MarkdownMail

目的

发送包含生成HTML内容的电子邮件。

内容必须使用Markdown语法编写。电子邮件的文本部分将按原样填充；HTML部分将是Markdown内容的转换HTML。

安装

$ pip install markdownmail

基本用法

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')

内容必须是Unicode。

更多信息

可以添加附加信息

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
)

cc_addr 和 bcc_addr 是可选的。参数 from_addr、to_addr、cc_addr 和 bcc_addr 与 Enveloppe 库相同。

更改 SMTP 端口

email.send("example.org", port=3325)

更改 SMTP 登录名和密码

email.send("example.org", login="user", password="password")

使用 TLS

email.send("example.org", tls=True)

样式

电子邮件会自动添加一个默认的 CSS，包括无衬线字体和一些小改进。

要覆盖默认 CSS，请将包含样式的字符串传递给 MardownMail 的 css 可选参数。

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;"
)

运行测试

在执行测试之前，Tox 会自动安装在 virtualenvs 中。使用以下命令执行它们：

$ python setup.py test

禁用测试中的电子邮件发送

如果传递给 send() 方法的参数是 NullServer 的实例，则不会发送电子邮件。

email = markdownmail.MarkdownMail(
    #params
)

email.send(markdownmail.NullServer())

在测试中断言电子邮件

通过子类化 NullServer，可以在 check() 方法中提供自定义行为。

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

email.send(MyServer())

有用的链接

Envelopes 库（MardownMail 是 Envelopes 库的包装器）。

Markdown 语法