poplib --- POP3 協定用戶端

原始碼:Lib/poplib.py


本模块定义了一个 POP3 类,该类封装了到 POP3 服务器的连接过程,并实现了 RFC 1939 中定义的协议。POP3 类同时支持 RFC 1939 中最小的和可选的命令集。POP3 类还支持在 RFC 2595 中引入的 STLS 命令,用于在已建立的连接上启用加密通信。

本模块额外提供一个 POP3_SSL 类,在连接到 POP3 服务器时,该类为使用 SSL 作为底层协议层提供了支持。

注意,尽管 POP3 具有广泛的支持,但它已经过时。POP3 服务器的实现质量差异很大,而且大多很糟糕。如果邮件服务器支持 IMAP,则最好使用 imaplib.IMAP4 类,因为 IMAP 服务器一般实现得更好。

可用性: 非 Emscripten,非 WASI。

此模組在 WebAssembly 平台 wasm32-emscriptenwasm32-wasi 上無法作用或無法使用。有關更多資訊,請參閱 WebAssembly 平台

poplib 模块提供了两个类:

class poplib.POP3(host, port=POP3_PORT[, timeout])

本类实现实际的 POP3 协议。实例初始化时,连接就会建立。如果省略 port,则使用标准 POP3 端口(110)。可选参数 timeout 指定连接尝试的超时时间(以秒为单位,如果未指定超时,将使用全局默认超时设置)。

引發一個附帶引數 selfhostport稽核事件 poplib.connect

引發一個附帶引數 selfline稽核事件 poplib.putline

在 3.9 版的變更: 如果 timeout 参数设置为 0,创建非阻塞套接字时,它将引发 ValueError 来阻止该操作。

class poplib.POP3_SSL(host, port=POP3_SSL_PORT, *, timeout=None, context=None)

一个 POP3 的子类,它使用经 SSL 加密的套接字连接到服务器。如果端口 port 未指定,则使用 995,它是标准的 POP3-over-SSL 端口。timeout 的作用与 POP3 构造函数中的相同。context 是一个可选的 ssl.SSLContext 对象,该对象可以将 SSL 配置选项、证书和私钥打包放入一个单独的(可以长久存在的)结构中。请阅读 安全考量 以获取最佳实践。

引發一個附帶引數 selfhostport稽核事件 poplib.connect

引發一個附帶引數 selfline稽核事件 poplib.putline

在 3.2 版的變更: 添加了 context 参数。

在 3.4 版的變更: 该类现在支持使用 ssl.SSLContext.check_hostname服务器名称提示 (参见 ssl.HAS_SNI) 进行主机名检测。

在 3.9 版的變更: 如果 timeout 参数设置为 0,创建非阻塞套接字时,它将引发 ValueError 来阻止该操作。

在 3.12 版的變更: 已弃用的 keyfilecertfile 形参已被移除。

定义了一个异常,它是作为 poplib 模块的属性定义的:

exception poplib.error_proto

此模块的所有错误都将引发本异常(来自 socket 模块的错误不会被捕获)。异常的原因将以字符串的形式传递给构造函数。

也參考

imaplib 模組

标准的 Python IMAP 模块。

關於 Fetchmail 的常見問題

fetchmail POP/IMAP 客户端的“常见问题”收集了 POP3 服务器之间的差异和 RFC 不兼容的信息,如果要编写基于 POP 协议的应用程序,这可能会很有用。

POP3 物件

所有 POP3 命令均以同名的方法表示,使用小写形式;大多数方法返回的是服务器所发送的响应文本。

POP3 实例具有下列方法:

POP3.set_debuglevel(level)

设置实例的调试级别,它控制着调试信息的数量。默认值 0 不产生调试信息。值 1 产生中等数量的调试信息,通常每个请求产生一行。大于或等于 2 的值产生的调试信息最多,FTP 控制连接上发送和接收的每一行都将被记录下来。

POP3.getwelcome()

返回 POP3 服务器发送的问候语字符串。

POP3.capa()

查询服务器支持的功能,这些功能在 RFC 2449 中有说明。返回一个 {'name': ['param'...]} 形式的字典。

Added in version 3.4.

POP3.user(username)

发送 user 命令,返回的响应应该指示需要一个密码。

POP3.pass_(password)

发送密码,响应包括邮件消息计数和邮箱大小。 注意:服务器上的邮箱将被锁定直到 quit() 被调用。

POP3.apop(user, secret)

使用更安全的 APOP 身份验证登录到 POP3 服务器。

POP3.rpop(user)

使用 RPOP 身份验证(类似于 Unix r-命令)登录到 POP3 服务器。

POP3.stat()

获取邮箱状态。结果为 2 个整数组成的元组:(message count, mailbox size)

POP3.list([which])

请求消息列表,结果的形式为 (response, ['mesg_num octets', ...], octets)。如果设置了 which,它表示需要列出的消息。

POP3.retr(which)

检索编号为 which 的整条消息,并设置其已读标志位。结果的形式为 (response, ['line', ...], octets)

POP3.dele(which)

将编号为 which 的消息标记为待删除。在多数服务器上,删除操作直到 QUIT 才会实际执行(主要例外是 Eudora QPOP,它在断开连接时执行删除,故意违反了 RFC)。

POP3.rset()

移除邮箱中的所有待删除标记。

POP3.noop()

什么都不做。可以用于保持活动状态。

POP3.quit()

登出:提交更改,解除邮箱锁定,断开连接。

POP3.top(which, howmuch)

检索编号为 which 的消息,范围是消息头加上消息头往后数 howmuch 行。结果的形式为 (response, ['line', ...], octets)

本方法使用 POP3 TOP 命令,不同于 RETR 命令,它不设置邮件的已读标志位。不幸的是,TOP 在 RFC 中说明不清晰,且在小众的服务器软件中往往不可用。信任并使用它之前,请先手动对目标 POP3 服务器测试本方法。

POP3.uidl(which=None)

返回消息摘要(唯一 ID)列表。如果指定了 which,那么结果将包含那条消息的唯一 ID,形式为 'response mesgnum uid,如果未指定,那么结果为列表 (response, ['mesgnum uid', ...], octets)

POP3.utf8()

尝试切换至 UTF-8 模式。成功则返回服务器的响应,失败则引发 error_proto 异常。在 RFC 6856 中有说明。

Added in version 3.5.

POP3.stls(context=None)

在活动连接上开启 TLS 会话,在 RFC 2595 中有说明。仅在用户身份验证前允许这样做。

context 参数是一个 ssl.SSLContext 对象,该对象可以将 SSL 配置选项、证书和私钥打包放入一个单独的(可以长久存在的)结构中。请阅读 安全考量 以获取最佳实践。

此方法支持通过 ssl.SSLContext.check_hostname服务器名称指示 (参见 ssl.HAS_SNI) 进行主机名检测。

Added in version 3.4.

POP3_SSL 实例没有额外方法。该子类的接口与其父类的相同。

POP3 範例

以下是一个最短示例(不带错误检查),该示例将打开邮箱,检索并打印所有消息:

import getpass, poplib

M = poplib.POP3('localhost')
M.user(getpass.getuser())
M.pass_(getpass.getpass())
numMessages = len(M.list()[1])
for i in range(numMessages):
    for j in M.retr(i+1)[1]:
        print(j)

模块的最后有一段测试,其中包含的用法示例更加广泛。