From 49a7201125a86b6510884f835a66154eb5447b2d Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Mon, 21 Aug 2017 00:03:22 +0100 Subject: [PATCH] Add documentation how the mail CLI should look like --- doc/src/04020-module-mails.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/src/04020-module-mails.md b/doc/src/04020-module-mails.md index d4fe60dd..87752c33 100644 --- a/doc/src/04020-module-mails.md +++ b/doc/src/04020-module-mails.md @@ -12,3 +12,18 @@ So this module offers functionality to read (Maildir) mailboxes, search for and Outgoing mails are pushed to a special directory and can later on be send via `imag-mail` which calls a MTA (for example msmtp) and also creates store entries for the outgoing mails. +### CLI + +The CLI of the imag-mail module is planned as follows: + + imag mail track [opts...] # track a new mail, mail file passed as path + imag mail scan [opts...] # scan a maildir and track all untracked mails + imag mail box # work with the mailbox specified by , name mappings from config + imag mail list # list mails in a given mailbox for a given account or the default account + imag mail show # open new mails in the pager + imag mail thread list # list mails from a thread + imag mail thread show # open new mails from a thread in the pager or call a script with them + imag mail new # craft a new mail and safe it in the folder + imag mail send # send emails from the outgoing folder, optionally also move them to archice boxes + imag mail mv # move a mail (or thread) from one mailbox to another +