Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Aliases → List Aliases

AI-generated

Summary

List Mailbox Aliases

Inputs

  • authentication (required) — Authentication method (OAuth2 or API Key) for Infomaniak API.
  • path_mail_hosting_id (required) — Numeric identifier of the mail hosting containing the mailbox.
  • path_mailbox_name (required) — Username (part before @) of the email address whose aliases to list.
  • returnFullResponse — If true, returns the complete API response; otherwise only aliases are returned.

Output shape

array of alias objects (each containing alias identifier, email address, etc.)

Result set may be paginated; additional pagination metadata may be present in the full response.

Examples

Example 1: Retrieve all aliases for user@example.com mailbox using OAuth2

authentication: oauth2; path_mail_hosting_id: 12; path_mailbox_name: "example"; returnFullResponse: false

Example 2: Get full API response for aliases of user@domain.tld using API Key

authentication: apiKey; path_mail_hosting_id: 7; path_mailbox_name: "user"; returnFullResponse: true

Links

Discussion