2.2.3.123 OofMessage
The OofMessage element is an optional child element of the Set element in Settings command requests and an optional child element of the Get element in Settings command responses. It specifies the OOF message for a particular audience.
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 Oof request (section 2.2.1.18) |
Set (section 2.2.3.167) |
AppliesToInternal (section 2.2.3.14) AppliesToExternalKnown (section 2.2.3.12) AppliesToExternalUnknown (section 2.2.3.13) Enabled (section 2.2.3.59) ReplyMessage (section 2.2.3.149) BodyType (section 2.2.3.17) |
container ([MS-ASDTYPE] section 2.2) |
0...3 (optional) |
|
Settings command Oof response |
Get (section 2.2.3.83) |
AppliesToInternal AppliesToExternalKnown AppliesToExternalUnknown Enabled ReplyMessage BodyType |
container |
0...3 (optional) |
The Oof property (section 2.2.3.122) supports the following three audiences for an OOF message:<11>
§ Internal—A user who is in the same organization as the sending user.
§ Known external—A user who is outside the sending user's organization, but is represented in the sending user's contacts.
§ Unknown external—A user who is outside the sending user's organization and is not represented in the sending user's contacts.
The presence of one of the following elements, which are mutually exclusive, indicates the audience to which an OOF message pertains:
§ AppliesToInternal—The OOF message is relevant to an internal audience.
§ AppliesToExternalKnown—The OOF message is relevant to a known external audience.
§ AppliesToExternalUnknown—The OOF message is relevant to an unknown external audience.
There is one OofMessage node per audience in a Settings command Oof Get response. If a sender group is allowed, but is disabled and has no reply message (specified by the ReplyMessage element), an OofMessage node is reported to the client. If AppliesToExternalKnown or AppliesToExternalUnknown are not allowed and are disabled by the administrator but are sent by the client in the Settings command Oof Set request, the response returns a successful Status element (section 2.2.3.177.15) value of 1 even though the user does not have access to these settings. Similarly, the AppliesToExternalKnown element and the AppliesToExternalUnknown element are returned to the client the response even if the sender group is not allowed and is disabled.
In a Settings command Oof Set request, the client MUST NOT include the same AppliesTo* element in more than one OofMessage 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 |