Preview a bulk action
bulk_previewPreview which messages a bulk action would affect by UIDs or criteria, returning count, senders, sample, and a confirm reference without changing anything.
Instructions
Selects the exact messages a bulk action would act on (explicit uids or criteria, oldest first) and returns a count, senders, a sample and a confirm ref for bulk_apply. Changes nothing. Show the preview to the owner. Needs read and modify (trash: delete); 50 per call on Free, 500 paid.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uids | No | Explicit messages, all in `folder` | |
| batch | No | Batch id from bulk_apply | |
| label | No | action=label: label or category | |
| action | No | ||
| folder | No | Source folder; default INBOX | |
| account | Yes | list_accounts id | |
| criteria | No | ||
| scan_from | No | Continues an earlier preview's scan | |
| to_folder | No | action=move | |
| create_folder | No | action=move: bulk_apply creates to_folder if it does not exist |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | ||
| plan | No | ||
| batch | No | ||
| count | No | ||
| confirm | No | ||
| will_process | No |