public interface MailboxSearchSession extends MailboxQuerySession
This session provides methods for searching among Mailbox
objects. The search query is constructed using the
MailboxQuery.
getMailboxesByQuery()
is the basic search method and
returns a list of Mailbox
objects.A more advanced search
may be performed with getMailboxesBySearch().
It accepts a
MailboxSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getMailboxesBySearch()
returns a
MailboxSearchResults
that can be used to access the resulting
MailboxList
or be used to perform a search within the
result set through MailboxSearch.
Mailboxes may have a query record indicated by their respective record
types. The query record is accessed via the MailboxQuery.
Modifier and Type | Method and Description |
---|---|
MailboxSearchResults |
getMailboxesBySearch(MailboxQuery mailboxQuery,
MailboxSearch mailboxSearch)
Gets the search results matching the given search query using the
given search.
|
MailboxQuery |
getMailboxQueryFromInspector(MailboxQueryInspector mailboxQueryInspector)
Gets a mailbox query from an inspector.
|
MailboxSearch |
getMailboxSearch()
Gets a mailbox search.
|
MailboxSearchOrder |
getMailboxSearchOrder()
Gets a mailbox search order.
|
canSearchMailboxes, getMailboxesByQuery, getMailboxQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
MailboxSearch getMailboxSearch()
mandatory
- This method must be implemented. MailboxSearchOrder getMailboxSearchOrder()
MailboxSearchOrder
is
supplied to a MailboxSearch
to specify the ordering of
results.mandatory
- This method must be implemented. MailboxSearchResults getMailboxesBySearch(MailboxQuery mailboxQuery, MailboxSearch mailboxSearch) throws OperationFailedException, PermissionDeniedException
mailboxQuery
- the mailbox querymailboxSearch
- the mailbox searchNullArgumentException
- mailboxQuery
or
mailboxSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- mailboxQuery
or
mailboxSearch
is not of this servicemandatory
- This method must be implemented. MailboxQuery getMailboxQueryFromInspector(MailboxQueryInspector mailboxQueryInspector)
MailboxSearchResults.
mailboxQueryInspector
- a mailbox query inspectorNullArgumentException
- mailboxQueryInspector
is null
UnsupportedException
- mailboxQueryInspector
is not of this servicemandatory
- This method must be implemented.