X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman7%2Fnotmuch-properties.rst;h=7f128b5c4f0f9c8a57e07b14bebee9f2f4cc261f;hb=ff4e81ac57dee5a62f35093c2966f931a7b7580c;hp=07d36a1a5993fefb0f815f7c82a44b8bef741f1a;hpb=040c3236afcf95bead0324a48c2e0b9cd7934993;p=notmuch diff --git a/doc/man7/notmuch-properties.rst b/doc/man7/notmuch-properties.rst index 07d36a1a..7f128b5c 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 ================== @@ -54,7 +56,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 @@ -71,15 +72,15 @@ of its normal activity. If notmuch never tried to decrypt an encrypted message during indexing (which is the default, see ``index.decrypt`` in - **notmuch-config(1)**), then this property will not be set on that + :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, if notmuch finds a ``session-key`` - property associated with the message, it will try that stashed - session key for decryption. + 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``. @@ -98,7 +99,7 @@ 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 + See ``index.decrypt`` in :any:`notmuch-config(1)` for more details about how to set notmuch's policy on when to store session keys. @@ -110,16 +111,40 @@ 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)`