Adds command 'outlook mailbox settings get'. Closes #6567

pnp · Feb 3, 2025 · 687bc88 · 687bc88
1 parent f6eb637
commit 687bc88
Show file tree

Hide file tree

Showing 7 changed files with 491 additions and 6 deletions.
diff --git a/docs/docs/cmd/outlook/mailbox/mailbox-settings-get.mdx b/docs/docs/cmd/outlook/mailbox/mailbox-settings-get.mdx
@@ -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 the signed-in user
+
+```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>
diff --git a/docs/src/config/sidebars.ts b/docs/src/config/sidebars.ts
@@ -1212,6 +1212,11 @@ const sidebars: SidebarsConfig = {
         },
         {
           mailbox: [
+            {
+              type: 'doc',
+              label: 'mailbox settings get',
+              id: 'cmd/outlook/mailbox/mailbox-settings-get'
+            },
             {
               type: 'doc',
               label: 'mailbox settings set',

diff --git a/src/m365/outlook/commands.ts b/src/m365/outlook/commands.ts
@@ -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`,