Python-Emails 开源项目教程

2025-04-17 01:16:43作者：咎竹峻Karen

1. 项目介绍

python-emails 是一个现代化的 Python 库，用于处理电子邮件。它提供了创建、发送和解析电子邮件的简单接口，并且支持多种高级特性，如DKIM签名、模板渲染、以及与 Flask 和 Django 的集成。这个库旨在简化电子邮件处理流程，同时保持代码的简洁和易用性。

2. 项目快速启动

在开始使用 python-emails 前，确保你的环境中已经安装了 Python。

# 安装 python-emails
pip install python-emails

以下是一个快速启动的示例，展示如何创建并发送一封带有附件的电子邮件：

from emails import html

# 创建邮件对象
message = html(
    html="<p>Hi!<br>Here is your receipt...</p>",
    subject="Your receipt No. 567098123",
    mail_from=("Some Store", "store@somestore.com")
)

# 添加附件
message.attach(
    data=open('bill.pdf', 'rb'),
    filename='bill.pdf'
)

# 发送邮件
response = message.send(
    to='s@lavr.me',
    smtp={
        'host': 'aspmx.l.google.com',
        'timeout': 5
    }
)

# 检查发送状态
assert response.status_code == 250

确保你已经将 's@lavr.me' 替换为实际的接收邮箱地址，并且 SMTP 配置正确。

3. 应用案例和最佳实践

发送带有DKIM签名的邮件

为了提高邮件的安全性，可以使用DKIM签名。你需要在你的DNS记录中配置DKIM记录，并在发送邮件时指定DKIM密钥。

from emails import html

message = html(
    html="Your email content here...",
    subject="Subject of the email",
    mail_from=("Your Name", "your@email.com"),
    dkim_private_key="path/to/your/private/key.pem",
    dkim_domain="yourdomain.com",
    dkim_selector="default"
)

使用模板渲染邮件内容

如果你的邮件内容是基于模板的，python-emails 可以很容易地渲染它们。

from emails import EmailMessage

template = """
<html>
  <body>
    <p>Dear {{ name }},</p>
    <p>Your order {{ order_id }} has been processed.</p>
  </body>
</html>
"""

message = EmailMessage(
    template=template,
    subject="Order Confirmation",
    mail_from=("Your Company", "orders@yourcompany.com"),
    context={'name': 'John Doe', 'order_id': '12345'}
)

4. 典型生态项目

python-emails 可以与其他开源项目配合使用，以下是一些典型的生态项目：

Flask-Emails: 用于 Flask 应用的 python-emails 集成。
Django: python-emails 可以与 Django 集成，提供强大的电子邮件功能。

以上教程介绍了 python-emails 的基础知识，希望对您开始使用这个库有所帮助。

登录后查看全文