README.rst
1====
2afew
3====
4
5|GithubTag| |CodeCov| |CI Status|
6
7About
8-----
9
10afew is an initial tagging script for notmuch mail:
11
12* http://notmuchmail.org/
13* http://notmuchmail.org/initial_tagging/
14
15Its basic task is to provide automatic tagging each time new mail is registered
16with notmuch. In a classic setup, you might call it after 'notmuch new' in an
17offlineimap post sync hook.
18
19It can do basic thing such as adding tags based on email headers or maildir
20folders, handling killed threads and spam.
21
22In move mode, afew will move mails between maildir folders according to
23configurable rules that can contain arbitrary notmuch queries to match against
24any searchable attributes.
25
26fyi: afew plays nicely with alot, a GUI for notmuch mail ;)
27
28* https://github.com/pazz/alot
29
30
31
32IRC
33---
34
35Feel free to ask your questions and discuss usage in the `#afewmail IRC Channel`_ on freenode.
36
37.. _#afewmail IRC Channel: http://webchat.freenode.net/?channels=#afewmail
38
39
40Features
41--------
42
43* spam handling (flush all tags, add spam)
44* killed thread handling
45* automatic propagation of tags to whole thread
46* tags posts to lists with ``lists``, ``$list-id``
47* autoarchives mails sent from you
48* catchall -> remove ``new``, add ``inbox``
49* can operate on new messages [default], ``--all`` messages or on custom
50 query results
51* can move mails based on arbitrary notmuch queries, so your sorting
52 may show on your traditional mail client (well, almost ;))
53* has a ``--dry-run`` mode for safe testing
54* works with python 3.6+
55
56
57
58Installation and Usage
59----------------------
60
61Full documentation is available in the `docs/`_ directory and in
62rendered form at afew.readthedocs.io_.
63
64.. _afew.readthedocs.io: https://afew.readthedocs.io/en/latest/
65.. _docs/: docs/
66
67Have fun :)
68
69
70.. |GithubTag| image:: https://img.shields.io/github/tag/afewmail/afew.svg
71 :target: https://github.com/afewmail/afew/releases
72.. |CodeCov| image:: https://codecov.io/gh/afewmail/afew/branch/master/graph/badge.svg
73 :target: https://codecov.io/gh/afewmail/afew
74.. |CI Status| image:: https://github.com/afewmail/afew/workflows/CI/badge.svg
75 :target: https://github.com/afewmail/afew/actions
76
