8 **notmuch** **config** **get** <*section*>.<*item*>
10 **notmuch** **config** **set** <*section*>.<*item*> [*value* ...]
12 **notmuch** **config** **list**
17 The **config** command can be used to get or set settings in the notmuch
18 configuration file and corresponding database.
20 Items marked **[STORED IN DATABASE]** are only in the database. They
21 should not be placed in the configuration file, and should be accessed
22 programmatically as described in the SYNOPSIS above.
25 The value of the specified configuration item is printed to
26 stdout. If the item has multiple values (it is a list), each value
27 is separated by a newline character.
30 The specified configuration item is set to the given value. To
31 specify a multiple-value item (a list), provide each value as a
32 separate command-line argument.
34 If no values are provided, the specified configuration item will
35 be removed from the configuration file.
38 Every configuration item is printed to stdout, each on a separate
43 No additional whitespace surrounds the dot or equals sign
44 characters. In a multiple-value item (a list), the values are
45 separated by semicolon characters.
47 The available configuration items are described below.
50 The top-level directory where your mail currently exists and to
51 where mail will be delivered in the future. Files should be
52 individual email messages. Notmuch will store its database within
53 a sub-directory of the path configured here named ``.notmuch``.
55 Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``.
60 Default: ``$NAME`` variable if set, otherwise read from
63 **user.primary\_email**
64 Your primary email address.
66 Default: ``$EMAIL`` variable if set, otherwise constructed from
67 the username and hostname of the current machine.
70 A list of other email addresses at which you receive email.
75 A list of tags that will be added to all messages incorporated by
78 Default: ``unread;inbox``.
81 A list to specify files and directories that will not be searched
82 for messages by **notmuch new**. Each entry in the list is either:
84 A file or a directory name, without path, that will be ignored,
85 regardless of the location in the mail store directory hierarchy.
89 A regular expression delimited with // that will be matched
90 against the path of the file or directory relative to the database
91 path. Matching files and directories will be ignored. The
92 beginning and end of string must be explicitly anchored. For
93 example, /.*/foo$/ would match "bar/foo" and "bar/baz/foo", but
94 not "foo" or "bar/foobar".
98 **search.exclude\_tags**
99 A list of tags that will be excluded from search results by
100 default. Using an excluded tag in a query will override that
103 Default: empty list. Note that **notmuch-setup(1)** puts
104 ``deleted;spam`` here when creating new configuration file.
106 **maildir.synchronize\_flags**
107 If true, then the following maildir flags (in message filenames)
108 will be synchronized with the corresponding notmuch tags:
110 +--------+-----------------------------------------------+
112 +========+===============================================+
114 +--------+-----------------------------------------------+
116 +--------+-----------------------------------------------+
118 +--------+-----------------------------------------------+
120 +--------+-----------------------------------------------+
121 | S | unread (added when 'S' flag is not present) |
122 +--------+-----------------------------------------------+
124 The **notmuch new** command will notice flag changes in filenames
125 and update tags, while the **notmuch tag** and **notmuch restore**
126 commands will notice tag changes and update flags in filenames.
128 If there have been any changes in the maildir (new messages added,
129 old ones removed or renamed, maildir flags changed, etc.), it is
130 advisable to run **notmuch new** before **notmuch tag** or
131 **notmuch restore** commands to ensure the tag changes are
132 properly synchronized to the maildir flags, as the commands expect
133 the database and maildir to be in sync.
137 **index.decrypt** **[STORED IN DATABASE]**
138 Policy for decrypting encrypted messages during indexing. Must be
139 one of: ``false``, ``auto``, ``nostash``, or ``true``.
141 When indexing an encrypted e-mail message, if this variable is set
142 to ``true``, notmuch will try to decrypt the message and index the
143 cleartext, stashing a copy of any discovered session keys for the
144 message. If ``auto``, it will try to index the cleartext if a
145 stashed session key is already known for the message (e.g. from a
146 previous copy), but will not try to access your secret keys. Use
147 ``false`` to avoid decrypting even when a stashed session key is
150 ``nostash`` is the same as ``true`` except that it will not stash
151 newly-discovered session keys in the database.
153 From the command line (i.e. during **notmuch-new(1)**,
154 **notmuch-insert(1)**, or **notmuch-reindex(1)**), the user can
155 override the database's stored decryption policy with the
156 ``--decrypt=`` option.
158 Here is a table that summarizes the functionality of each of these
161 +------------------------+-------+------+---------+------+
162 | | false | auto | nostash | true |
163 +========================+=======+======+=========+======+
164 | Index cleartext using | | X | X | X |
165 | stashed session keys | | | | |
166 +------------------------+-------+------+---------+------+
167 | Index cleartext | | | X | X |
168 | using secret keys | | | | |
169 +------------------------+-------+------+---------+------+
170 | Stash session keys | | | | X |
171 +------------------------+-------+------+---------+------+
172 | Delete stashed session | X | | | |
173 | keys on reindex | | | | |
174 +------------------------+-------+------+---------+------+
176 Stashed session keys are kept in the database as properties
177 associated with the message. See ``session-key`` in
178 **notmuch-properties(7)** for more details about how they can be
181 Be aware that the notmuch index is likely sufficient (and a
182 stashed session key is certainly sufficient) to reconstruct the
183 cleartext of the message itself, so please ensure that the notmuch
184 message index is adequately protected. DO NOT USE
185 ``index.decrypt=true`` or ``index.decrypt=nostash`` without
186 considering the security of your index.
190 **index.header.<prefix>** **[STORED IN DATABASE]**
191 Define the query prefix <prefix>, based on a mail header. For
192 example ``index.header.List=List-Id`` will add a probabilistic
193 prefix ``List:`` that searches the ``List-Id`` field. User
194 defined prefixes must not start with 'a'...'z'; in particular
195 adding a prefix with same name as a predefined prefix is not
196 supported. See **notmuch-search-terms(7)** for a list of existing
197 prefixes, and an explanation of probabilistic prefixes.
199 **built_with.<name>**
200 Compile time feature <name>. Current possibilities include
201 "retry_lock" (configure option, included by default).
202 (since notmuch 0.30, "compact" and "field_processor" are
205 **query.<name>** **[STORED IN DATABASE]**
206 Expansion for named query called <name>. See
207 **notmuch-search-terms(7)** for more information about named
213 The following environment variables can be used to control the behavior
217 Specifies the location of the notmuch configuration file. Notmuch
218 will use ${HOME}/.notmuch-config if this variable is not set.
224 **notmuch-count(1)**,
226 **notmuch-hooks(5)**,
227 **notmuch-insert(1)**,
229 **notmuch-reply(1)**,
230 **notmuch-restore(1)**,
231 **notmuch-search(1)**,
232 **notmuch-search-terms(7)**,
233 **notmuch-properties(7)**,