Difference between revisions of "Message Templates"
Jrobertson (talk | contribs) |
Jrobertson (talk | contribs) |
||
| Line 1: | Line 1: | ||
A range of templates for messaging can be created and organised with the message templates list. The New Message Template button leads to a choice between a Welcome Email template and a Forgotten password template. | A range of templates for messaging can be created and organised with the message templates list. The New Message Template button leads to a choice between a Welcome Email template and a Forgotten password template. | ||
| + | |||
| + | === Welcome Email template === | ||
| + | |||
| + | This template can be used when sending welcome messages to new users. | ||
| + | |||
| + | You can use the following special formatting options in this message: | ||
| + | |||
| + | *$user_name: The new user's username. | ||
| + | *$email: The new user's email address. | ||
| + | *$first_name: The new user's first name. | ||
| + | *$last_name: The new user's last name. | ||
| + | *$password_reset_link: A link to start the Password Recovery process. | ||
| + | *$change_password_link: A unique link for this user to immediately change their password. | ||
| + | *$recovery_email: The new user's recovery email address. | ||
| + | *$recovery_phone: The new user's recovery phone number. | ||
| + | |||
| + | You can also use any extra attributes your users might have, such as $salutation or $SIS_ID. Please note that a formatting option that does not match the above list or a user's custom attributes will be left in your email unchanged. | ||
| + | |||
| + | An example of the form for writing a Welcome Email template can be found below. | ||
| + | |||
| + | [[File:welcome_email.png|700px]] | ||
| + | |||
| + | === Forgotten Password template === | ||
| + | |||
| + | This template can be used when sending recovery codes via email for users who are attempting to reset their password. | ||
| + | |||
| + | You can use the following special formatting options in this message: | ||
| + | |||
| + | *$user_name: The user's username. | ||
| + | *$code: The recovery code needed by the user to reset their password. | ||
| + | *$continue_link: A link to continue the Password Recovery process. | ||
| + | *$email: The user's email address. | ||
| + | *$first_name: The user's first name. | ||
| + | *$last_name: The user's last name. | ||
| + | *$password_reset_link: A link to initiate Password Recovery. | ||
| + | *$recovery_email: The user's recovery email address. | ||
| + | *$recovery_phone: The user's recovery phone number. | ||
| + | |||
| + | An example of the form for writing a forgotten password template and an example of a message can be found below. | ||
| + | |||
| + | [[File:password_template.png|700px]] | ||
| + | |||
| + | ==== Example Password recovery message ==== | ||
| + | |||
| + | <p>Hi $first_name,</p> | ||
| + | |||
| + | <p>You've recently made a request to reset your Cloudwork password. <a href="$continue_link">Click here to reset your password</a>, or provide the following code in your browser:</p> | ||
| + | <p>$code</p> | ||
| + | <p>If you did not try to reset your password, please ignore this email.</p> | ||
| + | <br> | ||
| + | <p>Sincerely,</p> | ||
| + | <br> | ||
| + | <p>The Studentnet Support Team</p> | ||
| + | |||
[[Category:Features]] | [[Category:Features]] | ||
Revision as of 22:04, 13 February 2018
A range of templates for messaging can be created and organised with the message templates list. The New Message Template button leads to a choice between a Welcome Email template and a Forgotten password template.
Welcome Email template
This template can be used when sending welcome messages to new users.
You can use the following special formatting options in this message:
- $user_name: The new user's username.
- $email: The new user's email address.
- $first_name: The new user's first name.
- $last_name: The new user's last name.
- $password_reset_link: A link to start the Password Recovery process.
- $change_password_link: A unique link for this user to immediately change their password.
- $recovery_email: The new user's recovery email address.
- $recovery_phone: The new user's recovery phone number.
You can also use any extra attributes your users might have, such as $salutation or $SIS_ID. Please note that a formatting option that does not match the above list or a user's custom attributes will be left in your email unchanged.
An example of the form for writing a Welcome Email template can be found below.
Forgotten Password template
This template can be used when sending recovery codes via email for users who are attempting to reset their password.
You can use the following special formatting options in this message:
- $user_name: The user's username.
- $code: The recovery code needed by the user to reset their password.
- $continue_link: A link to continue the Password Recovery process.
- $email: The user's email address.
- $first_name: The user's first name.
- $last_name: The user's last name.
- $password_reset_link: A link to initiate Password Recovery.
- $recovery_email: The user's recovery email address.
- $recovery_phone: The user's recovery phone number.
An example of the form for writing a forgotten password template and an example of a message can be found below.
Example Password recovery message
Hi $first_name,
You've recently made a request to reset your Cloudwork password. <a href="$continue_link">Click here to reset your password</a>, or provide the following code in your browser:
$code
If you did not try to reset your password, please ignore this email.
Sincerely,
The Studentnet Support Team
