pmg_action_field_create
Create a field-modification action object to set a mail header field value in Proxmox Mail Gateway rules. Use dry-run for planning before execution.
Instructions
MUTATION (LOW): create a field-modification action object in the PMG RuleDB. Dry-run by default.
List existing action objects with pmg_action_objects_list; attach this one to a rule with pmg_ruledb_rule_action_attach. Needs PROXIMO_PMG_* config. confirm=True executes and returns {"status": "ok", "result": <PMG's raw API response>}.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| info | No | Optional free-text description. | |
| name | Yes | Name for the new field-modification action object. | |
| field | Yes | Mail header field to set. | |
| value | Yes | Value to assign to the header field. | |
| 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 |