Skip to content

Document Mailtrap email transport #768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tsokolovs wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Document Mailtrap email transport #768

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4dae234
Document Mailtrap email transport
tsokolovs Jul 10, 2026
c60989e
Merge branch 'main' into pr/768
ComfortablyCoding Aug 27, 2026
80f9cfd
reword and update
ComfortablyCoding Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 20 additions & 11 deletions content/configuration/email.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ description: Configuration for email settings and templates.

## Email Transport

| Variable | Description | Default Value |
| -------------------- | ------------------------------------------------------------------------ | ------------- |
| `EMAIL_VERIFY_SETUP` | Check if email setup is properly configured. | `true` |
| `EMAIL_TRANSPORT` | What to use to send emails. One of `sendmail`, `smtp`, `mailgun`, `ses`. | `sendmail` |
| Variable | Description | Default Value |
| -------------------- | ------------------------------------------------------------------------------------ | ------------- |
| `EMAIL_VERIFY_SETUP` | Check if email setup is properly configured. | `true` |
| `EMAIL_TRANSPORT` | What to use to send emails. One of `sendmail`, `smtp`, `mailgun`, `ses`, `mailtrap`. | `sendmail` |

Based on the `EMAIL_TRANSPORT` used, you must also provide additional variables.

Expand Down Expand Up @@ -51,6 +51,15 @@ Based on the `EMAIL_TRANSPORT` used, you must also provide additional variables.
| `EMAIL_SES_CREDENTIALS__SECRET_ACCESS_KEY` | Your AWS SES secret key. | |
| `EMAIL_SES_REGION` | Your AWS SES region. | |

### Mailtrap

| Variable | Description | Default Value |
| ------------------------------ | ------------------------------------------------------------------------------------------ | ------------- |
| `EMAIL_MAILTRAP_TOKEN` | An API token from [your Mailtrap account](https://mailtrap.io). | |
| `EMAIL_MAILTRAP_SANDBOX` | Send to a test inbox instead of delivering email. Requires `EMAIL_MAILTRAP_TEST_INBOX_ID`. | `false` |
| `EMAIL_MAILTRAP_TEST_INBOX_ID` | The inbox ID to use when `EMAIL_MAILTRAP_SANDBOX` is enabled. | |
| `EMAIL_MAILTRAP_BULK` | Use the bulk sending stream. Cannot be combined with `EMAIL_MAILTRAP_SANDBOX`. | `false` |

## Email Templates

Templates can be used to add custom templates for your emails, or to override the system emails used for things like resetting a password or inviting a user.
Expand All @@ -60,17 +69,17 @@ Templates can be used to add custom templates for your emails, or to override th
| `EMAIL_FROM` | Email address from which emails are sent. | `no-reply@example.com` |
| `EMAIL_TEMPLATES_PATH` | Where custom templates are located | `./templates` |

In the `EMAIL_TEMPLATES_PATH`, you can create templates for your emails by adding [`.liquid`](https://liquidjs.com) files.
In the `EMAIL_TEMPLATES_PATH`, you can create templates for your emails by adding [`.liquid`](https://liquidjs.com) files.

### Overriding System Emails

There are a number of templates provided by Directus that can be overridden with a custom template:
There are a number of templates provided by Directus that can be overridden with a custom template:

| Template | File |
| ------------------ | ----------------------- |
| Password Reset | `password-reset.liquid` |
| User Invitation | `user-invitation.liquid` |
| User Registration | `user-registration.liquid` |
| Template | File |
| ----------------- | -------------------------- |
| Password Reset | `password-reset.liquid` |
| User Invitation | `user-invitation.liquid` |
| User Registration | `user-registration.liquid` |

When overriding the default email templates, make sure to include the provided `url` somewhere to ensure the email is functional.

Expand Down