Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Service Mail > Redirections → Enable Redirection

AI-generated

Summary

Enables a mail redirection rule for a specified Infomaniak mail hosting

Inputs

  • authentication (required) — Authentication method – either OAuth2 or API Key
  • path_mail_hosting_id (required) — Identifier of the mail hosting (service) where the redirection belongs
  • path_redirection_id (required) — Identifier of the redirection rule to enable
  • returnFullResponse — If true, the full response object is returned; otherwise only a success indicator

Output shape

a success status (or the full redirection object when returnFullResponse is true)

The operation does not return a body for simple success; when returnFullResponse is enabled it returns the updated redirection object.

Examples

Example 1: Enable a redirection using OAuth2

authentication=oauth2, path_mail_hosting_id=12, path_redirection_id="redirect-001", returnFullResponse=true

Example 2: Enable a redirection using API Key

authentication=apiKey, path_mail_hosting_id=7, path_redirection_id="forward-42"

Example 3: Enable a redirection without fetching full details

authentication=oauth2, path_mail_hosting_id=3, path_redirection_id="auto-reply", returnFullResponse=false

Links

Discussion