Disambiguate Debian notmuch package and notmuch for emacs package.
[notmuch-wiki] / 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
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 ### Automatic tags
31
32  - attachment
33  - signed
34  - encrypted
35
36 The above tags are assigned to messages that have an attachment, or are signed
37 or encrypted, when adding a message to the database through the lib function
38 call:
39
40  - `notmuch_database_add_message()`
41
42 The cli calls the above function in "notmuch new".
43
44 ## Tags special to cli
45
46 All of the tags recognized by the cli are configurable.
47
48 ### Default tags for new messages
49
50  - unread
51  - inbox
52
53 These are the tags assigned to new message by default. The tags can be changed
54 using the new.tags configuration option.
55
56 ### Default excluded tags
57
58  - deleted
59  - spam
60
61 These are the default tags used for excluding messages from search results. The
62 tags can be changed using the search.exclude_tags configuration option.
63
64 ## Tags special to Emacs UI
65
66 All of the tags recognized by the emacs ui are configurable.
67
68 ### Reading mail
69
70  - unread
71  - inbox
72
73 The elementary mail reading commands automatically remove the tag(s) specified
74 by `notmuch-show-mark-read-tags` ("unread" by default) when visiting a message,
75 and remove the tag(s) specified by `notmuch-archive-tags` ("inbox" by default)
76 when archiving a message.
77
78 ### Other
79
80  - replied
81  - flagged
82
83 The tag(s) specified by `notmuch-message-replied-tags` ("replied" by default)
84 are added to messages that are replied to, and "flagged" messages are
85 highlighted through `notmuch-search-line-faces` by default.
86