crypto: index encrypted parts when indexopts try_decrypt is set.
[notmuch] / 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
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.
64
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.
71
72     If notmuch never tried to decrypt an encrypted message during
73     indexing (which is the default), then this property will not be
74     set on that message.
75
76 SEE ALSO
77 ========
78
79 **notmuch(1)**,
80 **notmuch-dump(1)**,
81 **notmuch-insert(1)**,
82 **notmuch-new(1)**,
83 **notmuch-reindex(1)**,
84 **notmuch-restore(1)**,
85 ***notmuch-search-terms(7)**