Email Templates

Nhost Auth sends out transactional emails as part of certain authentication workflows. These emails can be modified using email templates.

Customize your emails

Email Templates are deployed as part of a Deployment so your project must be connected to a Git repository.

File Structure

Email Templates can be found under your project’s ./nhost/emails folder and have the following structure:

> tree ./nhost

nhost
├── config.yaml
├── emails
│   ├── en
│   │   ├── email-confirm-change
│   │   │   ├── body.html
│   │   │   └── subject.txt
│   │   ├── email-verify
│   │   │   ├── body.html
│   │   │   └── subject.txt
│   │   ├── password-reset
│   │   │   ├── body.html
│   │   │   └── subject.txt
│   │   ├── signin-otp
│   │   │   ├── body.html
│   │   │   └── subject.txt
│   │   ├── signin-passwordless
│   │   │   ├── body.html
│   │   │   └── subject.txt
│   │   └── signin-passwordless-sms
│   │       └── body.txt
│   └── fr
│       ├── email-confirm-change
│       │   ├── body.html
│       │   └── subject.txt
│       ├── email-verify
│       │   ├── body.html
│       │   └── subject.txt
│       ├── password-reset
│       │   ├── body.html
│       │   └── subject.txt
│       ├── signin-otp
│       │   ├── body.html
│       │   └── subject.txt
│       ├── signin-passwordless
│       │   ├── body.html
│       │   └── subject.txt
│       └── signin-passwordless-sms
│           └── body.txt
├── metadata
├── migrations
├── nhost.toml
└── seeds

As you can see templates can be defined for various languages and, with the exception of signin-passwordless-sms, they require 2 files for the subject and body.

/{language-code}/{email-template}/[subject.txt, body.html]

Languages

A user’s language is stored in the auth.users table in the locale column. This locale column contains a two or three letter language code (ISO 639-1 or ISO 639-2) which is used to infer what language and template to use in the email.

Template Variables

The following variables are available to all email templates:

Variable	Description
`link`	The full URL to the target of the transaction. This should be used in the main call to action.
`serverUrl`	URL of the authentication server
`clientUrl`	URL of your client app
`redirectTo`	URL where the user will be redirected to after clicking the link and finishing the action of the email
`ticket`	Ticket or OTP that is used to authorize the request.
`displayName`	The display name of the user
`email`	The email of the user
`locale`	Locale of the user as a two or three letter language code (e.g. “en”)

Variables can be referenced by enclosing them with ${} as in the following example:

<h2>Verify You Email</h2>

<p>Hi, ${displayName}! Please click the link to verify your email:</p>

<p>
  <a href="${link}">Verify Email</a>
</p>

Postmark Integration

Alternatively, you can use postmark’s native integration and leverage postmark’s templates. To do so, you need to:

Configure SMTP settings like below:

[provider.smtp]
host = 'postmark'
password = '{{ secrets.POSTMARK_API_KEY }}'
sender = 'myapp@mydomain.com'

In postmark you need to create three templates for each locale with the following alias:

$locale.email-confirm-change
$locale.email-verify
$locale.password-reset

For instance:

en.email-confirm-change
en.email-verify
en.password-reset
se.email-confirm-change
se.email-verify
se.password-reset

Additionally, if you want to use the passwordless sign-in or OTP sign-in emails, you need to create the following templates as well:

$locale.signin-passwordless
$locale.signin-otp

After these two steps have been completed, the Auth service will leverage these templates instead of the ones described in the previous section.