Forward rules tools

`sendmock_forward_rule_create`

Add a forward rule at the end of the list.

Toolset rules.

Input	Type	Description
namerequired	string	A name for the rule, shown in the list.Example: `Invoices to finance QA`
filter	object	The webhook rule filter, over email fields; null matches every email.
torequired	string[]	Real addresses; each must be on the relay allowlist.Example: `["[email protected]"]`
is_enabledrequired	boolean	Off rules are kept but skipped.Example: `true`

Example call

{
  "name": "sendmock_forward_rule_create",
  "arguments": {
    "name": "Invoices to finance QA",
    "to": [
      "[email protected]"
    ],
    "is_enabled": true
  }
}

Result: ForwardRule

API: POST/api/v1/forward-rules
CLI: sendmock email forward-rules create
In the app: Settings > Email > Auto-forward rules > Add rule

`sendmock_forward_rule_delete`

Delete a forward rule.

Toolset rules.

Destructive
Idempotent

Input	Type	Description
rule_idrequired	string	The rule's ID, from the list of rules of the same kind.Example: `01JB7T9Q2R5W8X3Y6Z1A4B7C9D`

Example call

{
  "name": "sendmock_forward_rule_delete",
  "arguments": {
    "rule_id": "01JB7T9Q2R5W8X3Y6Z1A4B7C9D"
  }
}

Result: nothing

API: DELETE/api/v1/forward-rules/{ruleId}
CLI: sendmock email forward-rules delete <ruleId>
In the app: Settings > Email > Auto-forward rules > Delete

`sendmock_forward_rule_list`

Every forward rule, in the order they run.

Toolset rules.

Read only

No inputs.

Example call

{
  "name": "sendmock_forward_rule_list",
  "arguments": {}
}

Result: ForwardRule[]

API: GET/api/v1/forward-rules
CLI: sendmock email forward-rules list
In the app: Settings > Email > Auto-forward rules

`sendmock_forward_rule_move`

Move a forward rule up or down.

Toolset rules.

Input	Type	Description
rule_idrequired	string	The rule's ID, from the list of rules of the same kind.Example: `01JB7T9Q2R5W8X3Y6Z1A4B7C9D`
directionrequired	string	`up` moves the rule one place earlier in the order, `down` one place later.One of: `up`, `down`Example: `up`

Example call

{
  "name": "sendmock_forward_rule_move",
  "arguments": {
    "rule_id": "01JB7T9Q2R5W8X3Y6Z1A4B7C9D",
    "direction": "up"
  }
}

Result: ForwardRule[]

API: POST/api/v1/forward-rules/{ruleId}/move
CLI: sendmock email forward-rules move <ruleId>
In the app: Settings > Email > Auto-forward rules > Move up, Move down

`sendmock_forward_rule_update`

Change a forward rule, or switch it on or off.

Toolset rules.

Idempotent

Input	Type	Description
rule_idrequired	string	The rule's ID, from the list of rules of the same kind.Example: `01JB7T9Q2R5W8X3Y6Z1A4B7C9D`
name	string	A name for the rule, shown in the list.Example: `Invoices to finance QA`
filter	object	The webhook rule filter, over email fields; null matches every email.
to	string[]	Real addresses; each must be on the relay allowlist.Example: `["[email protected]"]`
is_enabled	boolean	Off rules are kept but skipped.Example: `true`

Example call

{
  "name": "sendmock_forward_rule_update",
  "arguments": {
    "rule_id": "01JB7T9Q2R5W8X3Y6Z1A4B7C9D",
    "name": "Invoices to finance QA",
    "to": [
      "[email protected]"
    ]
  }
}

Result: ForwardRule

API: PATCH/api/v1/forward-rules/{ruleId}
CLI: sendmock email forward-rules update <ruleId>
In the app: Settings > Email > Auto-forward rules > Edit, enabled switch