《flask Web 開發》讀書筆記 & chapter6

chapter 2 - chapter 3 - chapter 4 - chapter 5 - 原始碼

• 概念剖析-flask電子郵件操作
  • python 的郵件支援
  • Flask-Mail 的電子郵件支援
  • Flask-Mail SMTP伺服器的配置
  • 126郵箱的配置
  • 模板渲染郵件
  • 非同步傳送郵件
• 附錄
  • cmd環境變數的設定

概念剖析-flask電子郵件操作

python 的郵件支援

• python 標準庫中的 smtplib 包可以用於傳送電子郵件
• Flask-Mail 擴充套件包裝了 smtplib

Flask-Mail 的電子郵件支援

• 安裝 pip install flask-mail

若不配置伺服器，Flask-Mail 會連線 localhost 上的埠 25，傳送郵件

Flask-Mail SMTP伺服器的配置

配置	預設值	說明
MAIL_SERVER	localhost	電子郵件主機名或IP地址
MAIL_PORT	25	電子郵件伺服器埠
MAIL_USE_TLS	False	啟用傳輸層安全協議（Transport Layer Security）
MAIL_USE_SSL	False	啟用安全套接層（Secure Sockets Layer）
MAIL_USERNAME	None	郵件賬戶的賬戶名
MAIL_PASSWORD	None	郵件賬戶的密碼

126郵箱的配置

Flask-mail測試和遇到的問題
聊聊HTTPS和SSL/TLS協議

126郵箱的伺服器主機名smtp.126.com，非SSL埠號25，SSL埠號 465，使用前需要配置客戶端授權密碼

from flask_mail import Mail, Message
...
# 設定郵件
app.config['MAIL_SERVER'] = 'smtp.126.com'
app.config['MAIL_PORT'] = 25
app.config['MAIL_USERNAME'] = os.environ.get('MAIL_126_USERNAME')
app.config['MAIL_PASSWORD'] = os.environ.get('MAIL_126_PASSWORD')
# 匯入郵件
mail = Mail(app)
...
# 路由 /mail>
@app.route('/mail')
def mail_test():
    msg = Message('test subject', sender='發件人@126.com', recipients=['收件人列表@hust.edu.cn'])
    msg.body = 'test body'
    msg.html = '<b>HTML</b> body'
    mail.send(msg)
    return '<h1> hava send the message </h1>'

git add. git commit -m "flask mail demo",git tag 6a

模板渲染郵件

hello.py 檔案中

from flask_mail import Mail, Message
...
# 設定郵件
app.config['MAIL_SERVER'] = 'smtp.126.com'
app.config['MAIL_PORT'] = 25
app.config['MAIL_USERNAME'] = os.environ.get('MAIL_126_USERNAME')
app.config['MAIL_PASSWORD'] = os.environ.get('MAIL_126_PASSWORD')
# 設定管理員郵箱
app.config['FLASK_ADMIN'] = os.environ.get('FLASK_ADMIN')
# 設定 郵件主題字首
app.config['FLASK_MAIL_SUBJECT_PREFIX'] = '[Flask]'
# 設定 發件人名稱，此處126郵箱要求發件人名稱與賬戶名一致，此處設定無效
app.config['FLASK_MAIL_SENDER'] = 'Flasky Admin <flasky@example.com>'
# 匯入郵件
mail = Mail(app)
...
# 發件函式
def send_mail( to, subject, template, **kwargs):
    msg = Message( app.config['FLASK_MAIL_SUBJECT_PREFIX'] + subject, sender = app.config['MAIL_USERNAME'], recipients=[to] )
    # jinja2 同樣能夠渲染 txt 檔案
    msg.body = render_template( template + '.txt', **kwargs )
    # jinja2 渲染 html 檔案
    msg.html = render_template( template + '.html', **kwargs )
    mail.send(msg)
...
# 路由 index
@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)
            # add 到 session
            db.session.add(user)
            session['known'] = False
            # 發現新使用者，郵件通知管理員
            if app.config['FLASK_ADMIN']:
                send_mail(app.config['FLASK_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))

設定管理員郵箱環境變數，set FLASK_ADMIN=xxx@xx.com

模板檔案：'$templates/mail/new_user.txt'：User {{ user.username }} has joined.
模板檔案：'$templates/mail/new_user.html'：User <b>{{ user.username }}</b> has joined.

git add. git commit -m "flask mail with template",git tag 6b

非同步傳送郵件

mail.send() 函式傳送測試郵件時停滯了幾秒鐘，這個過程中瀏覽器無響應，為了避免不必要的延遲，將傳送電子郵件的函式移到後臺執行緒中。

from threading import Thread
# 執行緒的執行函式
def send_async_email(app, msg):
    # flsk 上下文的概念
    with app.app_context():
        mail.send(msg)

def send_mail( to, subject, template, **kwargs):
    msg = Message( app.config['FLASK_MAIL_SUBJECT_PREFIX'] + subject, sender = app.config['MAIL_USERNAME'], 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

當程式需要傳送大量的電子郵件，可以將執行 send_asyc_email()函式的操作發給 Celery 任務佇列

git add. git commit -m "flask sync mail with template",git tag 6c

附錄

cmd環境變數的設定

cmd命令集-SET(顯示、設定或刪除 cmd.exe 環境變數
python環境變數操作