discourse/docs/INSTALL-email.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

50 lines
2.9 KiB
Markdown
Raw Normal View History

2016-04-29 06:42:45 -04:00
### Recommended Email Providers for Discourse
2016-03-12 02:08:22 -05:00
We strongly recommend using a dedicated email service. Email server setup and maintenance is _very_ difficult even for experienced system administrators, and getting any part of the complex required email setup wrong means your email won't be delivered, or worse, delivered erratically.
The following are template configurations for email service providers known to work with Discourse.
_The pricing information is included as a courtesy, and may be out of date. Discourse does not control the pricing for external services, be sure to check with the email provider for up to date pricing information._
2016-04-29 06:17:48 -04:00
**Please note that in any email provider, you _must_ verify and use the subdomain, e.g. `discourse.example.com`. If you verify the domain only, e.g. `example.com`, mail will not be configured correctly.**
Enter these values when prompted by `./discourse-setup` per the [install guide](https://github.com/discourse/discourse/blob/main/docs/INSTALL-cloud.md#edit-discourse-configuration). To change the current email service, run `./discourse-setup` as well (this will bring the forum offline for a few minutes while it gets rebuilt).
#### [Mailgun][gun] — 5k emails/month on a 3 month trial
SMTP server address? smtp.mailgun.org
SMTP user name? [SMTP credentials for your domain under domains tab]
SMTP password? [SMTP credentials for your domain under domains tab]
#### [SendGrid][sg] — 40k emails on a 30 day trial
2016-04-29 06:17:48 -04:00
SMTP server address? smtp.sendgrid.net
SMTP user name? apikey
SMTP password? [SendGrid API Key]
We recommend creating an [API Key][sg2] instead of using your SendGrid username and password.
#### [Mailjet][jet] — 6k emails/month (200 max/day)
Go to [My Account page](https://app.mailjet.com/account) and click on the ["SMTP and SEND API Settings"](https://app.mailjet.com/account/setup) link.
#### [Elastic Email][ee]
SMTP server address? smtp.elasticemail.com
SMTP user name? [Your registered email address]
SMTP password? [Elastic Email API Key]
SMTP port? 2525
NOTE: By default, Elastic Email will add an additional UNSUBSCRIBE link at the bottom of each sent email. You need to work with them to [disable that link](https://meta.discourse.org/t/remove-or-merge-elastic-email-unsubscribe/70236/39), so that Discourse users can manage their subscription through Discourse.
2017-05-13 00:10:21 -04:00
[ee]: https://elasticemail.com
[jet]: https://www.mailjet.com/pricing
2019-02-22 10:29:27 -05:00
[gun]: https://www.mailgun.com/
[sg]: https://sendgrid.com/
[sg2]: https://sendgrid.com/docs/Classroom/Send/How_Emails_Are_Sent/api_keys.html
### Bounce Handling
When using a third party email service, you will need to enable VERP, or activate their **webhooks** in order to handle bouncing emails. [Full details here.](https://meta.discourse.org/t/handling-bouncing-e-mails/45343)