Add a forwarding address to a site
add_site_email_forward_address
Adds an address to the forwarding addresses of a site, which every forwarded email goes to once the address is confirmed.
A site can have up to 5 forwarding addresses. Your own account email, when your sign-in confirms it through a verified email or a Google or GitHub sign-in, is confirmed at once, and so is an address at a domain the site already proved it owns: any of its connected custom domains or one of its verified email domains, subdomains included.
Any other address gets an email with a confirmation link straight away and receives nothing until somebody opens that link. Its status is pending until then and verified after, and the link works for 7 days. The tool tells the client to add only an address you gave it.
It is refused for an address at a Modulify site domain, an address at a domain any Modulify site receives mail for, an address already on the list, an address that stopped forwarding from this site through its link, and once the site has 5 addresses. A workspace can try 30 adds an hour across its sites, refused ones included.
Confirmation links are limited to 1 a minute to one address from the same site, 5 a day to one address across every site, 20 a day for one site and 50 a day for one workspace, and a refusal says how long to wait. It needs the Delete projects permission. See Forwarding addresses.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | The site id. |
email |
string | Yes | The email address to forward the site's mail to. |