cli/show, reply: document use of stashed session keys in notmuch-properties

The stashed session keys are stored internally as notmuch properties.
So a user or developer who is reading about those properties might
want to understand how they fit into the bigger picture.

Note here that decrypting with a stored session key no longer needs
-decrypt for "notmuch show" and "notmuch reply".
This commit is contained in:
Daniel Kahn Gillmor 2017-12-08 01:23:56 -05:00 committed by David Bremner
parent a1260896f6
commit f845fb2a51

View file

@ -77,9 +77,12 @@ of its normal activity.
**session-key** **session-key**
When **notmuch-show(1)** or **nomtuch-reply** encounters a message When **notmuch-show(1)** or **nomtuch-reply** encounters a message
with an encrypted part and ``--decrypt`` is set, if notmuch finds a with an encrypted part, if notmuch finds a ``session-key``
``session-key`` property associated with the message, it will try property associated with the message, it will try that stashed
that stashed session key for decryption. session key for decryption.
If you do not want to use any stashed session keys that might be
present, you should pass those programs ``--decrypt=false``.
Using a stashed session key with "notmuch show" will speed up Using a stashed session key with "notmuch show" will speed up
rendering of long encrypted threads. It also allows the user to rendering of long encrypted threads. It also allows the user to