Move emails
Move messages to a folder other than the archive or trash.
move_emails
Move messages to a folder other than the archive or trash.
Permissions
Required capabilities: mail.organize.
Inputs
| Name | Required | Type | Details |
|---|---|---|---|
accountId | No | string or null | Account to operate on. Optional when exactly one account is connected. Minimum length: 1. |
messageIds | Yes | array of string | Messages to change, up to 100 distinct IDs |
folder | Yes | string | Destination folder name or role Minimum length: 1. |
{
"type": "object",
"properties": {
"accountId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"description": "Account to operate on. Optional when exactly one account is connected."
},
"messageIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "Messages to change, up to 100 distinct IDs"
},
"folder": {
"type": "string",
"minLength": 1,
"description": "Destination folder name or role"
}
},
"required": [
"messageIds",
"folder"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Last updated