Home | Trees | Index | Help |
---|
Package twisted :: Package protocols :: Module imap4 :: Class IMAP4Server |
|
BaseProtocol
--+ |Protocol
--+ |LineReceiver
--+ |TimeoutMixin
--+ | IMAP4Server
Protocol implementation for an IMAP4rev1 server.
The server can be in any of four states:Method Summary | |
---|---|
__init__(self,
contextFactory)
| |
auth_APPEND(self,
tag,
args)
| |
auth_CAPABILITY(self,
tag,
args)
| |
auth_CREATE(self,
tag,
args)
| |
auth_DELETE(self,
tag,
args)
| |
auth_EXAMINE(self,
tag,
args)
| |
auth_LIST(self,
tag,
args)
| |
auth_LOGOUT(self,
tag,
args)
| |
auth_LSUB(self,
tag,
args)
| |
auth_NOOP(self,
tag,
args)
| |
auth_QUIT(self,
tag,
args)
| |
auth_RENAME(self,
tag,
args)
| |
auth_SELECT(self,
tag,
args)
| |
auth_STATUS(self,
tag,
args)
| |
auth_SUBSCRIBE(self,
tag,
args)
| |
auth_UNSUBSCRIBE(self,
tag,
args)
| |
Account
|
Lookup the account associated with the given parameters |
Called when the client issues a CHECK command. | |
Clear buffered data. (inherited from LineReceiver )
| |
(Deprecated) (inherited from Protocol )
| |
Called when the connection is shut down. | |
Called when a connection is made. | |
Protocol.dataReceived. (inherited from LineReceiver )
| |
dispatchCommand(self,
tag,
cmd,
rest)
| |
flagsChanged(self,
newFlags)
| |
Called when the maximum line length has been reached. (inherited from LineReceiver )
| |
Override this for when each line is received. | |
listCapabilities(self)
| |
logout_CAPABILITY(self,
tag,
args)
| |
logout_LOGOUT(self,
tag,
args)
| |
logout_NOOP(self,
tag,
args)
| |
logout_QUIT(self,
tag,
args)
| |
lookupCommand(self,
cmd)
| |
Make a connection to a transport and a server. (inherited from BaseProtocol )
| |
Any object which implements write(string) and
seek(int, int)
|
Create a file to which an incoming message may be written. |
modeChanged(self,
writeable)
| |
newMessages(self,
exists,
recent)
| |
Override this for when raw data is received. | |
Register a new form of authentication | |
Reset the timeout count down (inherited from TimeoutMixin )
| |
select_APPEND(self,
tag,
args)
| |
select_CAPABILITY(self,
tag,
args)
| |
select_CHECK(self,
tag,
args)
| |
select_CLOSE(self,
tag,
args)
| |
select_COPY(self,
tag,
args,
uid)
| |
select_CREATE(self,
tag,
args)
| |
select_DELETE(self,
tag,
args)
| |
select_EXAMINE(self,
tag,
args)
| |
select_EXPUNGE(self,
tag,
args)
| |
select_FETCH(self,
tag,
args,
uid)
| |
select_LIST(self,
tag,
args)
| |
select_LOGOUT(self,
tag,
args)
| |
select_LSUB(self,
tag,
args)
| |
select_NOOP(self,
tag,
args)
| |
select_QUIT(self,
tag,
args)
| |
select_RENAME(self,
tag,
args)
| |
select_SEARCH(self,
tag,
args,
uid)
| |
select_SELECT(self,
tag,
args)
| |
select_STATUS(self,
tag,
args)
| |
select_STORE(self,
tag,
args,
uid)
| |
select_SUBSCRIBE(self,
tag,
args)
| |
select_UID(self,
tag,
args)
| |
select_UNSUBSCRIBE(self,
tag,
args)
| |
sendBadResponse(self,
tag,
message)
| |
sendContinuationRequest(self,
msg)
| |
Sends a line to the other end of the connection. (inherited from LineReceiver )
| |
sendNegativeResponse(self,
tag,
message)
| |
sendPositiveResponse(self,
tag,
message)
| |
sendServerGreeting(self)
| |
sendUntaggedResponse(self,
message)
| |
Sets the line-mode of this receiver. (inherited from LineReceiver )
| |
Sets the raw mode of this receiver. (inherited from LineReceiver )
| |
Change the timeout period (inherited from TimeoutMixin )
| |
Called when the connection times out. | |
unauth_AUTHENTICATE(self,
tag,
args)
| |
unauth_CAPABILITY(self,
tag,
args)
| |
unauth_LOGIN(self,
tag,
args)
| |
unauth_LOGOUT(self,
tag,
args)
| |
unauth_NOOP(self,
tag,
args)
| |
unauth_QUIT(self,
tag,
args)
| |
unauth_STARTTLS(self,
tag,
args)
| |
_IMAP4Server__cbAppend(self,
result,
tag,
mbox)
| |
_IMAP4Server__cbAuthChunk(self,
result,
auth,
savedState,
tag)
| |
_IMAP4Server__cbAuthResp(self,
result,
tag)
| |
_IMAP4Server__cbCheck(self,
result,
tag)
| |
_IMAP4Server__cbClose(self,
result,
tag)
| |
_IMAP4Server__cbContinueAppend(self,
rest,
tag,
mbox,
flags,
date)
| |
_IMAP4Server__cbCopied(self,
deferredIds,
ids,
failures,
tag,
mbox)
| |
_IMAP4Server__cbCopy(self,
messages,
tag,
mbox)
| |
_IMAP4Server__cbExpunge(self,
result,
tag)
| |
_IMAP4Server__cbFetch(self,
results,
tag)
| |
_IMAP4Server__cbLogin(self,
account,
tag)
| |
_IMAP4Server__cbSearch(self,
result,
tag)
| |
_IMAP4Server__cbStatus(self,
status,
tag,
box)
| |
_IMAP4Server__cbStore(self,
result,
tag,
silent)
| |
_IMAP4Server__ebAppend(self,
failure,
tag)
| |
_IMAP4Server__ebAuthChunk(self,
failure,
tag)
| |
_IMAP4Server__ebAuthResp(self,
failure,
tag)
| |
_IMAP4Server__ebCheck(self,
failure,
tag)
| |
_IMAP4Server__ebClose(self,
failure,
tag)
| |
_IMAP4Server__ebExpunge(self,
failure,
tag)
| |
_IMAP4Server__ebFetch(self,
failure,
tag)
| |
_IMAP4Server__ebLogin(self,
failure,
tag)
| |
_IMAP4Server__ebSearch(self,
failure,
tag)
| |
_IMAP4Server__ebStatus(self,
failure,
tag,
box)
| |
_IMAP4Server__ebStore(self,
failure,
tag)
| |
_listWork(self,
tag,
args,
sub,
cmdName)
| |
_parseMbox(self,
name)
| |
_respond(self,
state,
tag,
message)
| |
_selectWork(self,
tag,
args,
rw,
cmdName)
| |
_setupForLiteral(self,
octets)
| |
_TimeoutMixin__timedOut(self)
(inherited from TimeoutMixin )
|
Class Variable Summary | |
---|---|
tuple |
__implements__
|
NoneType |
account
|
dict |
CAPABILITIES
|
NoneType |
challengers
|
str |
IDENT
|
NoneType |
mbox
|
int |
POSTAUTH_TIMEOUT
|
str |
state
|
NoneType |
tags
|
int |
timeOut
|
int |
_memoryFileLimit
|
NoneType |
_pendingBuffer
|
NoneType |
_pendingLiteral
|
NoneType |
_pendingSize
|
Method Details |
---|
authenticateLogin(self, user, passwd)Lookup the account associated with the given parameters Override this method to define the desired authentication behavior.
|
checkpoint(self)Called when the client issues a CHECK command. This should perform any checkpoint operations required by the server. It may be a long running operation, but may not block. If it returns a deferred, the client will only be informed of success (or failure) when the deferred's callback (or errback) is invoked. |
connectionLost(self, reason)Called when the connection is shut down. Clear any circular references here, and any external references to this Protocol. The connection has been closed.
|
connectionMade(self)Called when a connection is made. This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
|
lineReceived(self, line)Override this for when each line is received.
|
messageFile(self, octets)Create a file to which an incoming message may be written.
|
rawDataReceived(self, data)Override this for when raw data is received.
|
registerChallenger(self, chal)Register a new form of authentication Challengers registered here will be listed as available to the client in the CAPABILITY response.
|
timeoutConnection(self)Called when the connection times out. Override to define behavior other than dropping the connection.
|
Class Variable Details |
---|
__implements__
|
account
|
CAPABILITIES
|
challengers
|
IDENT
|
mbox
|
POSTAUTH_TIMEOUT
|
state
|
tags
|
timeOut
|
_memoryFileLimit
|
_pendingBuffer
|
_pendingLiteral
|
_pendingSize
|
Home | Trees | Index | Help |
---|
Generated by Epydoc 1.1 on Fri Jun 27 03:48:31 2003 | http://epydoc.sf.net |