https://github.com/joeyespo/django-q-email

Queues the sending of email with Django Q.
https://github.com/joeyespo/django-q-email

background-jobs django django-q email pypi python

Last synced: 11 days ago
JSON representation

Queues the sending of email with Django Q.

• Host: GitHub
• URL: https://github.com/joeyespo/django-q-email
• Owner: joeyespo
• License: mit
• Created: 2017-02-09T04:38:13.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-10-13T17:56:21.000Z (about 3 years ago)
• Last Synced: 2024-10-14T09:29:11.514Z (25 days ago)
• Topics: background-jobs, django, django-q, email, pypi, python
• Language: Python
• Homepage:
• Size: 12.7 KB
• Stars: 34
• Watchers: 4
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Django Q Email

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

[![Current version on PyPI](http://img.shields.io/pypi/v/django-q-email.svg)][pypi]

`django-q-email` is a reusable Django app for queuing the sending of email with [Django Q][].

Installation

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

Install the latest version with pip:

```bash

$ pip install django-q-email

```

Then in `settings.py`:

```python

EMAIL_BACKEND = 'django_q_email.backends.DjangoQBackend'

```

Then send email in the normal way, as per the [Django email docs](https://docs.djangoproject.com/en/1.10/topics/email/),

and they will be sent in a background task. See Django Q for more information](https://github.com/Koed00/django-q).

Configuration

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

`DJANGO_Q_EMAIL_BACKEND` - Backend used in the background task (default: `django.core.mail.backends.smtp.EmailBackend`)

`DJANGO_Q_EMAIL_USE_DICTS` - Store Python dictionaries instead of pickled `EmailMessage` and `EmailMultiAlternatives` (default: `True`)

`DJANGO_Q_EMAIL_ERROR_HANDLER` - Optional function to be called if sending fails (called as `DJANGO_Q_EMAIL_ERROR_HANDLER(email_message, exception)`)

Requirements

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

- [Django](https://www.djangoproject.com/) >= 1.8

- [Django Q](https://github.com/Koed00/django-q)

Contributing

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

1. Check the open issues or open a new issue to start a discussion around

   your feature idea or the bug you found

2. Fork the repository and make your changes

3. Create a new pull request

[pypi]: http://pypi.python.org/pypi/django-q-email/

[django q]: https://github.com/Koed00/django-q