Skip to content

Commit fee11aa

Browse files
committed
New command: outlook mailbox settings get
1 parent f5e6f85 commit fee11aa

File tree

7 files changed

+490
-0
lines changed

7 files changed

+490
-0
lines changed
Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
import Global from '/docs/cmd/_global.mdx';
2+
import Tabs from '@theme/Tabs';
3+
import TabItem from '@theme/TabItem';
4+
5+
# outlook mailbox settings get
6+
7+
Get the user's mailbox settings
8+
9+
## Usage
10+
11+
```sh
12+
m365 outlook mailbox settings get [options]
13+
```
14+
15+
## Options
16+
17+
```md definition-list
18+
`-i, --userId [userId]`
19+
: 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.
20+
21+
`-n, --userName [userName]`
22+
: 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.
23+
```
24+
25+
<Global />
26+
27+
## Examples
28+
29+
Get mailbox settings of signed-in user
30+
31+
```sh
32+
m365 outlook mailbox settings get
33+
```
34+
35+
Get mailbox settings of a user specified by id
36+
37+
```sh
38+
m365 outlook mailbox settings get --userId 1caf7dcd-7e83-4c3a-94f7-932a1299c844
39+
```
40+
41+
## Response
42+
43+
<Tabs>
44+
<TabItem value="JSON">
45+
46+
```json
47+
{
48+
"archiveFolder": "AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA",
49+
"timeZone": "Central Europe Standard Time",
50+
"delegateMeetingMessageDeliveryOptions": "sendToDelegateOnly",
51+
"dateFormat": "dd.MM.yyyy",
52+
"timeFormat": "H:mm",
53+
"userPurpose": "user",
54+
"automaticRepliesSetting": {
55+
"status": "disabled",
56+
"externalAudience": "all",
57+
"internalReplyMessage": "On vacation. Will be back.",
58+
"externalReplyMessage": "Vacation",
59+
"scheduledStartDateTime": {
60+
"dateTime": "2025-01-20T08:00:00.0000000",
61+
"timeZone": "UTC"
62+
},
63+
"scheduledEndDateTime": {
64+
"dateTime": "2025-01-25T18:00:00.0000000",
65+
"timeZone": "UTC"
66+
}
67+
},
68+
"language": {
69+
"locale": "en-US",
70+
"displayName": "English (United States)"
71+
},
72+
"workingHours": {
73+
"daysOfWeek": [
74+
"monday",
75+
"tuesday",
76+
"wednesday",
77+
"thursday",
78+
"friday"
79+
],
80+
"startTime": "08:00:00.0000000",
81+
"endTime": "16:30:00.0000000",
82+
"timeZone": {
83+
"name": "Central Europe Standard Time"
84+
}
85+
}
86+
}
87+
```
88+
89+
</TabItem>
90+
<TabItem value="Text">
91+
92+
```text
93+
archiveFolder : AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA
94+
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"}}
95+
dateFormat : dd.MM.yyyy
96+
delegateMeetingMessageDeliveryOptions: sendToDelegateOnly
97+
language : {"locale":"en-US","displayName":"English (United States)"}
98+
timeFormat : H:mm
99+
timeZone : Central Europe Standard Time
100+
userPurpose : user
101+
workingHours : {"daysOfWeek":["monday","tuesday","wednesday","thursday","friday"],"startTime":"08:00:00.0000000","endTime":"16:30:00.0000000","timeZone":{"name":"Central Europe Standard Time"}}
102+
```
103+
104+
</TabItem>
105+
<TabItem value="CSV">
106+
107+
```csv
108+
archiveFolder,timeZone,delegateMeetingMessageDeliveryOptions,dateFormat,timeFormat,userPurpose
109+
AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA,Central Europe Standard Time,sendToDelegateOnly,dd.MM.yyyy,H:mm,user
110+
```
111+
112+
</TabItem>
113+
<TabItem value="Markdown">
114+
115+
```md
116+
# outlook mailbox settings get
117+
118+
Date: 1/17/2025
119+
120+
Property | Value
121+
---------|-------
122+
archiveFolder | AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA
123+
timeZone | Central Europe Standard Time
124+
delegateMeetingMessageDeliveryOptions | sendToDelegateOnly
125+
dateFormat | dd.MM.yyyy
126+
timeFormat | H:mm
127+
userPurpose | user
128+
```
129+
130+
</TabItem>
131+
</Tabs>

docs/src/config/sidebars.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1184,6 +1184,11 @@ const sidebars: SidebarsConfig = {
11841184
},
11851185
{
11861186
mailbox: [
1187+
{
1188+
type: 'doc',
1189+
label: 'mailbox settings get',
1190+
id: 'cmd/outlook/mailbox/mailbox-settings-get'
1191+
},
11871192
{
11881193
type: 'doc',
11891194
label: 'mailbox settings set',

src/m365/outlook/commands.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ const prefix: string = 'outlook';
22

33
export default {
44
MAIL_SEND: `${prefix} mail send`,
5+
MAILBOX_SETTINGS_GET: `${prefix} mailbox settings get`,
56
MAILBOX_SETTINGS_SET: `${prefix} mailbox settings set`,
67
MESSAGE_GET: `${prefix} message get`,
78
MESSAGE_LIST: `${prefix} message list`,

0 commit comments

Comments
 (0)