Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Aliases → Add An Alias

AI-generated

Summary

Add an alias to a mailbox on a specified Infomaniak hosting

Inputs

  • authentication (required) — Choose authentication method: OAuth2 or API Key.
  • path_mail_hosting_id (required) — The ID of the mail hosting to which the alias belongs.
  • path_mailbox_name (required) — The username (part before @) of the email address for which the alias is created.
  • body_alias (required) — The alias name to be added.
  • returnFullResponse — When true, the full API response is returned; otherwise only a success indicator.

Output shape

JSON object representing the newly created alias (or success status if returnFullResponse is false)

If returnFullResponse is false only a success confirmation is returned; otherwise the full API response with alias details is provided.

Examples

Example 1: Create alias 'dev' for user 'john.doe' on hosting ID 123 using OAuth2

authentication: oauth2; path_mail_hosting_id: 123; path_mailbox_name: john.doe; body_alias: dev; returnFullResponse: true

Links

Discussion