Skip to main content

DKIM signing e-mail backend for Django

Project description

https://gitlab.com/stinovlas/django-dkim/badges/master/pipeline.svg https://gitlab.com/stinovlas/django-dkim/badges/master/coverage.svg https://img.shields.io/pypi/pyversions/django-dkim.svg https://img.shields.io/pypi/djversions/django-dkim.svg

DKIM signing is generally better left to the mailserver. However, there are situations when you are unable to configure the SMTP server you use for sending mail. If you still want to sign your messages with DKIM, you can do it manually, on the application level.

This library provides custom e-mail backends with DKIM signing for Django web framework. Singing itself is provided by dkimpy library.

Installation

You can install stable version of django-dkim from PyPi:

$ pip install django-dkim

Settings

In order to use this custom backends, you have to add a few configuration options into your Django settings.

  • EMAIL_BACKEND - dotted path to custom e-mail backend

  • DKIM_SELECTOR - string containing DKIM selector

  • DKIM_DOMAIN - string containing DKIM domain

  • DKIM_PRIVATE_KEY - string containing whole private key (including the header)

Note: This library is not Django application, so you don’t need to change your INSTALLED_APPS setting.

Example

EMAIL_BACKEND = 'django_dkim.backends.smtp.EmailBackend'
DKIM_SELECTOR = 'selector'
DKIM_DOMAIN = 'example.com'
DKIM_PRIVATE_KEY = '''-----BEGIN RSA PRIVATE KEY-----
MIICXQIBAAKBgQDQUTvs1Rqjw6Vq2/LRnI7LzycT1gM1G4ZRMdWiLFg7y4TEPwfW
r6RgR04f56L9PxM1B6gW+gTkm30dwxNbU60u7emcqu+mYCzyVBHx9a4uhI3Ts8sy
67zIIeXarmxh+V/jqmAbdRAzRzAvjs0S74di1mwCplxYvVOEsDOj7OIEDQIDAQAB
AoGAR2rSJIuaqnI0j8IAKSSHQBAw0XgZeWeKUOPI3eReC4HmbnE9eriUnf1UJ1P+
aNvq9c8+LUJh0w4LgtySEklJoaK6rqLsdQhriHRiYThctMlzoZiLuVo6MQdACHBj
5LvjQY+PSIkpdoQumQJAwngyG0Zkg+t2u57UINn+p3zBxoECQQDuaF5HBELdbu84
08UsiG+zvuGoKEjtr4EjRZ9hdgkErooO8SXbJT+ALwJ6M6awGvkxQiPYR39kgCcG
VpB744aFAkEA37Bx33DKOpbOju2IaF4nwJ/JBmz54EvFOTl2ImP9iHM2qfZo8ueg
/iOG2vifayt5FvgTN7I7rpo3oQcI1DLR6QJBANskYmyi9Rd3zjsNJfQeYZb2gZRB
m2+n4Gtcpvk+N2HvUgYUEfkTjwAztfJAIhtEYASwSCSY6/ekeLqxvVOzu8UCQQCm
F4eWF1OxiUS6j9kXVcJCnuJPKR+o0doRkX8MLh6U8KeIL/ThV+gMjCiX8r+8fb0d
tvneAzOZg90Gbgi6NznxAkAXQz0rYjnQwRjlCyS/KUG1fek/EfJBlgiDmMtYuUpq
UPPnqkzsGyB9LqzL4aoKg1LDsbVP0hSt97SYhB9TtcgO
-----END RSA PRIVATE KEY-----'''

Available e-mail backends

  • django_dkim.backends.smtp.EmailBackend - DKIM extension of Django SMTP backend

  • django_dkim.backends.console.EmailBackend - DKIM extension of Django console backend

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-dkim-0.1.0.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

django_dkim-0.1.0-py2.py3-none-any.whl (8.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-dkim-0.1.0.tar.gz.

File metadata

  • Download URL: django-dkim-0.1.0.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-dkim-0.1.0.tar.gz
Algorithm Hash digest
SHA256 01b00c1f04846f379e1dec0f20508cec71b0f511b35f6095d5ec7f2b4655733b
MD5 9306f8b0e5cd3e074692e7144ed83fbd
BLAKE2b-256 48ef7221d841f16b83d95460e2ae76b73464a95f68a5d349616970f7770c86a3

See more details on using hashes here.

File details

Details for the file django_dkim-0.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_dkim-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e5618c9975c7ab7a20994604a5fabe4e40e95046675cb32adfd78e7aafd655dc
MD5 4e13647174eeca349e0b6de4f64108b0
BLAKE2b-256 f9d3acc1f7cc4fc76758ccabcf405162d0fd8c8ea6502a85aa9ac99312e4810c

See more details on using hashes here.

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