get-unread-count
Return the unread message count from Apple Mail, defaulting to the inbox or filtered by mailbox or account. Provides a simple number, with partial results flagged if any mailbox cannot be read.
Instructions
Use when: you only need the number of unread messages — INBOX by default, or scoped to one mailbox and/or account — without listing the messages themselves.
Returns: the unread count for the requested scope (INBOX when no mailbox is given). If a source cannot be read the result carries partial: true + failedAccounts, and a total AppleScript failure returns an ERROR — a plain count is never a disguised transport failure.
Do not use when: you need the actual unread messages and their ids (use list-messages with unreadOnly, or search-messages with isRead=false) or broader totals across every mailbox (use get-mail-stats).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Account to check | |
| mailbox | No | Mailbox to check (default: INBOX) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| unread | No | ||
| account | No | ||
| mailbox | No | ||
| partial | No | ||
| failedAccounts | No |