A Flask extension for sending email messages. Includes different mailer backends for different purposes:
- Dummy backend (useful for tests)
- SMTP backend (SMTP lib wrapper)
Install from PyPi via pip:
pip install Flask-Mailer| Option | Description |
|---|---|
MAILER_BACKEND |
Path to mailer backend, e.g. flask_mailer.backends.smpt.SMTPMailer |
MAILER_TESTING |
Enable dummy backend for testing |
MAILER_HOST |
Hostname for SMTP backend, e.g. localhost |
MAILER_PORT |
Port for SMTP backend, e.g. 25 |
MAILER_USERNAME |
Username for SMTP backend |
MAILER_PASSWORD |
Password for SMTP backend |
MAILER_DEFAULT_SENDER |
Default mail sender, e.g. webmaster |
from flask import Flask
from flask_mailer import Mailer, Email
app = Flask(__name__)
smtp = Mailer(app)
mail = Email(
subject='hi, there',
text='awesome message',
to=['to@example.com', 'you@example.com'],
from_addr='me@example.com'
)
smtp.send(mail)Setting to your app testing flag automatically enable the dummy mailer
backend or you can manually set MAILER_TESTING to True. On dummy mailer
all mails on send just append to outbox list:
smtp.send(mail)
assert len(smtp.outbox) == 1
assert smtp.outbox == [mail,]The extension inspired and partially reuse the code of the some awesome projects, such as:
Special thanks to their authors and contributors.
Licensed under the BSD license.