Git Product home page Git Product logo

bambu-mail's Introduction

Bambu Mail

A shortcut function for sending template-based emails in HTML and plain-text format, and subscribing users to newsletters

About Bambu Mail

This package allows for the quick and simple sending of emails in both plain-text and HTML format, without needing to specify both. A base HTML template is supplied which can be overridden. Markdown is the expected format for the email body, which means it gets transformed into HTML but left alone for the text-only version.

In addition, Bambu Mail has a simple provider system for newsletter subscriptions, allowing new signups to be automatically added to a mailing list (should they choose to). The only current provider in this package is for Mailchimp, but the base type is easily extensible.

Finally, Bambu Mail provides a Postmark email backend, based on the django-postmark but with a slight bug fix.

About Bambu Tools 2.0

This is part of a toolset called Bambu Tools. It's being moved from a namespace of bambu to its own 'root-level' package, along with all the other tools in the set. If you're upgrading from a version prior to 2.0, please make sure to update your code to use bambu_mail rather than bambu.mail.

Installation

Install the package via Pip:

pip install bambu-mail

Add it to your INSTALLED_APPS list along with Bambu Markup:

INSTALLED_APPS = (
    ...
    'bambu_mail',
    'bambu_markup'
)

Add bambu_mail.urls to your URLconf:

urlpatterns = patterns('',
    ...
    url(r'^mail/', include('bambu_mail.urls')),
)

Todo

  • Prepare for internationalisation
  • Write more tests

Documentation

Full documentation can be found at ReadTheDocs.

Questions or suggestions?

Find me on Twitter (@iamsteadman) or visit my blog.

bambu-mail's People

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.