twisted.mail.pop3
module documentationtwisted.mail
View Source
Post-office Protocol version 3.
Authors | Glyph Lefkowitz | |
Jp Calderone |
Class | POP3Error | The base class for POP3 errors. |
Class | POP3ClientError | The base class for all exceptions raised by POP3Client. |
Class | APOPCredentials | Credentials for use in APOP authentication. |
Function | iterateLineGenerator | Direct the output of an iterator to the transport of a protocol and arrange for iteration to take place. |
Function | successResponse | Format an object as a positive response. |
Function | formatStatResponse | Format a list of message sizes into a STAT response. |
Function | formatListLines | Format a list of message sizes for use in a LIST response. |
Function | formatListResponse | Format a list of message sizes into a complete LIST response. |
Function | formatUIDListLines | Format a list of message sizes for use in a UIDL response. |
Function | formatUIDListResponse | Format a list of message sizes into a complete UIDL response. |
Class | POP3 | A POP3 server protocol. |
Class | Mailbox | A base class for mailboxes. |
Class | POP3Client | A POP3 client protocol. |
Class | AdvancedPOP3Client | A POP3 client protocol. |
Class | _HeadersPlusNLines | A utility class to retrieve the header and some lines of the body of a mail message. |
Class | _IteratorBuffer | 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 STAT response.
This generator function is intended to be used with Cooperator
.
Parameters | msgs | A list of message sizes. (type: list
of int ) |
Returns | 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. (type: None
or bytes ) |
Format a list of message sizes into a complete LIST response.
This generator function is intended to be used with Cooperator
.
Parameters | msgs | A list of message sizes. (type: list
of int ) |
Returns | Yields a series of strings which make up a complete LIST response. (type: bytes ) |
Format a list of message sizes for use in a UIDL response.
Parameters | msgs | See formatUIDListResponse |
getUidl | See formatUIDListResponse | |
Returns | 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. (type: bytes ) |
Format a list of message sizes into a complete UIDL response.
This generator function is intended to be used with Cooperator
.
Parameters | msgs | A list of message sizes. (type: list
of int ) |
getUidl | A callable which takes a message index number and returns the UID of the corresponding message in the mailbox. (type: one-argument callable returning bytes) | |
Returns | Yields a series of strings which make up a complete UIDL response. (type: bytes ) |