$Id: README,v 1.3 2001/06/26 22:49:52 btrott Exp $

This is STAMP, the Secure, Template-Aware Mail Processor. It is a
secure, feature-full form mailer script. It contains many of the
options present in the 'FormMail' script offered at Matt's Script
Archive, but it also fills the security holes in that script. Among
other things, its configuration system prevents spammers from using
your mailer script as an open relay.

FEATURES

    * Secure configuration system prevents spammers from using
      your mailer as a spam tool.
    * Mail templates enable you to personalize/customize form
      submission messages (for the benefit of the recipient).
    * Can send mail using SMTP, sendmail, and mail.

PREREQUISITES

STAMP requires the following Perl packages:

    * App::Config
    * Mail::Mailer (MailTools package)
    * CGI

If you wish to use the mail-templating functionality, you will
also need HTML::Template.

INSTALLATION

If the above modules are not already installed on your system,
you will have to install them from the CPAN (the Comprehensive
Perl Archive Network). The CPAN shell offers a straightforward
method of performing installations; if yours is configured, you
should just be able to do

    % perl -MCPAN -e 'install App::Config'
    % perl -MCPAN -e 'install Mail::Mailer'

If you have problems, you can download the Perl packages and
install them manually. They can be downloaded from

    http://search.cpan.org/

If you're installing the Perl modules on a machine where you don't
have root privileges, you'll need to install the modules in your
personal directory, then edit 'stamp.cgi' to add a 'use lib'
statement pointing to that directory. For example:

    use lib '/home/foo/perl/lib';

If you've never installed a Perl module before, you may want to
ask your system administrator friends for help. :)

SETUP

1. Create a configuration file. You can base your configuration
on the 'sample.cfg' file, which demonstrates some of the options
in STAMP. Be sure to set a recipient for your form
('To'/'Recipient'), as well as a redirect URL ('Redirect').

2. Upload the configuration file into (preferably) a directory
that is not accessible to web users; ie. a directory that is
outside of your public HTML directory.

3. Edit 'stamp.cgi'; change the setting of $CFG_FILE to point
to the location of your configuration file.

4. Upload the file 'stamp.cgi' to your webserver and place it
where you place other CGI scripts.

5. Configure your form HTML to point to the location of
stamp.cgi.

SAMPLES/TUTORIALS

Take a look at the sample files included in the distribution.

    * sample.html is an example of an HTML form using STAMP.
    * sample.cfg is a sample configuration file.
    * sample.tmpl is a sample mail template.

TODO

    * Add ability to set up error template
    * Add any other FormMail features ('realname')

Benjamin Trott / ben@rhumba.pair.com