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
Create Mailbox
AI-generatedSummary
Create a new mailbox in Synology MailPlus with a specified name, optional parent mailbox ID, and subscription status.
Inputs
- Mailbox Name (required) — The name of the new mailbox to create.
- Parent Mailbox ID — The ID of the parent mailbox under which to create the new mailbox (default is 0 for no parent).
- Subscribed — Indicates whether the mailbox is subscribed (default is true).
Output shape
a JSON object representing the API response indicating success or failure of the mailbox creation.
The API response includes created mailbox details if successful or error information if failed.
Examples
Example 1: Create a mailbox named 'Archive' with no parent mailbox and subscribed by default.
Mailbox Name: 'Archive'; Parent Mailbox ID: 0; Subscribed: true