Preview a reversible batch
mail_batch_previewPreview read, flagged, tag, or move changes for up to 500 messages before applying them, so you can verify the batch without altering mail.
Instructions
Preview changes to up to 500 messages without changing mail.
A plan fixes the exact messages and expires after 15 minutes. Mark changes
read/flagged state and tags; move supports concrete folders in one account.
Any invalid message prevents applying the plan. History and undo metadata
stay local for seven days; message bodies are never stored in the journal.
changes accepts read, flagged, add_tags and remove_tags. The separate
fields are aliases; do not combine them with a changes object.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| read | No | ||
| action | Yes | ||
| changes | No | ||
| flagged | No | ||
| add_tags | No | ||
| message_ids | Yes | ||
| remove_tags | No | ||
| destination_folder_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||