Django Celery SES
Django Email Backend with Amazon Web Service SES and Celery, developed and used by StreetVoice.
This packages provide a EmailBackend to utilize django-celery to send email. You can just plug the EmailBackend in your project without any modify with your code.
Since Amazon SES requires you to handle Bounce email from SNS notification, django-celery-ses also provides view to handle SNS notification for email address which is blacklisted in Amazon SES.
What is provided
- Celery EmailBackend
- SNS notification handler
- Blacklist to handle Bounce email
- Install from pip / easy_install
$ pip install django-celery-ses
INSTALLED_APPS = ( ... 'djcelery_ses', ... )
- migrate the database with South ( you have to install South )
$ ./manage.py migrate
- Change the
EMAIL_BACKEND = 'djcelery_ses.backends.CeleryEmailBackend'
urlpatterns = patterns('', ... (r'^djcelery_ses/', include('djcelery_ses.urls')), ... )
django-celery-ses uses Amazon SES through SMTP, so you have add
EMAIL_* configuration in
EMAIL_USE_TLS = True EMAIL_HOST = 'email-smtp.us-east-1.amazonaws.com' EMAIL_HOST_USER = '<YOUR_AWS_ACCESS_KEY_ID>' EMAIL_HOST_PASSWORD = '<YOUR_AWS_SECRET_ACCESS_KEY>' EMAIL_PORT = 587 SERVER_EMAIL = 'StreetVoice <firstname.lastname@example.org>' DEFAULT_FROM_EMAIL = 'StreetVoice <email@example.com>'
Besides these settings, you also have to setting the SES / SNS on AWS to make this package handle bounce mail for you.
How to use
All you have to do is use
EmailMessage just like the old time, you don't have to change your code.
This package handle Blacklist for you by default, but sometimes, maybe you want to bypass the "blacklist check", you can use
pass_blacklist to pass the "backlist check" like this.
from djcelery_ses.utils import pass_blacklist from django.core.mail import EmailMessage with pass_blacklist: msg = EmailMessage('title', 'body content', 'firstname.lastname@example.org', ['email@example.com']) msg.send()
or in some situations, you don't want the email to send through Celery queue, you can use
no_delay, for example.
since version 0.9
from djcelery_ses.utils import no_delay from django.core.mail import send_mail with no_delay: send_mail('title', 'body content', 'firstname.lastname@example.org', ['email@example.com'])
no_delay your email will send out directly without Celey queue.
In order to ensure your changed which can pass in local environment, please run the script: