python-postmark 库技术文档

1. 安装指南

首先，确保您的环境中安装了pip。然后，在命令行中运行以下命令来安装python-postmark库：

pip install python-postmark

2. 项目的使用说明

该库为Postmark服务提供了一个Python接口，允许用户发送邮件、管理邮件模板以及处理邮件退回。以下是一些基本的使用示例：

发送邮件

from postmark import PMMail

mail = PMMail(to='[e-mail]', subject='Test Email', text_body='This is a test email')
mail.send()

使用 Django

若要在Django项目中使用python-postmark，需要将以下设置添加到settings.py文件中：

POSTMARK_API_KEY = 'your-key'
POSTMARK_SENDER = '[e-mail]'
POSTMARK_TEST_MODE = True  # 或 False
POSTMARK_TRACK_OPENS = True  # 或 False
POSTMARK_RETURN_MESSAGE_ID = True  # 或 False
EMAIL_BACKEND = 'postmark.django_backend.EmailBackend'

使用 Tornado

对于Tornado框架，python-postmark提供了Mixin支持。以下是一个使用示例：

import tornado.web
import tornado.options
from postmark.tornado_mixin import PostmarkMixin

tornado.options.define('postmark_signature', 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
tornado.options.define('postmark_sendemail', '[e-mail]')

class EmailHandler(tornado.web.RequestHandler, PostmarkMixin):
    def post(self):
        to = '[e-mail]'
        body = 'This is test message'
        subject = 'Test Message'
        self.send_email(body=body, to=to, subject=subject)

3. 项目API使用文档

以下是项目中一些关键类的API使用文档：

PMMail

PMMail是用于发送邮件的主要类。

• to: 接收者邮箱地址
• subject: 邮件主题
• text_body: 邮件文本内容
• html_body: 邮件HTML内容

发送邮件：

mail = PMMail(to='[e-mail]', subject='Subject', text_body='Text content')
mail.send()

PMBatchMail

用于发送邮件的批次。

PMBounceManager

管理邮件退回。

Django email backend

用于Django的邮件后端。

4. 项目安装方式

请参考本文档的“安装指南”部分，使用pip进行安装。

---

本文档详细介绍了python-postmark库的安装和使用方法，旨在帮助用户更好地利用该库提供的功能。