Managing emails in Kentico 9
Q_Community uses five specific email templates. These define the layout and content of emails sent to panellists using Q_Community.
Select the Email Templates application from the dashboard, or from the Development application group.
|MARSC – Activate – Panellist||The email sent to the panellist to confirm that their membership has been successfully activated.|
|MARSC – Prize Redeem – Administrator||The email sent to the prize administrator to inform them that a prize has been redeemed. The email address of the prize administrator is defined in the Email field of the prize within Q_Panel/Prize Manager. The email will typically contain the user name, the prize redeemed and the number of points used|
|MARSC – Prize Redeem – Panellist||The email sent to the panellist to confirm that a prize has been redeemed. This email will typically contain the prize redeemed and the number of points used.|
|MARSC – Prize Redeem Voucher – Panellist||The email sent to the panellist to confirm that a voucher prize has been redeemed. This email will typically contain the name of the prize redeemed and the number of points used.|
|MARSC – Refer A Friend||The email sent to a friend of the panellist inviting them to register for the panel. This email should include a link to the registration page.|
Editing an email template
To edit an email template, click on the Edit icon next to the relevant template to view the email template properties.
The Subject field and HTML content may be edited, but it is not recommended that you edit the plain text version.
As well as the email text, placeholders can be used to include data in the email.
Kentico placeholders must be surrounded by ‘%’ and include:
Q_Panel placeholders must be surrounded by ‘%’ and include:
Kentico Email Templates
There is also a huge range of Kentico email templates available, not all of which will used in your website.
By default all e-mail templates are shown. To view emails for a specific site select the Site name from the dropdown list – you will need to do this to see the Q_Panel email templates. You can also search by the template name or template type.
To view more details of a template click on the Edit icon next to the relevant template.
Modifying Kentico Email Templates
To modify a Kentico email for a particular site, the contents of the global template can be copied to a new template on the relevant site and can then be edited as above.
To do this, copy the HTML from the original email template and paste into a new email template within the relevant site. Ensure that the Code Name is exactly the same as the Code Name of the original template. The Display Name and the E-mail Type should also be identical. The new email template can then be edited.
The global email template should not be edited.
Email Template Localisations
If Q_Community supports more than one culture (or language) then the localisations (or translations) require to be added within the email template.
The relevant culture code and translation should be added to the text within the subject and HTML of the email template. The default language text should be separated from the translated text by the pipe character ‘|’.
For example, if the website has English as the default language and French as an additional language, then the subject for the MARSC – Prize Redeem – Administrator template could have the following French translation:
The translation of the text within the HTML should be done in a similar way, though this is likely to be more complicated as placeholders may be used.
For example, the HTML for the MARSC – Prize Redeem – Administrator could be translated as follows:
When changes are made remember to press the Save button.
Before making changes to an email template it is recommended that a backup of the original settings are taken beforehand (e.g. copy HTML into another file or take appropriate screen shots). Changes to email templates which include translations should be tested to ensure the resulting email produced is as required.
The Email Queue is available in Site Manager and shows all pending or failed emails.
Select the Email Queue from the dashboard, or from the Configuration application group.
To see only emails for a particular site, select the Site name from the dropdown box.
View email details by clicking on the View icon next to the relevant email.
There are various ways of re-sending emails in Kentico:
- Re-send an individual email by clicking on the Resend icon next to the relevant email
- Re-send all failed emails by clicking on the Resend all failed button
- Re-send one or more emails by checking the box next to the emails required to be re-sent and selecting Resend selected from the Resend drop-down list
- Re-send all emails by clicking Resend all from the Resend drop-down list