##################################################################################### ## ## ## THANK YOU TO LYNN L. FOR UPDATING THIS README FILE!! ## ## ## ## FILE: readme_V2.txt ## ## ## ## BizMailForm Version 2.0 ## ## ©Copyright 2000-2004+ Seth Michael Knorr mail@sethknorr.com ## ## ## ## http://www.bizmailform.com/ ## ## Please contact me with any bugs found, or any bug fixes. ## ## ## ##################################################################################### ## ## ## There is no email support provided for this script, ## ## the only support can be found at ## ## our web site: http://www.bizmailform.com/ ## ## ## ## ## ## ## ## ANY PERSON(S) MAY USE AND MODIFY THESE SCRIPT(S) ## ## FREE OF CHARGE FOR EITHER BUSINESS ## ## OR PERSONAL, HOWEVER AT ALL TIMES HEADERS ## ## AND COPYRIGHT MUST ALWAYS REMAIN INTACT. ## ## ## ## REDISTRIBUTION FOR PROFIT IS PROHIBITED ## ## WITH OUT THE CONSENT OF SETH KNORR. ## ## ## ## By using this code you agree to indemnify Seth M. Knorr ## ## from any liability that might arise from its use. ## ## ## ##################################################################################### ## ## ## This script is FREE, however if you use the script and ## ## find it useful, I would appreciate you rating it. ## ## ## ## TO RATE IT SIMPLY DOUBLE CLICK OPEN THE rateit.html FILE. ## ## ## ##################################################################################### =========================== S E T U P =========================== TABLE OF CONTENTS: (1) CONFIGURING THE FILES ......(1A) bizmail.cgi settings ..........(1A-I) Editing bizmail.cgi ..........(1A-II) Editing plain.mes ..........(1A-III) Editing html.mes ..........(1A-IV) Personalizing followup messages ..........(1A-V) Editing error.html ......(1B) Creating your forms html page or configuring the bizmail.html Template File ......(1C) success.html settings (2) UPLOADING FILES & SETTING PERMISSIONS (includes reference list of CHMOD permission equivalents) ========================================================== =========================== (1) CONFIGURATION SETTINGS =========================== The only files you need to edit are bizmail.cgi, plain.mes, html.mes, bizmail.html, success.html and (success.cgi -OPTIONAL-). bizmail.dat is a blank file that does not need to be edited. This is the data file where all form posts will be stored. =========================== (1A) Check bizmail.cgi Path to Perl. =========================== Make sure the path to PERL is correct. (THIS IS LOCATED ON THE VERY FIRST LINE OF THE bizmail.cgi script.) By default it is set to: #!/usr/bin/perl =========================== (1A-I) Set the variable values in bizmail.cgi as follows. =========================== *** For added privacy and security the $sendto and $cc_to reply emails are set in the actual bizmail.cgi script. Biz Mail Form lets your form data be sent to email address's in the actual script, preventing un-authorized person(s) from using your script to post their own forms. (such as spamers) This also provides the script user with added privacy, by preventing visitors from seeing your email address. (Note: That you can specify the send to and cc to emails in the form with the number associated with the email address in the bizmail.cgi file. This is explained below, with the setup of the bizmail.html page.) ------------------------------ $useLib $useLib defines the method of sending the email auto response and email form info. Example: To send mail via "SENDMAIL" (Most Common): $useLib = "sendmail"; OR - To send mail via "SMTP" server: $useLib = "smtp"; ------------------------------ $mailprog Used if you're using "SENDMAIL". Enter the path to send mail on your server. Example: $mailprog = "/usr/lib/sendmail"; ------------------------------ $smtp_server This is only used if you're not using "SENDMAIL". Enter the SMTP address on your server. Example: $smtp_server = "smtp.host.com"; ------------------------------ $reply_from_name The $reply_from_name variable refers to the from name that will apear on auto response email and the form data email. Example: (IF YOUR NAME IS "John Doe") $reply_from_name = "John Doe"; ------------------------------ $sendto{""} Simply enter all the possible email address's you want to receive your form data to. The "sendto" selected will also be the reply email address, if you use send reply. MAKE sure that when entering this variable to remember the \ before the @ sign. Example Config: $sendto{"1"} = "mail1\@yourdomain.com"; ## (REMEMBER THE \ BEFORE THE @ SIGN)## $sendto{"2"} = "mail2\@yourdomain.com"; $sendto{"3"} = "mail3\@yourdomain.com"; $sendto{"4"} = "mail4\@yourdomain.com"; $sendto{"5"} = "mail5\@yourdomain.com"; Example: if you want to send your form data results to mail1@yourdomain.com: Then on your HTML form page you would insert the below 'field' with the value of 1 (as shown below): -OR- if you want to send your form data results to mail2@yourdomain.com: Then on your HTML form page you would insert the below 'field' with the value of 2 (as shown below): Etc.... ...GOING FURTHER If you have multiple forms and you want to use multiple email address's you want to Send the form data results to simply add additional variables as shown below. You could add more fields if you have more email address's you want to send data to. So for example if you have 10 the config should look something like the below: $sendto{"1"} = "mail1\@yourdomain.com"; ## (REMEMBER THE \ BEFORE THE @ SIGN)## $sendto{"2"} = "mail2\@yourdomain.com"; $sendto{"3"} = "mail3\@yourdomain.com"; $sendto{"4"} = "mail4\@yourdomain.com"; $sendto{"5"} = "mail5\@yourdomain.com"; $sendto{"6"} = "mail6\@yourdomain.com"; $sendto{"7"} = "mail7\@yourdomain.com"; $sendto{"8"} = "mail8\@yourdomain.com"; $sendto{"9"} = "mail9\@yourdomain.com"; $sendto{"10"} = "mail10\@yourdomain.com"; ------------------------------ $cc_to{""} This variable is configured and implemented almost exactly like the 'sendto'. Simply enter all the possible email address's you may want to receive a carbon copy email with the form data to. MAKE sure that when entering this variable to remember the \ before the @ sign. Example Config: $cc_to{"1"} = "ccto1\@yourdomain.com"; ## (REMEMBER THE \ BEFORE THE @ SIGN)## $cc_to{"2"} = "ccto2\@yourdomain.com"; $cc_to{"3"} = "ccto3\@yourdomain.com"; $cc_to{"4"} = "ccto4\@yourdomain.com"; $cc_to{"5"} = "ccto5\@yourdomain.com"; Example: if you want to carbon copy your form data results to ccto1@yourdomain.com: Then format the send to field as follows: -OR- if you want to carbon copy your form data results to ccto2@yourdomain.com: Then format the send to field as follows: Etc.... GOING FURTHER If you have multiple forms and you want to use multiple email address's you want to Carbon Copy the form data results to simply add additional variables as shown below. So for example if you have 10 the config should look something like the below: $cc_to{"1"} = "ccto1\@yourdomain.com"; ## (REMEMBER THE \ BEFORE THE @ SIGN)## $cc_to{"2"} = "ccto2\@yourdomain.com"; $cc_to{"3"} = "ccto3\@yourdomain.com"; $cc_to{"4"} = "ccto4\@yourdomain.com"; $cc_to{"5"} = "ccto5\@yourdomain.com"; $cc_to{"6"} = "ccto6\@yourdomain.com"; $cc_to{"7"} = "ccto7\@yourdomain.com"; $cc_to{"8"} = "ccto8\@yourdomain.com"; $cc_to{"9"} = "ccto9\@yourdomain.com"; $cc_to{"10"} = "ccto10\@yourdomain.com"; ====================================== OPTIONAL FIELDS THAT CAN BE CONFIGURED IN bizmail.cgi ====================================== ------------------------------ $PRNT_blankfields Set $PRNT_blankfields = "2"; to not send & leave out blank form field results to your email (DEFAULT) set $PRNT_blankfields = "1"; to send blank form field results to your email $PRNT_blankfields = "1"; ------------------------------ $MY_error_page This is the HTML TEMPLATE file that will be accessed when an error occurs upon processing the script. ** The Page selected below should be uploaded to your cgi-bin. $MY_error_page = "error.html"; Note: There is more information on configuring this HTML TEMPLATE page in section (1A-IV) of this readme file. ------------------------------ $datafile{""} Simply enter all the possible datafiles you want to send form data to. Example Config: $datafile{"1"} = "bizmail.dat"; $datafile{"2"} = "secondfile.dat"; $datafile{"3"} = "etc.dat"; Example: if you want to use bizmail.dat as your data file: Then format the "datafile" field on the form as follows: -OR- if you want to use secondfile.dat as your data file: Then format the "datafile" field on the form as follows: Note, you can have as many datafile entries as you would like in bizmail.cgi IF YOU LEAVE THIS FIELD OUT OF THE FORM IT WILL DEFAULT TO bizmail.dat ------------------------------ $send_data_results set $send_data_results = "2"; to not send form results to the data file (DEFAULT) set $send_data_results to "1" to send form results to the data file $send_data_results = "1"; ------------------------------ $send_email_results Set $send_email_results = "2"; to not send form results to your email (DEFAULT) set $send_email_results to "1" to send form results to your email $send_email_results = "1"; ------------------------------ $delete_dups NEW FUNCTION! For people generating leads! Using the $delete_dups variable you can specify if you want to delete all duplicate leads posted on the form and data sent to the data file. If $delete_dups is set to 1 all dups will be deleted. To leave duplicate posts set $delete_dups to 2. (2 IS THE DEFAULT & MOST COMMON CHOICE) Example: if you DO NOT want to delete duplicate posts (DEFAULT & MOST COMMON): $delete_dups = "2"; OR - To delete all duplicates: $delete_dups = "1"; NOTE: A duplicate is determined by the email field. ------------------------------ $send_attachement $send_attachement specifys if you want to send an attachment with the auto response. to send attachment with auto-response set $send_attachement = "1"; To not send attachment with auto-response set (DEFAULT) $send_attachement = "2"; IF USING A FILE ATTACHMENT YOU MUST CONFIGURE THE BELOW THREE VARIABLES BELOW $attachment_nm = "file.txt"; ## file name of attachment ## $att_path = "/path/to/$attachment_nm"; ## Path to file attachment ## $att_format = ".txt"; ## File attachment extension, or file type ( basically .extension ) ## -------------------------------------- $setokurl to use @okurls to verify the URL the form is submitted by; set $setokurl to 1 and set $setokurl to 0 if you do not want to use @okurls to verify form submission URL. Example: $setokurl = "0"; # WOULD NOT REQUIRE URL VALIDATION # $setokurl = "1"; # WOULD REQUIRE URL VALIDATION # Only web address's entered below will be allowed to process the form if $setokurl is set to 1. @okurls = ("http://www.yourdomain.com", "http://yourdomain.com", "34.344.344.344"); =========================== (1A-I) Edit plain.mes as follows. =========================== This is the email reply that the form poster will receive automatically after they complete the form IF plain text is the chosen format for sending messages the auto-response. Edit plain.mes, and replace the current text in the file with the message you want to be sent as the plain text auto-response message. No HTML tags will work in this file. You can personalize this auto-response message. You can read more on personalization TAGS below in the personalization read me section (1A-III). =========================== (1A-II) Edit html.mes as follows =========================== This is the email reply that the form poster will receive automatically after they complete the form IF html is the chosen format for sending messages the auto-response. Edit html.mes, and replace the current text in the file with the HTML message you want to be sent as a reply message. You can personalize this auto-response message. You can read more on personalization TAGS below. =========================== (1A-III) P E R S O N A L I Z A T I O N O F Y O U R A U T O - R E S P O N S E E M A I L =========================== You can personalize the (HTML -or- PLAIN TEXT) auto-response email and auto-response email subject the form poster receives. For every field used in the form there is a proportionally Corresponding personalization TAG. Each personalization tag is exactly the same as the form field "NAME" What ever the form field (NAME="") is equal to, the personalization tag corresponds with this like: {FIELD_NAME} [ T H E S E T A G S A R E C A S E S E N S I T I V E ] These tags can be used in the PLAIN TEXT & HTML auto-response emails. Example: {firstname} - would be the personalization tag for this field ------------------------------------------------ {FIRSTNAME} - IN THIS EXAMPLE WOULD NOT WORK ------------------------------------------------ (If Joe is entered in the field ) In the below example of the a PLAIN TEXT auto-response email message: {firstname}, thanks for filling out the form. WOULD READ: Joe, thanks for filling out the form. ANOTHER EXAMPLE: Personalization TAG would = {First_Name} Personalization TAG would = {email} Personalization TAG would = {PHONE} ETC.... =========================== (1A-IV) Editing error.html Template =========================== The error.html page allows you to personalize all the error pages as well as the default success page that Biz Mail Form has. You would simply enter regular html into this file and it will appear on the error & success page. Custom Fields contained in error.html <%TITLE%> the "%TITLE%" TAG is configured to the appropriate error page title. ALREADY FORMATED WITH END TITLE TAG! EXAMPLE: