@pnp/cli-microsoft365/dist/m365/outlook/commands/message/message-list.js

Manage Microsoft 365 and SharePoint Framework projects on any platform

import { globalOptionsZod } from '../../../../Command.js';
import request from '../../../../request.js';
import { formatting } from '../../../../utils/formatting.js';
import { odata } from '../../../../utils/odata.js';
import GraphCommand from '../../../base/GraphCommand.js';
import commands from '../../commands.js';
import { Outlook } from '../../Outlook.js';
import { cli } from '../../../../cli/cli.js';
import { validation } from '../../../../utils/validation.js';
import { accessToken } from '../../../../utils/accessToken.js';
import auth from '../../../../Auth.js';
import { z } from 'zod';
export const options = z.strictObject({
    ...globalOptionsZod.shape,
    folderId: z.string().optional(),
    folderName: z.string().optional(),
    startTime: z.string()
        .refine(startTime => validation.isValidISODateTime(startTime), {
        error: e => `'${e.input}' is not a valid ISO date string for option startTime.`
    })
        .refine(startTime => new Date(startTime) <= new Date(), {
        error: 'startTime value cannot be in the future.'
    })
        .optional(),
    endTime: z.string()
        .refine(endTime => validation.isValidISODateTime(endTime), {
        error: e => `'${e.input}' is not a valid ISO date string for option endTime.`
    })
        .refine(endTime => new Date(endTime) <= new Date(), {
        error: 'endTime value cannot be in the future.'
    })
        .optional(),
    userId: z.string()
        .refine(userId => validation.isValidGuid(userId), {
        error: e => `${e.input} is not a valid GUID for option userId.`
    }).optional(),
    userName: z.string()
        .refine(userName => validation.isValidUserPrincipalName(userName), {
        error: e => `${e.input} is not a valid UPN for option userName.`
    }).optional()
});
class OutlookMessageListCommand extends GraphCommand {
    get name() {
        return commands.MESSAGE_LIST;
    }
    get description() {
        return 'Gets all mail messages from the specified folder';
    }
    get schema() {
        return options;
    }
    getRefinedSchema(schema) {
        return schema
            .refine(options => !(options.folderId && options.folderName), {
            error: 'Specify either folderId or folderName, but not both',
            params: {
                customCode: 'optionSet',
                options: ['folderId', 'folderName']
            }
        })
            .refine(options => !(options.userId && options.userName), {
            error: 'Specify either userId or userName, but not both',
            params: {
                customCode: 'optionSet',
                options: ['userId', 'userName']
            }
        })
            .refine(options => !(options.startTime && options.endTime && new Date(options.startTime) >= new Date(options.endTime)), {
            error: 'startTime must be before endTime.'
        });
    }
    defaultProperties() {
        return ['subject', 'receivedDateTime'];
    }
    async commandAction(logger, args) {
        try {
            if (!args.options.userId && !args.options.userName && accessToken.isAppOnlyAccessToken(auth.connection.accessTokens[auth.defaultResource].accessToken)) {
                throw 'You must specify either the userId or userName option when using app-only permissions.';
            }
            const userUrl = args.options.userId || args.options.userName ? `users/${args.options.userId || formatting.encodeQueryParameter(args.options.userName)}` : 'me';
            const folderId = await this.getFolderId(userUrl, args.options);
            const folderUrl = folderId ? `/mailFolders/${folderId}` : '';
            let requestUrl = `${this.resource}/v1.0/${userUrl}${folderUrl}/messages?$top=100`;
            if (args.options.startTime || args.options.endTime) {
                const filters = [];
                if (args.options.startTime) {
                    filters.push(`receivedDateTime ge ${args.options.startTime}`);
                }
                if (args.options.endTime) {
                    filters.push(`receivedDateTime lt ${args.options.endTime}`);
                }
                if (filters.length > 0) {
                    requestUrl += `&$filter=${filters.join(' and ')}`;
                }
            }
            const messages = await odata.getAllItems(requestUrl);
            await logger.log(messages);
        }
        catch (err) {
            this.handleRejectedODataJsonPromise(err);
        }
    }
    async getFolderId(userUrl, options) {
        if (!options.folderId && !options.folderName) {
            return '';
        }
        if (options.folderId) {
            return options.folderId;
        }
        if (Outlook.wellKnownFolderNames.includes(options.folderName.toLowerCase())) {
            return options.folderName;
        }
        const requestOptions = {
            url: `${this.resource}/v1.0/${userUrl}/mailFolders?$filter=displayName eq '${formatting.encodeQueryParameter(options.folderName)}'&$select=id`,
            headers: {
                accept: 'application/json;odata.metadata=none'
            },
            responseType: 'json'
        };
        const response = await request.get(requestOptions);
        if (response.value.length === 0) {
            throw `Folder with name '${options.folderName}' not found`;
        }
        if (response.value.length > 1) {
            const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', response.value);
            const result = await cli.handleMultipleResultsFound(`Multiple folders with name '${options.folderName}' found.`, resultAsKeyValuePair);
            return result.id;
        }
        return response.value[0].id;
    }
}
export default new OutlookMessageListCommand();
//# sourceMappingURL=message-list.js.map