The variables can be used in the email body, email subject, and sender data (name and email). While each of these can use static values, using the templates can help you create a better and more handy email for both the admins and the users.
The variables can be simple texts (e.g. form title), URLs (form logo, form address), or some other rendered data (results table). Generally, the variables contain a range of data, from the data related to the form itself to the data submitted by the user, or calculated based on that data.
In the following, we will show a list of currently available variables.
Note: For each value, if they’re null or blank, they will be replaced by an empty text in the final render.
This group of variables all contains the
form_ prefix. These are extremely handy if you want to create a template to use on multiple forms.
form_title: Title of the form.
form_description: Form’s description. Note that this field may have its own styling since it’s created using WYSIWYG.
form_success_message: Form’s success message, since you may want to include it in the email as well.
form_currency: Forms currency code (ISO). For example
form_full_address: A URL to the form’s display page (as seen by the end-user). If you’re using subdomains or custom domains, it will be linked to your custom URL. But if you’ve embedded the form in a custom page, it won’t be linked to that page.
form_logo: A URL to the form’s logo, if you want to show it in the email.
These are some of the most important variables. They contain the fields, and the submitted data on them, along with the result of the calculations, and a link to the row’s edit page (accessible by the form admin).
field_i_title: Title of a field based on its position on the form. for example,
field_1_titlewill be replaced by the title of the 1st field in the form, and
field_4_titlewill be replaced by the 4th field’s title.
field_i_value: Value of a field based on its position on the form. for example,
field_1_valuewill be replaced by the title of the 1st field in the form, and
field_4_valuewill be replaced by the 4th field’s title. This value can be a simple text for most of the fields such as choice field, text field, etc, or a link tag for file fields.
field_i_url: If a field is a file or signature field, you can use this variable for the 3rd field of the form is a file field,
field_3_urlwill be the submitted file’s URL, while
field_3_valueis an HTML tag containing the file’s URL. For any field except file or signature fields, this value will be empty.
alias_url: You can use these to access the fields’ data based on their alias. For example, if a short text field’s alias is
first_name, I can access its title and submitted value using
grade: The calculated grade, for the forms with calculations.
currency: The calculated currency, for the forms with calculations.
order_status: The order status for the forms with payment.
order_code: The order code for the forms with payment.
payment_amount: The payment amount for the forms with payment.
created_at: When was the submit created?
submitter_referer_address: From which address has the user submitted the form?
email_verification_state: Email field verification status, if the form has an email verification field.
tracking_code: Row’s tracking code, if the form is to give a tracking code to the user.
sumbit_time: How long (minutes) did it take for the user to submit the form.
response_admin_address: A URL to the response’s admin page (only accessible by the user with sufficient access).
user_email: Submitter’s email address, if the form is receiving the user’s email on an email field.
results_table: Will be replaced by a pre-rendered table containing all of the fields and their submitted data.
Email Subject, Sender Name, Sender Email
While using the variables for these fields, please note that only the simple variables are usable for these fields. For example, you can’t use the
results_table for any of these fields.
For the sender email, you can only use either a pre-defined email value (e.g.
[email protected] ) or any variable that will return either a valid email or an empty value. If you use any other value on this field (e.g. a variable that may return a text like
John Doe), your emails will not be sent successfully. It’s highly recommended to either use a predefined value, or the
user_email variable, as it will be safe to use.
For the subject and sender name fields, an important note is to be cautious of the variable’s length as well. Since they're limitations for their length while sending an email, we will automatically trim any texts longer than the standard length.