charset=¶

charset="utf-8"

This allows you to set the character set of the email being sent. Use this if your form’s template is using a character set other than iso-8859-1.

name=¶

name="myForm"

This allows you to set a name= attribute for the form. Keep in mind that name= is deprecated in XHTML.

recipients=¶

This optional parameter allows you to specify an email address to receive the email:

recipients="admin@example.com"

To specify more than one recipient, separate each email address with a comma:

recipients="admin@example.com,ceo@example.com,president@example.com"

redirect=¶

redirect="5"

After the form is submitted, the user will be shown a message stating that the submission was successful. With this parameter you can determine how long ExpressionEngine should display the message. The value for this parameter is set in the number of seconds. For instance, if you want the message displayed for six seconds, you would use

redirect="6"

You may also set ExpressionEngine to not redirect the user after they reach the message page. In that case, the user would simply remain on the message page. To do this, set the value to none:

redirect="none"

replyto=¶

replyto="yes"

By default the email address sending the email will be put in the From header for the email. If this parameter is set to “yes”, then that email address will be put into the Reply-To field and the site’s webmaster email will be put in the From header. This is necessary at times because certain email servers will not send an email with an address not from its domain, so ExpressionEngine will use the site’s webmaster email address to get past this restriction while still allowing any replies to go to the sender of the email.

return=¶

return="http://example.com/index.php"

This parameter lets you specify a URL where the user should be directed after the form is submitted. Upon submission, the user is presented with a standard “thank you” message and a link. If this parameter is not used, then the link will point to the page they were on prior to arriving at the email form.

return="http://example.com/index.php"

If used with the redirect=”none” parameter, the link text can be specified by adding the pipe character and the desired link text. If you are specifying only the link text, then you must precede it by the pipe character:

return="http://example.com/index.php|Return to Home Page"

return="|Return to the Site"

preview=¶

preview="about/contact-preview"

Specify a URL where the user can preview their message before sending it. This can be used in conjunction with the markdown= parameter.

markdown=¶

markdown="yes"

Optionally enable Markdown processing for message of the contact form.

user_recipients=¶

user_recipients="yes"

user_recipients="no"

The user_recipients parameter specifies whether or not the form will accept having the user input recipients via a ‘to’ field in the form. If set to true, then you can create a form field with the name “to” in which a user can input addresses where the email should be sent. The default value is “no”.

form_class=¶

form_class="my_form"

With this parameter, you can specify the css class you want the form to have, enabling fine-grained styling of the form.

form_id=¶

form_id="contact_form"

With this parameter, you can specify the css id you want the form to have. The default value is ‘contact_form’.

author_email¶

{author_email}

If you create a permalink to a page containing the {exp:email:contact_form} tag, then the form allows the use of this variable to put in the email address of the author who wrote the linked entry. This feature allows the creation of a “contact author” page.

author_name¶

{author_name}

If you create a permalink to a page containing the {exp:email:contact_form} tag, then the form allows the use of this variable to put in the screen name of the author who wrote the linked entry. This feature allows the creation of a “contact author” page.

member_email¶

{member_email}

If a user is logged in, then it will display their email address as recorded in their member profile.

member_name¶

{member_name}

If a user is logged in, then it will display their screen name as recorded in their member profile.

captcha¶

<input type="text" name="captcha" value="" maxlength="20" />

The CAPTCHA input for the form. It is usually used with a conditional so that it is only displayed if necessary:

{if captcha}
        <p>Please enter the word you see in the image below:</p>
        <p>{captcha}<br /> <input type="text" name="captcha" value="" maxlength="20" /></p>
{/if}

The setting to disable or enable CAPTCHA for the contact form can be found in the Email Configuration preferences.

from¶

<input type="text" name="from" size="40" />

Email address of person who is sending the email. You must include this form field, even if it is just a hidden field.

message¶

<textarea name="message" rows="10" cols="40"></textarea>

Main message of the email. You must include this form field, even if it is just a hidden field.

You may specify multiple fields by making the name= attribute an array by using “message[]”. For example:

Home Phone: <input type="text" name="message[]" size="12" maxlength="15" /><br /> <br />
Cell Phone: <input type="text" name="message[]" size="12" maxlength="15" />

name¶

<input type="text" name="name" size="40" />

Name of person who is sending the email.

required¶

<textarea name="required" rows="5" cols="40" readonly="readonly"></textarea>

This field allows you to have required information that is included at top of each email. Useful for support emails where the information can be readonly or hidden.

You may specify multiple fields by making the name= attribute an array by using “required[]”. For example:

Age: <input type="text" name="required[]" size="3" maxlength="3" /><br /> <br />
Bio: <textarea name="required[]" rows="5" cols="40"></textarea>

subject¶

<input type="text" name="subject" size="40" />

Subject of the email that is being sent. You must include this form field, even if it is just a hidden field.

to¶

<input type="text" name="to" size="40" />

Email address to which the email is being sent. Multiple email addresses may be specified by separating them with a comma. You must include this form field, even if it is just a hidden field. This data may also be specified with the recipients= parameter of the tag.