Skip to main content

E-mail with text and html content provided with markdown

Project description

MarkdownMail
============

Purpose
-------

Send e-mails with generated html content.

The content has to be written in Markdown syntax. The text part of the e-mail
will be filled verbatim; the html part will be a converted HTML from the
Markdown content.

Install
-------

``$ pip install markdownmail``


Basic Usage
-----------

.. code:: python

import markdownmail

CONTENT = u"""
SPAMS AND EGGS
==============

This is a demo with a list:

1. Spam
2. Second spam
3. ...and eggs
"""

email = markdownmail.MarkdownMail(
from_addr=(u'alice@example.com', u'Alice'),
to_addr=(u'bob@example.com', u'Bob'),
subject=u'MarkdownMail demo',
content=CONTENT
)

email.send('localhost')


Content must be unicode.


Run tests
---------

Tox is automatically installed in virtualenvs before executing the tests.
Execute them with:

``$ python setup.py test``


Disable markdownmail in your tests
----------------------------------

If an instance of NullServer is passed to send() method, the e-mail is not send:

.. code:: python
email = markdownmail.MarkdownMail(
#params
)

email.send(markdownmail.NullServer())


Subclassing NullServer allows to provide a custom behaviour for the send()
method.


Useful links
------------

Envelopes library: https://pypi.python.org/pypi/Envelopes/0.4

Markdown syntax: https://daringfireball.net/projects/markdown/syntax




Project details


Download files

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

Source Distribution

markdownmail-0.4.0.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

markdownmail-0.4.0-py2.py3-none-any.whl (8.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page