【Flask web 开发】第6章 电子邮件

很多类型的应用程序都需要在特定事件发生时提醒用户,而常用的通信方法是电子邮件。虽然 Python 标准库中的 smtplib 包可用在 Flask 程序中发送电子邮件,但包装了 smtplibFlask-Mail 扩展能更好地和 Flask 集成。

使用 Flask-Mail 提供电子邮件支持

使用 pip 安装 Flask-Mail:

(venv) $ pip install flask-mail

Flask-Mail 连接到简单邮件传输协议(Simple Mail Transfer Protocol,SMTP)服务器,并把邮件交给这个服务器发送。如果不进行配置,Flask-Mail 会连接 localhost 上的端口 25,无需验证即可发送电子邮件。表 6-1 列出了可用来设置 SMTP 服务器的配置。

表6-1 Flask-Mail SMTP服务器的配置

配  置默认值说  明
MAIL_SERVERlocalhost电子邮件服务器的主机名或 IP 地址
MAIL_PORT25电子邮件服务器的端口
MAIL_USE_TLSFalse启用传输层安全(Transport Layer Security,TLS)协议
MAIL_USE_SSLFalse启用安全套接层(Secure Sockets Layer,SSL)协议
MAIL_USERNAMENone邮件账户的用户名
MAIL_PASSWORDNone 邮件账户的密码

在开发过程中,如果连接到外部 SMTP 服务器,则可能更方便。举个例子,示例 6-1 展示了如何配置程序,以便使用 Google Gmail 账户发送电子邮件。

示例 6-1 hello.py:配置 Flask-Mail 使用 Gmail

import os
# ...
app.config['MAIL_SERVER'] = 'smtp.googlemail.com'
app.config['MAIL_PORT'] = 587
app.config['MAIL_USE_TLS'] = True
app.config['MAIL_USERNAME'] = os.environ.get('MAIL_USERNAME')
app.config['MAIL_PASSWORD'] = os.environ.get('MAIL_PASSWORD')
千万不要把账户密令直接写入脚本,特别是当你计划开源自己的作品时。为了保护账户信息,你需要让脚本从环境中导入敏感信息。

Flask-Mail 的初始化方法如示例 6-2 所示。

示例 6-2 hello.py:初始化 Flask-Mail

from flask.ext.mail import Mail
mail = Mail(app)

保存电子邮件服务器用户名和密码的两个环境变量要在环境中定义。如果你在 Linux 或 Mac OS X 中使用 bash,那么可以按照下面的方式设定这两个变量:

(venv) $ export MAIL_USERNAME=<Gmail username>
(venv) $ export MAIL_PASSWORD=<Gmail password>

微软 Windows 用户可按照下面的方式设定环境变量:

(venv) $ set MAIL_USERNAME=<Gmail username>
(venv) $ set MAIL_PASSWORD=<Gmail password>

在Python shell中发送电子邮件

你可以打开一个 shell 会话,发送一封测试邮件,以检查配置是否正确:

(venv) $ python hello.py shell
>>> from flask.ext.mail import Message
>>> from hello import mail
>>> msg = Message('test subject', sender='you@example.com',
... recipients=['you@example.com'])
>>> msg.body = 'text body'
>>> msg.html = '<b>HTML</b> body'
>>> with app.app_context():
... mail.send(msg)
...

注意,Flask-Mail 中的 send() 函数使用 current_app,因此要在激活的程序上下文中执行。

在程序中集成发送电子邮件功能

为了避免每次都手动编写电子邮件消息,我们最好把程序发送电子邮件的通用部分抽象出来,定义成一个函数。这么做还有个好处,即该函数可以使用 Jinja2 模板渲染邮件正文,灵活性极高。具体实现如示例 6-3 所示。

示例 6-3 hello.py:电子邮件支持

from flask.ext.mail import Message

app.config['FLASKY_MAIL_SUBJECT_PREFIX'] = '[Flasky]'
app.config['FLASKY_MAIL_SENDER'] = 'Flasky Admin <flasky@example.com>'

def send_email(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)

这个函数用到了两个程序特定配置项,分别定义邮件主题的前缀和发件人的地址。send_email 函数的参数分别为收件人地址、主题、渲染邮件正文的模板和关键字参数列表。指定模板时不能包含扩展名,这样才能使用两个模板分别渲染纯文本正文和富文本正文。调用者将关键字参数传给 render_template() 函数,以便在模板中使用,进而生成电子邮件正文。

index() 视图函数很容易被扩展,这样每当表单接收新名字时,程序都会给管理员发送一封电子邮件。修改方法如示例 6-4 所示。

示例 6-4 hello.py:电子邮件示例

# ...
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_email(app.config['FLASKY_ADMIN'], 'New User',
                        'mail/new_user', user=user)
        else:
            session['known'] = True
        session['name'] = form.name.data
        form.name.data = ''
        return redirect(url_for('index'))
    return render_template('index.html', form=form, name=session.get('name'),
                        known=session.get('known', False))

电子邮件的收件人保存在环境变量 FLASKY_ADMIN 中,在程序启动过程中,它会加载到一个同名配置变量中。我们要创建两个模板文件,分别用于渲染纯文本和 HTML 版本的邮件正文。这两个模板文件都保存在 templates 文件夹下的 mail 子文件夹中,以便和普通模板区分开来。电子邮件的模板中要有一个模板参数是用户,因此调用 send_mail() 函数时要以关键字参数的形式传入用户。

如果你从 GitHub 上克隆了这个程序的 Git 仓库,那么可以执行 git checkout 6a 签出程序的这个版本。

除了前面提到的环境变量 MAIL_USERNAMEMAIL_PASSWORD 之外,这个版本的程序还需要使用环境变量 FLASKY_ADMIN。Linux 和 Mac OS X 用户可使用下面的命令添加:

(venv) $ export FLASKY_ADMIN=<your-email-address>

对微软 Windows 用户来说,等价的命令是:

(venv) $ set FLASKY_ADMIN=<Gmail username>

设置好这些环境变量后,我们就可以测试程序了。每次你在表单中填写新名字时,管理员都会收到一封电子邮件。

异步发送电子邮件

如果你发送了几封测试邮件,可能会注意到 mail.send() 函数在发送电子邮件时停滞了几秒钟,在这个过程中浏览器就像无响应一样。为了避免处理请求过程中不必要的延迟,我们可以把发送电子邮件的函数移到后台线程中。修改方法如示例 6-5 所示。

示例 6-5 hello.py:异步发送电子邮件

from threading import Thread

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

def send_email(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

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

如果你从 GitHub 上克隆了这个程序的 Git 仓库,可以执行 git checkout 6b签出程序的这个版本。

现在再运行程序,你会发现程序流畅多了。不过要记住,程序要发送大量电子邮件时,使用专门发送电子邮件的作业要比给每封邮件都新建一个线程更合适。例如,我们可以把执行 send_async_email() 函数的操作发给 Celeryhttp://www.celeryproject.org/)任务队列。

至此,我们完成了对大多数 Web 程序所需功能的概述。现在的问题是,hello.py 脚本变得越来越大,难以使用。在下一章中,你会学到如何组织大型程序的结构。

标签: none

添加新评论