Identity Cloud

Email templates

Identity Cloud provides preconfigured email templates for common end-user journeys.

You can customize email templates using Markdown language. Identity Cloud uses a parser to let you preview your markup.

Email templates utilize Handlebar expressions to reference object data dynamically. For example, to reference the userName of an object:

{{object.userName}}

Create a new email template

  1. In the Identity Cloud admin UI, go to Email > Templates.

  2. On the Email Templates page, click + New Template.

  3. Provide the following details:

    • Template Name: Display name for the template.

    • From Address: Enter an email address for the group or individual sending the email.

    • From Name: Enter a name for the group or individual sending the email.

    • Description: A brief description of the template.

  4. Click Save.

  5. The new email opens in the email editor. Refer to Edit an email template.

Edit an email template

  1. In the Identity Cloud admin UI, go to Email > Templates.

  2. On the Email Templates page, click a template name to open the email editor.

  3. To change the wording in the email template, edit the markdown text in the left window on the page.

  4. Add, modify, or delete locales to suit your end-user audience. Refer to Manage email template locales.

  5. Repeat step 3 for each template locale.

  6. To edit the template styles, click Styles, and edit the CSS style code.

  7. To view available variables that you can use in the template, click Variables, and view the content on the Available Properties page. Click Done.

  8. To edit the template settings, click the More () icon at the top right of the page, and select Settings.

  9. Provide the following details:

    • Template Name: Display name for the template.

    • From Address: Enter an email address for the group or individual sending the email.

    • From Name: Enter a name for the group or individual sending the email.

    • Description: Enter a brief description of the template.

  10. Click Update.

  11. Click Save. This saves content changes in all template locales.

Manage email template locales

The locale selector in the top left of the email template editor displays the current template locale in the format Locale: code, where code is a ISO-639-1 language codes (for example en or de).

  • To switch locale:

    1. Click Locale: code.

    2. Select a locale.

  • To add a locale:

    1. Click Locale: code.

    2. Click add Add Locale to open the Add Locale modal window.

    3. Enter a ISO-639-1 language code in the Code field.

    4. (Optional) Select Make Default to make the new locale the default for this template.

    5. Click Save to close the modal window and add the new locale to the template, populated with a copy of the content from the default locale. The changes apply immediately without saving the main template.

  • To modify a locale:

    1. Click Locale: code.

    2. Click the locale’s edit icon (edit) to open the Edit Locale modal window.

    3. To change the locale, enter a ISO-639-1 language code in the Code field.

    4. To make the locale the default locale for the template, Select Make Default.

    5. Click Save to close the modal window. Any changes apply immediately without saving the main template.

  • To delete a locale:

    1. Click Locale: code.

    2. Click the locale’s edit icon (edit) to open the Edit Locale modal window.

    3. Click Delete Locale to delete the locale and its content. The deletion applies immediately without saving the main template.

Delete an email template

Deleting an email template cannot be undone.

  1. In the Identity Cloud admin UI, go to Email > Templates.

  2. On the Email Templates page, click the More () icon adjacent to any template.

  3. Select Delete.

  4. In the dialog box, click Delete.

Manage email templates

  1. In the Identity Cloud admin UI, go to Email > Templates.

  2. On the Email Templates page, click the More () icon adjacent to any template, and do any of the following:

    • To disable a template, click Deactivate.

    • To enable a template, click Activate.

    • To duplicate a template, click Duplicate.

      1. In the Duplicate Template window, enter the following details:

        • Template Name: Display name for the template.

        • From Address: Enter an email address for the group or individual sending the email.

        • From Name: Enter a name for the group or individual sending the email.

        • Description: A brief description of the template.

      2. Click Save.

Copyright © 2010-2024 ForgeRock, all rights reserved.