OofState

Article
03/29/2023

The OofState element is used to get or set the user's Out of Office (OOF) state.

<OofState>Disabled or Enabled or Scheduled</OofState>

OofState

Attributes and elements

The following sections describe attributes, child elements, and parent elements.

Attributes

None.

Child elements

None.

Parent elements

Element	Description
UserOofSettings	Specifies the OOF settings. The following is the XPath expression to this element: `/SetUserOofSettingsRequest/UserOofSettings`
OofSettings	Contains the OOF settings. The following is the XPath expression to this element: `/GetUserOofSettingsResponse/OofSettings`

Text value

A text value is required for the OofState element. The following list contains the possible values for this element:

Disabled
Enabled
Scheduled

A value of Scheduled indicates that the OOF status is set to Enabled during a time period identified by the Duration (UserOofSettings) element.

Remarks

This element is required in both the SetUsersOofSettingRequest message and the GetUserOofSettingResponse message.

The schema that describes this element is located in the EWS virtual directory of the computer that is running MicrosoftExchange Server 2007 that has the Client Access server role installed.

Example

The following example of a SetUserOofSettings request enables the OofState.

<?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>
    <SetUserOofSettingsRequest xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
      <Mailbox xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
        <Name>David Alexander</Name>
        <Address>someone@example.com</Address>
        <RoutingType>SMTP</RoutingType>
      </Mailbox>
      <UserOofSettings xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
        <OofState>Enabled</OofState>
        <ExternalAudience>All</ExternalAudience>
        <Duration>
          <StartTime>2005-10-05T00:00:00</StartTime>
          <EndTime>2005-10-25T00: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>
      </UserOofSettings>
    </SetUserOofSettingsRequest>
  </soap:Body>
</soap:Envelope>

Element information

Element	Example
Namespace	http://schemas.microsoft.com/exchange/services/2006/types
Schema Name	Types schema
Validation File	Types.xsd
Can be Empty	False

Share via