Instance Variable |
state |
A string representing the state the connection is currently in. |
Method |
registerAuthenticator |
Register a new form of authentication |
Method |
rawDataReceived |
Override this for when raw data is received. |
Method |
connectionMade |
Called when a connection is made. |
Method |
connectionLost |
We are no longer connected |
Method |
lineReceived |
Attempt to parse a single line from the server. |
Method |
timeoutConnection |
Called when the connection times out. |
Method |
messageFile |
Create a file to which an incoming message may be written. |
Method |
makeTag |
Undocumented |
Method |
dispatchCommand |
Undocumented |
Method |
response_UNAUTH |
Undocumented |
Method |
response_AUTH |
Undocumented |
Method |
sendCommand |
Undocumented |
Method |
getCapabilities |
Request the capabilities available on this server. |
Method |
logout |
Inform the server that we are done with the connection. |
Method |
noop |
Perform no operation. |
Method |
startTLS |
Initiates a 'STARTTLS' request and negotiates the TLS / SSL
Handshake. |
Method |
authenticate |
Attempt to enter the authenticated state with the server |
Method |
login |
Authenticate with the server using a username and password |
Method |
namespace |
Retrieve information about the namespaces available to this account |
Method |
select |
Select a mailbox |
Method |
examine |
Select a mailbox in read-only mode |
Method |
create |
Create a new mailbox on the server |
Method |
delete |
Delete a mailbox |
Method |
rename |
Rename a mailbox |
Method |
subscribe |
Add a mailbox to the subscription list |
Method |
unsubscribe |
Remove a mailbox from the subscription list |
Method |
list |
List a subset of the available mailboxes |
Method |
lsub |
List a subset of the subscribed available mailboxes |
Method |
status |
Retrieve the status of the given mailbox |
Method |
append |
Add the given message to the given mailbox. |
Method |
check |
Tell the server to perform a checkpoint |
Method |
close |
Return the connection to the Authenticated state. |
Method |
expunge |
Return the connection to the Authenticate state. |
Method |
search |
Search messages in the currently selected mailbox |
Method |
fetchUID |
Retrieve the unique identifier for one or more messages |
Method |
fetchFlags |
Retrieve the flags for one or more messages |
Method |
fetchInternalDate |
Retrieve the internal date associated with one or more messages |
Method |
fetchEnvelope |
Retrieve the envelope data for one or more messages |
Method |
fetchBodyStructure |
Retrieve the structure of the body of one or more messages |
Method |
fetchSimplifiedBody |
Retrieve the simplified body structure of one or more messages |
Method |
fetchMessage |
Retrieve one or more entire messages |
Method |
fetchHeaders |
Retrieve headers of one or more messages |
Method |
fetchBody |
Retrieve body text of one or more messages |
Method |
fetchSize |
Retrieve the size, in octets, of one or more messages |
Method |
fetchFull |
Retrieve several different fields of one or more messages |
Method |
fetchAll |
Retrieve several different fields of one or more messages |
Method |
fetchFast |
Retrieve several different fields of one or more messages |
Method |
fetchSpecific |
Retrieve a specific section of one or more messages |
Method |
setFlags |
Set the flags for one or more messages. |
Method |
addFlags |
Add to the set flags for one or more messages. |
Method |
removeFlags |
Remove from the set flags for one or more messages. |
Method |
copy |
Copy the specified messages to the specified mailbox. |
Method |
_setupForLiteral |
Undocumented |
Method |
_regularDispatch |
Undocumented |
Method |
_defaultHandler |
Undocumented |
Method |
_flushQueue |
Undocumented |
Method |
_extraInfo |
Undocumented |
Method |
__cbCapabilities |
Undocumented |
Method |
__cbLogout |
Undocumented |
Method |
__cbNoop |
Undocumented |
Method |
__cbAuthenticate |
Undocumented |
Method |
__cbContinueAuth |
Undocumented |
Method |
__cbAuthTLS |
Undocumented |
Method |
_getContextFactory |
Undocumented |
Method |
__cbLoginCaps |
Undocumented |
Method |
_startedTLS |
Undocumented |
Method |
__cbLoginTLS |
Undocumented |
Method |
__ebLoginTLS |
Undocumented |
Method |
__cbNamespace |
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 |
__cbSelect |
Handle lines received in response to a SELECT or EXAMINE command. |
Method |
__cbList |
Undocumented |
Method |
__cbStatus |
Undocumented |
Method |
__cbContinueAppend |
Undocumented |
Method |
__cbFinishAppend |
Undocumented |
Method |
__cbExpunge |
Undocumented |
Method |
__cbSearch |
Undocumented |
Method |
_parseFetchPairs |
Given the result of parsing a single FETCH response, construct a
dict
mapping response keys to response values. |
Method |
_cbFetch |
Undocumented |
Method |
_fetch |
Undocumented |
Method |
_store |
Undocumented |
Class Variable |
delimiter |
The line-ending delimiter to use. By default this is b'\r\n' . |
Class Variable |
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. |
Method |
clearLineBuffer |
Clear buffered data. |
Method |
dataReceived |
Protocol.dataReceived. Translates bytes into lines, and calls
lineReceived (or rawDataReceived, depending on mode.) |
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. |
Method |
sendLine |
Sends a line to the other end of the connection. |
Method |
lineLengthExceeded |
Called when the maximum line length has been reached. Override if it
needs to be dealt with in some special way. |