FindItem

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/>
   <IndexedPageItemView/>
   <DistinguishedGroupBy/>
   <Restriction/>
   <SortOrder/>
   <ParentFolderIds/>
   <QueryString/>
</FindItem>
<FindItem Traversal="">
   <ItemShape/>
   <ContactsView/>
   <GroupBy/>
   <Restriction/>
   <SortOrder/>
   <ParentFolderIds/>
   <QueryString/>
</FindItem>
<FindItem Traversal="">
   <ItemShape/>
   <ContactsView/> 
   <DistinguishedGroupBy/>
   <Restriction/>
   <SortOrder/>
   <ParentFolderIds/>
   <QueryString/>
</FindItem>
<FindItem Traversal="">
   <ItemShape/>
   <CalendarView/>
   <GroupBy/>
   <Restriction/>
   <SortOrder/>
   <ParentFolderIds/>
   <QueryString/>
</FindItem>
<FindItem Traversal="">
   <ItemShape/>
   <FractionalPageItemView/>
   <GroupBy/>
   <Restriction/>
   <SortOrder/>
   <ParentFolderIds/>
   <QueryString/>
</FindItem>
<FindItem Traversal="">
   <ItemShape/>
   <FractionalPageItemView/>
   <DistinguishedGroupBy/>
   <Restriction/>
   <SortOrder/>
   <ParentFolderIds/>
   <QueryString/>
</FindItem>

FindItemType

Attributes and elements

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
ItemShape
Identifies the item properties and content to include in a FindItem operation response.
IndexedPageItemView
Describes how paged item information is returned for a FindItem request. This element is optional.
FractionalPageItemView
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.
CalendarView
Provides time span limits to define a search for calendar items. This element is optional.
ContactsView
Defines a search for contact items based on alphabetical display names. This element is optional.
GroupBy
Specifies arbitrary groupings for FindItem queries. This element is optional.
DistinguishedGroupBy
Provides standard groupings for FindItem queries. This element is optional.
Restriction
Defines the restriction or query that is used to filter items or folders in FindItem/ FindFolder and search folder operations. This element is optional.
SortOrder
Defines how items are sorted in a FindItem request. This element is optional.
ParentFolderIds
Identifies folders to search for the FindItem and FindFolder operations.
QueryString (QueryStringType)
Contains a mailbox query string based on Advanced Query Syntax (AQS).

Parent elements

None.

Remarks

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.

Element information

Element Example
Namespace
https://schemas.microsoft.com/exchange/services/2006/messages
Schema Name
Messages schema
Validation File
Messages.xsd
Can be Empty
False

See also