django-celery-email-reboot 4.1.0

An async Django email backend using celery (forked from django-celery-email)

A Django email backend that uses a Celery queue for out-of-band sending of the messages.

This is a fork of django_celery_email. As this package has gone unmaintained for some time, we have decided to maintain the package in order to maintain compatibility with future Django versions, starting with Django 4.x and 5.x.

This new package is available in pypi under the name django-celery-email-reboot: https://pypi.org/project/django-celery-email-reboot/

Warning

This version requires the following versions:

• Python >= 3.9, < 3.14

• Celery:

  • >= 5.2, < 5.6 for Python 3.9 to 3.11

  • >= 5.3, < 5.6 for Python 3.12 and 3.13

• Django:

  • >= 3.2, < 4.3 for Python 3.9

  • >= 4.0, < 5.1 for Python 3.10

  • >= 4.1, < 5.3 for Python 3.11

  • >= 4.2, < 5.3 for Python 3.12 and 3.13

Using django-celery-email-reboot

Install from Pypi using:

pip install django-celery-email-reboot

To enable django-celery-email-reboot for your project you need to add djcelery_email to INSTALLED_APPS:

INSTALLED_APPS += ("djcelery_email",)

You must then set django-celery-email as your EMAIL_BACKEND:

EMAIL_BACKEND = 'djcelery_email.backends.CeleryEmailBackend'

By default django-celery-email will use Django’s builtin SMTP email backend for the actual sending of the mail. If you’d like to use another backend, you may set it in CELERY_EMAIL_BACKEND just like you would normally have set EMAIL_BACKEND before you were using Celery. In fact, the normal installation procedure will most likely be to get your email working using only Django, then change EMAIL_BACKEND to CELERY_EMAIL_BACKEND, and then add the new EMAIL_BACKEND setting from above.

Mass email are sent in chunks of size CELERY_EMAIL_CHUNK_SIZE (defaults to 10).

If you need to set any of the settings (attributes) you’d normally be able to set on a Celery Task class had you written it yourself, you may specify them in a dict in the CELERY_EMAIL_TASK_CONFIG setting:

CELERY_EMAIL_TASK_CONFIG = {
    'queue' : 'email',
    'rate_limit' : '50/m',  # * CELERY_EMAIL_CHUNK_SIZE (default: 10)
    ...
}

There are some default settings. Unless you specify otherwise, the equivalent of the following settings will apply:

CELERY_EMAIL_TASK_CONFIG = {
    'name': 'djcelery_email_send',
    'ignore_result': True,
}

After this setup is complete, and you have a working Celery install, sending email will work exactly like it did before, except that the sending will be handled by your Celery workers:

from django.core import mail

emails = (
    ('Hey Man', "I'm The Dude! So that's what you call me.", '[e-mail]', ['[e-mail]']),
    ('Dammit Walter', "Let's go bowlin'.", '[e-mail]', ['[e-mail]']),
)
results = mail.send_mass_mail(emails)

results will be a list of celery AsyncResult objects that you may ignore, or use to check the status of the email delivery task, or even wait for it to complete if want. You have to enable a result backend and set ignore_result to False in CELERY_EMAIL_TASK_CONFIG if you want to use these. You should also set CELERY_EMAIL_CHUNK_SIZE = 1 in settings if you are concerned about task status and results.

See the Celery docs for more info.

len(results) will be the number of emails you attempted to send divided by CELERY_EMAIL_CHUNK_SIZE, and is in no way a reflection on the success or failure of their delivery.