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 the list below

SMTP_USERNAME – The username for the mail server

SMTP_PASSWORD – The password for the mail server


Known services

  • "1und1"

  • "AOL"

  • "DebugMail.io"

  • "DynectEmail"

  • "FastMail"

  • "GandiMail"

  • "Gmail"

  • "Godaddy"

  • "GodaddyAsia"

  • "GodaddyEurope"

  • "hot.ee"

  • "Hotmail"

  • "iCloud"

  • "mail.ee"

  • "Mail.ru"

  • "Mailgun"

  • "Mailjet"

  • "Mandrill"

  • "Naver"

  • "Postmark"

  • "QQ"

  • "QQex"

  • "SendCloud"

  • "SendGrid"

  • "SES"

  • "Sparkpost"

  • "Yahoo"

  • "Yandex"

  • "Zoho"

Custom mail server

If your email provider is not included on the list above or is custom/in-house use the following settings


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 – The username to use

SMTP_PASSWORD – 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.