]> git.cworth.org Git - notmuch-wiki/blobdiff - manpages/notmuch-properties-7.mdwn
manpages updates for release 0.33
[notmuch-wiki] / manpages / notmuch-properties-7.mdwn
index 8cb4c67c90edbee5d4afe5bdf36da5096e4c6dfa..44d455a4f4147e12d7a30b9d82401ce145c48baa 100644 (file)
        <b>index.decryption</b>
               If  a  message  contains encrypted content, and notmuch tries to
               decrypt that content during indexing, it will add  the  property
-              <b>index.decryption=success</b>  when  the  cleartext  was successfully
-              indexed.  If notmuch attempts to decrypt any part of  a  message
+              <b>index.decryption=success</b> when the cleartext was successfully in‐
+              dexed.  If notmuch attempts to decrypt any  part  of  a  message
               during  indexing  and that decryption attempt fails, it will add
               the property <b>index.decryption=failure</b> to the message.
 
-              Note that it&apos;s possible  for  a  single  message  to  have  both
-              <b>index.decryption=success</b> and <b>index.decryption=failure</b>.  Consider
+              Note that it&apos;s possible for a single message to  have  both  <b>in-</b>
+              <b>dex.decryption=success</b>  and  <b>index.decryption=failure</b>.  Consider
               an encrypted e-mail  message  that  contains  another  encrypted
               e-mail  message  as an attachment -- if the outer message can be
               decrypted, but the attached part cannot,  then  both  properties
               sage.
 
        <b>session-key</b>
-          When <a href='../notmuch-show-1/'>notmuch-show</a>(1) or <b>nomtuch-reply</b> encounters a message  with  an
-          encrypted  part,  if notmuch finds a <b>session-key</b> property associated
-          with the message, it will try that stashed session key  for  decryp
-          tion.
+          When <a href='../notmuch-show-1/'>notmuch-show</a>(1) or <a href='../notmuch-reply-1/'>notmuch-reply</a>(1) encounters a  message  with
+          an  encrypted  part, if notmuch finds a <b>session-key</b> property associ‐
+          ated with the message, it will try that stashed session key for  de
+          cryption.
 
           If  you  do  not  want to use any stashed session keys that might be
           present, you should pass those programs <b>--decrypt=false</b>.
 
           Using a stashed session key with &quot;notmuch show&quot; will speed  up  ren‐
-          dering  of  long  encrypted  threads.   It  also  allows the user to
-          destroy the secret part of  any  expired  encryption-capable  subkey
-          while  still being able to read any retained messages for which they
-          have stashed the session key.  This enables truly deletable  e-mail,
-          since   (once  the  session  key  and  asymmetric  subkey  are  both
-          destroyed) there are no keys left that can be used  to  decrypt  any
-          copy of the original message previously stored by an adversary.
+          dering  of  long  encrypted threads.  It also allows the user to de‐
+          stroy the secret part of any expired encryption-capable subkey while
+          still  being  able to read any retained messages for which they have
+          stashed the session key.  This enables truly deletable e-mail, since
+          (once  the  session  key  and  asymmetric subkey are both destroyed)
+          there are no keys left that can be used to decrypt any copy  of  the
+          original message previously stored by an adversary.
 
           However,  access to the stashed session key for an encrypted message
           permits full byte-for-byte reconstruction of the cleartext  message.
           tion  of  the  algorithm-specific  key.  For example, an AES-128 key
           might   be   stashed   in    a    notmuch    property    as:    <b>ses-</b>
           <b>sion-key=7:14B16AF65536C28AF209828DFE34C9E0</b>.
+
+       <b>index.repaired</b>
+          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 <b>in-</b>
+          <b>dex.repaired</b> property to note the type of repair(s) it performed.
+
+          <b>index.repaired=skip-protected-headers-legacy-display</b> indicates  that
+          when indexing the cleartext of an encrypted message, notmuch skipped
+          over a &quot;legacy-display&quot; text/rfc822-headers part that  it  found  in
+          that  message,  since  it  was  able to index the built-in protected
+          headers directly.
+
+          <b>index.repaired=mixedup</b> indicates the repair  of  a  &quot;Mixed  Up&quot;  en‐
+          crypted  PGP/MIME  message,  a mangling typically produced by Micro‐
+          soft&apos;s
+          <u>https://tools.ietf.org/html/draft-dkg-openpgp-pgpmime-message-mangling</u>
+          for more information.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
        <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>not‐</a>
-       <a href='../notmuch-new-1/'>much-new</a>(1), <a href='../notmuch-reindex-1/'>notmuch-reindex</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),  <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
-       <a href='../notmuch-show-1/'>notmuch-show</a>(1), <b>*notmuch-search-terms</b>(7)
+       <a href='../notmuch-new-1/'>much-new</a>(1),  <a href='../notmuch-reindex-1/'>notmuch-reindex</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
+       <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1)
 </pre>
 
 <h2>AUTHOR</h2>
 
 <h2>COPYRIGHT</h2>
 <pre>
-       2009-2018, Carl Worth and many others
+       2009-2021, Carl Worth and many others
 </pre>
 
-<h2>0.28</h2>
+<h2>0.33</h2>