Flask插件系列 - Flask-Mail

开发 后端
给用户发送邮件是 Web 应用中最常见的任务之一,比如用户注册,找回密码等。Python 内置了一个 smtplib 的模块,可以用来发送邮件,这里我们使用 Flask-Mail,是因为它可以和 Flask 集成,让我们更方便地实现此功能。

简介

给用户发送邮件是 Web 应用中最常见的任务之一,比如用户注册,找回密码等。Python 内置了一个 smtplib 的模块,可以用来发送邮件,这里我们使用 Flask-Mail,是因为它可以和 Flask 集成,让我们更方便地实现此功能。

安装

使用 pip 安装:

  1. $ pip install Flask-Mail 

或下载源码安装:

  1. $ git clone https://github.com/mattupstate/flask-mail.git 
  2. $ cd flask-mail 
  3. $ python setup.py install  

发送邮件

Flask-Mail 连接到简单邮件传输协议 (Simple Mail Transfer Protocol, SMTP) 服务器,并把邮件交给这个服务器发送。这里以 QQ 邮箱为例,介绍如何简单地发送邮件。在此之前,我们需要知道 QQ 邮箱的服务器地址和端口是什么,点此查看。

  1. # -*- coding: utf-8 -*- 
  2.  
  3. from flask import Flask 
  4. from flask_mail import Mail, Message 
  5. import os 
  6.  
  7. app = Flask(__name__) 
  8.  
  9. app.config['MAIL_SERVER'] = 'smtp.qq.com'  # 邮件服务器地址 
  10. app.config['MAIL_PORT'] = 25               # 邮件服务器端口 
  11. app.config['MAIL_USE_TLS'] = True          # 启用 TLS 
  12. app.config['MAIL_USERNAME'] = os.environ.get('MAIL_USERNAME'or 'me@example.com' 
  13. app.config['MAIL_PASSWORD'] = os.environ.get('MAIL_PASSWORD'or '123456' 
  14.  
  15. mail = Mail(app) 
  16.  
  17. @app.route('/'
  18. def index(): 
  19.     msg = Message('Hi', sender='me@example.com', recipients=['he@example.com']) 
  20.     msg.html = '<b>Hello Web</b>' 
  21.     # msg.body = 'The first email!' 
  22.     mail.send(msg) 
  23.     return '<h1>OK!</h1>' 
  24.  
  25. if __name__ == '__main__'
  26.     app.run(host='127.0.0.1', debug=True 

在发送前,需要先设置用户名和密码,当然你也可以直接写在文件里,如果是从环境变量读取,可以这么做:

  1. $ export MAIL_USERNAME='me@example.com' 
  2. $ export MAIL_PASSWORD='123456'  

将上面的 sender 和 recipients 改一下,就可以进行测试了。

从上面的代码,我们可以知道,使用 Flask-Mail 发送邮件主要有以下几个步骤:

  • 配置 app 对象的邮件服务器地址,端口,用户名和密码等
  • 创建一个 Mail 的实例:mail = Mail(app)
  • 创建一个 Message 消息实例,有三个参数:邮件标题、发送者和接收者
  • 创建邮件内容,如果是 HTML 格式,则使用 msg.html,如果是纯文本格式,则使用 msg.body
  • 最后调用 mail.send(msg) 发送消息

Flask-Mail 配置项

Flask-Mail 使用标准的 Flask 配置 API 进行配置,下面是一些常用的配置项:

配置项 说明
MAIL_SERVER 邮件服务器地址,默认为 localhost
MAIL_PORT 邮件服务器端口,默认为 25
MAIL_USE_TLS 是否启用传输层安全 (Transport Layer Security, TLS)协议,默认为 False
MAIL_USE_SSL 是否启用安全套接层 (Secure Sockets Layer, SSL)协议,默认为 False
MAIL_DEBUG 是否开启 DEBUG,默认为 app.debug
MAIL_USERNAME 邮件服务器用户名,默认为 None
MAIL_PASSWORD 邮件服务器密码,默认为 None
MAIL_DEFAULT_SENDER 邮件发件人,默认为 None,也可在 Message 对象里指定
MAIL_MAX_EMAILS 邮件批量发送个数上限,默认为 None
MAIL_SUPPRESS_SEND 默认为 app.testing,如果为 True,则不会真的发送邮件,供测试用

异步发送邮件

使用上面的方式发送邮件,会发现页面卡顿了几秒才出现消息,这是因为我们使用了同步的方式。为了避免发送邮件过程中出现的延迟,我们把发送邮件的任务移到后台线程中,代码如下:

  1. # -*- coding: utf-8 -*- 
  2.  
  3. from flask import Flask 
  4. from flask_mail import Mail, Message 
  5. from threading import Thread 
  6. import os 
  7.  
  8. app = Flask(__name__) 
  9.  
  10. app.config['MAIL_SERVER'] = 'smtp.qq.com' 
  11. app.config['MAIL_PORT'] = 25 
  12. app.config['MAIL_USE_TLS'] = True 
  13. app.config['MAIL_USERNAME'] = os.environ.get('MAIL_USERNAME'or 'smtp.example.com' 
  14. app.config['MAIL_PASSWORD'] = os.environ.get('MAIL_PASSWORD'or '123456' 
  15.  
  16. mail = Mail(app) 
  17.  
  18. def send_async_email(app, msg): 
  19.     with app.app_context(): 
  20.         mail.send(msg) 
  21.  
  22. @app.route('/sync'
  23. def send_email(): 
  24.     msg = Message('Hi', sender='me@example.com', recipients=['he@example.com']) 
  25.     msg.html = '<b>send email asynchronously</b>' 
  26.  
  27.     thr = Thread(target=send_async_email, args=[app, msg]) 
  28.     thr.start() 
  29.     return 'send successfully' 
  30.  
  31. if __name__ == '__main__'
  32.     app.run(host='127.0.0.1', debug=True 

在上面,我们创建了一个线程,执行的任务是send_async_email,该任务的实现涉及一个问题1:

很多 Flask 扩展都假设已经存在激活的程序上下文和请求上下文。Flask-Mail 中的 send() 函数使用 current_app,因此必须激活程序上下文。不过,在不同线程中执行 mail.send() 函数时,程序上下文要使用 app.app_context()人工创建。

带附件的邮件

有时候,我们发邮件的时候需要添加附件,比如文档和图片等,这也很简单,代码如下:

  1. # -*- coding: utf-8 -*- 
  2.  
  3. from flask import Flask 
  4. from flask_mail import Mail, Message 
  5. import os 
  6.  
  7. app = Flask(__name__) 
  8.  
  9. app.config['MAIL_SERVER'] = 'smtp.qq.com'  # 邮件服务器地址 
  10. app.config['MAIL_PORT'] = 25               # 邮件服务器端口 
  11. app.config['MAIL_USE_TLS'] = True          # 启用 TLS 
  12. app.config['MAIL_USERNAME'] = os.environ.get('MAIL_USERNAME'or 'me@example.com' 
  13. app.config['MAIL_PASSWORD'] = os.environ.get('MAIL_PASSWORD'or '123456' 
  14.  
  15. mail = Mail(app) 
  16.  
  17. @app.route('/attach'
  18. def add_attchments(): 
  19.     msg = Message('Hi', sender='me@example.com', recipients=['other@example.com']) 
  20.     msg.html = '<b>Hello Web</b>' 
  21.  
  22.     with app.open_resource("/Users/Admin/Documents/pixel-example.jpg"as fp: 
  23.         msg.attach("photo.jpg""image/jpeg", fp.read()) 
  24.  
  25.     mail.send(msg) 
  26.     return '<h1>OK!</h1>' 
  27.  
  28. if __name__ == '__main__'
  29.     app.run(host='127.0.0.1', debug=True 

上面的代码中,我们通过 app.open_resource(path_of_attachment) 打开了本机的某张图片,然后通过msg.attach() 方法将附件内容添加到 Message 对象。msg.attach() 方法的第一个参数是附件的文件名,第二个参数是文件内容的 MIME (Multipurpose Internet Mail Extensions) 类型,第三个参数是文件内容。

如果你不知道附件的 MIME 类型是什么,可以查看 MIME 参考手册。

批量发送

在某些情况下,我们需要批量发送邮件,比如给网站的所有注册用户发送改密码的邮件,这时为了避免每次发邮件时都要创建和关闭跟服务器的连接,我们的代码需要做一些调整,类似如下:

  1. with mail.connect() as conn: 
  2.     for user in users: 
  3.         subject = "hello, %s" % user.name 
  4.         msg = Message(recipients=[user.email], body='...', subject=subject) 
  5.         conn.send(msg)  

上面的工作方式,使得应用与电子邮件服务器保持连接,一直到所有邮件已经发送完毕。某些邮件服务器会限制一次连接中的发送邮件的上限,这样的话,你可以配置 MAIL_MAX_EMAILS。

需要注意的是,更好的发送大量电子邮件的方式是用专门的作业系统,比如用 Celery 任务队列等。

本文完整的代码在这里

责任编辑:庞桂玉 来源: segmentfault
相关推荐

2021-08-19 07:25:02

数据库Flask插件

2019-05-14 13:59:52

Flask服务器部署

2022-03-16 00:15:56

Flask扩展插件

2022-08-31 15:09:03

PythonOthers

2020-12-29 10:16:24

接口测试flaskmock

2021-11-26 22:51:31

FlaskBlueprintsViews

2021-04-28 07:03:28

DjangoFlaskFastAPI

2020-06-03 09:37:42

人脸识别人工智能开源

2021-07-28 06:51:08

FlaskPythonWeb

2019-12-23 10:00:52

PythonFlaskPython Web

2022-02-16 07:47:48

flask分页SQLAlchemy

2022-05-26 15:02:35

Docker容器云原生

2022-06-23 08:01:36

FlaskSocketIOSwift

2023-06-07 08:18:25

2023-03-27 15:07:27

PythonWeb 开发编程语言

2022-01-03 18:15:35

FlaskTepHttpRunner

2023-09-01 08:19:21

Flask

2017-09-11 10:55:22

PythonWeb框架

2019-10-23 08:00:00

Flask机器学习人工智能

2023-12-27 10:47:45

Flask数据可视化开发
点赞
收藏

51CTO技术栈公众号