Skip to content

calternal mail

Mail reader operations use stable provider-backed IDs and delegate all writes to the server (#396, DESIGN §45)

Terminal window
calternal mail <COMMAND>

List connected Mail accounts

Terminal window
calternal mail accounts

List folders for one connected account

Terminal window
calternal mail folders <ACCOUNT_ID>
Argument Description Default
<ACCOUNT_ID> Required.

Read a folder’s newest messages

Terminal window
calternal mail folder <ID> [--limit <LIMIT>]
Argument Description Default
<ID> Required.
--limit <LIMIT> 50

Read the newest messages grouped by thread

Terminal window
calternal mail inbox [--category <CATEGORY>] [--limit <LIMIT>]
Argument Description Default
--category <CATEGORY> One of: people, newsletters, notifications, receipts, all. people
--limit <LIMIT> 50

Read one conversation thread

Terminal window
calternal mail thread <ID> [--limit <LIMIT>]
Argument Description Default
<ID> Required.
--limit <LIMIT> 50

Read one message body and its headers

Terminal window
calternal mail message <ID>
Argument Description Default
<ID> Required.

List attachment metadata in one thread

Terminal window
calternal mail attachments <THREAD_ID>
Argument Description Default
<THREAD_ID> Required.

Save one attachment to a new local file

Terminal window
calternal mail attachment <MESSAGE_ID> <SECTION_ID> <OUTPUT>
Argument Description Default
<MESSAGE_ID> Required.
<SECTION_ID> Required.
<OUTPUT> Required.

Find the oldest unread message in one thread

Terminal window
calternal mail oldest-unread <THREAD_ID>
Argument Description Default
<THREAD_ID> Required.

Mark one message read, or unread with –unread

Terminal window
calternal mail mark-read <ID> [--unread]
Argument Description Default
<ID> Required.
--unread false

Read or change when message opens mark messages read

Terminal window
calternal mail read-marking [<VALUE>]
Argument Description Default
<VALUE> One of: on-open, after-one-second, manually.

Set the sender category for one message

Terminal window
calternal mail category <ID> <CATEGORY>
Argument Description Default
<ID> Required.
<CATEGORY> Required. One of: people, newsletters, notifications, receipts, all.

Read or change the one Load remote content preference (#726). Remote images load through the server for all senders, or for none

Terminal window
calternal mail remote-content [<LOAD>]
Argument Description Default
<LOAD> One of: true, false.

Global options such as --json and --server apply to every command. See the CLI overview.