Skip to main content
Help us improve Python packaging – donate today!

Add unsubscribe link to your emails painlessly.

Project Description

https://badge.fury.io/py/django-unsubscribe.svg?fix https://travis-ci.org/theskumar/django-unsubscribe.svg?branch=master

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

History

0.1.1 (14/04/2014)

  • add support for django 1.5,1.6 and 1.7
  • add support for python 3
  • fix missing template

0.1.0 (22/02/2014)

  • First release on PyPI.

Release history Release notifications

This version
History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-unsubscribe-0.1.2.tar.gz (8.2 kB) Copy SHA256 hash SHA256 Source None Oct 8, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page