1aerc-notmuch(5)               File Formats Manual              aerc-notmuch(5)
2
3
4

NAME

6       aerc-notmuch - notmuch configuration for aerc(1)
7

SYNOPSIS

9       aerc supports using the notmuch email system as a backend, for fast in‐
10       dexing and searching.
11
12       For this to be enabled, aerc needs to be build with notmuch support.
13       Refer to the installation instructions for details.
14

CONFIGURATION

16       Notmuch accounts currently are not supported with the :new-account com‐
17       mand and must be added manually.
18
19       In accounts.conf (see aerc-config(5)), the following notmuch-specific
20       options are available:
21
22       check-mail-cmd
23           Command to run in conjunction with check-mail option.
24
25           Example:
26               mbsync -a
27
28           Default: none
29
30       check-mail-timeout
31           Timeout for the check-mail-cmd. The command will be stopped if it
32           does not complete in this interval and an error will be displayed.
33           Increase from the default if repeated errors occur
34
35           Default: 10s
36
37       source
38           notmuch://path
39
40           The source indicates the path to the directory containing your not‐
41           much database (usually a .notmuch folder).
42
43           The path portion of the URL following notmuch:// must be either an
44           absolute path prefixed by / or a path relative to your home direc‐
45           tory prefixed with ~. For example:
46
47               source = notmuch:///home/me/mail
48
49               source = notmuch://~/mail
50
51       query-map
52           Path to a file containing a mapping from display name to notmuch
53           query in the form of NAME=QUERY.
54           Multiple entries can be specified, one per line.
55           Lines starting with '#' are ignored and serve as comments.
56
57           e.g. inbox=tag:inbox and not tag:archived
58
59           Default: none
60
61       exclude-tags
62           Comma separated list of tags which will be excluded from query re‐
63           sults, unless explicitly mentioned in the query.
64           This can for example be useful if you use an archive or spam tag.
65
66           Default: none
67

USAGE

69       Notmuch shows slightly different behavior than for example imap.
70       Some commands are simply unsupported because they have no proper coun‐
71       terpart in notmuch, like :delete and :archive.
72       Others are slightly different in semantics and mentioned below:
73
74       cf <notmuch query>
75           The change folder command allows for arbitrary notmuch queries.
76           Performing a cf command will perform a new top-level notmuch query
77
78       filter <notmuch query>
79           The filter command for notmuch backends takes in arbitrary notmuch
80           queries. It applies the query on the set of messages shown in the
81           message list. This can be used to perform successive fil‐
82           ters/queries. It is equivalent to performing a set of queries con‐
83           catenated with "and"
84

SEE ALSO

86       aerc(1) aerc-config(5) aerc-smtp(5) aerc-maildir(5)
87

AUTHORS

89       Originally created by Drew DeVault <sir@cmpwn.com> and maintained by
90       Robin Jarry <robin@jarry.cc> who is assisted by other open source con‐
91       tributors. For more information about aerc development, see
92       https://sr.ht/~rjarry/aerc/.
93
94
95
96                                  2022-11-02                   aerc-notmuch(5)
Impressum