Microsoft: Invoke action move — users Mail Folder user Mail Folders Move

Microsoft usersMailFolder.userMailFoldersMove: arguments, response, policy and SDK examples.

← Users mail folder operations · Get started

Operation microsoft.users_user_mailfolders_mailfolder_move

Provider route: POST /users/{user-id}/mailFolders/{mailFolder-id}/move. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/microsoft with npm, or alter-sdk-microsoft with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MicrosoftIntegration } from "@alter-ai/microsoft";

async function execute(input: Parameters<MicrosoftIntegration["usersMailFolder"]["userMailFoldersMove"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new MicrosoftIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.usersMailFolder.userMailFoldersMove(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_microsoft import MicrosoftIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = MicrosoftIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.users_mail_folder.user_mail_folders_move(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.user-id`	string	Required within parent
`path.mailFolder-id`	string	Required within parent
`body`	object	Required within parent
`body.DestinationId`	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	Model	Alternative	Expand Get mail Folder — response body
`$ (anyOf 2)`	JSON	Alternative
`$ (anyOf 2) (anyOf 1)`	object	Alternative
`$ (anyOf 2) (anyOf 2)`	null	Alternative

Referenced models: Get mail Folder — response body

Schemas

13 more schemas are linked from the tables above, on the schema pages.

Get mail Folder — response body

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (allOf 1)`	Model	All variants apply	Expand Get rule — response body — @odata type, id
`$ (allOf 2)`	object	All variants apply	discriminator: {"mapping": {}, "propertyName": "@odata.type"}
`$ (allOf 2).@odata.type`	string	Optional
`$ (allOf 2).childFolderCount`	JSON	Optional
`$ (allOf 2).childFolderCount (anyOf 1)`	JSON	Alternative
`$ (allOf 2).childFolderCount (anyOf 1) (anyOf 1)`	number	Alternative	The number of immediate child mailFolders in the current mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648
`$ (allOf 2).childFolderCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (allOf 2).childFolderCount (anyOf 2)`	null	Alternative
`$ (allOf 2).childFolders`	array	Optional	The collection of child folders in the mailFolder.
`$ (allOf 2).childFolders[]`	Model	Each item	Expand Get mail Folder — response body
`$ (allOf 2).displayName`	JSON	Optional
`$ (allOf 2).displayName (anyOf 1)`	string	Alternative	The mailFolder's display name.
`$ (allOf 2).displayName (anyOf 2)`	null	Alternative
`$ (allOf 2).isHidden`	JSON	Optional
`$ (allOf 2).isHidden (anyOf 1)`	boolean	Alternative	Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.
`$ (allOf 2).isHidden (anyOf 2)`	null	Alternative
`$ (allOf 2).messageRules`	array	Optional	The collection of rules that apply to the user's Inbox folder.
`$ (allOf 2).messageRules[]`	Model	Each item	Expand Get rule — response body
`$ (allOf 2).messages`	array	Optional	The collection of messages in the mailFolder.
`$ (allOf 2).messages[]`	Model	Each item	Expand Get message — response body
`$ (allOf 2).multiValueExtendedProperties`	array	Optional	The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.
`$ (allOf 2).multiValueExtendedProperties[]`	Model	Each item	Expand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item
`$ (allOf 2).parentFolderId`	JSON	Optional
`$ (allOf 2).parentFolderId (anyOf 1)`	string	Alternative	The unique identifier for the mailFolder's parent mailFolder.
`$ (allOf 2).parentFolderId (anyOf 2)`	null	Alternative
`$ (allOf 2).singleValueExtendedProperties`	array	Optional	The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.
`$ (allOf 2).singleValueExtendedProperties[]`	Model	Each item	Expand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item
`$ (allOf 2).totalItemCount`	JSON	Optional
`$ (allOf 2).totalItemCount (anyOf 1)`	JSON	Alternative
`$ (allOf 2).totalItemCount (anyOf 1) (anyOf 1)`	number	Alternative	The number of items in the mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648
`$ (allOf 2).totalItemCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (allOf 2).totalItemCount (anyOf 2)`	null	Alternative
`$ (allOf 2).unreadItemCount`	JSON	Optional
`$ (allOf 2).unreadItemCount (anyOf 1)`	JSON	Alternative
`$ (allOf 2).unreadItemCount (anyOf 1) (anyOf 1)`	number	Alternative	The number of items in the mailFolder marked as unread. Format: int32 Maximum: 2147483647 Minimum: -2147483648
`$ (allOf 2).unreadItemCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (allOf 2).unreadItemCount (anyOf 2)`	null	Alternative

Referenced models: Get rule — response body — @odata type, id, Get mail Folder — response body, Get message — response body, Get rule — response body, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item

Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (allOf 1)`	Model	All variants apply	Expand Get rule — response body — @odata type, id
`$ (allOf 2)`	object	All variants apply
`$ (allOf 2).@odata.type`	string	Optional
`$ (allOf 2).value`	array	Optional	A collection of property values.
`$ (allOf 2).value[]`	JSON	Each item
`$ (allOf 2).value[] (anyOf 1)`	string	Alternative
`$ (allOf 2).value[] (anyOf 2)`	null	Alternative

Referenced models: Get rule — response body — @odata type, id

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (allOf 1)`	Model	All variants apply	Expand Get rule — response body — @odata type, id
`$ (allOf 2)`	object	All variants apply
`$ (allOf 2).@odata.type`	string	Optional
`$ (allOf 2).value`	JSON	Optional
`$ (allOf 2).value (anyOf 1)`	string	Alternative	A property value.
`$ (allOf 2).value (anyOf 2)`	null	Alternative

Referenced models: Get rule — response body — @odata type, id

Get attachment — response body

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (allOf 1)`	Model	All variants apply	Expand Get rule — response body — @odata type, id
`$ (allOf 2)`	object	All variants apply	discriminator: {"mapping": {}, "propertyName": "@odata.type"}
`$ (allOf 2).@odata.type`	string	Optional
`$ (allOf 2).contentType`	JSON	Optional
`$ (allOf 2).contentType (anyOf 1)`	string	Alternative	The MIME type.
`$ (allOf 2).contentType (anyOf 2)`	null	Alternative
`$ (allOf 2).isInline`	boolean	Optional	true if the attachment is an inline attachment; otherwise, false.
`$ (allOf 2).lastModifiedDateTime`	JSON	Optional
`$ (allOf 2).lastModifiedDateTime (anyOf 1)`	string	Alternative	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Format: date-time Pattern: ^[0-9]{4,}-(0[1-9]\|1[012])-(0[1-9]\|[12][0-9]\|3[01])T([01][0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z\|[+-][0-9][0-9]:[0-9][0-9])$
`$ (allOf 2).lastModifiedDateTime (anyOf 2)`	null	Alternative
`$ (allOf 2).name`	JSON	Optional
`$ (allOf 2).name (anyOf 1)`	string	Alternative	The attachment's file name.
`$ (allOf 2).name (anyOf 2)`	null	Alternative
`$ (allOf 2).size`	JSON	Optional
`$ (allOf 2).size (anyOf 1)`	number	Alternative	The length of the attachment in bytes. Format: int32 Maximum: 2147483647 Minimum: -2147483648
`$ (allOf 2).size (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get rule — response body — @odata type, id

Create open extension — response body

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (allOf 1)`	Model	All variants apply	Expand Get rule — response body — @odata type, id
`$ (allOf 2)`	object	All variants apply	discriminator: {"mapping": {}, "propertyName": "@odata.type"}
`$ (allOf 2).@odata.type`	string	Optional

Referenced models: Get rule — response body — @odata type, id

Policy, approvals and errors

SDK function policy ID: microsoft.users_user_mailfolders_mailfolder_move. Catalog operation: users_user_mailfolders_mailfolder_move. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["Mail.ReadWrite"]

Official provider source

Report an issue with this page