SDK method
tools.addForwardingRule
Add a forwarding rule. Convenience alias for add_forwarding_rule, forwarding to tinbox.api.forwarding.add.mutate.
Signature
ts
addForwardingRule(input: Parameters<TinboxTools["addForwardingRule"]>[0]): ReturnType<TinboxTools["addForwardingRule"]>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
forwardTo | string | yes | External destination email. |
matchAddress | string | no | Inbound address to match; blank = all inbound. |
Returns
ReturnType<TinboxTools["addForwardingRule"]>
Example
ts
await tinbox.tools.addForwardingRule({
"forwardTo": "ada@example.com"
});