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
List Mailboxes
AI-generatedSummary
List mailboxes in Synology MailPlus with optional conversation view and additional attributes, supporting extra arbitrary parameters.
Inputs
- Conversation View — Enable to get mailboxes with conversation threading enabled (boolean). Defaults to false.
- Additional Attributes — Select additional mailbox attributes to include such as unread count, draft total count, total count, and permission.
- Extra Params (JSON) — Provide extra parameters as a JSON object to customize the mailbox listing request.
Output shape
a JSON object representing the list of mailboxes returned by the Synology MailPlus API.
The output includes mailbox data with optional expanded attributes based on user selection. Extra parameters can modify the API call. Errors may be returned in a standard DSM API error format.
Examples
Example 1: List all mailboxes without conversation view or extra attributes.
Set 'Conversation View' to false, leave 'Additional Attributes' empty, and provide empty JSON for 'Extra Params'.
Example 2: List mailboxes with unread counts and conversation threading enabled.
Set 'Conversation View' to true, select 'Unread Count' in 'Additional Attributes', and leave 'Extra Params' empty.