Module t.m.pop3

Part of twisted.mail View Source

Post-office Protocol version 3
AuthorsGlyph Lefkowitz

Jp Calderone

API Stability: Unstable
Class APOPCredentials No class docstring; 1/2 methods documented
Class _HeadersPlusNLines Undocumented
Class _POP3MessageDeleted Internal control-flow exception. Indicates the file of a deleted message
Class POP3Error Undocumented
Class _IteratorBuffer No class docstring; 1/3 methods documented
Function iterateLineGenerator Hook the given protocol instance up to the given iterator with an
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
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
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 No class docstring; 6/6 methods documented
Class POP3Client No class docstring; 1/16 methods documented
Class AdvancedPOP3Client POP3 client protocol implementation class
Class POP3ClientError Base class for all exceptions raised by POP3Client.
Class InsecureAuthenticationDisallowed Secure authentication was required but no mechanism could be found.
Class ServerErrorResponse The server returned an error response to a request.
Class LineTooLong The server sent an extremely long line.
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.
Parametersproto(type: POP3 )
gen(type: iterator )
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.