Python使用POP3和SMTP協議收發郵件

潘高發表於2019-04-15
Python協議

前言

更多內容，請訪問我的 個人部落格。

先來了解一下收/發郵件有哪些協議：

  • SMTP協議
    SMTP（Simple Mail Transfer Protocol），即簡單郵件傳輸協議。相當於中轉站，將郵件傳送到客戶端。
  • POP3協議
    POP3（Post Office Protocol 3），即郵局協議的第3個版本，是電子郵件的第一個離線協議標準。該協議把郵件下載到本地計算機，不與伺服器同步，缺點是更易丟失郵件或多次下載相同的郵件。
  • IMAP協議
    IMAP（Internet Mail Access Protocol），即互動式郵件存取協議。該協議連線遠端郵箱直接操作，與伺服器內容同步。
  • Exchange服務
    Exchange服務是一個設計完備的郵件伺服器產品，提供了通常所需要的全部郵件服務功能。除了常規SMTP/POP協議服務之外，它還支援IMAP4 、LDAP和NNTP協議。

Python內建對SMTP/POP3/IMAP的支援。更多詳情請移步 Python官方教程

SMTP傳送郵件

Python對SMTP支援有 smtplib 和 email 兩個模組，email 負責構造郵件，smtplib 負責傳送郵件。

構造郵件

構造最簡單的純文字郵件，如下：

from email.mime.text import MIMEText

msg = MIMEText('hello, send by Python...', 'plain', 'utf-8')
複製程式碼

注意到構造 MIMEText 物件時，第一個引數就是郵件正文，第二個引數是MIME的subtype，傳入 'plain' 表示純文字，最終的MIME就是 'text/plain'，最後一定要用 utf-8 編碼保證多語言相容性。

傳送郵件

import smtplib

# 輸入Email地址和口令:
from_addr = 'test_from_addr@qq.com'
password = 'Password'
# 輸入收件人地址:
to_addr = 'test_to_addr@qq.com'
# 輸入SMTP伺服器地址:
smtp_server = smtp.qq.com

server = smtplib.SMTP(smtp_server, 25) # SMTP協議預設埠是25
# server.starttls() # 如果是SSL，則用 587 埠，再加上這句程式碼就行了
server.set_debuglevel(1)    # 列印出和SMTP伺服器互動的所有資訊
server.login(from_addr, password)   # 登入SMTP伺服器
server.sendmail(from_addr, [to_addr], msg.as_string())    # 發郵件
server.quit()
複製程式碼

sendmail() 方法就是發郵件，由於可以一次發給多個人，所以傳入一個 list，郵件正文是一個 str，as_string() 把MIMEText物件變成 str。

注意： QQ郵件等需要手動開通 SMTP服務 ， 郵箱設定 => 賬號 => POP3/SMTP服務，如下圖：

image

image

此時，我們就可以收到郵件了，如下：

image

新增郵件標題、收/發件人

郵件主題、顯示發件人、收件人等資訊並不是通過SMTP協議傳送的，而是包含在 MIMEText 物件中，如下：

from email import encoders
from email.header import Header
from email.mime.text import MIMEText
from email.utils import parseaddr, formataddr

import smtplib

def _format_addr(s):
    name, addr = parseaddr(s)
    return formataddr((Header(name, 'utf-8').encode(), addr))

from_addr = 'test_from_addr@qq.com'
password = 'Password'
to_addr = 'test_to_addr@qq.com'
smtp_server = smtp.qq.com

msg = MIMEText('hello, send by Python...', 'plain', 'utf-8')
msg['From'] = _format_addr('發件人暱稱 <%s>' % from_addr)
msg['To'] = _format_addr('收件人暱稱 <%s>' % to_addr)
msg['Subject'] = Header('這是個有主題的郵件', 'utf-8').encode()

server = smtplib.SMTP(smtp_server, 25)
server.set_debuglevel(1)
server.login(from_addr, password)
server.sendmail(from_addr, [to_addr], msg.as_string())
server.quit()
複製程式碼

收到的郵件，如下：

image

收件人並不是我們設定的 “收件人暱稱”，是因為很多郵件服務商在顯示郵件時，會把收件人名字自動替換為使用者註冊的名字，這無傷大雅。

傳送HTML郵件

要傳送HTML郵件很簡單，在構造 MIMEText 物件時，把HTML字串傳進去，再把第二個引數由 plain 變為 html ，如下：

msg = MIMEText('<html><body><h1>Hello</h1>' +
    '<p>send by <a href="http://blog.pangao.vip">PanGao’s blog</a>...</p>' +
    '</body></html>', 'html', 'utf-8')
複製程式碼

傳送附件

要想傳送附件，需要構造一個 MIMEMultipart 物件代表郵件本身，然後往裡面加上一個 MIMEText 作為郵件正文，再繼續往裡面加上表示附件的 MIMEBase 物件，如下：

from email.mime.multipart import MIMEMultipart
from email.mime.base import MIMEBase

# 郵件物件:
msg = MIMEMultipart()
msg['From'] = _format_addr('發件人暱稱 <%s>' % from_addr)
msg['To'] = _format_addr('收件人暱稱 <%s>' % to_addr)
msg['Subject'] = Header('這是個有主題的郵件', 'utf-8').encode()

# 郵件正文是MIMEText:
msg.attach(MIMEText('send with file...', 'plain', 'utf-8'))

# 新增附件就是加上一個MIMEBase，從本地讀取一個圖片:
with open('/Users/pangao/Downloads/test.png', 'rb') as f:
    # 設定附件的MIME和檔名，這裡是png型別:
    mime = MIMEBase('image', 'png', filename='test.png')
    # 加上必要的頭資訊:
    mime.add_header('Content-Disposition', 'attachment', filename='test.png')
    mime.add_header('Content-ID', '<0>')
    mime.add_header('X-Attachment-Id', '0')
    # 把附件的內容讀進來:
    mime.set_payload(f.read())
    # 用Base64編碼:
    encoders.encode_base64(mime)
    # 新增到MIMEMultipart:
    msg.attach(mime)
複製程式碼

image

傳送圖片

由於 mac 自帶的郵件會自動把圖片附件插入郵件正文中，所以樣式很好看。但是普通郵件可能沒這麼便捷（抱歉，我沒見過普通郵件。。。小小得瑟一下）

如果要把一個圖片嵌入到郵件正文中怎麼做？直接在HTML郵件中連結圖片地址行不行？答案是，大部分郵件服務商都會自動遮蔽帶有外鏈的圖片，因為不知道這些連結是否指向惡意網站。

要把圖片嵌入到郵件正文中，我們只需按照傳送附件的方式，先把郵件作為附件新增進去，然後，在HTML中通過引用 src="cid:0" 就可以把附件作為圖片嵌入了。如果有多個圖片，給它們依次編號，然後引用不同的 cid:x 即可。

把上面程式碼加入 MIMEMultipart 的 MIMEText 從 plain 改為 html，然後在適當的位置引用圖片，如下：

msg.attach(MIMEText('<html><body><h1>Hello</h1>' +
    '<p><img src="cid:0"></p>' +
    '</body></html>', 'html', 'utf-8'))
複製程式碼

同時支援HTML和Plain格式

如果我們傳送HTML郵件，收件人通過瀏覽器或者Outlook之類的軟體是可以正常瀏覽郵件內容的，但是，如果收件人使用的裝置太古老，檢視不了HTML郵件怎麼辦？

辦法是在傳送HTML的同時再附加一個純文字，如果收件人無法檢視HTML格式的郵件，就可以自動降級檢視純文字郵件。

利用 MIMEMultipart 就可以組合一個HTML和Plain，要注意指定subtype是 alternative，如下：

msg = MIMEMultipart('alternative')
msg['From'] = ...
msg['To'] = ...
msg['Subject'] = ...

msg.attach(MIMEText('hello', 'plain', 'utf-8'))
msg.attach(MIMEText('<html><body><h1>Hello</h1></body></html>', 'html', 'utf-8'))
# 正常傳送msg物件...
複製程式碼

加密SMTP

使用標準的25埠連線SMTP伺服器時，使用的是明文傳輸，傳送郵件的整個過程可能會被竊聽。要更安全地傳送郵件，可以加密SMTP會話，實際上就是先建立SSL安全連線，然後再使用SMTP協議傳送郵件。

某些郵件服務商，例如Gmail，提供的SMTP服務必須要加密傳輸。我們來看看如何通過Gmail提供的安全SMTP傳送郵件。

必須知道，Gmail的SMTP埠是587，因此，修改程式碼如下：

smtp_server = 'smtp.gmail.com'
smtp_port = 587
server = smtplib.SMTP(smtp_server, smtp_port)
server.starttls()
# 剩下的程式碼和前面的一模一樣:
server.set_debuglevel(1)
...
複製程式碼

只需要在建立 SMTP 物件後，立刻呼叫 starttls() 方法，就建立了安全連線。後面的程式碼和前面的傳送郵件程式碼完全一樣。

POP3收取郵件

Python內建一個 poplib 模組，實現了POP3協議，可以直接用來收郵件。

注意到POP3協議收取的不是一個已經可以閱讀的郵件本身，而是郵件的原始文字，這和SMTP協議很像，SMTP傳送的也是經過編碼後的一大段文字。

要把POP3收取的文字變成可以閱讀的郵件，還需要用email模組提供的各種類來解析原始文字，變成可閱讀的郵件物件。

所以，收取郵件分兩步：

第一步：用 poplib 把郵件的原始文字下載到本地；

第二部：用 email 解析原始文字，還原為郵件物件。

通過POP3下載郵件

POP3協議本身很簡單，以下面的程式碼為例，我們來獲取最新的一封郵件內容：

from email.parser import Parser
import poplib

# 輸入郵件地址, 口令和POP3伺服器地址:
email = 'pangao1990@qq.com'
password = 'Password'
pop3_server = 'pop.qq.com'

# 連線到POP3伺服器:
server = poplib.POP3_SSL(pop3_server)
# 可以開啟或關閉除錯資訊:
server.set_debuglevel(1)

# 身份認證:
server.user(email)
server.pass_(password)

# list()返回所有郵件的編號:
resp, mails, octets = server.list()

# 獲取最新一封郵件, 注意索引號從1開始:
index = len(mails)
resp, lines, octets = server.retr(index)

# lines儲存了郵件的原始文字的每一行,
# 可以獲得整個郵件的原始文字:
msg_content = b'\r\n'.join(lines).decode('utf-8')
# 稍後解析出郵件:
msg = Parser().parsestr(msg_content)

# 可以根據郵件索引號直接從伺服器刪除郵件:
# server.dele(index)
# 關閉連線:
server.quit()
複製程式碼

但是這個 Message 物件本身可能是一個 MIMEMultipart 物件，即包含巢狀的其他 MIMEBase 物件，巢狀可能還不止一層。

所以我們要遞迴地列印出 Message 物件的層次結構：

from email.header import decode_header
from email.utils import parseaddr


def print_info(msg, indent=0):
    if indent == 0:
        for header in ['From', 'To', 'Subject']:
            value = msg.get(header, '')
            if value:
                if header == 'Subject':
                    value = decode_str(value)
                else:
                    hdr, addr = parseaddr(value)
                    name = decode_str(hdr)
                    value = u'%s <%s>' % (name, addr)
            print('%s%s: %s' % ('  ' * indent, header, value))
    if (msg.is_multipart()):
        parts = msg.get_payload()
        for n, part in enumerate(parts):
            print('%spart %s' % ('  ' * indent, n))
            print('%s--------------------' % ('  ' * indent))
            print_info(part, indent + 1)
    else:
        content_type = msg.get_content_type()
        if content_type == 'text/plain' or content_type == 'text/html':
            content = msg.get_payload(decode=True)
            charset = guess_charset(msg)
            if charset:
                content = content.decode(charset)
            print('%sText: %s' % ('  ' * indent, content + '...'))
        else:
            print('%sAttachment: %s' % ('  ' * indent, content_type))


def decode_str(s):
    value, charset = decode_header(s)[0]
    if charset:
        value = value.decode(charset)
    return value


def guess_charset(msg):
    charset = msg.get_charset()
    if charset is None:
        content_type = msg.get('Content-Type', '').lower()
        pos = content_type.find('charset=')
        if pos >= 0:
            charset = content_type[pos + 8:].strip()
    return charset


print_info(msg) #解析

# From: 木葉 <pangao1990@qq.com>
# To:  <mail@pangao.vip>
# Subject: 測試主題
# Text: 測試內容
# 
# ...
複製程式碼

相關文章