Actions27
- Get Mailboxes
- List Mailboxes
- Create Mailbox
- Update Mailbox
- Delete Mailbox
- Get Labels
- List Labels
- Create Label
- Update Label
- Delete Label
- Get Filters
- List Filters
- Create Filter
- Update Filter
- Delete Filter
- Send Email
- Advanced: Login (debug)
- Advanced: Logout (debug)
- Legacy: List Mail APIs
- Legacy: Get Mail Server Version
- Legacy: List Messages
- Legacy: Get Message Detail
- Legacy: Move Message
- Legacy: Mark Read / Unread
- Legacy: Add / Remove Label
- Legacy: Get Account Info
- Legacy: Custom Mail Call
Update Mailbox
AI-generatedSummary
Update an existing mailbox in Synology MailPlus by specifying its mailbox ID and optionally modifying its name, parent mailbox ID, and subscription status.
Inputs
- Mailbox ID (required) — The identifier of the mailbox to update.
- Mailbox Name — New name for the mailbox; if omitted or empty, the name remains unchanged.
- Parent Mailbox ID — Identifier of the new parent mailbox; defaults to 0 if not specified.
- Subscribed — Boolean indicating whether the mailbox is subscribed; defaults to true.
Output shape
An object with the API response indicating success or failure of the update operation.
The response contains success status and any relevant error information from the Synology MailPlus API.
Examples
Example 1: Update the mailbox with ID '1' to have a new name 'Archive', move it under parent mailbox ID 2, and set it as subscribed.
Mailbox ID = '1', Mailbox Name = 'Archive', Parent Mailbox ID = 2, Subscribed = true