We have received your form, and \& we will get back to you shortly.
\& \& .Ve .PP \&\s-1NOTE:\s0 It is not necessary that your \s-1HTML\s0 file be called 'thankyou.html'. You may name this file anything you like. The only naming limitation is that the name of this file should be correctly referenced in your 'mailform.cgi', in the variable '\s-1SUCCESS_REDIRECT_URL\s0'. .SS "Create 'mailform.cgi'" .IX Subsection "Create 'mailform.cgi'" The file 'mailform.cgi' is where all the functionality of CGI::Application::Mailform is configured. This file is referred to as a \*(L"\s-1CGI\s0 instance script\*(R" because it creates an \*(L"instance\*(R" of your form. A single website may have as many instance scripts as needed. All of these instance scripts may use CGI::Application::Mailform. They may each use a different form (with different fields, etc.) if desired. The ability to create multiple instances of a single application, each with a different configuration is one of the benefits of building web-based applications using the CGI::Application framework. .PP Your instance script, 'mailform.cgi', must be created in such a way that it is treated by your web server as an executable \s-1CGI\s0 application (as opposed to a document). Generally (on \s-1UNIX\s0), this entails setting the \*(L"execute bit\*(R" on the file and configuring your web server to treat files ending \*(L".cgi\*(R" as \s-1CGI\s0 applications. Please refer to your particular web server's manual for configuration details. .PP Your instance script 'mailform.cgi' must start with the following: .PP .Vb 3 \& #!/usr/bin/perl \-w \& use CGI::Application::Mailform; \& my $mf = CGI::Application::Mailform\->new(); .Ve .PP These lines invoke the Perl interpreter, include the CGI::Application::Mailform module, and instantiate a Mailform object, respectively. (The author assumes your Perl binary is located at \*(L"/usr/bin/perl\*(R". If it is not, change the first line to refer to the correct location of your Perl binary.) .PP Once you have a Mailform object ($mf), you have to configure the Mailform for your particular application. This is done by using the \fIparam()\fR method to set a number of variables. These variables are specified as follows. .PP \&\fB\s-1REQUIRED VARIABLES\s0\fR .IP "\s-1MAIL_FROM\s0" 4 .IX Item "MAIL_FROM" .Vb 1 \& $mf\->param(\*(AqMAIL_FROM\*(Aq => \*(Aqwebmaster@your.domain\*(Aq); .Ve .Sp This variable specifies the email address from which the email created by this mailform will appear to be sent. This can be any address you like. Typically, this will be \*(L"webmaster@your.domain\*(R". Keep in mind, this is the address to which a bounce or a reply will be sent if one is generated as a result of the mailform email. The \s-1MAIL_FROM\s0 can also be useful for assisting the recipient of these email messages in automatically filtering and organizing the submissions they receive. .Sp This variable is required. If not specified, CGI::Application::Mailform will \fIdie()\fR with appropriate errors. .IP "\s-1MAIL_TO\s0" 4 .IX Item "MAIL_TO" .Vb 1 \& $mf\->param(\*(AqMAIL_TO\*(Aq => \*(Aqform_recipient@your.domain\*(Aq); .Ve .Sp This variable specifies the email address to which the email created by this mailform should be sent. This should be the email address of the person to whom the form contents should be emailed. This person will receive a reasonably formatted message every time this mailform is submitted. .Sp This variable is required. If not specified, CGI::Application::Mailform will \fIdie()\fR with appropriate errors. .IP "\s-1HTMLFORM_REDIRECT_URL\s0" 4 .IX Item "HTMLFORM_REDIRECT_URL" .Vb 1 \& $mf\->param(\*(AqHTMLFORM_REDIRECT_URL\*(Aq => \*(Aq/uri/or/url/to/mailform.html\*(Aq); .Ve .Sp This variable specifies the \s-1URL\s0 (or \s-1URI\s0) to which the web user should be redirected before they have submitted the mailform. This should be the \&\s-1HTML\s0 form which the user fills out, the contents of which will be emailed once they are submitted. .Sp This variable is required. If not specified, CGI::Application::Mailform will \fIdie()\fR with appropriate errors. .IP "\s-1SUCCESS_REDIRECT_URL\s0" 4 .IX Item "SUCCESS_REDIRECT_URL" .Vb 1 \& $mf\->param(\*(AqSUCCESS_REDIRECT_URL\*(Aq => \*(Aq/uri/or/url/to/thankyou.html\*(Aq); .Ve .Sp This variable specifies the \s-1URL\s0 (or \s-1URI\s0) to which the web user should be redirected once they have submitted the mailform. Typically, this would be a \*(L"thank you\*(R" screen which assures the user that their form submission has been received and processed. .Sp This variable is required. If not specified, CGI::Application::Mailform will \fIdie()\fR with appropriate errors. .IP "\s-1FORM_FIELDS\s0" 4 .IX Item "FORM_FIELDS" .Vb 1 \& $mf\->param(\*(AqFORM_FIELDS\*(Aq => [qw/name address comments etc/]); .Ve .Sp This variable specifies the list of \s-1HTML\s0 form fields which will be processed and sent via email to the specified recipient. Only the form fields specified in this list will be put in the email message which is generated by this mailform and sent to the specified recipient. .Sp The value of this variable must be an array reference. This variable is required. If not specified, CGI::Application::Mailform will \fIdie()\fR with appropriate errors. .PP \&\fB\s-1OPTIONAL VARIABLES\s0\fR .IP "\s-1SMTP_HOST\s0" 4 .IX Item "SMTP_HOST" .Vb 1 \& $mf\->param(\*(AqSMTP_HOST\*(Aq => \*(Aqmail.your.domain\*(Aq); .Ve .Sp This variable specifies the Internet host name (or \s-1IP\s0 address) of the server which provides Simple Mail Transfer Protocol (\s-1SMTP\s0) services. CGI::Application::Mailform sends all mail via \s-1SMTP\s0 using Net::SMTP. .Sp If \s-1SMTP_HOST\s0 is unspecified, Net::SMTP will use the default host which was specified when Net::SMTP was installed. If CGI::Application::Mailform is unable to make an \s-1SMTP\s0 connection, or successfully send mail via the \s-1SMTP\s0 host, it will \fIdie()\fR with appropriate errors. .IP "\s-1SUBJECT\s0" 4 .IX Item "SUBJECT" .Vb 1 \& $mf\->param(\*(AqSUBJECT\*(Aq => \*(AqNew form submission\*(Aq); .Ve .Sp This variable specifies the subject line of the email message which is created by this mailform. The subject is useful to the mailform recipient in easily recognizing (and possibly filtering) form submissions. .Sp This variable is optional. If not supplied, CGI::Application::Mailform will set the subject to a reasonable default. .IP "\s-1ENV_FIELDS\s0" 4 .IX Item "ENV_FIELDS" .Vb 1 \& $mf\->param(\*(AqENV_FIELDS\*(Aq => [qw/REMOTE_ADDR HTTP_USER_AGENT/]); .Ve .Sp This variable specifies the list of \*(L"environment\*(R" variables which will be processed and sent via email to the specified recipient. Only the environment variables specified in this list will be put in the email message which is generated by this mailform and sent to the specified recipient. .Sp Any environment variable which is present in the \s-1CGI\s0 environment may be included. Typical variables might be: .Sp .Vb 10 \& AUTH_TYPE \& CONTENT_LENGTH \& CONTENT_TYPE \& GATEWAY_INTERFACE \& HTTP_ACCEPT \& HTTP_USER_AGENT \& PATH_INFO \& PATH_TRANSLATED \& QUERY_STRING \& REMOTE_ADDR \& REMOTE_HOST \& REMOTE_IDENT \& REMOTE_USER \& REQUEST_METHOD \& SCRIPT_NAME \& SERVER_NAME \& SERVER_PORT \& SERVER_PROTOCOL \& SERVER_SOFTWARE .Ve .Sp See your web server documentation for a complete list and descriptions of the available environment variables. The list of environment variables specified by the \s-1CGI\s0 protocol can be found at the following \s-1URL:\s0 .Sp .Vb 1 \& http://hoohoo.ncsa.uiuc.edu/cgi/env.html .Ve .Sp The value of this variable must be an array reference. This variable is optional. If not specified, no environment variables will be included in the mailform email message. .PP Finally, you must actually cause your Mailform to be executed by calling the \fIrun()\fR method. Your instance script 'mailform.cgi' should end with the following lines: .PP .Vb 2 \& $mf\->run(); \& exit(0); .Ve .PP These lines cause your configured Mailform ($mf) to be executed, and for the program to cleanly exit, respectively. .PP \&\s-1NOTE:\s0 It is not necessary that your \s-1HTML\s0 file be called 'mailform.cgi'. You may name this file anything you like. The only naming limitations are that this file should be named so that your web server recognizes it as an executable \s-1CGI,\s0 and that your \&'mailform.html' file specifies your instance script in the \*(L"action\*(R" attribute of the