Flask之电子邮件

前言：本博客仅作记录学习使用，部分图片出自网络，如有侵犯您的权益，请联系删除

一、使用Flask-Mail发送电子邮件

1.1、配置Flask-Mail

1.2、构建邮件数据

1.3、发送邮件

二、使用事务邮件服务SendGrid

2.1、注册SendGrid

2.2、SendGrid SMTP转发

2.3、SendGrid Web API转发

三、电子邮件进阶

3.1、提供HRML正文

3.2、使用Jinja2模板组织邮件正文

3.3、异步发送邮件

致谢

示例邮件：

邮件字段	字段值
发信方（Sender）	Greygrey@helloflask.com
收信方（To）	Zornzorn@example.com
邮件主体（Subject）	Hello,World!
邮件正文（Body）	Across the Great Wall we can reach every corner in the world.

一、使用Flask-Mail发送电子邮件

扩展Flask-Mail包装了Python标准库中的smtplib包，简化了在Flask程序中发送电子邮件的过程。

 pip install flask-mail

实例化Flask-Mail提供的Mail类并传入程序实例以完成初始化：

 from flask_mail import Mail
 
 app = Flask(__name__)
 ...
 mail = Mail(app)

1.1、配置Flask-Mail

Flask-Mail通过连接SMTP（Simple Mail Transfer Protocal，简单邮件传输协议）服务器来发送邮件。在开发和测试阶段，我们使用邮件服务提供商的SMTP服务器（比如Gmail），这时我们需要对Flask-Mail进行配置。

Flask-Mail常用配置变量：

配置键	说明	默认值
MAIL_SERVER	用于发送邮件的SMTP服务器	localhost
MAIL_PORT	发送端口	25
MAIL_USE_TLS	是否使用STRTTLS	False
MAIL_USE_SSL	是否使用SSL/TLS	False
MAIL_USERNAME	发送服务器的用户名	None
MAIL_PASSWORD	发送服务器的密码	None
MAIL_DEFAULT_SENDER	默认的发信人	None

对发送的邮件进行加密可以避免在发送过程中被第三方截获和篡改。SSL（Security Socket Layer，安全套接字层）和TLS（Transport Layer Security，传输层安全）是两种常用的电子邮件安全协议。TLS继承了SSL，并在SSL的基础上做了一些改进。通过将MAIL_USE_SSL设置为True开启。STARTTLS是另一种加密方式，它会对不安全的连接进行升级。

 # 1、SSL/TLS加密:
 MAIL_USE_SLL = True
 MAIL_PORT = 465
 
 # 2、STARTTLS加密:
 MAIL_USE_TLS = True
 MAIL_PORT = 587

（当不对邮件进行加密时，邮件服务器的端口使用默认的25端口）

常见的电子邮箱服务提供商的STMP配置信息：

电子邮件服务提供商	MAIL_SERVER	MAIL_USERNAME	MAIL_PASSWORD	额外步骤
Gmail	smtp.gmail.com	邮箱地址	邮箱密码	开启"Allow less secure apps"，在本地设置VPN代理
QQ邮箱	smtp.qq.com	邮箱地址	授权码	开启SMTP服务并获取授权码
新浪邮件	smtp.sina.com	邮箱地址	邮箱密码	开启SMTP服务
163邮箱	smtp.163.com	邮箱地址	授权码	开启SMTP服务并设置授权码
Outlook/Hotmail	smtp.live.com或smtp.office365.com	邮箱地址	邮箱密码	无

（163邮箱的SMTP服务不支持STARTTLS，需要使用SSL/TLS加密。就是将MAIL_USE_SSL设为True，MAIL_PORT设为465）

Gmail、Outlook、QQ邮箱等这类服务被称为EPA（Email Service Procider），只适用于个人业务使用，不适合用来发送事务邮件。对于需要发送大量邮件的事务性邮件任务，更好的选择是使用自己配置的SMTP服务器或是使用类似SendGrid、Mailgun的事务邮件服务提供商。

在程序中，随着配置的逐渐增多，我们改用app.config对象的update()方法来加载配置：

 import os
 from flask import Flask
 from flask_mail import Mail
 
 app = Flask(__name__)
 
 app.config.update(
     MAIL_SERVER=os.getenv('MAIL_SERVER'),
     MAIL_PORT=587,
     MAIL_USE_TLS=True,
     MAIL_USERNAME=os.getenv('MAIL_USERNAME'),
     MAIL_PASSWORD=os.getenv('MAIL_PASSWORD'),
     MAIL_DEFAULT_SENDER=('Grey Li', os.getenv('MAIL_USERNAME'))
 )
 mail = Mail(app)

在我们的配置中，邮箱账户和密码属于敏感信息，不能直接写在脚本中，所以设置为从系统环境变量中获取。

1.2、构建邮件数据

下面借助Python Shell演示。邮件通过从Flask-Mail中导入的Message类表示，而发信功能通过我们在程序包的构建文件中创建的mail对象实现：

 $ flask shell
 >>> from flask_mail import Message
 >>> from app import mail

一封邮件至少包含主题、收件人、正文、发信人这几个。发信人在前用MAIL_DEFUALT_SENDER配置变量指定过了，剩下的分别通过Message类的构造方法中的subject、recipients、body关键字传入参数，其中recipients是包含一电子邮件地址的列表。

 >>> message = Message(subject='Hello,World!',recipients=['Zorn <zorn@example.com>'],body='Across the Great Wall we can reach every corner in the world.')

（和发信人类似，收信人字符串有两种新式：'Zorn zorn@example.com'或'zorn@example.com'）

1.3、发送邮件

通过对mail对象调用send()方法，传入我们在上面构建的邮件对象即可发送邮件：

 >>> mail.send(message)

完整的发送示例代码：

 from flask import Flask
 from flask_mail import Mail,Message
 ...
 message = Message(subject='Hello,World!',
                   recipients=['Zorn <zorn@example.com>'],
                   body='Across the Great Wall we can reach every corner in the world.')
 mail.send(message)

为了方便重用，我们把这些代码包装成一个通用的发信函数send_mail()：

...
def send_mail(subject,to,body):
    message = Message(subject,recipients=[to],body=body)
    mail.send(message)

假设我们程序是一个周刊订阅程序，当用户在表单中填写了正确的Email地址时，我们就发送一封邮件来通知用户订阅成功。通过在index视图中调用send_mail()即可发送邮件：

@app.route('/subscript',methods=['GET','POST'])
def subscript():
    form = SubscribeForm()
    if form.validate_on_submit():
        email = form.email.data
        flash('Welcome on board!')
        send_mail('Subscribe Success!',email,'Hello,thank you for subscribing Flask Weekly!')
        return redirect(url_for('index'))
    return render_template('index.html',form=form)

二、使用事务邮件服务SendGrid

在生产环境中，除了自己安装运行邮件服务器外，更方便的做法是使用事务邮件服务，比如Mailgun、Sendgrid等。这两个邮件服务对免费账户分别提供每月1万封和3000封的免费额度，完全足够在测试使用或在小型程序中使用。Mailgun在注册免费账户时需要填写信用卡，而Sendgrid没有这一限制。

2.1、注册SendGrid

登录官网注册一个免费账户，访问https://app.sendgrid.com/signup，填写信息等完成注册。注册完成后，需要为当前的项目创建一个API密钥，用于在程序中发送邮件时进行认证。

创建成功后复制密钥，然后保存到.env文件中，待会使用它来作为发信账户的密码：

SENDRID_API_KEY=your_key_here

（API密钥被创建一次后仅显示一次，一旦关闭了显示界面，将无法再次查看。）

2.2、SendGrid SMTP转发

创建好API密钥后，就可以通过SendGrid提供的SMTP服务器发送电子邮件了。

MAIL_SERVER = 'smtp.sendgrid.net'
MAIL_PORT = 587
MAIL_USE_TLS = True
MAIL_USERNAME = 'apikey'
MAIL_PASSWORD = os.getenv('SENDGRID_API_KEY')	# 从环境变量中读取API密钥

2.3、SendGrid Web API转发

在程序中向SendGrid提供的Web API发出一个POST请求，并附带必要的信息，比如密钥、邮件主题、收件人、正文等。示例：

POST https://api.sendgrid.com/v3/mail/send
'Authorization: Bearer YOUR_API_KEY'
'Content-Type: application/json'

'{"personalizations":[{"to":[{"email":"zorn@example.com"}]}],"from":{"email":"noreply@helloflask.com"},"subject":"Hello,World!","content":[{"type":"text/plain","value":"Across the Great Wall we can reach every corner in the World."}]}'

在命令行中使用curl一类的工具，或是使用任意一个用于请求的Python库即可发送电子邮件，比如requests。为了更方便在Python中构建邮件内容和发送邮件，我们可以使用SendGrid提供的官方Python SDK---SendGrid-Python：

pip install sendgrid

2.3.1、创建发信对象

首先需要实例化SendGridAPIClient类创建一个发信客户端对象：

>>> from sendgrid import SendGridAPIClient
>>> sg = SendGridAPIClient(api_key=os.getenv('SENDGRID_API_KEY'))

2.3.2、构建邮件数据

from sendgrid.helpers.mail import Email,Content,Mail
from_email = Email('norn@helloflask.com')
to_email = Email('zorn@example.com')
subject = 'Hello World!'
content = Content('text/plain','Across the Great Wall we can reach every corner in the World.')
mail = Mail(from_email,subject,to_email,content)

2.3.3、发送邮件

通过对表示邮件对象的sg对象调用sg.client.mail.send.post()方法，并将表示数据的字典使用关键字request_body传入即可发送发信的POST请求：

sg.client.mail.send.post(request_body=mail.get())

发信的方法会返回响应，我们可以查看响应的内容：

response = sg.client.mail.send.post(request_body=mail.get())
print(response.status_code)
print(response.body)
print(response.headers)

同样的，可以创建一个发信函数用来在视图函数中调用：

import sendgrid
import os
from sendgrid.helpers.mail import *

def send_email(subject,to,body):
    sg = SendGridAPIClient(api_key=os.getenv('SENDGRID_API_KEY'))
    from_email = Email('norn@helloflask.com')
    to_email = Email(to)
    content = Content('text/plain',body)
    mail = Mail(from_email,subject,to_email,content)
    response = sg.client.mail.send.post(request_body=mail.get())

三、电子邮件进阶

3.1、提供HRML正文

一封电子邮件的正文可以是纯文本（text/plain），也可以是HTML格式的文本（text/html）。出于更安全的考虑，一封电子邮件应该既包含纯文本又包含HTML格式的正文。HTML格式正文将被优先读取；对于HTML邮件正文的编写：

使用Tabel布局，而不是Div布局
使用行内（inline）样式定义，比如：

<span style="font-family:Arial,Helvetica,sans-serif;font-size:12px;color:##000000;">Hello Email!</span>

使用比较基础的CSS属性，避免使用快捷属性（比如background）和定位属性（比如float、position）
邮件正文的宽度不超过600px
避免使用JavaScript代码
避免使用背景图片

在Flask-Mail中，我们使用Message类实例来构建邮件。和纯文本正文类似，HTML正文可以在实例化时传入html参数指定：

message = Message(...,body='纯文本正文',html='<h1>HTML正文</h1>')

或是通过类属性message.html指定：

message = Message(...)
message.body = '纯正文文本'
message.html = '<h1>HTML文本</h1>'

在SendGrid-Python中，使用Content类构建邮件正文时传入的第一个type_ 参数指定了邮件正文的MIME类型。若想同时提供两种格式的正文，那么就在使用Mail类构建邮件数据时传入一个包含两个Content类实例的列表作为正文content的参数值：

from sendgrid.helpers.mail import *
...
text_content = Content("text/plain","纯正文文本")
html_content = Content("text/html","<h1>HTML文本</h1>")
mail = Mail(from_email,subject,to_email,content=[text=content,html_content])

3.2、使用Jinja2模板组织邮件正文

大多数情况下，我们需要动态构建邮件正文。示例一个纯文本邮件模板subscribe.txt：

Hello {{ name }},
Thank you for subscribing Flask weekly!
Enjoy the reading :)

Visit this link to unsubscribe: {{ url_for('unsubscribe',_external=True) }}

为了同时支持纯文本和HTML格式的邮件正文，每一类邮件我们都需要分别创建HTML和纯文本格式的模板。

<div style="width: 580px; padding: 20px;">
    <h3>Hello {{ name }}</h3>
    <p>Thank you for subscribing Flask Weekly!</p>
    <p>Enjoy the reading :)</p>
    <smail style="color: #868e96;">
        Click here to <a href="{{ url_for('unsubscribe',_external=True) }}">unsubscribe</a>.
    </smail>
</div>

以上面创建的发信函数为例，在发送邮件的视图函数中使用render_template()函数渲染邮件正文，并传入相应的变量：

from flask import render_template
from flask_mail import Message

def send_subscribe_mail(subject,to,**kwargs):
    message = Message(subject,recipients=[to],sender='Flask Weekly <%s>' %os.getenv('MAIL_USERNAME'))
    message.body = render_template('emails/subscribe.txt',**kwargs)
    message.html = render_template('emails/subscribe.html',**kwargs)
    mail.send(message)

3.3、异步发送邮件

为了避免延迟，我们可以将发信函数放入后台线程异步执行，以Flask-Mail为例：

from threading import Thread

def _send_async_mail(app,message):
    with app.app_context():
        mail.send(message)

def send_mail(subject,to,body):
    message = Message(subject,recipients=[to],body=body)
    thr = Thread(target=_send_async_mail,args=[app,message])
    thr.start()
    return thr

因为Flask_Mail的send()方法内部的调用逻辑中使用了current_app变量，而这个变量只在激活的程序上下文中才存在，这里在后台线程调用发信函数，但是后台线程并没有程序上下文存在。为了正常实现发信功能，我们传入程序实例app作为参数，并调用app,app_context()手动激活程序上下文。