diff options
authorMatthias Beyer <>2017-08-12 21:26:26 +0000
committerMatthias Beyer <>2017-08-12 21:26:26 +0000
commitdb51d971ccdd633dc1e8f8928a3342e731b79867 (patch)
parent740a5dad74feeca6bd375b4d5ca71ba026ad7dd6 (diff)
Improve mail module docs
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/src/ b/doc/src/
index 1e27fbb..d4fe60d 100644
--- a/doc/src/
+++ b/doc/src/
@@ -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`).
+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.
diff --git a/doc/src/ b/doc/src/
index bd05bdc..dd0e346 100644
--- a/doc/src/
+++ b/doc/src/
@@ -1,2 +1,9 @@
## 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.