Mailgun的出站扩展
项目描述
outgoing-mailgun 是 outgoing 的扩展,它增加了通过 Mailgun 发送电子邮件的能力。只需将 outgoing-mailgun 与 outgoing 一起安装,您就可以在 outgoing 配置中指定“mailgun”作为发送方法。
安装
outgoing-mailgun 需要 Python 3.7 或更高版本。只需使用 Python 3 的 pip 安装 outgoing-mailgun 及其依赖项(包括 outgoing)
python3 -m pip install outgoing-mailgun
配置
当在出站配置中使用“mailgun”作为发送方式时,以下配置字段被识别
- base-urlHTTP URL(可选)
用于Mailgun API请求的基础URL。这应该是位于Mailgun美国区域的域的“https://api.mailgun.net”(默认值)或位于Mailgun欧盟区域的域的“https://api.eu.mailgun.net”。URL结尾的反斜杠是可选的。
- domain字符串(必需)
您在Mailgun注册以发送电子邮件的域名
- api-key密码(必需)
用于您域的Mailgun API密钥;有关编写此字段的方式,请参阅“outgoing”文档中的密码部分。
当使用密钥环密码方案或其他包含可选主机/服务用户字段方案时,如果未在密码指定中提供服务/和/或用户名,则默认服务为base-url字段的主机名,默认用户名为domain字段的值。
- tags字符串列表(可选)
应用于已发送电子邮件的标签集
- deliverytime日期时间(可选)
期望发送电子邮件的交付时间;如果没有提供时区偏移量,则假定它在本地系统时区
- dkim布尔值(可选)
启用/禁用发送电子邮件上的DKIM签名
- testmode布尔值(可选)
是否以测试模式发送
- tracking布尔值(可选)
是否启用消息跟踪
- tracking-clicks布尔值或“htmlonly”(可选)
是否在电子邮件中启用点击跟踪
- tracking-opens布尔值(可选)
是否在电子邮件中启用打开跟踪
- headers字符串值的表(可选)
要附加到发送电子邮件的定制MIME头集合
- variables字符串值的表(可选)
要附加到发送电子邮件的Mailgun变量集合
示例配置
[outgoing]
method = "mailgun"
domain = "mydomain.nil"
api-key = { file = "~/secrets/mailgun.key" }
dkim = true
tags = [ "sent-with-outgoing", "my-campaign" ]
tracking-clicks = "htmlonly"
headers = { Reply-To = "me@mydomain.nil" }
variables = { sender = "outgoing", foo = "bar" }
发送者特定行为
此扩展提供的MailgunSender类是一个可重入和可重用的上下文管理器,并且其send()方法可以在上下文之外调用。此外,在成功时,send()方法返回新发送电子邮件的消息ID(不带尖括号)。