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 index.decrypt [STORED IN DATABASE]
137 Policy for decrypting encrypted messages during indexing. Must
138 be one of: false, auto, nostash, or true.
139 When indexing an encrypted e-mail message, if this variable is
141 set to true, notmuch will try to decrypt the message and index
142 the cleartext, stashing a copy of any discovered session keys
143 for the message. If auto, it will try to index the cleartext if
144 a stashed session key is already known for the message (e.g.
145 from a previous copy), but will not try to access your secret
146 keys. Use false to avoid decrypting even when a stashed session
147 key is already present.
148 nostash is the same as true except that it will not stash
150 newly-discovered session keys in the database.
151 From the command line (i.e. during notmuch-new(1), not‐
153 much-insert(1), or notmuch-reindex(1)), the user can override
154 the database's stored decryption policy with the --decrypt=
155 option.
156 Here is a table that summarizes the functionality of each of
158 these policies:
159 ┌──────────────┬───────┬──────┬─────────┬──────┐
161 │ │ false │ auto │ nostash │ true │
162 ├──────────────┼───────┼──────┼─────────┼──────┤
163 │Index cleart‐ │ │ X │ X │ X │
164 │ext using │ │ │ │ │
165 │stashed ses‐ │ │ │ │ │
166 │sion keys │ │ │ │ │
167 ├──────────────┼───────┼──────┼─────────┼──────┤
168 │Index cleart‐ │ │ │ X │ X │
169 │ext using │ │ │ │ │
170 │secret keys │ │ │ │ │
171 ├──────────────┼───────┼──────┼─────────┼──────┤
172 │Stash session │ │ │ │ X │
173 │keys │ │ │ │ │
174 ├──────────────┼───────┼──────┼─────────┼──────┤
175 │Delete │ X │ │ │ │
176 │stashed ses‐ │ │ │ │ │
177 │sion keys on │ │ │ │ │
178 │reindex │ │ │ │ │
179 └──────────────┴───────┴──────┴─────────┴──────┘
180 Stashed session keys are kept in the database as properties
182 associated with the message. See session-key in notmuch-proper‐
183 ties(7) for more details about how they can be useful.
184 Be aware that the notmuch index is likely sufficient (and a
186 stashed session key is certainly sufficient) to reconstruct the
187 cleartext of the message itself, so please ensure that the not‐
188 much message index is adequately protected. DO NOT USE
189 index.decrypt=true or index.decrypt=nostash without considering
190 the security of your index.
191 Default: auto.
193 index.header.<prefix> [STORED IN DATABASE]
195 Define the query prefix <prefix>, based on a mail header. For
196 example index.header.List=List-Id will add a probabilistic pre‐
197 fix List: that searches the List-Id field. User defined pre‐
198 fixes must not start with 'a'...'z'; in particular adding a pre‐
199 fix with same name as a predefined prefix is not supported. See
200 notmuch-search-terms(7) for a list of existing prefixes, and an
201 explanation of probabilistic prefixes.
202 built_with.<name>
204 Compile time feature <name>. Current possibilities include
205 "retry_lock" (configure option, included by default). (since
206 notmuch 0.30, "compact" and "field_processor" are always
207 included.)
208 query.<name> [STORED IN DATABASE]
210 Expansion for named query called <name>. See not‐
211 much-search-terms(7) for more information about named queries.
212
214 The following environment variables can be used to control the behavior
215 of notmuch.
216 NOTMUCH_CONFIG
218 Specifies the location of the notmuch configuration file. Not‐
219 much will use ${HOME}/.notmuch-config if this variable is not
220 set.
221
223 notmuch(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5), not‐
224 much-insert(1), notmuch-new(1), notmuch-reply(1), notmuch-restore(1),
225 notmuch-search(1), notmuch-search-terms(7), notmuch-properties(7), not‐
226 much-show(1), notmuch-tag(1)
227
229 Carl Worth and many others
230
232 2009-2020, Carl Worth and many others
2330.31.3 Dec 25, 2020 NOTMUCH-CONFIG(1)