Create Email Forward
create_email_forwardForward an address at the domain (e.g. info@example.com) to another mailbox. Free, up to the domain's limit. No catch-all or wildcard forwards, and an address that is an email hosting mailbox cannot also be a forward.
Instructions
Forward an address at the domain (e.g. info@example.com) to another mailbox. Free, up to the domain's limit. No catch-all or wildcard forwards, and an address that is an email hosting mailbox cannot also be a forward. Setting up forwarding puts Porkbun's MX records (and SPF include) at the domain apex. If that would delete MX records for another mail service or rewrite the domain's SPF record, the call returns DNS_CHANGE_CONFIRMATION_REQUIRED with dnsChanges listing exactly what would change, and nothing is changed: tell the user (deleting another provider's MX stops that mail service receiving), and only with their OK call again with confirm_dns_changes: true. Use dry_run: true to preview, including whether confirmation will be needed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | Domain the address belongs to, e.g. `example.com` | |
| address | Yes | The address to forward: the part before the @ (`info`) or the whole address (`info@example.com`). | |
| dry_run | No | If true, validate and report the DNS changes without making any. | |
| forward_to | Yes | The mailbox to deliver to, e.g. `me@gmail.com`. | |
| confirm_dns_changes | No | Set only after the user has agreed to the DNS changes a `DNS_CHANGE_CONFIRMATION_REQUIRED` result described. |