matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Add documentation how the mail CLI should look like

Browse source
This commit is contained in:
Matthias Beyer 2017-08-21 00:03:22 +01:00
parent 5fa076914c
commit 49a7201125
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/src/04020-module-mails.md
View file

@ -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 <path> [opts...] # track a new mail, mail file passed as path
imag mail scan <path> [opts...] # scan a maildir and track all untracked mails
imag mail box <name|path> # work with the mailbox specified by <name|path>, name mappings from config
imag mail list <args...> # list mails in a given mailbox for a given account or the default account
imag mail show <args...> # open new mails in the pager
imag mail thread list <args...> # list mails from a thread
imag mail thread show <args...> # open new mails from a thread in the pager or call a script with them
imag mail new <args...> # craft a new mail and safe it in the <outgoing> folder
imag mail send <args...> # send emails from the outgoing folder, optionally also move them to archice boxes
imag mail mv <srcbox> <dstbox> # move a mail (or thread) from one mailbox to another