exchangelib

exchangelib 是一个用于操作 Exchange 邮箱的第三方库，其接口设计简单易用。类库现有功能如下：

  • 服务器自动发现( autodiscover )
  • 对象搜索( searching )
  • 对象创建( creating )
  • 对象更新( updating )
  • 对象发送( sending )
  • 对象删除( deleting )
  • etc

抢先一览

下面这个例子仅用若干行代码便实现了打印输出收件箱前 100 封邮件：

  1. from exchangelib import Credentials, Account
  2.  
  3. credentials = Credentials('john@example.com', 'topsecret')
  4. account = Account('john@example.com', credentials=credentials, autodiscover=True)
  5.  
  6. for item in account.inbox.all().order_by('-datetime_received')[:100]:
  7.         print(item.subject, item.sender, item.datetime_received)

可以看到，将邮箱账号和密码传给 exchangelib 之后，即可通过简单的操作函数完成各种不可以思议的操作！

安装

开始使用 exchangelib 之前，你需要先装好它。推荐从 PYPI 安装：

  1. $ pip install exchangelib

默认的安装版本不支持 Kerberos 。如果实在需要 Kerberos ，可以安装带 Kerberos 依赖的版本：

  1. $ pip install exchangelib[kerberos]

想要安装最新的代码，则可以直接从 Github 安装：

  1. $ pip install git+https://github.com/ecederstrand/exchangelib.git

警告

最新的代码可能不太稳定，在生产中使用需要谨慎测试验证。

此外，由于 exchangelib 用到 lxml 包以及用以支持 Kerberos 认证的 pykerberos 包，你可能需要装一些额外的系统包，具体方法因操作系统而异。

对于 Debian 系列系统：

  1. $ apt-get install libxml2-dev libxslt1-dev
  2.  
  3. $ # For Kerberos support, also install these:
  4. % apt-get install libkrb5-dev build-essential libssl-dev libffi-dev python-dev

对于 CentOS 系列系统：

  1. $ # For Kerberos support, install these:
  2. $ yum install gcc python-devel krb5-devel krb5-workstation python-devel

发送邮件

发送邮件只需初始化 Message 对象并调用 send 方法即可：

  1. from exchangelib import Message
  2.  
  3. message = Message(
  4.     account=account,
  5.     subject='测试主题',
  6.     body='这是一封测试邮件',
  7.     to_recipients=(
  8.         'jim@example.com',
  9.     ),
  10. )
  11. message.send()

其中， account 参数是账号授权信息，抢先一览小节已介绍过；subject 为邮件主题； body 为邮件体；to_recipients 指定收件人列表。

抄送、密送

抄送 收件人列表通过 cc_recipients 参数指定：

  1. message = Message(
  2.     account=account,
  3.     subject='测试主题',
  4.     body='这是一封测试邮件',
  5.     to_recipients=(
  6.         'jim@example.com',
  7.     ),
  8.     cc_recipients=(
  9.         'another-one@example.com',
  10.     ),
  11. )

类似地， 密送 收件人通过 bcc_recipients 参数指定：

  1. message = Message(
  2.     account=account,
  3.     subject='测试主题',
  4.     body='这是一封测试邮件',
  5.     to_recipients=(
  6.         'jim@example.com',
  7.     ),
  8.     bcc_recipients=(
  9.         'another-one@example.com',
  10.     ),
  11. )

HTML邮件

邮件一般不局限于纯文本，可以用 HTML 编写格式丰富的内容：

  1. from exchangelib import HTMLBody
  2.  
  3. html = '<html><body>Hello happy <blink>OWA user!</blink></body></html>'
  4. message = Message(
  5.     account=account,
  6.     subject='测试主题',
  7.     body=HTMLBody(html),
  8.     to_recipients=(
  9.         'jim@example.com',
  10.     ),
  11. )

发送附件

发送附件需要初始化 FileAttachment 对象，指定文件名以及文件内容，并通过 Message 对象 attach 方法附着到邮件上：

  1. from exchangelib import FileAttachment
  2.  
  3. logo_filename = 'logo.png'
  4. with open(logo_filename, 'rb') as f:
  5.     logo = FileAttachment(
  6.         filename=logo_filename,
  7.         content=f.read(),
  8.     )
  9. message.attach(logo)
  10. message.send()

内嵌附件图片

附件图片可以嵌到 HTML 邮件体中进行展示。此时，需要为附件指定一个 CID ，以便在 HTML 中引用：

  1. logo_filename = 'logo.png'
  2. with open(logo_filename, 'rb') as f:
  3.     logo = FileAttachment(
  4.         filename=logo_filename,
  5.         content=f.read(),
  6.         content_id=logo_filename,
  7.     )
  8. message.attach(logo)
  9. message.body = HTMLBody('<html><body>Hello logo: <img src="cid:%s"></body></html>' % (logo_filename,))
  10. message.send()

下一步

订阅更新，获取更多学习资料，请关注我们的 微信公众号 ：

../_images/wechat-mp-qrcode.png小菜学编程

参考文献