Flask Web开发 邮件模块

---

这一章真的好多坑,分成几块来写
1.以测试Flask_mail为目的
2.狗书代码实战
用目录来看本片文章更好，markdown的目录功能很棒

---

测试环境：

• windows10
• python3.5

---

参考链接

segment-测试用例
blog-狗书中环境变量的坑
知乎-对狗书记录比较全面的一篇
很棒的总结

---

Flask-Mail 发送邮件的主要步骤：

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

测试Flask_mail发送邮件

点此为原文出处，以下为部分引用

---

1.简介

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

---

2.安装

# pip
$ pip install Flask-Mail

# 或下载源码安装
$ git clone https://github.com/mattupstate/flask-mail.git
$ cd flask-mail
$ python setup.py install

---

3.发送邮件

SMTP端口

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

[

image.jpg

POP和IMAP，SMTP区别

POP和IMAP的区别在于：POP的操作，不会同步到服务器上，也就是不会影响到服务器，而IMAP是和服务器同步的。
SMTP 是发送邮件的服务器。

测试代码

# -*- coding: utf-8 -*-

from flask import Flask
from flask_mail import Mail, Message
import os

app = Flask(__name__)

app.config['MAIL_SERVER'] = 'smtp.qq.com'  # 邮件服务器地址
app.config['MAIL_PORT'] = 25               # 邮件服务器端口
app.config['MAIL_USE_TLS'] = True          # 启用 TLS
app.config['MAIL_USERNAME'] = os.environ.get('MAIL_USERNAME') or '[email protected]'
app.config['MAIL_PASSWORD'] = os.environ.get('MAIL_PASSWORD') or '123456'

mail = Mail(app)

@app.route('/')
def index():
    msg = Message('Hi', sender='[email protected]', recipients=['[email protected]'])
    msg.html = 'Hello Web'
    # msg.body = 'The first email!'
    mail.send(msg)
    return '
OK!
'

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

进行必要的修改后，在命令行用python打开这个文件就可以进行测试了
需要注意的几点如下

这里的一些坑

• qq邮箱的smtp端口为 25
• MAIL_PASSWORD最好用邮箱里生成的授权码，可在"邮箱- 设置- 账户" 内查看
• from flask_mail import Mail, Message 注意大小写
• sender 要和app.config['MAIL_USERNAME']一致

狗书代码实战

经过敲测试代码我们已经基本明白Flask-mail的基本工作模式了，单是在敲狗书里这一章代码时，还是会遇见不少坑

环境变量

书中给出设置环境变量方法如下

# Mac OS X 中使用bash，那么可以按照下面的方式设定这两个变量：
(venv) $ export MAIL_USERNAME=
(venv) $ export MAIL_PASSWORD=
# 微软Windows 用户可按照下面的方式设定环境变量：
(venv) $ set MAIL_USERNAME=
(venv) $ set MAIL_PASSWORD=

作者有些表述不清晰，实际上在windows中

# cmd下
set MAIL_USERNAME='[email protected]'  #此处有疑问，详见后文
# cmd下查看环境变量直接输入set即可
set
# powershell中
$env:MAIL_USERNAME='[email protected]'

注意：这中方法设置的是临时环境变量，这意味着重新打开cmd窗口就需要重新设置临时环境变量

环境变量这里有坑, 注意
不设立环境变量,直接在代码中配置用户名和密码不出现问题

app.config['MAIL_USERNAME'] = '[email protected]'
app.config['MAIL_PASSWORD'] = 'password'

但是如果在环境变量中配置用户名和密码，在代码中读取就会报错

#配置环境变量
$set MAIL_USERNAME = '[email protected]'
$set MAIL_PASSWORD = 'password'
#代码
app.config['MAIL_USERNAME'] = os.environ.get('MAIL_USERNAME')
app.config['MAIL_PASSWORD'] = os.environ.get('MAIL_PASSWORD')
#运行报错

  raise SMTPAuthenticationError(code, resp)
smtplib.SMTPAuthenticationError: (535, b'Error: \xc7\xeb\xca\xb9\xd3\xc8\xa8\xb5\xc7\xc2\xbc\xa1\xa3\xcf\xea\xc7\xe9\xc7\xeb\xbf\xb4: http://service.mail.qq.com/cgi-bin/help?subtype=1&&id=28&&no=1001256')

报错应该是说验证码出现问题，就是密码错误了。
但是不使用环境变量密码就正确这就很奇怪了
遂在代码中加入

#一个读取环境变量，一个直接读取
app.config['MAIL_USERNAME'] = os.environ.get('MAIL_USERNAME')
app.config['MAIL_PASSWORD'] = 'password'

#在主函数中加入打印语句
@app.route('/', methods=['GET', 'POST'])
def index():
    form = NameForm()
    print(app.config['MAIL_USERNAME'])#打印
    print(app.config['MAIL_PASSWORD'])#打印
    
#打印结果如下
'[email protected]'  #带引号
password        #无引号

发现不同后遂在环境变量配置中取消了引号，终于成功运行。

$set MAIL_USERNAME = [email protected]
$set MAIL_PASSWORD = password

但是这种情况好像只有用授权码当密码才会出现问题。因为我看了五六篇文章别人都没有遇见这个问题，而且也很少有人提问，所以我还是保留了加引号的记录。

---

坑已点完，项目实战

1.安装

(venv) $ pip install flask-mail

---

2.Flask-Mail配置 qq 邮箱

由于Gmail在国内不能使用，我们用qq邮箱替代

import os
# 原有内容
app.config['MAIL_SERVER'] = 'smtp.qq.com'
app.config['MAIL_PORT'] = 25
app.config['MAIL_USE_TLS'] = True
app.config['MAIL_USERNAME'] = os.environ.get('MAIL_USERNAME')
app.config['MAIL_PASSWORD'] = os.environ.get('MAIL_PASSWORD')

---

3.配置环境变量

set MAIL_USERNAME = '[email protected]'
set MAIL_PASSWORD = 'lssokgzndbfsfdjj'
set FLASK_ADMIN = '[email protected]' #管理员邮箱，也是项目中的接收者邮箱

---

4.在hello.py中添加电子邮件支持

邮件发送函数

from flask_mail import Message

app.config['FLASKY_MAIL_SUBJECT_PREFIX'] = '[Flasky]'#邮件主题前缀
app.config['FLASKY_MAIL_SENDER'] = 'Flasky Admin '  #这个是发件人，而<>前面的内容，实际上就相当于昵称的作用
def send_mail(to, subject, template, **kwargs):
    msg = Message(app.config['FLASKY_MAIL_SUBJECT_PREFIX'] + subject, sender=app.config['FLASKY_MAIL_SENDER'], recipients=[to])
    msg.body = render_template(template + '.txt', **kwargs)
    msg.html = render_template(template + '.html', **kwargs)
    mail.send(msg)

app.config['FLASKY_MAIL_SUBJECT_PREFIX'] 发送的邮件主题的前缀
app.config['FLASKY_MAIL_SENDER'] 邮件发送者，这个人要在你配置过的app.config['MAIL_USERNAME'] 里

如果提交的用户是新用户，则给管理员发送一封邮件提醒

# 原有内容
app.config['FLASKY_ADMIN'] = os.environ.get('FLASKY_ADMIN')
# 原有内容
@app.route('/', methods=['GET', 'POST'])
def index():
    form = NameForm()
    if form.validate_on_submit():
        user = User.query.filter_by(username=form.name.data).first()
        if user is None:
            user = User(username=form.name.data)
            db.session.add(user)
            session['known'] = False
            if app.config['FLASKY_ADMIN']:
                send_mail(app.config['FLASKY_ADMIN'], 'New User', 'mail/new_user',  user=user)
    else:
        session['known'] = True
        session['name'] = form.name.data
        return redirect(url_for('index'))
    return render_template('index.html', form=form, name=session.get('name'), known=session.get('known', False))

这里书中没有提到的是
需要在templates下建立mail子文件夹存放邮件模板。

# templates/mail/new_user.txt
User {{ user.username }} has joined.
# templates/mail/new_user.html
User {{ user.username }} has joined

---

5.异步发送电子邮件

当在发送电子邮件时，可发现程序有停滞现象，表现在浏览器上就是刷新按钮在转，这时就是send_mail()函数正在执行。为了避免这种不必要的延迟，可以使用异步的方法执行邮件发送函数。 修改hello.py：

from threading import Thread

def send_async_email(app, msg):
    with app.app_context():
        mail.send(msg)

def send_mail(to, subject, template, **kwargs):
    msg = Message(app.config['FLASKY_MAIL_SUBJECT_PREFIX'] + subject, sender=app.config['FLASKY_MAIL_SENDER'], recipients=[to])
    msg.body = render_template(template + '.txt', **kwargs)
    msg.html = render_template(template + '.html', **kwargs)
    thr = Thread(target=send_async_email, args=[app, msg])
    thr.start()
    return thr

END