diff --git a/develop-docs/backend/application-domains/email.mdx b/develop-docs/backend/application-domains/email.mdx index 835ae4fc4d7fb2..e52633f53b562d 100644 --- a/develop-docs/backend/application-domains/email.mdx +++ b/develop-docs/backend/application-domains/email.mdx @@ -78,7 +78,7 @@ Defaults to `(empty)`.
Declared in `config.yml`. -Should Sentry use SSL when connecting to the SMTP server? +Should Sentry use SSL when connecting to the SMTP server? Mutually exclusive with `mail.use-tls`. Defaults to `false`. @@ -88,7 +88,7 @@ Defaults to `false`.
Declared in `config.yml`. -Should Sentry use TLS when connecting to the SMTP server? +Should Sentry use STARTTLS when connecting to the SMTP server? Mutually exclusive with `mail.use-ssl`. Defaults to `false`. diff --git a/develop-docs/self-hosted/email.mdx b/develop-docs/self-hosted/email.mdx index e84fe5303a61e8..8e6d301b8e8508 100644 --- a/develop-docs/self-hosted/email.mdx +++ b/develop-docs/self-hosted/email.mdx @@ -11,14 +11,18 @@ description: Set up and configure email notifications for your self-hosted Sentr ## Outbound Email -Self-hosted Sentry ships with a built-in outgoing SMTP server powered by [exim4](https://hub.docker.com/r/tianon/exim4). The default configuration is set to use this server. All you need to do is to set a valid address for `mail.from` setting in `config.yml` and the [FQDN](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) of your Sentry instance for `SENTRY_MAIL_HOST` in `.env`. Keep in mind that if you start sending too many emails to public addresses, your new server may get marked as a spammer and banned. +It is recommended to use an external SMTP server due to various sender requirements implemented by major email providers, but if you are testing or running a self-hosted Sentry instance on a local network, you can use the built-in SMTP server, powered by [exim4](https://hub.docker.com/r/tianon/exim4). The default configuration is set to use this server. All you need to do is to set a valid address for `mail.from` setting in `config.yml` and the [FQDN](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) of your Sentry instance for `SENTRY_MAIL_HOST` in `.env`. -If you want to use an external SMTP server you can set the relevant `mail.*` settings in `config.yml` file and ignore the built-in SMTP server. Refer to our [email service documentation](/backend/email/) for all the details on what each setting means and does. If your MX records usually resolve to internal private network mail handlers, see [this ticket](https://github.com/getsentry/self-hosted/issues/1202) for some pointers. +If you want to use an external SMTP server you can set the relevant `mail.*` settings in `config.yml` file and ignore the built-in SMTP server. If you don't have an external SMTP server, yet you need to see sent emails, you can set `mail.backend` to `console` on your `config.yml` file. Refer to our [email service documentation](/backend/email/) for all the details on what each setting means and does. + +If your MX records usually resolve to internal private network mail handlers, see [this ticket](https://github.com/getsentry/self-hosted/issues/1202) for some pointers. Because of the way configuration is layered, if you update mail settings through the web interface, you will need to also comment out the mail.host: 'smtp' default in your config.yml in order for your desired settings to be picked up. +Sentry does not support sending outbound email with any other protocol than SMTP (examples: Sendgrid's API, AWS SES API, Mailgun API). Usually, those services provide SMTP relay that you can use. + ## Inbound Email Sentry has very limited inbound mail support through [Mailgun](https://documentation.mailgun.com/en/latest/quickstart-receiving.html). You can find all the information regarding how to set this up over at our [inbound email service documentation](/backend/email/#inbound-email).