Test e-mails in development¶
This guide is meant for users that are in development and need to test e-mails receival / sending.
Step 1 - run a local SMTP server¶
First, install a tool that runs a local SMTP server for testing purposes. This tutorial will use MailHog.
If a system is not listed below, check the original documentation on how to install
brew update && brew install mailhog
docker run --restart unless-stopped --name mailhog -p 1025:1025 -p 8025:8025 -d mailhog/mailhog
Note that, by default,
MailHog uses the following ports:
SMTPserver runs in port
HTTPserver runs in port
MailHog is running by accessing its
HTTP server in
http://127.0.0.1:8025 (or the configured
HTTP server port).
Step 2 - enable e-mails for development¶
In development, e-mail sending is disabled by default and the application must be configured for e-mails to be sent.
Enable e-mail sending¶
E-mail sending is configured using the config
MAIL_SUPPRESS_SEND. It must be set to False for e-mails to be sent to the configured
If set to True, e-mails are printed in
stdout instead of being sent to the configured mail server.
Configure the application by editing the app's
# Allow e-mails to be sent. MAIL_SUPPRESS_SEND = False # Configured SMTP server's host MAIL_SERVER = '127.0.0.1' # Configured SMTP server's port MAIL_PORT = 1025
Restart the application and e-mails will be sent to the configured
Check the inbox in MailHog UI.