Metadata-Version: 2.4
Name: django-q2-email-backend
Version: 2.1.0
Summary: An asynchronous Django email backend for Django Q2
Project-URL: Homepage, https://github.com/knyghty/django-q2-email-backend
Project-URL: Repository, https://github.com/knyghty/django-q2-email-backend
Author-email: Tom Carrick <tom@carrick.eu>
License: MIT License
        
        Copyright (c) 2024 Tom Carrick
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.1
Classifier: Framework :: Django :: 5.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Communications :: Email
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: django
Requires-Dist: django-q2
Description-Content-Type: text/x-rst

=======================
Django Q2 Email Backend
=======================

An asynchronous Django email backend for Django Q2

------------
Requirements
------------

* `Django <https://www.djangoproject.com/>`_
* `Django Q2 <https://github.com/django-q2/django-q2>`_

------------
Installation
------------

* Install ``django-q2-email-backend``:

.. code-block:: bash

    pip install django-q2-email-backend

* Add ``django_q2_email_backend`` to ``INSTALLED_APPS`` in ``settings.py``:

.. code-block:: python

    INSTALLED_APPS = (
        # other apps
        "django_q2_email_backend",
    )

You must then set django-q2-email-backend as your ``EMAIL_BACKEND``:

.. code-block:: python

    EMAIL_BACKEND = "django_q2_email_backend.backends.Q2EmailBackend"

By default django-q2-email-backend will use Django's builtin ``SMTP`` email backend
for the actual sending of the mail. If you'd like to use another backend, you
may set it in ``Q2_EMAIL_BACKEND`` just like you would normally have set
``EMAIL_BACKEND`` before you were using Q2. In fact, the normal installation
procedure will most likely be to get your email working using only Django, then
change ``EMAIL_BACKEND`` to ``Q2_EMAIL_BACKEND``, and then add the new
``EMAIL_BACKEND`` setting from above.


Credits
-------

Some code around serializing emails was taken from `joeyespo/django-q-email`_

This package was created with Cookiecutter_ and the `knyghty/cookiecutter-django-package`_ project template.

.. _`joeyespo/django-q-email`: https://github.com/joeyespo/django-q-email
.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
.. _`knyghty/cookiecutter-django-package`: https://github.com/knyghty/cookiecutter-django-package
