CleanCode Perl Libraries

Perl

Java

JavaScript

Certified
Class

Testable
Class

Standalone
Mode

Diagnostic
Enabled

NAME
SYNOPSIS
REQUIRES
DESCRIPTION
CLASS VARIABLES
CONSTRUCTOR
METHODS
BUGS
TO BE DONE
AUTHOR
VERSION
SINCE
SEE ALSO
POD ERRORS

NAME

CGI::PagePlugin::FormMail - send contents of form as mail.

SYNOPSIS

    use CGI::PagePlugin::FormMail;
    $plugin = CGI::PagePlugin::FormMail->new(\@fieldList, $inputData)
    print $plugin->output();

REQUIRES

Perl5.005

DESCRIPTION

A plugin used by CGI::PageSequencer to perform an action, in this case to send the contents of the form as email.

CLASS VARIABLES

VERSION: Current version of this class.

CONSTRUCTOR

new

PACKAGE->new(fields, inputData)

Returns a newly created object.

Parameters:

fields - reference to array of field names to process.

inputData - an InputOptions object; the getData and getProperty methods are needed to retrieve the value of each field and the project administrator, respectively.

Returns:

a newly created object

METHODS

output

OBJ->output()

Sends email to the project administrator (specified via the ADMIN_EMAIL property in the inputData) enumerating all input fields and corresponding values from the web page.

BUGS

None

TO BE DONE

Tailor subject to include subject from form.

AUTHOR

Michael Sorens

VERSION

$Revision: 8 $ $Date: 2006-12-19 21:13:43 -0800 (Tue, 19 Dec 2006) $

SINCE

CleanCode 0.9

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 120:: =back doesn't take any parameters, but you said =back -- end of CONSTRUCTOR section
Around line 149:: =back doesn't take any parameters, but you said =back -- end of METHOD section

Home