Actions118
- Mailbox Management Actions
- Mailboxes Actions
- Mailboxes > Accesses > Devices Actions
- Mailboxes > Accesses > Invitations Actions
- Mailboxes > Accesses > Webmail Actions
- List User Access And Invitations
- Create Webmail Access
- Set The Primary Mailbox For The Authenticated User
- List Users Having Access
- List Of User Accesses For The Current User
- List Of User Accesses For A Account And A User
- Update Webmail Access
- Delete Webmail Access
- Delete Access To A Mailbox For The Current User
- Mailboxes > Aliases Actions
- Mailboxes > Auto Reply Actions
- Mailboxes > Folders Actions
- Mailboxes > Forwarding Actions
- Mailboxes > Sieve Filters Actions
- Mailboxes > Signatures Actions
- Mailboxes > Users Actions
- Mailing List Actions
- Mailing List > Subscribers Actions
- Service Mail > Auto Reply Actions
- Service Mail > Bimi Actions
- Service Mail > Filters Models Actions
- Service Mail > Preferences Actions
- Service Mail > Redirections Actions
- Service Mail > Redirections > Target Actions
- Service Mail > Signatures Templates Actions
Mailboxes > Sieve Filters → Add A Filter
AI-generatedSummary
Add a sieve filter to a mailbox
Inputs
- authentication — Authentication method; choose 'OAuth2' or 'API Key'
- path_mail_hosting_id (required) — Unique identifier of the mail hosting to request
- path_mailbox_name (required) — Username part of the email address for the mailbox
- body_actions (required) — Action to perform when the filter is triggered
- body_conditions (required) — Condition that must be met to trigger the filter
- body_has_all_of (required) — Whether all conditions must be met (true) or any one suffices (false)
- body_is_enabled (required) — Indicates if the filter is enabled
- body_name (required) — Name of the filter
- bodyParameters (required) — Additional body fields for the filter, such as template ID
- returnFullResponse — If true, the full API response is returned; otherwise only success/failure is indicated
Output shape
a single JSON object representing the newly created sieve filter
When 'returnFullResponse' is true, the complete response is returned; otherwise only a success indicator is provided. The shape may include filter details like ID, name, and status.
Examples
Example 1: Create a filter that forwards all emails with subject 'Invoice' to a specific folder
Authentication: OAuth2; Mail Hosting Id: 123; Mailbox Name: user@example.com; Actions: {"forward":"Folder"}; Conditions: {"subject":"Invoice"}; Has All Of: true; Is Enabled: true; Name: "Forward invoices"; Additional Body Fields: {"templateId":0}; Return Full Response: true