X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-insert.rst;h=1a3dfe98299ae21b6501de65cad97ef9f91a18bb;hb=f2a6790583825ffe3c564582f9a93a6c50d8430a;hp=9847e674688ed1cb23b95ef87ccc2efb89599268;hpb=5de84d07526d330a46e50d955bdfeed8f629637d;p=notmuch diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst index 9847e674..1a3dfe98 100644 --- a/doc/man1/notmuch-insert.rst +++ b/doc/man1/notmuch-insert.rst @@ -34,7 +34,8 @@ Supported options for **insert** include ``--folder=<``\ folder\ **>** Deliver the message to the specified folder, relative to the top-level directory given by the value of **database.path**. The - default is to deliver to the top-level directory. + default is the empty string, which means delivering to the + top-level directory. ``--create-folder`` Try to create the folder named by the ``--folder`` option, if it @@ -50,6 +51,29 @@ Supported options for **insert** include ``--no-hooks`` Prevent hooks from being run. + ``--decrypt=(true|nostash|auto|false)`` + + If ``true`` and the message is encrypted, try to decrypt the + message while indexing, stashing any session keys discovered. + If ``auto``, and notmuch already knows about a session key for + the message, it will try decrypting using that session key but + will not try to access the user's secret keys. If decryption + is successful, index the cleartext itself. Either way, the + message is always stored to disk in its original form + (ciphertext). + + ``nostash`` is the same as ``true`` except that it will not + stash newly-discovered session keys in the database. + + Be aware that the index is likely sufficient (and a stashed + session key is certainly sufficient) to reconstruct the + cleartext of the message itself, so please ensure that the + notmuch message index is adequately protected. DO NOT USE + ``--decrypt=true`` or ``--decrypt=nostash`` without + considering the security of your index. + + See also ``index.decrypt`` in **notmuch-config(1)**. + EXIT STATUS =========== @@ -65,7 +89,7 @@ errors most likely to be temporary in nature, e.g. failure to get a database write lock. ``75 (EX_TEMPFAIL)`` - A temporary failure occured; the user is invited to retry. + A temporary failure occurred; the user is invited to retry. The exit status of the **post-insert** hook does not affect the exit status of the **insert** command. @@ -73,7 +97,14 @@ status of the **insert** command. SEE ALSO ======== -**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**, -**notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-reply(1)**, -**notmuch-restore(1)**, **notmuch-search(1)**, -**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)** +**notmuch(1)**, +**notmuch-config(1)**, +**notmuch-count(1)**, +**notmuch-dump(1)**, +**notmuch-hooks(5)**, +**notmuch-reply(1)**, +**notmuch-restore(1)**, +**notmuch-search(1)**, +**notmuch-search-terms(7)**, +**notmuch-show(1)**, +**notmuch-tag(1)**