git.notmuchmail.org Git - notmuch/blob - doc/man7/notmuch-properties.rst

   1 ==================
   2 notmuch-properties
   3 ==================
   4
   5 SYNOPSIS
   6 ========
   7
   8 **notmuch** **count** **property:**\ <*key*>=<*value*>
   9
  10 **notmuch** **search** **property:**\ <*key*>=<*value*>
  11
  12 **notmuch** **show** **property:**\ <*key*>=<*value*>
  13
  14 **notmuch** **reindex** **property:**\ <*key*>=<*value*>
  15
  16 **notmuch** **tag** +<*tag*> **property:**\ <*key*>=<*value*>
  17
  18
  19 **notmuch** **dump** **--include=properties**
  20
  21 **notmuch** **restore** **--include=properties**
  22
  23 DESCRIPTION
  24 ===========
  25
  26 Several notmuch commands can search for, modify, add or remove
  27 properties associated with specific messages.  Properties are
  28 key/value pairs, and a message can have more than one key/value pair
  29 for the same key.
  30
  31 While users can select based on a specific property in their search
  32 terms with the prefix **property:**, the notmuch command-line
  33 interface does not provide mechanisms for modifying properties
  34 directly to the user.
  35
  36 Instead, message properties are expected to be set and used
  37 programmatically, according to logic in notmuch itself, or in
  38 extensions to it.
  39
  40 Extensions to notmuch which make use of properties are encouraged to
  41 report the specific properties used to the upstream notmuch project,
  42 as a way of avoiding collisions in the property namespace.
  43
  44 CONVENTIONS
  45 ===========
  46
  47 Any property with a key that starts with "index." will be removed (and
  48 possibly re-set) upon reindexing (see **notmuch-reindex(1)**).
  49
  50 MESSAGE PROPERTIES
  51 ==================
  52
  53 The following properties are set by notmuch internally in the course
  54 of its normal activity.
  55
  56 **index.decryption**
  57     If a message contains encrypted content, and notmuch tries to
  58     decrypt that content during indexing, it will add the property
  59     ``index.decryption=success`` when the cleartext was successfully
  60     indexed.  If notmuch attempts to decrypt any part of a message
  61     during indexing and that decryption attempt fails, it will add the
  62     property ``index.decryption=failure`` to the message.
  63
  64     Note that it's possible for a single message to have both
  65     ``index.decryption=success`` and ``index.decryption=failure``.
  66     Consider an encrypted e-mail message that contains another
  67     encrypted e-mail message as an attachment -- if the outer message
  68     can be decrypted, but the attached part cannot, then both
  69     properties will be set on the message as a whole.
  70
  71     If notmuch never tried to decrypt an encrypted message during
  72     indexing (which is the default, see ``index.decrypt`` in
  73     **notmuch-config(1)**), then this property will not be set on that
  74     message.
  75
  76 **session-key**
  77
  78     When **notmuch-show(1)** or **nomtuch-reply** encounters a message
  79     with an encrypted part, if notmuch finds a ``session-key``
  80     property associated with the message, it will try that stashed
  81     session key for decryption.
  82
  83     If you do not want to use any stashed session keys that might be
  84     present, you should pass those programs ``--decrypt=false``.
  85
  86     Using a stashed session key with "notmuch show" will speed up
  87     rendering of long encrypted threads.  It also allows the user to
  88     destroy the secret part of any expired encryption-capable subkey
  89     while still being able to read any retained messages for which
  90     they have stashed the session key.  This enables truly deletable
  91     e-mail, since (once the session key and asymmetric subkey are both
  92     destroyed) there are no keys left that can be used to decrypt any
  93     copy of the original message previously stored by an adversary.
  94
  95     However, access to the stashed session key for an encrypted message
  96     permits full byte-for-byte reconstruction of the cleartext
  97     message.  This includes attachments, cryptographic signatures, and
  98     other material that cannot be reconstructed from the index alone.
  99
 100     See ``index.decrypt`` in **notmuch-config(1)** for more
 101     details about how to set notmuch's policy on when to store session
 102     keys.
 103
 104     The session key should be in the ASCII text form produced by
 105     GnuPG.  For OpenPGP, that consists of a decimal representation of
 106     the hash algorithm used (identified by number from RFC 4880,
 107     e.g. 9 means AES-256) followed by a colon, followed by a
 108     hexadecimal representation of the algorithm-specific key.  For
 109     example, an AES-128 key might be stashed in a notmuch property as:
 110     ``session-key=7:14B16AF65536C28AF209828DFE34C9E0``.
 111
 112 SEE ALSO
 113 ========
 114
 115 **notmuch(1)**,
 116 **notmuch-config(1)**,
 117 **notmuch-dump(1)**,
 118 **notmuch-insert(1)**,
 119 **notmuch-new(1)**,
 120 **notmuch-reindex(1)**,
 121 **notmuch-reply(1)**,
 122 **notmuch-restore(1)**,
 123 **notmuch-show(1)**,
 124 ***notmuch-search-terms(7)**