Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Sieve Filters → Enable / Disable Script

AI-generated

Summary

Enable or disable a Sieve script filter for a specific mailbox.

Inputs

  • authentication (required) — Authentication method to use (OAuth2 or API Key).
  • path_mail_hosting_id (required) — Unique identifier of the mail hosting containing the mailbox.
  • path_mailbox_name (required) — Username part of the email address (mailbox name).
  • body_is_enabled (required) — Whether the script filter should be enabled.
  • body_name (required) — Identifier name of the script filter.
  • returnFullResponse — If true, the full server response is returned; otherwise only a success indicator.

Output shape

object

Returns the updated script filter details; when returnFullResponse is true the full response object is included, otherwise a simple success indicator.

Examples

Example 1: Enable a script filter named "SpamFilter" for user@example.com

authentication: oauth2; path_mail_hosting_id: 12; path_mailbox_name: user; body_is_enabled: true; body_name: SpamFilter; returnFullResponse: false

Links

Discussion