CData Python Connector for Microsoft Exchange

Build 25.0.9454

GetUserOofSettings

Retrieves the Out of Office (OOF) settings for a given user, identified by their email address. It includes information on whether automatic replies are enabled and any custom OOF messages configured by the user.

Input

Name Type Required Description
User String True The email address of the user whose Out of Office (OOF) settings are being retrieved. This is the primary target of the request.
ImpersonationUser String False The email address of the account to impersonate when performing the OOF settings request. This is used when the calling user has delegated access or application permissions.
ImpersonationType String False Specifies the type of identifier used for impersonating the user. Accepted values include PrincipalName, SID, PrimarySmtpAddress, or SmtpAddress.

Result Set Columns

Name Type Description
OofState String Indicates the current Out of Office (OOF) status of the user. Possible values are: Disabled (OOF is off), Enabled (OOF is always on), or Scheduled (OOF is active during a specified time range).
ExternalAudience String Defines which external senders receive the user's Out of Office response. Options include: None (no external replies), Known (only contacts), or All (all external senders).
StartTime String The start date and time for the scheduled Out of Office period, if the OOF state is set to Scheduled. Ignored when OOF is Disabled or always Enabled.
EndTime String The end date and time for the scheduled Out of Office period. Relevant only when the OOF state is Scheduled.
InternalReply String The automatic reply message sent to users within the same organization or trusted domains during the OOF period.
ExternalReply String The automatic reply message sent to users outside the organization, based on the selected external audience policy.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454