Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Aliases → Delete An Alias

AI-generated

Summary

Delete a specified alias from a mailbox in Infomaniak Mail.

Inputs

  • authentication — Authentication method to use: OAuth2 or API Key.
  • path_mail_hosting_id (required) — The unique identifier (ID) of the mail hosting to request.
  • path_mailbox_name (required) — The username (that is the part before the @) of the email address you want to request.
  • path_alias (required) — Alias to remove.
  • returnFullResponse — Return Full Response

Output shape

a response object confirming deletion (may include details if Return Full Response is enabled)

Success returns a confirmation; errors raise exceptions.

Examples

Example 1: Delete alias 'test' for mailbox 'john.doe@example.com' using OAuth2

authentication: oauth2, path_mail_hosting_id: 12345, path_mailbox_name: john.doe, path_alias: test, returnFullResponse: false

Example 2: Delete alias 'old-alias' using API Key with full response

authentication: apiKey, path_mail_hosting_id: 54321, path_mailbox_name: john.doe, path_alias: old-alias, returnFullResponse: true

Example 3: Attempt deletion without providing mailbox name (validation error)

authentication: oauth2, path_mail_hosting_id: 12345, path_mailbox_name: , path_alias: test, returnFullResponse: false

Links

Discussion