Python 自动化指南（繁琐工作自动化）第二版：十八发送电子邮件和短信

Posted 2023-04-04 布客飞龙

原文：https://automatetheboringstuff.com/2e/chapter18/

检查和回复电子邮件是一项巨大的时间消耗。当然，你不能只写一个程序来帮你处理所有的邮件，因为每封邮件都需要它自己的回应。但是，一旦你知道如何编写可以发送和接收电子邮件的程序，你仍然可以自动完成大量与电子邮件相关的任务。

例如，您可能有一个充满客户记录的电子表格，并希望根据每个客户的年龄和位置信息向他们发送不同的套用信函。商业软件可能无法为你做到这一点；幸运的是，您可以编写自己的程序来发送这些电子邮件，从而节省大量复制和粘贴表单电子邮件的时间。

你也可以编写程序，发送电子邮件和短信通知你，即使你不在电脑旁。如果你正在自动化一个需要几个小时才能完成的任务，你不会想每隔几分钟就回到你的电脑前检查程序的状态。相反，该程序可以在完成后给你的手机发短信——让你在离开电脑时专注于更重要的事情。

本章介绍了 EZGmail 模块，这是一种从 Gmail 帐户发送和阅读电子邮件的简单方法，以及一个使用标准 SMTP 和 IMAP 电子邮件协议的 Python 模块。

警告

我强烈建议你为任何发送或接收电子邮件的脚本设置一个单独的电子邮件帐户。这将防止程序中的错误影响您的个人电子邮件帐户（例如，通过删除电子邮件或意外发送垃圾邮件给您的联系人）。最好先做一次预演，注释掉实际发送或删除电子邮件的代码，并用一个临时的print()调用来替换它。这样你可以在真正运行程序之前测试它。

使用 Gmail API 发送和接收电子邮件

Gmail 拥有将近三分之一的电子邮件客户端市场份额，你很可能至少有一个 Gmail 电子邮件地址。由于额外的安全和反垃圾邮件措施，通过 EZGmail 模块比通过smtplib和imapclient更容易控制 Gmail 帐户，这将在本章稍后讨论。EZGmail 是我编写的一个模块，它工作在官方 Gmail API 之上，并提供了一些功能，使从 Python 使用 Gmail 变得很容易。你可以在asweigart/ezgmail找到 EZGmail 的全部细节。EZGmail 不是由谷歌制作的，也不隶属于谷歌；在developers.google.com/gmail/api/v1/reference找到 Gmail API 官方文档。

要安装 EZGmail，在 Windows 上运行pip install --user --upgrade ezgmail（或者在 MacOS 和 Linux 上使用pip3）。--upgrade选项将确保您安装最新版本的软件包，这是与不断变化的在线服务（如 Gmail API）交互所必需的。

启用 Gmail API

在你写代码之前，你必须先在 Gmail 注册一个 Gmail 邮箱账户。然后，转到developers.google.com/gmail/api/quickstart/python，点击页面上的启用 Gmail API 按钮，并填写出现的表单。

填写完表单后，页面会显示一个指向credentials.json文件的链接，您需要下载该文件并将其放在与您的py文件相同的文件夹中。credentials.json文件包含客户端 ID 和客户端机密信息，您应该将其视为您的 Gmail 密码，不要与任何人共享。

然后，在交互式 Shell 中，输入以下代码：

>>> import ezgmail, os
>>> os.chdir(r'C:\\path\\to\\credentials_json_file')
>>> ezgmail.init()

确保你将当前的工作目录设置在与credentials.json相同的文件夹中，并且你已经连接到互联网。ezgmail.init()函数将打开您的浏览器，进入谷歌登录页面。输入您的 Gmail 地址和密码。该页面可能会警告你“此应用未经验证”，但这没关系；点击高级，然后进入快速启动 ( 不安全)。（如果你为其他人编写 Python 脚本，并且不希望这个警告对他们出现，你需要了解 Google 的应用验证过程，这超出了本书的范围。）当下一页提示您“Quickstart 想要访问您的 Google 帐户”时，单击允许，然后关闭浏览器。

将生成一个token.json文件，让您的 Python 脚本可以访问您输入的 Gmail 帐户。浏览器只有在找不到现有的token.json文件时才会打开登录页面。有了credentials.json和token.json，你的 Python 脚本可以从你的 Gmail 账户发送和阅读电子邮件，而不需要你在源代码中包含 Gmail 密码。

从 Gmail 账户发送邮件

一旦有了一个token.json文件，EZGmail 模块应该能够通过一个函数调用发送电子邮件：

>>> import ezgmail
>>> ezgmail.send('[e-mail]', 'Subject line', 'Body of the email')

如果您想将文件附加到您的电子邮件中，您可以为send()函数提供一个额外的列表参数：

>>> ezgmail.send('[e-mail]', 'Subject line', 'Body of the email',
['attachment1.jpg', 'attachment2.mp3'])

请注意，作为其安全和反垃圾邮件功能的一部分，Gmail 可能不会重复发送文本完全相同的电子邮件（因为这些很可能是垃圾邮件），或包含exe的电子邮件，或者zip文件附件（因为它们可能是病毒）。

您还可以提供可选的关键字参数cc和bcc来发送副本和密件副本：

>>> import ezgmail
>>> ezgmail.send('[e-mail]', 'Subject line', 'Body of the email',
cc='[e-mail]', bcc='[e-mail],[e-mail]')

如果你需要记住token.json文件是为哪个 Gmail 地址配置的，可以查看ezgmail.EMAIL_ADDRESS。请注意，只有在调用了ezgmail.init()或任何其他 EZGmail 函数之后，才会填充该变量：

>>> import ezgmail
>>> ezgmail.init()
>>> ezgmail.EMAIL_ADDRESS
'[e-mail]'

确保将token.json文件视为与您的密码相同。如果其他人获得了此文件，他们可以访问您的 Gmail 帐户（尽管他们无法更改您的 Gmail 密码）。要撤销之前发布的token.json文件，请前往security.google.com/settings/security/permissions?pli=1和撤销对快速入门应用的访问。您需要运行ezgmail.init()并再次通过登录过程来获得一个新的token.json文件。

从 Gmail 账户中读取邮件

Gmail 将相互回复的电子邮件组织成对话线索。当你通过网络浏览器或应用登录 Gmail 时，你看到的是邮件群，而不是单封邮件（即使邮件群中只有一封邮件）。

EZGmail 有GmailThread和GmailMessage对象分别代表对话线程和个人邮件。一个GmailThread对象有一个messages属性，它保存了一个GmailMessage对象的列表。unread()函数返回所有未读邮件的GmailThread对象列表，然后可以将该列表传递给ezgmail.summary()以打印该列表中对话线程的摘要：

>>> import ezgmail
>>> unreadThreads = ezgmail.unread() # List of GmailThread objects.
>>> ezgmail.summary(unreadThreads)
Al, Jon - Do you want to watch RoboCop this weekend? - Dec 09
Jon - Thanks for stopping me from buying Bitcoin. - Dec 09

summary()函数可以方便地显示电子邮件线程的快速摘要，但是要访问特定的消息（和部分消息），您需要检查GmailThread对象的messages属性。messages属性包含组成线程的GmailMessage对象的列表，这些对象具有描述电子邮件的subject、body、timestamp、sender和recipient属性：

>>> len(unreadThreads)
2
>>> str(unreadThreads[0])
"<GmailThread len=2 snippet= Do you want to watch RoboCop this weekend?'>"
>>> len(unreadThreads[0].messages)
2
>>> str(unreadThreads[0].messages[0])
"<GmailMessage from='Al Sweigart <[e-mail]>' to='Jon Doe
<[e-mail]>' timestamp=datetime.datetime(2018, 12, 9, 13, 28, 48)
subject='RoboCop' snippet='Do you want to watch RoboCop this weekend?'>"
>>> unreadThreads[0].messages[0].subject
'RoboCop'
>>> unreadThreads[0].messages[0].body
'Do you want to watch RoboCop this weekend?\\r\\n'
>>> unreadThreads[0].messages[0].timestamp
datetime.datetime(2018, 12, 9, 13, 28, 48)
>>> unreadThreads[0].messages[0].sender
'Al Sweigart <[e-mail]>'
>>> unreadThreads[0].messages[0].recipient
'Jon Doe <[e-mail]>'

与ezgmail.unread()函数类似，ezgmail.recent()函数将返回您 Gmail 帐户中最近的 25 个主题。你可以通过一个可选的maxResults关键字参数来改变这个限制：

>>> recentThreads = ezgmail.recent()
>>> len(recentThreads)
25
>>> recentThreads = ezgmail.recent(maxResults=100)
>>> len(recentThreads)
46

从 Gmail 账户中搜索邮件

除了使用ezgmail.unread()和ezgmail.recent()之外，你还可以搜索特定的电子邮件，就像你在搜索框中输入查询一样，通过调用ezgmail.search():

>>> resultThreads = ezgmail.search('RoboCop')
>>> len(resultThreads)
1
>>> ezgmail.summary(resultThreads)
Al, Jon - Do you want to watch RoboCop this weekend? - Dec 09

前面的search()调用应该产生相同的结果，就好像你在搜索框中输入“机械战警”，如图 18-1 中的所示。

图 18-1：在 Gmail 网站搜索“机械战警”邮件

像unread()和recent()一样，search()函数返回一个GmailThread对象的列表。您还可以将您可以在搜索框中输入的任何特殊搜索操作符传递给search()函数，如下所示：

'label:UNREAD'表示未读邮件

'from:[e-mail]'表示来自[e-mail]的邮件

'subject:hello'表示主题中带有“你好”的电子邮件

'has:attachment'表示带文件附件的邮件

您可以在support.google.com/mail/answer/7190?hl=en查看搜索运营商的完整列表。

从 Gmail 帐户下载附件

GmailMessage对象有一个 attachments 属性，它是消息附件的文件名列表。你可以将这些名字中的任何一个传递给对象的downloadAttachment()方法来下载文件。也可以用downloadAllAttachments()一次性下载全部。默认情况下，EZGmail 会将附件保存到当前工作目录，但是您也可以将一个额外的downloadFolder关键字参数传递给downloadAttachment()和downloadAllAttachments()。例如：

>>> import ezgmail
>>> threads = ezgmail.search('vacation photos')
>>> threads[0].messages[0].attachments
['tulips.jpg', 'canal.jpg', 'bicycles.jpg']
>>> threads[0].messages[0].downloadAttachment('tulips.jpg')
>>> threads[0].messages[0].downloadAllAttachments(downloadFolder='vacat
ion2019')
['tulips.jpg', 'canal.jpg', 'bicycles.jpg']

如果以附件的文件名命名的文件已经存在，下载的附件将自动覆盖它。

EZGmail 包含额外的功能，你可以在asweigart/ezgmail的找到完整的文档。

SMTP

就像 HTTP 是计算机通过互联网发送网页的协议一样，简单邮件传输协议（SMTP） 是用于发送电子邮件的协议。SMTP 规定了在您点按“发送”后，电子邮件应该如何格式化、加密以及在邮件服务器之间中继，以及您的电脑处理的所有其他详细信息。不过，你不需要知道这些技术细节，因为 Python 的smtplib模块将它们简化成了几个函数。

SMTP 只是处理发送电子邮件给他人。另一种不同的协议叫做 IMAP，处理检索发送给你的电子邮件，在第 424 页的 IMAP 中有描述。

除了 SMTP 和 IMAP 之外，当今大多数基于 Web 的电子邮件运营商还采取了其他安全措施来防止垃圾邮件、网络钓鱼和其他恶意电子邮件的使用。这些措施防止 Python 脚本使用smtplib和imapclient模块登录电子邮件帐户。然而，其中许多服务都有 API 和特定的 Python 模块，允许脚本访问它们。本章介绍了 Gmail 的模块。对于其他人，您需要查阅他们的在线文档。

发送电子邮件

您可能熟悉从 Outlook 或 Thunderbird 或通过 Gmail 或 Yahoo Mail 等网站发送电子邮件。不幸的是，Python 并没有像那些服务一样提供给你一个漂亮的图形用户界面。相反，您可以调用函数来执行 SMTP 的每个主要步骤，如下面的交互式 Shell 示例所示。

注

不要在交互 Shell 中输入这个例子；这是行不通的，因为smtp.example.com、[e-mail]、MY_SECRET_PASSWORD、[e-mail]都只是占位符。这段代码只是用 Python 发送电子邮件过程的概述。

>>> import smtplib
>>> smtpObj = smtplib.SMTP('smtp.example.com', 587)
>>> smtpObj.ehlo()
(250, b'mx.example.com at your service, [216.172.148.131]\\nSIZE 35882577\\
n8BITMIME\\nSTARTTLS\\nENHANCEDSTATUSCODES\\nCHUNKING')
>>> smtpObj.starttls()
(220, b'2.0.0 Ready to start TLS')
>>> smtpObj.login('[e-mail]', 'MY_SECRET_PASSWORD')
(235, b'2.7.0 Accepted')
>>> smtpObj.sendmail('[e-mail]', '[e-mail]', 'Subject: So
long.\\nDear Alice, so long and thanks for all the fish. Sincerely, Bob')

>>> smtpObj.quit()
(221, b'2.0.0 closing connection ko10sm23097611pbd.52 - gsmtp')

在接下来的几节中，我们将介绍每个步骤，用您的信息替换占位符，以连接并登录到 SMTP 服务器，发送电子邮件，以及断开与服务器的连接。

连接 SMTP 服务器

如果您曾经设置过 Thunderbird、Outlook 或其他程序来连接到您的电子邮件帐户，您可能会熟悉 SMTP 服务器和端口的配置。这些设置因电子邮件运营商而异，但是在网上搜索你的运营商的 SMTP 设置应该会找到要使用的服务器和端口。

SMTP 服务器的域名通常是您的电子邮件运营商的域名，前面带有smtp.。例如，威瑞森的 SMTP 服务器在smtp.verizon.net。表 18-1 列出了一些常见的电子邮件运营商及其 SMTP 服务器。（端口是一个整数值，几乎总是 587。它由命令加密标准 TLS 使用。）

*表 18-1： 电子邮件运营商及其 SMTP 服务器

运营商	SMTP 服务器域名
Gmail⭐	smtp.gmail.com
Outlook/Hotmail	smtp-mail.outlook.com
YahooMail⭐	smtp.mail.yahoo.com
ATT	http://smpt.mail.att.net （端口 465）
Comcast	smtp.comcast.net
Verizon	incoming.verizon.net (465 端口）
⭐额外的安全措施阻止 Python 使用smtplib模块登录这些服务器。EZGmail 模块可以为 Gmail 帐户绕过这个困难。

一旦您有了电子邮件运营商的域名和端口信息，通过调用smptlib.SMTP()创建一个SMTP对象，将域名作为字符串参数传递，将端口作为整数参数传递。SMTP对象表示一个到 SMTP 邮件服务器的连接，并有发送电子邮件的方法。例如，下面的调用创建了一个SMTP对象，用于连接到一个假想的电子邮件服务器：

>>> smtpObj = smtplib.SMTP('smtp.example.com', 587)
>>> type(smtpObj)
<class 'smtplib.SMTP'>

输入type(smtpObj)会显示在smtpObj中存储了一个SMTP对象。您将需要这个SMTP对象来调用让您登录和发送电子邮件的方法。如果smptlib.SMTP()调用不成功，您的 SMTP 服务器可能不支持端口 587 上的 TLS。在这种情况下，您需要使用smtplib.SMTP_SSL()和端口 465 创建一个SMTP对象。

>>> smtpObj = smtplib.SMTP_SSL('smtp.example.com', 465)

注

如果你没有连接到互联网，Python 会抛出一个socket.gaierror: [Errno 11004] getaddrinfo failed或者类似的异常。

对于您的程序来说，TLS 和 SSL 之间的区别并不重要。您只需要知道您的 SMTP 服务器使用哪种加密标准，这样您就知道如何连接到它。在接下来的所有交互式 Shell 示例中，smtpObj变量将包含一个由smtplib.SMTP()或smtplib.SMTP_SSL()函数返回的SMTP对象。

发送 SMTP“你好”消息

一旦有了SMTP对象，调用其奇怪命名的ehlo()方法向 SMTP 电子邮件服务器“问好”。这个问候语是 SMTP 中的第一步，对于建立与服务器的连接非常重要。你不需要知道这些协议的细节。只要确保在得到SMTP对象后首先调用ehlo()方法，否则后面的方法调用将导致错误。下面是一个ehlo()调用及其返回值的例子：

>>> smtpObj.ehlo()
(250, b'mx.example.com at your service, [216.172.148.131]\\nSIZE 35882577\\
n8BITMIME\\nSTARTTLS\\nENHANCEDSTATUSCODES\\nCHUNKING')

如果返回的元组中的第一项是整数250(SMTP 中“成功”的代码），那么问候成功。

启用 TLS 加密

如果您正在连接到 SMTP 服务器上的端口 587（也就是说，您正在使用 TLS 加密），那么接下来您需要调用starttls()方法。这个必需的步骤为您的连接启用加密。如果您连接到端口 465（使用 SSL），那么加密已经设置好了，您应该跳过这一步。

下面是一个starttls()方法调用的例子：

>>> smtpObj.starttls()
(220, b'2.0.0 Ready to start TLS')

starttls()方法将您的 SMTP 连接置于 TLS 模式。返回值中的220告诉你服务器已经准备好了。

登录 SMTP 服务器

一旦建立了到 SMTP 服务器的加密连接，您就可以通过调用login()方法使用您的用户名（通常是您的电子邮件地址）和电子邮件密码登录。

>>> smtpObj.login('[e-mail]', 'MY_SECRET_PASSWORD')
(235, b'2.7.0 Accepted')

将您的电子邮件地址字符串作为第一个参数，将您的密码字符串作为第二个参数。返回值中的235表示认证成功。Python 针对不正确的密码引发了一个smtplib.SMTPAuthenticationError异常。

警告

在源代码中输入密码时要小心。如果任何人复制了你的程序，他们将可以访问你的电子邮件帐户！调用input()并让用户输入密码是个好主意。每次运行程序时都必须输入密码可能不太方便，但这种方法可以防止您将密码保存在计算机上的未加密文件中，这样黑客或笔记本电脑窃贼就可以很容易地获得密码。

发送邮件

一旦登录到您的电子邮件运营商的 SMTP 服务器，您就可以调用sendmail()方法来实际发送电子邮件。sendmail()方法调用如下所示：

>>> smtpObj.sendmail('[e-mail]
', '[e-mail]', 'Subject: So long.\\nDear Alice, so long and thanks for all the fish.
Sincerely, Bob')

sendmail()方法需要三个参数：

• 字符串形式的电子邮件地址（代表电子邮件的“发件人”地址）
• 字符串形式的收件人电子邮件地址，或者多个收件人的字符串列表（对于“收件人”地址）
• 字符串形式的电子邮件正文

电子邮件正文字符串的开头必须是以'Subject: \\n'开头的电子邮件主题行。'\\n'换行符将电子邮件的主题行与正文分开。

从sendmail()返回的值是一个字典。对于电子邮件传递失败的每个收件人，字典中都会有一个键值对。一个空字典意味着所有的收件人都成功发送了邮件。

断开与 SMTP 服务器的连接

发送完电子邮件后，一定要调用quit()方法。这将断开您的程序与 SMTP 服务器的连接。

>>> smtpObj.quit()
(221, b'2.0.0 closing connection ko10sm23097611pbd.52 - gsmtp')

返回值中的221表示会话结束。

要查看连接和登录服务器、发送电子邮件和断开连接的所有步骤，请参见第 420 页的发送电子邮件。

IMAP

正如 SMTP 是发送电子邮件的协议一样，互联网消息访问协议（IMAP） 规定了如何与电子邮件运营商的服务器通信，以检索发送到您的电子邮件地址的电子邮件。Python 自带了一个imaplib模块，但实际上第三方的imapclient模块更容易使用。本章介绍如何使用 IMAPClient 完整文档在imapclient.readthedocs.io。

模块从 IMAP 服务器下载格式相当复杂的电子邮件。最有可能的是，您希望将它们从这种格式转换成简单的字符串值。pyzmail模块为您完成解析这些电子邮件消息的艰巨工作。你可以在www.magiksys.net/pyzmail找到 PyzMail 的完整文档。

在 Windows 上使用pip install --user -U imapclient==2.1.0和pip install --user -U pyzmail36== 1.0.4从终端窗口安装imapclient和pyzmail（或者在 MacOS 和 Linux 上使用pip3）。附录 A 有如何安装第三方模块的步骤。

使用 IMAP 检索和删除电子邮件

在 Python 中查找和检索电子邮件是一个多步骤的过程，既需要imapclient又需要pyzmail第三方模块。为了给你一个概述，这里有一个完整的例子，登录到 IMAP 服务器，搜索电子邮件，获取它们，然后从中提取电子邮件的文本。

>>> import imapclient
>>> imapObj = imapclient.IMAPClient('imap.example.com', ssl=True)
>>> imapObj.login('[e-mail]', 'MY_SECRET_PASSWORD')
'[e-mail] Jane Doe authenticated (Success)'
>>> imapObj.select_folder('INBOX', readonly=True)
>>> UIDs = imapObj.search(['SINCE 05-Jul-2019'])
>>> UIDs
[40032, 40033, 40034, 40035, 40036, 40037, 40038, 40039, 40040, 40041]
>>> rawMessages = imapObj.fetch([40041], ['BODY[]', 'FLAGS'])
>>> import pyzmail
>>> message = pyzmail.PyzMessage.factory(rawMessages[40041][b'BODY[]'])
>>> message.get_subject()
'Hello!'
>>> message.get_addresses('from')
[('Edward Snowden', '[e-mail]')]
>>> message.get_addresses('to')
[('Jane Doe', '[e-mail]')]
>>> message.get_addresses('cc')
[]
>>> message.get_addresses('bcc')
[]
>>> message.text_part != None
True
>>> message.text_part.get_payload().decode(message.text_part.charset)
'Follow the money.\\r\\n\\r\\n-Ed\\r\\n'
>>> message.html_part != None
True
>>> message.html_part.get_payload().decode(message.html_part.charset)
'<div dir="ltr"><div>So long, and thanks for all the fish!<br><br></div>-
Al<br></div>\\r\\n'
>>> imapObj.logout()

你不必记住这些步骤。在我们详细介绍了每个步骤之后，您可以回到这个概述来刷新您的记忆。

连接到 IMAP 服务器

就像您需要一个SMTP对象来连接到 SMTP 服务器并发送电子邮件一样，您需要一个IMAPClient对象来连接到 IMAP 服务器并接收电子邮件。首先，你需要你的电子邮件运营商的 IMAP 服务器的域名。这将不同于 SMTP 服务器的域名。表 18-2 列出了几家流行的电子邮件运营商的 IMAP 服务器。

表 18-2： 电子邮件运营商及其 IMAP 服务器

运营商	IMAP 服务器域名
Gmail⭐	http://imap.gmail.com
Outlook/Hotmail⭐	imap-mail.outlook.com
YahooMail⭐	imap.mail.yahoo.com
ATT	imap.mail.att.net
Comcast	imap.comcast.net
Verizon	incoming.verizon.net
⭐额外的安全措施阻止 Python 使用imapclient模块登录这些服务器。

一旦有了 IMAP 服务器的域名，调用imapclient.IMAPClient()函数创建一个IMAPClient对象。大多数电子邮件运营商要求 SSL 加密，所以传递ssl=True关键字参数。在交互式 Shell 中输入以下内容（使用您的运营商的域名）:

>>> import imapclient
>>> imapObj = imapclient.IMAPClient('imap.example.com', ssl=True)

在接下来的所有交互式 Shell 示例中，imapObj变量包含一个从imapclient.IMAPClient()函数返回的IMAPClient对象。在这个上下文中，客户端是连接到服务器的对象。

登录 IMAP 服务器

一旦有了一个IMAPClient对象，调用它的login()方法，以字符串的形式传入用户名（这通常是你的电子邮件地址）和密码。

>>> imapObj.login('[e-mail]', 'MY_SECRET_PASSWORD')
'[e-mail] Jane Doe authenticated (Success)'

警告

切记不要将密码直接写入您的代码中！相反，设计您的程序来接受从input()返回的密码。

如果 IMAP 服务器拒绝这个用户名/密码组合，Python 就会引发一个imaplib.error异常。

搜索邮件

一旦你登录，实际上检索你感兴趣的电子邮件是一个两步的过程。首先，您必须选择一个要搜索的文件夹。然后，您必须调用IMAPClient对象的search()方法，传入一串 IMAP 搜索关键字。

选择文件夹

几乎每个账户默认都有一个INBOX文件夹，但是你也可以通过调用IMAPClient对象的list_folders()方法来获得文件夹列表。这将返回一个元组列表。每个元组包含关于单个文件夹的信息。通过输入以下内容继续交互式 Shell 示例：

>>> import pprint
>>> pprint.pprint(imapObj.list_folders())
[(('\\\\HasNoChildren',), '/', 'Drafts'),
 (('\\\\HasNoChildren',), '/', 'Filler'),
 (('\\\\HasNoChildren',), '/', 'INBOX'),
 (('\\\\HasNoChildren',), '/', 'Sent'),
--snip--
 (('\\\\HasNoChildren', '\\\\Flagged'), '/', 'Starred'),
 (('\\\\HasNoChildren', '\\\\Trash'), '/', 'Trash')]

每个元组中的三个值（例如，(('\\\\HasNoChildren',), '/', 'INBOX')）如下所示：

• 文件夹标志的元组。（这些标志具体代表什么超出了本书的范围，您可以放心地忽略这个字段。）
• 名称字符串中用于分隔父文件夹和子文件夹的分隔符。
• 文件夹的全名。

要选择要搜索的文件夹，将文件夹的名称作为字符串传递给IMAPClient对象的select_folder()方法。

>>> imapObj.select_folder('INBOX', readonly=Truehttps://automatetheboringstuff.com/2e/chapter8/
 
 
 
输入验证代码检查用户输入的值，比如来自input()函数的文本，格式是否正确。例如，如果您希望用户输入他们的年龄，您的代码不应该接受无意义的答案，如负数（在可接受的整数范围之外）或单词（这是错误的数据类型）。输入验证还可以防止错误或安全漏洞。如果您实现了一个withdrawFromAccount()函数，该函数接受一个参数作为要从帐户中减去的金额，那么您需要确保该金额是一个正数。如果withdrawFromAccount()函数从账户中减去一个负数，那么“取款”将会增加钱！
 
通常，我们通过反复要求用户输入来执行输入验证，直到他们输入有效文本，如下例所示：
 
while True:
    print('Enter your age:')
    age = input()
    try:
        age = int(age)
    except:
        print('Please use numeric digits.')
        continue
    if age < 1:
        print('Please enter a positive number.')
        continue
    break
print(f'Your age is age.')
 
当您运行此程序时，输出可能如下所示：
 
Enter your age:
five
Please use numeric digits.
Enter your age:
-2
Please enter a positive number.
Enter your age:
30
Your age is 30.
 
当您运行此代码时，系统会提示您输入年龄，直到您输入一个有效的年龄。这确保了当执行离开while循环时，age变量将包含一个不会在以后使程序崩溃的有效值。
 
然而，为程序中的每个input()调用编写输入验证代码很快就变得乏味了。此外，您可能会错过某些情况，并允许无效的输入通过您的检查。在本章中，您将学习如何使用第三方 PyInputPlus 模块进行输入验证。
 
PyInputPlus 模块
 
PyInputPlus 包含类似于input()的函数，用于几种数据：数字、日期、电子邮件地址等等。如果用户输入了无效的输入，比如格式错误的日期或超出预期范围的数字，PyInputPlus 将重新提示用户输入，就像上一节中我们的代码所做的那样。PyInputPlus 还有其他有用的特性，比如限制它重新提示用户的次数，如果要求用户在限定的时间内做出响应，还会超时。
 
PyInputPlus 不是 Python 标准库的一部分，所以必须使用 PIP 单独安装。要安装 PyInputPlus，请从命令行运行pip install --user pyinputplus。附录 A 有安装第三方模块的完整说明。要检查 PyInputPlus 是否安装正确，请在交互式 Shell 中导入它：
 
>>> import pyinputplus
 
如果在导入模块时没有出现错误，则说明该模块已成功安装。
 
PyInputPlus 有几个用于不同类型输入的函数：
 
inputStr()类似于内置的input()函数，但是具有 PyInputPlus 的一般特性。您还可以向它传递一个自定义验证函数
 
inputNum()确保用户输入一个数字并返回一个int或float，这取决于数字中是否有小数点
 
inputChoice()确保用户输入所提供的选项之一
 
inputMenu()类似于inputChoice()，但是提供了一个带有数字或字母选项的菜单
 
inputDatetime()确保用户输入日期和时间
 
inputYesNo()确保用户输入“是”或“否”的回答
 
inputBool()与inputYesNo()类似，但是接受“真”或“假”响应并返回一个布尔值
 
inputEmail()确保用户输入有效的电子邮件地址
 
inputFilepath()确保用户输入有效的文件路径和文件名，并且可以选择性地检查具有该名称的文件是否存在
 
inputPassword()类似于内置的input()，但是在用户输入时显示*字符，这样密码或其他敏感信息就不会显示在屏幕上
 
只要用户输入无效的输入，这些函数就会自动重新提示用户：
 
>>> import pyinputplus as pyip
>>> response = pyip.inputNum()
five
'five' is not a number.
42
>>> response
42
 
每次我们想调用 PyInputPlus 函数时，import语句中的as pyip代码可以避免我们键入pyinputplus。相反，我们可以使用更短的pyip名称。如果你看一下这个例子，你会发现不像input()，这些函数返回一个int或float值：42和3.14，而不是字符串'42'和'3.14'。
 
正如您可以将一个字符串传递给input()来提供提示一样，您也可以将一个字符串传递给 PyInputPlus 函数的prompt关键字参数来显示提示：
 
>>> response = input('Enter a number: ')
Enter a number: 42
>>> response
'42'
>>> import pyinputplus as pyip
>>> response = pyip.inputInt(prompt='Enter a number: ')
Enter a number: cat
'cat' is not an integer.
Enter a number: 42
>>> response
42
 
使用 Python 的help()函数来了解关于这些函数的更多信息。例如，help(pyip.inputChoice)显示inputChoice()函数的帮助信息。完整的文档可以在pyinputplus.readthedocs.io找到。
 
与 Python 的内置input()不同，PyInputPlus 函数有几个额外的输入验证特性，如下一节所示。
 
关键字参数
 
接受int和float数的inputNum()、inputInt()和inputFloat()函数也有用于指定有效值范围的min、max、greaterThan和lessThan关键字参数。例如，在交互式 Shell 中输入以下内容：
 
>>> import pyinputplus as pyip
>>> response = pyip.inputNum('Enter num: ', min=4)
Enter num:3
Input must be at minimum 4.
Enter num:4
>>> response
4
>>> response = pyip.inputNum('Enter num: ', greaterThan=4)
Enter num: 4
Input must be greater than 4.
Enter num: 5
>>> response
5
>>> response = pyip.inputNum('>', min=4, lessThan=6)
Enter num: 6
Input must be less than 6.
Enter num: 3
Input must be at minimum 4.
Enter num: 4
>>> response
4
 
这些关键字参数是可选的，但是如果提供的话，输入不能小于min参数或大于max参数（尽管输入可以等于它们）。同样，输入必须大于greaterThan并且小于lessThan参数（也就是说，输入不能等于它们）。
 
blank关键字参数
 
默认情况下，不允许空白输入，除非blank关键字参数设置为True:
 
>>> import pyinputplus as pyip
>>> response = pyip.inputNum('Enter num: ')
Enter num:(blank input entered here)
Blank values are not allowed.
Enter num: 42
>>> response
42
>>> response = pyip.inputNum(blank=True)
(blank input entered here)
>>> response
''
 
如果你想让输入可选，用户不需要输入任何东西，使用blank=True。
 
limit、timeout和default关键字参数
 
默认情况下，PyInputPlus 函数将永远（或者只要程序运行）继续要求用户输入有效的数据。如果你想让一个函数在一定次数的尝试或一定时间后停止要求用户输入，你可以使用关键字参数limit和timeout。为limit关键字参数传递一个整数，以确定 PyInputPlus 函数在放弃之前尝试接收有效输入的次数，为timeout关键字参数传递一个整数，以确定在 PyInputPlus 函数放弃之前用户必须输入有效输入的秒数。
 
如果用户未能输入有效的输入，这些关键字参数将导致函数分别引发一个RetryLimitException或TimeoutException。例如，在交互式 Shell 中输入以下内容：
 
>>> import pyinputplus as pyip
>>> response = pyip.inputNum(limit=2)
blah
'blah' is not a number.
Enter num: number
'number' is not a number.
Traceback (most recent call last):
    --snip--
pyinputplus.RetryLimitException
>>> response = pyip.inputNum(timeout=10)
42 (entered after 10 seconds of waiting)
Traceback (most recent call last):
    --snip--
pyinputplus.TimeoutException
 
当您使用这些关键字参数并传递一个default关键字参数时，该函数将返回默认值，而不是引发异常。在交互式 Shell 中输入以下内容：
 
>>> response = pyip.inputNum(limit=2, default='N/A')
hello
'hello' is not a number.
world
'world' is not a number.
>>> response
'N/A'
 
inputNum()函数只是返回字符串'N/A'，而不是引发RetryLimitException。
 
allowRegexes和blockRegexes关键字参数
 
您还可以使用正则表达式来指定是否允许输入。allowRegexes和blockRegexes关键字参数采用正则表达式字符串列表来确定 PyInputPlus 函数将接受或拒绝哪些有效输入。例如，在交互式 Shell 中输入以下代码，以便inputNum()除了接受常用数字之外，还接受罗马数字：
 
>>> import pyinputplus as pyip
>>> response = pyip.inputNum(allowRegexes=[r'(I|V|X|L|C|D|M)+', r'zero'])
XLII
>>> response
'XLII'
>>> response = pyip.inputNum(allowRegexes=[r'(i|v|x|l|c|d|m)+', r'zero'])
xlii
>>> response
'xlii'
 
当然，这个正则表达式只影响inputNum()函数从用户那里接受的字母；该函数仍将接受带有无效排序的罗马数字，如'XVX'或'MILLI'，因为r'(I|V|X|L|C|D|M)+'正则表达式接受这些字符串。
 
还可以通过使用blockRegexes关键字参数来指定 PyInputPlus 函数不接受的正则表达式字符串列表。在交互式 Shell 中输入以下内容，以便inputNum()不接受偶数：
 
>>> import pyinputplus as pyip
>>> response = pyip.inputNum(blockRegexes=[r'[02468]

如果同时指定了`allowRegexes`和`blockRegexes`参数，允许列表将覆盖阻止列表。例如，在交互式 Shell 中输入以下内容，它允许使用`'caterpillar'`和`'category'`，但阻止任何包含`'cat'`的内容：

```py
>>> import pyinputplus as pyip
>>> response = pyip.inputStr(allowRegexes=[r'caterpillar', 'category'],
blockRegexes=[r'cat'])
cat
This response is invalid.
catastrophe
This response is invalid.
category
>>> response
'category'
 
PyInputPlus 模块的函数可以让您不必自己编写繁琐的输入验证代码。但是 PyInputPlus 模块有比这里详细描述的更多的内容。你可以在pyinputplus.readthedocs.io的在线查看它的完整文档。
 
向inputCustom()传递自定义验证函数
 
通过将函数传递给inputCustom()，您可以编写一个函数来执行您自己的定制验证逻辑。例如，假设您希望用户输入一系列数字，其总和为 10。没有pyinputplus.inputAddsUpToTen()函数，但是您可以创建自己的函数：
 
接受用户输入内容的单个字符串参数
如果字符串验证失败，将引发异常
如果inputCustom()应该返回不变的字符串，则返回None（或者没有return语句）
如果inputCustom()应该返回一个不同于用户输入的字符串，则返回一个非None值
作为第一个参数传递给inputCustom()
 
比如我们可以创建自己的addsUpToTen()函数，然后传递给inputCustom()。注意，函数调用看起来像inputCustom(addsUpToTen)而不是inputCustom(addsUpToTen())，因为我们将addsUpToTen()函数本身传递给inputCustom()，而不是调用addsUpToTen()并传递它的返回值。
 
>>> import pyinputplus as pyip
>>> def addsUpToTen(numbers):
...   numbersList = list(numbers)
...   for i, digit in enumerate(numbersList):
...     numbersList[i] = int(digit)
...   if sum(numbersList) != 10:
...     raise Exception('The digits must add up to 10, not %s.' %
(sum(numbersList)))
...   return int(numbers) # Return an int form of numbers.
...
>>> response = pyip.inputCustom(addsUpToTen) # No parentheses after
addsUpToTen here.
123
The digits must add up to 10, not 6.
1235
The digits must add up to 10, not 11.
1234
>>> response # inputStr() returned an int, not a string.
1234
>>> response = pyip.inputCustom(addsUpToTen)
hello
invalid literal for int() with base 10: 'h'
55
>>> response
 
inputCustom()函数还支持一般的 PyInputPlus 特性，例如blank、limit、timeout、default、allowRegexes和blockRegexes关键字参数。当很难或不可能为有效输入编写正则表达式时，编写自己的自定义验证函数是有用的，如在“加起来等于 10”的例子中。
 
项目：如何让一个白痴忙上好几个小时
 
让我们使用 PyInputPlus 来创建一个简单的程序，它执行以下操作：
 
问用户是否想知道如何让一个白痴忙上几个小时。
如果用户回答否，退出。
如果用户回答是，请转到第一步。
 
当然，我们不知道用户是否会输入除“是”或“否”之外的内容，所以我们需要执行输入验证。对于用户来说，能够输入y或n而不是完整的单词也是很方便的。PyInputPlus 的inputYesNo()函数将为我们处理这个问题，并且无论用户输入的是哪种情况，都会返回一个小写的'yes'或'no'字符串值。
 
当您运行这个程序时，它看起来应该如下所示：
 
Want to know how to keep an idiot busy for hours?
sure
'sure' is not a valid yes/no response.
Want to know how to keep an idiot busy for hours?
yes
Want to know how to keep an idiot busy for hours?
y
Want to know how to keep an idiot busy for hours?
Yes
Want to know how to keep an idiot busy for hours?
YES
Want to know how to keep an idiot busy for hours?
YES!!!!!!
'YES!!!!!!' is not a valid yes/no response.
Want to know how to keep an idiot busy for hours?
TELL ME HOW TO KEEP AN IDIOT BUSY FOR HOURS.
'TELL ME HOW TO KEEP AN IDIOT BUSY FOR HOURS.' is not a valid yes/no response.
Want to know how to keep an idiot busy for hours?
no
Thank you. Have a nice day.
 
打开一个新的文件编辑器标签，保存为idiot.py。然后输入以下代码：
 
import pyinputplus as pyip
 
这将导入 PyInputPlus 模块。由于输入pyinputplus有点麻烦，我们将简称为pyip。
 
while True:
    prompt = 'Want to know how to keep an idiot busy for hours?\\n'
    response = pyip.inputYesNo(prompt)
 
接下来，while True:创建一个无限循环，该循环将继续运行，直到遇到一个break语句。在这个循环中，我们调用pyip.inputYesNo()来确保这个函数调用不会返回，直到用户输入一个有效的答案。
 
    if response == 'no':
        break
 
保证调用pyip.inputYesNo()只返回字符串yes或字符串no。如果它返回了no，那么我们的程序就跳出了无限循环，继续执行最后一行，感谢用户：
 
print('Thank you. Have a nice day.')
 
否则，循环再次迭代。
 
你也可以通过传递关键字参数yesVal和noVal在非英语语言中使用inputYesNo()函数。例如，这个程序的西班牙语版本会有这两行：
 
    prompt = '¿Quieres saber cómo mantener ocupado a un idiota durante horas?\\n'
    response = pyip.inputYesNo(prompt, yesVal='sí', noVal='no')
    if response == 'sí':
 
现在用户可以输入sí或s（小写或大写）来代替yes或y来得到肯定的答案。
 
项目：乘法竞猜
 
PyInputPlus 的特性对于创建一个定时乘法测验很有用。通过将allowRegexes、blockRegexes、timeout和limit关键字参数设置为pyip.inputStr()，可以将大部分实现留给 PyInputPlus。你需要写的代码越少，你写程序的速度就越快。让我们创建一个程序，向用户提出 10 个乘法问题，其中有效输入是问题的正确答案。打开一个新的文件编辑器选项卡，将文件保存为multiplicationQuiz.py。
 
首先，我们将导入pyinputplus、random和time。我们将使用变量numberOfQuestions和correctAnswers来跟踪程序问了多少问题以及用户给出了多少正确答案。一个for循环将重复提出 10 次随机乘法问题：
 
import pyinputplus as pyip
import random, time
numberOfQuestions = 10
correctAnswers = 0
for questionNumber in range(numberOfQuestions):
 
在for循环中，程序将选择两个一位数相乘。我们将使用这些数字为用户创建一个#Q: N × N =提示，其中Q是问题编号（1 到 10）N是要相乘的两个数字。
 
    # Pick two random numbers:
    num1 = random.randint(0, 9)
    num2 = random.randint(0, 9)
    prompt = '#%s: %s x %s = ' % (questionNumber, num1, num2)
 
pyip.inputStr()函数将处理这个测验程序的大部分功能。我们传递给allowRegexes的参数是一个包含正则表达式字符串'^%s$'的列表，其中%s被正确的答案替换。^和%字符确保答案以正确的数字开始和结束，尽管 PyInputPlus 会首先删除用户回答开头和结尾的任何空格，以防他们在回答之前或之后无意中按了空格键。我们传递给blocklistRegexes的参数是一个带有('.*', 'Incorrect!')的列表。元组中的第一个字符串是匹配所有可能字符串的正则表达式。因此，如果用户的回答与正确答案不匹配，程序将拒绝他们提供的任何其他答案。在这种情况下，将显示'Incorrect!'字符串，并提示用户再次回答。此外，通过timeout的8和limit的3将确保用户只有 8 秒和 3 次尝试来提供正确答案：
 
    try:
        # Right answers are handled by allowRegexes.
        # Wrong answers are handled by blockRegexes, with a custom message.
        pyip.inputStr(prompt, allowRegexes=['^%s$' % (num1 * num2)],
                              blockRegexes=[('.*', 'Incorrect!')],
                              timeout=8, limit=3)
 
如果用户在 8 秒超时后回答，即使他们回答正确，pyip.inputStr()也会引发TimeoutException异常。如果用户错误回答超过 3 次，就会引发一个RetryLimitException异常。这两种异常类型都在 PyInputPlus 模块中，所以pyip.需要预先考虑它们：
 
    except pyip.TimeoutException:
        print('Out of time!')
    except pyip.RetryLimitException:
        print('Out of tries!')
 
记住，就像else块可以跟随一个if或elif块一样，它们可以选择跟随最后一个except块。如果在try块中没有出现异常，下面的else块中的代码将会运行。在我们的例子中，这意味着如果用户输入了正确的答案，代码就会运行：
 
    else:
        # This block runs if no exceptions were raised in the try block.
        print('Correct!')
        correctAnswers += 1
 
不管是三条信息中的哪一条，“超时！”、“超出尝试次数！”，或者“正确！”，显示，让我们在for循环结束时暂停 1 秒钟，让用户有时间阅读。在程序问了 10 个问题并且for循环继续之后，让我们向用户展示他们做出了多少个正确答案：
 
    time.sleep(1) # Brief pause to let user see the result.
print('Score: %s / %s' % (correctAnswers, numberOfQuestions))
 
PyInputPlus 非常灵活，您可以在各种各样接受用户键盘输入的程序中使用它，如本章中的程序所示。
 
总结
 
很容易忘记编写输入验证代码，但是没有它，您的程序几乎肯定会有 bug。您期望用户输入的值和他们实际输入的值可能完全不同，您的程序需要足够健壮来处理这些异常情况。您可以使用正则表达式来创建自己的输入验证代码，但是对于一般情况，使用现有的模块更容易，比如 PyInputPlus。您可以使用import pyinputplus as pyip导入模块，以便在调用模块函数时输入一个较短的名称。
 
PyInputPlus 具有用于输入各种输入的函数，包括字符串、数字、日期、是/否、True / False、电子邮件和文件。虽然input()总是返回一个字符串，但是这些函数以适当的数据类型返回值。inputChoice()函数允许您从几个预先选择的选项中选择一个，而inputMenu()还添加了数字或字母以便快速选择。
 
所有这些函数都有以下标准特性：去掉两边的空白，用timeout和limit关键字参数设置超时和重试限制，将正则表达式字符串列表传递给allowRegexes或blockRegexes以包含或排除特定响应。您将不再需要编写自己繁琐的while循环来检查有效输入并重新提示用户。
 
如果 PyInputPlus 模块的函数都不符合您的需要，但是您仍然喜欢 PyInputPlus 提供的其他特性，您可以调用inputCustom()并传递您自己的自定义验证函数供 PyInputPlus 使用。pyinputplus.readthedocs.io/en/latest的文档中有 PyInputPlus 函数和附加特性的完整列表。PyInputPlus 在线文档中的内容比本章中描述的要多得多。重新发明轮子是没有用的，学会使用这个模块将使你不必自己编写和调试代码。*
 
现在您已经掌握了处理和验证文本的专业知识，是时候学习如何读写计算机硬盘上的文件了。
 
练习题
 
 
PyInputPlus 是 Python 标准库自带的吗？
 
 
为什么 PyInputPlus 一般用import pyinputplus as pyip导入？
 
 
inputInt()和inputFloat()有什么区别？
 
 
如何确保用户使用 PyInputPlus 输入一个介于0和99之间的整数？
 
 
传递给allowRegexes和blockRegexes关键字参数的是什么？
 
 
空白输入三次inputStr(limit=3)做什么？
 
 
空白输入三次inputStr(limit=3, default='hello')做什么？
 
 
实践项目
 
为了练习，编写程序来完成以下任务。
 
三明治制作器
 
编写一个程序，询问用户对三明治的偏好。程序应该使用 PyInputPlus 来确保他们输入有效的输入，例如：
 
使用inputMenu()表示面包类型：小麦、白面包或酸面团。
使用inputMenu()表示蛋白质类型：鸡肉、火鸡、火腿或豆腐。
用inputYesNo()询问他们是否想要奶酪。
如果是这样，用inputMenu()询问奶酪的种类：切达奶酪、瑞士奶酪或马苏里拉奶酪。
用inputYesNo()询问他们想要蛋黄酱、芥末、生菜还是西红柿。
用inputInt()询问他们想要多少三明治。请确保该数字等于或大于 1。
 
为这些选项中的每一个提供价格，并在用户输入他们的选择后，让您的程序显示总成本。
 
自己编写乘法小测验
 
要了解 PyInputPlus 为您做了多少工作，请尝试自己重新创建乘法测验项目，而不要导入它。这个程序会提示用户 10 道乘法题，范围从0 × 0到9 × 9。您需要实现以下特性：
 
如果用户输入正确的答案，程序显示“正确！”1 秒钟，然后继续下一个问题。
在程序进入下一个问题之前，用户有三次输入正确答案的机会。
第一次显示问题八秒后，即使用户在八秒限制后输入了正确答案，该问题也会被标记为不正确。
 
将您的代码与第 196 页的“项目：乘法测验”中使用 PyInputPlus 的代码进行比较。
以上是关于Python 自动化指南（繁琐工作自动化）第二版：十八发送电子邮件和短信的主要内容，如果未能解决你的问题，请参考以下文章
 
 Python 自动化指南（繁琐工作自动化）第二版：二流程控制
 Python 自动化指南（繁琐工作自动化）第二版：五字典和结构化数据
 Python 自动化指南（繁琐工作自动化）第二版：十八发送电子邮件和短信
 Python 自动化指南（繁琐工作自动化）第二版：七使用正则表达式的模式匹配
 Python编程快速上手-让繁琐工作自动化-第二章习题及其答案
 Python学习的必备书籍