twisted.mail.pop3 : API documentation

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.

def iterateLineGenerator(proto, gen): (source)

Direct the output of an iterator to the transport of a protocol and arrange for iteration to take place.

Parameters	proto	A POP3 server protocol. (type: `POP3`)
	gen	An iterator over strings. (type: iterator which yields `bytes`)
Returns	A deferred which fires when the iterator finishes. (type: `Deferred`)

def successResponse(response): (source)

Format an object as a positive response.

Parameters	response	An object with a string representation. (type: stringifyable `object`)
Returns	A positive POP3 response string. (type: `bytes`)

def formatStatResponse(msgs): (source)

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`)

def formatListLines(msgs): (source)

Format a list of message sizes for use in a LIST response.

Parameters	msgs	A list of message sizes. (type: `list` of `int`)
Returns	Yields a series of strings that are suitable for use as scan listings in a LIST response. Each string consists of a message number and its size in octets. (type: `bytes`)

def formatListResponse(msgs): (source)

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`)

def formatUIDListLines(msgs, getUidl): (source)

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`)

def formatUIDListResponse(msgs, getUidl): (source)

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`)

Authors	Glyph Lefkowitz
	Jp Calderone

twisted.mail.pop3 module documentation