FindItem
Last modified: October 13, 2012
Applies to: Exchange Online | Exchange Server 2007 | Exchange Server 2010 | Exchange Server 2013 | Office 365
The FindItem element defines a request to find items in a mailbox.
<FindItem Traversal=""> <ItemShape/> <IndexedPageItemView/> <GroupBy/> <Restriction/> <SortOrder/> <ParentFolderIds/> <QueryString/> </FindItem>
<FindItem Traversal=""> <ItemShape/> <FractionalPageItemView/> <GroupBy/> <Restriction/> <SortOrder/> <ParentFolderIds/> <QueryString/> </FindItem>
<FindItem Traversal=""> <ItemShape/> <CalendarView/> <GroupBy/> <Restriction/> <SortOrder/> <ParentFolderIds/> <QueryString/> </FindItem>
<FindItem Traversal=""> <ItemShape/> <ContactsView/> <GroupBy/> <Restriction/> <SortOrder/> <ParentFolderIds/> <QueryString/> </FindItem>
<FindItem Traversal=""> <ItemShape/> <IndexedPageItemView/> <DistinguishedGroupBy/> <Restriction/> <SortOrder/> <ParentFolderIds/> <QueryString/> </FindItem>
<FindItem Traversal=""> <ItemShape/> <FractionalPageItemView/>r <DistinguishedGroupBy/> <Restriction/> <SortOrder/> <ParentFolderIds/> <QueryString/> </FindItem>
<FindItem Traversal=""> <ItemShape/> <CalendarView/> <DistinguishedGroupBy/> <Restriction/> <SortOrder/> <ParentFolderIds/> <QueryString/> </FindItem>
<FindItem Traversal=""> <ItemShape/> <ContactsView/> <DistinguishedGroupBy/> <Restriction/> <SortOrder/> <ParentFolderIds/> <QueryString/> </FindItem>
FindItemType
The following sections describe attributes, child elements, and parent elements.
Attributes
|
Attribute |
Description |
|---|---|
|
Traversal |
Defines whether the search finds items in folders or the folders' dumpsters. This attribute is required. |
Traversal Attribute Values
|
Value |
Description |
|---|---|
|
Shallow |
Returns only the identities of items in the folder. |
|
SoftDeleted |
Returns only the identities of items that are in a folder's dumpster. Note that a soft-deleted traversal combined with a search restriction will result in zero items returned even if there are items that match the search criteria. |
|
Associated |
Returns only the identities of associated items in the folder. |
Child elements
|
Element |
Description |
|---|---|
|
Identifies the item properties and content to include in a FindItem operation response. |
|
|
Describes how paged item information is returned for a FindItem request. This element is optional. |
|
|
Describes where the paged view starts and the maximum number of items returned in a FindItem request. The paged view offset from the beginning of the set of found items is described by a fraction. This element is optional. |
|
|
Provides time span limits to define a search for calendar items. This element is optional. |
|
|
Defines a search for contact items based on alphabetical display names. This element is optional. |
|
|
Specifies arbitrary groupings for FindItem queries. This element is optional. |
|
|
Provides standard groupings for FindItem queries. This element is optional. |
|
|
Defines the restriction or query that is used to filter items or folders in FindItem/FindFolder and search folder operations. This element is optional. |
|
|
Defines how items are sorted in a FindItem request. This element is optional. |
|
|
Identifies folders to search for the FindItem and FindFolder operations. |
|
|
Contains a mailbox query string based on Advanced Query Syntax (AQS). |
Parent elements
None.
Only one of the IndexedPageItemView, FractionalPageItemView, CalendarView, or ContactsView elements can be included in a FindItem request. Only one of the GroupBy or DistinguishedGroupBy elements can be included in a FindItem request.
The schema that describes this element is located in the IIS virtual directory that hosts Exchange Web Services.