Actions118
- Mailbox Management Actions
- Mailboxes Actions
- Mailboxes > Accesses > Devices Actions
- Mailboxes > Accesses > Invitations Actions
- Mailboxes > Accesses > Webmail Actions
- List User Access And Invitations
- Create Webmail Access
- Set The Primary Mailbox For The Authenticated User
- List Users Having Access
- List Of User Accesses For The Current User
- List Of User Accesses For A Account And A User
- Update Webmail Access
- Delete Webmail Access
- Delete Access To A Mailbox For The Current User
- Mailboxes > Aliases Actions
- Mailboxes > Auto Reply Actions
- Mailboxes > Folders Actions
- Mailboxes > Forwarding Actions
- Mailboxes > Sieve Filters Actions
- Mailboxes > Signatures Actions
- Mailboxes > Users Actions
- Mailing List Actions
- Mailing List > Subscribers Actions
- Service Mail > Auto Reply Actions
- Service Mail > Bimi Actions
- Service Mail > Filters Models Actions
- Service Mail > Preferences Actions
- Service Mail > Redirections Actions
- Service Mail > Redirections > Target Actions
- Service Mail > Signatures Templates Actions
Mailboxes > Forwarding → Update A Forwarding
AI-generatedSummary
Update a mailbox forwarding configuration
Inputs
- authentication — Authentication method (OAuth2 or API Key).
- path_mail_hosting_id (required) — Unique identifier of the mail hosting to update.
- path_mailbox_name (required) — Username (local part) of the email address to configure forwarding.
- body_has_dont_deliver — Indicates if emails should be deleted locally after forwarding.
- body_has_forward_spam — Indicates if spam‑flagged messages should be forwarded.
- body_is_enabled — Enable or disable the forwarding rule (disabling removes existing addresses).
- body_redirect_addresses — JSON array of destination email addresses for forwarding (max 1 for starter pack).
- returnFullResponse — When true, the full API response is returned; otherwise a success indicator is returned.
Output shape
success indicator (no body) when returnFullResponse is false; otherwise the full API response object
If returnFullResponse is false the operation returns a simple success response; if true it returns the complete API response which may include error details.
Examples
Example 1: Enable forwarding for user@example.com to forward@example.org with spam handling
authentication=apiKey, path_mail_hosting_id=12, path_mailbox_name=example, bodyParameters={body_is_enabled:true,body_has_forward_spam:true,body_redirect_addresses=['forward@example.org']}, returnFullResponse=false