pmg_quarantine_blocklist_add
Add an email address to the Proxmox Mail Gateway quarantine blocklist. Dry-run by default; use confirm=True to execute.
Instructions
MUTATION (LOW): add an address to the quarantine blocklist. Dry-run by default. confirm=True to execute. Needs PROXIMO_PMG_* config.
Dry-run returns a PLAN; confirm=True executes and returns {"status": "ok", "result": ...}. Additive — reverse with pmg_quarantine_blocklist_remove. View current entries with pmg_quarantine_blocklist_list. pmail scopes the entry to a per-user blocklist (optional).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pmail | No | Scope the blocklist entry to this user's mailbox; defaults to the authenticated PMG user. | |
| address | Yes | Email address to add to the quarantine blocklist. | |
| confirm | No | False (default) returns a dry-run PLAN; True executes the mutation. | |
| proximo_target | No | Which configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |