*------------------------------------------------------------------------------- * JFormMail Information *------------------------------------------------------------------------------- *-[JFormMail]- * Author : Sunil Amber * First Release : 17th May 2002 * Version ID : $JFormMail, v1.1, 22/06/2003, 18:00:00 Sunil.K.S$ * JFormMail URL : http://jformmail.sourceforge.net * * JFormMail is a universal WWW form to E-mail gateway. * It is similar to Matt's popular FormMail.pl script. * The only difference is that mine is written in Java. * * Please see changes and features in Changelog.txt * *------------------------------------------------------------------------------- * -[Copyright / Redistribution / Terms Of Usage]- * Copyright 2002-2007 Sunil Amber * Homepage: http://www.sunilamber.com/ * * This program is free as long the above mentioned copyright * and comments are kept intact. By using this program you agree * to indemnify Sunil Amber from any liability that might arise from its use. * * Selling the code for this program without prior written consent is * strictly forbidden. * * Obtain permission before redistributing this software over the Internet or * in any other medium. In all cases copyright and header must remain intact. *------------------------------------------------------------------------------- Comments ========== JFormMail supports 100% of all functions implemented by Matt's JFormMail. (I would be glad to be informed of any functionality that I might have missed out) Future versions will continue to support all functions implemented by Matt's FormMail. Please visit http://jformmail.sourceforge.net/ for the latest updates. Credits ========== This servlet is basically a rewrite of Matt's JFormMail. Please checkout his site at http://www.scriptarchive.com/ Notes ========== The JFormMail servlet was developed & tested on a win2k professional machine with the following Tools: -Apache Tomcat 4.1 (java.apache.org) -MS SMTP Server (Running as a local service, comes with win2k) -JDK 1.4 (java.sun.com) -Editplus (www.editplus.com) JFormMail has also been tested on a RedHat Linux running the following software with the specified configuration: -RedHat Linux -Tomcat 4.1 Addtional APIs ============== JFormMail uses the javax.regex library explicitly available in JDK 1.4. Hence, JFormMail is unlikely to work in older Java Runtime Environments. You may also need to install Java Mail APIs seperately if it is not already installed. Tomcat 4.1 (full edition, not the LE !!) already comes with these set of APIs. Java Mail API can be downloaded from http://java.sun.com/products/javamail/ Installation ============= Unzip the file jformmail1-1.zip into your web application folder of your Servlet Engine. For example ... On Windows 2000, ---------------- I place mine in "C:\Program Files\Apache Group\Tomcat 4.1\webapps" I.e You should have something similar to the following: "C:\Program Files\Apache Group\Tomcat 4.1\webapps\ssm" On RedHat Linux ---------------- I place mine in "/home/tomcat/webapps" I.e You should have something similar to the following: "/home/tomcat/webapps/ssm" Installation is complete. JFormMail is controlled by a single configuration script. This script can be found in the main servlet directory of the JFormMail app. Example: "C:\Program Files\Apache Group\Tomcat 4.1\webapps\ssm\WEB-INF\classes\JFormMail.ini" -or- "/home/tomcat/webapps/ssm/WEB-INF/classes/JFormMail.ini" Modify the configuration file to suit your needs. (You need to restart the JFormMail app everytime you modify the config file.) NOTE: JFormMail has been written such that it searches for the configuration file JFormMail.ini under the application servlet directory (e.g /WEB-INF/classes). If you wish to place your configuration file in another directory for a reason, please specify its location in the JFormMail.java (in the init() method) file and recompile the servlet. You are done !! Problems ?? Suggestions ?? Comments ?? Contact me at ssm[AT]sunilamber.com Cheers -SUNIL AMBER ----------------------------------------------------------------------------- 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. 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 JFormMail 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. As of version 1.1, You can include multiple recipients by separating the values with commas. Syntax: To send results of the form to a single recipient: For multiple recipients: ----------------------------------------------------------------------------- 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: To allow the user to choose a 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: ----------------------------------------------------------------------------- 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: ----------------------------------------------------------------------------- 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: To allow them to specify a URL they wish to travel to once the form is filled out: ----------------------------------------------------------------------------- Field: required 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: ----------------------------------------------------------------------------- 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: 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. Syntax: If you wanted to find the remote host and browser sending the request, you would put the following into your form: ----------------------------------------------------------------------------- Field: sort Description: This field allows you to choose the order in which you wish for your variables to appear in the e-mail that JFormMail 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: To sort by a set field order: ----------------------------------------------------------------------------- Field: print_config 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: ----------------------------------------------------------------------------- Field: print_blank_fields 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. JFormMail defaults to turning this off, so that unused form fields aren't e-mailed. Syntax: If you want to print all blank fields: ---------------------------------------------------------------------------- Field: title 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': ----------------------------------------------------------------------------- Field: return_link_url 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: ----------------------------------------------------------------------------- Field: return_link_title 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: Syntax: ----------------------------------------------------------------------------- Field: missing_fields_redirect 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: ----------------------------------------------------------------------------- Field: background 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: ----------------------------------------------------------------------------- Field: bgcolor 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: ----------------------------------------------------------------------------- Field: text_color 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: ----------------------------------------------------------------------------- Field: link_color Description: Changes the color of links on the resulting page. Works in the same way as text_color. Should not be defined if redirect is. Syntax: For a link color of Red: ----------------------------------------------------------------------------- Field: vlink_color Description: Changes the color of visited links on the resulting page. Works exactly the same as link_color. Should not be set if redirect is. Syntax: For a visited link color of Blue: ----------------------------------------------------------------------------- Field: alink_color Description: Changes the color of active links on the resulting page. Works exactly the same as link_color. Should not be set if redirect is. Syntax: For a visited link color of Blue: ----------------------------------------------------------------------------- Any other form fields that appear in your script will be mailed back to you and displayed on the resulting page if you do not have the redirect field set. There is no limit as to how many other form fields you can use with this form, except the limits imposed by browsers and your server. ----------------------------------------------------------------------------- Some of the possible uses of this script are (According to Matt's FormMail.pl) 1) You want to have a form that will be mailed to you, but aren't sure how to write the CGI script for it. 2) You are the webmaster of your site and want to allow users to use forms, but not to have their own cgi-bin directories, which can cause security risks to your system. You can set this script up and then allow all users to run off of it. 3) Want to have one script to parse all of your html forms and mail them to you. For JFormMail 1)You want a Java substitute to FormMail.pl cos your server does not support CGI. 2)You don't have a sendmail substitute for windows. 3)(Anything else you might know that I don't....pls let me know and i will add it here)