Actions

Email templates

From LimeSurvey Manual

This page contains changes which are not marked for translation.

Other languages:
English • ‎français • ‎Nederlands • ‎slovenščina

To edit the email templates select the according entry from the survey menu:

Edit email template.jpg

Using replacement function.

In the email template , you can use some specific keywords to use token information: see Emails placeholders to have the complete list of placeholders.

A good example is the usage of the plain link to the survey instead of a long url.

Example: Create a nice link to start the survey

  1. First open up the email-templates editing and choose 'Invitation' on the upper tabs.
  2. Then write the text you want to appear as link to start the survey.
  3. Then select that text.

Mark text to hyperlink.jpg

  1. Add the placeholder for the plain link @@SURVEYURL@@ and choose other from the protocol-select-box

Add link placeholder choose other.jpg

Now if you send out your invitation mails, the link to start the survey will be a link and not an url.


Email attachment feature.

From 2.05 forwards, LimeSurvey will officially support adding file attachments to emails sent by the system.

The following templates support adding attachments:

  • invitation
  • reminder
  • admin notification
  • detailed admin notification
  • confirmation

Attachments can be added at the bottom of the email template editing interface. Email attachments are uploaded on a per survey basis.

To decide if an attachment should be sent on an individual basis it is possible to add a relevance equation to each attachment.

All functions supported by the Expression Manager can be used, as well as token attributes if the survey uses tokens.

In case of a notification or confirmation template it is also possible to use question codes used in the survey.

Things to watch out for

  • When a file can not be found on the file system, the email will be sent without attachment.
  • Exporting / importing a survey does not export the uploaded files. The settings for attachments will be maintained, as will the relevance equations.


Email placeholders

You may observe in the body and/or subject of the message different email placeholders. Their role is to connect the email you wish to send to each token entry from the survey participants list. In this way, their data is automatically taken and you will not have to manually type the details of the respective survey participant (e.g. first name, administrator email, survey description, and so on).

You can find below the field names that are allowed in invitation and reminder email templates in LimeSurvey. They must be included in the body message! When sending out the emails, these field names will be already replaced in the preview of your invitation/reminder email.

{ADMINEMAIL} Email of the Survey admin
{ADMINNAME} Name of Survey Admin
{SURVEYNAME} Title of your survey
{SURVEYDESCRIPTION} Description of your survey

The following field names are allowed in invitation/reminder emails (subject and/or body) and will be replaced while sending out the mails:

{EMAIL} Email of the recipient
{FIRSTNAME} First Name
{LASTNAME} Last Name
{SURVEYURL} The URL pointing to the survey start - if you are sending HTML emails this will be a fully linked HTML version
@@SURVEYURL@@ The URL pointing to the survey start - this is the barebone link. Use this if you want to integrate the link in your custom HTML elements somewhere (available in v1.90 and later)
{OPTOUTURL} The URL to deactivate sending of mail for this survey  - this will be a fully linked HTML version
{TOKEN} Token to access the survey
{ATTRIBUTE_1} Attribute 1
{ATTRIBUTE_2} Attribute 2 (...and so on for more attribute fields)

If your survey is not anonymous, the following field names are available to insert token data in survey text and javascript.

{TOKEN:EMAIL} Email of the recipient
{TOKEN:FIRSTNAME} First Name
{TOKEN:LASTNAME} Last Name
{TOKEN} Token to access the survey
{TOKEN:ATTRIBUTE_1} Attribute 1
{TOKEN:ATTRIBUTE_2} Attribute 2 (and so on for more attribute fields)

Note: You can use these fields in confirmation and notification email template too.

Note:

  • If your survey is using anonymized responses then token-related placeholders will not work in notification email templates.
  • You can use Expression Manager to use expressions for tailoring an email (New in 1.92 ). Please have a look at the Expression Manager HowTos for an example.

Also have a look at the examples on using information from tokens table.

Edit email templates

  1. Invitation Email Subject: The subject line for the invitation email that gets sent out when tokens are used with your survey.
  2. Invitation Email: This is the text for the invitation email that gets sent out when tokens are used with your survey. This is initially filled by the default invitation message (from the language files) but you can modify it to suit yourself. If you are using English as your base language, the default invitation and reminder text can be found in the limesurvey/tokens.php file. Of course if you don't plan to use tokens on your survey, whatever is in this field is irrelevant.  You can use the following "form" fields to insert individualized information in each email:
  • {FIRSTNAME} - gets replaced with the token table's "firstname" value
  • {LASTNAME} - gets replaced with the token table's "lastname" value
  • {SURVEYNAME} - gets replaced with your surveys name
  • {SURVEYDESCRIPTION} - gets replaced with your surveys description
  • {ATTRIBUTE_1} - gets replaced with the token table's "attribute_1" value
  • {ATTRIBUTE_2} - gets replaced with the token table's "attribute_2" value and so on
  • {SURVEYURL} - gets replaced with the fully qualified URL to this particular survey - in HTML emails this is a fully linked HTML link
  • @@SURVEYURL@@ - Gets replaced with the survey barebone link. Use this if you want to integrate the link in your custom email HTML (available in v1.90 and later)
  • {OPTOUTURL} - gets replaced with the URL for a respondent to opt-out of this particular survey

Note that these "form fields" apply to the following email fields.

  1. Email Reminder Subject: The subject line for the reminder email that gets sent out from the tokens tool
  2. Email Reminder: This is the text for the reminder email that gets sent out when tokens are used with your survey. See "invitation email" for specific details on how this field is used.
  3. Confirmation Email Subject: When tokens are used, this is the subject line of the email that gets automatically sent to participants after completion of the survey
  4. Confirmation Email: This is the text of the email that gets sent to users after completion of the survey. Delete/blank this text remove the confirmation email sending.
  5. Public Registration Email Subject: This is the subject line for the invitation email sent to members of the public who register for a survey.
  6. Public Registration Email: This is the text for the invitation email sent to members of the public who register for a survey. The same "form fields" apply in this email as in the earlier ones.


Participant opt-out

When you use the {OPTOUTURL} tag in your invitation/reminder email, your participants have the possibility to opt out of this particular survey by just clicking on the related URL in the email - so you don't harass them with reminder emails. A participant that opted out of your survey will have the email status 'OptOut' set in the token.