Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Sieve Filters → List Filters

AI-generated

Summary

Lists sieve filters for a specified mail hosting and mailbox.

Inputs

  • authentication — Authentication method; choose OAuth2 or API Key.
  • path_mail_hosting_id (required) — The unique identifier (ID) of the mail hosting to request.
  • path_mailbox_name (required) — The username (part before '@') of the email address to query.
  • returnFullResponse — If true, returns the complete response; otherwise a truncated view.

Output shape

a list of sieve filter objects

Each object contains filter details such as name, match criteria, and priority; the list may be empty if no filters exist.

Examples

Example 1: Retrieve all sieve filters for mailbox user@example.com on hosting ID 123 using OAuth2.

authentication: oauth2; path_mail_hosting_id: 123; path_mailbox_name: user; returnFullResponse: false

Example 2: List filters for a specific mailbox using API Key and request the full response.

authentication: apiKey; path_mail_hosting_id: 456; path_mailbox_name: user; returnFullResponse: true

Links

Discussion