🎥 作者简介： CSDN\阿里云\腾讯云\华为云开发社区优质创作者，专注分享大数据、Python、数据库、人工智能等领域的优质内容
🌸个人主页： 长风清留杨的博客
🍃形式准则： 无论成就大小，都保持一颗谦逊的心，尊重他人，虚心学习。
✨推荐专栏： Python入门到入魔，Mysql入门到入魔，Python入门基础大全，Flink入门到实战
🍂若缘分至此，无法再续相逢，愿你朝朝暮暮，皆有安好，晨曦微露道早安，日中炽热说午安，星河长明寄晚安🍂

在Python编程中，发送电子邮件是一个常见的需求，无论是用于自动化报告、用户通知还是简单的信息交换。yagmail库以其简洁的API和强大的功能，成为了众多开发者发送邮件的首选工具。

一、yagmail简介

1.1 什么是yagmail？

yagmail是一个Python库，旨在简化通过SMTP协议发送电子邮件的过程。它封装了底层的SMTP连接细节，提供了直观的接口，让开发者能够以最少的代码实现邮件发送功能。

1.2 主要特点

易用性：极简的API设计，几行代码即可发送邮件。
安全性：支持SSL/TLS加密，保护邮件数据。
附件支持：轻松附加文件，包括图片、PDF等。
HTML邮件：支持HTML格式的邮件内容，提升邮件表现力。
多收件人：支持单个或多个收件人，以及CC（抄送）和BCC（密送）。

1.3 关键参数

参数名称	描述	示例值
user	发送邮件的邮箱账号	'your_email@qq.com'
password	邮箱的登录密码或授权码（注意：不建议在代码中硬编码密码，建议使用环境变量或配置文件存储）	'your_password_or_auth_code'
host	SMTP服务器地址，根据邮箱服务提供商不同而有所差异（例如QQ邮箱为’smtp.qq.com’）	'smtp.qq.com'
port	SMTP服务器端口，默认为25，但出于安全考虑，常使用加密端口如465或587	465 或 587
ssl	是否使用SSL加密连接，通常与端口465配合使用	True/False
starttls	是否启用STARTTLS加密（对于支持STARTTLS的服务器），通常与端口587配合使用	True/False
to	收件人的邮箱地址，可以是一个字符串或字符串列表（支持多个收件人）	'recipient@example.com' 或 ['recipient1@example.com', 'recipient2@example.com']
subject	邮件的主题	'邮件主题'
contents	邮件的正文内容，可以是字符串、HTML或包含附件的列表	'邮件内容' 或 '<h1>HTML邮件</h1>' 或 ['正文1', '正文2']（当为列表时，通常用于多部分邮件）
attachments	附件的路径，可以是一个字符串或路径列表（支持多个附件）	'/path/to/attachment.txt' 或 ['/path/to/attachment1.txt', '/path/to/attachment2.pdf']
cc	抄送邮件的地址列表，将邮件同时发送给收件人以外的人	['cc_recipient1@example.com', 'cc_recipient2@example.com']
bcc	密送邮件的地址列表，与抄送不同的是收件人看不到其他人的邮箱地址	['bcc_recipient1@example.com', 'bcc_recipient2@example.com']
headers	自定义邮件头部信息，传递字典参数	{'Reply-To': 'noreply@example.com', 'X-Priority': '1'}
preview_only	布尔型，表示仅预览邮件而不实际发送，可以用于测试邮件内容是否正确	True/False
from_	指定发件人的邮箱地址（注意：下划线是参数名的一部分，不是拼写错误）	'another_email@example.com'（用于伪装发件人地址，但需注意邮件服务提供商的政策）
debug	是否开启调试模式，输出更多日志信息，有助于排查邮件发送过程中的问题	True/False

二、安装yagmail

2.1 安装方法

yagmail可以通过Python的包管理工具pip进行安装。在命令行中运行以下命令：

pip install yagmail

2.2 依赖项

yagmail依赖于smtplib（Python标准库的一部分）和requests库来处理HTTP请求（主要用于验证某些邮件服务）。

三、基本用法

3.1 配置SMTP服务器

在发送邮件之前，您需要配置SMTP服务器的信息，包括服务器地址、端口、用户名和密码。

3.2 发送简单文本邮件

以下是一个发送简单文本邮件的示例：

import yagmail# 连接到SMTP服务器
yag = yagmail.SMTP('your_email@example.com', 'your_password')# 发送邮件
yag.send('recipient@example.com', 'Subject', 'This is the body of the email.')

3.3 发送HTML邮件

yagmail同样支持发送HTML格式的邮件：

# 发送HTML邮件
yag.send('recipient@example.com', 'Subject', contents=['<h1>Hello World!</h1>'])

四、高级功能

4.1 添加附件

yagmail允许您轻松添加附件：

# 发送带有附件的邮件
yag.send('recipient@example.com', 'Subject', 'Here is your report.', attachments=['path/to/report.pdf'])

4.2 多收件人处理

您可以同时向多个收件人发送邮件，也可以设置抄送和密送：

# 多收件人
recipients = ['user1@example.com', 'user2@example.com']
yag.send(recipients, 'Subject', 'Message for multiple recipients.')# 抄送和密送
yag.send('user1@example.com', 'Subject', 'Message', cc=['user2@example.com'], bcc=['user3@example.com'])

4.3 自定义邮件头

您可以自定义邮件头信息，如回复地址、优先级等：

# 自定义邮件头
yag.send('recipient@example.com', 'Subject', 'Message', headers={'Reply-To': 'noreply@example.com', 'X-Priority': '1'})

五、错误处理与调试

5.1 常见错误

• 认证失败：检查用户名和密码是否正确。
• SMTP连接错误：确认SMTP服务器地址和端口无误，且服务器允许您的IP地址连接。
• 附件发送失败：确保附件路径正确，且文件可读。

5.2 调试技巧

• 开启调试模式：通过yagmail.SMTP的debug参数开启调试模式，获取更多发送过程中的日志信息。
• 检查邮件日志：查看邮件服务器的日志，了解邮件是否被成功接收或被拒绝的原因。

六、最佳实践

6.1 安全性

• 环境变量：避免在代码中硬编码敏感信息，如邮箱密码，建议使用环境变量或配置文件存储。
• OAuth2认证：对于支持OAuth2的邮件服务（如Gmail），使用OAuth2令牌代替密码进行认证，提高安全性。

6.2 性能优化

• 批量发送：如果需要发送大量邮件，考虑使用批量发送功能或分批发送，以减少服务器压力。
• 异步处理：对于实时性要求不高的邮件发送任务，可以使用异步编程模型，提高程序响应速度。

七、实例演示：发送带附件的HTML邮件

7.1 代码示例

import yagmail# 连接到SMTP服务器
yag = yagmail.SMTP('your_email@example.com', 'your_password')# 邮件内容
subject = 'Monthly Report'
body = '''
<h1>Monthly Sales Report</h1>
<p>Please find the attached report for the month of October.</p>
'''
attachments = ['/path/to/report.xlsx']# 发送邮件
yag.send('recipient@example.com', subject, body, attachments=attachments)

7.2 关键点总结

• SMTP配置：正确配置SMTP服务器信息。
• 邮件格式：使用HTML格式增强邮件可读性。
• 附件处理：确保附件路径正确，且文件类型支持。

八、总结

yagmail以其简洁的API和丰富的功能，为Python开发者提供了一个高效、安全的邮件发送解决方案。无论是简单的文本邮件，还是复杂的HTML邮件加附件，yagmail都能轻松应对。