2.2.2.11 BodyPartPreference

  • Article

The BodyPartPreference element is an optional element that sets preference information related to the type and size of information that is returned from searching, synchronizing, or fetching a message part.

The BodyPartPreference element is a container data type, as specified in [MS-ASDTYPE] section 2.2.

A command response MUST NOT include a BodyPartPreference element. Command requests can include the BodyPartPreference element. The Options element ([MS-ASCMD] section 2.2.3.125) MUST be the parent element of the BodyPartPreference element. The BodyPartPreference element, if present, MUST have the following required and optional child elements in the following order:

  • Type (section 2.2.2.41.3). This element is required.

  • TruncationSize (section 2.2.2.40.1). This element is optional.

  • AllOrNone (section 2.2.2.3.1). This element is optional.

  • Preview (section 2.2.2.35.3). This element is optional.

The contents of the Options element specify preferences for all of the content that the user is interested in searching, synchronizing, or retrieving. These preferences are set on a per-request basis and override any stored information. Because this information is required to process every request, the information can be persisted on the server if network load is a concern.

There MUST be one explicit BodyPartPreference element for each Type value specified in the set of preferences in order to request a BodyPart element (section 2.2.2.10) of that Type in the response.

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

14.1

Yes

16.0

Yes

16.1

Yes