Custom form email options screen

The Email options screen allows you to define the different emails sent when a user submits the custom form.

Keyword replacements

In addition to the keyword replacement options shown underneath each email, you can use the response keyword replacements within the fields available for each email option. Click on the List of keywords available for use in emails link to list the available keyword replacements.

Recipient email options

In this section, you can format the email sent to those needing to be notified when form submissions are made. For example, if the form is a job application you can send an email to the HR manager to notify them that a user has applied for a job.

Recipient email format

The recipient email format options define the format of the recipient email.

The fields that are available in this section are as follows.

To

Enter the email address of a person who should receive the email. You can enter their email address in the text fields or select their user account in the asset finder field.

From

Enter the email address that will appear in the From field in the email.

Reply-to

Enter the email address to which they will reply. If no reply-to address is configured, the header is not sent on the email.

If you have a form field where the user has supplied an email address, use the corresponding response keyword replacement in this field to use this as the reply-to address. This setting allows the recipient of the email to respond directly to the user who submitted the form. Click on the List of keywords available for use in emails link in the keyword replacements section of the screen for a full list of keyword replacements.
Subject

Enter the text to be used as the subject of the recipient email. You can use keyword replacements for the responses to the form fields the user entered on the form. Click on the List of keywords available for use in emails hyperlink in the keyword replacements section of the screen for a full list of keyword replacements.

Attachments

Check the include file attachments box to attach the files uploaded through a file upload form field type to this email. The Attach to emails option on the Details screen of the File uploaded form field must be Yes.

Body

Enter the body of the email. You can enter either the text or HTML version of the email in this field. To edit the HTML version, click on the edit icon. A WYSIWYG editor will appear. You can use the keyword replacements for the form fields the user entered on the form within the email body.
For a full list of keyword replacements, click on the List of keywords available for use in emails hyperlink in the screen’s keyword replacements section. Along with these keyword replacements, you can also use the following:

%form_info%

This will show information about the custom form, including the asset ID, name and URL of the form, and the name and asset ID of the site.

%form_summary%

This will show the responses that the user entered on the form.

Custom file attachments

The custom file attachments options allow you to configure file attachments on the recipient email.

The fields available in this section are as follows:

Asset to send

Specify the asset to send as a file attachment on the email.

File name

Enter the name of the file attachment. If you have selected a non-file type asset in the asset to send field, the extension used in this field will determine the type of file attached to the email.
For example, if you select a standard page asset and enter index.html as the file’s name, it will be attached to the email as an HTML file. If no file name or extension is provided, the asset will be sent as a text file, by default, and the selected asset’s name will be used as the name of the file.

Design to apply

Specify a design asset to apply a design to the selected asset to send. This field is only applicable when dealing with non-file type assets. Read the Working with designs documentation for more information about applying designs to assets.

Layout to apply

Specify a paint layout asset to apply a layout to the selected asset to send. This field is only applicable when dealing with non-file type assets. Read the Working with paint layouts documentation for more information about apply layouts to assets.

Dynamic parameters

Allows you to source the asset to send ID for the dynamically sent email based on GET, POST, or SESSION variables, current asset, current user, current site, set value, or any PHP superglobal variable like those described on the PHP language variables website.

Additional get parameters

Allows you to send extra get variables to the asset that is being attached. This field is useful if you want to send a dynamic root node to an asset listing to send or have conditional keywords on a standard page based on these get parameters.

Delete

Select this field and click Save to delete this file attachment.

You can add additional file attachments by selecting the Add new file attachment field and clicking Save.

Receipt email options

This section allows you to define an email to send to the user who submitted the form.

The fields that are available in this section are as follows.

Receipt recipient form field

Select an email address form field type from the custom form in this field. The email is sent to the email address the user enters into the form’s selected form field. No email is sent if this field is empty.

To

Enter any additional email addresses for the people who should receive the email. You can enter their email address in the text fields or select their user account in the asset finder field.

From

Enter the email address that will appear in the From field in the email. You may want to put the email address of the person who will manage the submission, such as the HR manager, so that the user can contact an appropriate person within your organization.

Reply-to

Enter the email address to which a user will reply. If no reply-to address is configured, the header is not sent on the email.

Subject

Enter the text to be used as the subject of the email. You can use keyword replacements for the responses the user entered on the form. For a full list of keyword replacements, click on the List of keywords available for use in emails hyperlink in the screen’s keyword replacements section.

Attachments

Check the include file attachments box to attach the files uploaded through a file upload form field type to this email. The Attach to emails option on the Details screen of the File uploaded form field must be set to Yes.

Body

Enter the body of the email. You can enter either the text or HTML version of the email in this field.
Click on the edit icon to edit the HTML version. A WYSIWYG editor will appear.
You can use the keyword replacements for the responses the user entered on the form. For a full list of keyword replacements, click on the List of keywords available for use in emails hyperlink in the screen’s keyword replacements section. Along with these keyword replacements, you can also use the following:

%form_info%

This will show information about the custom form, including the asset ID, name and URL of the form, and the name and asset ID of the site.

%form_summary%

This will show the responses that the user entered on the form.

Send to a friend email options

This section allows you to set up an email that can be used in a Send to a friend hyperlink.

The fields that are available in this section are as follows.

STAF recipient form field

Select an email address form field type from the custom form in this field. The email will be sent to the email address the user enters into the form’s selected form field. If this field is empty, this email will not be sent.

To

Enter any additional email addresses of the people who should receive the email. You can enter their email address in the text fields or select their user account in the asset finder field.

From

Enter the email address that will appear in the From field in the email. You can use a keyword replacement for the responses that the user entered on the form. For a full list of keyword replacements, click on the List of keywords available for use in emails hyperlink in the screen’s keyword replacements section.

Reply-to

Enter the email address to which a user will reply. If no reply-to address is configured, the header will not be sent on the email.

Subject

Enter the text to be used as the subject of the email. You can use keyword replacements for the responses that the user entered on the form. For a full list of keyword replacements, refer to the list of available keyword replacements in the keyword replacements section of the screen.

Attachments

Check the include file attachments box to attach the files uploaded through a file upload form field type to this email. The Attach to emails option on the Details screen of the file uploaded form field must be Yes.

Body

Enter the body of the email. You can enter either the text or HTML version of the email in this field. To edit the HTML version, click on the edit icon. A WYSIWYG editor will appear. You can use the keyword replacements for the responses that the user entered on the form. For a full list of keyword replacements, click on the List of keywords available for use in emails hyperlink in the screen’s keyword replacements section. Along with these keyword replacements, you can also use the following:

%form_info%

This will show information about the custom form, including its asset ID, name and URL of the form, and the name and asset ID of the site.

%form_summary%

This will show the responses that the user entered on the form.

%referral_url%

This keyword replacement will add the URL of the last page that the user was viewing before they viewed the custom form.

%referring_asset_<keywordreplacement>%

You can use keyword replacements from the referring asset by appending the regular asset keyword replacement onto the end of %referring_asset_.
For example, if you want to show the referring asset’s name, use the keyword replacement %referring_asset_attribute_name%. The referral asset is the last page the user was viewing before they viewed the custom form.

Setting up a send to a friend form

To use the send to a friend option:

  1. Create a custom form and add an email address form field type.

  2. Select the email address form field in the STAF recipient form field field.

  3. Format the body of the email and include the keyword replacement %referral_url%.

  4. Fill out the remaining fields in the send to a friend options section.

  5. Create a hyperlink to the form from a page in the site or add a hyperlink within your design.

When the user clicks on the hyperlink, they will be able to enter an email address. Once they click Submit, the send to a friend email will be sent to the email address the user entered. The URL of the asset they were looking at before they clicked on the hyperlink will be included within the email body.

© 2015-2020 Squiz Pty Ltd