Synology MailPlus icon

Synology MailPlus

Synology MailPlus API operations (18 endpoints + legacy support)

Update Filter

AI-generated

Summary

Update an existing mail filter in Synology MailPlus by specifying its ID and defining its conditions, actions, enabled state, and whether to apply the updated filter to existing emails.

Inputs

  • Filter ID (required) — The unique identifier of the filter to update.
  • Filter Conditions (JSON) (required) — JSON array defining the filter's conditions, e.g., [{'name':'from','value':'test@example.com'}].
  • Filter Actions (JSON) (required) — JSON array defining the filter's actions, e.g., [{'name':'set_label','value':'1'}].
  • Filter Enabled — Boolean to enable or disable the filter; default is true.
  • Apply to Existing — Boolean to apply the updated filter rules to existing emails; default is false.

Output shape

a single JSON object representing the updated filter's API response.

The output contains the success status and any returned data from Synology MailPlus API after updating the filter. Errors are thrown and can be caught by the workflow execution context.

Examples

Example 1: Update a filter to label incoming mail from a specific sender and apply it to existing messages

Set Filter ID to '1'; Filter Conditions to [{'name':'from','value':'sender@example.com'}]; Filter Actions to [{'name':'set_label','value':'2'}]; Filter Enabled to true; Apply to Existing to true.

Links

Discussion