> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/automation/runbooks/runbook-references/user/mail/set-out-of-office.md).
# Set Out Of Office
### Description
Configures automatic replies for a mailbox and can optionally create an out-of-office calendar event. The runbook can either enable scheduled replies with internal and external messages or disable existing out-of-office settings.
### Location
User → Mail → Set Out Of Office
**Full Runbook name**
rjgit-user\_mail\_set-out-of-office
### Details
| Property | Value |
| ---------------- | -------------------------------------------------------------------------------- |
| Version | 1.1.0 |
| Required modules | RealmJoin.RunbookHelper (>= 0.8.9)
ExchangeOnlineManagement (>= 3.9.2)
|
| Schedulable | no |
### Permissions
#### Application permissions
* **Type**: Office 365 Exchange Online
* Exchange.ManageAsApp
* *Runs Get-/Set-MailboxAutoReplyConfiguration in the app-only Exchange Online session*
#### RBAC roles
* Exchange Administrator
* *Required for the app-only Exchange Online session changing the auto-reply settings*
### Parameters
#### UserName
User principal name of the mailbox. This value is auto-filled by the portal.
| Property | Value |
| ---------------- | -------------------------------------- |
| Required | true |
| Default Value | |
| Type | String |
| Hidden in portal | yes (preset via runbook customization) |
#### Disable
Select whether to enable out-of-office notifications or disable existing out-of-office settings.
| Property | Value |
| ------------------- | ------------------------------- |
| Required | false |
| Default Value | False |
| Type | Boolean |
| Portal display name | Enable or Disable Out-of-Office |
**Portal options**
| Portal option | Value |
| --------------------- | ----- |
| Enable Out-of-Office | |
| Disable Out-of-Office | |
#### Start
Start time for scheduled out-of-office replies.
| Property | Value |
| ------------------- | ---------- |
| Required | false |
| Default Value | (Get-Date) |
| Type | DateTime |
| Portal display name | Start Date |
#### End
End time for scheduled out-of-office replies. If not specified, it defaults to 10 years from the current date.
| Property | Value |
| ------------------- | ---------------------------------------- |
| Required | false |
| Default Value | ((Get-Date) + (New-TimeSpan -Days 3650)) |
| Type | DateTime |
| Portal display name | End Date |
#### MessageInternal
Internal automatic reply message.
| Property | Value |
| ------------- | ----------------------------------------------------------------- |
| Required | false |
| Default Value | Sorry, this person is currently not able to receive your message. |
| Type | String |
#### MessageExternal
External automatic reply message.
| Property | Value |
| ------------- | ----------------------------------------------------------------- |
| Required | false |
| Default Value | Sorry, this person is currently not able to receive your message. |
| Type | String |
#### ExternalAudience
Controls who receives external automatic replies. Use None to send no external replies, Known to send replies only to known external contacts, or All to send replies to all external senders.
| Property | Value |
| ------------- | ------ |
| Required | false |
| Default Value | All |
| Type | String |
#### CreateEvent
If set to true, creates an out-of-office calendar event.
| Property | Value |
| ------------- | ------- |
| Required | false |
| Default Value | False |
| Type | Boolean |
#### EventSubject
Subject for the optional out-of-office calendar event.
| Property | Value |
| ------------- | ------------- |
| Required | false |
| Default Value | Out of Office |
| Type | String |
[Back to Runbook Reference overview](/automation/runbooks/runbook-references.md)
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.realmjoin.com/automation/runbooks/runbook-references/user/mail/set-out-of-office.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.