A Django app to monitor and send mail asynchronously, complete with template support.
Project description
Django SendMail
Asynchronous email sending library for Django with enhanced templating options.
Full documentation can be found here
sendmail provides a set of powerful features, such as:
- Handling millions of emails efficiently.
- Allows you to send emails asynchronously.
- Multi backend support.
- Support for inlined images.
- 2-phase email templating to allow non-technical users contributing to emails creation.
- Scheduling support.
- Works with task queues like RQ and Celery.
- Uses multiprocessing to send emails in parallel.
- Support of different storages.
Dependencies
Installing nh3 is strongly encouraged for security reasons. Only with installed nh3 emails will be rendered in admin interface.
Installation
pip install django-sendmail
To enable JSON editing functionality for Newsletter in the admin interface, install with django-jsoneditor
optional dependency.
pip install django-sendmail[jsoneditor]
Add sendmail and ckeditor to your installed app in settings.py:
INSTALLED_APPS = [
# other apps,
'ckeditor',
'ckeditor_uploader',
'sendmail',
'jsoneditor' # if installed
]
To your settings.py also add email server configurations:
EMAIL_HOST = '<your-smtp-host.com>'
EMAIL_PORT = '<SMTP-PORT>'
EMAIL_USE_TLS = True
DEFAULT_FROM_EMAIL = 'default@email.com'
To your list of template engines (TEMPLATES) settings add a special template backend:
TEMPLATES = [
{
'BACKEND': 'sendmail.template.backends.sendmail.SendMailTemplates',
'APP_DIRS': True,
'DIRS': [BASE_DIR / 'templates', ...],
'OPTIONS': {
'context_processors': [
'django.contrib.auth.context_processors.auth',
'django.template.context_processors.debug',
'django.template.context_processors.i18n',
'django.template.context_processors.media',
'django.template.context_processors.static',
'django.template.context_processors.tz',
'django.template.context_processors.request',
]
}
},
...
]
Add CKEDITOR_UPLOAD_PATH. This path will be used to store ckeditor uploaded images inside MEDIA_ROOT:
CKEDITOR_UPLOAD_PATH = 'ckeditor_uploads'
To your main urls.py add ckeditor_uploader urls:
urlpatterns = [
...,
path('ckeditor/', include('ckeditor_uploader.urls')),
]
Add STATIC_URL and STATIC_ROOT
STATIC_URL = '/static/'
STATIC_ROOT = BASE_DIR / 'staticfiles'
Add MEDIA_URL and MEDIA_ROOT
MEDIA_URL = '/media/'
MEDIA_ROOT = BASE_DIR / 'workdir' / 'media'
Run migrate:
python manage.py migrate
Run collectstatic:
python manage.py collectstatic
Set sendmail.EmailBackend as your EMAIL_BACKEND in Django's settings.py:
EMAIL_BACKEND = 'sendmail.EmailBackend'
Quickstart
Send a simple email is really easy:
from sendmail import mail
mail.send(
'recipient@example.com', # List of email addresses also accepted
'from@example.com',
subject='My email',
message='Hi there!',
html_message='Hi <strong>there</strong>!',
)
If you want to use templates:
- In your templates folder create an .html file with your email markup. Inside it you can leave placeholders or use context vars. For example something like this:
{% load sendmail %}
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Example email template</title>
</head>
<body>
Hello, {{ username }}
{% placeholder 'main' %}
</body>
</html>
- Register your template in
settings.py:
SENDMAIL = {
'EMAIL_TEMPLATES': [
('your-file/path', _('Your-Name')),
]
}
You can use relative path from your templates folder or absolute file path.
-
Specify list of translation languages in
settings.LANGUAGESor disable internalization by settingsettings.USE_I18NtoFalse. -
Open your admin interface and create a new EmailMergeModel instance:
-
Enter name. This will be used as identifier for your template and click “Save and continue editing”.
-
Select Base File which you have created.
-
You will be requested to enter values to the placeholders you entered in the template. (main in the example). You can specify variables to be filled with the context. Syntax is
#var#. Example: This is a simple mail created by #generator# -
If you have more than 1 language configured you will be able to fill values for all languages in
LANGUAGES:- Create element in Email Template Contents inline with desired language
- Click
Save and Continue Editing - Fill in placeholders
-
Save your instance.
-
You can now send test email with created object using
Send test email button. In test email you can make use ofdemo contextthat can be refreshed usingReparse Contextbutton.
-
-
To send an email with the created template:
from sendmail import mail
mail.send(
'recipient@example.com', # List of email addresses or list of EmailAddress also accepted
'from@example.com',
emailmerge='your-template-here', # Could be an EmailMergeModel instance or name
context={'generator': 'sendmail',
'username': 'michaelpoi', }, # Context is used to fill both {{ var }} in html and #var# in ckeditor.
language='en' # If not specified settings.LANGUAGE_CODE is used
)
The above command will put your email on the queue so you can use the command in your webapp without slowing down the request/response cycle too much. To actually send them out, run
python manage.py sendmail all
You can schedule this management command to run regularly via cron:
* * * * * (/usr/bin/python manage.py sendmail all >> send_mail.log 2>&1)
Full documentation can be found here
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_sendmail-4.0.tar.gz.
File metadata
- Download URL: django_sendmail-4.0.tar.gz
- Upload date:
- Size: 73.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.9.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dc8fdb90ace6d9c86e7e3af3ac5bcb5a03fc45e6891bef92e6cb5b33272a6d69
|
|
| MD5 |
279f873c33b705a71548868e70c79e30
|
|
| BLAKE2b-256 |
269b607b3c26c477c7d09688b0cef2fae0614254cb4650ccd6333d9bf45c2014
|
File details
Details for the file django_sendmail-4.0-py3-none-any.whl.
File metadata
- Download URL: django_sendmail-4.0-py3-none-any.whl
- Upload date:
- Size: 119.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.9.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4d1615bcfbe7f4adb7f2138813bee9a92bd115b5b1b618fc128e00da8c596f4e
|
|
| MD5 |
d54c2c8b35efe5f8db6376c3e71e869b
|
|
| BLAKE2b-256 |
a196e3d83c648a7261a87ce8cfb6a42152fa0eeb3ff0f16e109298087181c0b4
|
