Reference
Command reference
Every command, grouped by what lets it run: macOS Automation consent alone, or that plus one of two switches in Settings. Each page lists its flags, exit codes and examples.
Works with Automation consent
BuiltNo switch. macOS Automation consent is the only gate.
Opens things in Briskmail's window: a conversation, a search, a folder, a prefilled compose or reply window. With reply --send, the separate auto-send switch and Touch ID grant apply. These commands never print mail contents.
briskmail openBring Briskmail's window forward on a conversation, a search or a folder.briskmail draftOpen a compose window with the fields filled in. Saves nothing and cannot send.briskmail replyOpen a reply window, or use --send for guarded auto-send.briskmail checkCheck every signed-in account for new mail now, like Mailbox ▸ Check for New Mail.
Read and organize
Coming soonSwitch: Let apps read and organize my mail, in Settings ▸ Advanced ▸ Command-line access. Off until you turn it on.
Lists, searches and reads your mail, and does the things you can undo: label, mark read or unread, star, archive, snooze, and save a draft without opening a window.
briskmail triageBuiltPropose one of five Triage groups for a cached Inbox message.briskmail listBuiltList the messages in a folder or label: ids, senders, subjects, dates, labels and unread state.briskmail searchBuiltSearch mail and get back metadata rows, never bodies.briskmail unreadBuiltCount unread Inbox messages.briskmail labelsBuiltThe account's folders and labels.briskmail accountsBuiltThe accounts signed in to Briskmail, by the names you see, with the ids --account takes.briskmail readBuiltRead one message’s plain-text body.briskmail threadBuiltRead a conversation’s plain-text bodies.briskmail attachmentsBuiltList attachment names, types and sizes, or save one to an exact path.briskmail labelBuiltAdd a label to a message, as the app's Label menu does.briskmail unlabelBuiltRemove a label from a message.briskmail mark-readBuiltMark a message read.briskmail mark-unreadBuiltMark a message unread.briskmail starBuiltStar a message.briskmail unstarBuiltRemove a message's star.briskmail archiveBuiltArchive a message the same way the app's Archive button does, so Undo works.briskmail snoozeBuiltSnooze a message so it comes back later, as the app's Snooze does.briskmail save-draftBuiltSave a draft in Gmail without opening a window. It never sends.
Send without asking
BuiltSwitch: Let apps send without asking, in Settings ▸ Advanced ▸ Command-line access. Off until you turn it on.
Lets an agent send mail while you are away. Turning it on takes Touch ID or your login password.
briskmail sendSend without you, to known recipients only, through Undo Send. Anything else becomes a draft.
Global flags
--account ID- An account id from accounts.json. Leave it out to use the first account. Accepted before or after the command.
--dev- Send the command to the dev build (com.valleyedgeconsulting.edgemail.dev) instead of Briskmail. Only useful when working on Briskmail itself.
Exit codes
The same for every built command. The tool prints ok on success and an error on stderr otherwise. A command behind a switch that is off also exits 2, and the message names the switch.
| Code | Meaning |
|---|---|
| 0 | The check started. Prints ok. |
| 2 | Not allowed. macOS refused Automation for the app you ran it from (-1743). |
| 3 | Briskmail reported an error, printed on stderr. |
| 64 | Bad usage. |
Never available
No command does these, and no switch turns them on:
- Permanently delete mail
- Create or change filters or forwarding rules
- Change account or security settings
- Unsubscribe