twisted.mail.interfaces.ISearchableIMAPMailbox(Interface) interface documentationtwisted.mail.interfaces
(View In Hierarchy)
Known implementations: twisted.mail.test.test_imap.FetchSearchStoreTests
| Method | search | Search for messages that meet the given query criteria. |
Search for messages that meet the given query criteria.
If this interface is not implemented by the mailbox, IMailboxIMAP.fetch
and various methods of IMessageIMAP
will be used instead.
Implementations which wish to offer better performance than the default implementation should implement this interface.
| Parameters | query | The search criteria (type: list) |
| uid | If true, the IDs specified in the query are UIDs; otherwise they are
message sequence IDs. (type: bool) | |
| Returns | A 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) | |
| Raises | IllegalQueryError | Raised when query is not valid. |