X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman7%2Fnotmuch-properties.rst;h=a7d91d674a89f92e37989e6bb1ca3846839360c2;hp=9e033e14c16d235919119db6af826bb4573db3a2;hb=4b1a8fd18364a6e1f1a6e987c64aae760505999e;hpb=a99058540823cd520cf2a5333e8ffe99799aa285 diff --git a/doc/man7/notmuch-properties.rst b/doc/man7/notmuch-properties.rst index 9e033e14..a7d91d67 100644 --- a/doc/man7/notmuch-properties.rst +++ b/doc/man7/notmuch-properties.rst @@ -54,7 +54,6 @@ The following properties are set by notmuch internally in the course of its normal activity. **index.decryption** - If a message contains encrypted content, and notmuch tries to decrypt that content during indexing, it will add the property ``index.decryption=success`` when the cleartext was successfully @@ -70,16 +69,19 @@ of its normal activity. properties will be set on the message as a whole. If notmuch never tried to decrypt an encrypted message during - indexing (which is the default, see ``index.try_decrypt`` in + indexing (which is the default, see ``index.decrypt`` in **notmuch-config(1)**), then this property will not be set on that message. **session-key** When **notmuch-show(1)** or **nomtuch-reply** encounters a message - with an encrypted part and ``--decrypt`` is set, if notmuch finds a - ``session-key`` property associated with the message, it will try - that stashed session key for decryption. + with an encrypted part, if notmuch finds a ``session-key`` + property associated with the message, it will try that stashed + 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 rendering of long encrypted threads. It also allows the user to @@ -95,6 +97,10 @@ of its normal activity. message. This includes attachments, cryptographic signatures, and other material that cannot be reconstructed from the index alone. + See ``index.decrypt`` in **notmuch-config(1)** for more + details about how to set notmuch's policy on when to store session + keys. + The session key should be in the ASCII text form produced by GnuPG. For OpenPGP, that consists of a decimal representation of the hash algorithm used (identified by number from RFC 4880, @@ -103,6 +109,30 @@ of its normal activity. example, an AES-128 key might be stashed in a notmuch property as: ``session-key=7:14B16AF65536C28AF209828DFE34C9E0``. +**index.repaired** + + Some messages arrive in forms that are confusing to view; they can + be mangled by mail transport agents, or the sending mail user + agent may structure them in a way that is confusing. If notmuch + knows how to both detect and repair such a problematic message, it + will do so during indexing. + + If it applies a message repair during indexing, it will use the + ``index.repaired`` property to note the type of repair(s) it + performed. + + ``index.repaired=skip-protected-headers-legacy-display`` indicates + that when indexing the cleartext of an encrypted message, notmuch + skipped over a "legacy-display" text/rfc822-headers part that it + found in that message, since it was able to index the built-in + protected headers directly. + + ``index.repaired=mixedup`` indicates the repair of a "Mixed Up" + encrypted PGP/MIME message, a mangling typically produced by + Microsoft's Exchange MTA. See + https://tools.ietf.org/html/draft-dkg-openpgp-pgpmime-message-mangling + for more information. + SEE ALSO ========