[MailIt!]

MailIt! is a free module for the Roxen Web Server. It allows easy formatting
and mailing of HTML Form data without the need to program custom CGI
scripts.

Please remember that this is a work in progress. Your comments and
suggestions are appreciated. Click here to send your comments to me, the
developer.

If you find this module useful, I'd greatly appreciate a postcard from you
letting me know you're out there. My Address is included in the
distribution.

[Requirements]

   * Roxen 1.1 or higher.
   * sendmail

[Getting MailIt!]

   * Download the latest version of MailIt! with Documentation (v0.9)

[Installing MailIt!]

Using MailIt! is simple! Just download the archive, then unpack it by using
the following command:

        tar -zxvf mailit-0.9.tar.gz

You should get a directory called mailit-0.9. Inside that directory is a
file called mailit.pike. Copy that file to your Roxen modules directory,
under roxen/server/modules. Then you can use the Configuration Interface to
add the MailIt! module.

There are a few options you can change, but in most cases it won't be
nessecary. If your sendmail binary is in a location other than /usr/lib,
you'll need to make the appropriate adjustments.

That's all there is to it! You can now start using the features of the
MailIt! module.

[Using MailIt!]

There are 3 components of a working MailIt! application:

   * The MailIt! Module (you've already installed it)
   * An HTML Form Page
   * A MailIt! Template Page

[The HTML Form Page]
You can use any text or HTML editor you'd like to create the form page. This
just contains the fields that you'd like to have mailed when a user presses
the submit button. The key is to set the form action to be the URL of an
HTML page that uses the features of MailIt!. When designing your form,
simply keep in mind the names of the various elements that you add to the
form. You'll need to supply these in the Template page later.

[The MailIt! Template]
The MailIt! Template is simply an HTML file that includes MailIt! tags. The
two tags that are provided by MailIt! are:

     <mailit> </mailit> and <mfield>

The first tag tells MailIt! that you are going to send everything inside the
two tags as an email message. Anything enclosed by these tags will not get
returned to the browser. Everything outside the mailit tags will be returned
to the browser as a response to the form submission.

The mailit container takes the following attributes:

subject="Subject of Message"
     Lets you specify the subject of the message. Optional, but basically
     essential.
to="Email Address"
     Tells MailIt! where to send the message. Absolutely required.
cc="Field Name"
     If included, tells MailIt! the name of the Form Field to use for the
     Carbon Copy address. Optional. Omit if you don't want Carbon Copying.
     If you don't specify a fieldname, the default specified in the
     Configuration Interface will be used.

The second tag tells MailIt! to print the value of a form element that you
specify. You can include these tags inside the mailit container to send the
information from the form in the email message.

The mfield tag takes the following attribute:

name="Field Name"
     The name of the Form Field to insert. This is case sensitive.

You can put any RXML tags inside the subject attribute of the mailit
container, as well as within the body of your message. The formatting
between the mailit tags is preserved when it is sent as a message.

Bill Welliver <hww3@galileo.susqu.edu>
1/29/97
