Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Service Mail > Redirections → List Redirections

AI-generated

Summary

List Mail Redirections

Inputs

  • authentication (required) — Authentication method, either OAuth2 or API Key
  • path_mail_hosting_id (required) — Identifier of the mail hosting for which to list redirections
  • queryParameters — Optional query parameters such as order_by and order_dir
  • returnFullResponse — If true, returns the full API response; otherwise only redirection items are returned

Output shape

an array of redirection objects

Each object includes fields like id, name, state, created_at, updated_at; may be empty if no redirections exist

Examples

Example 1: List redirections for a mail hosting using OAuth2

authentication=oauth2; path_mail_hosting_id=123; returnFullResponse=false

Example 2: List redirections with custom ordering using API Key

authentication=apiKey; path_mail_hosting_id=456; queryParameters={"query_order_by":"created_at","query_order_dir":"desc"}

Example 3: Return full API response for debugging

authentication=oauth2; path_mail_hosting_id=789; returnFullResponse=true

Links

Discussion