.\" Generated by scdoc 1.11.3 .\" Complete documentation for this program is not available as a GNU info page .ie \n(.g .ds Aq \(aq .el .ds Aq ' .nh .ad l .\" Begin generated content: .TH "AERC-NOTMUCH" "5" "2024-07-30" .PP .SH NAME .PP aerc-notmuch - notmuch configuration for \fBaerc\fR(1) .PP .SH SYNOPSIS .PP aerc supports using the notmuch email system as a backend, for fast indexing and searching.\& .PP For this to be enabled, aerc needs to be build with notmuch support.\& Refer to the installation instructions for details.\& .PP .SH CONFIGURATION .PP Basic Notmuch configuration may be done interactively with the \fB:new-account\fR command.\& .PP In \fIaccounts.\&conf\fR (see \fBaerc-accounts\fR(5)), the following notmuch-specific options are available: .PP \fBcheck-mail-cmd\fR = \fI\fR .RS 4 Command to run in conjunction with \fBcheck-mail\fR option.\& .PP Example: .RS 4 check-mail-cmd = mbsync -a .PP .RE .RE \fBcheck-mail-timeout\fR = \fI\fR .RS 4 Timeout for the \fBcheck-mail-cmd\fR.\& 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 .PP Default: \fI10s\fR .PP .RE \fBsource\fR = notmuch://\fI\fR .RS 4 The \fBsource\fR indicates the path to the directory containing your notmuch database (usually a \fI.\¬much/\fR folder).\& .PP The path portion of the URL following \fInotmuch://\fR must be either an absolute path prefixed by \fI/\fR or a path relative to your home directory prefixed with \fI~\fR.\& For example: .PP .RS 4 source = notmuch:///home/me/mail .PP source = notmuch://~/mail .PP .RE .RE \fBquery-map\fR = \fI\fR .RS 4 Path to a file containing a mapping from display name to notmuch query in the form of \fB\fR=\fI\fR.\& .PP Multiple entries can be specified, one per line.\& Lines starting with \fI#\fR are ignored and serve as comments.\& .PP e.\&g.\& inbox=tag:inbox and not tag:archived .PP .RE \fBexclude-tags\fR = \fI\fR .RS 4 Comma separated list of tags which will be excluded from query results, unless explicitly mentioned in the query.\& .PP This can for example be useful if you use an \fIarchive\fR or \fIspam\fR tag.\& .PP .RE \fBmaildir-store\fR = \fI\fR .RS 4 Path to the maildir store containing the message files backing the notmuch database.\& This is often the same as the notmuch database path.\& If specified, this option will be used by aerc to list available folders and enable commands such as \fB:delete\fR and \fB:archive\fR.\& .PP N.\&B.\&: aerc will still always show messages and not files (under notmuch, a single message can be represented by several files), which makes the semantics of certain commands as \fBmove\fR ambiguous.\& Use \fBmulti-file-strategy\fR to tell aerc how to resolve these ambiguities.\& .PP .RE \fBmaildir-account-path\fR = \fI\fR .RS 4 Path to the maildir account relative to the \fBmaildir-store\fR.\& .PP This could be used to achieve traditional maildir one tab per account behavior.\& The note on \fBmaildir-store\fR also applies to this option.\& .PP .RE \fBmulti-file-stategy\fR = \fI\fR .RS 4 Strategy for file operations (e.\&g.\&, move, copy, delete) on messages that are backed by multiple files.\& Possible values: .PP .PD 0 .IP \(bu 4 \fBrefuse\fR (default): Refuse to act.\& .IP \(bu 4 \fBact-all\fR: Act on all files.\& .IP \(bu 4 \fBact-one\fR: Act on one of the files, arbitrarily chosen, and ignore the .PD .RE rest.\& .RS 4 .PD 0 .IP \(bu 4 \fBact-one-delete-rest\fR: Like \fBact-one\fR, but delete the remaining files.\& .IP \(bu 4 \fBact-dir\fR: Act on all files within the current folder and ignore the rest.\& .PD .RE Note that this strategy only works within the maildir directories; in other .RS 4 directories, it behaves like \fBrefuse\fR.\& .PD 0 .IP \(bu 4 \fBact-dir-delete-rest\fR: Like \fBact-dir\fR, but delete the remaining files.\& .PD .PP Note that the strategy has no effect on cross-account operations.\& Copying a message across accounts will always copy a single file, arbitrarily chosen.\& Moving a message across accounts will always copy a single file, arbitrarily chosen, and refuse to delete multiple files from the source account.\& .PP .RE .SH USAGE .PP Notmuch shows slightly different behavior than for example imap.\& Some commands are slightly different in semantics and mentioned below: .PP \fBcf\fR \fI\fR .RS 4 The change folder command allows for arbitrary notmuch queries.\& Performing a \fB:cf\fR command will perform a new top-level notmuch query.\& .PP .RE \fBfilter\fR \fI\fR .RS 4 The filter command for notmuch backends takes in arbitrary notmuch queries.\& It applies the query on the set of messages shown in the message list.\& This can be used to perform successive filters/queries.\& It is equivalent to performing a set of queries concatenated with "and".\& .PP .RE .SH SEE ALSO .PP \fBaerc\fR(1) \fBaerc-accounts\fR(5) \fBaerc-smtp\fR(5) \fBaerc-maildir\fR(5) .PP .SH AUTHORS .PP Originally created by Drew DeVault and maintained by Robin Jarry who is assisted by other open source contributors.\& For more information about aerc development, see \fIhttps://sr.\&ht/~rjarry/aerc/\fR.\&