Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Sieve Filters → Update A Filter

AI-generated

Summary

Update an existing Sieve filter by modifying its properties such as name, conditions, actions, and enablement.

Inputs

  • authentication — Authentication method to use (OAuth2 or API Key).
  • path_mail_hosting_id (required) — Unique identifier of the mail hosting.
  • path_mailbox_name (required) — Username part of the email address for the mailbox.
  • body_actions (required) — Action to execute when the filter matches.
  • body_conditions (required) — Condition that must be met for the filter to trigger.
  • body_has_all_of (required) — Whether all conditions must be satisfied (true) or any one suffices (false).
  • body_is_enabled (required) — Whether the filter is enabled after update.
  • body_name (required) — Display name of the filter.
  • body_old_name (required) — Current name of the filter to identify it for update.
  • bodyParameters (required) — Additional parameters to include in the request body.
  • returnFullResponse — Whether to return the full API response.

Output shape

a single updated filter object

Returns the updated filter; if returnFullResponse is true, the full API response is included; otherwise only a success status.

Examples

Example 1: Create a new filter to catch promotional emails

Authentication: OAuth2; Mail Hosting Id: 3; Mailbox Name: marketing; Body: name 'Promo Filter', conditions {subject contains 'promo'}, actions {move to 'Promotions'}, is_enabled true.

Example 2: Enable an existing filter and change its name

Authentication: API Key; Mail Hosting Id: 7; Mailbox Name: john; Body: old_name 'Travel', name 'Travel Updates', is_enabled true.

Links

Discussion