Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Aliases → Update Aliases

AI-generated

Summary

Update mailbox aliases on an Infomaniak mail hosting account.

Inputs

  • authentication — Authentication method: either OAuth2 or API Key.
  • path_mail_hosting_id (required) — The ID of the mail hosting that contains the target mailbox.
  • path_mailbox_name (required) — The username part of the email address for the mailbox to update.
  • body_aliases (required) — JSON object representing the list of alias email addresses to set.
  • returnFullResponse — If true, the full updated mailbox response is returned; otherwise only a success indicator.

Output shape

updated mailbox object or success indicator

When returnFullResponse is true the full response is emitted; otherwise the operation resolves with a simple success flag.

Examples

Example 1: Update aliases using OAuth2 authentication

authentication: oauth2, path_mail_hosting_id: 5, path_mailbox_name: john.doe, body_aliases: {"aliases":["john.doe+work@example.com","john.doe+personal@example.com"]}

Example 2: Update aliases using API Key authentication

authentication: apiKey, path_mail_hosting_id: 5, path_mailbox_name: john.doe, body_aliases: {}, returnFullResponse: true

Example 3: Update aliases for a different mailbox with full response

authentication: oauth2, path_mail_hosting_id: 7, path_mailbox_name: jane.doe, body_aliases: {}, returnFullResponse: true

Links

Discussion