Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 2.37 KB

README.md

File metadata and controls

41 lines (27 loc) · 2.37 KB
Raw

django-email-relay

PyPI PyPI - Python Version Django Version

django-email-relay enables Django projects without direct access to a preferred SMTP server to use that server for email dispatch.

It consists of two parts:

  1. A Django app with a custom email backend that stores emails in a central database queue. This is what you will use on all the distributed Django projects that you would like to give access to the preferred SMTP server.

  2. A relay service that reads from this queue to orchestrate email sending. It is available as either a standalone Docker image or a management command to be used within a Django project that does have access to the preferred SMTP server.

Requirements

  • Python 3.8, 3.9, 3.10, 3.11, 3.12
  • Django 3.2, 4.2, 5.0

Getting Started

Visit the documentation for more information. There you will find:

  • Why we created this package and how it can help you.
  • How to install and configure the relay service and Django app.
  • How to use the Django app to send emails.
  • Things to be aware of when it comes time to update the package.
  • How you can contribute to the package.

Inspiration

This package is heavily inspired by the django-mailer package. django-mailer is licensed under the MIT license, which is also the license used for this package. The required copyright notice is included in the LICENSE file for this package.

License

django-email-relay is licensed under the MIT license. See the LICENSE file for more information.