Synology MailPlus icon

Synology MailPlus

Synology MailPlus API operations (18 endpoints + legacy support)

Delete Mailbox

AI-generated

Summary

Delete a mailbox or multiple mailboxes from Synology MailPlus specified by their mailbox IDs.

Inputs

  • mailboxIds (required) — A JSON array of mailbox IDs to delete (e.g. [-1, 1, 2]).
  • conversationView — Boolean to enable conversation view context for the delete operation, default is false.

Output shape

a JSON object indicating success or failure of the delete request

The response includes the API call's success status and possible error details if deletion fails.

Examples

Example 1: Delete one or more mailboxes by specifying their mailbox IDs in a JSON array, optionally enabling conversation view.

Set 'Mailbox IDs (JSON Array)' to a list of IDs and optionally set 'Conversation View' boolean.

Links

Discussion