2022-06-15 07:51:47 +00:00
---
title: "Notification Templates"
description: "A reference guide on overriding notification templates"
lead: "This section contains reference documentation for Authelia's notification templates."
2022-06-28 05:27:14 +00:00
date: 2022-06-15T17:51:47+10:00
2022-06-15 07:51:47 +00:00
draft: false
images: []
menu:
reference:
parent: "guides"
weight: 220
toc: true
---
Authelia uses templates to generate the HTML and plaintext emails sent via the notification service. Each template has
two extensions; `.html` for HTML templates, and `.txt` for plaintext templates.
This guide effectively documents the usage of the
2022-12-07 09:43:02 +00:00
[template_path ](../../configuration/notifications/introduction.md#templatepath ) notification configuration option.
2022-06-15 07:51:47 +00:00
2022-08-26 21:39:20 +00:00
## Important Notes
2023-01-03 11:44:14 +00:00
1. The templates are not covered by our stability guarantees as per our [Versioning Policy]. While we aim to avoid
changes to the templates which would cause users to have to manually change them changes may be necessary in order to
facilitate bug fixes or generally improve the templates.
2022-12-23 05:06:49 +00:00
1. It is your responsibility to ensure your templates are up to date. We make no efforts in facilitating this.
2022-08-26 21:39:20 +00:00
2. We may not be able to offer any direct support in debugging these templates. We only offer support and fixes to
the official templates.
3. All templates __ *MUST*__ be encoded in UTF-8 with CRLF line endings. The line endings __ *MUST NOT*__ be a simple LF.
2022-06-15 07:51:47 +00:00
## Template Names
| Template | Description |
|:--------------------:|:---------------------------------------------------------------------------------:|
| IdentityVerification | Used to render notifications sent when registering devices or resetting passwords |
| PasswordReset | Used to render notifications sent when password has successfully been reset |
For example, to modify the `IdentityVerification` HTML template, if your
2022-12-07 09:43:02 +00:00
[template_path ](../../configuration/notifications/introduction.md#templatepath ) was configured as
2022-06-15 07:51:47 +00:00
`/config/email_templates` , you would create the `/config/email_templates/IdentityVerification.html` file to override the
HTML `IdentityVerification` template.
## Placeholder Variables
In template files, you can use the following placeholders which are automatically injected into the templates:
| Placeholder | Templates | Description |
|:--------------------:|:--------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------:|
| `{{ .LinkURL }}` | IdentityVerification | The URL associated with the notification if applicable. |
| `{{ .LinkText }}` | IdentityVerification | The display value for the URL associated with the notification if applicable. |
| `{{ .Title }}` | All | A predefined title for the email. < br > It will be `"Reset your password"` or `"Password changed successfully"` , depending on the current step. |
| `{{ .DisplayName }}` | All | The name of the user, i.e. `John Doe` |
| `{{ .RemoteIP }}` | All | The remote IP address (client) that initiated the request or event. |
## Examples
This is a basic example:
```html
< body >
< h1 > {{ .Title }}< / h1 >
Hi {{ .DisplayName }}< br / >
This email has been sent to you in order to validate your identity.
Click < a href = "{{ .LinkURL }}" > here< / a > to change your password.
< / body >
```
Some Additional examples for specific purposes can be found in the
[examples directory on GitHub ](https://github.com/authelia/authelia/tree/master/examples/templates/notifications ).
## Original Templates
The original template content can be found on
2022-07-18 00:56:09 +00:00
[GitHub ](https://github.com/authelia/authelia/tree/master/internal/templates/src/notification ).
2022-12-23 10:58:54 +00:00
## Functions
Several functions are implemented with the email templates. See the
[Templating Reference Guide ](../../reference/guides/templating.md ) for more information.
2022-07-18 00:56:09 +00:00
[host]: ../../configuration/notifications/smtp.md#host
[server_name]: ../../configuration/notifications/smtp.md#tls
[sender]: ../../configuration/notifications/smtp.md#sender
[identifier]: ../../configuration/notifications/smtp.md#identifier
2023-01-03 11:44:14 +00:00
[Versioning Policy]: ../../policies/versioning.md
