NOTMUCH-CONFIG(1) | notmuch | NOTMUCH-CONFIG(1) |
notmuch-config - access notmuch configuration file
notmuch config get <section>.<item>
notmuch config set <section>.<item> [value ...]
notmuch config list
The config command can be used to get or set settings in the notmuch configuration file and corresponding database.
Items marked [STORED IN DATABASE] are only in the database. They should not be placed in the configuration file, and should be accessed programmatically as described in the SYNOPSIS above.
If no values are provided, the specified configuration item will be removed from the configuration file.
section.item=value
No additional whitespace surrounds the dot or equals sign characters. In a multiple-value item (a list), the values are separated by semicolon characters.
The available configuration items are described below.
Default: $MAILDIR variable if set, otherwise $HOME/mail.
Default: $NAME variable if set, otherwise read from /etc/passwd.
Default: $EMAIL variable if set, otherwise constructed from the username and hostname of the current machine.
Default: not set.
Default: unread;inbox.
A file or a directory name, without path, that will be ignored, regardless of the location in the mail store directory hierarchy.
Or:
A regular expression delimited with // that will be matched against the path of the file or directory relative to the database path. Matching files and directories will be ignored. The beginning and end of string must be explicitly anchored. For example, /.*/foo$/ would match "bar/foo" and "bar/baz/foo", but not "foo" or "bar/foobar".
Default: empty list.
Default: empty list. Note that notmuch-setup(1) puts deleted;spam here when creating new configuration file.
Flag | Tag |
D | draft |
F | flagged |
P | passed |
R | replied |
S | unread (added when 'S' flag is not present) |
The notmuch new command will notice flag changes in filenames and update tags, while the notmuch tag and notmuch restore commands will notice tag changes and update flags in filenames.
If there have been any changes in the maildir (new messages added, old ones removed or renamed, maildir flags changed, etc.), it is advisable to run notmuch new before notmuch tag or notmuch restore commands to ensure the tag changes are properly synchronized to the maildir flags, as the commands expect the database and maildir to be in sync.
Default: true.
When indexing an encrypted e-mail message, if this variable is set to true, notmuch will try to decrypt the message and index the cleartext, stashing a copy of any discovered session keys for the message. If auto, it will try to index the cleartext if a stashed session key is already known for the message (e.g. from a previous copy), but will not try to access your secret keys. Use false to avoid decrypting even when a stashed session key is already present.
nostash is the same as true except that it will not stash newly-discovered session keys in the database.
From the command line (i.e. during notmuch-new(1), notmuch-insert(1), or notmuch-reindex(1)), the user can override the database's stored decryption policy with the --decrypt= option.
Here is a table that summarizes the functionality of each of these policies:
false | auto | nostash | true | |
Index cleartext using stashed session keys | X | X | X | |
Index cleartext using secret keys | X | X | ||
Stash session keys | X | |||
Delete stashed session keys on reindex | X |
Stashed session keys are kept in the database as properties associated with the message. See session-key in notmuch-properties(7) for more details about how they can be useful.
Be aware that the notmuch index is likely sufficient (and a stashed session key is certainly sufficient) to reconstruct the cleartext of the message itself, so please ensure that the notmuch message index is adequately protected. DO NOT USE index.decrypt=true or index.decrypt=nostash without considering the security of your index.
Default: auto.
The following environment variables can be used to control the behavior of notmuch.
notmuch(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reply(1), notmuch-restore(1), notmuch-search(1), notmuch-search-terms(7), notmuch-properties(7), notmuch-show(1), notmuch-tag(1)
Carl Worth and many others
2009-2021, Carl Worth and many others
June 29, 2021 | 0.31.4 |