1NOTMUCH-CONFIG(1) notmuch NOTMUCH-CONFIG(1)
2
6 notmuch-config - access notmuch configuration file
7
9 notmuch config get <section>.<item>
10 notmuch config set <section>.<item> [value ...]
12 notmuch config list
14
16 The config command can be used to get or set settings in the notmuch
17 configuration file and corresponding database.
18 Items marked [STORED IN DATABASE] are only in the database. They
20 should not be placed in the configuration file, and should be accessed
21 programmatically as described in the SYNOPSIS above.
22 get The value of the specified configuration item is printed to std‐
24 out. If the item has multiple values (it is a list), each value
25 is separated by a newline character.
26 set The specified configuration item is set to the given value. To
28 specify a multiple-value item (a list), provide each value as a
29 separate command-line argument.
30 If no values are provided, the specified configuration item will
32 be removed from the configuration file.
33 list Every configuration item is printed to stdout, each on a sepa‐
35 rate line of the form:
36 *section*.\ *item*\ =\ *value*
38 No additional whitespace surrounds the dot or equals sign char‐
40 acters. In a multiple-value item (a list), the values are sepa‐
41 rated by semicolon characters.
42 The available configuration items are described below.
44 database.path
46 The top-level directory where your mail currently exists and to
47 where mail will be delivered in the future. Files should be
48 individual email messages. Notmuch will store its database
49 within a sub-directory of the path configured here named .not‐
50 much.
51 Default: $MAILDIR variable if set, otherwise $HOME/mail.
53 user.name
55 Your full name.
56 Default: $NAME variable if set, otherwise read from /etc/passwd.
58 user.primary_email
60 Your primary email address.
61 Default: $EMAIL variable if set, otherwise constructed from the
63 username and hostname of the current machine.
64 user.other_email
66 A list of other email addresses at which you receive email.
67 Default: not set.
69 new.tags
71 A list of tags that will be added to all messages incorporated
72 by notmuch new.
73 Default: unread;inbox.
75 new.ignore
77 A list to specify files and directories that will not be
78 searched for messages by notmuch new. Each entry in the list is
79 either:
80 A file or a directory name, without path, that will be ignored,
82 regardless of the location in the mail store directory hierar‐
83 chy.
84 Or:
86 A regular expression delimited with // that will be matched
88 against the path of the file or directory relative to the data‐
89 base path. Matching files and directories will be ignored. The
90 beginning and end of string must be explicitly anchored. For
91 example, /.*/foo$/ would match "bar/foo" and "bar/baz/foo", but
92 not "foo" or "bar/foobar".
93 Default: empty list.
95 search.exclude_tags
97 A list of tags that will be excluded from search results by
98 default. Using an excluded tag in a query will override that
99 exclusion.
100 Default: empty list. Note that notmuch-setup(1) puts
102 deleted;spam here when creating new configuration file.
103 maildir.synchronize_flags
105 If true, then the following maildir flags (in message filenames)
106 will be synchronized with the corresponding notmuch tags:
107 ┌─────┬────────────────────────────┐
109 │Flag │ Tag │
110 ├─────┼────────────────────────────┤
111 │D │ draft │
112 ├─────┼────────────────────────────┤
113 │F │ flagged │
114 ├─────┼────────────────────────────┤
115 │P │ passed │
116 ├─────┼────────────────────────────┤
117 │R │ replied │
118 ├─────┼────────────────────────────┤
119 │S │ unread (added when 'S' │
120 │ │ flag is not present) │
121 └─────┴────────────────────────────┘
122 The notmuch new command will notice flag changes in filenames
124 and update tags, while the notmuch tag and notmuch restore com‐
125 mands will notice tag changes and update flags in filenames.
126 If there have been any changes in the maildir (new messages
128 added, old ones removed or renamed, maildir flags changed,
129 etc.), it is advisable to run notmuch new before notmuch tag or
130 notmuch restore commands to ensure the tag changes are properly
131 synchronized to the maildir flags, as the commands expect the
132 database and maildir to be in sync.
133 Default: true.
135 crypto.gpg_path
137 Name (or full path) of gpg binary to use in verification and
138 decryption of PGP/MIME messages. NOTE: This configuration item
139 is deprecated, and will be ignored if notmuch is built against
140 GMime 3.0 or later.
141 Default: gpg.
143 index.decrypt [STORED IN DATABASE]
145 Policy for decrypting encrypted messages during indexing. Must
146 be one of: false, auto, nostash, or true.
147 When indexing an encrypted e-mail message, if this variable is
149 set to true, notmuch will try to decrypt the message and index
150 the cleartext, stashing a copy of any discovered session keys
151 for the message. If auto, it will try to index the cleartext if
152 a stashed session key is already known for the message (e.g.
153 from a previous copy), but will not try to access your secret
154 keys. Use false to avoid decrypting even when a stashed session
155 key is already present.
156 nostash is the same as true except that it will not stash
158 newly-discovered session keys in the database.
159 From the command line (i.e. during notmuch-new(1), not‐
161 much-insert(1), or notmuch-reindex(1)), the user can override
162 the database's stored decryption policy with the --decrypt=
163 option.
164 Here is a table that summarizes the functionality of each of
166 these policies:
167 ┌──────────────┬───────┬──────┬─────────┬──────┐
169 │ │ false │ auto │ nostash │ true │
170 ├──────────────┼───────┼──────┼─────────┼──────┤
171 │Index cleart‐ │ │ X │ X │ X │
172 │ext using │ │ │ │ │
173 │stashed ses‐ │ │ │ │ │
174 │sion keys │ │ │ │ │
175 ├──────────────┼───────┼──────┼─────────┼──────┤
176 │Index cleart‐ │ │ │ X │ X │
177 │ext using │ │ │ │ │
178 │secret keys │ │ │ │ │
179 ├──────────────┼───────┼──────┼─────────┼──────┤
180 │Stash session │ │ │ │ X │
181 │keys │ │ │ │ │
182 ├──────────────┼───────┼──────┼─────────┼──────┤
183 │Delete │ X │ │ │ │
184 │stashed ses‐ │ │ │ │ │
185 │sion keys on │ │ │ │ │
186 │reindex │ │ │ │ │
187 └──────────────┴───────┴──────┴─────────┴──────┘
188 Stashed session keys are kept in the database as properties
190 associated with the message. See session-key in notmuch-proper‐
191 ties(7) for more details about how they can be useful.
192 Be aware that the notmuch index is likely sufficient (and a
194 stashed session key is certainly sufficient) to reconstruct the
195 cleartext of the message itself, so please ensure that the not‐
196 much message index is adequately protected. DO NOT USE
197 index.decrypt=true or index.decrypt=nostash without considering
198 the security of your index.
199 Default: auto.
201 index.header.<prefix> [STORED IN DATABASE]
203 Define the query prefix <prefix>, based on a mail header. For
204 example index.header.List=List-Id will add a probabilistic pre‐
205 fix List: that searches the List-Id field. User defined pre‐
206 fixes must not start with 'a'...'z'; in particular adding a pre‐
207 fix with same name as a predefined prefix is not supported. See
208 notmuch-search-terms(7) for a list of existing prefixes, and an
209 explanation of probabilistic prefixes.
210 built_with.<name>
212 Compile time feature <name>. Current possibilities include "com‐
213 pact" (see notmuch-compact(1)) and "field_processor" (see not‐
214 much-search-terms(7)).
215 query.<name> [STORED IN DATABASE]
217 Expansion for named query called <name>. See not‐
218 much-search-terms(7) for more information about named queries.
219
221 The following environment variables can be used to control the behavior
222 of notmuch.
223 NOTMUCH_CONFIG
225 Specifies the location of the notmuch configuration file. Not‐
226 much will use ${HOME}/.notmuch-config if this variable is not
227 set.
228
230 notmuch(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5), not‐
231 much-insert(1), notmuch-new(1), notmuch-reply(1), notmuch-restore(1),
232 notmuch-search(1), notmuch-search-terms(7), notmuch-properties(7), not‐
233 much-show(1), notmuch-tag(1)
234
236 Carl Worth and many others
237
239 2009-2019, Carl Worth and many others
2400.29.1 Jul 25, 2019 NOTMUCH-CONFIG(1)