Synology MailPlus icon

Synology MailPlus

Synology MailPlus API operations (18 endpoints + legacy support)

Legacy: Add / Remove Label

AI-generated

Summary

Modify labels on a specific email message by adding or removing a label using its ID and message ID.

Inputs

  • Label ID (required) — The ID of the label to add or remove from the message.
  • Label Action (required) — Action to perform on the label: either add or remove the label from the message.
  • Message ID (required) — The ID of the message to modify with the label action.
  • Extra Params (JSON) — Optional additional parameters as a JSON object to customize the API call.

Output shape

a single record containing the API response indicating success or failure of the label modification.

The output includes the result of the label add/remove operation. The action triggers Synology DSM API calls that either assign or unassign the specified label to the target message. Errors from the API call will surface as exceptions unless 'Continue on Fail' option is enabled in the workflow.

Links

Discussion