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

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.

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

Parameters

reason

(type: twisted.python.failure.Failure )

Called when the connection times out. Override to define behavior other than dropping the connection.

Override this for when raw data is received.

Override this for when each line is received.

Parse an astring from the line, return (arg, rest), possibly via a deferred (to handle literals)

Parse an atom from the line

Parse a (non-nested) parenthesised list from the line

Parse a literal from the line

searchkeys

sequence-set

fetch-att

Flag part of store-att-flag

Command line of UID command

Optional parenthesised list

Optional date-time string

Optional charset of SEARCH command

Lookup the account associated with the given parameters

Override this method to define the desired authentication behavior.

The default behavior is to defer authentication to self.portal if it is not None, or to deny the login otherwise.

Parameters	user	The username to lookup (type: str )
	passwd	The password to login with (type: str )

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.

Apply the search filter to a set of messages. Send the response to the client.

Parameters	result	A list two tuples of messages with their sequence ids, sorted by the ids in descending order. (type: list of tuple of (int, provider of imap4.IMessage) )
	tag	A command tag. (type: str )
	mbox	The searched mailbox. (type: Provider of imap4.IMailbox )
	query	A list representing the parsed form of the search query. (type: list )
	uid	A flag indicating whether the search is over message sequence numbers or UIDs.
	searchResults	The search results so far or None if no results yet. (type: list )

Pop search terms from the beginning of query until there are none left and apply them to the given message.

Parameters	query	A list representing the parsed form of the search query.
	id	The sequence number of the message being checked.
	msg	The message being checked.
	lastSequenceId	The highest sequence number of any message in the mailbox being searched. (type: int )
	lastMessageId	The highest UID of any message in the mailbox being searched. (type: int )
Returns	Boolean indicating whether all of the query terms match the message.

Pop one search term from the beginning of query (possibly more than one element) and return whether it matches the given message.

Parameters	query	A list representing the parsed form of the search query.
	id	The sequence number of the message being checked.
	msg	The message being checked.
	lastSequenceId	The highest sequence number of any message in the mailbox being searched.
	lastMessageId	The highest UID of any message in the mailbox being searched.
Returns	Boolean indicating whether the query term matched the message.

Returns True if the message matches the ALL search key (always).

Parameters	query	A list representing the parsed query string. (type: A list of str )
	id	The sequence number of the message being checked. (type: int )
	msg	(type: Provider of imap4.IMessage )

Returns True if the message has been answered.

Parameters	query	A list representing the parsed query string. (type: A list of str )
	id	The sequence number of the message being checked. (type: int )
	msg	(type: Provider of imap4.IMessage )

Returns True if the message has a BCC address matching the query.

Parameters	query	A list whose first element is a BCC str (type: A list of str )
	id	The sequence number of the message being checked. (type: int )
	msg	(type: Provider of imap4.IMessage )

Returns True if the message does not match the query.

Parameters	query	A list representing the parsed form of the search query. (type: A list of str )
	id	The sequence number of the message being checked. (type: int )
	msg	The message being checked. (type: Provider of imap4.IMessage )
	lastSequenceId	The highest sequence number of a message in the mailbox. (type: int )
	lastMessageId	The highest UID of a message in the mailbox. (type: int )

Returns True if the message matches any of the first two query items.

Parameters	query	A list representing the parsed form of the search query. (type: A list of str )
	id	The sequence number of the message being checked. (type: int )
	msg	The message being checked. (type: Provider of imap4.IMessage )
	lastSequenceId	The highest sequence number of a message in the mailbox. (type: int )
	lastMessageId	The highest UID of a message in the mailbox. (type: int )

Returns True if the message date is earlier than the query date.

Parameters	query	A list whose first element starts with a stringified date that is a fragment of an imap4.Query(). The date must be in the format 'DD-Mon-YYYY', for example '03-March-2003' or '03-Mar-2003'. (type: A list of str )
	id	The sequence number of the message being checked. (type: int )
	msg	(type: Provider of imap4.IMessage )

Returns True if the message date is the same as the query date.

Parameters	query	A list whose first element starts with a stringified date that is a fragment of an imap4.Query(). The date must be in the format 'DD-Mon-YYYY', for example '03-March-2003' or '03-Mar-2003'. (type: A list of str )
	msg	(type: Provider of imap4.IMessage )

Returns True if the message date is later than the query date.

Parameters	query	A list whose first element starts with a stringified date that is a fragment of an imap4.Query(). The date must be in the format 'DD-Mon-YYYY', for example '03-March-2003' or '03-Mar-2003'. (type: A list of str )
	msg	(type: Provider of imap4.IMessage )

Returns True if the message UID is in the range defined by the search query.

Parameters	query	A list representing the parsed form of the search query. Its first element should be a str that can be interpreted as a sequence range, for example '2:4,5:*'. (type: A list of str )
	id	The sequence number of the message being checked. (type: int )
	msg	The message being checked. (type: Provider of imap4.IMessage )
	lastSequenceId	The highest sequence number of a message in the mailbox. (type: int )
	lastMessageId	The highest UID of a message in the mailbox. (type: int )

Indicates that the write status of a mailbox has changed.

Parameters

writeable

A true value if write is now allowed, false otherwise. (type: bool )

Indicates that the flags of one or more messages have changed.

Parameters

newFlags

A mapping of message identifiers to tuples of flags now set on that message. (type: dict )

Indicates that the number of messages in a mailbox has changed.

Parameters	exists	The total number of messages now in this mailbox. If the total number of messages has not changed, this should be None. (type: int or None )
	recent	The number of messages now flagged \Recent. If the number of recent messages has not changed, this should be None. (type: int )