Skip to content
Briskmail
See availability

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

Built

No 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 soon

Switch: 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.

Send without asking

Built

Switch: 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.

CodeMeaning
0The check started. Prints ok.
2Not allowed. macOS refused Automation for the app you ran it from (-1743).
3Briskmail reported an error, printed on stderr.
64Bad 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