Quick Start Guide¶
As of 2.0 Django Mail Queue is now Python 3 compatible!
Django Mail Queue requires:
python 2.7 or greater django 1.8 or greater
Django Mail Queue is tested against Python 2.7, 3.x and Django 1.8 and 1.9.
If using Celery, you’ll need celery 3 or greater.
pip install django-mail-queue
Go to https://github.com/dstegelman/django-mail-queue if you need to download a package or clone the repo.
settings.py and add
mailqueue to your
INSTALLED_APPS = ( 'mailqueue', )
Mailqueue can be configured a few different ways:
- Configured to send mail synchronously in the web request.
- Configured to send mail asynchronously through Celery.
- Configured to queue up and send mail in bulk through a management command.
- Confgiured to queue up and send mail in bulk through a hitting a URL. (pending deprecation)
This is the default setting for mailqueue. You do not need to set any additional settings for this option.
Celery is disabled by default, you can turn it on the use of Celery and
send emails in real time using
MAILQUEUE_CELERY in settings:
MAILQUEUE_CELERY = True
Instead of using the cron job the celery task worker will attempt to send email when it’s saved. The cron job will clean up any emails that get lost.
First, in order to queue up the mail and not send on save(), you’ll need to set the queue up:
MAILQUEUE_QUEUE_UP = True
A cron job can be set up to work one of two ways: using a management command
or an HTTP request. Both methods run the mail queue which grabs emails and
sends them. To decrease load, it only tries to send 30 emails at a time.
This number can be changed by using
MAILQUEUE_LIMIT in settings:
MAILQUEUE_LIMIT = 50
Using the management command:
python manage.py send_queued_messages
You can also override
MAILQUEUE_LIMIT by using the
python manage.py send_queued_messages --limit=10
urlpatterns = patterns('', (r'^mail-queue/', include('mailqueue.urls')), )
If you’re running cron from another machine or can’t run python directly, you can add the above to urls.py and use a utility like curl to hit /mail-queue/.
You can force mail queue to use default file system storage with MEDIA_ROOT as the storage folder. You may want to do this because by default mail queue will use your default file storage, and attachments are known to not work against various storages such as S3 Boto.
To force Django’s File System storage:
MAILQUEUE_STORAGE = True
To change the Attachment dir:
MAILQUEUE_ATTACHMENT_DIR = 'mailqueue-attachments'