Home | Trees | Index | Help |
---|
Package twisted :: Package protocols :: Module imap4 :: Class IMAP4Client |
|
BaseProtocol
--+ |Protocol
--+ |LineReceiver
--+ | IMAP4Client
Method Summary | |
---|---|
__init__(self)
| |
Deferred
|
Add to the set flags for one or more messages. |
Deferred
|
Add the given message to the currently selected mailbox |
Deferred
|
Attempt to enter the authenticated state with the server |
Deferred
|
Tell the server to perform a checkpoint |
Deferred
|
Return the connection to the Authenticated state. |
(Deprecated) (inherited from Protocol )
| |
Called when the connection is shut down. (inherited from Protocol )
| |
Deferred
|
Copy the specified messages to the specified mailbox. |
Deferred
|
Create a new mailbox on the server |
Protocol.dataReceived. (inherited from LineReceiver )
| |
Deferred
|
Delete a mailbox |
dispatchCommand(self,
tag,
rest)
| |
Deferred
|
Select a mailbox in read-only mode |
Deferred
|
Return the connection to the Authenticate state. |
Deferred
|
Retrieve several different fields of one or more messages |
Deferred
|
Retrieve body text of one or more messages |
Deferred
|
Retrieve the structure of the body of one or more messages |
Deferred
|
Retrieve the envelope data for one or more messages |
Deferred
|
Retrieve several different fields of one or more messages |
Deferred
|
Retrieve the flags for one or more messages |
Deferred
|
Retrieve several different fields of one or more messages |
Deferred
|
Retrieve headers of one or more messages |
Deferred
|
Retrieve the internal date associated with one or more messages |
Deferred
|
Retrieve one or more entire messages |
Deferred
|
Retrieve the simplified body structure of one or more messages |
Deferred
|
Retrieve the size, in octets, of one or more messages |
Deferred
|
Retrieve a specific section of one or more messages |
Deferred
|
Retrieve the unique identifier for one or more messages |
Override me | |
Deferred
|
Request the capabilities available on this server. |
Called when the maximum line length has been reached. (inherited from LineReceiver )
| |
Override this for when each line is received. | |
Deferred
|
List a subset of the available mailboxes |
Deferred
|
Authenticate with the server using a username and password |
Deferred
|
Inform the server that we are done with the connection. |
List a subset of the subscribed available mailboxes | |
makeTag(self)
| |
Any object which implements write(string) and
seek(int, int)
|
Create a file to which an incoming message may be written. |
Override me | |
Override me | |
Deferred
|
Perform no operation. |
Override this for when raw data is received. | |
Register a new form of authentication | |
Deferred
|
Remove from the set flags for one or more messages. |
Deferred
|
Rename a mailbox |
response_AUTH(self,
tag,
rest)
| |
response_UNAUTH(self,
tag,
rest)
| |
Deferred
|
Search messages in the currently selected mailbox |
Deferred
|
Select a mailbox |
sendCommand(self,
cmd)
| |
Sends a line to the other end of the connection. (inherited from LineReceiver )
| |
Deferred
|
Set the flags for one or more messages. |
Sets the line-mode of this receiver. (inherited from LineReceiver )
| |
Sets the raw mode of this receiver. (inherited from LineReceiver )
| |
Deferred
|
Retrieve the status of the given mailbox |
Deferred
|
Add a mailbox to the subscription list |
Deferred
|
Remove a mailbox from the subscription list |
Instance Variable Summary | |
---|---|
state
- A string representing the state the connection is currently in. |
Class Variable Summary | |
---|---|
tuple |
__implements__
|
NoneType |
authenticators
|
NoneType |
queued
|
NoneType |
state
|
tuple |
STATUS_CODES
|
dict |
STATUS_TRANSFORMATIONS
|
int |
tagID
|
NoneType |
tags
|
NoneType |
waiting
|
Method Details |
---|
addFlags(self, messages, flags, silent=1, uid=0)Add to the set flags for one or more messages. This command is allowed in the Selected state.
|
append(self, mailbox, message, flags=(), date=None)Add the given message to the currently selected mailbox This command is allowed in the Authenticated and Selected states.
|
authenticate(self, secret)Attempt to enter the authenticated state with the server This command is allowed in the Non-Authenticated state.
|
check(self)Tell the server to perform a checkpoint This command is allowed in the Selected state.
|
close(self)Return the connection to the Authenticated state. This command is allowed in the Selected state. Issuing this command will also remove all messages flagged \Deleted from the selected mailbox if it is opened in read-write mode, otherwise it indicates success by no messages are removed.
|
copy(self, messages, mailbox)Copy the specified messages to the specified mailbox. This command is allowed in the Selected state.
|
create(self, name)Create a new mailbox on the server This command is allowed in the Authenticated and Selected states.
|
delete(self, name)Delete a mailbox This command is allowed in the Authenticated and Selected states.
|
examine(self, mailbox)Select a mailbox in read-only mode This command is allowed in the Authenticated and Selected states.
|
expunge(self)Return the connection to the Authenticate state. This command is allowed in the Selected state. Issuing this command will perform the same actions as issuing the close command, but will also generate an 'expunge' response for every message deleted.
|
fetchAll(self, messages, uid=0)Retrieve several different fields of one or more messages This command is allowed in the Selected state. This is equivalent to issuing all of thefetchFlags ,
fetchInternalDate , fetchSize , and
fetchEnvelope functions.
|
fetchBody(self, messages, uid=0)Retrieve body text of one or more messages This command is allowed in the Selected state.
|
fetchBodyStructure(self, messages, uid=0)Retrieve the structure of the body of one or more messages This command is allowed in the Selected state.
|
fetchEnvelope(self, messages, uid=0)Retrieve the envelope data for one or more messages This command is allowed in the Selected state.
|
fetchFast(self, messages, uid=0)Retrieve several different fields of one or more messages This command is allowed in the Selected state. This is equivalent to issuing all of thefetchFlags ,
fetchInternalDate , and fetchSize
functions.
|
fetchFlags(self, messages, uid=0)Retrieve the flags for one or more messages This command is allowed in the Selected state.
|
fetchFull(self, messages, uid=0)Retrieve several different fields of one or more messages This command is allowed in the Selected state. This is equivalent to issuing all of thefetchFlags ,
fetchInternalDate , fetchSize ,
fetchEnvelope , and fetchSimplifiedBody
functions.
|
fetchHeaders(self, messages, uid=0)Retrieve headers of one or more messages This command is allowed in the Selected state.
|
fetchInternalDate(self, messages, uid=0)Retrieve the internal date associated with one or more messages This command is allowed in the Selected state.
|
fetchMessage(self, messages, uid=0)Retrieve one or more entire messages This command is allowed in the Selected state.
|
fetchSimplifiedBody(self, messages, uid=0)Retrieve the simplified body structure of one or more messages This command is allowed in the Selected state.
|
fetchSize(self, messages, uid=0)Retrieve the size, in octets, of one or more messages This command is allowed in the Selected state.
|
fetchSpecific(self, messages, uid=0, headerType=None, headerNumber=None, headerArgs=None, peek=None, offset=None, length=None)Retrieve a specific section of one or more messages
|
fetchUID(self, messages)Retrieve the unique identifier for one or more messages This command is allowed in the Selected state.
|
flagsChanged(self, newFlags)Override me |
getCapabilities(self)Request the capabilities available on this server. This command is allowed in any state of connection.
|
lineReceived(self, line)Override this for when each line is received.
|
list(self, reference, wildcard)List a subset of the available mailboxes This command is allowed in the Authenticated and Selected states.
|
login(self, username, password)Authenticate with the server using a username and password This command is allowed in the Non-Authenticated state.
|
logout(self)Inform the server that we are done with the connection. This command is allowed in any state of connection.
|
lsub(self, reference, wildcard)List a subset of the subscribed available mailboxes This command is allowed in the Authenticated and Selected states. The parameters and returned object are the same as for thelist method, with one slight difference: Only mailboxes
which have been subscribed can be included in the resulting list.
|
messageFile(self, octets)Create a file to which an incoming message may be written.
|
modeChanged(self, writeable)Override me |
newMessages(self, exists, recent)Override me |
noop(self)Perform no operation. This command is allowed in any state of connection.
|
rawDataReceived(self, data)Override this for when raw data is received.
|
registerAuthenticator(self, auth)Register a new form of authentication When invoking the authenticate() method of IMAP4Client, the first matching authentication scheme found will be used. The ordering is that in which the server lists support authentication schemes.
|
removeFlags(self, messages, flags, silent=1, uid=0)Remove from the set flags for one or more messages. This command is allowed in the Selected state.
|
rename(self, oldname, newname)Rename a mailbox This command is allowed in the Authenticated and Selected states.
|
search(self, *queries)Search messages in the currently selected mailbox This command is allowed in the Selected state. Any non-zero number of queries are accepted by this method, as returned by theQuery , Or , and
Not functions.
|
select(self, mailbox)Select a mailbox This command is allowed in the Authenticated and Selected states.
|
setFlags(self, messages, flags, silent=1, uid=0)Set the flags for one or more messages. This command is allowed in the Selected state.
|
status(self, mailbox, *names)Retrieve the status of the given mailbox This command is allowed in the Authenticated and Selected states.
|
subscribe(self, name)Add a mailbox to the subscription list This command is allowed in the Authenticated and Selected states.
|
unsubscribe(self, name)Remove a mailbox from the subscription list This command is allowed in the Authenticated and Selected states.
|
Instance Variable Details |
---|
stateA string representing the state the connection is currently in. |
Class Variable Details |
---|
__implements__
|
authenticators
|
queued
|
state
|
STATUS_CODES
|
STATUS_TRANSFORMATIONS
|
tagID
|
tags
|
waiting
|
Home | Trees | Index | Help |
---|
Generated by Epydoc 1.1 on Thu May 8 13:16:38 2003 | http://epydoc.sf.net |