t.m.i.ISearchableMailbox(Interface) : interface documentation

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

No interface docstring
Method search Search for messages that meet the given query criteria.
def search(query, uid): (source)
Search for messages that meet the given query criteria.

If this interface is not implemented by the mailbox, IMailbox.fetch and various methods of IMessage will be used instead.

Implementations which wish to offer better performance than the default implementation should implement this interface.

ParametersqueryThe search criteria (type: list)
uidIf true, the IDs specified in the query are UIDs; otherwise they are message sequence IDs. (type: bool)
ReturnsA list of message sequence numbers or message UIDs which match the search criteria or a Deferred whose callback will be invoked with such a list. (type: list or Deferred)
RaisesIllegalQueryErrorRaised when query is not valid.
API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.