Provided by: notmuch_0.35-2ubuntu1_amd64 
NAME
notmuch-config - access notmuch configuration file
SYNOPSIS
notmuch config get <section>.<item>
notmuch config set [--database] <section>.<item> [value ...]
notmuch config list
DESCRIPTION
The config command can be used to get or set settings in the notmuch configuration file and corresponding
database.
get The value of the specified configuration item is printed to stdout. If the item has multiple
values (it is a list), each value is separated by a newline character.
set The specified configuration item is set to the given value. To specify a multiple-value item (a
list), provide each value as a separate command-line argument.
If no values are provided, the specified configuration item will be removed from the configuration
file.
With the --database option, updates configuration metadata stored in the database, rather than the
default (text) configuration file.
list Every configuration item is printed to stdout, each on a separate line of the form:
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. Non-absolute paths are presumed relative to $HOME
for items in section database.
database.path
Notmuch will store its database here, (in sub-directory named .notmuch if database.mail_root is
unset).
Default: see DATABASE LOCATION
database.mail_root
The top-level directory where your mail currently exists and to where mail will be delivered in
the future. Files should be individual email messages.
History: this configuration value was introduced in notmuch 0.32.
Default: For compatibility with older configurations, the value of database.path is used if
database.mail_root is unset.
database.backup_dir
Directory to store tag dumps when upgrading database.
History: this configuration value was introduced in notmuch 0.32.
Default: A sibling directory of the Xapian database called backups.
database.hook_dir
Directory containing hooks run by notmuch commands. See notmuch-hooks(5).
History: this configuration value was introduced in notmuch 0.32.
Default: See HOOKS, below.
database.autocommit
How often to commit transactions to disk. 0 means wait until command completes, otherwise an integer n
specifies to commit to disk after every n completed transactions.
History: this configuration value was introduced in notmuch 0.33.
user.name
Your full name.
Default: $NAME variable if set, otherwise read from /etc/passwd.
user.primary_email
Your primary email address.
Default: $EMAIL variable if set, otherwise constructed from the username and hostname of the
current machine.
user.other_email
A list of other email addresses at which you receive email.
Default: not set.
new.tags
A list of tags that will be added to all messages incorporated by notmuch new.
Default: unread;inbox.
new.ignore
A list to specify files and directories that will not be searched for messages by notmuch-new(1).
Each entry in the list is either:
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.
search.exclude_tags
A list of tags that will be excluded from search results by default. Using an excluded tag in a
query will override that exclusion.
Default: empty list. Note that notmuch-setup(1) puts deleted;spam here when creating new
configuration file.
show.extra_headers
By default notmuch-show(1) includes the following headers in structured output if they are present in
the message: Subject, From, To, Cc, Bcc, Reply-To, Date. This option allows the specification of a
list of further headers to output.
History: This configuration value was introduced in notmuch 0.35.
Default: empty list.
maildir.synchronize_flags
If true, then the following maildir flags (in message filenames) will be synchronized with the
corresponding notmuch tags:
────────────────────────────────────────────────
Flag Tag
────────────────────────────────────────────────
D draft
────────────────────────────────────────────────
F flagged
────────────────────────────────────────────────
P passed
────────────────────────────────────────────────
R replied
────────────────────────────────────────────────
S unread (added when 'S' flag is not
present)
┌──────┬───────────────────────────────────────┐
│ │ │
--
FILES
CONFIGURATION
Notmuch configuration file search order:
1. File specified by notmuch --config global option; see notmuch(1).
2. File specified by NOTMUCH_CONFIG environment variable.
3. $XDG_CONFIG_HOME/notmuch/<profile>/config where <profile> is defined by NOTMUCH_PROFILE environment
variable if set, $XDG_CONFIG_HOME/notmuch/default/config otherwise.
4. $HOME/.notmuch-config.<profile> where <profile> is defined by NOTMUCH_PROFILE environment variable if
set, $HOME/.notmuch-config otherwise.
DATABASE LOCATION
Notmuch database search order:
1. Directory specified by NOTMUCH_DATABASE environment variable.
2. Directory specified by config key database.path.
3. $XDG_DATA_HOME/notmuch/<profile> where <profile> is defined by NOTMUCH_PROFILE environment variable if
set, $XDG_DATA_HOME/notmuch/default otherwise.
4. Directory specified by MAILDIR environment variable.
5. $HOME/mail
HOOKS
Notmuch hook directory search order:
1. Directory specified by database.hook_dir configuration option.
2. $XDG_CONFIG_HOME/notmuch/<profile>/hooks where <profile> is defined by NOTMUCH_PROFILE environment
variable if set, $XDG_CONFIG_HOME/notmuch/default/hooks otherwise.
3. <database.path>/.notmuch/hooks
SEE ALSO
notmuch(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5), notmuch-insert(1), notmuch-new(1),
notmuch-properties(7), notmuch-reply(1), notmuch-restore(1), notmuch-search(1), notmuch-search-terms(7),
notmuch-show(1), notmuch-tag(1)
AUTHOR
Carl Worth and many others
COPYRIGHT
2009-2022, Carl Worth and many others
0.35 Mar 29, 2022 NOTMUCH-CONFIG(1)