2.2.3.36.2 ConversationMode (Sync)
The ConversationMode element is an optional child element of the Collection element in Sync command requests that specifies whether to include items that are included within the conversation modality within the results of the Sync response. A single conversation MAY span multiple classes, and therefore ConversationMode is a child of the Collection element as opposed to the Options element (section 2.2.3.125.6).
Elements referenced in this section are defined in the AirSync namespace, except where otherwise indicated by the presence of a namespace prefix (as defined in section 2.2.4).
|
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
|---|---|---|---|---|
|
Sync command request (section 2.2.1.21) |
Collection (section 2.2.3.29.2) |
None |
boolean ([MS-ASDTYPE] section 2.1) |
0...1 (optional) |
Setting the ConversationMode element value to 1 (TRUE) results in retrieving all emails that match the conversations received within the date filter specified. However, although the body of the emails outside of that time based filter will not be retrieved, the text previews will be retrieved if the previews were requested.
Setting the ConversationMode element value to 0 (FALSE) in a Sync request results in the synchronization of items that meet the criteria of the FilterType element (section 2.2.3.68) value. Setting the ConversationMode element value to 1 (TRUE) expands the result set to also include any items with identical email2:ConversationId ([MS-ASEMAIL] section 2.2.2.21) values to those in the FilterType result set. The ConversationMode element value has no impact on items outside the collection specified by the CollectionId element (section 2.2.3.30.6); the result set is limited to items in the specified collection. The ConversationMode element value only limits or expands the results determined by the FilterType element value.
Specifying the ConversationMode element for collections that do not store emails results in an invalid XML error, Status element (section 2.2.3.177.17) value 4.
Protocol Versions
The following table specifies the protocol versions that support this element. The client indicates the protocol version being used by setting either the MS-ASProtocolVersion header, as specified in [MS-ASHTTP] section 2.2.1.1.2.6, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.
|
Protocol version |
Element support |
|---|---|
|
2.5 |
|
|
12.0 |
|
|
12.1 |
|
|
14.0 |
Yes |
|
14.1 |
Yes |
|
16.0 |
Yes |
|
16.1 |
Yes |