@pnp/cli-microsoft365 11.0.0-beta.1f852eb → 11.0.0-beta.3d99ea3

package/dist/m365/entra/commands/app/app-add.js

@@ -425,7 +425,9 @@ _a = EntraAppAddCommand, _EntraAppAddCommand_instances = new WeakSet(), _EntraAp
             certificateBase64Encoded: typeof args.options.certificateBase64Encoded !== 'undefined',
             certificateDisplayName: typeof args.options.certificateDisplayName !== 'undefined',
             grantAdminConsent: typeof args.options.grantAdminConsent !== 'undefined',
-            allowPublicClientFlows: typeof args.options.allowPublicClientFlows !== 'undefined'
+            allowPublicClientFlows: typeof args.options.allowPublicClientFlows !== 'undefined',
+            bundleId: typeof args.options.bundleId !== 'undefined',
+            signatureHash: typeof args.options.signatureHash !== 'undefined'
         });
     });
 }, _EntraAppAddCommand_initOptions = function _EntraAppAddCommand_initOptions() {
@@ -465,6 +467,10 @@ _a = EntraAppAddCommand, _EntraAppAddCommand_instances = new WeakSet(), _EntraAp
         option: '--certificateDisplayName [certificateDisplayName]'
     }, {
         option: '--manifest [manifest]'
+    }, {
+        option: '--bundleId [bundleId]'
+    }, {
+        option: '--signatureHash [signatureHash]'
     }, {
         option: '--save'
     }, {
@@ -519,12 +525,18 @@ _a = EntraAppAddCommand, _EntraAppAddCommand_instances = new WeakSet(), _EntraAp
                 return `Error while parsing the specified manifest: ${e}`;
             }
         }
+        if (args.options.platform === 'apple' && !args.options.bundleId) {
+            return `When you use platform apple, you'll need to specify bundleId`;
+        }
+        if (args.options.platform === 'android' && (!args.options.bundleId || !args.options.signatureHash)) {
+            return `When you use platform android, you'll need to specify bundleId and signatureHash`;
+        }
         return true;
     });
 }, _EntraAppAddCommand_initOptionSets = function _EntraAppAddCommand_initOptionSets() {
     this.optionSets.push({ options: ['name', 'manifest'] });
 };
-EntraAppAddCommand.entraApplicationPlatform = ['spa', 'web', 'publicClient'];
+EntraAppAddCommand.entraApplicationPlatform = ['spa', 'web', 'publicClient', 'apple', 'android'];
 EntraAppAddCommand.entraAppScopeConsentBy = ['admins', 'adminsAndUsers'];
 export default new EntraAppAddCommand();
 //# sourceMappingURL=app-add.js.map

package/dist/m365/outlook/commands/mail/mail-searchfolder-add.js

@@ -0,0 +1,85 @@
+import request from '../../../../request.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import { zod } from '../../../../utils/zod.js';
+import { validation } from '../../../../utils/validation.js';
+import { accessToken } from '../../../../utils/accessToken.js';
+import auth from '../../../../Auth.js';
+const options = globalOptionsZod
+    .extend({
+    userId: zod.alias('i', z.string()
+        .refine(userId => validation.isValidGuid(userId), userId => ({
+        message: `'${userId}' is not a valid GUID.`
+    })).optional()),
+    userName: zod.alias('n', z.string()
+        .refine(userName => validation.isValidUserPrincipalName(userName), userName => ({
+        message: `'${userName}' is not a valid UPN.`
+    })).optional()),
+    folderName: z.string(),
+    messageFilter: z.string(),
+    sourceFoldersIds: z.string().transform((value) => value.split(',')).pipe(z.string().array()),
+    includeNestedFolders: z.boolean().optional()
+})
+    .strict();
+class OutlookMailSearchFolderAddCommand extends GraphCommand {
+    get name() {
+        return commands.MAIL_SEARCHFOLDER_ADD;
+    }
+    get description() {
+        return `Creates a new mail search folder in the user's mailbox`;
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => !(options.userId && options.userName), {
+            message: 'Specify either userId or userName, but not both'
+        });
+    }
+    async commandAction(logger, args) {
+        try {
+            const isAppOnlyAccessToken = accessToken.isAppOnlyAccessToken(auth.connection.accessTokens[auth.defaultResource].accessToken);
+            let requestUrl = `${this.resource}/v1.0/me/mailFolders/searchFolders/childFolders`;
+            if (isAppOnlyAccessToken) {
+                if (!args.options.userId && !args.options.userName) {
+                    throw 'When running with application permissions either userId or userName is required';
+                }
+                const userIdentifier = args.options.userId ?? args.options.userName;
+                requestUrl = `${this.resource}/v1.0/users('${userIdentifier}')/mailFolders/searchFolders/childFolders`;
+                if (args.options.verbose) {
+                    await logger.logToStderr(`Creating a mail search folder in the mailbox of the user ${userIdentifier}...`);
+                }
+            }
+            else {
+                if (args.options.userId || args.options.userName) {
+                    throw 'You can create mail search folder for other users only if CLI is authenticated in app-only mode';
+                }
+            }
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json'
+                },
+                responseType: 'json',
+                data: {
+                    '@odata.type': '#microsoft.graph.mailSearchFolder',
+                    displayName: args.options.folderName,
+                    includeNestedFolders: args.options.includeNestedFolders,
+                    filterQuery: args.options.messageFilter,
+                    sourceFolderIds: args.options.sourceFoldersIds
+                }
+            };
+            const result = await request.post(requestOptions);
+            await logger.log(result);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new OutlookMailSearchFolderAddCommand();
+//# sourceMappingURL=mail-searchfolder-add.js.map

package/dist/m365/outlook/commands.js

@@ -1,5 +1,6 @@
 const prefix = 'outlook';
 export default {
+    MAIL_SEARCHFOLDER_ADD: `${prefix} mail searchfolder add`,
     MAIL_SEND: `${prefix} mail send`,
     MAILBOX_SETTINGS_GET: `${prefix} mailbox settings get`,
     MAILBOX_SETTINGS_SET: `${prefix} mailbox settings set`,

package/dist/m365/pp/commands.js

@@ -3,10 +3,6 @@ export default {
     AIBUILDERMODEL_GET: `${prefix} aibuildermodel get`,
     AIBUILDERMODEL_LIST: `${prefix} aibuildermodel list`,
     AIBUILDERMODEL_REMOVE: `${prefix} aibuildermodel remove`,
-    CARD_CLONE: `${prefix} card clone`,
-    CARD_GET: `${prefix} card get`,
-    CARD_LIST: `${prefix} card list`,
-    CARD_REMOVE: `${prefix} card remove`,
     CHATBOT_GET: `${prefix} chatbot get`,
     CHATBOT_LIST: `${prefix} chatbot list`,
     CHATBOT_REMOVE: `${prefix} chatbot remove`,

package/dist/m365/spo/commands/customaction/customaction-list.js

@@ -33,17 +33,10 @@ class SpoCustomActionListCommand extends SpoCommand {
                 await logger.logToStderr('');
             }
             const customActions = await spo.getCustomActions(args.options.webUrl, args.options.scope);
-            if (customActions.length === 0) {
-                if (this.verbose) {
-                    await logger.logToStderr(`Custom actions not found`);
-                }
-            }
-            else {
-                if (args.options.output !== 'json') {
-                    customActions.forEach(a => a.Scope = this.humanizeScope(a.Scope));
-                }
-                await logger.log(customActions);
+            if (args.options.output !== 'json') {
+                customActions.forEach(a => a.Scope = this.humanizeScope(a.Scope));
             }
+            await logger.log(customActions);
         }
         catch (err) {
             this.handleRejectedPromise(err);

package/dist/m365/spo/commands/homesite/homesite-set.js

@@ -1,79 +1,123 @@
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _SpoHomeSiteSetCommand_instances, _SpoHomeSiteSetCommand_initTelemetry, _SpoHomeSiteSetCommand_initOptions, _SpoHomeSiteSetCommand_initValidators, _SpoHomeSiteSetCommand_initTypes;
+import { z } from 'zod';
+import { zod } from '../../../../utils/zod.js';
+import { globalOptionsZod } from '../../../../Command.js';
 import request from '../../../../request.js';
 import { spo } from '../../../../utils/spo.js';
 import { validation } from '../../../../utils/validation.js';
 import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.js';
+import { entraGroup } from '../../../../utils/entraGroup.js';
+const optionsSchema = globalOptionsZod
+    .extend({
+    url: zod.alias('u', z.string()
+        .refine((url) => validation.isValidSharePointUrl(url) === true, url => ({
+        message: `'${url}' is not a valid SharePoint Online site URL.`
+    }))),
+    vivaConnectionsDefaultStart: z.boolean().optional(),
+    draftMode: z.boolean().optional(),
+    audienceIds: z.string()
+        .refine(audiences => validation.isValidGuidArray(audiences) === true, audiences => ({
+        message: `The following GUIDs are invalid: ${validation.isValidGuidArray(audiences)}.`
+    })).optional(),
+    audienceNames: z.string().optional(),
+    targetedLicenseType: z.enum(['everyone', 'frontLineWorkers', 'informationWorkers']).optional(),
+    order: z.number()
+        .refine(order => validation.isValidPositiveInteger(order) === true, order => ({
+        message: `'${order}' is not a positive integer.`
+    })).optional()
+});
 class SpoHomeSiteSetCommand extends SpoCommand {
     get name() {
         return commands.HOMESITE_SET;
     }
     get description() {
-        return 'Sets the specified site as the Home Site';
+        return 'Updates an existing SharePoint home site.';
     }
-    constructor() {
-        super();
-        _SpoHomeSiteSetCommand_instances.add(this);
-        __classPrivateFieldGet(this, _SpoHomeSiteSetCommand_instances, "m", _SpoHomeSiteSetCommand_initTelemetry).call(this);
-        __classPrivateFieldGet(this, _SpoHomeSiteSetCommand_instances, "m", _SpoHomeSiteSetCommand_initOptions).call(this);
-        __classPrivateFieldGet(this, _SpoHomeSiteSetCommand_instances, "m", _SpoHomeSiteSetCommand_initValidators).call(this);
-        __classPrivateFieldGet(this, _SpoHomeSiteSetCommand_instances, "m", _SpoHomeSiteSetCommand_initTypes).call(this);
+    get schema() {
+        return optionsSchema;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine((options) => [options.audienceIds, options.audienceNames].filter(o => o !== undefined).length <= 1, {
+            message: 'You must specify either audienceIds or audienceNames but not both.'
+        })
+            .refine((options) => options.vivaConnectionsDefaultStart !== undefined ||
+            options.draftMode !== undefined ||
+            options.audienceIds !== undefined ||
+            options.audienceNames !== undefined ||
+            options.targetedLicenseType !== undefined ||
+            options.order !== undefined, {
+            message: 'You must specify at least one option to configure.'
+        });
     }
     async commandAction(logger, args) {
         try {
             if (this.verbose) {
-                await logger.logToStderr(`Setting the SharePoint home site to: ${args.options.siteUrl}...`);
-                await logger.logToStderr('Attempting to retrieve the SharePoint admin URL.');
+                await logger.logToStderr(`Configuring SharePoint home site: ${args.options.url}...`);
+                await logger.logToStderr(`Attempting to retrieve the SharePoint admin URL.`);
             }
             const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
+            const configuration = {};
+            if (args.options.vivaConnectionsDefaultStart !== undefined) {
+                configuration.IsVivaConnectionsDefaultStartPresent = true;
+                configuration.vivaConnectionsDefaultStart = args.options.vivaConnectionsDefaultStart;
+            }
+            if (args.options.draftMode !== undefined) {
+                configuration.IsInDraftModePresent = true;
+                configuration.isInDraftMode = args.options.draftMode;
+            }
+            if (args.options.audienceIds !== undefined) {
+                configuration.IsAudiencesPresent = true;
+                configuration.Audiences = args.options.audienceIds.split(',').map(id => id.trim());
+            }
+            if (args.options.audienceNames !== undefined) {
+                configuration.IsAudiencesPresent = true;
+                configuration.Audiences = args.options.audienceNames.trim() === '' ? [] : await this.transformAudienceNamesToIds(args.options.audienceNames);
+            }
+            if (args.options.targetedLicenseType !== undefined) {
+                configuration.IsTargetedLicenseTypePresent = true;
+                configuration.TargetedLicenseType = this.convertTargetedLicenseTypeToNumber(args.options.targetedLicenseType);
+            }
+            if (args.options.order !== undefined) {
+                configuration.IsOrderPresent = true;
+                configuration.Order = args.options.order;
+            }
             const requestOptions = {
-                url: `${spoAdminUrl}/_api/SPO.Tenant`,
+                url: `${spoAdminUrl}/_api/SPO.Tenant/UpdateTargetedSite`,
                 headers: {
                     accept: 'application/json;odata=nometadata',
                     'content-Type': 'application/json'
                 },
                 responseType: 'json',
                 data: {
-                    sphSiteUrl: args.options.siteUrl
+                    siteUrl: args.options.url,
+                    configurationParam: configuration
                 }
             };
-            if (args.options.vivaConnectionsDefaultStart !== undefined) {
-                requestOptions.url += '/SetSPHSiteWithConfiguration';
-                requestOptions.data.configuration = { vivaConnectionsDefaultStart: args.options.vivaConnectionsDefaultStart };
-            }
-            else {
-                requestOptions.url += '/SetSPHSite';
-            }
             const res = await request.post(requestOptions);
-            await logger.log(res.value);
+            await logger.log(res);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);
         }
     }
+    convertTargetedLicenseTypeToNumber(licenseType) {
+        const licenseTypeMap = {
+            'everyone': 0,
+            'frontLineWorkers': 1,
+            'informationWorkers': 2
+        };
+        return licenseTypeMap[licenseType];
+    }
+    async transformAudienceNamesToIds(audienceNames) {
+        const names = audienceNames.split(',');
+        const ids = [];
+        for (const name of names) {
+            const id = await entraGroup.getGroupIdByDisplayName(name.trim());
+            ids.push(id);
+        }
+        return ids;
+    }
 }
-_SpoHomeSiteSetCommand_instances = new WeakSet(), _SpoHomeSiteSetCommand_initTelemetry = function _SpoHomeSiteSetCommand_initTelemetry() {
-    this.telemetry.push((args) => {
-        Object.assign(this.telemetryProperties, {
-            vivaConnectionsDefaultStart: typeof args.options.vivaConnectionsDefaultStart !== 'undefined'
-        });
-    });
-}, _SpoHomeSiteSetCommand_initOptions = function _SpoHomeSiteSetCommand_initOptions() {
-    this.options.unshift({
-        option: '-u, --siteUrl <siteUrl>'
-    }, {
-        option: '--vivaConnectionsDefaultStart [vivaConnectionsDefaultStart]',
-        autocomplete: ['true', 'false']
-    });
-}, _SpoHomeSiteSetCommand_initValidators = function _SpoHomeSiteSetCommand_initValidators() {
-    this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.siteUrl));
-}, _SpoHomeSiteSetCommand_initTypes = function _SpoHomeSiteSetCommand_initTypes() {
-    this.types.boolean.push('vivaConnectionsDefaultStart');
-};
 export default new SpoHomeSiteSetCommand();
 //# sourceMappingURL=homesite-set.js.map

package/dist/m365/spo/commands.js

@@ -193,7 +193,6 @@ export default {
     LISTITEM_ROLEINHERITANCE_BREAK: `${prefix} listitem roleinheritance break`,
     LISTITEM_ROLEINHERITANCE_RESET: `${prefix} listitem roleinheritance reset`,
     LISTITEM_SET: `${prefix} listitem set`,
-    MAIL_SEND: `${prefix} mail send`,
     NAVIGATION_NODE_ADD: `${prefix} navigation node add`,
     NAVIGATION_NODE_GET: `${prefix} navigation node get`,
     NAVIGATION_NODE_LIST: `${prefix} navigation node list`,

package/dist/m365/teams/commands/report/report-directroutingcalls.js

@@ -4,12 +4,12 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _TeamsReportDirectroutingcallsCommand_instances, _TeamsReportDirectroutingcallsCommand_initTelemetry, _TeamsReportDirectroutingcallsCommand_initOptions, _TeamsReportDirectroutingcallsCommand_initValidators;
-import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
+import { odata } from '../../../../utils/odata.js';
 import { validation } from '../../../../utils/validation.js';
-import GraphCommand from '../../../base/GraphCommand.js';
+import GraphApplicationCommand from '../../../base/GraphCommand.js';
 import commands from '../../commands.js';
-class TeamsReportDirectroutingcallsCommand extends GraphCommand {
+class TeamsReportDirectroutingcallsCommand extends GraphApplicationCommand {
     get allowedOutputs() {
         return ['json', 'csv'];
     }
@@ -31,16 +31,9 @@ class TeamsReportDirectroutingcallsCommand extends GraphCommand {
     }
     async commandAction(logger, args) {
         const toDateTimeParameter = formatting.encodeQueryParameter(args.options.toDateTime ? args.options.toDateTime : new Date().toISOString());
-        const requestOptions = {
-            url: `${this.resource}/v1.0/communications/callRecords/getDirectRoutingCalls(fromDateTime=${formatting.encodeQueryParameter(args.options.fromDateTime)},toDateTime=${toDateTimeParameter})`,
-            headers: {
-                accept: 'application/json;odata.metadata=none'
-            },
-            responseType: 'json'
-        };
         try {
-            const res = await request.get(requestOptions);
-            await logger.log(res);
+            const response = await odata.getAllItems(`${this.resource}/v1.0/communications/callRecords/getDirectRoutingCalls(fromDateTime=${formatting.encodeQueryParameter(args.options.fromDateTime)},toDateTime=${toDateTimeParameter})`);
+            await logger.log(response);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);

package/dist/m365/teams/commands/report/report-pstncalls.js

@@ -4,12 +4,12 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _TeamsReportPstncallsCommand_instances, _TeamsReportPstncallsCommand_initTelemetry, _TeamsReportPstncallsCommand_initOptions, _TeamsReportPstncallsCommand_initValidators;
-import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
+import { odata } from '../../../../utils/odata.js';
 import { validation } from '../../../../utils/validation.js';
-import GraphCommand from '../../../base/GraphCommand.js';
+import GraphApplicationCommand from '../../../base/GraphCommand.js';
 import commands from '../../commands.js';
-class TeamsReportPstncallsCommand extends GraphCommand {
+class TeamsReportPstncallsCommand extends GraphApplicationCommand {
     get allowedOutputs() {
         return ['json', 'csv'];
     }
@@ -31,16 +31,9 @@ class TeamsReportPstncallsCommand extends GraphCommand {
     }
     async commandAction(logger, args) {
         const toDateTimeParameter = formatting.encodeQueryParameter(args.options.toDateTime ? args.options.toDateTime : new Date().toISOString());
-        const requestOptions = {
-            url: `${this.resource}/v1.0/communications/callRecords/getPstnCalls(fromDateTime=${formatting.encodeQueryParameter(args.options.fromDateTime)},toDateTime=${toDateTimeParameter})`,
-            headers: {
-                accept: 'application/json;odata.metadata=none'
-            },
-            responseType: 'json'
-        };
         try {
-            const res = await request.get(requestOptions);
-            await logger.log(res);
+            const response = await odata.getAllItems(`${this.resource}/v1.0/communications/callRecords/getPstnCalls(fromDateTime=${formatting.encodeQueryParameter(args.options.fromDateTime)},toDateTime=${toDateTimeParameter})`);
+            await logger.log(response);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);

package/dist/m365/viva/commands.js

@@ -9,9 +9,6 @@ export default {
     ENGAGE_COMMUNITY_USER_ADD: `${prefix} engage community user add`,
     ENGAGE_COMMUNITY_USER_LIST: `${prefix} engage community user list`,
     ENGAGE_COMMUNITY_USER_REMOVE: `${prefix} engage community user remove`,
-    ENGAGE_GROUP_LIST: `${prefix} engage group list`,
-    ENGAGE_GROUP_USER_ADD: `${prefix} engage group user add`,
-    ENGAGE_GROUP_USER_REMOVE: `${prefix} engage group user remove`,
     ENGAGE_MESSAGE_ADD: `${prefix} engage message add`,
     ENGAGE_MESSAGE_GET: `${prefix} engage message get`,
     ENGAGE_MESSAGE_LIKE_SET: `${prefix} engage message like set`,

package/dist/utils/entraApp.js

@@ -143,6 +143,21 @@ export const entraApp = {
                 redirectUris: options.redirectUris.split(',').map(u => u.trim())
             };
         }
+        if (options.platform === 'android') {
+            applicationInfo['publicClient'] = {
+                redirectUris: [
+                    `msauth://${options.bundleId}/${formatting.encodeQueryParameter(options.signatureHash)}`
+                ]
+            };
+        }
+        if (options.platform === 'apple') {
+            applicationInfo['publicClient'] = {
+                redirectUris: [
+                    `msauth://code/msauth.${options.bundleId}%3A%2F%2Fauth`,
+                    `msauth.${options.bundleId}://auth`
+                ]
+            };
+        }
         if (options.implicitFlow) {
             if (!applicationInfo.web) {
                 applicationInfo.web = {};

package/docs/docs/cmd/entra/app/app-add.mdx

@@ -31,7 +31,7 @@ m365 entra appregistration add [options]
 : Comma-separated list of redirect URIs. Requires `platform` to be specified.
 
 `-p, --platform [platform]`
-: Platform for which the `redirectUris` should be configured. Allowed values `spa`, `web`, `publicClient`. Requires `redirectUris` to be specified.
+: Platform for which the app should be configured. Allowed values `spa`, `web`, `publicClient`, `apple`, `android`.
 
 `--implicitFlow`
 : Specify, to indicate that the authorization endpoint should return ID and access tokens.
@@ -75,6 +75,12 @@ m365 entra appregistration add [options]
 `--manifest [manifest]`
 : App manifest as retrieved from Entra ID to create the app registration from. Specify either `name` or `manifest` but not both.
 
+`--bundleId [bundleId]`
+: Specify a bundle Id to add the iOS / macOS or Android platform to the application. Required when platform is `apple` or `android`.
+
+`--signatureHash [signatureHash]`
+: A required hash when specifying a bundle Id and platform `android`.
+
 `--save`
 : Use to store the information about the created app in a local file.
 

package/docs/docs/cmd/outlook/mail/mail-searchfolder-add.mdx

@@ -0,0 +1,147 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook mail searchfolder add
+
+Creates a new mail search folder in the user's mailbox
+
+## Usage
+
+```sh
+m365 outlook mail searchfolder add [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --userId [userId]`
+: The id of the user in whose mailbox the search folder should be created. Specify either `userId` or `userName`, but not both.
+
+`-n, --userName [userName]`
+: The UPN of the user in whose mailbox the search folder should be created. Specify either `userId` or `userName`, but not both.
+
+`--folderName <folderName>`
+: The name of the mail search folder.
+
+`--sourceFolderIds <sourceFolderIds>`
+: Comma-separated list of mail folders that should be searched.
+
+`--includeNestedFolders`
+: The nested mail folders will be searched if specified.
+
+`--messageFilter <messageFilter>`
+: The OData query to filter the messages.
+```
+
+<Global />
+
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions    |
+  |-----------------|----------------|
+  | Microsoft Graph | Mail.ReadWrite |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions    |
+  |-----------------|----------------|
+  | Microsoft Graph | Mail.ReadWrite |
+
+  </TabItem>
+</Tabs>
+
+## Examples
+
+Create a mail search folder in the user's mailbox specified by id for messages from the inbox that contain specific subject
+
+```sh
+m365 outlook mail searchfolder add --userId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --folderName 'CLI m365' --sourceFolderIds 'AQMkADYAAAIBDAAAAA==' --messageFilter "contains(subject, 'CLI for Microsoft 365')"
+```
+
+Create a mail search folder in the user's mailbox specified by UPN for incoming and outgoing messages from a specific year that contain specific text in a message body, search for messages inside all subfolders
+
+```sh
+m365 outlook mail searchfolder add --userName john.doe@contoso.com --folderName 'Power Platform Community' --sourceFolderIds 'AQMkADYAAAIBDAAAAA==,AQMkADYAAAIBDBBBBB==' --includeNestedFolders --messageFilter "contains(body/content,'Power Platform') AND receivedDateTime ge 2024-01-01 AND receivedDateTime le 2024-12-31"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQABco84sgAAAA==",
+    "displayName": "Microsoft Entra",
+    "parentFolderId": "AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEEAAAA",
+    "childFolderCount": 0,
+    "unreadItemCount": 27,
+    "totalItemCount": 41,
+    "sizeInBytes": null,
+    "isHidden": false,
+    "isSupported": true,
+    "includeNestedFolders": false,
+    "sourceFolderIds": [
+      "AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEMAAAA"
+    ],
+    "filterQuery": "contains(subject,'Microsoft Entra ID')"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  childFolderCount    : 0
+  displayName         : Microsoft Entra
+  filterQuery         : contains(subject,'Microsoft Entra ID')
+  id                  : AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQABco88nAAAAA==
+  includeNestedFolders: false
+  isHidden            : false
+  isSupported         : true
+  parentFolderId      : AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEEAAAA
+  sizeInBytes         : null
+  sourceFolderIds     : ["AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEMAAAA"]
+  totalItemCount      : 41
+  unreadItemCount     : 27
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,displayName,parentFolderId,childFolderCount,unreadItemCount,totalItemCount,sizeInBytes,isHidden,isSupported,includeNestedFolders,filterQuery
+  AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQABco88ngAAAA==,Microsoft Entra,AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEEAAAA,0,27,41,,,1,,"contains(subject,'Microsoft Entra ID')"
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # outlook mail searchfolder add --debug "false" --verbose "false" --userName "john.doe@contoso.com" --folderName "Microsoft Entra4" --messageFilter "contains(subject,'Microsoft Entra ID')" --sourceFoldersIds "AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEMAAAA"
+
+  Date: 9/6/2024
+
+  ## Microsoft Entra (AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQABco88oAAAAA==)
+
+  Property | Value
+  ---------|-------
+  id | AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQABco88oAAAAA==
+  displayName | Microsoft Entra
+  parentFolderId | AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEEAAAA
+  childFolderCount | 0
+  unreadItemCount | 27
+  totalItemCount | 41
+  isHidden | false
+  isSupported | true
+  includeNestedFolders | false
+  filterQuery | contains(subject,'Microsoft Entra ID')
+  ```
+
+  </TabItem>
+</Tabs>