X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-insert.rst;h=1a3dfe98299ae21b6501de65cad97ef9f91a18bb;hb=be555b9d27f5675ef04edc5a34a4dc2b6dfc71ff;hp=e2bf37d04c79e49f6a8127bf36949a84470d2f86;hpb=c5356b9ed56e42d36ca18206155b62c94cfbd79d;p=notmuch diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst index e2bf37d0..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,19 +51,28 @@ Supported options for **insert** include ``--no-hooks`` Prevent hooks from being run. - ``--try-decrypt=(true|false)`` + ``--decrypt=(true|nostash|auto|false)`` - If true and the message is encrypted, try to decrypt the - message while indexing. 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 + 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 - ``--try-decrypt=true`` without considering the security of - your index. + ``--decrypt=true`` or ``--decrypt=nostash`` without + considering the security of your index. - See also ``index.try_decrypt`` in **notmuch-config(1)**. + See also ``index.decrypt`` in **notmuch-config(1)**. EXIT STATUS ===========