cipp_set_out_of_office
DestructiveIdempotent
Configure out-of-office auto-replies for a mailbox: enable, disable, or schedule replies with custom messages and optional calendar events.
Instructions
⚠ HIGH-IMPACT. Configures the out-of-office / auto-reply for a mailbox, which causes automated messages to be sent to internal and/or external senders. Reversible by disabling the auto-reply. Confirm with the user before invoking.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| upn | Yes | User Principal Name of the mailbox to configure. | |
| state | Yes | Auto-reply state. 'Scheduled' replies only between startTime and endTime — useful during offboarding. | |
| endTime | No | When the scheduled auto-reply ends — ISO 8601 datetime or Unix epoch seconds. Only valid when state is 'Scheduled'; CIPP defaults to 7 days after startTime if omitted. | |
| timezone | No | Timezone the schedule is interpreted in (e.g. 'Eastern Standard Time'). Requires a recent CIPP build; older ones ignore it. | |
| startTime | No | When the scheduled auto-reply starts — ISO 8601 datetime or Unix epoch seconds. Only valid when state is 'Scheduled'; CIPP defaults to now if omitted. | |
| tenantFilter | Yes | Tenant domain name or ID to scope the operation. Use 'allTenants' to target every managed tenant. | |
| createOOFEvent | No | Create a calendar event covering the out-of-office window. Only valid when state is 'Scheduled'. | |
| externalMessage | No | HTML or plain-text auto-reply message sent to senders outside the organisation. Omit to leave the existing message untouched. | |
| internalMessage | No | HTML or plain-text auto-reply message sent to senders within the same organisation. Omit to leave the existing message untouched. | |
| oofEventSubject | No | Subject line for the calendar event created by createOOFEvent. Only valid when state is 'Scheduled'. | |
| declineMeetingMessage | No | Message sent when a meeting is declined. Only valid when state is 'Scheduled'. | |
| declineEventsForScheduledOOF | No | Decline existing meetings that fall inside the out-of-office window. Only valid when state is 'Scheduled'. | |
| autoDeclineFutureRequestsWhenOOF | No | Automatically decline meeting requests that arrive for the out-of-office window. Only valid when state is 'Scheduled'. |