Skip to main content

E-mail with text and html content provided with markdown

Project description

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.

E-mail rendering for the user (HTML part)

Install

$ pip install markdownmail

Basic Usage

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.org',
    to_addr=u'bob@example.org',
    subject=u'MarkdownMail demo',
    content=CONTENT
)

email.send('localhost')

Content must be unicode.

More infos

Additional informations are addable:

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

The from_addr and to_addr parameters are the same as Enveloppe library.

Style

A default CSS is automatically added to the e-mail. It includes a font sans serif and minor improvements.

To override the default CSS, pass a string including the style to the css optional parameter of MardownMail:

import markdownmail

email = markdownmail.MarkdownMail(
    from_addr=u'alice@example.org',
    to_addr=u'bob@example.org',
    subject=u'MarkdownMail demo',
    content="CONTENT",
    css="font-family:monospace; color:green;"
)

Run tests

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

$ python setup.py test

Disable sending e-mails in your tests

The e-mail is not send if the parameter passed to send() method is an instance of NullServer.

email = markdownmail.MarkdownMail(
    #params
)

email.send(markdownmail.NullServer())

Assert about e-mails in your tests

Subclassing NullServer allows to provide a custom behaviour in the check() method:

class MyServer(markdownmail.NullServer):
    def check(self, email):
        assert u'bob@example.org' == email.to_addr[0]

email.send(MyServer())

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.6.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

markdownmail-0.6.0-py2.py3-none-any.whl (8.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file markdownmail-0.6.0.tar.gz.

File metadata

  • Download URL: markdownmail-0.6.0.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2+

File hashes

Hashes for markdownmail-0.6.0.tar.gz
Algorithm Hash digest
SHA256 edf3ba412fb894bb24e62880efcb44d88674dfb15e719fff0fb7c8bf1c7f076b
MD5 c8dff573efa5d7d2eef035294b072155
BLAKE2b-256 270e6a0a02540b2567779e99dabe3e61e6485176cd250cd7e07c4719375029e9

See more details on using hashes here.

File details

Details for the file markdownmail-0.6.0-py2.py3-none-any.whl.

File metadata

  • Download URL: markdownmail-0.6.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2+

File hashes

Hashes for markdownmail-0.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 59391aeeecc8f5e035b08aaf847a4155a25fae046358cdc0686136e56db9d6e4
MD5 e2da229f1463f4780c8cf928c2bd395d
BLAKE2b-256 cdac972546ca7dfbeff5190333c9740cfd7540bdb4a9b1a33fc4790cf33ea83d

See more details on using hashes here.

Supported by

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