Skip to content
Briskmail
See availability

Read and organize

briskmail list

Built

List the messages in a folder or label: ids, senders, subjects, dates, labels and unread state.

Taught in lesson 2, Triage your inbox with an agent.

Usage

briskmail list [--folder <name>] [--json]

Lists Inbox by default, or a named folder or label. Returns only id, thread id, sender, subject, date, labels and unread state for each message. No snippet or body.

Runs only while Let apps read and organize my mail is on. With it off, the command exits 2 and names the switch.

Arguments and flags

--folder NAME
The folder or label to list.
--json
Print one JSON document.

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

CodeMeaning
0Done. Prints the rows.
2Not allowed: macOS refused Automation for the app you ran it from (-1743), or this command's switch is off. The message names the switch.
3Briskmail reported an error, printed on stderr.
64Bad usage.

Examples

briskmail list --folder Inbox --json