Skip to main content

django-email-bandit is a Django email backend for hijacking email sending in a test environment.

Project description

A Django email backend for hijacking email sending in a staging/test environment. It extends the default SMTP backend to intercept outgoing emails and instead send them to a single email address that you specify. It does not intercept emails going to the site admins (as defined by the ADMINS setting) so it will not interfere with 500 error emails.

You can also configure the hijacked emails to be logged through standard Python logging. Mixin classes are provided to use the same hijack logic for any existing email backend such as django-ses.

Requirements

  • Python 3

  • Django >= 2.2 (supported versions)

Installation

To install django-email-bandit via pip:

pip install django-email-bandit

Add django-email-bandit to your installed apps:

INSTALLED_APPS = (
    ...
    'bandit',
    ...
)

For your test environment you should enable the backend:

EMAIL_BACKEND = 'bandit.backends.smtp.HijackSMTPBackend'

and set the email which will receive all of the emails:

BANDIT_EMAIL = 'bandit@example.com'

or even multiple addresses:

BANDIT_EMAIL = ['bandit@example.com', 'accomplice@example.com']

It’s also possible to whitelist certain email addresses and domains:

BANDIT_WHITELIST = [
    'iloveemail@example.com',  # Just this specific email address
    'example.net'   # All email addresses @example.net
]

Documentation

Full project documentation is on Read the Docs.

Maintainer Information

We use Github Actions to lint (using pre-commit, black, isort, and flake8), test (using tox and tox-gh-actions), calculate coverage (using coverage), and build documentation (using sphinx).

We have a local script to do these actions locally, named maintain.sh:

$ ./maintain.sh

A Github Action workflow also builds and pushes a new package to PyPI whenever a new Release is created in Github. This uses a project-specific PyPI token, as described in the PyPI documentation here. That token has been saved in the PYPI_PASSWORD settings for this repo, but has not been saved anywhere else so if it is needed for any reason, the current one should be deleted and a new one generated.

As always, be sure to bump the version in bandit/__init__.py before creating a Release, so that the proper version gets pushed to PyPI.

Questions or Issues?

If you have questions, issues or requests for improvements please let us know on Github.

Development sponsored by Caktus Consulting Group, LLC.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-email-bandit-2.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

django_email_bandit-2.0-py2.py3-none-any.whl (10.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-email-bandit-2.0.tar.gz.

File metadata

  • Download URL: django-email-bandit-2.0.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for django-email-bandit-2.0.tar.gz
Algorithm Hash digest
SHA256 676174702b57d1e1f4d74e507fc6bc0e6292e3af08f20088dc4f859614710706
MD5 43490c5c896946e087c5a552950f2a41
BLAKE2b-256 ec5c3246544486a3215d905385a14e34a76cfaf60ff7a90613baa6d968fed1e9

See more details on using hashes here.

Provenance

File details

Details for the file django_email_bandit-2.0-py2.py3-none-any.whl.

File metadata

  • Download URL: django_email_bandit-2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for django_email_bandit-2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 22b0a3ebf2ac19051facc2148df338f353a749d9e3e3bce6551fffcbbe049d0a
MD5 513c651832a461f466eb062cc51d5028
BLAKE2b-256 f2eb798812481e102792fdac554b18ca93950fe129b9a0091868a894ed41bf44

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page