john/deighton-ar
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
John Lyon-Smith
2018-02-22 17:57:27 -08:00
commit e80f5490d5
196 changed files with 38982 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
server/config/templates/README.md5 Normal file
View File

@@ -0,0 +1,27 @@
# Email Templates
This directory contains the email templates used for various communications with the user. The list of templates is as follows:
| File Name | Description
|:------------ |:-----------
`welcome.txt/.html` | Sent to users when they are first added to the system. Should include welcome message, link to email confirmation page and notification of link expiration and support email.
`forgotPassword.txt/.html` | Sent to users when they click on the forgot password link. Should include the link to the reset and support email. Rate limited in production.
`changeEmailNew.txt/.html` | Sent to the old email of existing users when they are changing their email. Should include support email and the new email.
`changeEmailOld.txt/.html` | Sent to existing users when they are changing their email. Should include the link to email confirmation page and support email.
`accountDeleted.txt/.html` | Notification that the users account has been deleted from the system. Must include a support email.
Each template must have a text (`.txt`) version and can also have an HTML (`.html`) version. Both will be sent and it is up to the users email reader to decide which to use.
## List of Supported Data Fields
This is the the definitive list of supported data fields in emails.
Name | Value
---- | -----
`recipientFullName` | Full name of the user receiving the email
`confirmEmailLink` | URL that will take the user to confirming their email, and if necessary setting their password (for first time account setup.)
`confirmEmailLinkExpirationHours` | The number of hours before the given link expires
`senderFullName` | The full name of the user that initiated the action
`supportEmail` | The support email for the system
`recipientNewEmail` | The new email that is being set for the user
`resetPasswordLink` | A link that allows the user to reset their password