自动发送邮件功能

Python自带的发送邮件功能
- 1.发送邮件正文
- 2.发送带附件的邮件
用yagmail发送邮件
整合自动发送邮件功能

自动发送邮件功能是自动化测试项目的重要需求之一，当自动化测试用例运行完成之后，可自动向相关人员的邮箱发送测试报告。严格来讲，这里介绍的发送邮件模块并不属于unittest的扩展，不过，我们仍然可以将它与unittest结合使用。
SMTP（Simple Mail Transfer Protocol）是简单邮件传输协议，是一组由源地址到目的地址传送邮件的规则，可以控制信件中的中转方式。Python的smtplib模块提供了简单的API用来实现发送邮件功能，它对SMTP进行了简单的封装。
在实现发送邮件功能之前，需要补充一个基础知识。在给其他人发送邮件之前，首先需要有一个自己的邮箱。通过浏览器打开邮箱网址（如 https://mail.qq.com/ ），或打开邮箱客户端（如 Foxmail），登录自己的邮箱账号。如果是邮箱客户端，则还需要配置邮箱服务器地址（如 smtp.qq.com）。然后填写收件人地址、邮件的主题和正文，以及添加附件等。即便通过Python实现发送邮件功能，也需要设置这些信息。

Python自带的发送邮件功能

在发送邮件时，除填写主题和正文外，还可以添加抄送人、添加附件等。这里我们分别把测试报告作为正文和附件进行发送。

1.发送邮件正文

  import smtplib
  from email.mime.text import MIMEText
  from email.header import Header
  
  # 发送邮件主题
  subject = 'Python email test'
  
  # 编写HTML类型的邮件正文
  msg = MIMEText('<html><h1>你好！</h1></html>','html','utf-8')
  msg['Subject'] = Header(subject,'utf-8')
  
  # 发送邮件
  smtp = smtplib.SMTP()
  smtp.connect('smtp.qq.com') # 阿里云企业邮箱：mxhichina
  smtp.login('sender@qq.com','password')
  smtp.sendmail('sender@qq.com','receiver@qq.com',msg.as_string())
  smtp.quit()

首先，调用email模块下面的MIMEText类，定义发送邮件的正文、格式，以及编码。
然后，调用email模块下面的Header类，定义邮件的主题和编码类型。
smtplib模块用于发送邮件。connect()方法指定连接的邮箱服务；login()方法指定登录邮箱的账号和密码；sendmail()方法指定发件人，收件人，以及邮件的正文；quit()方法用于关闭邮箱服务器的连接。

2.发送带附件的邮件

  import smtplib
  from email.mime.text import MIMEText
  from email.mime.multipart import MIMEMultipart
  
  # 邮件主题
  subject = 'Python send email test'
  
  # 发送的附件
  with open('log.txt','rb') as f:
      send_att = f.read()

  att = MIMEText(send_att,'text','utf-8')
  att['Content-Type'] = 'application/octet-stream'
  att['Content-Disposition'] = 'attachment;filename-"log.txt"'

  msg = MIMEMultipart()
  msg['Subject'] = subject
  msg.attach(att)

  # 发送邮件
  smtp = smtplib.SMTP()
  smtp.connect('smtp.qq.com') # 阿里云企业邮箱：mxhichina
  smtp.login('sender@qq.com','password')
  smtp.sendmail('sender@qq.com','receiver@qq.com',msg.as_string())
  smtp.quit()

带附件的邮件要稍微复杂一些。
首先，读取附件的内容。通过MIMEText类，定义发送邮件的正文格式，以及编码；Content-Type指定附件内容类型；application/octet-stream表示二进制流；Content-Disposition指定显示附件文件；attachment;filename-"log.txt"指定附件的文件名。
然后，使用MIMEMultipart类定义邮件的主题，attach()指定附件信息。
最后，通过smtplib模块发送邮件，发送过程与第一个例子相同。

用yagmail发送邮件

yagmail是Python的一个第三方库，可以让我们以非常简单的方法实现自动发送邮件功能。
GitHub项目地址：https://github.com/kootenpv/yagmail

通过pip命令安装。

  pip install yagmail

项目文档提供了的简单发送邮件的例子。

  import yagmail

  # 连接
  yag = yagmail.SMTP(user='sender@qq.com',password='password',host='smtp.qq.com')

  # 邮件正文
  contents = ['This is the body, and here is just text http://somedomain/image.png', 'You can find an audio file attached.', '/local/path/song.mp3']

  # 发送邮件
  yag.send('receiver@qq.com', 'subject', contents)

  yag.close()  # Don't forget to close the server

总共五行代码，是不是比上面的例子简单太多了。有了前面的基础，这里的代码就不需要做过多解释了。

如果想给多个用户发送邮件，那么只需把收件人放到一个list中即可。

  yag.send('["receiver@qq.com","receiver2@qq.com",""receiver3@qq.com""]', 'subject', contents)

如果想发送带附件的邮件，那么只需指定本地附件的路径即可。

  yag.send('receiver@qq.com', subject, contents, ['d://log.txt','d://onepiece_img.jpg'])

另外，还可以通过list指定多个附件。yagmail库极大地简化了发送邮件的代码。

整合自动发送邮件功能

在学习了如何用Python实现发送邮件之后，现在只需将功能集成到自动化测试项目中即可。
打开run_tests.py文件，修改代码如下。

  import time
  import unittest
  import yagmail
  from HTMLTestRunner import HTMLTestRunner
  
  # 把测试报告作为附件发送到指定邮箱
  def send_email(report):
      yag = yagmail.SMTP(user='sender@qq.com',password='password',host='smtp.qq.com')
      subject = '主题，自动化测试报告'
      contents = '正文，请查看附件。'
      yag.send('receiver@qq.com', 'subject', contents, report) # 发送附件
      print('email has send out !')

  if __name__ == '__main__':
      # 定义测试用例的目录为当前目录
      test_dir = './test_case'
      suit = unittest.defaultTestLoader.discover(test_dir,pattern='test_*.py')
      
      # 获取当前日期和时间
      now_time = time.strftime('%Y-%m-%d %H_%M_%S')
      html_report = './test_report/' + now_time + 'result.html'
      fp = open(html_report,'wb')
      
      # 调用HTMLTestRunner，运行测试用例
      runner = HTMLTestRunner(stream=fp,title='测试报告',description='运行环境：Windows 10,Chrome浏览器')
      runner.run(suit)
      fp.close()
      send_email(html_report) # 发送报告

整个程序的执行过程可以分为两部分：

定义测试报告文件，并赋值给变量 html_report，通过HTMLTestRunner运行测试用例，将结果写入文件后关闭。
调用 send_email() 函数，并传入html_report文件。在send_email()函数中，把测试报告作为邮件的附件发送到指定邮箱。

为什么不把测试报告的内容读取出来作为邮件正文发送呢？
因为HTMLTestRunner报告在展示时引用了Bootstrap样式库，当作为邮件正文“写死”在邮件中时，会导致样式丢失，所以作为附件发送更为合适。