The inspiration which resulted in the development of Hark's Mailer was:
Jack's Formmail at http://www.lumbroso.com/scripts/ .
Formmail V4.2 was the basis for this effort.

DOCUMENTATION

1. Copyright
2. Overview
3. Setting Up the HarksMailer Script

4. Form Configuration

5. History


COPYRIGHT

Copyright 2003 Richard Harkrider (c) All rights reserved. http://harksmailer.harkrider.com.
This application will only function at PHP Version 4.1 or higher. Doubt that it could be used on a mICKYMOUSE wINDOWS server and quite honestly I DON'T GIVE A DAMN.
There are known issues with sending attachments on a server in safe mode.
I know why and am trying to find a secure way around it. Because of Safe Mode security a directory with world access must exist to do attachments.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For full disclaimer and warranty info GO HERE.


OVERVIEW

Hark's Mailer is a form handler which has the ability to email attachments. If the script is set up properly there is only 1 field required for this script to work. Other hidden configuration fields can also be used to enhance the operation of HarksMailer.php on your site.


To Top

SETTING UP THE SCRIPT

Required Variables
Variable:

$allowed_recips

Description:

Here you will define the domains which will be allowed to receive email generated by this script. If not defined the script will 'DIE'.

Further Explaination:
By placing goodguy.com and www.goodguy.com in the allowed_recips (as in the example below) array, this insures that any mail not addressed to some user at this domain will not be sent.

Syntax:

$allowed_recips = ('goodguy.com','www.goodguy.com');


--NOTE-- If sending attachments when Safe Mode is activated there are additional requirements. CLICK HERE for specifics.
To Top
Recommended Variables*

*While these variables are not required they are highly recommended.

Variable:

$Referers

Description:

This array allows you to define the domains that you will allow forms to reside on and use your HarksMailer.php script. If a user tries to put a form on another server, that is not the specified domain or ip, they will receive an error message when someone tries to fill out their form.

Further Explaination:
By placing goodguy.com in the referers (as in the example below) array, this also allows www.goodguy.com, ftp.goodguy.com, goodguy.com/dir/file/, any other http address with goodguy.com in it and goodguy.com's IP (216.65.144.195) address to access this script as well, so no users will be turned away.

Syntax:

$referers = ('goodguy.com','216.64.145.194');

To Top
Variable:

$default_recipient

Description: If desired, set a default email address here. If all mail goes to a single address this eliminates the need to specify a recipient in your form.
The default can be overidden by....
<input type="hidden" NAME="recipient"VALUE="user@anotherdomain.com">
in the form. This will overwrite the default.
Syntax:$default_recipient = "agooduser";
$default_recipient .= "@";
$default_recipient .= "somedomain.net";

This is broken up this way to try and avoid the email harvesting spiders.
To Top
Variable:

$allowed_attach_types

Description: Limit the type of files which can be uploaded -- default is image & text. If unsure what type to use test upload of a file. The error handler will tell you the type of file.
Types I know of are image, application(dangerous as includes executables * and at least some scripts) and text.
--NOTE -- To allow any file type set value to 'all' as in...
$allowed_attach_types = array ('all');
Syntax:$allowed_attach_types = array ('image', 'text');
To Top

Optional Variables

Variable:

$banlist

Description:

This array allows you to define the domains and emails that you would like banned from using your HarksMailer.php.

Further Explaination:
By placing *@hotmail.com it bans any one with anything@hotmail.com from using the form so if spammer@hotmail.com uses your script he'll be turned away. You can also specify an full email address, such as bull@schitt.org and only that email address will be banned not everyone at "schitt.org".

Syntax:

$banlist = array ('*@somedomain.com', 'user@domain.com', 'etc@domains.com');

To Top
Safe Mode
--NOTE-- If sending attachments when Safe Mode is activated there are additional requirements.

A directory MUST exist in or under your $_SERVER[DOCUMENT_ROOT] directory with world write permissions (chmod 777) and the following variables defined in the script. Most FTP applications can be used to create the directory and set permissions.
Variable

$is_safe_mode

Description:

Setting this variable to a non-zero value allows you to send email attachments when safe mode is activated.

Further Explaination:
Because of some of the safe mode requirements it is necessary to jump through a bunch of hoops and create a security hole by opening up a directory to world write access.

Syntax:

$is_safe_mode = 1;


Variable

$path_to_use

Description:

This is the path which will be used by Hark's Mailer for temporary storage. Must be the path to your directory. ie: "filedir/" where filedir/ is relative (and located under) your document root directory (this is the same directory where you place the default HTML file for your website).

Further Explaination:
The directory must exist and have world write permissions. i.e CHMOD 777. Any files placed here should be deleted by Hark's Mailer when done.

Syntax:

$path_to_use = "filedir/";

To Top
To set up the HarksMailer.php script and copy it into the directory in which you are planning to use it.

Your Hark's Mailer program is now configured.

FORM CONFIGURATION

The action of your form needs to point towards HarksMailer.php.
<FORM ENCTYPE="multipart/form-data" ACTION="HarksMailer.php" METHOD=POST>

Now we will take you through a list of form fields you can use and how to implement them.


To Top
Necessary Form Fields
--NOTE-- If a default recipient has not been defined in the script or you wish to overide the default or you wish to specify multiple recipients then the recipient field is REQUIRED.
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">

For Multiple Recipients seperate the emails with commas (",").


To Top
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: "Form Submission"

Syntax:

<input type=hidden name="subject" value="subject">

To Top
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.

Syntax:

<input type=text name="email">

To Top
Field:

phone_no

Description:

This form field will allow the user to specify a phone number.

Syntax:

<input type=text name="phone_no">

To Top
Field:

fax_no

Description:

This form field will allow the user to specify a fax number.

Syntax:

<input type=text name="fax_no">

To Top
Field:

zip_code

Description:

This form field will allow the user to specify their zip code.

Syntax:

<input type=text name="zip_code">

To Top
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 or as another form type to let the user decide.

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 the user to specify a URL they wish to travel to once the form is filled out:
<input type=text name="redirect" value="http://">

To Top
Field:

required_fields

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.

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_fields" value="email,phone_no">

You can use this on any field.

To Top
Field:

error_header_file

Description:Used to define a header file for error processing. Great way to blend Harks Mailer output with your site design
Syntax:<input type="hidden" name="error_header_file" value="er_header.htm">
To Top
Field:

error_footer_file

Description:Used to define a footer file for error processing. Great way to blend Harks Mailer output with your site design
Syntax:<input type="hidden" name="error_footer_file" value="er_footer.htm">
To Top
Field:

header_file

Description:Used to define a header file for display of normal termination results. Great way to blend Harks Mailer output with your site design
Syntax:<input type="hidden" name="header_file" value="header.htm">
To Top
Field:

footer_file

Description:Used to define a footer file for display of normal termination results. Great way to blend Harks Mailer output with your site design
Syntax:<input type="hidden" name="footer_file" value="footer.htm">
To Top
Field:

attachment[]

Description: This allows the attachment of one or more files to the email.
--NOTE-- If sending attachments when Safe Mode is activated there are additional requirements. CLICK HERE for specifics.

MAX_FILE_SIZE - (case sensitive) hidden field must precede the file input field and it's value is the maximum filesize accepted. The value is in bytes.
Syntax:

<input type="hidden" name="MAX_FILE_SIZE" value="1000000">

<input type="file" name="attachment[]">

To Top
Field:

env_report

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:

HTTP_HOST
  - Sends the hostname making the request.
REMOTE_ADDR
  - Sends the IP address of the remote host making the request.
HTTP_USER_AGENT
  - The browser the client is using to send the request.

Syntax:

If you wanted to find the http host and browser sending the request, you would put the following into your form:
<input type=hidden name="env_report" value="HTTP_HOST, HTTP_USER_AGENT">

Seperate by commas ",".

To Top
HISTORY



To Top