https://github.com/knyghty/django-rq-email-backend

Provides Django email integration for RQ (Redis Queue).
https://github.com/knyghty/django-rq-email-backend

django email rq

Last synced: about 1 month ago
JSON representation

Provides Django email integration for RQ (Redis Queue).

• Host: GitHub
• URL: https://github.com/knyghty/django-rq-email-backend
• Owner: knyghty
• License: other
• Created: 2013-05-09T03:41:35.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2024-09-23T23:20:14.000Z (about 2 months ago)
• Last Synced: 2024-09-30T10:42:35.447Z (about 2 months ago)
• Topics: django, email, rq
• Language: Python
• Homepage:
• Size: 68.4 KB
• Stars: 18
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

        
========================

django-rq-email-backend

========================

------------

Requirements

------------

* `Django `_

* `RQ `_

* `Django-RQ `_

------------

Installation

------------

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

.. code-block:: bash

    pip install django-rq-email-backend

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

.. code-block:: python

    INSTALLED_APPS = (

        # other apps

        'django_rq_email_backend',

    )

You must then set ``django_rq_email_backend`` as your ``EMAIL_BACKEND``::

    EMAIL_BACKEND = 'django_rq_email_backend.backends.RQEmailBackend'

By default ``django-rq-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 ``RQ_EMAIL_BACKEND`` just like you would normally have set

``EMAIL_BACKEND`` before you were using RQ. In fact, the normal installation

procedure will most likely be to get your email working using only Django, then

change ``EMAIL_BACKEND`` to ``RQ_EMAIL_BACKEND``, and then add the new

``EMAIL_BACKEND`` setting from above.

-----------

Inspiration

-----------

`django-rq-email-backend` was heavily influenced by:

* `django-celery-email `_

* `django-rq-mail `_