summaryrefslogtreecommitdiff
path: root/README.md
blob: ac7dd0f4d989f50a9795bcbe82f266d1d6f4c457 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
This is a proposal for a terminal gui for [notmuch mail][notmuch]
written in python using the [urwid][urwid] toolkit.

You can find some old screenshots in `data/alot*png`,
the files `INSTALL` and `USAGE` contain instructions on how to set it up,
use and customize. These files are nicely rendered in the [github wiki][wiki].
The API docs for the current master branch are [here][api].
the `docs` directory contains their sources.

Do comment on the code or file issues! I'm curious what you think of it.
You can talk to me in #notmuch@Freenode.
Be aware that the master branch is used only for releases and hotfixes,
the bleeding edge version sits in branch `develop`!.
If you'd like to contribute, please make sure your patches can be applied to that branch.

Current features include:
-------------------------
 * spawn terminals for asynchronous editing of mails
 * theming, optionally in monochromatic, 16 or 256 colours
 * tag specific theming and tagstring translation
 * a hook system to inject one's own python code
 * python shell for introspection
 * forward/reply/group-reply of emails
 * multiple accounts for sending mails via sendmail
 * tab completion for commands and querystrings
 * priorizable notification popups
 * database manager that manages a write queue to the notmuch index
 * user configurable keyboard maps
 * printing/piping of mails and threads
 * addressbook integration (dev branch)

Soonish to be addressed non-features:
-------------------------------------
 * encryption/decryption for messages
 * search for strings in displayed buffer
 * folding for message parts
 * undo for commands

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