search
configuration

Email Templates

ForgeRock allows you to design custom emails triggered by user account activity.


For example, you can set up an account verification email that’s sent when a user registers for your service or application. That same email can also welcome users to your service.

ForgeRock email templates support the use of Markdown, based on the CommonMark specification, enhanced by the markdown-it parser. You can test options on the markdown-it demo site. In addition, you can:

  • Use variables to help personalize messages.
  • Skin templates using CSS.

Available Templates

You can use the console to configure the following email templates:

Template Name Description
Registration When a user registers on your service or application
This email will only be sent if “User must click on email verification link before registration is complete” is checked in “Password Policy”
Recover Username For users who need help recovering their usernames
Username Recovered After a user has recovered their username
Forgot Password Whenever a user requests a password change
Email Update Successful Sent after a user changes the account email address
Welcome When users verify their email addresses
Reset Password Successful Upon successful password reset

Variables

You can add variables (with double curly braces {{ variableName }}) to the template. The variables will then pull data from entities such as users, apps and tenants. The following table includes example variables:

Variable Description Example
{{application.name}} Name of application. TrakMyExpenses
{{user.emails.primary}} Primary email of the user. [email protected]
{{user.preferredLanguage}} Preferred language of the user. en-US
{{user.name.givenName}} Given name / first name of the user. Barbara
{{user.name.familyName}} Family name / last name of the user. Jensen
{{user.name.formatted}} User’s fully formatted name. Ms. Barbara J Jensen, III
{{user.displayName}} User’s display name. Babs Jensen
{{user.userName}} The username. bjensen
{{url}} Generic link for account activity such as registration password reset.  
{{url.expiry}} Limit on URL validity, in hours.  
{{date}} Date and time of request in ISO 8601 format.  
{{organization.name}} Organization name. Mega Money Mgr Inc.
{{tenant.name}} Tenant Name. Mega Money Mgr-Dev


See a missing template or have feedback? Let us know! [email protected]