X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman7%2Fnotmuch-properties.rst;h=ff79f4c2f2c9774b885600d64682267d314ea227;hb=HEAD;hp=9e033e14c16d235919119db6af826bb4573db3a2;hpb=a99058540823cd520cf2a5333e8ffe99799aa285;p=notmuch diff --git a/doc/man7/notmuch-properties.rst b/doc/man7/notmuch-properties.rst index 9e033e14..ff79f4c2 100644 --- a/doc/man7/notmuch-properties.rst +++ b/doc/man7/notmuch-properties.rst @@ -1,3 +1,5 @@ +.. _notmuch-properties(7): + ================== notmuch-properties ================== @@ -45,7 +47,7 @@ CONVENTIONS =========== Any property with a key that starts with "index." will be removed (and -possibly re-set) upon reindexing (see **notmuch-reindex(1)**). +possibly re-set) upon reindexing (see :any:`notmuch-reindex(1)`). MESSAGE PROPERTIES ================== @@ -53,8 +55,7 @@ MESSAGE PROPERTIES The following properties are set by notmuch internally in the course of its normal activity. -**index.decryption** - +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,17 +71,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 - **notmuch-config(1)**), then this property will not be set on that + indexing (which is the default, see ``index.decrypt`` in + :any:`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 + When :any:`notmuch-show(1)` or :any:`notmuch-reply(1)` encounters + a message 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 destroy the secret part of any expired encryption-capable subkey @@ -95,6 +98,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 :any:`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,16 +110,39 @@ 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 ======== -**notmuch(1)**, -**notmuch-config(1)**, -**notmuch-dump(1)**, -**notmuch-insert(1)**, -**notmuch-new(1)**, -**notmuch-reindex(1)**, -**notmuch-reply(1)**, -**notmuch-restore(1)**, -**notmuch-show(1)**, -***notmuch-search-terms(7)** +:any:`notmuch(1)`, +:any:`notmuch-config(1)`, +:any:`notmuch-dump(1)`, +:any:`notmuch-insert(1)`, +:any:`notmuch-new(1)`, +:any:`notmuch-reindex(1)`, +:any:`notmuch-reply(1)`, +:any:`notmuch-restore(1)`, +:any:`notmuch-search-terms(7)`, +:any:`notmuch-show(1)`