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

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