unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob f70ffb3ca3ae706b7f74393eb48b1f0d6375d93d 1593 bytes (raw)
name: doc/man7/notmuch-properties.rst 	 # note: path name is non-authoritative(*)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
==================
notmuch-properties
==================

SYNOPSIS
========

**notmuch** **count** **property:**\ <*key*>=<*value*>

**notmuch** **search** **property:**\ <*key*>=<*value*>

**notmuch** **show** **property:**\ <*key*>=<*value*>

**notmuch** **reindex** **property:**\ <*key*>=<*value*>

**notmuch** **tag** +<*tag*> **property:**\ <*key*>=<*value*>


**notmuch** **dump** **--include=properties**

**notmuch** **restore** **--include=properties**

DESCRIPTION
===========

Several notmuch commands can search for, modify, add or remove
properties associated with specific messages.  Properties are
key/value pairs, and a message can have more than one key/value pair
for the same key.

While users can select based on a specific property in their search
terms with the prefix **property:**, the notmuch command-line
interface does not provide mechanisms for modifying properties
directly to the user.

Instead, message properties are expected to be set and used
programmatically, according to logic in notmuch itself, or in
extensions to it.

Extensions to notmuch which make use of properties are encouraged to
report the specific properties used to the upstream notmuch project,
as a way of avoiding collisions in the property namespace.

CONVENTIONS
===========

Any property with a key that starts with "index." will be removed (and
possibly re-set) upon reindexing (see **notmuch-reindex(1)**).

SEE ALSO
========

**notmuch(1)**,
**notmuch-dump(1)**,
**notmuch-insert(1)**,
**notmuch-new(1)**,
**notmuch-reindex(1)**,
**notmuch-restore(1)**,
***notmuch-search-terms(7)**

debug log:

solving f70ffb3c ...
found f70ffb3c in https://yhetil.org/notmuch.git/

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).