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-accounts(5)), the following notmuch-specific
20       options are available:
21
22       check-mail-cmd = <command>
23           Command to run in conjunction with check-mail option.
24
25           Example:
26               check-mail-cmd = mbsync -a
27
28       check-mail-timeout = <duration>
29           Timeout for the check-mail-cmd. The command will be stopped if it
30           does not complete in this interval and an error will be displayed.
31           Increase from the default if repeated errors occur
32
33           Default: 10s
34
35       source = notmuch://<path>
36           The source indicates the path to the directory containing your not‐
37           much database (usually a .notmuch/ folder).
38
39           The path portion of the URL following notmuch:// must be either an
40           absolute path prefixed by / or a path relative to your home direc‐
41           tory prefixed with ~. For example:
42
43               source = notmuch:///home/me/mail
44
45               source = notmuch://~/mail
46
47       query-map = <file>
48           Path to a file containing a mapping from display name to notmuch
49           query in the form of <NAME>=<QUERY>.
50
51           Multiple entries can be specified, one per line. Lines starting
52           with # are ignored and serve as comments.
53
54           e.g. inbox=tag:inbox and not tag:archived
55
56       exclude-tags = <tag1,tag2,tag3...>
57           Comma separated list of tags which will be excluded from query re‐
58           sults, unless explicitly mentioned in the query.
59
60           This can for example be useful if you use an archive or spam tag.
61
62       maildir-store = <path>
63           Path to the maildir store containing the message files backing the
64           notmuch database. This is often the same as the notmuch database
65           path. This is optional. If specified, it will be used by aerc to
66           list available folders and enable commands such as :delete and :ar‐
67           chive.
68

USAGE

70       Notmuch shows slightly different behavior than for example imap. Some
71       commands are slightly different in semantics and mentioned below:
72
73       cf <notmuch query>
74           The change folder command allows for arbitrary notmuch queries.
75           Performing a :cf command will perform a new top-level notmuch
76           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-accounts(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                                  2023-07-19                   AERC-NOTMUCH(5)
Impressum