Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Forwarding → Add A Forwarding

AI-generated

Summary

Add a forwarding rule to an Infomaniak mailbox

Inputs

  • authentication — Authentication method: OAuth2 or API key
  • path_mail_hosting_id (required) — Numeric ID of the mail hosting containing the mailbox
  • path_mailbox_name (required) — Mailbox username (part before '@') to which the forwarding rule applies
  • body_redirect_address (required) — Email address to which incoming messages will be forwarded
  • returnFullResponse — If true, the full API response is returned; otherwise only success status

Output shape

JSON object confirming creation of the forwarding rule, including the new rule's identifier and details

May contain error information if the request fails; otherwise a simple success response.

Examples

Example 1: Configure forwarding for user@example.com to forward@example.org using OAuth2

authentication: OAuth2; path_mail_hosting_id: 123; path_mailbox_name: 'user'; body_redirect_address: 'forward@example.org'; returnFullResponse: false

Links

Discussion