
flanker
用于邮件解析的开源 Python 库
通过开源免费 Python API 解析电子邮件地址、验证地址并解析 MIME 消息。
什么是 flanker?
flanker 是由 Mailgun 开发的开源 Python 库,用于解析电子邮件地址和 MIME 消息。它提供了强大的工具来验证电子邮件地址、解析复杂的地址列表以及从 MIME 消息中提取结构化数据。该库面向生产使用,支持 Python 2.7 和 Python 3.6 以上,使其非常适合构建邮件密集型应用程序,如邮件处理流水线、CRM 集成和通知系统的开发者。
该库由两个核心模块组成:`flanker.addresslib` 用于解析和验证电子邮件地址,`flanker.mime` 用于解析 MIME 消息。它支持严格和宽松的解析模式、DNS/MX 记录验证以及详细的错误报告。凭借简洁的 API 和最小的依赖,flanker 使开发者能够可靠地处理电子邮件数据,而无需依赖外部二进制文件或复杂的依赖项。它在 Mailgun 基础设施中的广泛使用确保了在高流量环境下的稳定性和性能。
开始使用 flanker
要开始使用 flanker,您需要先安装 Python 头文件。在 Ubuntu 上,运行 `sudo apt-get install python-dev`;在 Fedora 上,使用 `sudo yum install python-devel`。然后通过 pip 安装:`pip install flanker`。或者,克隆 [flanker GitHub](https://github.com/mailgun/flanker) 仓库并运行 `pip install -e .`。该库轻量级,依赖最少,已准备好用于生产环境。详细文档和 API 参考可在项目的 GitHub 仓库中获取。
通过 PIP 或 GitHub 安装 flanker
# Ubuntu: install Python headers
sudo apt-get install python-dev
# Install via pip
pip install flanker
# Or clone and install from GitHub
git clone git@github.com:mailgun/flanker.git
cd flanker
pip install -e .
解析并验证电子邮件地址
flanker 提供强大的工具用于解析和验证电子邮件地址。您可以解析带显示名称的单个地址,验证 DNS/MX 记录,并检查 ESP 语法规则。该库支持严格和宽松的解析模式,并且可以返回解析后的地址或对无效输入返回 `None`。它还处理地址列表,分别返回已解析的地址和无法解析的片段。这使其非常适合清理用户输入、验证批量导入以及确保电子邮件驱动工作流中的数据完整性。
如何使用 Python 解析并验证电子邮件地址?
from flanker.addresslib import address
# Parse single address with display name
addr = address.parse('John Doe <john@example.com>')
print(addr) # John Doe <john@example.com>
# Validate with DNS/MX checks
valid = address.validate_address('john@mailgun.com')
print(valid) # john@mailgun.com
# Parse list and separate valid/unparseable
parsed, failed = address.parse_list(['john@example.com, @invalid'], as_tuple=True)
print(parsed, failed) # [john@example.com], ['@invalid']
解析 MIME 消息
flanker 的 MIME 解析模块(`flanker.mime`)使开发者能够将原始电子邮件消息解析为结构化的 Python 对象。您可以轻松提取标题、解码正文、检测内容类型,并浏览 multipart 结构。该库自动处理编码、字符集转换以及嵌套的 MIME 部分。使用诸如 `is_multipart()` 和 `is_singlepart()` 之类的谓词,您可以以编程方式检查消息结构并相应地处理每个部分——非常适合构建电子邮件客户端、归档系统或自动化处理流水线。
如何解析 MIME 消息并提取邮件头和正文?
from flanker import mime
# Parse raw MIME message
msg = mime.from_string(raw_message)
# Extract headers
headers = msg.headers.items()
# Check content type
is_multipart = msg.content_type.is_multipart()
# Decode body (handles multipart automatically)
for part in msg.parts:
print(f"Content-Type: {part.content_type}")
print(f"Body: {part.body}")
提取邮件头和元数据
flanker 通过其 MIME 解析 API 提供对电子邮件标题和元数据的丰富访问。标题以 Unicode 多值字典的形式返回,支持不区分大小写的查找和结构化的值(例如,将 `Content-Type` 解析为类型和参数)。您可以轻松检索发件人、收件人、主题、日期以及自定义标题。这在电子邮件索引、垃圾邮件过滤、合规审计以及构建可搜索的电子邮件归档时尤为有用,因为精确的标题解析至关重要。
如何通过 Python 提取电子邮件标题和元数据?
from flanker import mime
msg = mime.from_string(raw_message)
# Get all headers as list of tuples
for key, value in msg.headers.items():
print(f"{key}: {value}")
# Access structured content-type
ctype = msg.content_type
print(f"Type: {ctype.type}, Boundary: {ctype.boundary}")
# Get raw header value
raw_from = msg.headers.get('From')
print(raw_from) # Bob <bob@example.com>
处理多部分消息和附件
flanker 简化了处理复杂的多部分消息的工作,包括包含嵌套部分和附件的情况。您可以遍历 `msg.parts` 来访问每个 MIME 部分,检查其内容类型,并解码其正文。该库会自动处理 base64 和 quoted-printable 解码、字符集转换以及边界检测。这使得提取 text/plain 和 text/html 版本、保存附件或重建用于转发或归档的消息变得直截了当——非常适合电子邮件客户端、备份工具和合规系统。
如何处理多部分消息并提取附件?
from flanker import mime
msg = mime.from_string(raw_message)
# Iterate over parts
for part in msg.parts:
if part.content_type.is_text():
print(f"Text part: {part.body}")
elif part.content_type.is_attachment():
filename = part.content_type.filename
payload = part.body
print(f"Attachment: {filename}, size: {len(payload)}")
