ExchangeService.SearchMailboxes method (IEnumerable<MailboxQuery>, SearchResultType, String, SortDirection, Int32, SearchPageDirection, String)

EWS Managed API

Searches mailboxes for items that match a set of query strings and returns a sorted, ordered result of preview items.

The SearchMailboxes(IEnumerable<MailboxQuery>, SearchResultType, String, SortDirection, Int32, SearchPageDirection, String) method is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

Namespace:  Microsoft.Exchange.WebServices.Data
Assembly:  Microsoft.Exchange.WebServices (in Microsoft.Exchange.WebServices.dll)

'Declaration
PublicFunctionSearchMailboxes ( _
	mailboxQueriesAsIEnumerable(OfMailboxQuery), _
	resultTypeAsSearchResultType, _
	sortByPropertyAsString, _
	sortOrderAsSortDirection, _
	pageSizeAsInteger, _
	pageDirectionAsSearchPageDirection, _
	pageItemReferenceAsString _
) AsServiceResponseCollection(OfSearchMailboxesResponse)
'Usage
DiminstanceAsExchangeServiceDimmailboxQueriesAsIEnumerable(OfMailboxQuery)
DimresultTypeAsSearchResultTypeDimsortByPropertyAsStringDimsortOrderAsSortDirectionDimpageSizeAsIntegerDimpageDirectionAsSearchPageDirectionDimpageItemReferenceAsStringDimreturnValueAsServiceResponseCollection(OfSearchMailboxesResponse)

returnValue = instance.SearchMailboxes(mailboxQueries, _
	resultType, sortByProperty, sortOrder, _
	pageSize, pageDirection, pageItemReference)

Parameters

mailboxQueries
Type: System.Collections.Generic.IEnumerable<MailboxQuery>

A collection of queries and a collection of mailbox search scopes.

resultType
Type: Microsoft.Exchange.WebServices.Data.SearchResultType

The search result is either statistical or an item preview.

sortByProperty
Type: System.String

The search result is sorted by property name.

sortOrder
Type: Microsoft.Exchange.WebServices.Data.SortDirection

The sort order.

pageSize
Type: System.Int32

The preview page size.

pageDirection
Type: Microsoft.Exchange.WebServices.Data.SearchPageDirection

The preview page direction, either previous or next.

pageItemReference
Type: System.String

A reference that determines where an item is on a preview page.

Return value

Type: Microsoft.Exchange.WebServices.Data.ServiceResponseCollection<SearchMailboxesResponse>
An item preview of items returned in the search.
Show:
© 2014 Microsoft