git.cworth.org Git - obsolete/notmuch-wiki/blob - special-tags.mdwn

   1 # Tags special to notmuch
   2
   3 This page describes the tags that the notmuch lib, cli, and emacs ui recognize
   4 and treat specially, and whether these tags can be configured.
   5
   6 ## Tags special to lib
   7
   8 None of the tags recognized by the lib are configurable.
   9
  10 ### Synchronization between tags and maildir flags
  11
  12  - draft
  13  - flagged
  14  - passed
  15  - replied
  16  - unread
  17  - deleted (*)
  18
  19 The above tags are recognized by the lib, and synchronized with the
  20 corresponding maildir flags through the following lib function calls:
  21
  22  - `notmuch_message_maildir_flags_to_tags()`
  23  - `notmuch_message_tags_to_maildir_flags()`
  24
  25 The cli calls the above functions if the maildir.synchronize_flags configuration
  26 option is enabled. Maildir flags are synchronized to tags in "notmuch new", and
  27 tags are synchronized to maildir flags in "notmuch tag" and "notmuch restore".
  28
  29 (*) The "deleted" tag is not synced to maildir T flag at the moment, but it may
  30 be in the future.
  31
  32 ### Automatic tags
  33
  34  - attachment
  35  - signed
  36  - encrypted
  37
  38 The above tags are assigned to messages that have an attachment, or are signed
  39 or encrypted, when adding a message to the database through the lib function
  40 call:
  41
  42  - `notmuch_database_add_message()`
  43
  44 The cli calls the above function in "notmuch new".
  45
  46 ## Tags special to cli
  47
  48 All of the tags recognized by the cli are configurable.
  49
  50 ### Default tags for new messages
  51
  52  - unread
  53  - inbox
  54  - new (*)
  55
  56 These are the tags assigned to new message by default. The tags can be changed
  57 using the new.tags configuration option.
  58
  59 (*) The "new" tag is by no means special or default, but it is documented here
  60 as the typically used intermediate tag to use between "notmuch tag" and a
  61 post-new tagging script. See [[Initial_Tagging]].
  62
  63 ### Default excluded tags
  64
  65  - deleted
  66  - spam
  67
  68 These are the default tags used for excluding messages from search results. The
  69 tags can be changed using the search.exclude_tags configuration option.
  70
  71 ## Tags special to Emacs UI
  72
  73 All of the tags recognized by the emacs ui are configurable.
  74
  75 ### Reading mail
  76
  77  - unread
  78  - inbox
  79
  80 The elementary mail reading commands automatically remove the tag(s) specified
  81 by `notmuch-show-mark-read-tags` ("unread" by default) when visiting a message,
  82 and remove the tag(s) specified by `notmuch-archive-tags` ("inbox" by default)
  83 when archiving a message.
  84
  85 ### Other
  86
  87  - replied
  88  - flagged
  89  - deleted (*)
  90
  91 The tag(s) specified by `notmuch-message-replied-tags` ("replied" by default)
  92 are added to messages that are replied to, and "flagged" messages are
  93 highlighted through `notmuch-search-line-faces` by default.
  94
  95 (*) There are patches to tag, untag, and hide "deleted" tagged messages, but
  96 they have not been merged at the time of writing this.