module documentation
Post-office Protocol version 3.
Authors | |
Glyph Lefkowitz | |
Jp Calderone |
Class |
|
A POP3 client protocol. |
Class |
|
Credentials for use in APOP authentication. |
Class |
|
A base class for mailboxes. |
Class | POP3 |
A POP3 server protocol. |
Class |
|
A POP3 client protocol. |
Exception |
|
An error indicating secure authentication was required but no mechanism could be found. |
Exception |
|
An error indicating that the server sent a line which exceeded the maximum line length (LineOnlyReceiver.MAX_LENGTH ). |
Exception |
|
The base class for all exceptions raised by POP3Client. |
Exception |
|
The base class for POP3 errors. |
Exception |
|
An error indicating that the server returned an error response to a request. |
Exception |
|
An error indicating secure authentication was required but either the transport does not support TLS or no TLS context factory was supplied. |
Exception |
|
An error indicating secure authentication was required but the server does not support TLS. |
Function | format |
Format a list of message sizes for use in a LIST response. |
Function | format |
Format a list of message sizes into a complete LIST response. |
Function | format |
Format a list of message sizes into a STAT response. |
Function | format |
Format a list of message sizes for use in a UIDL response. |
Function | format |
Format a list of message sizes into a complete UIDL response. |
Function | iterate |
Direct the output of an iterator to the transport of a protocol and arrange for iteration to take place. |
Function | success |
Format an object as a positive response. |
Constant | NEXT |
Undocumented |
Variable | FIRST |
Undocumented |
Variable | LONG |
Undocumented |
Variable | NONE |
Undocumented |
Variable | SHORT |
Undocumented |
Class | _ |
A utility class to retrieve the header and some lines of the body of a mail message. |
Class | _ |
An iterator which buffers the elements of a container and periodically passes them as input to a writer. |
Format a list of message sizes into a complete LIST response.
This generator function is intended to be used with Cooperator
.
Parameters | |
msgs:list of int | A list of message sizes. |
Returns | |
bytes | Yields a series of strings which make up a complete LIST response. |
Format a list of message sizes into a STAT response.
This generator function is intended to be used with Cooperator
.
Parameters | |
msgs:list of int | A list of message sizes. |
Returns | |
None or bytes | Yields none until a result is available, then a string that is suitable for use in a STAT response. The string consists of the number of messages and the total size of the messages in octets. |
Format a list of message sizes for use in a UIDL response.
Parameters | |
msgs | See formatUIDListResponse |
get | See formatUIDListResponse |
Returns | |
bytes | Yields a series of strings that are suitable for use as unique-id listings in a UIDL response. Each string consists of a message number and its unique id. |
Format a list of message sizes into a complete UIDL response.
This generator function is intended to be used with Cooperator
.
Parameters | |
msgs:list of int | A list of message sizes. |
get | A callable which takes a message index number and returns the UID of the corresponding message in the mailbox. |
Returns | |
bytes | Yields a series of strings which make up a complete UIDL response. |