Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Forwarding → List Forwarding

AI-generated

Summary

List forwarding rules for a mail host and mailbox.

Inputs

  • authentication — Authentication method for the Infomaniak API (either OAuth2 or API Key).
  • path_mail_hosting_id (required) — The ID of the mail hosting to query.
  • path_mailbox_name (required) — The username (part before @) of the mailbox whose forwarding rules to list.
  • returnFullResponse — When true, returns the full API response; otherwise returns a simplified response.

Output shape

an array of forwarding rule objects

Each object contains forwarding configuration details such as enabled state, destination address, and rule settings.

Examples

Example 1: List forwarding rules for a mailbox using OAuth2 authentication.

authentication: oauth2, path_mail_hosting_id: 5, path_mailbox_name: "john.doe", returnFullResponse: false

Example 2: List forwarding rules with full API response for an API Key.

authentication: apiKey, path_mail_hosting_id: 3, path_mailbox_name: "jane.doe", returnFullResponse: true

Example 3: List forwarding rules for multiple mailboxes in a single workflow.

authentication: oauth2, path_mail_hosting_id: 2, path_mailbox_name: "info", returnFullResponse: false

Links

Discussion