1 *notmuch.txt* Plug-in to make vim a nice email client using notmuch
3 Author: Felipe Contreras <felipe.contreras@gmail.com>
5 Overview |notmuch-intro|
7 Mappings |notmuch-mappings|
8 Configuration |notmuch-config|
10 ==============================================================================
11 OVERVIEW *notmuch-intro*
13 This is a vim plug-in that provides a fully usable mail client interface,
14 utilizing the notmuch framework.
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.
21 ==============================================================================
24 To use it, simply run the `:NotMuch` command.
26 By default you start in the folder view which shows you default searches and
27 the number of threads that match those:
29 10 new (tag:inbox and tag:unread)
31 30 unread (tag:unread)
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.
37 To exit a view, click `q`.
39 Also, you can specify a search directly:
41 :NotMuch is:inbox and date:yesterday..
43 ==============================================================================
44 MAPPINGS *notmuch-mappings*
46 ------------------------------------------------------------------------------
49 <enter> Show selected search
54 ------------------------------------------------------------------------------
58 <enter> Show selected search
59 <space> Show selected search with filter
60 A Archive (-inbox -unread)
61 I Mark as read (-unread)
65 ? Show search information
68 ------------------------------------------------------------------------------
72 A Archive (-inbox -unread)
73 I Mark as read (-unread)
78 ? Show thread information
79 <tab> Show next message
82 ------------------------------------------------------------------------------
88 ==============================================================================
89 CONFIGURATION *notmuch-config*
91 You can add the following configurations to your `.vimrc`, or
92 `~/.vim/plugin/notmuch.vim`.
96 The first thing you might want to do is set your custom searches.
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' ],
107 *g:notmuch_custom_search_maps*
108 *g:notmuch_custom_show_maps*
110 You can also configure the keyboard mappings for the different views:
112 let g:notmuch_custom_search_maps = {
113 \ 't': 'search_tag("+to-do -inbox")',
114 \ 'd': 'search_tag("+deleted -inbox -unread")',
117 let g:notmuch_custom_show_maps = {
118 \ 't': 'show_tag("+to-do -inbox")',
119 \ 'd': 'show_tag("+deleted -inbox -unread")',
123 *g:notmuch_date_format*
125 To configure the date format you want in the search view:
127 let g:notmuch_date_format = '%d.%m.%y'
130 *g:notmuch_datetime_format*
132 You can do the same for the thread view:
134 let g:notmuch_datetime_format = '%d.%m.%y %H:%M:%S'
137 *g:notmuch_folders_count_threads*
139 If you want to count the threads instead of the messages in the folder view:
141 let g:notmuch_folders_count_threads = 0
147 You can also configure your externail mail reader and sendemail program:
149 let g:notmuch_reader = 'mutt -f %s'
150 let g:notmuch_sendmail = 'sendmail'
153 vim:tw=78:ts=8:noet:ft=help: