Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Service Mail > Filters Models → Show A Filter Model

AI-generated

Summary

Retrieve details of a specific mail filter model from Infomaniak Mail service.

Inputs

  • authentication — Authentication method (OAuth2 or API Key)
  • path_mail_hosting_id (required) — Identifier of the mail service
  • path_filter_id (required) — Identifier of the filter
  • returnFullResponse — If true, the full response body is returned

Output shape

a single filter model object

The returned object contains the filter's configuration and metadata as defined by the Infomaniak API; additional fields may appear in future versions.

Examples

Example 1: Fetch filter details using OAuth2

authentication: oauth2; path_mail_hosting_id: 123; path_filter_id: filter-01; returnFullResponse: false

Example 2: Get filter with full response via API Key

authentication: apiKey; path_mail_hosting_id: 456; path_filter_id: filter-02; returnFullResponse: true

Links

Discussion