Flask-Mail邮件发送教程

介绍Flask-Mail

Flask-Mail是Flask的一个官方扩展，用于在Flask应用中发送电子邮件。它封装了SMTP和其他邮件发送协议，简化了邮件发送过程，支持多种邮件后端。使用Flask-Mail，您可以轻松集成邮件功能到Web应用中，如发送用户注册确认、密码重置或通知邮件。

安装Flask-Mail

在开始之前，需要安装Flask-Mail扩展。可以使用pip进行安装：

pip install Flask-Mail

确保您的Flask应用已安装，如果需要，先安装Flask：pip install Flask。

配置SMTP服务器

Flask-Mail需要SMTP服务器来发送邮件。SMTP（简单邮件传输协议）是标准邮件发送协议。您可以使用Gmail、Outlook等公共邮箱服务，或自建SMTP服务器。配置在Flask应用的设置中进行。

在Flask应用中，通常通过配置字典设置SMTP参数。例如，使用Gmail的SMTP服务器：

from flask import Flask
from flask_mail import Mail

app = Flask(__name__)

# 配置SMTP服务器参数
app.config['MAIL_SERVER'] = 'smtp.gmail.com'  # SMTP服务器地址
app.config['MAIL_PORT'] = 587  # 端口号，Gmail使用587（TLS）或465（SSL）
app.config['MAIL_USE_TLS'] = True  # 启用TLS加密，更安全；如果使用SSL，设置MAIL_USE_SSL=True
app.config['MAIL_USE_SSL'] = False  # Gmail通常用TLS，所以设为False
app.config['MAIL_USERNAME'] = 'your-email@gmail.com'  # 发件人邮箱地址
app.config['MAIL_PASSWORD'] = 'your-password'  # 邮箱密码或应用专用密码（对于启用两步验证的服务）
app.config['MAIL_DEFAULT_SENDER'] = 'your-email@gmail.com'  # 默认发件人，可选

# 初始化Flask-Mail扩展
mail = Mail(app)

重要提示：对于Gmail等邮箱服务，如果启用了两步验证，不能直接使用普通密码，需要生成应用专用密码。此外，确保允许“安全性较低的应用程序访问”，但出于安全考虑，建议使用应用专用密码或OAuth。

您也可以使用环境变量来存储敏感信息，提高安全性：

import os
app.config['MAIL_USERNAME'] = os.environ.get('MAIL_USERNAME')
app.config['MAIL_PASSWORD'] = os.environ.get('MAIL_PASSWORD')

发送普通邮件

普通邮件是纯文本邮件，适用于简单通知。使用Flask-Mail的Message类创建邮件对象，设置收件人、主题和内容。

from flask_mail import Message

# 创建一个邮件对象
msg = Message('测试邮件主题', recipients=['recipient@example.com'])
msg.body = '这是一封普通邮件的内容。你好！感谢使用Flask-Mail。'

# 发送邮件
mail.send(msg)
print('普通邮件发送成功')

在Flask视图函数中，可以这样集成：

@app.route('/send-plain-mail')
def send_plain_mail():
    msg = Message('欢迎邮件', recipients=['user@example.com'])
    msg.body = '欢迎来到我们的网站！'
    try:
        mail.send(msg)
        return '普通邮件已发送'
    except Exception as e:
        return f'发送失败: {e}'

发送HTML邮件

HTML邮件允许发送带有格式、链接和图片的内容，提供更好的用户体验。Flask-Mail支持同时发送纯文本和HTML版本，确保兼容性。

msg = Message('HTML邮件示例', recipients=['recipient@example.com'])
msg.body = '这是纯文本版本，用于不支持HTML的邮件客户端。'
msg.html = '<h1>Hello!</h1><p>这是一封<strong>HTML邮件</strong>，您可以添加样式和链接，例如<a href="https://example.com">访问网站</a>。</p>'

mail.send(msg)
print('HTML邮件发送成功')

您可以创建更复杂的HTML内容，但确保纯文本版本是可读的，因为某些邮件客户端可能只显示文本。

邮件发送异常处理

邮件发送可能失败，原因包括网络问题、SMTP服务器错误或配置问题。为了提高应用的健壮性，需要处理异常。使用try-except块捕获错误，并采取相应措施。

from flask_mail import Message

msg = Message('重要通知', recipients=['recipient@example.com'])
msg.body = '请查看附件。'

try:
    mail.send(msg)
    print('邮件发送成功')
    # 可以在数据库中记录发送状态或通知用户
    
except Exception as e:
    print(f'邮件发送失败: {e}')
    # 可以记录错误日志、重试发送或通知管理员
    # 例如：logging.error(f'邮件发送失败: {e}')
    # 或添加重试逻辑：重试几次后放弃

为了更健壮，可以考虑使用异步任务队列（如Celery）发送邮件，避免阻塞Web请求。或使用重试机制：

import time

def send_email_with_retry(msg, retries=3):
    for attempt in range(retries):
        try:
            mail.send(msg)
            return True
        except Exception as e:
            print(f'尝试 {attempt + 1} 失败: {e}')
            time.sleep(2)  # 等待2秒后重试
    return False  # 所有重试失败

完整示例代码

以下是一个完整的Flask应用示例，集成所有功能：

from flask import Flask
from flask_mail import Mail, Message

app = Flask(__name__)

# 配置Flask-Mail
app.config.update(
    MAIL_SERVER='smtp.gmail.com',
    MAIL_PORT=587,
    MAIL_USE_TLS=True,
    MAIL_USERNAME='your-email@gmail.com',  # 替换为您的邮箱
    MAIL_PASSWORD='your-password',  # 替换为您的密码或应用专用密码
    MAIL_DEFAULT_SENDER='your-email@gmail.com'
)

mail = Mail(app)

@app.route('/')
def index():
    return '欢迎访问邮件发送示例应用！访问 /send-mail 发送测试邮件。'

@app.route('/send-mail')
def send_mail():
    # 创建邮件对象
    msg = Message('Flask-Mail测试邮件', recipients=['recipient@example.com'])  # 替换为收件人邮箱
    msg.body = '这是一封测试邮件的纯文本内容。'
    msg.html = '<h1>HTML版本</h1><p>这是<b>加粗</b>的HTML内容。</p>'
    
    try:
        mail.send(msg)
        return '邮件发送成功！'
    except Exception as e:
        return f'邮件发送失败，错误: {e}'

if __name__ == '__main__':
    app.run(debug=True)

进阶内容

Flask-Mail还支持其他功能，如：

• 附件发送：使用msg.attach方法添加附件。
• 批量发送：通过循环或使用邮件列表发送多封邮件。
• 使用模板：结合Jinja2模板生成动态邮件内容。
• 自定义邮件后端：支持Sendmail或其他后端。

例如，发送带附件的邮件：

from flask_mail import Message
import os

msg = Message('带附件的邮件', recipients=['recipient@example.com'])
msg.body = '请查收附件。'

# 添加附件
with open('path/to/file.pdf', 'rb') as f:
    msg.attach('file.pdf', 'application/pdf', f.read())

mail.send(msg)

总结

Flask-Mail是一个强大的Flask扩展，简化了邮件发送过程。通过本教程，您学会了：

1. 安装和配置Flask-Mail，设置SMTP服务器。
2. 发送普通和HTML邮件。
3. 处理邮件发送异常，确保应用稳定性。

实践中，建议将敏感信息存储在环境变量中，并考虑使用异步发送来提高性能。Flask-Mail的文档提供了更多高级功能，您可以根据需求进一步探索。

祝您在Flask开发中顺利集成邮件功能！