2.2.3.125.5 Options (Search)

The Options element is an optional child element of the Store element in Search command requests that contains the search options.

Elements referenced in this section are defined in the Search 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

Search command request (section 2.2.1.16)

Store (section 2.2.3.178.3)

airsync:MIMESupport (section 2.2.3.110.2)

airsyncbase:BodyPreference ([MS-ASAIRS] section 2.2.2.12)

airsyncbase:BodyPartPreference ([MS-ASAIRS] section 2.2.2.11)

rm:RightsManagementSupport ([MS-ASRM] section 2.2.2.15)

Range (section 2.2.3.143.3)

UserName (section 2.2.3.193.2)

Password (section 2.2.3.132.2)

DeepTraversal (section 2.2.3.41.2)

RebuildResults (section 2.2.3.144)

Picture (section 2.2.3.135.3)

container ([MS-ASDTYPE] section 2.2)

0...1 (optional)

The UserName element and Password element can only be sent in the request after receiving a Status element (section 2.2.3.177.13) value of 14 (see section 2.2.3.177.13 for more details). The server requires these credentials to access the requested resources. The client MUST only send these over a secure or trusted connection, and only in response to a Status value of 14. The UserName and Password element values are defined as strings consisting of at most 100 characters.

The supported options vary according to the message store that is being searched. The following table lists the valid options for each store.

Options

Store

Range

UserName

Password

Picture

GAL

Range

DeepTraversal

RebuildResults

airsyncbase:BodyPreference

airsyncbase:BodyPartPreference

rm:RightsManagementSupport

Mailbox

Range

UserName

Password

Document Library

The airsyncbase:BodyPartPreference element is only valid in Search command requests that include a ConversationId element, as specified in section 2.2.3.35.2.

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

Yes

12.0

Yes

12.1

Yes

14.0

Yes

14.1

Yes

16.0

Yes

16.1

Yes

All protocol versions except 2.5 support the airsyncbase:BodyPreference element as a child element of the Options element in a Search command request. The airsyncbase:BodyPartPreference element and the rm:RightsManagementSupport element are supported as a child elements of the Options element only when protocol version 14.1, 16.0, or 16.1 is used. Protocol version support of other elements referenced in this section is specified in the individual sections that define those elements.

Show: