git.cworth.org Git - 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.
   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 in "notmuch new" if the
  26 maildir.synchronize_flags configuration option is enabled.
  27
  28 (*) The "deleted" tag is not synced to maildir T flag at the moment, but it may
  29 be in the future.
  30
  31 ### Automatic tags
  32
  33  - attachment
  34  - signed
  35  - encrypted
  36
  37 The above tags are assigned to messages that have an attachment, or are signed
  38 or encrypted, when adding a message to the database through the lib function
  39 call:
  40
  41  - `notmuch_database_add_message()`
  42
  43 The cli calls the above function in "notmuch new".
  44
  45 ## Tags special to cli
  46
  47 All of the tags recognized by the cli are configurable.
  48
  49 ### Default tags for new messages
  50
  51  - unread
  52  - inbox
  53  - new (*)
  54
  55 These are the tags assigned to new message by default. The tags can be changed
  56 using the new.tags configuration option.
  57
  58 (*) The "new" tag is by no means special or default, but it is documented here
  59 as the typically used intermediate tag to use between "notmuch tag" and a
  60 post-new tagging script. See [[Initial_Tagging]].
  61
  62 ### Default excluded tags
  63
  64  - deleted
  65  - spam
  66
  67 These are the default tags used for excluding messages from search results. The
  68 tags can be changed using the search.exclude_tags configuration option.
  69
  70 ## Tags special to Emacs UI
  71
  72 Most of the tags recognized by the emacs ui are not (easily) configurable.
  73
  74 ### Reading mail
  75
  76  - unread
  77  - inbox
  78
  79 The elementary mail reading commands automatically remove the "unread" tag when
  80 visiting a message, and remove the "inbox" tag when archiving a message.
  81
  82 ### Other
  83
  84  - replied
  85  - flagged
  86  - deleted (*)
  87
  88 The "replied" tag is added to messages that are replied to, and "flagged"
  89 messages are highlighted through `notmuch-search-line-faces` by default.
  90
  91 (*) There are patches to tag, untag, and hide "deleted" tagged messages, but
  92 they have not been merged at the time of writing this.