Alot is an experimantal terminal MUA based on [notmuch mail][notmuch].
It is written in python using the [urwid][urwid] toolkit.

See `INSTALL.md` for instructions on how to set it up and have a look
at the [user manual][userdocs] (sources in in `docs/user`)
for advanced usage and customization.

Development happens in branch 'testing', autogenerated API docs for the
current HEAD can be found [here][apidocs]. Their sources live in `docs/dev`.

Do comment on the code or file issues! I'm curious what you think of it.
You can talk to me in #notmuch@Freenode.

Current features include:
-------------------------
 * modular and command prompt driven interface
 * tab completion and usage help for all commands
 * contacts completion using customizable `abook` lookups
 * user configurable keyboard maps
 * spawn terminals for asynchronous editing of mails
 * theming, optionally in 2, 16 or 256 colours
 * tag specific theming and tag string translation
 * (python) hooks to react on events and do custom formating
 * python shell for introspection
 * forward/reply/group-reply of emails
 * printing/piping of mails and threads
 * multiple accounts for sending mails via sendmail
 * notification popups with priorities
 * database manager that manages a write queue to the notmuch index

Soonish to be addressed non-features:
-------------------------------------
 * encryption/decryption for messages (see branch `gnupg`)
 * live search results (branch `live`)
 * search for message (branch `messagesmode`)
 * bind sequences of key presses to commands (branch `multiinput`)
 * search for strings in displayed buffer
 * folding for message parts
 * undo for commands


Usage
=====
In all views, arrows, page-up/down, `j`,`k` and `Space` can be used to move the focus.
`Escape` cancels prompts and `Enter` selects. Hit `:` at any time and type in commands
to the prompt.
Usage information on any command can be listed by typing `help YOURCOMMAND` to the prompt;
The key bindings for the current mode are listed upon pressing `?`.


[notmuch]: http://notmuchmail.org/
[urwid]: http://excess.org/urwid/
[userdocs]: http://alot.rtfd.org
[apidocs]: http://pazz.github.com/alot/
[wiki]: https://github.com/pazz/alot/wiki