Skip to main content

MIT Open Learning django app extensions for mail

Project description

mitol-django-mail

This is the Open Learning Django Mail app. It provides a few key features around mail:

  • Templated multipart html emails
  • Automatic generation of plaintext portion of multipart email
  • CSS inlining for email html

Getting started

pip install mitol-django-mail

Add the mail app:

INSTALLED_APPS = [
    ...
    "mitol.mail.apps.MailApp",
]

Settings

Common Django settings

  • SITE_BASE_URL - the website's host url, including the protocol (e.g. "https://example.com/")
  • SITE_NAME - the website's name

Mail app settings

All settings for the mitol-django-mail app are namespaced in django settings with MITOL_MAIL_ prefix.

  • MITOL_MAIL_FROM_EMAIL - the default from email for all messages
  • MITOL_MAIL_REPLY_TO_ADDRESS - the default reply-to email for all messages
  • MITOL_MAIL_MESSAGE_CLASSES - a list of fully qualified message class names that make the message classes available in the debugger
  • MITOL_MAIL_ENABLE_EMAIL_DEBUGGER - True if the email debugger should be enabled, you probably want to set this to the same value as DEBUG
  • MITOL_MAIL_RECIPIENT_OVERRIDE - only used locally, this overrides the recipient of all outgoing email messages
  • MITOL_MAIL_FORMAT_RECIPIENT_FUNC - (optional) set to a custom function to format recipients. You'll typically use this if you're storing the name in a place other that Django's builtin User model. Default: "mitol.mail.defaults.format_recipient".
  • MITOL_MAIL_CAN_EMAIL_USER_FUNC - (optional) set to a custom function to determine whether a user can be sent an email. You'll typically use this if you have additional criteria beyond the user having an email. Default: "mitol.mail.defaults.can_email_user".
  • MITOL_MAIL_CONNECTION_BACKEND - the connection backend to use for email sending. You'd use this only if you're doing something really custom that anymail doesn't give you. Default: "anymail.backends.mailgun.EmailBackend".

Usage

Create message classes

This involves subclassing mitol.mail.messages.TemplatedMessage. To subclass, do the following:

  • template_name attribute - str that denotes the directory within templates/mail that this message's templates reside in (e.g. "password_reset")
  • name attribute - a human-friendly name for your message (e.g. "Password Reset")
  • get_debug_template_context - static method that returns a context dict for rendering the email in the debugger

Define templates

In your apps's templates directory, create some templates:

templates/
  mail/
    {template_name}/
      subject.txt
      body.html

Configure settings.py

Add your custom message class to MITOL_MAIL_MESSAGE_CLASSES so it is available in the debugger.

Optional customizations

Optionally, you can also override:

  • get_base_template_context - extend the default base template context used with all emails of this type. Return type is a dict. As a best practice you should be merging with super().get_base_template_context().
  • get_default_headers - extend the default headers included with all emails of this type. Return type is a dict. As a best practice you should be merging with super().get_default_headers().

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mitol_django_mail-2025.6.24.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

mitol_django_mail-2025.6.24-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file mitol_django_mail-2025.6.24.tar.gz.

File metadata

  • Download URL: mitol_django_mail-2025.6.24.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mitol_django_mail-2025.6.24.tar.gz
Algorithm Hash digest
SHA256 7acaec76138b35bf20af8d33e55c575a829c9e7f6d28f02246da720147c1adc9
MD5 cbe4c5fcf239f5ba6790ccbc45c06b3f
BLAKE2b-256 cf82ca6814b0fa4ebaf0ab1c9e93c1a2b60da7f198e8b13823d0adaac15a404f

See more details on using hashes here.

File details

Details for the file mitol_django_mail-2025.6.24-py3-none-any.whl.

File metadata

File hashes

Hashes for mitol_django_mail-2025.6.24-py3-none-any.whl
Algorithm Hash digest
SHA256 20e1830de82095fa1bc5484275c036a45b207e991f9febd65b4d9e276ffd4f57
MD5 60544642290c68533092ad156a7adf6b
BLAKE2b-256 b46d8740fa49df7e729c87d9379c94b44ae1adc46be9bab6cbb7a42e918f786d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page