https://github.com/theskumar/django-unsubscribe
Add unsubscribe link to your emails painlessly.
https://github.com/theskumar/django-unsubscribe
Last synced: about 1 year ago
JSON representation
Add unsubscribe link to your emails painlessly.
- Host: GitHub
- URL: https://github.com/theskumar/django-unsubscribe
- Owner: theskumar
- License: bsd-3-clause
- Archived: true
- Created: 2014-02-13T06:26:41.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2016-10-16T07:29:59.000Z (over 9 years ago)
- Last Synced: 2025-03-07T09:19:57.183Z (over 1 year ago)
- Language: Python
- Size: 364 KB
- Stars: 23
- Watchers: 5
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- License: LICENSE
Awesome Lists containing this project
README
===============================
Django Unsubscribe
===============================
.. image:: https://badge.fury.io/py/django-unsubscribe.svg?fix
:target: http://badge.fury.io/py/django-unsubscribe
.. image:: https://travis-ci.org/theskumar/django-unsubscribe.svg?branch=master
:target: https://travis-ci.org/theskumar/django-unsubscribe
Easily send one-click un-subscribable emails from django to keep your customers happy.
Features
--------
* Adds `List-Unsubscribe` header to the email.
* Adds a context variable `unsubscribe_url` which can be used to render emails.
* Provides signals to implement the actual unsubscribe logic.
Requirements
------------
* Python (2.7, 3.2, 3.3, 3.4)
* Django (1.4, 1.5, 1.6, 1.7)
Quickstart
----------
Install Django Unsubscribe:
pip install django-unsubscribe
Add `unsubscribe` to your `INSTALLED_APPS` settings.
from unsubscribe import UnsubscribableEmailMessage
# rest of your code
Add a signal listner for `user_unsubscribe` in your code that contains the logic to unsubsribe a user from the mailing list.
That's it!
Overview
--------
This application is supposed to help at improving the overall quality of the
mass e-mails your site sends out by:
1. Creating a simple subclass of `django.core.mail.EmailMultiAlternatives`, which adds a `List-Unsubscribe` header to the email message and a `render_message` function that is a wrapper to `render_to_string` to add `unsubscribe_url` to the context.
2. Providing a replaceable `urlconf` and `view`, which provides a unique url for each user wishing to unsubscribe.
This application does not:
1. Compose, create or mail newsletter e-mails for you. That is up to you.
2. Actually unsubscribe members from your mailing lists. It provides a signal, `unsubscribe.signals.user_unsubscribe`, which you must hook on to to unsubscribe your users.
Contributing
------------
Please send pull request or open a issue.
License
-------
BSD