Description:
------------

This script will do the following:
1. AutoMail Lite will attach a file to a text body and auto-forward it
to the email address entered in the form.
2. Includes Formmail. Formmail instructions are included at the end of
these instructions. No formmail functions are changed.
3. In addition to the formmail functions, auto-responding is possible.
4. Will either record the email address in a log file for you, email
you a short letter stating the form inputs of the user, or both.

Instructions on Use:
--------------------
A formmail compatible form must be placed on your website.
Automail Lite functions are enabled by doing the following:

1. Configure the file automail_lite.cgi by changing the proper variables so
that Automail can find your files and logs (variables described later).
2. Automail Lite can do the following (only!). Attach a file to a text
body. If you leave out the text, the script will fail, and if you leave
out the attachment, the script will fail.
3. A form must be placed on your website that triggers AutoMail Lite. An
example of such a form is located in the file ExampleForm.txt.

Files needed:
-------------
In script directory (i.e. www.yoursite.com/scripts):
automail_lite.cgi : This is the script file : chmod 755

In directory named 'automail' off of main script directory. (i.e. www.yoursite.com/scripts/automail)
automail_lite.log : This is the counter log file : chmod 666
body.txt : This is the body of the email that is to be sent
**YOUR FILES THAT YOU WISH TO ATTACH ALSO GET PLACED IN THE AUTOMAIL DIRECTORY**

Installation:
-------------
1. Place a form on your site that is formmail compatible (formmail instructions below).
A simple example form is located in the 'exampleform.txt' file.
2. Chmod the scripts as above.
3. Change the first line of the script to the location of PERL on your system.
4. The following items need to be changed in the script, they are located
just after the headers.

-----------------------
$mailprog
Defines the location of your sendmail program on your unix system.
$mailprog = '/usr/lib/sendmail';

-----------------------
@referers
These are the domain names that are allowed to use formmail on your site.
This is a first level protection against a someone using your form to send
spam or to control access to your files. It is NOT foolproof
(see http://www.datatrendsoftware.com/spoof.html to see how easily "referer"
can be spoofed) so if you are going to try to restrict access to important
files, this is not a good way to do it.
@referers = ('www.yoursite.com','www.othersite.com');

-----------------------
$auto_type
This is your file attachment type. See mimetype.txt for a list of valid types.
$auto_type = 'application/octet-stream';

-----------------------
$auto_encoding
This is the encoding that will be used for your attachment. See encoding.txt
for a list of types. Most users will want 'base64'.
$auto_encoding = 'base64';

-----------------------
$auto_body
This is the body of your auto-response message. It must be a text file. Be
sure to test how it looks when mailed for funny line-wrapping etc. Sometimes
text files don't translate into email readers very cleanly.
This file must also go in the automail directory (with the download file).
$auto_body = 'body.txt';

-----------------------
$message_type
This is your message type. See encoding.txt for valid types and definitions.
Most users will want 'multipart/mixed' because you WILL have at least two parts
(the attachment and the message body) and most likely you are attaching a binary
file.
$message_type = 'multipart/mixed';

-----------------------
$log_or_email
Set this to 'L' for to keep log (stores email addresses only!)
Set this to 'E' to send a confirm email.
Set this to 'B' for both. (Recommended over 'L')
Set this to 'N' for neither.
$log_or_email = 'B';

NOTES: If you have a single field form, for just email input, a log file will
be sufficient to keep these on file for you. If you have other fields in the
form (i.e. name, address, etc) you MUST select 'E' or 'B' to send the form
to you or else the data will be lost. Also, if two users happen to submit at
the same time, it is possible that the 'L' option will not store the email
of the second user (to prevent log file corruption). This is only an issue
at high volume sites.

-----------------------
$email_log
This is the log file for storing your email addresses if you chose 'L'
or 'B' above. This file must also be located in the automail directory with
the attachment files (above).
$email_log = 'automail.log';

--------------------
If you want to see a working version of Automail Lite.
Go to http://www.datatrendsoftware.com/automail_demo.html.
There is a single email capture field that makes it work like a charm!
####################################################################
# END OF AUTOMAIL README. BELOW IS THE ORIGINAL FORMMAIL README
####################################################################
# FormMail Version 1.6
# Copyright 1996-1997 Matt Wright mattw@worldwidemart.com
# Created 06/09/95 Last Modified 05/02/97
# Matt's Script Archive, Inc.: http://www.worldwidemart.com/scripts/
####################################################################
# If you run into any problems while trying to configure this scripts, help
# is available. The steps you should take to get the fastest results, are:
# 1) Read this file thoroughly.
# 2) Consult the Matt's Script Archive Frequently Asked Questions:
# http://www.worldwidemart.com/scripts/faq/
# 3) If you are still having difficulty installing this script, send
# e-mail to: scripts-help@tahoenet.com
# Include any error messages you are receiving and as much detail
# as you can so we can spot your problem. Also include the variabl
# configuration block that is located at the top of the script.
#
# Hopefully we will be able to help you solve your problems. Thank you.
####################################################################
# COPYRIGHT NOTICE
# Copyright 1995 - 1997 Matthew M. Wright All Rights Reserved.
#
# FormMail may be used and modified free of charge by anyone so long as this
# copyright notice and the comments above remain intact. By using this
# code you agree to indemnify Matthew M. Wright from any liability that
# might arise from its use.
#
# Selling the code for this program without prior written consent is
# expressly forbidden. In other words, please ask first before you try and
# make money off of my program.
#
# Obtain permission before redistributing this software over the Internet or
# in any other medium. In all cases copyright and header must remain intact
####################################################################

FormMail is a universal WWW form to E-mail gateway. There is only one
required form input tag which must be specified in order for this script to
work with your existing forms. Other hidden configuration fields can also
be used to enhance the operation of FormMail on your site. Version 1.6 of
FormMail contains a few minor bug fixes, optimized code and more comments.
The biggest change in this version is that by default, form fields are now
sorted as they appear in the form. Error pages were also beautified a
little and two new configuration fields were created. Read the History for
a more complete list of changes.

The script, FormMail.pl, needs to be placed in your server's cgi-bin and the
anonymous WWW user must have the ability to read/execute the script. If
you do not have access to your server's cgi-bin, yet you can execute cgi
scripts, you may want to try adding a .cgi extension to the FormMail.pl,
so you could move it to FormMail.cgi.

Setting Up the FormMail Script:
===============================

The FormMail.pl script does not have to be extensively configured in order
to work. There are only two variables in the perl file which you will
need to define along with changing the top line of your script to match
the location of you Perl interpreter.

Necessary Variables:
--------------------

$mailprog = '/usr/lib/sendmail';
This variable must define the location to your server's sendmail
program. If this is incorrect, form results will not be mailed to you.

@referers = ('worldwidemart.com','206.31.72.203');
This array allows you to define the domains that you will allow
forms to reside on and use your FormMail script. If a user tries to
put a form on another server, that is not worldwidemart.com, they
will receive an error message when someone tries to fill out their form.
By placing worldwidemart.com in the @referers array, this also allows
www.worldwidemart.com, ftp.worldwidemart.com, any other http address
with worldwidemart.com in it and worldwidemart.com's IP address to access
this script as well, so no users will be turned away.

Your FormMail program is now configured.

-----------------------------------------------------------------------------

Form Configuration:
===================

The action of your form needs to point towards this script (obviously), and
the method must be POST or GET in capital letters. Version 1.5 of FormMail
offers many new ways to code your form to tailor the resulting HTML page
and the way the script performs. Below is a list of form fields you can
use and how to implement them.

Necessary Form Fields:
======================

There is only one form field that you must have in your form, for
FormMail to work correctly. This is the recipient field.

Field: recipient

Description: This form field allows you to specify to whom you wish for your
form results to be mailed. Most likely you will want to
configure this option as a hidden form field with a value equal
to that of your e-mail address.

Syntax:
<input type=hidden name="recipient" value="email@your.host.com">

-----------------------------------------------------------------------------

Optional Form Fields:
=====================

Field: subject

Description: The subject field will allow you to specify the subject that you
wish to appear in the e-mail that is sent to you after this form
has been filled out. If you do not have this option turned on,
then the script will default to a message subject: WWW Form
Submission

Syntax:
If you wish to choose what the subject is:
<input type=hidden name="subject" value="Your Subject">

To allow the user to choose a subject:
<input type=text name="subject">

-----------------------------------------------------------------------------

Field: email

Description: This form field will allow the user to specify their return
e-mail address. If you want to be able to return e-mail to your
user, I strongly suggest that you include this form field and
allow them to fill it in. This will be put into the From:
field of the message you receive. If you want to require an
email address with valid syntax, add this field name to the
'required' field.

Syntax:
<input type=text name="email">

-----------------------------------------------------------------------------

Field: realname

Description: The realname form field will allow the user to input their real
name. This field is useful for identification purposes and will
also be put into the From: line of your message header.

Syntax:
<input type=text name="realname">

-----------------------------------------------------------------------------

Field: redirect

Description: If you wish to redirect the user to a different URL, rather than
having them see the default response to the fill-out form, you
can use this hidden variable to send them to a pre-made HTML
page.

Syntax:
To choose the URL they will end up at:
<input type=hidden name="redirect"
value="http://your.host.com/to/file.html">

To allow them to specify a URL they wish to travel to once the
form is filled out:
<input type=text name="redirect">

-----------------------------------------------------------------------------

Field: required

Version: 1.3 & Up

Description: You can now require for certain fields in your form to be filled
in before the user can successfully submit the form. Simply
place all field names that you want to be mandatory into this
field. If the required fields are not filled in, the user will
be notified of what they need to fill in, and a link back to
the form they just submitted will be provided.

To use a customized error page, see 'missing_fields_redirect'

Syntax:
If you want to require that they fill in the email and phone
fields in your form, so that you can reach them once you have
received the mail, use a syntax like:

<input type=hidden name="required" value="email,phone">

-----------------------------------------------------------------------------

Field: env_report

Version: 1.3 & Up

Description: Allows you to have Environment variables included in the
e-mail message you receive after a user has filled out your
form. Useful if you wish to know what browser they were using,
what domain they were coming from or any other attributes
associated with environment variables. The following is a short
list of valid environment variables that might be useful:

REMOTE_HOST - Sends the hostname making a request.
REMOTE_ADDR - Sends the IP address of the remote host making
the request.
REMOTE_USER - If server supports authentication and script
is protected, this is the username they have
authenticated as. *This is not usually set.*
HTTP_USER_AGENT - The browser the client is using to send the
request.

There are others, but these are a few of the most useful. For
more information on environment variables, see:

http://www.cgi-resources.com/Documentation/Environment_Variables/

Syntax:
If you wanted to find the remote host and browser sending the
request, you would put the following into your form:

<input type=hidden name="env_report" value="REMOTE_HOST,
HTTP_USER_AGENT">

-----------------------------------------------------------------------------

Field: sort

Version: 1.4 & Up

Description: This field allows you to choose the order in which you wish
for your variables to appear in the e-mail that FormMail
generates. You can choose to have the field sorted
alphabetically or specify a set order in which you want the
fields to appear in your mail message. By leaving this field
out, the order will simply default to 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.) When
sorting by a set order of fields, you should include the phrase
"order:" as the first part of your value for the sort field, and
then follow that with the field names you want to be listed in
the e-mail message, separated by commas. Version 1.6 allows a
little more flexibility in the listing of ordered fields, in
that you can include spaces and line breaks in the field without
it messing up the sort. This is helpful when you have many form
fields and need to insert a line wrap.

Syntax:
To sort alphabetically:
<input type=hidden name="sort" value="alphabetic">

To sort by a set field order:
<input type=hidden name="sort" value="order:name1,name2,
name3,etc...">

-----------------------------------------------------------------------------

Field: print_config

Version: 1.5 & Up

Description: print_config allows you to specify which of the config
variables you would like to have printed in your e-mail message.
By default, no config fields are printed to your e-mail. This
is because the important form fields, like email, subject, etc.
are included in the header of the message. However some users
have asked for this option so they can have these fields printed
in the body of the message. The config fields that you wish to
have printed should be in the value attribute of your input tag
separated by commas.

Syntax:
If you want to print the email and subject fields in the body of
your message, you would place the following form tag:

<input type=hidden name="print_config" value="email,subject">

-----------------------------------------------------------------------------

Field: print_blank_fields

Version: 1.6

Description: print_blank_fields allows you to request that all form fields
are printed in the return HTML, regardless of whether or not
they were filled in. FormMail defaults to turning this off, so
that unused form fields aren't e-mailed.

Syntax:

If you want to print all blank fields:
<input type=hidden name="print_blank_fields" value="1">

----------------------------------------------------------------------------

Field: title

Version: 1.3 & Up

Description: This form field allows you to specify the title and header that
will appear on the resulting page if you do not specify a
redirect URL.

Syntax:
If you wanted a title of 'Feedback Form Results':
<input type=hidden name="title" value="Feedback Form Results">

-----------------------------------------------------------------------------

Field: return_link_url

Version: 1.3 & Up

Description: This field allows you to specify a URL that will appear, as
return_link_title, on the following report page. This field
will not be used if you have the redirect field set, but it is
useful if you allow the user to receive the report on the
following page, but want to offer them a way to get back to
your main page.

Syntax:
<input type=hidden name="return_link_url"
value="http://your.host.com/main.html">

-----------------------------------------------------------------------------

Field: return_link_title

Version: 1.3 & Up

Description: This is the title that will be used to link the user back to the
page you specify with return_link_url. The two fields will be
shown on the resulting form page as:

<ul>
<li><a href="return_link_url">return_link_title</a>
</ul>

Syntax:
<input type=hidden name="return_link_title"
value="Back to Main Page">

-----------------------------------------------------------------------------

Field: missing_fields_redirect

Version: 1.6

Description: This form field allows you to specify a URL that users will be
redirected to if there are fields listed in the required form
field that are not filled in. This is so you can customize an
error page instead of displaying the default.

Syntax:
<input type=hidden name="missing_fields_redirect"
value="http://your.host.com/error.html">

-----------------------------------------------------------------------------

Field: background

Version: 1.3 & Up

Description: This form field allow you to specify a background image that
will appear if you do not have the redirect field set. This
image will appear as the background to the form results page.

Syntax:
<input type=hidden name="background"
value="http://your.host.com/image.gif">

-----------------------------------------------------------------------------

Field: bgcolor

Version: 1.3 & Up

Description: This form field allow you to specify a bgcolor for the form
results page in much the way you specify a background image.
This field should not be set if the redirect field is.

Syntax:
For a background color of White:
<input type=hidden name="bgcolor" value="#FFFFFF">

-----------------------------------------------------------------------------

Field: text_color

Version: 1.3 & Up

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

Syntax:
For a text color of Black:
<input type=hidden name="text_color" value="#000000">

-----------------------------------------------------------------------------