Class t.m.i.IMAP4Server(basic.LineReceiver, policies.TimeoutMixin):

Part of twisted.mail.imap4 View Source View In Hierarchy

Implements interfaces: twisted.mail.imap4.IMailboxListener

Protocol implementation for an IMAP4rev1 server.

The server can be in any of four states:

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
506 Method __init__ Undocumented
516 Method capabilities Undocumented
526 Method connectionMade Called when a connection is made.
532 Method connectionLost Called when the connection is shut down.
538 Method timeoutConnection Called when the connection times out.
549 Method rawDataReceived Override this for when raw data is received.
571 Method lineReceived Override this for when each line is received.
586 Method parse_command Undocumented
611 Method parse_pending Undocumented
617 Method dispatchCommand Undocumented
626 Method lookupCommand Undocumented
686 Method arg_astring Parse an astring from the line, return (arg, rest), possibly
721 Method arg_atom Parse an atom from the line
733 Method arg_plist Parse a (non-nested) parenthesised list from the line
750 Method arg_literal Parse a literal from the line
770 Method arg_searchkeys searchkeys
780 Method arg_seqset sequence-set
795 Method arg_fetchatt fetch-att
803 Method arg_flaglist Flag part of store-att-flag
827 Method arg_line Command line of UID command
833 Method opt_plist Optional parenthesised list
842 Method opt_datetime Optional date-time string
855 Method opt_charset Optional charset of SEARCH command
870 Method sendServerGreeting Undocumented
874 Method sendBadResponse Undocumented
877 Method sendPositiveResponse Undocumented
880 Method sendNegativeResponse Undocumented
883 Method sendUntaggedResponse Undocumented
889 Method sendContinuationRequest Undocumented
908 Method listCapabilities Undocumented
917 Method do_CAPABILITY Undocumented
926 Method do_LOGOUT Undocumented
936 Method do_NOOP Undocumented
944 Method do_AUTHENTICATE Undocumented
953 Method authenticate Undocumented
1009 Method do_STARTTLS Undocumented
1026 Method do_LOGIN Undocumented
1038 Method authenticateLogin Lookup the account associated with the given parameters
1077 Method do_NAMESPACE Undocumented
1145 Method do_IDLE Undocumented
1151 Method parse_idle Undocumented
1161 Method do_CREATE Undocumented
1179 Method do_DELETE Undocumented
1197 Method do_RENAME Undocumented
1217 Method do_SUBSCRIBE Undocumented
1232 Method do_UNSUBSCRIBE Undocumented
1273 Method do_STATUS Undocumented
1304 Method do_APPEND Undocumented
1335 Method do_CHECK Undocumented
1354 Method checkpoint Called when the client issues a CHECK command.
1364 Method do_CLOSE Undocumented
1390 Method do_EXPUNGE Undocumented
1409 Method do_SEARCH Undocumented
1450 Method searchFilter Undocumented
1456 Method singleSearchStep Undocumented
1480 Method search_ALL Undocumented
1483 Method search_ANSWERED Undocumented
1486 Method search_BCC Undocumented
1490 Method search_BEFORE Undocumented
1494 Method search_BODY Undocumented
1498 Method search_CC Undocumented
1502 Method search_DELETED Undocumented
1505 Method search_DRAFT Undocumented
1508 Method search_FLAGGED Undocumented
1511 Method search_FROM Undocumented
1515 Method search_HEADER Undocumented
1520 Method search_KEYWORD Undocumented
1524 Method search_LARGER Undocumented
1527 Method search_NEW Undocumented
1530 Method search_NOT Undocumented
1533 Method search_OLD Undocumented
1536 Method search_ON Undocumented
1540 Method search_OR Undocumented
1545 Method search_RECENT Undocumented
1548 Method search_SEEN Undocumented
1551 Method search_SENTBEFORE Undocumented
1556 Method search_SENTON Undocumented
1561 Method search_SENTSINCE Undocumented
1566 Method search_SINCE Undocumented
1570 Method search_SMALLER Undocumented
1573 Method search_SUBJECT Undocumented
1577 Method search_TEXT Undocumented
1582 Method search_TO Undocumented
1586 Method search_UID Undocumented
1591 Method search_UNANSWERED Undocumented
1594 Method search_UNDELETED Undocumented
1597 Method search_UNDRAFT Undocumented
1600 Method search_UNFLAGGED Undocumented
1603 Method search_UNKEYWORD Undocumented
1607 Method search_UNSEEN Undocumented
1614 Method do_FETCH Undocumented
1670 Method spew_envelope Undocumented
1675 Method spew_flags Undocumented
1680 Method spew_internaldate Undocumented
1700 Method spew_rfc822header Undocumented
1706 Method spew_rfc822text Undocumented
1715 Method spew_rfc822size Undocumented
1720 Method spew_rfc822 Undocumented
1734 Method spew_uid Undocumented
1739 Method spew_bodystructure Undocumented
1742 Method spew_body Undocumented
1782 Method spewMessage Undocumented
1819 Method do_STORE Undocumented
1849 Method do_COPY Undocumented
1922 Method do_UID Undocumented
1934 Method modeChanged Indicates that the write status of a mailbox has changed.
1940 Method flagsChanged Indicates that the flags of one or more messages have changed.
1945 Method newMessages Indicates that the number of messages in a mailbox has changed.
559 Method _unblock Undocumented
629 Method __doCommand Undocumented
649 Method __cbDispatch Undocumented
653 Method __ebDispatch Undocumented
666 Method _stringLiteral Undocumented
678 Method _fileLiteral Undocumented
895 Method _respond Undocumented
960 Method _setupChallenge Undocumented
973 Method __cbAuthChunk Undocumented
989 Method __cbAuthResp Undocumented
997 Method __ebAuthResp Undocumented
1006 Method __ebAuthChunk Undocumented
1059 Method __cbLogin Undocumented
1070 Method __ebLogin Undocumented
1090 Method _parseMbox Undocumented
1099 Method _selectWork Undocumented
1114 Method _ebSelectWork Undocumented
1118 Method _cbSelectWork Undocumented
1247 Method _listWork Undocumented
1254 Method _cbListWork Undocumented
1263 Method _ebListWork Undocumented
1280 Method _cbStatusGotMailbox Undocumented
1289 Method _ebStatusGotMailbox Undocumented
1296 Method __cbStatus Undocumented
1301 Method __ebStatus Undocumented
1311 Method _cbAppendGotMailbox Undocumented
1320 Method _ebAppendGotMailbox Undocumented
1328 Method __cbAppend Undocumented
1332 Method __ebAppend Undocumented
1348 Method __cbCheck Undocumented
1351 Method __ebCheck Undocumented
1381 Method __cbClose Undocumented
1387 Method __ebClose Undocumented
1400 Method __cbExpunge Undocumented
1405 Method __ebExpunge Undocumented
1425 Method __cbSearch Undocumented
1432 Method __cbManualSearch Undocumented
1610 Method __ebSearch Undocumented
1627 Method __cbFetch Undocumented
1662 Method __ebSpewMessage Undocumented
1813 Method __ebFetch Undocumented
1835 Method __cbStore Undocumented
1846 Method __ebStore Undocumented
1857 Method _cbCopySelectedMailbox Undocumented
1867 Method _ebCopySelectedMailbox Undocumented
1870 Method __cbCopy Undocumented
1905 Method __cbCopied Undocumented
1918 Method __ebCopy Undocumented

Inherited from LineReceiver:

Line # Kind Name Docs
207 Method clearLineBuffer Clear buffered data.
211 Method dataReceived Protocol.dataReceived.
241 Method setLineMode Sets the line-mode of this receiver.
256 Method setRawMode Sets the raw mode of this receiver.
273 Method sendLine Sends a line to the other end of the connection.
278 Method lineLengthExceeded Called when the maximum line length has been reached.

Inherited from BaseProtocol (via LineReceiver, Protocol):

Line # Kind Name Docs
341 Method makeConnection Make a connection to a transport and a server.

Inherited from _PauseableMixin (via LineReceiver):

Line # Kind Name Docs
172 Method pauseProducing Undocumented
176 Method resumeProducing Undocumented
181 Method stopProducing Undocumented

Inherited from TimeoutMixin:

Line # Kind Name Docs
593 Method callLater Undocumented
597 Method resetTimeout Reset the timeout count down
602 Method setTimeout Change the timeout period
623 Method __timedOut Undocumented
Line # Kind Name Docs
506 Method __init__ Undocumented
686 Method arg_astring Parse an astring from the line, return (arg, rest), possibly
721 Method arg_atom Parse an atom from the line
795 Method arg_fetchatt fetch-att
803 Method arg_flaglist Flag part of store-att-flag
827 Method arg_line Command line of UID command
750 Method arg_literal Parse a literal from the line
733 Method arg_plist Parse a (non-nested) parenthesised list from the line
770 Method arg_searchkeys searchkeys
780 Method arg_seqset sequence-set
953 Method authenticate Undocumented
1038 Method authenticateLogin Lookup the account associated with the given parameters
593 Method callLater Undocumented
516 Method capabilities Undocumented
1354 Method checkpoint Called when the client issues a CHECK command.
207 Method clearLineBuffer Clear buffered data.
532 Method connectionLost Called when the connection is shut down.
526 Method connectionMade Called when a connection is made.
211 Method dataReceived Protocol.dataReceived.
617 Method dispatchCommand Undocumented
1304 Method do_APPEND Undocumented
944 Method do_AUTHENTICATE Undocumented
917 Method do_CAPABILITY Undocumented
1335 Method do_CHECK Undocumented
1364 Method do_CLOSE Undocumented
1849 Method do_COPY Undocumented
1161 Method do_CREATE Undocumented
1179 Method do_DELETE Undocumented
1390 Method do_EXPUNGE Undocumented
1614 Method do_FETCH Undocumented
1145 Method do_IDLE Undocumented
1026 Method do_LOGIN Undocumented
926 Method do_LOGOUT Undocumented
1077 Method do_NAMESPACE Undocumented
936 Method do_NOOP Undocumented
1197 Method do_RENAME Undocumented
1409 Method do_SEARCH Undocumented
1009 Method do_STARTTLS Undocumented
1273 Method do_STATUS Undocumented
1819 Method do_STORE Undocumented
1217 Method do_SUBSCRIBE Undocumented
1922 Method do_UID Undocumented
1232 Method do_UNSUBSCRIBE Undocumented
1940 Method flagsChanged Indicates that the flags of one or more messages have changed.
278 Method lineLengthExceeded Called when the maximum line length has been reached.
571 Method lineReceived Override this for when each line is received.
908 Method listCapabilities Undocumented
626 Method lookupCommand Undocumented
341 Method makeConnection Make a connection to a transport and a server.
1934 Method modeChanged Indicates that the write status of a mailbox has changed.
1945 Method newMessages Indicates that the number of messages in a mailbox has changed.
855 Method opt_charset Optional charset of SEARCH command
842 Method opt_datetime Optional date-time string
833 Method opt_plist Optional parenthesised list
586 Method parse_command Undocumented
1151 Method parse_idle Undocumented
611 Method parse_pending Undocumented
172 Method pauseProducing Undocumented
549 Method rawDataReceived Override this for when raw data is received.
597 Method resetTimeout Reset the timeout count down
176 Method resumeProducing Undocumented
1480 Method search_ALL Undocumented
1483 Method search_ANSWERED Undocumented
1486 Method search_BCC Undocumented
1490 Method search_BEFORE Undocumented
1494 Method search_BODY Undocumented
1498 Method search_CC Undocumented
1502 Method search_DELETED Undocumented
1505 Method search_DRAFT Undocumented
1508 Method search_FLAGGED Undocumented
1511 Method search_FROM Undocumented
1515 Method search_HEADER Undocumented
1520 Method search_KEYWORD Undocumented
1524 Method search_LARGER Undocumented
1527 Method search_NEW Undocumented
1530 Method search_NOT Undocumented
1533 Method search_OLD Undocumented
1536 Method search_ON Undocumented
1540 Method search_OR Undocumented
1545 Method search_RECENT Undocumented
1548 Method search_SEEN Undocumented
1551 Method search_SENTBEFORE Undocumented
1556 Method search_SENTON Undocumented
1561 Method search_SENTSINCE Undocumented
1566 Method search_SINCE Undocumented
1570 Method search_SMALLER Undocumented
1573 Method search_SUBJECT Undocumented
1577 Method search_TEXT Undocumented
1582 Method search_TO Undocumented
1586 Method search_UID Undocumented
1591 Method search_UNANSWERED Undocumented
1594 Method search_UNDELETED Undocumented
1597 Method search_UNDRAFT Undocumented
1600 Method search_UNFLAGGED Undocumented
1603 Method search_UNKEYWORD Undocumented
1607 Method search_UNSEEN Undocumented
1450 Method searchFilter Undocumented
874 Method sendBadResponse Undocumented
889 Method sendContinuationRequest Undocumented
273 Method sendLine Sends a line to the other end of the connection.
880 Method sendNegativeResponse Undocumented
877 Method sendPositiveResponse Undocumented
870 Method sendServerGreeting Undocumented
883 Method sendUntaggedResponse Undocumented
241 Method setLineMode Sets the line-mode of this receiver.
256 Method setRawMode Sets the raw mode of this receiver.
602 Method setTimeout Change the timeout period
1456 Method singleSearchStep Undocumented
1742 Method spew_body Undocumented
1739 Method spew_bodystructure Undocumented
1670 Method spew_envelope Undocumented
1675 Method spew_flags Undocumented
1680 Method spew_internaldate Undocumented
1720 Method spew_rfc822 Undocumented
1700 Method spew_rfc822header Undocumented
1715 Method spew_rfc822size Undocumented
1706 Method spew_rfc822text Undocumented
1734 Method spew_uid Undocumented
1782 Method spewMessage Undocumented
181 Method stopProducing Undocumented
538 Method timeoutConnection Called when the connection times out.
1328 Method __cbAppend Undocumented
973 Method __cbAuthChunk Undocumented
989 Method __cbAuthResp Undocumented
1348 Method __cbCheck Undocumented
1381 Method __cbClose Undocumented
1905 Method __cbCopied Undocumented
1870 Method __cbCopy Undocumented
649 Method __cbDispatch Undocumented
1400 Method __cbExpunge Undocumented
1627 Method __cbFetch Undocumented
1059 Method __cbLogin Undocumented
1432 Method __cbManualSearch Undocumented
1425 Method __cbSearch Undocumented
1296 Method __cbStatus Undocumented
1835 Method __cbStore Undocumented
629 Method __doCommand Undocumented
1332 Method __ebAppend Undocumented
1006 Method __ebAuthChunk Undocumented
997 Method __ebAuthResp Undocumented
1351 Method __ebCheck Undocumented
1387 Method __ebClose Undocumented
1918 Method __ebCopy Undocumented
653 Method __ebDispatch Undocumented
1405 Method __ebExpunge Undocumented
1813 Method __ebFetch Undocumented
1070 Method __ebLogin Undocumented
1610 Method __ebSearch Undocumented
1662 Method __ebSpewMessage Undocumented
1301 Method __ebStatus Undocumented
1846 Method __ebStore Undocumented
623 Method __timedOut Undocumented
1311 Method _cbAppendGotMailbox Undocumented
1857 Method _cbCopySelectedMailbox Undocumented
1254 Method _cbListWork Undocumented
1118 Method _cbSelectWork Undocumented
1280 Method _cbStatusGotMailbox Undocumented
1320 Method _ebAppendGotMailbox Undocumented
1867 Method _ebCopySelectedMailbox Undocumented
1263 Method _ebListWork Undocumented
1114 Method _ebSelectWork Undocumented
1289 Method _ebStatusGotMailbox Undocumented
678 Method _fileLiteral Undocumented
1247 Method _listWork Undocumented
1090 Method _parseMbox Undocumented
895 Method _respond Undocumented
1099 Method _selectWork Undocumented
960 Method _setupChallenge Undocumented
666 Method _stringLiteral Undocumented
559 Method _unblock Undocumented
def __init__(self, chal=None, contextFactory=None, scheduler=None): (source)
Undocumented
def capabilities(self): (source)
Undocumented
def connectionMade(self): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.BaseProtocol.connectionMade

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.
def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.connectionLost

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.
Parametersreason (type: twisted.python.failure.Failure )
def timeoutConnection(self): (source)
overrides twisted.protocols.policies.TimeoutMixin.timeoutConnection
Called when the connection times out. Override to define behavior other than dropping the connection.
def rawDataReceived(self, data): (source)
overrides twisted.protocols.basic.LineReceiver.rawDataReceived
Override this for when raw data is received.
def _unblock(self): (source)
Undocumented
def lineReceived(self, line): (source)
overrides twisted.protocols.basic.LineReceiver.lineReceived
Override this for when each line is received.
def parse_command(self, line): (source)
Undocumented
def parse_pending(self, line): (source)
Undocumented
def dispatchCommand(self, tag, cmd, rest, uid=None): (source)
Undocumented
def lookupCommand(self, cmd): (source)
Undocumented
def __doCommand(self, tag, handler, args, parseargs, line, uid): (source)
Undocumented
def __cbDispatch(self, (arg, rest), tag, fn, args, parseargs, uid): (source)
Undocumented
def __ebDispatch(self, failure, tag): (source)
Undocumented
def _stringLiteral(self, size): (source)
Undocumented
def _fileLiteral(self, size): (source)
Undocumented
def arg_astring(self, line): (source)
Parse an astring from the line, return (arg, rest), possibly via a deferred (to handle literals)
def arg_atom(self, line): (source)
Parse an atom from the line
def arg_plist(self, line): (source)
Parse a (non-nested) parenthesised list from the line
def arg_literal(self, line): (source)
Parse a literal from the line
def arg_searchkeys(self, line): (source)
searchkeys
def arg_seqset(self, line): (source)
sequence-set
def arg_fetchatt(self, line): (source)
fetch-att
def arg_flaglist(self, line): (source)
Flag part of store-att-flag
def arg_line(self, line): (source)
Command line of UID command
def opt_plist(self, line): (source)
Optional parenthesised list
def opt_datetime(self, line): (source)
Optional date-time string
def opt_charset(self, line): (source)
Optional charset of SEARCH command
def sendServerGreeting(self): (source)
Undocumented
def sendBadResponse(self, tag=None, message=''): (source)
Undocumented
def sendPositiveResponse(self, tag=None, message=''): (source)
Undocumented