Edit e-mail templates
Change the subject and text of the e-mails the platform sends, preview them, and restore earlier versions.
Requires: kernel/emailTemplates/manage
Every e-mail the platform sends is built from a template you can edit. Editing templates needs
kernel/emailTemplates/manage at the platform root, which Platform Owner and Platform
Contributor hold.
The templates
Open Settings → Platform Settings and the Email templates tab. The list shows each template's key, locale, subject, version, and whether it is the Built-in default or has been Edited.
| Template | Sent when |
|---|---|
invitation-new-user, invitation-new-user-platform |
Someone without an account is invited to a boundary, or to a platform role |
invitation-existing-user, invitation-existing-user-platform |
Someone with an account is invited to a boundary, or to a platform role |
invitation-revoked |
An invitation is withdrawn |
jit-access-requested |
Someone requests just-in-time access |
jit-access-approved, jit-access-declined |
A just-in-time request is decided |
member-added |
Someone is added to a boundary |
password-reset, password-changed |
A password reset is requested, and a password has changed |
member-role-changed |
Not sent by anything today |
Templates exist in English only, and the platform sends every message in English.
Edit a template
- Choose a template in the list.
- Change the Subject and the body on the HTML and Plain text tabs. The Variables tab lists the values the template can use; the list itself cannot be changed.
- Check the preview beside the editor. It shows the message filled in with sample values.
- Choose Save. The template gets a new version number.
Insert a variable with {{ name }}. In the HTML body its value is HTML-escaped; write
{{ name | raw }} to insert it unescaped. A variable the template does not declare is an error,
and a template with errors cannot be saved.
Note
Send test email in the template editor does not work yet: it sends the saved template without values for its variables, which the platform refuses. Use the preview to check a template.
Versions and defaults
- History lists the template's earlier versions — the 20 most recent are kept. Restoring one saves it as a new version.
- Reset to default replaces your text with the built-in default, again as a new version.
- When the platform is upgraded, templates you have not edited get the new release's defaults; edited templates are left as they are.