t.m.pop3 : module documentation

Part of twisted.mail View Source

Post-office Protocol version 3
AuthorsGlyph Lefkowitz
Jp Calderone
Class APOPCredentials Undocumented
Class POP3Error Undocumented
Function iterateLineGenerator Hook the given protocol instance up to the given iterator with an _IteratorBuffer and schedule the result to be exhausted via the protocol.
Function successResponse Format the given object as a positive response.
Function formatStatResponse Format the list of message sizes appropriately for a STAT response.
Function formatListLines Format a list of message sizes appropriately for the lines of a LIST response.
Function formatListResponse Format a list of message sizes appropriately for a complete LIST response.
Function formatUIDListLines Format the list of message sizes appropriately for the lines of a UIDL response.
Function formatUIDListResponse Format a list of message sizes appropriately for a complete UIDL response.
Class POP3 POP3 server protocol implementation.
Interface IServerFactory Interface for querying additional parameters of this POP3 server.
Interface IMailbox
Class Mailbox Undocumented
Class POP3Client Undocumented
Class _HeadersPlusNLines Undocumented
Class _POP3MessageDeleted Internal control-flow exception. Indicates the file of a deleted message was requested.
Class _IteratorBuffer No class docstring; 1/3 methods documented
def iterateLineGenerator(proto, gen): (source)
Hook the given protocol instance up to the given iterator with an _IteratorBuffer and schedule the result to be exhausted via the protocol.
Returns (type: twisted.internet.defer.Deferred)
def successResponse(response): (source)
Format the given object as a positive response.
def formatStatResponse(msgs): (source)
Format the list of message sizes appropriately for a STAT response.

Yields None until it finishes computing a result, then yields a str instance that is suitable for use as a response to the STAT command. Intended to be used with a twisted.internet.task.Cooperator.

def formatListLines(msgs): (source)
Format a list of message sizes appropriately for the lines of a LIST response.

Yields str instances formatted appropriately for use as lines in the response to the LIST command. Does not include the trailing '.'.

def formatListResponse(msgs): (source)
Format a list of message sizes appropriately for a complete LIST response.

Yields str instances formatted appropriately for use as a LIST command response.

def formatUIDListLines(msgs, getUidl): (source)
Format the list of message sizes appropriately for the lines of a UIDL response.

Yields str instances formatted appropriately for use as lines in the response to the UIDL command. Does not include the trailing '.'.

def formatUIDListResponse(msgs, getUidl): (source)
Format a list of message sizes appropriately for a complete UIDL response.

Yields str instances formatted appropriately for use as a UIDL command response.

API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.