Metadata-Version: 2.1
Name: django-ses-plus
Version: 1.0.0
Summary: It's a Django module to store and send email with AWS SES.
Home-page: https://github.com/Hipo/django-ses-plus
Author: hipo
Author-email: pypi@hipolabs.com
License: Apache-2.0
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Django SES Plus

Django module to store and send email with AWS SES. It's an extension for [django-ses](https://github.com/django-ses/django-ses) package.

## Releases

You can see the releases [here](https://github.com/Hipo/django-ses-plus/releases).

## Installation

1. pip install `django-ses-plus`. 

2. Add **django_ses_plus** to the `INSTALLED_APPS` in the settings file.

3. Set up Django SES Plus email backend.

`EMAIL_BACKEND = 'django_ses_plus.backends.SESPlusBackend'`

Please refer to django-ses package [documentation](https://github.com/django-ses/django-ses) for detailed configuration of AWS SES.

4. Configure settings.

```
DJANGO_SES_PLUS_SETTINGS = {
    "SEND_EMAIL": True,  # True by default.
    "CELERY_TASK_RETRY_KWARGS": {
        'max_retries': 15, 
        'countdown': 60
    }
}
```

5. `python manage.py migrate`

6. (Optional) Add `SendEmailMixin` to your auth user model.
```
from django_ses_plus.models import SendEmailMixin

class AuthUser(SendEmailMixin,...):
    ....
    
user.send_email(subject, template_path, context, from_email=None, language=None)
# OR
from django_ses_plus.tasks import send_email
send_email.delay(subject, to_email, html_message, from_email=None, message=None, recipient_id=None)
```

## Support

Please [open an issue](https://github.com/Hipo/django-ses-plus/issues/new) for support.

## Contributing

Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a branch, add commits, and [open a pull request](https://github.com/Hipo/django-ses-plus/compare/).


