Skip to content

ferrix/django-mgsub

Repository files navigation

Mailgun list subscription for Django

https://travis-ci.org/ferrix/django-mgsub.svg?branch=master https://coveralls.io/repos/github/ferrix/django-mgsub/badge.svg?branch=master

This Django module provides a FormView and a Form that subscribe the user to a list on Mailgun.

Usage

  1. Install:

    pip install django-mgsub
    pip freeze | grep django-mgsub >> requirements.txt
    
  2. Add to Django:

    # settings.py
    INSTALLED_APPS += 'mgsub',
    
  3. Configure credentials:

    # settings.py
    MGSUB_DEFAULT_MAILINGLIST = 'mylist@example.com'
    MAILGUN_API_KEY = '<secret>'
    

    or:

    export MGSUB_DEFAULT_MAILINGLIST='mylist@example.com' MAILGUN_API_KEY=...
    
  4. Add urls:

    # urls.py
    urlpatterns = [
      ...
        url('^mailinglist/', include('mgsub.urls', namespace='mgsub')),
      ...
    ]
    
  5. Configure:

    ## settings.py
    
    # Setting this to False will disable email sending and the following
    # settings
    MGSUB_SEND_WELCOME = True
    
    MGSUB_WELCOME_FROM = 'noreply@example.com'    # defaults to settings.SERVER_EMAIL
    MGSUB_WELCOME_REPLY_TO = 'me@example.com'     # nothing by default
    
    # Subscription email templates
    MGSUB_WELCOME_SUBJECT = 'Welcome to my list!' # Defaults to: Welcome!
    MGSUB_WELCOME_TEMPLATE = 'myapp/welcome.html' # HTML template
    MGSUB_WELCOME_TEMPLATE_PLAIN = 'myapp/w.txt'  # Plain text template
    

About

Mailgun list subscription for Django

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •