基於Web的應用程式通常需要具有向使用者/用戶端傳送郵件的功能。 Flask-Mail擴充套件使得用任何電子郵件伺服器設定一個簡單介面變得非常簡單。
起初，Flask-Mail擴充套件可使用pip工具來安裝，如下所示 -
pip install Flask-Mail
然後需要通過設定以下應用程式引數的值來組態Flask-Mail。
| 編號 | 引數 | 描述 |
|---|---|---|
| 1 | MAIL_SERVER | 郵件伺服器的名稱/IP地址 |
| 2 | MAIL_PORT | 所用伺服器的埠號 |
| 3 | MAIL_USE_TLS | 啟用/禁用傳輸安全層加密 |
| 4 | MAIL_USE_SSL | 啟用/禁用安全通訊端層加密 |
| 5 | MAIL_DEBUG | 偵錯支援，預設是Flask應用程式的偵錯狀態 |
| 6 | MAIL_USERNAME | 發件人的使用者名 |
| 7 | MAIL_PASSWORD | 發件人的密碼 |
| 8 | MAIL_DEFAULT_SENDER | 設定預設發件人 |
| 9 | MAIL_MAX_EMAILS | 設定要傳送的最大郵件 |
| 10 | MAIL_SUPPRESS_SEND | 如果app.testing設定為true，則傳送被抑制 |
| 11 | MAIL_ASCII_ATTACHMENTS | 如果設定為true，則將附加的檔案名轉換為ASCII |
flask-mail模組包含以下重要類的定義。
它管理電子郵件訊息的要求。 類建構函式採用以下形式 -
| 編號 | 方法 | 描述 |
|---|---|---|
| 1 | send() | 傳送Message類物件的內容 |
| 2 | connect() | 與郵件主機開啟連線 |
| 3 | send_message() | 傳送訊息物件 |
它封裝了一封電子郵件，Message類別建構函式有幾個引數 -
flask-mail.Message(subject, recipients, body, html, sender, cc, bcc,
reply-to, date, charset, extra_headers, mail_options, rcpt_options)
attach() - 向訊息新增附件。 該方法採用以下引數 -filename - 要附加的檔案的名稱content_type - 檔案的MIME型別data - 原始檔案資料disposition - 內容處置，如果有的話。add_recipient() - 向訊息新增另一個收件人
在以下範例中，Google的Gmail服務的SMTP伺服器用作Flask-Mail組態的MAIL_SERVER。
第1步 - 在程式碼中從flask-mail模組匯入Mail和Message類。
from flask_mail import Mail, Message
第2步 - 然後根據以下設定組態Flask-Mail。
app.config['MAIL_SERVER']='smtp.gmail.com'
app.config['MAIL_PORT'] = 465
app.config['MAIL_USERNAME'] = '[email protected]'
app.config['MAIL_PASSWORD'] = '*****'
app.config['MAIL_USE_TLS'] = False
app.config['MAIL_USE_SSL'] = True
第3步 - 建立一個Mail類的範例。
mail = Mail(app)
第4步 - 在由URL規則對映的Python函式(‘/‘)中設定Message物件。
@app.route("/")
def index():
msg = Message('Hello', sender = '[email protected]', recipients = ['[email protected]'])
msg.body = "This is the email body"
mail.send(msg)
return "Sent"
第5步 - 整個程式碼如下。 在Python Shell中執行以下指令碼並存取URL: http://localhost:5000/。
from flask import Flask
from flask_mail import Mail, Message
app =Flask(__name__)
mail=Mail(app)
app.config['MAIL_SERVER']='smtp.gmail.com'
app.config['MAIL_PORT'] = 465
app.config['MAIL_USERNAME'] = '[email protected]'
app.config['MAIL_PASSWORD'] = '*****'
app.config['MAIL_USE_TLS'] = False
app.config['MAIL_USE_SSL'] = True
mail = Mail(app)
@app.route("/")
def index():
msg = Message('Hello', sender = '[email protected]', recipients = ['[email protected]'])
msg.body = "Hello Flask message sent from Flask-Mail"
mail.send(msg)
return "Sent"
if __name__ == '__main__':
app.run(debug = True)
請注意，Gmail服務中的內建不安全功能可能會阻止此登入嘗試，可能需要降低安全級別。 請登入到您的Gmail帳戶並存取此連結以降低安全性。