crypto: actually stash session keys when decrypt=true
[notmuch] / doc / man1 / notmuch-insert.rst
1 ==============
2 notmuch-insert
3 ==============
4
5 SYNOPSIS
6 ========
7
8 **notmuch** **insert** [option ...] [+<*tag*>|-<*tag*> ...]
9
10 DESCRIPTION
11 ===========
12
13 **notmuch insert** reads a message from standard input and delivers it
14 into the maildir directory given by configuration option
15 **database.path**, then incorporates the message into the notmuch
16 database. It is an alternative to using a separate tool to deliver the
17 message then running **notmuch new** afterwards.
18
19 The new message will be tagged with the tags specified by the
20 **new.tags** configuration option, then by operations specified on the
21 command-line: tags prefixed by '+' are added while those prefixed by '-'
22 are removed.
23
24 If the new message is a duplicate of an existing message in the database
25 (it has same Message-ID), it will be added to the maildir folder and
26 notmuch database, but the tags will not be changed.
27
28 The **insert** command supports hooks. See **notmuch-hooks(5)** for
29 more details on hooks.
30
31 Option arguments must appear before any tag operation arguments.
32 Supported options for **insert** include
33
34     ``--folder=<``\ folder\ **>**
35         Deliver the message to the specified folder, relative to the
36         top-level directory given by the value of **database.path**. The
37         default is the empty string, which means delivering to the
38         top-level directory.
39
40     ``--create-folder``
41         Try to create the folder named by the ``--folder`` option, if it
42         does not exist. Otherwise the folder must already exist for mail
43         delivery to succeed.
44
45     ``--keep``
46         Keep the message file if indexing fails, and keep the message
47         indexed if applying tags or maildir flag synchronization
48         fails. Ignore these errors and return exit status 0 to
49         indicate successful mail delivery.
50
51     ``--no-hooks``
52         Prevent hooks from being run.
53
54     ``--decrypt=(true|auto|false)``
55
56         If ``true`` and the message is encrypted, try to decrypt the
57         message while indexing, storing any session keys discovered.
58         If ``auto``, and notmuch already knows about a session key for
59         the message, it will try decrypting using that session key but
60         will not try to access the user's secret keys.  If decryption
61         is successful, index the cleartext itself.  Either way, the
62         message is always stored to disk in its original form
63         (ciphertext).
64
65         Be aware that the index is likely sufficient to reconstruct
66         the cleartext of the message itself, so please ensure that the
67         notmuch message index is adequately protected. DO NOT USE
68         ``--decrypt=true`` without considering the security of
69         your index.
70
71         See also ``index.decrypt`` in **notmuch-config(1)**.
72
73 EXIT STATUS
74 ===========
75
76 This command returns exit status 0 on successful mail delivery,
77 non-zero otherwise. The default is to indicate failed mail delivery on
78 any errors, including message file delivery to the filesystem, message
79 indexing to Notmuch database, changing tags, and synchronizing tags to
80 maildir flags. The ``--keep`` option may be used to settle for
81 successful message file delivery.
82
83 This command supports the following special exit status code for
84 errors most likely to be temporary in nature, e.g. failure to get a
85 database write lock.
86
87 ``75 (EX_TEMPFAIL)``
88     A temporary failure occurred; the user is invited to retry.
89
90 The exit status of the **post-insert** hook does not affect the exit
91 status of the **insert** command.
92
93 SEE ALSO
94 ========
95
96 **notmuch(1)**,
97 **notmuch-config(1)**,
98 **notmuch-count(1)**,
99 **notmuch-dump(1)**,
100 **notmuch-hooks(5)**,
101 **notmuch-reply(1)**,
102 **notmuch-restore(1)**,
103 **notmuch-search(1)**,
104 **notmuch-search-terms(7)**,
105 **notmuch-show(1)**,
106 **notmuch-tag(1)**