Email Templates#
The repository sends emails for several events.
Administrators can customize the content of these emails by editing the respective files on the server.
The files are located in the Config/EmailTemplates/ directory in the repository installation directory.
Default copies of the files are distributed in the Config.dist/EmailTemplates/ directory.
Customize Email Content#
The following files on the server determine the content of the emails.
The JSON files in the Config/EmailTemplates/ directory can be modified to change the content of the emails.
The HTML and text templates in the Design/ directory can also be modified to change the layout and design of the emails.
Email Type |
JSON File |
Design File |
|---|---|---|
Welcome |
WelcomeResetPassword.json |
action.html (.txt) |
Confirm Account |
ConfirmAccount.json |
action.html (.txt) |
Reset Password |
ResetPassword.json |
action.html (.txt) |
Feedback |
Feedback.json |
notification.html (.txt) |
Basket Notification |
BasketNotification.json |
action.html (.txt) |
The Design/ directory also contains alert.html and alert.txt, which are used for messages
that carry only an alert text.
JSON File Structure#
Each JSON file can have the following fields:
- Subject
The subject of the email.
- Paragraph1
The first paragraph of the email body.
- Paragraph2
The second paragraph of the email body.
- ParagraphHtml1, ParagraphHtml2
Optional HTML versions of the paragraphs, used in the HTML email instead of the plain paragraphs.
- ParagraphText1, ParagraphText2
Optional plain text versions of the paragraphs, used in the text email.
- ActionText
Text for any action buttons or links.
- AlertText
Text for any alert messages.
- Closing
The closing text of the email.
The design templates contain tokens beginning with @, such as @subject and @actionUrl,
which are replaced with the content of the JSON file and the message.
These tokens must be preserved when editing the design files.