poplib — POP3 协议客户端 ¶

POP3 对象 ¶

所有 POP3 命令都按小写由同名方法表示；大多数返回由服务器发送的响应文本。

POP3 实例具有下列方法：

POP3. set_debuglevel ( level ) ¶

Set the instance’s debugging level. This controls the amount of debugging output printed. The default, 0 , produces no debugging output. A value of 1 produces a moderate amount of debugging output, generally a single line per request. A value of 2 or higher produces the maximum amount of debugging output, logging each line sent and received on the control connection.

POP3. getwelcome ( ) ¶

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

POP3. capa ( ) ¶

查询服务器的能力作为指定在 RFC 2449 . Returns a dictionary in the form {'name': ['param'...]} .

3.4 版新增。

POP3. user ( username ) ¶

Send user command, response should indicate that a password is required.

POP3. pass_ ( password ) ¶

Send password, response includes message count and mailbox size. Note: the mailbox on the server is locked until quit() 被调用。

POP3. apop ( user , secret ) ¶

Use the more secure APOP authentication to log into the POP3 server.

POP3. rpop ( user ) ¶

Use RPOP authentication (similar to UNIX r-commands) to log into POP3 server.

POP3. stat ( ) ¶

Get mailbox status. The result is a tuple of 2 integers: (message count, mailbox size) .

POP3. list ( [ which ] ) ¶

请求消息列表，结果按形式 (response, ['mesg_num octets', ...], octets) 。若 which 有设置，它是要列表的消息。

POP3. retr ( which ) ¶

Retrieve whole message number which , and set its seen flag. Result is in form (response, ['line', ...], octets) .

POP3. dele ( which ) ¶

Flag message number which for deletion. On most servers deletions are not actually performed until QUIT (the major exception is Eudora QPOP, which deliberately violates the RFCs by doing pending deletes on any disconnect).

POP3. rset ( ) ¶

移除邮箱的任何删除标记。

POP3. noop ( ) ¶

什么都不做。可能用作保持存活。

POP3. quit ( ) ¶

Signoff: commit changes, unlock mailbox, drop connection.

POP3. top ( which , howmuch ) ¶

Retrieves the message header plus howmuch lines of the message after the header of message number which . Result is in form (response, ['line', ...], octets) .

The POP3 TOP command this method uses, unlike the RETR command, doesn’t set the message’s seen flag; unfortunately, TOP is poorly specified in the RFCs and is frequently broken in off-brand servers. Test this method by hand against the POP3 servers you will use before trusting it.

POP3. uidl ( which=None ) ¶

Return message digest (unique id) list. If which is specified, result contains the unique id for that message in the form 'response mesgnum uid ，否则结果是列表 (response, ['mesgnum uid', ...], octets) .

POP3. utf8 ( ) ¶

Try to switch to UTF-8 mode. Returns the server response if successful, raises error_proto if not. Specified in RFC 6856 .

3.5 版新增。

POP3. stls ( context=None ) ¶

Start a TLS session on the active connection as specified in RFC 2595 . This is only allowed before user authentication

context parameter is a ssl.SSLContext 对象允许捆绑 SSL 配置选项、证书及私钥成单一 (潜在长期存活) 结构。请阅读 安全注意事项 了解最佳实践。

此方法支持主机名校验凭借 ssl.SSLContext.check_hostname and SNI (服务器名称指示) (见 ssl.HAS_SNI ).

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)
								

At the end of the module, there is a test section that contains a more extensive example of usage.