Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Sieve Filters → Update A Script

AI-generated

Summary

Updates a Sieve filter script for a specified mailbox under a given hosting.

Inputs

  • authentication (required) — Authentication method (OAuth2 or API Key).
  • path_mail_hosting_id (required) — ID of the mail hosting containing the mailbox.
  • path_mailbox_name (required) — Username part of the email address of the mailbox.
  • body_content (required) — Content defining the sieve script.
  • body_is_enabled (required) — Whether the script is enabled.
  • body_name (required) — Name of the script.
  • body_old_name (required) — Current name of the script to identify which script to update.
  • returnFullResponse — If true, the full API response is returned; otherwise only success/failure.

Output shape

An object indicating the update result, possibly containing the updated script details.

When returnFullResponse is true the full response is returned; otherwise the operation returns a success/failure indicator.

Examples

Example 1: Update a sieve filter script for user john.doe using API Key

authentication=apiKey; path_mail_hosting_id=123; path_mailbox_name=john.doe; body_content=...; body_is_enabled=true; body_name=SpamFilter; body_old_name=SpamFilterOld; returnFullResponse=false

Links

Discussion