Install

pip install -e git://github.com/shantilabs/django-mailqueue.git#egg=mailqueue

Base settings:

INSTALLED_APPS = (
    # ...
    'mailqueue',
)

Features

Letters queue for asynchronous sending

Cases:

from datetime import timedelta 
from django.utils import timezone
from mailqueue import mailqueue

# simple email
mailqueue.add_mail('subject', 'message', '[email protected]')

# send now (synchronous)
mailqueue.add_mail('subject', 'message', '[email protected]', 
                   send_now=True)

# send after 3 days
start_datetime = timezone.now() + timedelta(days=3)
mailqueue.add_mail('subject', 'delayed message', '[email protected]', 
                   start_datetime=start_datetime)

# custom "From" (for easy reply)
mailqueue.add_mail('New question', question, manager.email, 
                   from_email=customer.email)

Mail archive

mailqueue.models.MailerMessage

Django templates for letters

=== letters/hello.txt ===
{% extends "email.txt" %} 

{% block subject %}Subject{% endblock %}

{% block body %}
    Hello, {{ customer.name }}!
{% endblock %}

Usage:

from mailqueue import mailqueue

# email from django templates
mailqueue.add_templated_mail(customer.email, 'letters/hello.txt', {
    'customer': customer,
})

Tuning

Server settings

Different settings for mailqueue's letters and for standard Django send_mail() / mail_admin() functions:

EMAIL_HOST = 'myhost'
EMAIL_HOST_USER = 'user'
EMAIL_HOST_PASSWORD = 'password'

MAILQUEUE_SERVER_SETTINGS = {
    'host': 'another_host',
    'username': 'another_username',
    'password': 'another_password',
}

Different settings for different recipients:

MAILQUEUE_SERVER_SETTINGS = [{
    # from yandex to yandex
    'to_regex': '^.*@yandex.ru$',
    'host': 'smtp.yandex.ru',
    'port': 465,
    'username': 'username',
    'password': '********',
    'use_tls': True,
}, {
    # from gmail to other services
    'host': 'smtp.gmail.com',
    'port': 587,
    'username': '[email protected]',
    'password': '********',
    'use_tls': True,
}]

Sending method

# default behavior: send email after creation like send_mail()
MAILQUEUE_SEND_METHOD = 'now'

# send email after creation with celery task 
# MAILQUEUE_SEND_METHOD = 'celery'

# Manual run
# MAILQUEUE_SEND_METHOD = 'cron'

Celery task: mailqueue.task.clean_mailqueue

Crontab for manual run:

*/2 * * * * www-data /path/to/my/project/manage.py process_mailqueue

Supervisord config for manual run:

[program:myproject_mailqueue]
command=/path/to/my/project/manage.py process_mailqueue --forever
process_name=myproject_mailqueue
user=www-data
autorestart=true

Cleanup

# 0 = save letters forever (default)
MAILQUEUE_ARCHIVE_LIFETIME_DAYS = 0

Celery task: mailqueue.tasks.clean_mailqueue

Crontab:

0 4 * * * www-data /path/to/my/project/manage.py clean_mailqueue

"From" field

Default contents of "From" field if sender's email is not equals to server email:

MAILQUEUE_FROM = "{from_email}"

GMail always set server email to "From". Avoid this:

MAILQUEUE_FROM = u'{from_email} <{email_host_user}>'

Interval between letters

MAILQUEUE_PROCESSING_PAUSE_SECONDS = 2