molten-mail 0.1.0

A simple email component for the Molten web framework

molten-mail

Provides a simple interface to set up SMTP with your Molten web application and send messages from your handler functions. Please note this work derives largely from the Flask-Mail extension by 'Dan Jacob' and contributors, but has been modified extensively to remove Python 2 support and be used as a Molten component.

Installation

pip install molten-mail

If you plan on using HTML templates you will need to ensure that Jinja2 is installed.

pip install molten-mail[templates]

Usage

Be sure to check the examples folder for sample applications and more complex usage.

Example Setup

To send mail messages from your view functions you must instantiate a Mail instance yourself or use the MailComponent. The MailComponent will instantiate a global Mail instance from settings provided in the molten.Settings.

Here we have a minimally viable app capable of sending an email message and returning a 204 response code:

from molten import (
    App,
    Route,
    Settings,
    SettingsComponent,
    QueryParams,
    HTTP_204,
    HTTP_400,
    Response,
)
from molten_mail import MailComponent, Mail, Message

# Replace with your own SMTP parameters
settings = Settings(
    {
        "MAIL_SERVER": "smtp.example.com",
        "MAIL_USERNAME": "[e-mail]",
        "MAIL_PASSWORD": "dontaddthistoyourversioncontrol",
        "MAIL_PORT": 587,
        "MAIL_USE_TLS": True,
        "MAIL_DEFAULT_SENDER": "[e-mail]",
    }
)


def send_message(params: QueryParams, mail: Mail):
    """Emails an email address provided in the query string"""
    addresses = params.get_all("email")
    if not addresses:
        return Response(
            HTTP_400,
            content="Provide emails in the query params to send a welcome message",
        )
    msg = Message(
        subject="Welcome to Molten!",
        body="Welcome to Molten! Glad to have you here.",
        recipients=addresses,
    )
    mail.send(msg)
    return Response(HTTP_204, content="")


routes = [Route("/", send_message, "POST")]

components = [SettingsComponent(settings), MailComponent()]

app = App(routes=routes, components=components)

Configuration Options

A singleton Mail component can be configured for use in dependency injection using options included in your molten.Settings. This requires that you include the MailComponent within you molten.App instance. The key values can either be all upper or lowercase and begin with MAIL_. The available options are:

• 'MAIL_SERVER': default 'localhost'
• 'MAIL_USERNAME': default None
• 'MAIL_PASSWORD': default None
• 'MAIL_PORT': default 25
• 'MAIL_USE_TLS': default False
• 'MAIL_USE_SSL': default False
• 'MAIL_DEFAULT_SENDER': default None
• 'MAIL_DEBUG': default False
• 'MAIL_MAX_EMAILS': default None
• 'MAIL_SUPPRESS_SEND': default False
• 'MAIL_ASCII_ATTACHMENTS': False

Sending Messages

To send a message, instantiate a Mail component. Then create an instance of Message, and pass it to your Mail component using mail.send(msg)

from molten_mail import Mail, Message

mail = Mail(server="localhost",
            user="[e-mail]",
            password="dontaddthistoyourversioncontrol",
            port=587,
            use_tls=True,
            default_sender="[e-mail]")
msg = Message(subject="Hey there!", body="Welcome to Molten Mail", recipients=["[e-mail]"])
mail.send(msg)

Your message recipients can be set in bulk or individually:

msg.recipients = ['[e-mail]', '[e-mail]']
msg.add_recipient('[e-mail]')

If you have included a default sender you do not need to set the message sender explicitly, as it will use this configuration value by default:

msg = Message('Hello',
              recipients=['[e-mail]'])

The sender can also be passed as a two element tuple containing a name and email address which will be split like so:

msg = Message('Hello',
              sender=('Me', '[e-mail]'))

assert msg.sender == 'Me <[e-mail]>'

A Message can contain a body and/or HTML:

msg.body = 'message body'
msg.html = '<b>Hello Molten-mail!</b>'

A convenience function send_message can also be used to create and send a message:

mail.send_message(subject="Your subject", body="Message body", recipients=["[e-mail]"])

HTML Email Templates

Molten-mail includes a convenience component MailTemplates for rendering HTML email bodies using Jinja2. You have to install jinja2 yourself before using this module.

You must include the MailTemplatesComponent in your app, passing the path to a folder containing your templates.

from molten import App, Route, Response, HTTP_204, Settings, SettingsComponent
from molten_mail import Mail, MailComponent
from molten_mail.templates import MailTemplates, MailTemplatesComponent

settings = Settings({
    ...
})

def view_func(mail: Mail, mail_templates: MailTemplates): -> Response:
    mail.send_message(
        subject="Hello Molten!",
        html=mail_templates.render("my_email_template.html", somevalue="Key values for the template context"),
        recipients=["[e-mail]"]
    )
    return Response(HTTP_204, content="")

app = App(
    components=[SettingsComponent(settings),
                MailComponent(),
                MailTemplatesComponent('./path_to_templates_dir')],
    routes=[Route('/', view_func, method="POST"]
)

Testing

To run the test suite with coverage first install the package in editable mode with it's full testing requirements:

$ pip install -e ".[dev]"

To run the project's tests

$ pytest --cov

To run tests against multiple python interpreters use:

$ tox

HISTORY

0.1.0 Initial Release

• Initial release.