GetUserOofSettings operation
Published: July 16, 2012
Applies to: Exchange 2013 | Exchange Online | Exchange Server 2007 | Exchange Server 2010
The GetUserOofSettings operation gets a mailbox user's Out of Office (OOF) settings and messages.
The GetUserOofSettings operation can use the SOAP headers that are listed and described in the following table.
Header | Element | Description |
|---|---|---|
Impersonation | Identifies the user whom the client application is impersonating. | |
ServerVersion | Identifies the version of the server that responded to the request. |
The GetUserOofSettings operation provides access to a user's OOF settings. A user is identified by the user's email address. If the OOF message is null and OOF is enabled, no OOF message is sent.
 Important |
|---|
If the OOF messages are set by MicrosoftOfficeOutlook, this operation will return the OOF messages in HTML format. |
Description
The following example shows a GetUserOofSettings request that gets a single user's OOF information.
Code
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetUserOofSettingsRequest xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<Mailbox xmlns ="http://schemas.microsoft.com/exchange/services/2006/types">
<Address>User1@example.com</Address>
</Mailbox>
</GetUserOofSettingsRequest>
</soap:Body>
</soap:Envelope>
Request Elements
The following elements are used in the request:
Description
The following example shows a disabled OOF state with the OOF messages.
Code
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<t:ServerVersionInfo MajorVersion="8" MinorVersion="0" MajorBuildNumber="685" MinorBuildNumber="8"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" />
</soap:Header>
<soap:Body>
<GetUserOofSettingsResponse xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseMessage ResponseClass="Success">
<ResponseCode>NoError</ResponseCode>
</ResponseMessage>
<OofSettings xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
<OofState>Disabled</OofState>
<ExternalAudience>All</ExternalAudience>
<Duration>
<StartTime>2006-11-03T23:00:00</StartTime>
<EndTime>2006-11-04T23:00:00</EndTime>
</Duration>
<InternalReply>
<Message>I am out of office. This is my internal reply.</Message>
</InternalReply>
<ExternalReply>
<Message>I am out of office. This is my external reply.</Message>
</ExternalReply>
</OofSettings>
<AllowExternalOof>All</AllowExternalOof>
</GetUserOofSettingsResponse>
</soap:Body>
</soap:Envelope>
Successful GetUserOofSettings Response Elements
Description
The following example shows an error response caused by an attempt to access another user's OOF information.
Code
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<t:ServerVersionInfo MajorVersion="8" MinorVersion="0" MajorBuildNumber="685" MinorBuildNumber="8"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" />
</soap:Header>
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Microsoft.Exchange.Data.Storage.AccessDeniedException: User is not mailbox owner. User = S-1-5-21-3642464542-282065186-3871681729-1155, MailboxGuid = S-1-5-21-3642464542-282065186-3871681729-1156 ---> User is not mailbox owner. </faultstring>
<faultactor>https://CAS01.example.com/EWS/Exchange.asmx</faultactor>
<detail>
<ErrorCode xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">-2146233088</ErrorCode>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>
Date | Description |
|---|---|
July 16, 2012 | Initial publication |
