FormMailGMT.cgi
  (Version 1.5, 9/23/99)

Click here to return to the home page.
Configuration Options

FormMailGMT is controlled via input fields that you specify inside your web form. All of the following fields are optional except for the "mailto_recipient" field. If you haven't already read the Quick Start Guide, please do so now, then return back here to include those options which you need to configure the actions of your form.
MAILTO (recipient email) REDIRECT (url diversion) IO (form field control)
BODY (response page html) REPLY (courtesy email) DB (database logging)

MAILTO options

The "mailto_" configuration set defines who should receive the form data and how it should be presented.

Field:
 mailto_recipient (THIS IS THE ONLY REQUIRED FIELD)
Syntax:
 <input type=hidden name="mailto_recipient"
       value="email@your.host.com">
Purpose:
 Specifies who should receive the results of the form data. This option should be specified as a hidden form field with a value equal to that of your email address.
Field:
 mailto_subject
Syntax:
 <input type=hidden name="mailto_subject"
       value="Your Subject Line">

If you wish to have the user of the form specify the subject line, then use the following syntax instead:
<input type=text name="mailto_subject">
Purpose:

Specifies the subject that should appear in the email header that is sent to the "mailto_recipient". If this field is not provided, then the FormMailGMT will default to a message subject: WWW Form Submission.
Field:
 mailto_from (highly recommended field)
Syntax:
 <input type=text name="mailto_from">
Purpose:

Specifies the return email address of the sender of the form. This result is placed into the From: field of the message received by the "recipient". If you want to require an email address with valid syntax, add this field name to the "required" field, especially if you want to send a courtesy (confirmation) reply.
Field:
 mailto_cc
Syntax:
 <input type=hidden name="mailto_cc"
       value="webmaster@yourdomain.com">
Purpose:

Specifies where to send a copy of the web form data, an alternate to putting multiple addresses in the recipient field. This will be added to the email header as a Cc: field.

Field:
 mailto_bcc
Syntax:
 <input type=hidden name="mailto_bcc"
       value="webmaster@yourdomain.com">
Purpose:

Specifies where to send a blind copy of the web form data, an alternate method to using multiple addresses in the recipient field. This will be added to the email header as a Bcc: field

Field:
 mailto_realname
Syntax:
 <input type=text name="mailto_realname">
Purpose:

Specifies the realname of the user which is placed in the From: line of your email message header.
Field:
 mailto_print_config
Syntax:
 <input type=hidden name="mailto_print_config"
       value="mailto_from,email_subject,...">
Purpose:

Specifies configuration fields to be printed in the body of the recipient email message. By default, no config fields (of type hidden) are printed in the recipient email message. Important form fields like email, subject, etc., are formally included in the header of the message.
Field:
 mailto_env_report
Syntax:
 <input type=hidden name="mailto_env_report"
       value="REMOTE_HOST,REMOTE_USER,HTTP_USER_AGENT">
Purpose:

Specifies that the given Environment variables be included in the email message received by the target "mailto_recipient". This stuff is useful if you wish to know what browser the user posted the form with, what domain they were coming from, etc.

For more information on environment variables, see:
http://www.cgi-resources.com/Documentation/Environment_Variables/

REDIRECT options

The "redirect_" configuration set allows you to bypass the default response page and substitute a custom URL thank-you or error page.
Field:
 redirect_success
Syntax:
 <input type=hidden name="redirect_success"
       value="http://your.host.com/thanks.html">
Purpose:

By default, a successful form submission will send the user to a default response page generated by FormMailGMT. If you wish to redirect the user to a different URL, you can use this hidden variable to specify an existing HTML thank-you type page.
Field:
 redirect_missing_fields
Syntax:
 <input type=hidden name="redirect_missing_fields"
       value="http://yourhost.com/missing-fields-error.html">
Purpose:

Specifies a URL that users will be redirected to if there are fields listed in the "io_required" field that are not filled in. The default is to allow FormMailGMT display an error page for you.

IO options

The "io_" configuration set provides control over which form fields are required, how they should be sorted, what name to use when referring to these fields and whether to allow blank field entries to be visible in the mailto message and default response page.
Field:
 io_required
Syntax:
 <input type=hidden name="io_required"
       value="email,phone,etc...">
Purpose:

Specifies all field names that MUST be filled in by the user. If any of these required fields are not filled in by the user, FormMailGMT will notify the user as to what they need to fill in, it also provides a link back to the form they just submitted so that the missing fields can be completed.

NOTE: To use a customized error page, see the "redirect_missing_fields" option.

Field:
 io_sort
Syntax:
 <input type=hidden name="io_sort"
       value="alphabetic">
or to sort by a specific field order use;
<input type=hidden name="io_sort"
       value="order:field1,field2,...">
Purpose:

Specifies the ordering of the variables (form fields and data) that appear in the mailto message that FormMailGMT sends. The default sequence is the order in which the browsers sends the information to the script (which is usually the exact same order as they appeared in the form).
Field:
 io_aliases
Syntax:
 <input type=hidden name="io_aliases"
       value="field1:alias1,field2:alias2,...">
Purpose:

Specifies an alternative name to use when referring to a configuration or web form field in all output content including email messages, error messages, thank you messages, etc.

Field:
 io_blank_fields
Syntax:
 <input type=hidden name="io_blank_fields"
       value="1">
Purpose:

Specifies that all form fields are to be printed in the mailto message and the default success page, regardless of whether or not they were filled in. By default, FormMailGMT will not display unused (empty) form fields.

BODY options

The "body_" configuration set provides control over the appearance of the default response page generated by FormMailGMT. These options will be ignored if the redirect_success url is being used to bypass the response page.
Field:
 body_title
Syntax:
 <input type=hidden name="body_title"
       value="Pizza Order">
Purpose:

This form field allows you to specify the title and header that will appear in the body of the response page.
Field:
 body_return_link_url
Syntax:
 <input type=hidden name="body_return_link_url"
       value="http://your.host.com/main.html">
Purpose:

This form field allows you to specify a URL that will appear in the body of the response page and is useful if you want to allow the user a direct link back to your home page. Please include the "body_return_link_title" below here, otherwise this option will be ignored.

Field:
 body_return_link_title
Syntax:
 <input type=hidden name="body_return_link_title"
       value="Back to Our Main Page">
Purpose:

This field specifies the title for the "body_return_link_url" link that will appear in the body of the response page. Please include the body_return_link_url otherwise this option will be ignored.
Field:
 body_background
Syntax:
 <input type=hidden name="body_background"
       value="http://yourhost.com/background-image.gif">
Purpose:

Specifies a background image that will appear if you do not have the redirect field set. This image will appear as the background to the default form response page.

Field:
 body_bgcolor
Syntax:
 <input type=hidden name="body_bgcolor"
       value="#f0f0f0">
Purpose:

Specifies a background color for the form response page in much the way you specify a background image.
Field:
 body_text_color
Syntax:
 <input type=hidden name="body_text_color"
       value="#000000">
Purpose:

This field works in the same way as bgcolor, except that it will change the color of your text.

Field:
 body_link_color
Syntax:
 <input type=hidden name="body_link_color"
       value="#0000ff">
Purpose:

Changes the color of links on the response page. Works in the same way as text_color.
Field:
 body_vlink_color
Syntax:
 <input type=hidden name="body_vlink_color"
       value="#ff0000">
Purpose:

Changes the color of visited links on the response page. Works exactly the same as link_color.

Field:
 body_alink_color
Syntax:
 <input type=hidden name="body_alink_color"
       value="#0000ff">
Purpose:

Changes the color of active links on the response page. Works exactly the same as link_color.

REPLY options

The "reply_" configuration set defines options that control the appearance and content of a courtesy or confirmation reply message to be sent to the sender or submitter of your form.
Field:
 reply_to_sender
Syntax:
 <input type=hidden name="reply_to_sender"
       value="yes">
Purpose:

Causes an automated courtesy reply to be sent to the user who filled out the form, this can be used as a confirmation or simple thank you message for filling out your form!

Field:
 reply_texta
Syntax:
 <input type=hidden name="reply_texta"
       value="Thank You for filling out this form...">
Purpose:

The first line of your courtesy reply message.

Field:
 reply_textb
Syntax:
 <input type=hidden name="reply_textb"
       value="Call us if you need further information...">
Purpose:

The second line of your courtesy reply message.

Field:
 reply_our_url
Syntax:
 <input type=hidden name="reply_our_url"
       value="http://www.pizza.com">
Purpose:

A place to specify your URL in the footer of the courtesy reply message.
Field:
 reply_our_email
Syntax:
 <input type=hidden name="reply_our_email"
       value="pizza@pizza.com">
Purpose:

A place to specify your email address for placement in the footer of the courtesy reply message.
Field:
 reply_who_we_are
Syntax:
 <input type=hidden name="reply_who_we_are"
       value="Pizza OnLine">
Purpose:

Tell the visitor who you are in the courtesy reply footer.
Field:
 reply_who_we_are2
Syntax:
 <input type=hidden name="reply_who_we_are2"
       value="The fastest way to order pizza!">
Purpose:

An additional line of text telling the visitor who you are.
Field:
 reply_exclude
Syntax:
 <input type=hidden name="reply_exclude"
       value="credit_card,federal_tax_id,etc.">
Purpose:

Specifies "sensitive" fields to be excluded from the courtesy reply message, i.e., credit card numbers, tax id numbers, bank accounts, home phone numbers, etc.

DATABASE options

The "db_" configuration set defines options that specify where and how to store web form data on your web site.
Field:
 db_append
Syntax:
 <input type=hidden name="db_append"
       value="your-database-folder/results.txt">
Purpose:

Specifies the path to the filename in which to store WEB form results. An initial blank datafile must be created prior to using this option, otherwise no results will be stored, i.e., FormMailGMT does not automatically create your database file; it only appends to it. In addition, the data file and the directory containing it must be writable by the webserver, typically Unix mode 662 is sufficient for the database file and 777 for the directory that contains the database file.

When specifying the datafile, it can be either a full unix path (e.g. "'$ENV{'DOCUMENT_ROOT'}/database/results.txt") or a relative path (e.g. "database/results.txt"). It is important to note that if you specify a relative path, it is the path relative to the value of the $ENV{'DOCUMENT_ROOT'} folder.

note: Consult your ISP's documentation regarding the value of DOCUMENT_ROOT in your CGI environment.
Field:
 db_fields
Syntax:
 <input type=hidden name="db_fields"
       value="mailto_realname,phone,etc.">
Purpose:

Specifies exactly which fields are to be appended to the database. If db_fields is not specified, the default is to store all field data, whether there is data present or not, i.e., blank fields are not ignored, unlike with the mailto_recipient message.

note:
If db_fields is not specified, all non-hidden fields are appended to the database in the order recieved.
Field:
 db_delimiter
Syntax:
 <input type=hidden name="db_delimiter"
       value="|">
Purpose:

Specifies the field separator character in the database, the default is a tab character. Please avoid using common characters, like @.

note1: Records are separated by newlines.
note2: If the database format is not appropriate, please see "db_vertical".
Field:
 db_vertical
Syntax:
 <input type=hidden name="db_vertical"
       value="yes">
Purpose:

Specifies that the fields in the db_append file should be written in vertical format similar to that in the email message sent to the recipient, one field per line in the format FIELDNAME: VALUE.
©® Copyright 1999 by WaveStar Technology, USA
Last edited 10/19/99 by jpf@wave-star.com
All Rights Reserved.