对于 Web 应用程序,往往需要有很多讯息及时的通知到用户,这种通知方式一般都是通过 Email 来实现的。比如用户的注册验证码、用户密码找回等功能,通过邮件来确认用户身份并发送相关信息,都是很好的选择。
而在 Flask 应用当中,我们可以选择 flask-mail 插件来把邮件功能很好的集成到我们的应用当中,安装和初始化都是我们熟悉命令和配置
安装:
pip install flask-mail
配置
from flask_mail import Mail
app = Flask(__name__)
...
mail = Mail(app)
Flask-Mail 是通过连接 SMTP(Simple Mail Transfer Protocol,简单邮 件传输协议)服务器来发送邮件的,因此,在开始发送电子邮件前,我们 需要配置SMTP服务器。下面是 Flask-Mail 提供的一些常用配置
配置 | 默认值 | 说明 |
---|---|---|
MAIL_SERVER | 用于发送邮件的 SMTP 服务器 | localhost |
MAIL_PORT | 发送端口 | 25 |
MAIL_USE_TLS | 是否使用TLS | False |
MAIL_USE_SSL | 是否使用SSL | False |
MAIL_USERNAME | 发信服务器用户名 | None |
MAIL_PASSWORD | 发信服务器密码 | None |
其中 TLS 和 SSL 都是用于加密的服务,可以有效的防止邮件在发送的过程中被第三方截获或篡改!
下面我们就在当前的程序当中,集成 Flask-Mail
这里要注意的一点,为了信息安全,我们千万不要把用户名和密码直接写到代码当中,而是尽量使用环境变量来代替
app.config['MAIL_SERVER'] = 'smtp.163.com'
app.config['MAIL_PORT'] = 465
app.config['MAIL_USE_SSL'] = True
app.config['MAIL_USERNAME'] = os.environ.get('MAIL_USERNAME')
app.config['MAIL_PASSWORD'] = os.environ.get('MAIL_PASSWORD')
同时还有注意,现在很多支持 SMTP 服务的服务商,在通过第三方登录的时候,都需要开启授权码,比如对于 163 邮箱,就是需要开启授权码的! 下面我们再编写一个专门用来发送邮件的函数 send_email
def send_email(to, subject, bogy):
msg = Message(subject, sender=app.config['MAIL_USERNAME'], recipients=[to], body=bogy)
mail.send(msg)
为了方便我们测试邮件是否能够正常发送,我们再编写一个测试邮件的页面,来发送测试邮件
class SendEmailForm(FlaskForm):
emailAddress = StringField('Email Address', validators=[DataRequired()])
message = TextAreaField()
submit = SubmitField("Send")
@app.route('/sendemail', methods=['GET', 'POST'])
def sendemail():
form = SendEmailForm()
if form.validate_on_submit():
eAddress = form.emailAddress.data
message = form.message.data
flash("Start Send Email!")
send_email(eAddress, "My Email", message)
return redirect(url_for('index'))
return render_template('email.html', form=form)
再次创建一个表单用于发送测试邮件
这样,一个简单的验证页面就完成了!
细心的你可能已经发现了,当我们点击发送之后,会稍微停顿几秒,这是因为我们当时是同步发送邮件,也就是程序会等待邮件发送请求返回后,才执行后面的动作,为了避免这种类似无响应的情况,我们可以使用异步的方式来发送邮件。
我们可以为发送邮件这个功能开启一个新的线程,这样我们 Web 的主线程就不需要等待了
def send_async_email(app, msg):
with app.app_context():
mail.send(msg)
def send_email_saync(to, subject, body):
msg = Message(subject, sender=app.config['MAIL_USERNAME'], recipients=[to], body=body)
thr = Thread(target=send_async_email, args=[app, msg])
thr.start()
return thr
这里涉及到了多线程的操作,不熟悉的小伙伴可以先提前看看,对于不是很熟悉的小伙伴,也不用担心,我们后面还会再用到,再重点介绍学习! 这部分完整代码,可以检出6a
到此为止,我们已经差不多完成了一个 Flask Web 应用的所需功能的概述,后面我们就可以来完成一个完整的项目了,一起进步吧!