SMTP

To support sending outgoing transactional emails such as "document updated" or "you've been invited" you'll need to provide authentication for an SMTP server. This is also required to support email “magic link” sign-in. Environment variables are mostly self explanatory – add the following to your environment:

Configuration

There are two ways to configure email depending on the service you are using - if you are using a known service it’s recommended to use the first method for easiest setup.

With known service

SMTP_SERVICE – A supported email service from this list

SMTP_USERNAME – The username for the mail server

SMTP_PASSWORD – The password for the mail server

Custom mail server

SMTP_HOST – The hostname of your mail server, e.g. mail.mycompany.com

SMTP_PORT – The port of your mail server, usually 465

SMTP_USERNAME – An optional username for secured mail servers

SMTP_PASSWORD – An optional password for secured mail servers

SMTP_FROM_EMAIL – You can also use the mailbox format, Outline <noreply@mycompany.com>

SMTP_REPLY_EMAIL – Optional. You can also use the mailbox format, Outline <reply@mycompany.com>

SMTP_TLS_CIPHERS – Optional. Allows passing the ciphers to use with TLS

SMTP_SECURE – Optional. If false the connection to the mail server will no use TLS, defaults to true

SMTP_NAME – Optional. hostname to send to the server, sometimes required, eg for Google Mail.

Examples

Some known working configurations can be found below

Apple Mail

SMTP_HOST=smtp.mail.me.com
SMTP_PORT=587
SMTP_USERNAME=<username>
SMTP_PASSWORD=<password>
SMTP_FROM_EMAIL=<email>
SMTP_TLS_CIPHERS=TLSv1.2
SMTP_SECURE=false

Mailgun

SMTP_HOST=smtp.mailgun.org
SMTP_PORT=465
SMTP_USERNAME=<username>
SMTP_PASSWORD=<password>
SMTP_FROM_EMAIL=<email>