Zephr User Guide

Email Templates

81 views 0

Zephr provides a series of email templates that are sent for key account tasks. Whilst there is a default template for each of these, they can be customised based on your organisation’s needs.

Customers have the ability to create new email templates for use on a site-specific basis or use the same template for every site.

Customising Email Templates

When you create a Site within Zephr, it will initially use default email templates. If you wish to customise the templates that are sent you must first create a new template, then assign it to the relevant site.

Email Template Library

Email templates are created and edited within the Email Template Library. This can be found by navigating to Settings > Email Templates within your Zephr Admin Console.

Email Templates - Example List Of Emails For A Site

Here, you will see an area to configure the email address your default emails are sent from, a button for adding a new email template, and a list of your existing email templates. Templates that have been created by default will be marked with a ‘Default’ symbol.

Configuring Your Send Address for Email Templates

If you are configuring your email templates for the first time, you will need to set your ‘From Address’. This is the address that Zephr’s system emails will appear to be sent from for emails such as password reset and login verification.

Under Configuration, set the From Address field, then click Send Verification Email.

This will send an email from Amazon Web Services to the email address you have entered. Click the link within this email to confirm you have the authority to send your system emails from this address. Once complete, click Update.

Editing Default Templates

You can edit any default email template by clicking on its name within your list of email templates.

A new screen will open, allowing you to set the Subject Line and Body Copy for the email. At the bottom of the page, any available template variables for that particular type of email template will be displayed.

Email Templates - Shows the WYSIWYG Editor For Editing An Email Template

These variables can be placed anywhere within your email template and act as a placeholder for Zephr to render the email accordingly. The password reset email template, for example, has the following template variables:

{{password-reset-form}}

This will be replaced with “https://example.com/blaize/password-reset”, the URL for the password reset form.

{{password-reset-target}}

This is the URL that the form will redirect to once the user has submitted the password reset.

For Default Email Templates, you are unable to update the Type of template being used.

Once you’ve configured the template, click Save. Your updated template will now be used for all sites where the default template is set to be used.

Creating New Templates

Rather than using default templates across all of your sites, you may wish to create new email templates and customise the branding of them in a way that is relevant to each site.

To do this, click the Add A New Email Template button in your Email Template Library.

Here, a screen similar to that of your default email templates will open.

You will be able to set a Title for your email template, which will be used internally, as well as selecting the template Type, Subject and Body Copy. The type you select will determine the Available Template Variables within the template.

The following Email Templates Types are available for you to use:

  • Pages User Email Update: This is sent when an end-user updates their email address from an out of the box Zephr Preference Centre Page.
  • Pages User Password Reset: This is sent when an end-user resets their password from an out of the box Zephr Preference Centre Page.
  • User 2FA Authentication: Sent when a user logs into a site that is using two-factor authentication. This email includes a six-digit code for them to input to complete authentication.
  • User 2FA Password Reset: Sent when a user resets their password on a site that is using two-factor authentication. This email includes a six-digit code for them to input to complete the password reset.
  • User Complete Registration: Sent when a user registers to a site that is using two-factor authentication. This email includes a six-digit code for them to input to complete registration.
  • User Email Update: Sent to users who have updated the email address they use to access your site.
  • User Email Update Interstitial: Sent to users as part of the flow of changing their email when you also require email verification (as set up within your Zephr Identity Settings)
  • User Email Verification: Sent to users who have registered for your site and need to verify their email address.
  • User Oversubscription Notification: Sent to the relevant Account Manager when a Company Account becomes oversubscribed. Read our Companies & Accounts guide for more details.
  • User Password Reset: For end users resetting their password to your website, when the Zephr Identity Store is in use.
  • User Passwordless Authentication: Sent to users logging into your site via Zephr, when Passwordless Authentication is enabled. This email provides a magic link for users to log in with.

Email Templates - Example Creation Of Custom Template

Once complete, click Save. Your email template will be created, however it will not be in use until you set it as the email template for one of your sites. Details on how to assign it to a Site can be found below.

Duplicating Email Templates

Once you have created a new email template, you will be able to duplicate this template in order to alter it for another site. To do this, find the email template in your list, then click the three dots to the right of it and select Make A Copy.

Update the copy as required, then click Save.

Note: You cannot duplicate a default email template.

Assigning Email Templates For Each Site

Once you have edited your email templates in line with your branding needs, it is time to update which templates are used for each of your sites.

This is done on a site by site basis. To begin, navigate to Delivery > Sites, then select the site you wish to update email templates for. Once the site settings have loaded, select Email Templates.

On this page, you are able to set the email address this site’s email templates are sent from and see a list of current email templates for the site.

If you have not edited these before, default email templates will be in use for every template type. To adjust this, click the ‘Replace Email Templates By Selecting’ button.

Clicking this button will give you a list of all the email templates you have available to you that are not currently in use for that Site. Selecting these will swap them out with the current email template your site is using, on a type by type basis. You may only have one email template type in use per site.

Email Templates - List of Existing Email Templates

For example, in the image above you can see a custom template for a user password reset email. Selecting this email template will swap the template with the current user password reset in use for the site and it will appear in your email template list accordingly.

Once you have updated your templates accordingly, click Done, then repeat as necessary.