Skip to main content

Subscribe Mailgun mailing lists from Django

Project description

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
    

Project details


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_mgsub-0.1.6-py2-none-any.whl (13.3 kB) Copy SHA256 hash SHA256 Wheel py2 Jul 9, 2015
django_mgsub-0.1.6-py3-none-any.whl (13.4 kB) Copy SHA256 hash SHA256 Wheel py3 Jul 9, 2015
django-mgsub-0.1.6.tar.gz (21.9 kB) Copy SHA256 hash SHA256 Source None Jul 9, 2015

Supported by

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