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
Get Mailboxes
AI-generatedSummary
Retrieve detailed information about specified mailboxes from Synology MailPlus.
Inputs
- Mailbox IDs (JSON Array) — A JSON array of mailbox IDs to retrieve. Defaults to [-1] which may mean all or default mailboxes.
- Conversation View — Boolean indicating whether to enable conversation view for the mailboxes.
- Additional Attributes — Optional list of additional mailbox attributes to include, such as 'Unread Count', 'Draft Total Count', 'Total Count', and 'Permission'.
Output shape
A single JSON object containing mailbox details corresponding to the specified mailbox IDs, including optionally requested additional attributes and conversation view settings.
The response encapsulates the API response from Synology's MailPlus 'Mailbox' 'get' method. The structure may include multiple mailbox records keyed by the server's API response format. No pagination is indicated. Errors are thrown if the API call fails.
Examples
Example 1: Get details for mailbox IDs 1 and 2 with unread count and total count included.
Set 'Mailbox IDs' to [1,2], 'Additional Attributes' to ['unread_count','total_count'], and 'Conversation View' to false or omit.