n8n/packages/nodes-base/nodes/Microsoft/Outlook/FolderDescription.ts

312 lines
5.4 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
export const folderOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'folder',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a new mail folder in the root folder of the user\'s mailbox',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a folder',
},
{
name: 'Get',
value: 'get',
description: 'Get a single folder details',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all folders under the root folder of the signed-in user',
},
{
name: 'Get Children',
value: 'getChildren',
description: 'Lists all child folders under the folder',
},
],
default: 'create',
description: 'The operation to perform.',
},
];
export const folderFields: INodeProperties[] = [
{
displayName: 'Folder ID',
name: 'folderId',
description: 'Folder ID',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'folder',
],
operation: [
'delete',
'get',
'getChildren',
'update',
],
},
},
},
// folder:list, getChildren, listMessages
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'folder',
],
operation: [
'getAll',
'getChildren',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'folder',
],
operation: [
'getAll',
'getChildren',
],
returnAll: [false],
},
},
typeOptions: {
minValue: 1,
maxValue: 500,
},
default: 100,
description: 'How many results to return.',
},
// folder:create
{
displayName: 'Type',
name: 'folderType',
description: 'Folder Type',
type: 'options',
options: [
{
name: 'Folder',
value: 'folder',
},
{
name: 'Search Folder',
value: 'searchFolder',
},
],
displayOptions: {
show: {
resource: [
'folder',
],
operation: [
'create',
],
},
},
default: 'folder',
},
{
displayName: 'Display Name',
name: 'displayName',
description: 'Name of the folder.',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'folder',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Include Nested Folders',
name: 'includeNestedFolders',
description: 'Include child folders in the search.',
type: 'boolean',
default: false,
displayOptions: {
show: {
resource: [
'folder',
],
operation: [
'create',
],
folderType: [
'searchFolder',
],
},
},
},
{
displayName: 'Source Folder IDs',
name: 'sourceFolderIds',
description: 'The mailbox folders that should be mined.',
type: 'string',
typeOptions: {
multipleValues: true,
},
default: [],
displayOptions: {
show: {
resource: [
'folder',
],
operation: [
'create',
],
folderType: [
'searchFolder',
],
},
},
},
{
displayName: 'Filter Query',
name: 'filterQuery',
description: 'The OData query to filter the messages.',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'folder',
],
operation: [
'create',
],
folderType: [
'searchFolder',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'folder',
],
operation: [
'get',
'getAll',
'getChildren',
],
},
},
options: [
{
displayName: 'Fields',
name: 'fields',
type: 'string',
default: '',
description: 'Fields the response will contain. Multiple can be added separated by ,.',
},
{
displayName: 'Filter',
name: 'filter',
type: 'string',
default: '',
description: 'Microsoft Graph API OData $filter query. Information about the syntax can be found <a href="https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter">here</a>.',
},
],
},
// folder:update
{
displayName: 'Update Fields',
name: 'updateFields',
description: 'Fields to update.',
type: 'collection',
default: {},
displayOptions: {
show: {
resource: [
'folder',
],
operation: [
'update',
],
},
},
options: [
{
displayName: 'Display Name',
name: 'displayName',
description: 'Name of the folder.',
type: 'string',
default: '',
},
{
displayName: 'Filter Query',
name: 'filterQuery',
description: 'The OData query to filter the messages. Only for search folders.',
type: 'string',
default: '',
},
{
displayName: 'Include Nested Folders',
name: 'includeNestedFolders',
description: 'Include child folders in the search. Only for search folders.',
type: 'boolean',
default: false,
},
{
displayName: 'Source Folder IDs',
name: 'sourceFolderIds',
description: 'The mailbox folders that should be mined. Only for search folders.',
type: 'string',
typeOptions: {
multipleValues: true,
},
default: [],
},
],
},
];