Skip to content

mail queuing and management for the Django web framework

License

Notifications You must be signed in to change notification settings

zenefits/django-mailer

 
 

Repository files navigation

Django Mailer

Pinax

Pinax is an open-source platform built on the Django Web Framework. It is an ecosystem of reusable Django apps, themes, and starter project templates. This collection can be found at http://pinaxproject.com.

This app was developed as part of the Pinax ecosystem but is just a Django app and can be used independently of other Pinax apps.

django-mailer

django-mailer is a reusable Django app for queuing the sending of email.

Getting Started

Simple usage instructions:

In settings.py:

INSTALLED_APPS = [
    ...
    "mailer",
    ...
]

EMAIL_BACKEND = "mailer.backend.DbBackend"

Run database migrations to set up the needed database tables.

Then send email in the normal way, as per the Django email docs, and they will be added to the queue.

To actually send the messages on the queue, add this to a cron job file or equivalent:

*       * * * * (/path/to/your/python /path/to/your/manage.py send_mail >> ~/cron_mail.log 2>&1)
0,20,40 * * * * (/path/to/your/python /path/to/your/manage.py retry_deferred >> ~/cron_mail_deferred.log 2>&1)

Documentation

The django-mailer documentation can be found at http://django-mailer2.readthedocs.org/en/latest/. See usage.rst in the docs for more advanced use cases - https://github.com/pinax/django-mailer/blob/master/docs/usage.rst#usage. The Pinax documentation is available at http://pinaxproject.com/pinax/.

Contributing

See CONTRIBUTING.rst for information about contributing patches to django-mailer.

Code of Conduct

In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a code of conduct, which can be found here http://pinaxproject.com/pinax/code_of_conduct/.

Pinax Project Blog and Twitter

For updates and news regarding the Pinax Project, please follow us on Twitter at @pinaxproject and check out our blog http://blog.pinaxproject.com.

About

mail queuing and management for the Django web framework

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%