Necessary Configuration Parameters
There is only one necessary parameter, and that is the recipient.
| Field | recipients |
| Description: |
This form field allows you to specify the e-mail recipient(s) of your form results.
You can include multiple recipients by separating the values with commas. |
| Syntax: |
recipients=user1@bethel.edu,user2@somewhereelse.com |
|
Optional Configuration Parameters
| Field | recipient_from |
| Description: |
This parameter allows you to specify the return email address of the envelope header. If this is not specified, the first email address in the recipients parameter will be used. NOTE: this needs to be a bethel email address! |
| Syntax: |
recipient_from=user1@bethel.edu |
|
| Field | subject |
| Description: |
The subject field will allow you to specify the subject
that you wish to appear in the e-mails that are sent after the form has been filled out. Depending on the e-mail, 'submission'
or 'confirmation' will automatically be appended to this. You can also insert the value of a form field into the subject line.
Use the pattern: $[fieldname]. The form field is truncated to a length of no more than 30 characters before it is added to the subject.
The default if not present in configuration:
Bethel Form (Submission or Confirmation) |
| Syntax: |
subject=Your Subject
To change the subject to Bethel Admissions Form:
subject=Bethel Admissions Form
subject=CARS Account Request LOGIN: $[LoginName]
Now in the recipient e-mail, the subject will be: 'Bethel Admissions Form Submission', and if there is a confirmation e-maill,
the subject will be: 'Bethel Admissions Form Confirmation'. On the second example, if the value of the LoginName input field was 'myusername',
the subject would be 'CARS Account Request LOGIN: myusername'.
|
|
| 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 'require' parameter.
|
| Syntax: |
<input type=text name="email">
|
|
| Field | confirm_email_fields |
| Description: |
If this field is set, a copy of the confirmation e-mail will be sent to all valid e-mail addresses
in this list. Note: confirmemail must be set in order to use this field!
|
| Syntax: |
confirm_email_fields=email1@somewhere.com,email2@someotherplace.net,email3@bethel.edu
|
|
| Field | stdtemplate |
| Description: |
There are a couple results html templates that are supplied, so you don't need to create your own. There is one template for each major look and feel on the website. Current, there are three of these: Bethel Official (official), Bethel College (college), and Bethel CGCS (cgcs).
|
| Syntax: |
To use one of these templates, include this parameter in the configuration file, with it's value being 'official','college', or 'cgcs'.stdtemplate=cgcs
|
|
| Field | confirmemail |
| Description: |
If you wish to send a confirmation e-mail to the submitter of the form, place this in that form's configuration file. If confirmheader and confirmfooter are not present in the configuration file, then suitable defaults will be used. The default looks like this:
Bethel College and Seminary online forms submission.
The following is the information that you posted on DATE:
LIST OF FORM RESULTS, ONE FORM FIELD PER LINE
|
| Syntax: |
confirmemail=1
|
|
| Field | confirmheader |
| Description: |
Use this option to specify the first line or few of the confirmation e-mail. If this is not present in the configuration file, then the default will be used.
Default:
The following is the information that you posted on DATE
If your form is configured to send a confirmation e-mail (via confirmemail), then you should also use this.
|
| Syntax: |
confirmheader="Listed below is what you submitted to us."
|
|
| Field | confirmfooter |
| Description: |
Use this option to specify the last line or few of the confirmation e-mail. If this is not present, then there will be no footer.
Using this is suggested if you are sending confirmation e-mails.
|
| Syntax: |
confirmfooter="Thank you for your interest in Bethel College and Seminary."
|
|
| Field | jsfields |
| Description: |
When this parameter is used in conjunction with the jsfields template function, the form fields specified here are converted to javascript variables and inserted into the
results html page. In this way, you can develop a template that can display something different depending on what was input into the form. An example of where this could come in handy would be if you wanted to display a different page depending on whether the form submitter selected a 'yes' or 'no'. Check the jsfields template function for an example.
|
| Syntax: |
jsfields=answer,email
|
|
| Field | namemap |
| Description: |
This is a comma-delimited list of field/name pairs. This allows you to change the name
of a field in the results html and e-mails. A good use of this is to provide a better description
(which allows spaces, etc) than a field name. |
| Syntax: |
namemap=cname:Contact Name,fname:First Name,lname:Last Name
|
|
| Field | referer |
| Description: |
This is a regular expression of sites that are allowed to use this form. |
| Syntax: |
To let all bethel sites use this form:
referer=bethel
To only allow referals from www.bethel.edu:
referer=www.bethel.edu
To only allow referals from one form:
referer=www.bethel.edu/admissions/admform.htm
|
|
| Field | allowurls |
| Description: |
This is a list of fields in the form that allow http or ftp urls to be placed in.
By default, no (http://name or ftp://name) text is allowed in any form field, which reduces the appeal
to spammers. |
| Syntax: |
allowurls=website,comments
|
|
| Field | hidefields |
| Description: |
This is a list of fields that aren't presented in the results page and the two e-mails that
are sent out. This is most useful for named form fields that don't need to be in the results, like a
submit or reset button. |
| Syntax: |
hidefields=submit
|
|
| 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: |
<input type=text name="realname">
|
|
| Field | redirect |
| Description: |
If you wish to redirect the user to a different URL,
you can use this to send them to a pre-made HTML page.Note: if you wish to supply a custom
'Thank you' page, you should use the results template as described in the 'New Features' section |
| Syntax: |
redirect=http://your.host.com/to/file.html
|
|
| Field | require |
| Description: |
You can now require certain fields in your form to be filled in before the user
can successfully submit the form. 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.
Note: 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:
require=email,phone,fname
|
|
| 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 the 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.
If you are also using the sort_on param, make sure the environment variables you want to include are listed in that param! |
| Syntax: |
If you wanted to find the remote host and browser sending the request:
env_report=REMOTE_HOST,HTTP_USER_AGENT
|
|
| 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 FormMail generates.
You can choose to have the field sorted alphabetically or specify an order.
If this is left out, it will default to the order in which the browser has sent form (usually the same order the form. |
| Syntax: |
To sort alphabetically:
sort=alphabetic
To sort by a set field order:
sort=order:name1,name2,etc...
|
|
| 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 and results messages. By default, no config fields are printed. |
| Syntax: |
If you want to print the email and subject fields:
print_config=email,subject
|
|
| Field | print_blank_fields |
| Description: |
print_blank_fields allows you to request that all form fields are printed in the e-mail
and results messages, regardless of whether or not they were filled in. The default is off. |
| Syntax: |
print_blank_fields=1
|
|
| 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. The default title is 'Bethel Thanks You'. |
| Syntax: |
If you wanted a title of 'Feedback Form Results':
title=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 results page page. This field will not be used if you have the redirect field set.
It is useful if you want to allow the client to return to some other page. |
| Syntax: |
return_link_url=http://your.host.com/main.html
|
|
| Field | return_link_title |
| Description: |
This is the title that will be used to link the user back to the page you specified with return_link_url. |
| Syntax: |
return_link_title=Back to Main Page
|
|
| Field | abuselimiter |
| Description: |
If your form is publicly accessible (e.g. not on bethelnet) and it is sending confirmation e-mails, then you need to turn on the abuse limiter. This feature makes our forms less appealing to spammers. |
| Syntax: |
abuselimiter=on
|
