class documentation

Undocumented

Method __init__ Undocumented
Method flagsChanged Override me
Method modeChanged Override me
Method newMessages Override me
Method serverGreeting Called when the server has sent us a greeting.
Instance Variable deferred Undocumented
Instance Variable events Undocumented

Inherited from IMAP4Client:

Method addFlags Add to the set flags for one or more messages.
Method append Add the given message to the given mailbox.
Method authenticate Attempt to enter the authenticated state with the server
Method check Tell the server to perform a checkpoint
Method close Return the connection to the Authenticated state.
Method connectionLost We are no longer connected
Method connectionMade Called when a connection is made.
Method copy Copy the specified messages to the specified mailbox.
Method create Create a new mailbox on the server
Method delete Delete a mailbox
Method dispatchCommand Undocumented
Method examine Select a mailbox in read-only mode
Method expunge Return the connection to the Authenticate state.
Method fetchAll Retrieve several different fields of one or more messages
Method fetchBody Retrieve body text of one or more messages
Method fetchBodyStructure Retrieve the structure of the body of one or more messages
Method fetchEnvelope Retrieve the envelope data for one or more messages
Method fetchFast Retrieve several different fields of one or more messages
Method fetchFlags Retrieve the flags for one or more messages
Method fetchFull Retrieve several different fields of one or more messages
Method fetchHeaders Retrieve headers of one or more messages
Method fetchInternalDate Retrieve the internal date associated with one or more messages
Method fetchMessage Retrieve one or more entire messages
Method fetchSimplifiedBody Retrieve the simplified body structure of one or more messages
Method fetchSize Retrieve the size, in octets, of one or more messages
Method fetchSpecific Retrieve a specific section of one or more messages
Method fetchUID Retrieve the unique identifier for one or more messages
Method getCapabilities Request the capabilities available on this server.
Method lineReceived Attempt to parse a single line from the server.
Method list List a subset of the available mailboxes
Method login Authenticate with the server using a username and password
Method logout Inform the server that we are done with the connection.
Method lsub List a subset of the subscribed available mailboxes
Method makeTag Undocumented
Method messageFile Create a file to which an incoming message may be written.
Method namespace Retrieve information about the namespaces available to this account
Method noop Perform no operation.
Method rawDataReceived Override this for when raw data is received.
Method registerAuthenticator Register a new form of authentication
Method removeFlags Remove from the set flags for one or more messages.
Method rename Rename a mailbox
Method response_AUTH Undocumented
Method response_UNAUTH Undocumented
Method search Search messages in the currently selected mailbox
Method select Select a mailbox
Method sendCommand Undocumented
Method setFlags Set the flags for one or more messages.
Method startTLS Initiates a 'STARTTLS' request and negotiates the TLS / SSL Handshake.
Method status Retrieve the status of the given mailbox
Method subscribe Add a mailbox to the subscription list
Method timeoutConnection Called when the connection times out.
Method unsubscribe Remove a mailbox from the subscription list
Constant STATUS_CODES Undocumented
Constant STATUS_TRANSFORMATIONS Undocumented
Class Variable tagID Undocumented
Class Variable timeout Undocumented
Instance Variable authenticators Undocumented
Instance Variable context Undocumented
Instance Variable queued Undocumented
Instance Variable startedTLS Undocumented
Instance Variable state A string representing the state the connection is currently in.
Instance Variable tags Undocumented
Instance Variable waiting Undocumented
Method __cbAuthenticate Undocumented
Method __cbAuthTLS Undocumented
Method __cbCapabilities Undocumented
Method __cbContinueAppend Undocumented
Method __cbContinueAuth Undocumented
Method __cbExpunge Undocumented
Method __cbFinishAppend Undocumented
Method __cbList Undocumented
Method __cbLoginCaps Undocumented
Method __cbLoginTLS Undocumented
Method __cbLogout Undocumented
Method __cbNamespace Undocumented
Method __cbNoop Undocumented
Method __cbSearch Undocumented
Method __cbSelect Handle lines received in response to a SELECT or EXAMINE command.
Method __cbStatus Undocumented
Method __ebLoginTLS Undocumented
Method _cbFetch Undocumented
Method _defaultHandler Undocumented
Method _extraInfo Undocumented
Method _fetch Undocumented
Method _flushQueue Undocumented
Method _getContextFactory Undocumented
Method _intOrRaise Parse value as an integer and return the result or raise IllegalServerResponse with phrase as an argument if value cannot be parsed as an integer.
Method _parseFetchPairs Given the result of parsing a single FETCH response, construct a dict mapping response keys to response values.
Method _regularDispatch Undocumented
Method _setupForLiteral Undocumented
Method _startedTLS Undocumented
Method _store Undocumented
Class Variable _memoryFileLimit Undocumented
Class Variable _statusNames Undocumented
Instance Variable _capCache Undocumented
Instance Variable _lastCmd Undocumented
Instance Variable _parts Undocumented
Instance Variable _pendingBuffer Undocumented
Instance Variable _pendingSize Undocumented
Instance Variable _tag Undocumented

Inherited from LineReceiver (via IMAP4Client):

Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method sendLine Sends a line to the other end of the connection.
Method setLineMode Sets the line-mode of this receiver.
Method setRawMode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Constant MAX_LENGTH The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Class Variable delimiter The line-ending delimiter to use. By default this is b'\r\n'.
Instance Variable line_mode Undocumented
Instance Variable _buffer Undocumented
Instance Variable _busyReceiving Undocumented

Inherited from Protocol (via IMAP4Client, LineReceiver):

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable factory Undocumented

Inherited from BaseProtocol (via IMAP4Client, LineReceiver, Protocol):

Method makeConnection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented

Inherited from _PauseableMixin (via IMAP4Client, LineReceiver, Protocol, BaseProtocol):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
Instance Variable paused Undocumented

Inherited from TimeoutMixin (via IMAP4Client, LineReceiver, Protocol, BaseProtocol, _PauseableMixin):

Method callLater Wrapper around reactor.callLater for test purpose.
Method resetTimeout Reset the timeout count down.
Method setTimeout Change the timeout period
Instance Variable timeOut The number of seconds after which to timeout the connection.
Method __timedOut Undocumented
Instance Variable __timeoutCall Undocumented
def __init__(self, deferred, contextFactory=None): (source)
def serverGreeting(self, caps): (source)

Called when the server has sent us a greeting.

Parameters
caps:dictCapabilities the server advertised in its greeting.
deferred = (source)

Undocumented

Undocumented