Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New command: outlook mailbox settings get. Closes #6567 #6569

Closed
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 131 additions & 0 deletions docs/docs/cmd/outlook/mailbox/mailbox-settings-get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# outlook mailbox settings get

Get the user's mailbox settings

## Usage

```sh
m365 outlook mailbox settings get [options]
```

## Options

```md definition-list
`-i, --userId [userId]`
: The ID of the Microsoft Entra user for which you want to get mailbox settings. Specify either `userId` or `userName`, but not both. This option is required when using application permissions.

`-n, --userName [userName]`
: The UPN of the Microsoft Entra user for which you want to get mailbox settings. Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
```

<Global />

## Examples

Get mailbox settings of signed-in user
MartinM85 marked this conversation as resolved.
Show resolved Hide resolved

```sh
m365 outlook mailbox settings get
```

Get mailbox settings of a user specified by id

```sh
m365 outlook mailbox settings get --userId 1caf7dcd-7e83-4c3a-94f7-932a1299c844
```

## Response

<Tabs>
<TabItem value="JSON">

```json
{
"archiveFolder": "AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA",
"timeZone": "Central Europe Standard Time",
"delegateMeetingMessageDeliveryOptions": "sendToDelegateOnly",
"dateFormat": "dd.MM.yyyy",
"timeFormat": "H:mm",
"userPurpose": "user",
"automaticRepliesSetting": {
"status": "disabled",
"externalAudience": "all",
"internalReplyMessage": "On vacation. Will be back.",
"externalReplyMessage": "Vacation",
"scheduledStartDateTime": {
"dateTime": "2025-01-20T08:00:00.0000000",
"timeZone": "UTC"
},
"scheduledEndDateTime": {
"dateTime": "2025-01-25T18:00:00.0000000",
"timeZone": "UTC"
}
},
"language": {
"locale": "en-US",
"displayName": "English (United States)"
},
"workingHours": {
"daysOfWeek": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"startTime": "08:00:00.0000000",
"endTime": "16:30:00.0000000",
"timeZone": {
"name": "Central Europe Standard Time"
}
}
}
```

</TabItem>
<TabItem value="Text">

```text
archiveFolder : AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA
automaticRepliesSetting : {"status":"disabled","externalAudience":"all","internalReplyMessage":"","externalReplyMessage":"","scheduledStartDateTime":{"dateTime":"2025-01-20T08:00:00.0000000","timeZone":"UTC"},"scheduledEndDateTime":{"dateTime":"2025-01-25T18:00:00.0000000","timeZone":"UTC"}}
dateFormat : dd.MM.yyyy
delegateMeetingMessageDeliveryOptions: sendToDelegateOnly
language : {"locale":"en-US","displayName":"English (United States)"}
timeFormat : H:mm
timeZone : Central Europe Standard Time
userPurpose : user
workingHours : {"daysOfWeek":["monday","tuesday","wednesday","thursday","friday"],"startTime":"08:00:00.0000000","endTime":"16:30:00.0000000","timeZone":{"name":"Central Europe Standard Time"}}
```

</TabItem>
<TabItem value="CSV">

```csv
archiveFolder,timeZone,delegateMeetingMessageDeliveryOptions,dateFormat,timeFormat,userPurpose
AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA,Central Europe Standard Time,sendToDelegateOnly,dd.MM.yyyy,H:mm,user
```

</TabItem>
<TabItem value="Markdown">

```md
# outlook mailbox settings get

Date: 1/17/2025

Property | Value
---------|-------
archiveFolder | AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA
timeZone | Central Europe Standard Time
delegateMeetingMessageDeliveryOptions | sendToDelegateOnly
dateFormat | dd.MM.yyyy
timeFormat | H:mm
userPurpose | user
```

</TabItem>
</Tabs>
5 changes: 5 additions & 0 deletions docs/src/config/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1184,6 +1184,11 @@ const sidebars: SidebarsConfig = {
},
{
mailbox: [
{
type: 'doc',
label: 'mailbox settings get',
id: 'cmd/outlook/mailbox/mailbox-settings-get'
},
{
type: 'doc',
label: 'mailbox settings set',
Expand Down
1 change: 1 addition & 0 deletions src/m365/outlook/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ const prefix: string = 'outlook';

export default {
MAIL_SEND: `${prefix} mail send`,
MAILBOX_SETTINGS_GET: `${prefix} mailbox settings get`,
MAILBOX_SETTINGS_SET: `${prefix} mailbox settings set`,
MESSAGE_GET: `${prefix} message get`,
MESSAGE_LIST: `${prefix} message list`,
Expand Down
Loading
Loading