GroupBy
The GroupBy element specifies an arbitrary grouping for FindItem queries.
<GroupBy Order="">
<FieldURI/>
<AggregateOn/>
</GroupBy>
<GroupBy Order="">
<ExtendededFieldURI/>
<AggregateOn/>
</GroupBy>
<GroupBy Order="">
<IndexedFieldURI/>
<AggregateOn/>
</GroupBy>
GroupByType
Attributes and elements
The following sections describe attributes, child elements, and parent elements.
Attributes
Attribute | Description |
---|---|
Order |
Determines the order of the groups in the grouped item array that is returned in the response. This attribute is of type SortDirectionType. |
Order attribute values
Value | Description |
---|---|
Ascending |
The groups are ordered in ascending order. |
Descending |
The groups are ordered in descending order. |
Child elements
Element | Description |
---|---|
FieldURI |
Identifies frequently referenced properties by URI. |
IndexedFieldURI |
Identifies individual members of a dictionary. |
ExtendedFieldURI |
Identifies extended MAPI properties to get, set, or create. |
AggregateOn |
Represents the field that is used to determine the order of groups in a response. |
Parent elements
Element | Description |
---|---|
FindItem |
Defines a request to find items in a mailbox. The following is the XPath expression to this element: /FindItem |
Remarks
The FindItem response will contain a collection of groups. Each group will contain all items that had matching values for the GroupBy property. The property that determines the grouping is identified in the FieldURI, IndexedFieldURI, or ExtendedFieldURI element.
The schema that describes this element is located in the EWS virtual directory of the computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.
Element information
Element | Example |
---|---|
Namespace |
http://schemas.microsoft.com/exchange/services/2006/messages |
Schema Name |
Messages schema |
Validation File |
Messages.xsd |
Can be Empty |
False |