allow_html=¶

allow_html="yes" allow_html="<p>,<a>" allow_html="no"

The channel entry variables (see Channel Variables below) are formatted according to the formatting specified when the entry was submitted, so there is a possibility of HTML being output. This parameter allows you the choice of whether to keep the HTML in the form fields, allow only certain HTML tags (by specifying the tags as a comma-separated list), or allow no HTML to remain. If HTML is left in, then the email will be automatically sent as an HTML email.

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.

recipients=¶

recipients="admin@example.com"

You may specify hidden recipients for the form. This is who will receive the submitted information. You may specify more than one recipient by separating the email addresses with commas:

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

redirect=¶

redirect="5"

After the form is submitted, the user will be shown a page stating that the submission was successful. With this parameter, you can determine how long ExpressionEngine displays that page. 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="email/thanks"

return="email/thanks"

return="about|Return to About Page"

return="|Return to the Site"

status=¶

status="open"

The channel status you would like entries restricted to. This is useful if you will be displaying entries with a status other than “open”. You can choose multiple statuses using a pipe:

status="draft|reviewed|published"

Or exclude statuses using “not”

status="not submitted|processing|closed"

channel=¶

channel="news"

Specify from which channel you would like to allow Tell-a-Friend emails to be sent. This parameter is useful if you have multiple entries with the same URL Title in different channels. Unless you restrict this EE tag to a particular channel then you might get Tell-a-Friend forms for all entries matching the URL Title.

preview=¶

preview="about/tell-a-friend-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 Tell-a-Friend form.

form_class=¶

form_class="tellafriend_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="tellafriend_form"

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

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 tell-a-friend 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.

message¶

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

Main message of the email. If you do not wish to have the tell-a-friend message modified then we suggest using a hidden form field or setting the textarea as read only (ex: <textarea readonly=”readonly”></textarea>). You must include this form field, even if it is just a hidden field.

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>

Field allows you to have required information that is included at top of each email message. Useful for support emails where the information can be read only or hidden.

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 where 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.