The email templates in Passport can be customized allowing you to have your visual brand consistent across all customer touch points. In the video below we show you how to set up the email templates to be ready to use Passport’s integrated email features.
Passport ships with three templates to support standard workflows.
- Forgot Password
- Setup Password
- Verify Email
You should customize these templates with your branding, but at a minimum, you will need to make minor edits prior to using them in production. To enable emails, you will need to modify the URL used in the template to be publicly accessible.
NOTE: Email features require that the SMTP setup has been completed. Review your Passport dashboard, if you see a box labeled “Email settings” you will need to complete that task first. View the Using the Passport Setup Wizard tutorial to see how to complete the SMTP configuration.
Editing the Email Templates in Passport
Once your SMTP configuration is complete, navigate to the Settings option in the left side menu, then select Email Templates. This is the Email Template page. Here you will see the three default Email templates provided by Passport.
In addition to the template name, you will see the unique ID of the template, this will be used when using the email APIs during your integration. For each template you may select Edit, View, or Delete from the provided row actions. Selecting the View action is helpful to preview how the template will render. Delete will permanently remove an email template and this action cannot be undone. You will be prevented from completing the Delete operation if the template in use by the Passport configuration. To create a new template, you may click on the green Add button in the top right corner.
Edit Email Verification
Next, we will take a deeper look at the provided Email Verification template. We will modify this template to prepare it for use in our production application. To begin, click the blue Edit icon for the Email Verification template. This is the Edit Email Template page.
On the top section labeled Base Information you will see the Template Id. This value is used by the Email APIs during integration and cannot be changed. The remainder of the fields in this section may be modified. The Default Subject and the Default From Name fields ware marked with a code symbol indicating they may utilize replacement variables.
Required: Modify the Default URL
Once the Base Information has been modified to your liking we will move to the bottom section labeled Options. Here you have access to edit the HTML and Text versions of the templates.
The URL in the default template is configured to use localhost which will not work properly for your production instance. You will need to modify the HTML and Text body to reflect the publicly available Passport URL. There is a preview button in the bottom right that will allow you to review how the email body will look prior to saving the template changes.
While most modern Email clients will render emails using the HTML template, you must also provide a plain text version of your Email Template. Repeat the same process for the Text template.
Edit the Localization
The last tab on the bottom section of the page is labeled Localization. Adding localized versions of your template allows Passport to select a localized version based upon the recipient’s preferred locale.
Using Email Template localization allow you to communicate with your users in their preferred language which makes for a better user experience.
You can create customized HTML and text versions for the localized template. If you leave this blank, Passport with use the HTML you created on the Edit page. Be sure to click Submit in the bottom left corner. Once submitted you will see the name of your localized template on the Locale heading on the Localization tab.
To save all changes on your email template, click the blue Save icon in the top right. Once saved you will return to the Email Template page. For each email template you want to use, you will need to repeat these steps.
In this tutorial for email templates in Passport we have taken a look at email templates in Passport and have prepared the Email Verification Template for use in production. If you have additional questions or require assistance please send us a note at firstname.lastname@example.org.
Learn More About Passport
Passport is designed to be the most flexible and secure Customer Identity and Access Management solution available on the market. More than a login tool, we provide registration, data search, user segmentation and advanced user management across applications. Find out more about Passport and sign up for a free trial today.