@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.3158148

package/docs/docs/cmd/outlook/report/report-mailactivitycounts.mdx

@@ -0,0 +1,93 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook report mailactivitycounts
+
+Enables you to understand the trends of email activity (like how many were sent, read, and received) in your organization
+
+## Usage
+
+```sh
+m365 outlook report mailactivitycounts [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Gets the trends of email activity (like how many were sent, read, and received) in your organization for the last week
+
+```sh
+m365 outlook report mailactivitycounts --period D7
+```
+
+Gets the trends of email activity (like how many were sent, read, and received) in your organization for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 outlook report mailactivitycounts --period D7 --output text > "mailactivitycounts.txt"
+```
+
+Gets the trends of email activity (like how many were sent, read, and received) in your organization for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 outlook report mailactivitycounts --period D7 --output json > "mailactivitycounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-01-24",
+      "Send": "",
+      "Receive": "2",
+      "Read": "",
+      "Meeting Created": "0",
+      "Meeting Interacted": "",
+      "Report Date": "2023-01-18",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  Report Refresh Date,Send,Receive,Read,Meeting Created,Meeting Interacted,Report Date,Report Period
+  2023-01-24,,2,,0,,2023-01-18,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Send,Receive,Read,Meeting Created,Meeting Interacted,Report Date,Report Period
+  2023-01-24,,2,,0,,2023-01-18,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Send,Receive,Read,Meeting Created,Meeting Interacted,Report Date,Report Period
+  2023-01-24,,2,,0,,2023-01-18,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/outlook/report/report-mailactivityusercounts.mdx

@@ -0,0 +1,93 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook report mailactivityusercounts
+
+Enables you to understand trends on the number of unique users who are performing email activities like send, read, and receive
+
+## Usage
+
+```sh
+m365 outlook report mailactivityusercounts [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Gets the trends on the number of unique users who are performing email activities like send, read, and receive for the last week
+
+```sh
+m365 outlook report mailactivityusercounts --period D7
+```
+
+Gets the trends on the number of unique users who are performing email activities like send, read, and receive for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 outlook report mailactivityusercounts --period D7 --output text > "mailactivityusercounts.txt"
+```
+
+Gets the trends on the number of unique users who are performing email activities like send, read, and receive for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 outlook report mailactivityusercounts --period D7 --output json > "mailactivityusercounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-01-24",
+      "Send": "",
+      "Receive": "2",
+      "Read": "",
+      "Meeting Created": "0",
+      "Meeting Interacted": "",
+      "Report Date": "2023-01-18",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  Report Refresh Date,Send,Receive,Read,Meeting Created,Meeting Interacted,Report Date,Report Period
+  2023-01-24,,2,,0,,2023-01-18,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Send,Receive,Read,Meeting Created,Meeting Interacted,Report Date,Report Period
+  2023-01-24,,2,,0,,2023-01-18,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Send,Receive,Read,Meeting Created,Meeting Interacted,Report Date,Report Period
+  2023-01-24,,2,,0,,2023-01-18,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/outlook/report/report-mailactivityuserdetail.mdx

@@ -0,0 +1,107 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook report mailactivityuserdetail
+
+Gets details about email activity users have performed
+
+## Usage
+
+```sh
+m365 outlook report mailactivityuserdetail [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period [period]`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-d, --date [date]`
+: The date for which you would like to view the users who performed any activity. Supported date format is YYYY-MM-DD. Specify the date or period, but not both
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Gets details about email activity users have performed for the last week
+
+```sh
+m365 outlook report mailactivityuserdetail --period D7
+```
+
+Gets details about email activity users have performed for May 1st, 2019
+
+```sh
+m365 outlook report mailactivityuserdetail --date 2019-05-01
+```
+
+Gets details about email activity users have performed for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 outlook report mailactivityuserdetail --period D7 --output text > "mailactivityuserdetail.txt"
+```
+
+Gets details about email activity users have performed for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 outlook report mailactivityuserdetail --period D7 --output json > "mailactivityuserdetail.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-01-24",
+      "User Principal Name": "5535B4D580981B19AD1942C38063507F",
+      "Display Name": "F8C53518381F605C8FBA65C52CB43A1D",
+      "Is Deleted": "False",
+      "Deleted Date": "",
+      "Last Activity Date": "2022-11-29",
+      "Send Count": "0",
+      "Receive Count": "0",
+      "Read Count": "0",
+      "Meeting Created Count": "0",
+      "Meeting Interacted Count": "0",
+      "Assigned Products": "OFFICE 365 E5+MICROSOFT POWER AUTOMATE FREE+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE)",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Last Activity Date,Send Count,Receive Count,Read Count,Meeting Created Count,Meeting Interacted Count,Assigned Products,Report Period
+  2023-01-24,5535B4D580981B19AD1942C38063507F,F8C53518381F605C8FBA65C52CB43A1D,False,,2022-11-29,0,0,0,0,0,OFFICE 365 E5+MICROSOFT POWER AUTOMATE FREE+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE),7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Last Activity Date,Send Count,Receive Count,Read Count,Meeting Created Count,Meeting Interacted Count,Assigned Products,Report Period
+  2023-01-24,5535B4D580981B19AD1942C38063507F,F8C53518381F605C8FBA65C52CB43A1D,False,,2022-11-29,0,0,0,0,0,OFFICE 365 E5+MICROSOFT POWER AUTOMATE FREE+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE),7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Last Activity Date,Send Count,Receive Count,Read Count,Meeting Created Count,Meeting Interacted Count,Assigned Products,Report Period
+  2023-01-24,5535B4D580981B19AD1942C38063507F,F8C53518381F605C8FBA65C52CB43A1D,False,,2022-11-29,0,0,0,0,0,OFFICE 365 E5+MICROSOFT POWER AUTOMATE FREE+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE),7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/outlook/report/report-mailappusageappsusercounts.mdx

@@ -0,0 +1,96 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook report mailappusageappsusercounts
+
+Gets the count of unique users per email app
+
+## Usage
+
+```sh
+m365 outlook report mailappusageappsusercounts [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Gets the count of unique users per email app for the last week
+
+```sh
+m365 outlook report mailappusageappsusercounts --period D7
+```
+
+Gets the count of unique users per email app for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 outlook report mailappusageappsusercounts --period D7 --output text > "mailappusageappsusercounts.txt"
+```
+
+Gets the count of unique users per email app for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 outlook report mailappusageappsusercounts --period D7 --output json > "mailappusageappsusercounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-01-25",
+      "Mail For Mac": "",
+      "Outlook For Mac": "6",
+      "Outlook For Windows": "108",
+      "Outlook For Mobile": "61",
+      "Other For Mobile": "",
+      "Outlook For Web": "2",
+      "POP3 App": "",
+      "IMAP4 App": "",
+      "SMTP App": "",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  Report Refresh Date,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Period
+  2023-01-25,,6,108,61,,2,,,,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Period
+  2023-01-25,,6,108,61,,2,,,,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Period
+  2023-01-25,,6,108,61,,2,,,,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/outlook/report/report-mailappusageusercounts.mdx

@@ -0,0 +1,97 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook report mailappusageusercounts
+
+Gets the count of unique users that connected to Exchange Online using any email app
+
+## Usage
+
+```sh
+m365 outlook report mailappusageusercounts [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Gets the count of unique users that connected to Exchange Online using any email app for the last week
+
+```sh
+m365 outlook report mailappusageusercounts --period D7
+```
+
+Gets the count of unique users that connected to Exchange Online using any email app for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 outlook report mailappusageusercounts --period D7 --output text > "mailappusageusercounts.txt"
+```
+
+Gets the count of unique users that connected to Exchange Online using any email app for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 outlook report mailappusageusercounts --period D7 --output json > "mailappusageusercounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-01-25",
+      "Mail For Mac": "",
+      "Outlook For Mac": "2",
+      "Outlook For Windows": "99",
+      "Outlook For Mobile": "46",
+      "Other For Mobile": "",
+      "Outlook For Web": "",
+      "POP3 App": "",
+      "IMAP4 App": "",
+      "SMTP App": "",
+      "Report Date": "2023-01-19",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  Report Refresh Date,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Date,Report Period
+  2023-01-25,,2,99,46,,,,,,2023-01-19,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Date,Report Period
+  2023-01-25,,2,99,46,,,,,,2023-01-19,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Date,Report Period
+  2023-01-25,,2,99,46,,,,,,2023-01-19,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/outlook/report/report-mailappusageuserdetail.mdx

@@ -0,0 +1,110 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook report mailappusageuserdetail
+
+Gets details about which activities users performed on the various email apps
+
+## Usage
+
+```sh
+m365 outlook report mailappusageuserdetail [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period [period]`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-d, --date [date]`
+: The date for which you would like to view the users who performed any activity. Supported date format is YYYY-MM-DD. Specify the date or period, but not both
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Gets details about which activities users performed on the various email apps for the last week
+
+```sh
+m365 outlook report mailappusageuserdetail --period D7
+```
+
+Gets details about which activities users performed on the various email apps for May 1st, 2019
+
+```sh
+m365 outlook report mailappusageuserdetail --date 2019-05-01
+```
+
+Gets details about which activities users performed on the various email apps for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 outlook report mailappusageuserdetail --period D7 --output text > "mailappusageuserdetail.txt"
+```
+
+Gets details about which activities users performed on the various email apps for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 outlook report mailappusageuserdetail --period D7 --output json > "mailappusageuserdetail.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-01-25",
+      "User Principal Name": "john.doe@contoso.com",
+      "Display Name": "John Doe",
+      "Is Deleted": "False",
+      "Deleted Date": "",
+      "Last Activity Date": "2023-01-25",
+      "Mail For Mac": "",
+      "Outlook For Mac": "",
+      "Outlook For Windows": "ProPlus",
+      "Outlook For Mobile": "",
+      "Other For Mobile": "",
+      "Outlook For Web": "",
+      "POP3 App": "",
+      "IMAP4 App": "",
+      "SMTP App": "",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Last Activity Date,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Period
+  2023-01-25,john.doe@contoso.com,John Doe,False,,2023-01-25,,,ProPlus,,,,,,,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Last Activity Date,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Period
+  2023-01-25,john.doe@contoso.com,John Doe,False,,2023-01-25,,,ProPlus,,,,,,,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Last Activity Date,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Period
+  2023-01-25,john.doe@contoso.com,John Doe,False,,2023-01-25,,,ProPlus,,,,,,,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/outlook/report/report-mailappusageversionsusercounts.mdx

@@ -0,0 +1,94 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook report mailappusageversionsusercounts
+
+Gets the count of unique users by Outlook desktop version.
+
+## Usage
+
+```sh
+m365 outlook report mailappusageversionsusercounts [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Gets the count of unique users by Outlook desktop version for the last week
+
+```sh
+m365 outlook report mailappusageversionsusercounts --period D7
+```
+
+Gets the count of unique users by Outlook desktop version for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 outlook report mailappusageversionsusercounts --period D7 --output text > "mailappusageversionsusercounts.txt"
+```
+
+Gets the count of unique users by Outlook desktop version for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 outlook report mailappusageversionsusercounts --period D7 --output json > "mailappusageversionsusercounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-01-25",
+      "Outlook 2016": "",
+      "Outlook 2013": "",
+      "Outlook 2010": "",
+      "Outlook 2007": "",
+      "Undetermined": "",
+      "Report Period": "7",
+      "Outlook M365": "108",
+      "Outlook 2019": ""
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  Report Refresh Date,Outlook 2016,Outlook 2013,Outlook 2010,Outlook 2007,Undetermined,Report Period,Outlook M365,Outlook 2019
+  2023-01-25,,,,,,7,108,
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Outlook 2016,Outlook 2013,Outlook 2010,Outlook 2007,Undetermined,Report Period,Outlook M365,Outlook 2019
+  2023-01-25,,,,,,7,108,
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Outlook 2016,Outlook 2013,Outlook 2010,Outlook 2007,Undetermined,Report Period,Outlook M365,Outlook 2019
+  2023-01-25,,,,,,7,108,
+  ```
+
+  </TabItem>
+</Tabs>
+