📧 创建第一个邮件¶
这个教程将指导你创建第一个EmailWidget邮件报告。我们将从最简单的例子开始，逐步添加更多功能。
🎯 本章目标¶
- 创建基础邮件对象
- 添加文本、表格、图表等组件
- 导出HTML文件
- 将邮件发送到邮箱
🚀 第一步：最简单的邮件¶
让我们从最简单的例子开始：
Python
from email_widget import Email, TextWidget, TextType
email = Email("我的第一份报告")
# 添加欢迎文本
email.add_widget(
TextWidget()
.set_content("欢迎使用 EmailWidget! 🎉")
.set_type(TextType.TITLE_LARGE)
)
# 导出HTML文件
file_path = email.export_html("first_email.html")
print(f"邮件已生成: {file_path}")
运行这个代码，你会在当前目录下看到一个名为 first_email.html 的文件。用浏览器打开它，你将看到一个美观的邮件页面！
🎉 恭喜！
你已经成功创建了第一个EmailWidget邮件！
📝 第二步：添加更多内容¶
现在让我们添加更多内容，创建一个更完整的报告：
Python
from email_widget import Email, TextWidget, TableWidget, ProgressWidget
from email_widget.core.enums import TextType, ProgressTheme
# 创建邮件对象，并设置副标题和脚注
email = Email("📊 销售数据周报")
email.set_subtitle("2024年第3周销售情况汇总")
email.set_footer("本报告由销售团队自动生成")
# 1. 添加主标题
email.add_widget(
TextWidget()
.set_content("销售业绩概览")
.set_type(TextType.TITLE_LARGE)
)
# 2. 添加进度指标
email.add_widget(
ProgressWidget()
.set_value(85)
.set_label("本周目标完成率")
.set_theme(ProgressTheme.SUCCESS)
)
# 3. 添加数据表格
table = TableWidget()
table.set_title("🏆 销售排行榜")
table.set_headers(["销售员", "销售额", "完成率", "状态"])
table.add_row(["张三", "¥125,000", "125%", "success"])
table.add_row(["李四", "¥98,000", "98%", "warning"])
table.add_row(["王五", "¥87,000", "87%", "info"])
email.add_widget(table)
# 4. 添加总结文本
email.add_widget(
TextWidget()
.set_content("本周销售业绩整体表现良好，超额完成既定目标。")
.set_type(TextType.BODY)
)
# 导出HTML文件
file_path = email.export_html("sales_report.html")
print(f"销售报告已生成: {file_path}")
发送到邮箱¶
使用内置的 EmailSender 发送邮件(推荐)¶
最方便的方式就是直接使用 EmailWidget 自带的 EmailSender 发送邮件，只需要选择合适的 EmailSender，最后调用 send 方法传入 Email 对象即可，下面是一个简单的实例
Python
from email_widget import Email, QQEmailSender
email = Email("欢迎使用EmailWidget")
email.add_card("Python版本", "您需要Python3.10或以上才能使用EmailWidget", metadata={"Python版本": "3.10+"})
email.add_quote("EmailWidget是一个用于构建和发送HTML邮件的Python库。", "EmailWidget")
# 一行代码成功发送邮件
QQEmailSender("你的QQ邮箱", "你的QQ邮箱授权码").send(email)
下面是发送邮件后的实际效果，可以看到邮件已经成功发送，并且成功样式正常
使用 smtplib 标准库¶
这里使用标准库 smtplib 发送邮件，实际的开发过程中您也可以使用其他的邮件发送库，例如 redmail
注意
yagmail 因为自带一个处理 HTML 的过程，会处理掉 EmailWidget 的 CSS 样式，目前无法兼容，请使用除了 yagmail 以外的邮件发送库，例如 redmail
Python
from email_widget import Email, TextWidget, TableWidget, ProgressWidget
from email_widget.core.enums import TextType, ProgressTheme
import smtplib
from email.mime.text import MIMEText
from email.header import Header
# 创建邮件对象，并设置副标题和脚注
email = Email("📊 销售数据周报")
email.set_subtitle("2024年第3周销售情况汇总")
email.set_footer("本报告由销售团队自动生成")
# 1. 添加主标题
email.add_widget(
TextWidget().set_content("销售业绩概览").set_type(TextType.TITLE_LARGE)
)
# 2. 添加进度指标
email.add_widget(
ProgressWidget()
.set_value(85)
.set_label("本周目标完成率")
.set_theme(ProgressTheme.SUCCESS)
)
# 3. 添加数据表格
table = TableWidget()
table.set_title("🏆 销售排行榜")
table.set_headers(["销售员", "销售额", "完成率", "状态"])
table.add_row(["张三", "¥125,000", "125%", "success"])
table.add_row(["李四", "¥98,000", "98%", "warning"])
table.add_row(["王五", "¥87,000", "87%", "info"])
email.add_widget(table)
# 4. 添加总结文本
email.add_widget(
TextWidget()
.set_content("本周销售业绩整体表现良好，超额完成既定目标。")
.set_type(TextType.BODY)
)
# 编写HTML类型的邮件正文
# 这里不导出为文件，而是使用 export_str 直接导出为字符串
msg = MIMEText(email.export_str(), "html", "utf-8")
msg["Subject"] = Header("邮件标题", "utf-8")
msg["From"] = "你的邮箱@qq.com" # 添加发件人
msg["To"] = "你的邮箱@qq.com" # 添加收件人
# 连接发送邮件(使用QQ邮箱为例)
smtp = smtplib.SMTP_SSL("smtp.qq.com", 465)
smtp.login("你的邮箱@qq.com", "jjhbkryjybwjbjbh")
smtp.sendmail("你的邮箱@qq.com", "你的邮箱@qq.com", msg.as_string())
smtp.quit()
运行完毕之后查看邮箱即可发现邮件已经被成功发送了
同时在手机端查看也能看到漂亮的报告
使用 redmail 发送邮件¶
使用 redmail 发送邮件相对而言更加简单，但是需要安装额外的依赖
Python
from redmail import EmailSender
import os
from smtplib import SMTP_SSL
from email_widget import Email, TextWidget, TableWidget, ProgressWidget
from email_widget.core.enums import TextType, ProgressTheme
# 创建邮件对象，并设置副标题和脚注
email = Email("📊 销售数据周报")
email.set_subtitle("2024年第3周销售情况汇总")
email.set_footer("本报告由销售团队自动生成")
# 1. 添加主标题
email.add_widget(
TextWidget().set_content("销售业绩概览").set_type(TextType.TITLE_LARGE)
)
# 2. 添加进度指标
email.add_widget(
ProgressWidget()
.set_value(85)
.set_label("本周目标完成率")
.set_theme(ProgressTheme.SUCCESS)
)
# 3. 添加数据表格
table = TableWidget()
table.set_title("🏆 销售排行榜")
table.set_headers(["销售员", "销售额", "完成率", "状态"])
table.add_row(["张三", "¥125,000", "125%", "success"])
table.add_row(["李四", "¥98,000", "98%", "warning"])
table.add_row(["王五", "¥87,000", "87%", "info"])
email.add_widget(table)
# 4. 添加总结文本
email.add_widget(
TextWidget()
.set_content("本周销售业绩整体表现良好，超额完成既定目标。")
.set_type(TextType.BODY)
)
# 配置QQ邮箱发送器
email_sender = EmailSender(
host="smtp.qq.com",
port=465,
username="你的邮箱@qq.com", # 替换为你的QQ邮箱
password="授权码", # SMTP授权码
use_starttls=False,
cls_smtp=SMTP_SSL,
)
# 发送邮件
email_sender.send(
subject="HTML测试邮件",
sender="你的邮箱@qq.com", # 替换为你的QQ邮箱
receivers=["你的邮箱@qq.com"], # 替换为接收邮件的邮箱
html=email.export_str(),
)
print("邮件发送成功！")
🚀 下一步¶
现在你已经掌握了基础用法，可以继续学习：