Improve mail module docs

This commit is contained in:
Matthias Beyer 2017-08-12 21:26:26 +00:00
parent 740a5dad74
commit db51d971cc
2 changed files with 9 additions and 0 deletions

View file

@ -10,3 +10,5 @@ The goal of the initial implementation is only a CLI, not a TUI like mutt offers
So this module offers functionality to read (Maildir) mailboxes, search for and list mails and mail-threads and reply to mails (by spawning the `$EDITOR`). So this module offers functionality to read (Maildir) mailboxes, search for and list mails and mail-threads and reply to mails (by spawning the `$EDITOR`).
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.

View file

@ -1,2 +1,9 @@
## libimagmails ## libimagmails
The mail library implements everything that is needed for beeing used to implement a mail reader (MUA).
It therefor providea reading mailboxes, getting related content or mails, saving attachements to external locations, crafting new mails and responses,...
It also offers, natively, ways to search for mails (which are represented as imag entries) via tags, categories or even other metadata.
For more information on the domain of the `imag-mail` command, look at the documentation of the @sec:modules:mails module.