基于Web的应用程序通常需要具有向用户/客户端发送邮件的功能。 Flask-Mail扩展使得用任何电子邮件服务器设置一个简单接口变得非常简单。
首先,Flask-Mail扩展可使用 pip
工具来安装。
pip install Flask-Mail
然后需要通过设置以下应用程序参数的值来配置Flask-Mail。
参数 | 描述 |
---|---|
MAIL_SERVER | 邮件服务器的名称/IP地址 |
MAIL_PORT | 所用服务器的端口号 |
MAIL_USE_TLS | 启用/禁用传输安全层加密 |
MAIL_USE_SSL | 启用/禁用安全套接字层加密 |
MAIL_DEBUG | 调试支持,默认是Flask应用程序的调试状态 |
MAIL_USERNAME | 发件人的用户名 |
MAIL_PASSWORD | 发件人的密码 |
MAIL_DEFAULT_SENDER | 设置默认发件人 |
MAIL_MAX_EMAILS | 设置要发送的最大邮件 |
MAIL_SUPPRESS_SEND | 如果app.testing设置为true,则发送被抑制 |
MAIL_ASCII_ATTACHMENTS | 如果设置为true,则将附加的文件名转换为ASCII |
flask-mail
模块包含以下重要类的定义。
它管理电子邮件消息的要求。 类构造函数采用以下形式
方法 | 描述 |
---|---|
send() | 发送Message类对象的内容 |
connect() | 与邮件主机打开连接 |
send_message() | 发送消息对象 |
它封装了一封电子邮件,Message
类的构造函数有几个参数
flask-mail.Message(subject, recipients, body, html, sender, cc, bcc,
reply-to, date, charset, extra_headers, mail_options, rcpt_options)
attach()
- 向消息添加附件。 该方法采用以下参数 -
filename
- 要附加的文件的名称content_type
- 文件的MIME类型data
- 原始文件数据disposition
- 内容处置,如果有的话。add_recipient()
- 向消息添加另一个收件人
在以下示例中,Google的 Gmail 服务的 SMTP 服务器用作 Flask-Mail 配置的MAIL_SERVER。
第1步 - 在代码中从 flask-mail
模块导入 Mail
和 Message
类。
from flask_mail import Mail, Message
第2步 - 根据以下设置配置 Flask-Mail
。
app.config['MAIL_SERVER']='smtp.gmail.com'
app.config['MAIL_PORT'] = 465
app.config['MAIL_USERNAME'] = '[email protected]'
app.config['MAIL_PASSWORD'] = '*****'
app.config['MAIL_USE_TLS'] = False
app.config['MAIL_USE_SSL'] = True
第3步 - 创建一个 Mail
类的实例
mail = Mail(app)
第4步 - 在由URL规则映射的Python函数( /
)中设置 Message
对象。
@app.route("/")
def index():
msg = Message('Hello', sender = '[email protected]', recipients = ['[email protected]'])
msg.body = "This is the email body"
mail.send(msg)
return "Sent"
第5步 - 整个代码如下。 在Python Shell中运行以下脚本并访问URL: http://localhost:5000/。
from flask import Flask
from flask_mail import Mail, Message
app = Flask(__name__)
mail = Mail(app)
app.config['MAIL_SERVER'] = 'smtp.gmail.com'
app.config['MAIL_PORT'] = 465
app.config['MAIL_USERNAME'] = '[email protected]'
app.config['MAIL_PASSWORD'] = '*****'
app.config['MAIL_USE_TLS'] = False
app.config['MAIL_USE_SSL'] = True
mail = Mail(app)
@app.route("/")
def index():
msg = Message('Hello', sender='[email protected]', recipients=['[email protected]'])
msg.body = "Hello Flask message sent from Flask-Mail"
mail.send(msg)
return "Sent"
if __name__ == '__main__':
app.run(debug=True)
请注意,Gmail服务中的内置不安全功能可能会阻止此登录尝试,可能需要降低安全级别。 请登录到您的Gmail帐户并访问 此链接以降低安全性。