8 **notmuch** **count** **property:**\ <*key*>=<*value*>
10 **notmuch** **search** **property:**\ <*key*>=<*value*>
12 **notmuch** **show** **property:**\ <*key*>=<*value*>
14 **notmuch** **reindex** **property:**\ <*key*>=<*value*>
16 **notmuch** **tag** +<*tag*> **property:**\ <*key*>=<*value*>
19 **notmuch** **dump** **--include=properties**
21 **notmuch** **restore** **--include=properties**
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
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
36 Instead, message properties are expected to be set and used
37 programmatically, according to logic in notmuch itself, or in
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.
47 Any property with a key that starts with "index." will be removed (and
48 possibly re-set) upon reindexing (see **notmuch-reindex(1)**).
53 The following properties are set by notmuch internally in the course
54 of its normal activity.
58 If a message contains encrypted content, and notmuch tries to
59 decrypt that content during indexing, it will add the property
60 ``index.decryption=success`` when the cleartext was successfully
61 indexed. If notmuch attempts to decrypt any part of a message
62 during indexing and that decryption attempt fails, it will add the
63 property ``index.decryption=failure`` to the message.
65 Note that it's possible for a single message to have both
66 ``index.decryption=success`` and ``index.decryption=failure``.
67 Consider an encrypted e-mail message that contains another
68 encrypted e-mail message as an attachment -- if the outer message
69 can be decrypted, but the attached part cannot, then both
70 properties will be set on the message as a whole.
72 If notmuch never tried to decrypt an encrypted message during
73 indexing (which is the default, see ``index.try_decrypt`` in
74 **notmuch-config(1)**), then this property will not be set on that
79 When **notmuch-show(1)** or **nomtuch-reply** encounters a message
80 with an encrypted part and ``--decrypt`` is set, if notmuch finds a
81 ``session-key`` property associated with the message, it will try
82 that stashed session key for decryption.
84 Using a stashed session key with "notmuch show" will speed up
85 rendering of long encrypted threads. It also allows the user to
86 destroy the secret part of any expired encryption-capable subkey
87 while still being able to read any retained messages for which
88 they have stashed the session key. This enables truly deletable
89 e-mail, since (once the session key and asymmetric subkey are both
90 destroyed) there are no keys left that can be used to decrypt any
91 copy of the original message previously stored by an adversary.
93 However, access to the stashed session key for an encrypted message
94 permits full byte-for-byte reconstruction of the cleartext
95 message. This includes attachments, cryptographic signatures, and
96 other material that cannot be reconstructed from the index alone.
98 The session key should be in the ASCII text form produced by
99 GnuPG. For OpenPGP, that consists of a decimal representation of
100 the hash algorithm used (identified by number from RFC 4880,
101 e.g. 9 means AES-256) followed by a colon, followed by a
102 hexadecimal representation of the algorithm-specific key. For
103 example, an AES-128 key might be stashed in a notmuch property as:
104 ``session-key=7:14B16AF65536C28AF209828DFE34C9E0``.
110 **notmuch-config(1)**,
112 **notmuch-insert(1)**,
114 **notmuch-reindex(1)**,
115 **notmuch-reply(1)**,
116 **notmuch-restore(1)**,
118 ***notmuch-search-terms(7)**