cli/new: add --try-decrypt=(true|false)
[notmuch] / doc / man1 / notmuch-new.rst
1 ===========
2 notmuch-new
3 ===========
4
5 SYNOPSIS
6 ========
7
8 **notmuch** **new** [options]
9
10 DESCRIPTION
11 ===========
12
13 Find and import any new messages to the database.
14
15 The **new** command scans all sub-directories of the database,
16 performing full-text indexing on new messages that are found. Each new
17 message will automatically be tagged with both the **inbox** and
18 **unread** tags.
19
20 You should run **notmuch new** once after first running **notmuch
21 setup** to create the initial database. The first run may take a long
22 time if you have a significant amount of mail (several hundred thousand
23 messages or more). Subsequently, you should run **notmuch new** whenever
24 new mail is delivered and you wish to incorporate it into the database.
25 These subsequent runs will be much quicker than the initial run.
26
27 Invoking ``notmuch`` with no command argument will run **new** if
28 **notmuch setup** has previously been completed, but **notmuch new** has
29 not previously been run.
30
31 **notmuch new** updates tags according to maildir flag changes if the
32 **maildir.synchronize\_flags** configuration option is enabled. See
33 **notmuch-config(1)** for details.
34
35 The **new** command supports hooks. See **notmuch-hooks(5)** for more
36 details on hooks.
37
38 Supported options for **new** include
39
40     ``--no-hooks``
41         Prevents hooks from being run.
42
43     ``--quiet``
44         Do not print progress or results.
45
46     ``--try-decrypt=(true|false)``
47
48         If true, when encountering an encrypted message, try to
49         decrypt it while indexing.  If decryption is successful, index
50         the cleartext itself.  Be aware that the index is likely
51         sufficient to reconstruct the cleartext of the message itself,
52         so please ensure that the notmuch message index is adequately
53         protected.  DO NOT USE ``--try-decrypt=true`` without
54         considering the security of your index.
55
56         See also ``index.try_decrypt`` in **notmuch-config(1)**.
57
58 EXIT STATUS
59 ===========
60
61 This command supports the following special exit status code
62
63 ``75 (EX_TEMPFAIL)``
64     A temporary failure occurred; the user is invited to retry.
65
66 SEE ALSO
67 ========
68
69 **notmuch(1)**,
70 **notmuch-config(1)**,
71 **notmuch-count(1)**,
72 **notmuch-dump(1)**,
73 **notmuch-hooks(5)**,
74 **notmuch-insert(1)**,
75 **notmuch-reply(1)**,
76 **notmuch-restore(1)**,
77 **notmuch-search(1)**,
78 **notmuch-search-terms(7)**,
79 **notmuch-show(1)**,
80 **notmuch-tag(1)**