]> git.cworth.org Git - notmuch-wiki/blobdiff - manpages/notmuch-properties-7.mdwn
News for release 0.38.3
[notmuch-wiki] / manpages / notmuch-properties-7.mdwn
index 0e94e5bedb095d8be6b81a9986780bf102963a46..8cfd7f6ab11f8f1dc310393cd8bd7356517492f4 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.
-
-          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.
-
-          However,  access to the stashed session key for an encrypted message
-          permits full byte-for-byte reconstruction of the cleartext  message.
-          This includes attachments, cryptographic signatures, and other mate‐
-          rial that cannot be reconstructed from the index alone.
-
-          See <b>index.decrypt</b> in <a href='../notmuch-config-1/'>notmuch-config</a>(1) for more details about how to
-          set notmuch&apos;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, e.g. 9 means
-          AES-256) followed by a colon, followed by a hexadecimal  representa‐
-          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>.
+              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
+              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 <b>--decrypt=false</b>.
+
+              Using a stashed session key with &quot;notmuch show&quot;  will  speed  up
+              rendering 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  de‐
+              crypt  any  copy of the original message previously stored by an
+              adversary.
+
+              However, access to the stashed session key for an encrypted mes‐
+              sage  permits full byte-for-byte reconstruction of the cleartext
+              message.  This includes attachments,  cryptographic  signatures,
+              and  other  material that cannot be reconstructed from the index
+              alone.
+
+              See <b>index.decrypt</b> in <a href='../notmuch-config-1/'>notmuch-config</a>(1) for  more  details  about
+              how to set notmuch&apos;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,
+              e.g. 9 means AES-256) followed by a colon, followed by  a  hexa‐
+              decimal representation of the algorithm-specific key.  For exam‐
+              ple, an AES-128 key might be stashed in a notmuch  property  as:
+              <b>session-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>index.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;
-          encrypted  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.
+              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>index.repaired</b> property to note the type of  repair(s)  it  per‐
+              formed.
+
+              <b>index.repaired=skip-protected-headers-legacy-display</b>   indicates
+              that when indexing the cleartext of an encrypted  message,  not‐
+              much  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  Mi‐
+              crosoft&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-2020, Carl Worth and many others
+       2009-2022, Carl Worth and many others
 </pre>
 
-<h2>0.31</h2>
+<h2>0.35</h2>