Python网络编程之使用email、smtplib、poplib、imaplib模块收发邮件

2022-07-14,,,,

一封电子邮件的旅程是:

  • mua:mail user agent——邮件用户代理。(即类似outlook的电子邮件软件)
  • mta:mail transfer agent——邮件传输代理,就是那些email服务提供商,比如网易、新浪等等。
  • mda:mail delivery agent——邮件投递代理。email服务提供商的某个服务器

发件人 -> mua -> mta -> mta -> 若干个mta -> mda <- mua <- 收件人

要编写程序来发送和接收邮件,本质上就是:

  • 编写mua把邮件发到mta;
  • 编写mua从mda上收邮件。

发邮件时,mua和mta使用的协议就是smtp:simple mail transfer protocol,后面的mta到另一个mta也是用smtp协议。

收邮件时,mua和mda使用的协议有两种:pop:post office protocol,目前版本是3,俗称pop3;imap:internet message access protocol,目前版本是4,优点是不但能取邮件,还可以直接操作mda上存储的邮件,比如从收件箱移到垃圾箱,等等。

一、smtp(simple mail transfer protocol)

即简单邮件传输协议,它是一组用于由源地址到目的地址传送邮件的规则,由它来控制信件的中转方式。

python的smtplib提供了一种很方便的途径发送电子邮件。它对smtp协议进行了简单的封装。

python对smtp支持有smtplibemail两个模块email负责构造邮件,smtplib负责发送邮件。

1、构造邮件:email.mime类型

构造一个邮件对象就是一个messag对象,如果构造一个mimetext对象,就表示一个文本邮件对象,如果构造一个mimeimage对象,就表示一个作为附件的图片,要把多个对象组合起来,就用mimemultipart对象,而mimebase可以表示任何对象。它们的继承关系如下:

message
+- mimebase
   +- mimemultipart
   +- mimenonmultipart
      +- mimemessage
      +- mimetext
      +- mimeimage

首先,我们来构造一个最简单的纯文本邮件,然后,通过smtp发出去。

from email.mime.text import mimetext
msg = mimetext('hello, send by python...', 'plain', 'utf-8')

注意到构造mimetext对象时,第一个参数就是邮件正文,第二个参数是mime的subtype,传入'plain',最终的mime就是'text/plain',最后一定要用utf-8编码保证多语言兼容性。

2、创建 smtp 对象

语法如下:

import smtplib
smtpobj = smtplib.smtp( [host [, port [, local_hostname]]] )

参数说明:

  • host: smtp 服务器主机。 你可以指定主机的ip地址或者域名如: runoob.com,这个是可选参数。
  • port: 如果你提供了 host 参数, 你需要指定 smtp 服务使用的端口号,一般情况下 smtp 端口号为25。
  • local_hostname: 如果 smtp 在你的本机上,你只需要指定服务器地址为 localhost 即可。

3、python smtp 对象使用 sendmail 方法发送邮件

语法如下:

smtp.sendmail(from_addr, to_addrs, msg[, mail_options, rcpt_options])

参数说明:

  • from_addr: 邮件发送者地址。
  • to_addrs: 字符串列表,邮件发送地址。
  • msg: 发送消息

这里要注意一下第三个参数,msg 是字符串,表示邮件。我们知道邮件一般由标题,发信人,收件人,邮件内容,附件等构成,发送邮件的时候,要注意 msg 的格式。这个格式就是 smtp 协议中定义的格式。

二、实例

2:本机已安装支持 smtp 的服务

以下执行实例需要你本机已安装了支持 smtp 的服务。

sendmail()方法就是发邮件,由于可以一次发给多个人,所以传入一个list,邮件正文是一个stras_string()mimetext对象变成str

经过header对象编码的文本,包含utf-8编码信息和base64编码的文本。

以下是一个使用 python 发送邮件简单的实例:

import smtplib
from email.mime.text import mimetext
from email.header import header
 
sender = 'from@runoob.com'
receivers = ['429240967@qq.com']  # 接收邮件,可设置为你的qq邮箱或者其他邮箱
 
# 三个参数:第一个为文本内容,第二个 plain 设置文本格式,第三个 utf-8 设置编码
message = mimetext('python 邮件发送测试内容...', 'plain', 'utf-8')
message['from'] = header("菜鸟教程", 'utf-8')   # 发送者
message['to'] =  header("测试", 'utf-8')        # 接收者
message['subject'] = header('python smtp 邮件测试主题', 'utf-8')
 
try:
    smtpobj = smtplib.smtp('localhost')
    smtpobj.sendmail(sender, receivers, message.as_string())
    print "邮件发送成功"
except smtplib.smtpexception:
    print "error: 无法发送邮件"

2、使用第三方 smtp 服务

如果我们本机没有 sendmail 访问,也可以使用其他邮件服务商的 smtp 访问(qq、网易、google等)。

login()方法用来登录smtp服务器

发收件件人的名字没有显示为友好的名字,比如mr green 

使用 formataddr方法来格式化一个邮件地址。如果包含中文,需要通过header对象进行编码。

msg['to']接收的是字符串而不是list,如果有多个邮件地址,用,分隔即可。

import smtplib
from email.mime.text import mimetext
from email.utils import formataddr

# 第三方 smtp 服务
mail_host = "mail.sss.com"  # 设置服务器
mail_user = "it_system@sss.com"  # 用户名
mail_pass = "ssss201709#"  # 口令

sender = 'it_system@tcl.com'
receivers = 'sss.yang@tcsssl.com'  # 接收邮件,可设置为你的qq邮箱或者其他邮箱

message = mimetext('python 邮件内容测试...', 'plain', 'utf-8')
message['from'] = formataddr(('scbc-啊it',   sender))
message['to'] = formataddr(('杨生', receivers))
message['subject'] = 'python smtp 邮件测试'

try:
    smtpobj = smtplib.smtp()
    smtpobj.connect(mail_host, 25)  # 25 为 smtp 端口号
    smtpobj.login(mail_user, mail_pass)
    smtpobj.sendmail(sender, receivers, message.as_string())
    print("邮件发送成功")
except smtplib.smtpexception:
    print("error: 无法发送邮件")

3、使用python发送html格式的邮件

python在构造mimetext对象时,把html字符串传进去,再把第二个参数由plain变为html就可以了:

具体代码如下:

mail_msg = """
python 邮件内容测试...


这是一个链接


"""
message = mimetext(mail_msg, 'html', 'utf-8')

4、python 发送带附件的邮件

带附件的邮件可以看做包含若干部分的邮件:文本和各个附件本身,所以,可以构造一个mimemultipart对象代表邮件本身,然后往里面加上一个mimetext作为邮件正文,再继续往里面加上表示附件的mimebase对象即可。

发送带附件的邮件,首先要创建mimemultipart()实例,然后构造附件,如果有多个附件,可依次构造,最后利用smtplib.smtp发送。

from email.mime.multipart import mimemultipart

# 创建一个带附件的实例
message = mimemultipart()

message['from'] = formataddr(('scbc-啊it', sender))
message['to'] = formataddr(('杨生', receivers))
message['subject'] = 'python smtp 邮件测试'

mail_msg = """
python 邮件内容测试...


这是一个链接


"""
# 邮件正文内容
message.attach(mimetext(mail_msg, 'html', 'utf-8'))

# 构造附件1,传送当前目录下的 test.txt 文件
att = mimetext(open('32.txt', 'rb').read(), 'base64', 'utf-8')
att["content-type"] = 'application/octet-stream'
# 这里的filename可以任意写,写什么名字,邮件中显示什么名字
att["content-disposition"] = 'attachment; filename="32.txt"'
message.attach(att)

5、在 html 文本中添加图片

要把图片嵌入到邮件正文中,我们只需按照发送附件的方式,先把邮件作为附件添加进去,然后,在html中通过引用src="cid:0"就可以把附件作为图片嵌入了。如果有多个图片,给它们依次编号,然后引用不同的cid:x即可。

邮件的 html 文本中一般邮件服务商添加外链是无效的,正确添加图片的实例如下所示:

from email.mime.multipart import mimemultipart
from email.mime.image import mimeimage

# 创建一个带附件的实例
message = mimemultipart()

message['from'] = formataddr(('scbc-啊it', sender))
message['to'] = formataddr(('杨生', receivers))
message['subject'] = 'python smtp 邮件测试'

mail_msg = """
python 邮件内容测试...


这是一个链接


图片演示:





"""
# 邮件正文内容
message.attach(mimetext(mail_msg, 'html', 'utf-8'))

# 指定图片为当前目录
with  open('a.jpg', 'rb') as fp:
    msgimage = mimeimage(fp.read())

# 定义图片 id,在 html 文本中引用
msgimage.add_header('content-id', '')
message.attach(msgimage)

或者通过mimebase来添加图片

# 指定图片为当前目录
with  open('a.jpg', 'rb') as fp:
    # 设置附件的mime和文件名,这里是png类型:
    mime = mimebase('image', 'jpg', filename='a.jpg')
    # 加上必要的头信息:
    mime.add_header('content-disposition', 'attachment', filename='附件显示名称.jpg')
    mime.add_header('content-id', '')  # 如果有多个文件需要使用.format(index)
    mime.add_header('x-attachment-id', '0')  # 如果有多个文件需要使用.format(index)
    # 把附件的内容读进来:
    mime.set_payload(fp.read())
    # 用base64编码:
    encoders.encode_base64(mime)
    # 添加到mimemultipart:
    message.attach(mime)

6、同时支持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('hello', 'html', 'utf-8'))
# 正常发送msg对象...

7、加密smtp

使用标准的25端口连接smtp服务器时,使用的是明文传输,发送邮件的整个过程可能会被窃听。要更安全地发送邮件,可以加密smtp会话,实际上就是先创建ssl安全连接,然后再使用smtp协议发送邮件。

某些邮件服务商,例如gmail,提供的smtp服务必须要加密传输。我们来看看如何通过gmail提供的安全smtp发送邮件。

只需要在创建smtp对象后,立刻调用starttls()方法,就创建了安全连接。后面的代码和前面的发送邮件代码完全一样。

必须知道,gmail的smtp端口是587,因此,修改代码如下:

smtp_server = 'smtp.gmail.com'
smtp_port = 587
server = smtplib.smtp(smtp_server, smtp_port)
server.starttls()
# 剩下的代码和前面的一模一样:
server.set_debuglevel(1)

三、使用poplib接收邮件

收取邮件就是编写一个mua作为客户端,从mda把邮件获取到用户的电脑或者手机上。收取邮件最常用的协议是pop协议,目前版本号是3,俗称pop3

python内置一个poplib模块,实现了pop3协议,可以直接用来收邮件。

pop3 的命令和响应数据都是基于 ascii 文本的,并以 cr 和 lf(/r/n) 作为行结束符,响应数据包括一个表示返回状态的符号(+/)和描述信息。

请求和响应的标准格式如下:

请求标准格式:命令 [参数] crlf
响应标准格式:+ok /[-err] description crlf

pop3 协议客户端的命令和服务器端对应的响应数据如下:

  • user name:向 pop 服务器发送登录的用户名。
  • pass string:向 pop 服务器发送登录的密码。
  • quit:退出 pop 服务器。
  • stat:统计邮件服务器状态,包括邮件数和总大小。
  • list [msg_no]:列出全部邮件或指定邮件。返回邮件编号和对应大小。
  • retr msg_no:获取指定邮件的内容(根据邮件编号来获取,编号从 1 开始)。
  • dele msg_no:删除指定邮件(根据邮件编号来删除,编号从 1 开始)。
  • noop:空操作。仅用于与服务器保持连接。
  • rset:用于撤销 dele 命令。

poplib 模块完全模拟了上面命令,poplib.pop3 或 poplib.pop3_ssl 为上面命令提供了相应的方法,开发者只要依次使用上面命令即可从服务器端下载对应的邮件

注意到pop3协议收取的不是一个已经可以阅读的邮件本身,而是邮件的原始文本,这和smtp协议很像,smtp发送的也是经过编码后的一大段文本。

要把pop3收取的文本变成可以阅读的邮件,还需要用email模块提供的各种类来解析原始文本,变成可阅读的邮件对象。

所以,收取邮件分两步:

第一步:使用poplib.pop3 或 poplib.pop3_ssl 按 pop3 协议把邮件的原始文本下载到本地;

用pop3获取邮件其实很简单,要获取所有邮件,只需要循环使用retr()把每一封邮件内容拿到即可。真正麻烦的是把邮件的原始内容解析为可以阅读的邮件对象。

import poplib
from email.parser import parser
# email.parser 解析电子邮件,返回这个对象的email.message.message实例
from email.header import decode_header
from email.utils import parseaddr

# 服务器及用户信息
host = 'mail.tcl.com'
username = 'bobin.yang@tcl.com'
password = 'ybb7654321'

# 连接到pop3服务器
conn = poplib.pop3_ssl(host)
# 注意qq邮箱使用ssl连接
# 设置调试模式,可以看到与服务器的交互信息
conn.set_debuglevel(1)

# 打印pop3服务器的欢迎文字
print(conn.getwelcome().decode("utf-8"))

# 身份认证
conn.user(username)
conn.pass_(password)

# 获取服务器上信件信息,返回一个列表,第一项是一共有多少封邮件,第二项是共有多少字节
# stat()返回邮件数量和占用空间
mail_total, total_size = conn.stat()
print('message: %s.size:%s' % (mail_total, total_size))

# list()返回(response, ['mesg_num octets', ...], octets),第二项是编号
resp, mails, octets = conn.list()
print(mails)
# 返回的列表类似[b'1 82923', b'2 2184', ...]

# 获取最新一封邮件,注意索引号从1开始
# pop3.retr(which) 检索序号which的这个邮件,然后设置他的出现标志 返回(response, ['line', ...], octets)这个三元组
resp, lines, ocetes = conn.retr(len(mails))
print('lines:', len(lines))
# lines 存储了邮件的原始文本的每一行
# 可以获得整个邮件的原始文本
print("-------------------")

第二步:使用 email.parser.parser或bytesparser 解析邮件内容为消息对象,然后,用适当的形式把邮件内容展示给用户即可。

解析邮件的过程和上一节构造邮件正好相反。

程序在创建 bytesparser(解析字节串格式的邮件数据)或 parser(解析字符串格式的邮件数据)时,必须指定 policy=default;否则,bytesparse 或 parser 解析邮件数据得到的就是过时的 message 对象,,不是新的 emailmessage,处理起来非常不方便。

1、使用 email.parser.parser解析邮件内容为 email.message.message(过时,不推荐)

msg = b'\r\n'.join(lines).decode('utf-8')
# 解析出邮件
msg = parser().parsestr(msg)


# email.parser.parsestr(text, headersonly=false)
# 与parser()方法类似,不同的是他接受一个字符串对象而不是一个类似文件的对象
# 可选的headersonly表示是否在解析玩标题后停止解析,默认为否
# 返回根消息对象

# 编码处理,文本邮件的内容也是str,还需要检测编码,否则,非utf-8编码的邮件都无法正常显示
def guess_charset(msg):
    charset = msg.get_charset()  # 从msg对象获取编码
    if charset is none:
        content_type = msg.get('content-type', '').lower()  # 如果获取不到,再从content—type字段获取
        if 'charset' in content_type:
            charset = content_type.split('charset=')[1].strip()
            return charset
    return charset


# 数据解码,邮件的subject或者email中包含的名字都是经过编码后的str,要正常显示,就必须decode
def decode_str(s):
    value, charset = decode_header(s)[0]  # 数据,数据编码方式,from email.header import decode_header
    # decode_header()返回一个list,因为像cc、bcc这样的字段可能包含多个邮件地址,所以解析出来的会有多个元素。上面的代码我们偷了个懒,只取了第一个元素。
    if charset:
        value = value.decode(charset)
    return value


# print_ingo函数:解析邮件与构造邮件的步骤正好相反
def print_info(msg, indent=0):  # indent用于缩进显示
    if indent == 0:
        for header in ['from', 'to', 'subject']:  # 邮件的from、to、subject存在于根对象上
            value = msg.get(header, '')
            if value:
                if header == 'subject':
                    value = decode_str(value)  # 需要解码subject字符串
                else:
                    # 解码mail地址
                    hdr, addr = parseaddr(value)
                    name = decode_str(hdr)
                    value = '%s' % addr
            print('%s:  %s  %s' % (header, value, name))
            print('-*-' * 20)
    if msg.is_multipart():
        # 如果邮件对象是一个is_multipart,get_payload()返回一个list,包含所有子对象
        parts = msg.get_payload()  # 循环获得列表项
        for n, part in enumerate(parts):
            # print('%spart %s' % ('  ' * indent, n))
            # print('%s------------' % ('  ' * indent))
            # 递归打印没一个子对象
            print_info(part, indent + 1)
    else:
        # 邮件对象不是一个is_multipart,就根据content_type判断
        content_type = msg.get_content_type()  # 数据类型
        if content_type == 'text/plain' or content_type == 'text/html':  # 纯文本 html文本
            # 纯文本或html内容
            content = msg.get_payload(decode=true)  # 获得文本对象的字符串而非对象本身
            charset = guess_charset(msg)  # 要检测文本编码
            if charset: content = content.decode(charset)
            content = '%s' % (content)
            print(content)  # 获取邮件文本内容,如果只有文本,打印显示的结果和邮件中看的效果一模一样
        else:
            print(content_type+'不是文本')


print_info(msg, 0)

# 退出
conn.quit()

2、使用email.parser.bytesparser 解析成email.message.emailmessage对象

如果程序要获取邮件的发件人、收件人和主题,直接通过 emailmessage 的相应属性来获取即可,与前面为 emailmessage 设置发件人、收件人和主题的方式是对应的。
如果程序要读取 emailmessage 的各部分,则需要调用该对象的 walk() 方法,该方法返回一个可迭代对象,程序使用 for 循环遍历 walk() 方法的返回值,对邮件内容进行逐项处理:

  • 如果邮件某项的 maintype 是 'multipart',则说明这一项是容器,用于包含邮件内容、附件等其他项。
  • 如果邮件某项的 maintype 是 'text',则说明这一项的内容是文本,通常就是邮件正文或文本附件。对于这种文本内容,程序直接将其输出到控制台中。
  • 如果邮件某项的 maintype 是其他,则说明这一项的内容是附件,程序将附件内容保存在本地文件中。
import os
import poplib
import mimetypes
from email.parser import parser, bytesparser
from email.policy import default

msg_data = b'\r\n'.join(lines)
# 将字符串内容解析成邮件,此处一定要指定policy=default
msg = bytesparser(policy=default).parsebytes(msg_data)
print(type(msg))

print('发件人:' + msg['from'])
print('收件人:' + msg['to'])
print('主题:' + msg['subject'])
print('第一个收件人名字:' + msg['to'].addresses[0].username)
print('第一个发件人名字:' + msg['from'].addresses[0].username)
for part in msg.walk():
    counter = 1
    # 如果maintype是multipart,说明是容器(用于包含正文、附件等)
    if part.get_content_maintype() == 'multipart':
        continue
    # 如果maintype是multipart,说明是邮件正文部分
    elif part.get_content_maintype() == 'text':
        print(part.get_content())
    # 处理附件
    else:
        # 获取附件的文件名
        filename = part.get_filename()
        # 如果没有文件名,程序要负责为附件生成文件名
        if not filename:
            # 根据附件的contnet_type来推测它的后缀名
            ext = mimetypes.guess_extension(part.get_content_type())
            # 如果推测不出后缀名
            if not ext:
                # 使用.bin作为后缀名
                ext = '.bin'
            # 程序为附件来生成文件名
            filename = 'part-%03d%s' % (counter, ext)
        counter += 1
        # 将附件写入的本地文件
        with open(os.path.join('.', filename), 'wb') as fp:
            fp.write(part.get_payload(decode=true))
# 退出服务器,相当于发送pop 3的quit命令
conn.quit()

四、利用imaplib读取邮件文本内容及附件内容

通过imap协议来管理邮箱用的,称作交互邮件访问协议。

! encoding:utf8
'''
环境:
    win10 64位 python 2.7.5
参考:
    http://www.pythonclub.org/python-network-application/email-format
    http://blog.sina.com.cn/s/blog_4deeda2501016eyf.html
'''


import imaplib
import email


def parseheader(message):
    """ 解析邮件首部 """
    subject = message.get('subject')  
    h = email.header.header(subject)
    dh = email.header.decode_header(h)
    subject = unicode(dh[0][0], dh[0][1]).encode('gb2312')
    # 主题
    print subject
    print '
'
    # 发件人
    print 'from:', email.utils.parseaddr(message.get('from'))[1]
    print '
'
    # 收件人
    print 'to:', email.utils.parseaddr(message.get('to'))[1]
    print '
'
    # 抄送人
    print 'cc:',email.utils.parseaddr(message.get_all('cc'))[1]



def parsebody(message):
    """ 解析邮件/信体 """
    # 循环信件中的每一个mime的数据块
    for part in message.walk():
        # 这里要判断是否是multipart,是的话,里面的数据是一个message 列表
        if not part.is_multipart():
            charset = part.get_charset()
            # print 'charset: ', charset
            contenttype = part.get_content_type()
            # print 'content-type', contenttype
            name = part.get_param("name") #如果是附件,这里就会取出附件的文件名
            if name:
                # 有附件
                # 下面的三行代码只是为了解码象=?gbk?q?=cf=e0=c6=ac.rar?=这样的文件名
                fh = email.header.header(name)
                fdh = email.header.decode_header(fh)
                fname = dh[0][0]
                print '附件名:', fname
                # attach_data = par.get_payload(decode=true) # 解码出附件数据,然后存储到文件中

                # try:
                #     f = open(fname, 'wb') #注意一定要用wb来打开文件,因为附件一般都是二进制文件
                # except:
                #     print '附件名有非法字符,自动换一个'
                #     f = open('aaaa', 'wb')
                # f.write(attach_data)
                # f.close()
            else:
                #不是附件,是文本内容
                print part.get_payload(decode=true) # 解码出文本内容,直接输出来就可以了。
                # pass
            # print '+'*60 # 用来区别各个部分的输出


def getmail(host, username, password, port=993):
    try:
        serv = imaplib.imap4_ssl(host, port)
    except exception, e:
        serv = imaplib.imap4(host, port)

    serv.login(username, password)
    serv.select()
    # 搜索邮件内容
    typ, data = serv.search(none, '(from "xx@xxx.com")')

    count = 1
    pcount = 1
    for num in data[0].split()[::-1]:
        typ, data = serv.fetch(num, '(rfc822)')
        text = data[0][1]
        message = email.message_from_string(text)   # 转换为email.message对象
        parseheader(message)
        print '
'
        parsebody(message)   
        pcount += 1
        if pcount > count:
            break

    serv.close()
    serv.logout()


if __name__ == '__main__':
    host = "imap.mail_serv.com" # "pop.mail_serv.com"
    username = "trevor@mail_serv.com"
    password = "your_password"
    getmail(host, username, password)

到此这篇关于python收发邮件的文章就介绍到这了。希望对大家的学习有所帮助,也希望大家多多支持。

《Python网络编程之使用email、smtplib、poplib、imaplib模块收发邮件.doc》

下载本文的Word格式文档,以方便收藏与打印。