X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-insert.rst;h=b22be863dc351fe4a5a56844e3829a4a6f75dec0;hb=181d4091c408b8ca014ec245ecdae602942b70ce;hp=f83a7385ccf457a705a28a4e3d92ce35bbbf819e;hpb=6499fce3911df2646db67c0f1ff65672324904f0;p=notmuch diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst index f83a7385..b22be863 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,24 @@ Supported options for **insert** include ``--no-hooks`` Prevent hooks from being run. + ``--decrypt=(true|auto|false)`` + + If ``true`` and the message is encrypted, try to decrypt the + message while indexing. 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). + + Be aware that the index is likely 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`` without considering the security of + your index. + + See also ``index.decrypt`` in **notmuch-config(1)**. + EXIT STATUS ===========