v1

latestOpenAPI 3.0.02026-07-13474670.4 KB

Addresses

Update private email address forwarding and metadata

For a private email address, set it to forward to another place.

It can be forwarded to another email (with via mailsac indicator), to a websocket, to a webhook, or to a Slack channel.

put/addresses/{email}

infostring

User configurable metadata about this enhanced private address.

forwardstring

email address - SMTP forwarding / standard email forwarding - set to "" or null to disable forwarding

enablewsboolean

boolean, defaults false - set to true to enable web socket forwarding (see Web Socket API)

webhookstring

url - set to your public webhook endpoint to receive mail via webhook - set to "" or null to disable webhooks

webhookSlackstring

Slack webhook URL where messages will be published.

webhookSlackToFromboolean

When webhookSlack is set, controls whether the message includes TO and FROM

email forwarding successfully configured