blob: 44b6b9d202da39b46d43c9706e171c006dfa1da2 (
plain) (
tree)
|
|
aerc-notmuch(5)
# NAME
aerc-notmuch - notmuch configuration for *aerc*(1)
# SYNOPSIS
aerc supports using the notmuch email system as a backend, for fast indexing
and searching.
For this to be enabled, aerc needs to be build with notmuch support.++
Refer to the installation instructions for details.
# CONFIGURATION
Notmuch accounts currently are not supported with the :new-account command and
must be added manually.
In accounts.conf (see *aerc-config*(5)), the following notmuch-specific
options are available:
*check-mail-cmd*
Command to run in conjunction with *check-mail* option.
Example:
mbsync -a
Default: none
*check-mail-timeout*
Timeout for the *check-mail-cmd*. The command will be stopped if it does
not complete in this interval and an error will be displayed. Increase from
the default if repeated errors occur
Default: 10s
*source*
notmuch://path
The *source* indicates the path to the directory containing your notmuch
database (usually a .notmuch folder).
The path portion of the URL following _notmuch://_ must be either an absolute
path prefixed by */* or a path relative to your home directory prefixed with
*~*. For example:
source = notmuch:///home/me/mail
source = notmuch://~/mail
*query-map*
Path to a file containing a mapping from display name to notmuch query in
the form of NAME=QUERY.++
Multiple entries can be specified, one per line.++
Lines starting with '#' are ignored and serve as comments.
e.g. inbox=tag:inbox and not tag:archived
Default: none
*exclude-tags*
Comma separated list of tags which will be excluded from query results,
unless explicitly mentioned in the query.++
This can for example be useful if you use an archive or spam tag.
Default: none
# USAGE
Notmuch shows slightly different behaviour than for example imap.++
Some commands are simply unsupported because they have no proper counterpart
in notmuch, like :delete and :archive.++
Others are slightly different in semantics and mentioned below:
*cf* <notmuch query>
The change folder command allows for arbitrary notmuch queries and should
usually be preferred over *:filter* as it will be much faster if you use
the notmuch database to do the filtering
# SEE ALSO
*aerc*(1) *aerc-config*(5) *aerc-smtp*(5) *aerc-maildir*(5)
# AUTHORS
Originally created by Drew DeVault <sir@cmpwn.com> and maintained by Robin
Jarry <robin@jarry.cc> who is assisted by other open source contributors. For
more information about aerc development, see https://sr.ht/~rjarry/aerc/.
|
