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 Script
AI-generatedSummary
Adds a sieve filter script to a specified mailbox.
Inputs
- authentication — Authentication method; OAuth2 or API Key.
- path_mail_hosting_id (required) — Unique identifier of the mail hosting to request.
- path_mailbox_name (required) — Username (part before @) of the email address for which to add the sieve filter.
- body_content (required) — Content of the sieve filter script.
- body_name (required) — Name of the sieve filter script.
- bodyParameters — Additional parameters for the script; currently supports 'body_is_enabled' to toggle enablement.
- returnFullResponse — Whether to return the full API response.
Output shape
a single record representing the added sieve filter
Contains details of the created filter; no pagination; returns an error envelope on failure.
Examples
Example 1: Add a sieve filter to block spam messages
authentication: OAuth2, path_mail_hosting_id: 42, path_mailbox_name: "user@example.com", body_name: "spam", body_content: "if (subject :contains "viagra" ) then reject", body_is_enabled: true, returnFullResponse: false