Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Service Mail > Preferences → Update Preferences

AI-generated

Summary

Update the preferences for a selected Infomaniak Mail hosting resource.

Inputs

  • authentication — Authentication method to use for the Infomaniak Mail API.
  • path_mail_hosting_id (required) — Identifier of the mail hosting resource to update preferences for.
  • body_authorized_senders — List of email addresses authorized to send mail on behalf of the hosting.
  • body_blocked_senders — List of email addresses blocked from sending mail.
  • body_default_permission — Default permission level for new mail items.
  • body_dkim_enabled — Whether DKIM signing is enabled for the domain.
  • body_external_mail_flag_enabled — Whether the external mail flag is enabled.
  • body_promotion_filter_enabled — Whether the promotion filter is enabled.
  • body_spam_filter_enabled — Whether the spam filter is enabled.
  • body_default_permissions — Default permissions for mail items.
  • returnFullResponse — If true, the full API response is returned; otherwise only a success indicator is emitted.

Output shape

object representing the updated preferences or the full API response

When Return Full Response is disabled, only a success status is returned; when enabled, the complete API response is emitted.

Examples

Example 1: Update mail hosting preferences using OAuth2, enable DKIM, block specified senders, and request full response.

authentication: oauth2, path_mail_hosting_id: "12345", body_dkim_enabled: true, body_blocked_senders: {"spam@example.com": true}, returnFullResponse: true

Example 2: Update preferences for a hosting using API Key, set default permission to "read", and enable promotion filter.

authentication: apiKey, path_mail_hosting_id: "67890", body_default_permission: "read", body_promotion_filter_enabled: true

Links

Discussion