unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob 3a73912b63e7857b70dfc5f2518e61163e2b7848 4174 bytes (raw)
name: vim/notmuch.txt 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
*notmuch.txt*	Plug-in to make vim a nice email client using notmuch

Author: Felipe Contreras <felipe.contreras@gmail.com>

Overview 					|notmuch-intro|
Usage						|notmuch-usage|
Mappings					|notmuch-mappings|
Configuration					|notmuch-config|

==============================================================================
OVERVIEW					*notmuch-intro*

This is a vim plug-in that provides a fully usable mail client interface,
utilizing the notmuch framework.

It has three main views: folders, search, and thread. In the folder view you
can find a summary of saved searches, In the search view you can see all the
threads that comprise the selected search, and in the thread view you can read
every mail in the thread.

==============================================================================
USAGE						*notmuch-usage*

To use it, simply run the `:NotMuch` command.

By default you start in the folder view which shows you default searches and
the number of threads that match those:
>
	10 new                  (tag:inbox and tag:unread)
	20 inbox                (tag:inbox)
	30 unread               (tag:unread)
<
You can see the threads of each by clicking `enter`, which sends you to the
search view. In both the search and folder views you can type `s` to type a
new search, or `=` to refresh. To see a thread, type `enter` again.

To exit a view, click `q`.

Also, you can specify a search directly:
>
	:NotMuch is:inbox and date:yesterday..
<
==============================================================================
MAPPINGS					*notmuch-mappings*

------------------------------------------------------------------------------
Folder view~

<enter>	Show selected search
s	Enter a new search
=	Refresh
c	Compose a new mail

------------------------------------------------------------------------------
Search view~

q	Quit view
<enter>	Show selected search
<space>	Show selected search with filter
A	Archive (-inbox -unread)
I	Mark as read (-unread)
t	Tag (prompted)
s	Search
=	Refresh
?	Show search information
c	Compose a new mail
>
------------------------------------------------------------------------------
Thread view~

q	Quit view
A	Archive (-inbox -unread)
I	Mark as read (-unread)
t	Tag (prompted)
s	Search
p	Save patches
r	Reply
?	Show thread information
<tab>	Show next message
c	Compose a new mail

------------------------------------------------------------------------------
Compose view~

q	Quit view
s	Send

==============================================================================
CONFIGURATION					*notmuch-config*

You can add the following configurations to your `.vimrc`, or
`~/.vim/plugin/notmuch.vim`.

						*g:notmuch_folders*

The first thing you might want to do is set your custom searches.

Adding an empty set of strings results in a blank line which allows you
to break up searches into groups.
>
	let g:notmuch_folders = [
		\ [ 'new', 'tag:inbox and tag:unread' ],
		\ [ 'inbox', 'tag:inbox' ],
		\ [ 'unread', 'tag:unread' ],
		\ [ '', '' ],
		\ [ 'to-do', 'tag:to-do' ],
		\ [ 'to-me', 'to:john.doe and tag:new' ],
		\ ]
<

						*g:notmuch_custom_search_maps*
						*g:notmuch_custom_show_maps*

You can also configure the keyboard mappings for the different views:
>
	let g:notmuch_custom_search_maps = {
		\ 't':		'search_tag("+to-do -inbox")',
		\ 'd':		'search_tag("+deleted -inbox -unread")',
		\ }

	let g:notmuch_custom_show_maps = {
		\ 't':		'show_tag("+to-do -inbox")',
		\ 'd':		'show_tag("+deleted -inbox -unread")',
		\ }
<

						*g:notmuch_date_format*

To configure the date format you want in the search view:
>
	let g:notmuch_date_format = '%d.%m.%y'
<

						*g:notmuch_datetime_format*

You can do the same for the thread view:
>
	let g:notmuch_datetime_format = '%d.%m.%y %H:%M:%S'
<

						*g:notmuch_folders_count_threads*

If you want to count the threads instead of the messages in the folder view:
>
	let g:notmuch_folders_count_threads = 0
<

						*g:notmuch_reader*
						*g:notmuch_sendmail*

You can also configure your externail mail reader and sendemail program:
>
	let g:notmuch_reader = 'mutt -f %s'
	let g:notmuch_sendmail = 'sendmail'
<

vim:tw=78:ts=8:noet:ft=help:

debug log:

solving 3a73912 ...
found 3a73912 in https://yhetil.org/notmuch/1412621414-31793-1-git-send-email-imain@stemwinder.org/
found 4374102 in https://yhetil.org/notmuch.git/
preparing index
index prepared:
100644 43741022e13580cafd7f1190a601608b14afcafe	vim/notmuch.txt

applying [1/1] https://yhetil.org/notmuch/1412621414-31793-1-git-send-email-imain@stemwinder.org/
diff --git a/vim/notmuch.txt b/vim/notmuch.txt
index 4374102..3a73912 100644

Checking patch vim/notmuch.txt...
Applied patch vim/notmuch.txt cleanly.

index at:
100644 3a73912b63e7857b70dfc5f2518e61163e2b7848	vim/notmuch.txt

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).