Email | Directus Docs

Environment Variables
Environment variables are configurable for Directus Business Cloud and Enterprise Cloud projects via our Customer Success team. You can also set environment variables in self-hosted projects.

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`

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

Sendmail

Variable	Description	Default Value
`EMAIL_SENDMAIL_NEW_LINE`	What new line style to use in sendmail.	`unix`
`EMAIL_SENDMAIL_PATH`	Path to your sendmail executable.	`/usr/sbin/sendmail`

SMTP

Variable	Description	Default Value
`EMAIL_SMTP_HOST`	SMTP server host.
`EMAIL_SMTP_PORT`	SMTP server port.
`EMAIL_SMTP_USER`	SMTP user.
`EMAIL_SMTP_PASSWORD`	SMTP password.
`EMAIL_SMTP_POOL`	Use SMTP pooling.
`EMAIL_SMTP_SECURE`	Enable TLS.
`EMAIL_SMTP_IGNORE_TLS`	Ignore TLS.
`EMAIL_SMTP_NAME`	SMTP client hostname.

Mailgun

Variable	Description	Default Value
`EMAIL_MAILGUN_API_KEY`	Your Mailgun API key.
`EMAIL_MAILGUN_DOMAIN`	A domain from your Mailgun account.
`EMAIL_MAILGUN_HOST`	Specify a custom host.	`api.mailgun.net`

AWS SES

Variable	Description	Default Value
`EMAIL_SES_CREDENTIALS__ACCESS_KEY_ID`	Your AWS SES access key ID.
`EMAIL_SES_CREDENTIALS__SECRET_ACCESS_KEY`	Your AWS SES secret key.
`EMAIL_SES_REGION`	Your AWS SES region.

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.

Variable	Description	Default Value
`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 files.

Overriding System Emails

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`

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

Logging

Configuration for general and Realtime logging.

Migrations

Creation of custom migration files to automate database changes.