test: regression tests for n_indexopts_{get,set}_decrypt_policy
[notmuch] / vim / notmuch.txt
1 *notmuch.txt*   Plug-in to make vim a nice email client using notmuch
2
3 Author: Felipe Contreras <felipe.contreras@gmail.com>
4
5 Overview                                        |notmuch-intro|
6 Usage                                           |notmuch-usage|
7 Mappings                                        |notmuch-mappings|
8 Configuration                                   |notmuch-config|
9
10 ==============================================================================
11 OVERVIEW                                        *notmuch-intro*
12
13 This is a vim plug-in that provides a fully usable mail client interface,
14 utilizing the notmuch framework.
15
16 It has three main views: folders, search, and thread. In the folder view you
17 can find a summary of saved searches, In the search view you can see all the
18 threads that comprise the selected search, and in the thread view you can read
19 every mail in the thread.
20
21 ==============================================================================
22 USAGE                                           *notmuch-usage*
23
24 To use it, simply run the `:NotMuch` command.
25
26 By default you start in the folder view which shows you default searches and
27 the number of threads that match those:
28 >
29         10 new                  (tag:inbox and tag:unread)
30         20 inbox                (tag:inbox)
31         30 unread               (tag:unread)
32 <
33 You can see the threads of each by clicking `enter`, which sends you to the
34 search view. In both the search and folder views you can type `s` to type a
35 new search, or `=` to refresh. To see a thread, type `enter` again.
36
37 To exit a view, click `q`.
38
39 Also, you can specify a search directly:
40 >
41         :NotMuch is:inbox and date:yesterday..
42 <
43 ==============================================================================
44 MAPPINGS                                        *notmuch-mappings*
45
46 ------------------------------------------------------------------------------
47 Folder view~
48
49 <enter> Show selected search
50 s       Enter a new search
51 =       Refresh
52 c       Compose a new mail
53
54 ------------------------------------------------------------------------------
55 Search view~
56
57 q       Quit view
58 <enter> Show selected search
59 <space> Show selected search with filter
60 A       Archive (-inbox -unread)
61 I       Mark as read (-unread)
62 t       Tag (prompted)
63 s       Search
64 =       Refresh
65 ?       Show search information
66 c       Compose a new mail
67 >
68 ------------------------------------------------------------------------------
69 Thread view~
70
71 q       Quit view
72 A       Archive (-inbox -unread)
73 I       Mark as read (-unread)
74 t       Tag (prompted)
75 s       Search
76 p       Save patches
77 r       Reply
78 ?       Show thread information
79 <tab>   Show next message
80 c       Compose a new mail
81
82 ------------------------------------------------------------------------------
83 Compose view~
84
85 q       Quit view
86 s       Send
87
88 ==============================================================================
89 CONFIGURATION                                   *notmuch-config*
90
91 You can add the following configurations to your `.vimrc`, or
92 `~/.vim/plugin/notmuch.vim`.
93
94                                                 *g:notmuch_folders*
95
96 The first thing you might want to do is set your custom searches.
97 >
98         let g:notmuch_folders = [
99                 \ [ 'new', 'tag:inbox and tag:unread' ],
100                 \ [ 'inbox', 'tag:inbox' ],
101                 \ [ 'unread', 'tag:unread' ],
102                 \ [ 'to-do', 'tag:to-do' ],
103                 \ [ 'to-me', 'to:john.doe and tag:new' ],
104                 \ ]
105 <
106
107                                                 *g:notmuch_custom_search_maps*
108                                                 *g:notmuch_custom_show_maps*
109
110 You can also configure the keyboard mappings for the different views:
111 >
112         let g:notmuch_custom_search_maps = {
113                 \ 't':          'search_tag("+to-do -inbox")',
114                 \ 'd':          'search_tag("+deleted -inbox -unread")',
115                 \ }
116
117         let g:notmuch_custom_show_maps = {
118                 \ 't':          'show_tag("+to-do -inbox")',
119                 \ 'd':          'show_tag("+deleted -inbox -unread")',
120                 \ }
121 <
122
123                                                 *g:notmuch_date_format*
124
125 To configure the date format you want in the search view:
126 >
127         let g:notmuch_date_format = '%d.%m.%y'
128 <
129
130                                                 *g:notmuch_datetime_format*
131
132 You can do the same for the thread view:
133 >
134         let g:notmuch_datetime_format = '%d.%m.%y %H:%M:%S'
135 <
136
137                                                 *g:notmuch_folders_count_threads*
138
139 If you want to count the threads instead of the messages in the folder view:
140 >
141         let g:notmuch_folders_count_threads = 0
142 <
143
144                                                 *g:notmuch_reader*
145                                                 *g:notmuch_sendmail*
146
147 You can also configure your externail mail reader and sendemail program:
148 >
149         let g:notmuch_reader = 'mutt -f %s'
150         let g:notmuch_sendmail = 'sendmail'
151 <
152
153 vim:tw=78:ts=8:noet:ft=help: