2.2.3.125.3 Options (ItemOperations)
The Options element is an optional child element of the EmptyFolderContents element, the Fetch element, and the Move element in ItemOperations command requests. It contains the options for the EmptyFolderContents operation, the fetch operation, or the move operation.
Elements referenced in this section are defined in the ItemOperations 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 |
|---|---|---|---|---|
|
ItemOperations command request (section 2.2.1.10) EmptyFolderContents operation |
EmptyFolderContents (section 2.2.3.58) |
DeleteSubFolders (section 2.2.3.44) |
container ([MS-ASDTYPE] section 2.2) |
0...1 (optional) |
|
ItemOperations command request fetch operation |
Fetch (section 2.2.3.67.1) |
Schema (section 2.2.3.158) Range (section 2.2.3.143.2) UserName (section 2.2.3.193.1) Password (section 2.2.3.132.1) airsync:MIMESupport (section 2.2.3.110.1) airsyncbase:BodyPreference ([MS-ASAIRS] section 2.2.2.12) airsyncbase:BodyPartPreference ([MS-ASAIRS] section 2.2.2.11) |
container |
0...1 (optional) |
|
ItemOperations command request Move operation |
Move (section 2.2.3.117.1) |
MoveAlways (section 2.2.3.118) |
container |
0...1 (optional) |
If the client specifies an option that is invalid for the parent element, the server returns a Status element (section 2.2.3.177.8) value of 2.
The following options are supported for the fetch operation:
Schema
Per-class settings on format for fetch results.
This protocol supports schemas for Personal Information Manager (PIM) items only; it does not support schemas for document library items or attachments.
Supports all top-level property nodes.
For more information about the Schema element, section 2.2.3.158.
Byte ranges
Facilitates a checkpoint to improve the reliability of large data downloads.
This protocol supports ranges for document library items and attachments; it does not support ranges for other item types—that is, PIM items, such as email, contact, calendar, or task items.
For attachments, the range applies to the file content.
For document library items, this applies to the file content.
For more information about the Range element, section 2.2.3.143.2.
User name and password
Identifies the username and password required to fetch the desired item.
For more information about UserName and Password elements, see section 2.2.3.193.1 and section 2.2.3.132.1 respectively.
MIME support
Indicates whether the server returns MIME content for S/MIME-only messages, all messages, or no messages
For more information about the airsync:MIMESupport element, section 2.2.3.110.1.
Body format preference
Per-class settings on preferred body format.
This protocol supports body preferences for PIM items only; it does not support body format preferences for document library items or attachments.
For more information about the airsyncbase:BodyPreference element, see [MS-ASAIRS] section 2.2.2.12.
Body part preference
Per email settings on preferred body part format.
When the airsyncbase:BodyPartPreference element is specified, the server returns the unique parts of the email message body with reference to the parent item across all collections.
For more information about the airsyncbase:BodyPartPreference element, see [MS-ASAIRS] section 2.2.2.11.
Rights management support
Indicates whether the device has information rights management enabled. If information rights management is enabled, the client requests that the information rights management content be returned in its schematized form in the response.
If the airsyncbase:FileReference element (section 2.2.3.8) is present, then the Range element is the only valid child element of the Options element.
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 |
Yes |
|
12.1 |
Yes |
|
14.0 |
Yes |
|
14.1 |
Yes |
|
16.0 |
Yes |
|
16.1 |
Yes |
The same protocol versions that support the Options element in an ItemOperations command request also support the airsyncbase:BodyPreference element as a child element of the Options element. 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.