2.2.3.122 Oof
The Oof element is an optional child element of the Settings element in Settings command requests and responses that specifies a named property node for retrieving and setting Out of Office (OOF) information.
All elements referenced in this section are defined in the Settings namespace.
|
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
|---|---|---|---|---|
|
Settings command request (section 2.2.1.18) |
Settings (section 2.2.3.168.2) |
Get (section 2.2.3.83) Set (section 2.2.3.167)
|
container ([MS-ASDTYPE] section 2.2) |
0...1 (optional) |
|
Settings command response |
Settings |
Get Status (section 2.2.3.177.15) |
container |
0...1 (optional) |
The Settings command request supports Get and Set operations for the Oof element. The Oof element enables a user to do the following:
§ Specify whether the user is currently out of office.
§ Schedule an out of office message to be sent between a particular start date and end date.
§ Specify the message that is to be shown to various audiences when the mobile device user is out of office.
Oof Get Request and Response
The Get element within the Oof element of a Settings command request enables the client to retrieve OOF information from the server. The client specifies the body type (BodyType element (section 2.2.3.17)) to be retrieved and the server will return all OOF information and messages.
In a Settings command Oof Get response, there is one OofMessage node (section 2.2.3.123) per audience. If the sender group is allowed, but is disabled and has no reply message (specified by the ReplyMessage element (section 2.2.3.149)), an OofMessage node is still reported to the client.
If the client does not receive a group, it is presumably because the client does not have permission to enter settings for that group; in such a case, any attempt to set those properties results in an Access Denied status code.
Oof Set Request and Response
The Set element within the Oof element of a Settings command request enables the client to set the OOF status, time OOF, and OOF messages for one or more of the following groups:
§ Internal
§ External Known Senders (such as contacts)
§ External Unknown Senders
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 |