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 SEE ALSO
  45 ========
  46
  47 **notmuch(1)**,
  48 **notmuch-dump(1)**,
  49 **notmuch-insert(1)**,
  50 **notmuch-new(1)**,
  51 **notmuch-reindex(1)**,
  52 **notmuch-restore(1)**,
  53 ***notmuch-search-terms(7)**