Giter Club home page Giter Club logo

django-unsubscribe's Introduction

Django Unsubscribe

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

django-unsubscribe's People

Contributors

mukgupta avatar theskumar avatar tvorog avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.