Use an URL to configure email backend settings in your Django Application.
Project description
This utility is based on dj-database-url by Kenneth Reitz.
It allows to utilize the 12factor inspired environments variable to configure the email backend in a Django application.
Usage
Import the package in settings.py:
import dj_email_urlFetch your email configuration values. The default option is fetch them from EMAIL_URL environment variable:
email_config = dj_email_url.config()Other option is parse an arbitrary email URL:
email_config = dj_email_url.parse('smtp://...')Finally, it is necessary to assign values to settings:
EMAIL_FILE_PATH = email_config['EMAIL_FILE_PATH']
EMAIL_HOST_USER = email_config['EMAIL_HOST_USER']
EMAIL_HOST_PASSWORD = email_config['EMAIL_HOST_PASSWORD']
EMAIL_HOST = email_config['EMAIL_HOST']
EMAIL_PORT = email_config['EMAIL_PORT']
EMAIL_BACKEND = email_config['EMAIL_BACKEND']
EMAIL_USE_TLS = email_config['EMAIL_USE_TLS']
EMAIL_USE_SSL = email_config['EMAIL_USE_SSL']Alternatively, it is possible to use this less explicit shortcut:
vars().update(email_config)Supported backends
Currently, it supports:
SMTP backend (smtp and smtps for TLS),
console backend (console),
file backend (file),
in-memory backend (memory),
and dummy backend (dummy).
SMTP backend
The scheme smtps indicates to use TLS connections, that is to set EMAIL_USE_TLS to True.
It is possible to specify SSL using a ssl=True as a query parameter:
>>> url = 'smtp://user@domain.com:pass@smtp.example.com:465/?ssl=True'
>>> url = dj_email_url.parse(url)
>>> assert url['EMAIL_USE_SSL'] is TrueFile backend
The file backend is the only one which needs a path. The url path is store in EMAIL_FILE_PATH key.
Change Log
0.0.9 - Unreleased
Fixcase when user sets ssl=False in its url (thanks bogdal)
0.0.8 - 2016-06-07
Allow universal wheel
0.0.7 - 2016-05-31
Add EMAIL_USE_SSL setting to docs and set a default value (thanks iraycd).
Add coverage (thanks iraycd).
0.0.6 - 2016-04-18
Fix error parsing URL without credentials (thanks martinmaillard).
0.0.5 - 2016-04-17
Allow URL encoded credentials (thanks kane-c).
0.0.4 - 2015-03-05
Fix README.
0.0.3 - 2015-03-05
Add change log.
Add ssl= option as a query parameter for SMTP backend.
Add Travis continuous integration.
0.0.2 - 2014-03-12
Add Python 3 support.
0.0.1 - 2013-02-12
Initial version.
CI status
Development (master):
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
File details
Details for the file dj-email-url-0.0.9.tar.gz.
File metadata
- Download URL: dj-email-url-0.0.9.tar.gz
- Upload date:
- Size: 3.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2efc602c390cbdfdfb2f877b82901775c790d7c45f1cb388de2ad69f4c38ba39 |
|
| MD5 | 509b89d2c36b0981c046dfe87ff55e27 |
|
| BLAKE2b-256 | 1a4f1291646387101dcecef00d25b5889c4981bea5e83889dfe94623c31881f4 |
File details
Details for the file dj_email_url-0.0.9-py2.py3-none-any.whl.
File metadata
- Download URL: dj_email_url-0.0.9-py2.py3-none-any.whl
- Upload date:
- Size: 5.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a31900ac8b888969606eadbd6d83a1d1fcc48419c5a37a502600d973afd91386 |
|
| MD5 | 7ae95b9fa416de243bdd560f23d63d63 |
|
| BLAKE2b-256 | 5effad79fcf0da072987a755991bf942d54cc2d30ed4c46166737e0487b510c4 |
