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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
Command Line Usage
==================
Ultimately afew is a command line tool. You have to specify an action, and
whether to act on all messages, or only on new messages. The actions you can
choose from are:
tag
run the tag filters. See :ref:`Initial tagging`.
watch
continuously monitor the mailbox for new files
move-mails
move mail files between maildir folders
learn=LEARN
train the category with the messages matching the
given query
update
update the categories [requires no query]
update-reference
update the reference category (takes quite some time)
[requires no query]
classify
classify each message matching the given query (to
test the trained categories)
Initial tagging
---------------
Basic tagging stuff requires no configuration, just run
.. code-block:: sh
$ afew --tag --new
# or to tag *all* messages
$ afew --tag --all
To do this automatically you can add the following hook into your
`~/.offlineimaprc`:
.. code-block:: ini
postsynchook = ionice -c 3 chrt --idle 0 /bin/sh -c "notmuch new && afew --tag --new"
There is a lot more to say about general filter :doc:`configuration`
and the different :doc:`filters` provided by afew.
Simulation
^^^^^^^^^^
Adding `--dry-run` to any `--tag` or `--sync-tags` action prevents
modification of the notmuch db. Add some `-vv` goodness to see some
action.
Move Mode
---------
To invoke afew in move mode, provide the `--move-mails` option on the
command line. Move mode will respect `--dry-run`, so throw in
`--verbose` and watch what effects a real run would have.
In move mode, afew will check all mails (or only recent ones) in the
configured maildir folders, deciding whether they should be moved to
another folder.
The decision is based on rules defined in your config file. A rule is
bound to a source folder and specifies a target folder into which a
mail will be moved that is matched by an associated query.
This way you will be able to transfer your sorting principles roughly
to the classic folder based maildir structure understood by your
traditional mail server. Tag your mails with notmuch, call afew
`--move-mails` in an offlineimap presynchook and enjoy a clean inbox
in your webinterface/GUI-client at work.
For information on how to configure rules for move mode, what you can
do with it and what you can't, please refer to :doc:`move_mode`.
Classify
--------
The `--learn`, `--update`, `--update-references` and `--classify` actions
all relate to learning how to filter your email. See the
:doc:`classification` page for details.
Commandline help
----------------
The full set of options is:
.. code-block:: sh
$ afew --help
Usage: afew [options] [--] [query]
Options:
-h, --help show this help message and exit
Actions:
Please specify exactly one action (both update actions can be
specified simultaniously).
-t, --tag run the tag filters
-w, --watch continuously monitor the mailbox for new files
-l LEARN, --learn=LEARN
train the category with the messages matching the
given query
-u, --update update the categories [requires no query]
-U, --update-reference
update the reference category (takes quite some time)
[requires no query]
-c, --classify classify each message matching the given query (to
test the trained categories)
-m, --move-mails move mail files between maildir folders
Query modifiers:
Please specify either --all or --new or a query string. The default
query for the update actions is a random selection of
REFERENCE_SET_SIZE mails from the last REFERENCE_SET_TIMEFRAME days.
-a, --all operate on all messages
-n, --new operate on all new messages
General options:
-C NOTMUCH_CONFIG, --notmuch-config=NOTMUCH_CONFIG
path to the notmuch configuration file [default:
$NOTMUCH_CONFIG or ~/.notmuch-config]
-e ENABLE_FILTERS, --enable-filters=ENABLE_FILTERS
filter classes to use, separated by ',' [default:
filters specified in afew's config]
-d, --dry-run don't change the db [default: False]
-R REFERENCE_SET_SIZE, --reference-set-size=REFERENCE_SET_SIZE
size of the reference set [default: 1000]
-T DAYS, --reference-set-timeframe=DAYS
do not use mails older than DAYS days [default: 30]
-v, --verbose be more verbose, can be given multiple times
|
