Creating an Email Notification Template
Crowd uses an email template to build the content of an email message that Crowd sends to a user. Crowd provides the following email templates:
- Password Resets: A template for the email sent when an administrator asks a user to reset their password and when a user asks to reset their own forgotten password.
- Forgotten usernames: A template for the email sent when a user requests their forgotten username.
- Password expiry reminders: A template for the email sent when the Configuring an Internal Directory for password expiry is reached.
Email Template for Password Resets (Forgotten Passwords)
This is a template for the email sent when an administrator asks a user to reset their password and when a user asks to reset their own forgotten password.
To edit the email template for password resets,
- Log in to the Crowd Administration Console.
- Click the 'Administration' tab in the top navigation bar.
- Click 'Mail Template' in the left-hand menu.
- In the 'Forgotten Password Template' text box, enter the text and macros that will form the body of the email message. Use a macro when you want to include a variable into the email text. Crowd will replace the macro with the relevant value when it sends the email. Below are the available macros and their replacement values:
- $username – The username of the person who will receive the email.
- $firstname – The user's first name.
- $lastname – The user's last name.
- $deploymenttitle – The title of your Crowd site, as defined in Deployment Title.
- $date – The date/time of the message event.
$resetlink – The automatically-generated URL that the user can click, allowing them to choose a new password.
Note: To ensure that the password reset URL will include the correct domain for your Crowd server, please make sure that Crowd's base url is set correctly in the Server Settings screen.
- Click 'Update'.
Earlier releases of Crowd supplied the '$password' macro to represent the user's new password, automatically generated by Crowd. Crowd no longer generates a new password, but instead generates a link that the user can click to choose their own new password. For backwards compatibility, if your email template contains the '$password' macro, Crowd will now replace it with the text 'available at (link)'. The '(link)' will be the same as now available in the '$resetlink' macro.
Email Template for Forgotten Usernames
This is a template for the email sent when a user requests their forgotten username.
To edit the email template for forgotten usernames,
- Log in to the Crowd Administration Console.
- Click the 'Administration' tab in the top navigation bar.
- Click 'Mail Template' in the left-hand menu.
- In the 'Forgotten Username(s) Template' text box, enter the text and macros that will form the body of the email message. Use a macro when you want to include a variable into the email text. Crowd will replace the macro with the relevant value when it sends the email. Below are the available macros and their replacement values:
- $username – The username of the person who will receive the email.
- $firstname – The user's first name.
- $lastname – The user's last name.
- $deploymenttitle – The title of your Crowd site, as defined in Deployment Title.
- $date – The date/time of the message event.
- $email – The email address that the user entered when requesting forgotten usernames. This is the address to which the email message is sent.
- $admincontact – The email address of the Crowd administrator.
- Click 'Update'.
Email template for Password expiry reminders
This is a template for the email sent when the Configuring an Internal Directory for password expiry is reached.
To edit the email template for password expiry reminders,
- Log in to the Crowd Administration Console.
- Click the 'Administration' tab in the top navigation bar.
- Click 'Mail Template' in the left-hand menu.
- In the 'Password expiration reminder template' text box, enter the text and macros that will form the body of the email message. Use a macro when you want to include a variable into the email text. Crowd will replace the macro with the relevant value when it sends the email. Below are the available macros and their replacement values:
- $username – The username of the person who will receive the email.
- $firstname – The user's first name.
- $lastname – The user's last name.
- $daysToPasswordExpiration – The amount of days left until the user's password expires.
- $changePasswordlink – The link to the change password page of your Crowd site.
- $admincontact – The email address of the Crowd administrator.
- $deploymenttitle – The title of your Crowd site, as defined in Deployment Title.
- $date – The date/time of the message event.
- Click 'Update'.