forked from emacs-evil/evil-collection
/
evil-collection-mu4e.el
329 lines (291 loc) · 16.3 KB
/
evil-collection-mu4e.el
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
;;; evil-collection-mu4e.el --- Evil bindings for mu4e -*- lexical-binding: t -*-
;; Copyright (C) 2015-2018 Joris Engbers
;; Copyright (C) 2018 Pierre Neidhardt <ambrevar@gmail.com>
;; Author: Joris Engbers <info@jorisengbers.nl>
;; Maintainer: James Nguyen <james@jojojames.com>
;; Pierre Neidhardt <ambrevar@gmail.com>
;; URL: https://github.com/emacs-evil/evil-collection
;; Version: 0.0.9
;; Package-Requires: ((emacs "24.4") (evil "1.2.10"))
;; Keywords: evil, mu4e, tools
;; This file is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published
;; by the Free Software Foundation; either version 3, or (at your
;; option) any later version.
;;
;; This file is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; For a full copy of the GNU General Public License
;; see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Evil keybindings for mu4e that make sense for Evil users. The following
;; keybindings are defined:
;;
;; General commands:
;; | Commmand | evil-mu4e | Alternative |
;; |--------------------------+-----------+-------------|
;; | Jump to maildir | J | |
;; | Update | u | |
;; | Compose message | cc | C |
;; | Kill update mail process | x | |
;; Commands for header-mode and view-mode:
;; | Command | evil-mu4e | Alternative |
;; |---------------------------------+-----------+-------------|
;; | Next message | C-j | |
;; | Previous message | C-k | |
;; | Mark the current thread as read | T | |
;; | Compose message | cc | C |
;; | Compose edit** | ce | E |
;; | Compose forward** | cf | F |
;; | Compose reply | cr | R |
;; | Change sorting*** | o | O |
;; | Rerun search | gr | |
;; | Toggle include related | zr | |
;; | Toggle threading | zt | |
;; | Toggle hide cited | za | |
;; | Skip duplicates | zd | |
;; | Show log | gl | |
;; | Select other view | gv | |
;; | Save attachement(s) | p | P |
;; | Save url | yu | |
;; | Go to url | gx | |
;; | Fetch url | gX | |
;;
;; - * denotes only in header-mode
;; - ** denotes Alternative only in header-mode
;; - *** denotes Alternative only in view-mode
;;
;;; Code:
(require 'evil-collection)
(require 'mu4e nil t)
(declare-function mu4e~main-action-str "mu4e-main")
(declare-function mu4e~main-view-queue "mu4e-main")
(defvar smtpmail-send-queued-mail)
(defvar smtpmail-queue-dir)
(defconst evil-collection-mu4e-maps '(mu4e-main-mode-map
mu4e-headers-mode-map
mu4e-view-mode-map
mu4e-compose-mode-map))
(defun evil-collection-mu4e-set-state ()
"Set the appropriate initial state of all mu4e modes."
(dolist (mode '(mu4e-main-mode
mu4e-headers-mode
mu4e-view-mode
mu4e-org-mode))
(evil-set-initial-state mode 'normal))
(evil-set-initial-state 'mu4e-compose-mode 'insert))
;;; Define bindings
;; TODO: Inhibit insert-state functions as per Evil Collection.
(defvar evil-collection-mu4e-mode-map-bindings
`((mu4e-main-mode-map "J" mu4e~headers-jump-to-maildir)
(mu4e-main-mode-map "j" next-line)
(mu4e-main-mode-map "k" previous-line)
(mu4e-main-mode-map "u" mu4e-update-mail-and-index)
(mu4e-main-mode-map "gr" revert-buffer)
(mu4e-main-mode-map "b" mu4e-headers-search-bookmark)
(mu4e-main-mode-map "B" mu4e-headers-search-bookmark-edit)
(mu4e-main-mode-map "N" mu4e-news)
(mu4e-main-mode-map ";" mu4e-context-switch)
(mu4e-main-mode-map "H" mu4e-display-manual)
(mu4e-main-mode-map "C" mu4e-compose-new)
(mu4e-main-mode-map "cc" mu4e-compose-new)
(mu4e-main-mode-map "x" mu4e-kill-update-mail)
(mu4e-main-mode-map "A" mu4e-about)
(mu4e-main-mode-map "f" smtpmail-send-queued-mail)
(mu4e-main-mode-map "m" mu4e~main-toggle-mail-sending-mode)
(mu4e-main-mode-map "s" mu4e-headers-search)
(mu4e-main-mode-map "q" mu4e-quit)
(mu4e-headers-mode-map "q" mu4e~headers-quit-buffer)
(mu4e-headers-mode-map "J" mu4e~headers-jump-to-maildir)
(mu4e-headers-mode-map "C" mu4e-compose-new)
(mu4e-headers-mode-map "E" mu4e-compose-edit)
(mu4e-headers-mode-map "F" mu4e-compose-forward)
(mu4e-headers-mode-map "R" mu4e-compose-reply)
(mu4e-headers-mode-map "cc" mu4e-compose-new)
(mu4e-headers-mode-map "ce" mu4e-compose-edit)
(mu4e-headers-mode-map "cf" mu4e-compose-forward)
(mu4e-headers-mode-map "cr" mu4e-compose-reply)
(mu4e-headers-mode-map "o" mu4e-headers-change-sorting)
(mu4e-headers-mode-map "j" mu4e-headers-next)
(mu4e-headers-mode-map "k" mu4e-headers-prev)
(mu4e-headers-mode-map "gr" mu4e-headers-rerun-search)
(mu4e-headers-mode-map "b" mu4e-headers-search-bookmark)
(mu4e-headers-mode-map "B" mu4e-headers-search-bookmark-edit)
(mu4e-headers-mode-map ";" mu4e-context-switch)
(mu4e-headers-mode-map ,(kbd "RET") mu4e-headers-view-message)
(mu4e-headers-mode-map "/" mu4e-headers-search-narrow)
(mu4e-headers-mode-map "s" mu4e-headers-search)
(mu4e-headers-mode-map "S" mu4e-headers-search-edit)
(mu4e-headers-mode-map "x" mu4e-mark-execute-all)
(mu4e-headers-mode-map "a" mu4e-headers-action)
(mu4e-headers-mode-map "*" mu4e-headers-mark-for-something) ; TODO: Don't override evil-seach-word-forward?
(mu4e-headers-mode-map "&" mu4e-headers-mark-custom)
(mu4e-headers-mode-map "A" mu4e-headers-mark-for-action)
(mu4e-headers-mode-map "m" mu4e-headers-mark-for-move)
(mu4e-headers-mode-map "r" mu4e-headers-mark-for-refile)
(mu4e-headers-mode-map "D" mu4e-headers-mark-for-delete)
(mu4e-headers-mode-map "d" mu4e-headers-mark-for-trash)
(mu4e-headers-mode-map "=" mu4e-headers-mark-for-untrash)
(mu4e-headers-mode-map "u" mu4e-headers-mark-for-unmark)
(mu4e-headers-mode-map "U" mu4e-mark-unmark-all)
(mu4e-headers-mode-map "?" mu4e-headers-mark-for-unread)
(mu4e-headers-mode-map "!" mu4e-headers-mark-for-read)
(mu4e-headers-mode-map "%" mu4e-headers-mark-pattern)
(mu4e-headers-mode-map "+" mu4e-headers-mark-for-flag)
(mu4e-headers-mode-map "-" mu4e-headers-mark-for-unflag)
(mu4e-headers-mode-map "[" mu4e-headers-prev-unread)
(mu4e-headers-mode-map "]" mu4e-headers-next-unread)
(mu4e-headers-mode-map "gk" mu4e-headers-prev-unread)
(mu4e-headers-mode-map "gj" mu4e-headers-next-unread)
(mu4e-headers-mode-map "\C-j" mu4e-headers-next)
(mu4e-headers-mode-map "\C-k" mu4e-headers-prev)
(mu4e-headers-mode-map "zr" mu4e-headers-toggle-include-related)
(mu4e-headers-mode-map "zt" mu4e-headers-toggle-threading)
(mu4e-headers-mode-map "zd" mu4e-headers-toggle-skip-duplicates)
(mu4e-headers-mode-map "gl" mu4e-show-log)
(mu4e-headers-mode-map "gv" mu4e-select-other-view)
(mu4e-headers-mode-map "T" (lambda ()
(interactive)
(mu4e-headers-mark-thread nil '(read))))
;; (,evil-collection-mu4e-state mu4e-compose-mode-map "gg" mu4e-compose-goto-top) ; TODO: Make this work.
(mu4e-view-mode-map ,(kbd "SPC") mu4e-view-scroll-up-or-next)
(mu4e-view-mode-map ,(kbd "<tab>") shr-next-link)
(mu4e-view-mode-map ,(kbd "<backtab>") shr-previous-link)
(mu4e-view-mode-map "q" mu4e~view-quit-buffer)
(mu4e-view-mode-map "gx" mu4e-view-go-to-url)
(mu4e-view-mode-map "gX" mu4e-view-fetch-url)
(mu4e-view-mode-map "C" mu4e-compose-new)
(mu4e-view-mode-map "H" mu4e-view-toggle-html)
;te mu4e-view-mode-map "E" mu4e-compose-edit)
;te mu4e-view-mode-map "F" mu4e-compose-forward)
(mu4e-view-mode-map "R" mu4e-compose-reply)
(mu4e-view-mode-map "cc" mu4e-compose-new)
(mu4e-view-mode-map "ce" mu4e-compose-edit)
(mu4e-view-mode-map "cf" mu4e-compose-forward)
(mu4e-view-mode-map "cr" mu4e-compose-reply)
(mu4e-view-mode-map "p" mu4e-view-save-attachment)
(mu4e-view-mode-map "P" mu4e-view-save-attachment-multi) ; Since mu4e 1.0, -multi is same as normal.
(mu4e-view-mode-map "O" mu4e-headers-change-sorting)
(mu4e-view-mode-map "o" mu4e-view-open-attachment)
(mu4e-view-mode-map "A" mu4e-view-attachment-action)
(mu4e-view-mode-map "a" mu4e-view-action)
(mu4e-view-mode-map "J" mu4e~headers-jump-to-maildir)
(mu4e-view-mode-map "[" mu4e-view-headers-prev-unread)
(mu4e-view-mode-map "]" mu4e-view-headers-next-unread)
(mu4e-view-mode-map "gk" mu4e-view-headers-prev-unread)
(mu4e-view-mode-map "gj" mu4e-view-headers-next-unread)
(mu4e-view-mode-map "\C-j" mu4e-view-headers-next)
(mu4e-view-mode-map "\C-k" mu4e-view-headers-prev)
(mu4e-view-mode-map "x" mu4e-view-marked-execute)
(mu4e-view-mode-map "&" mu4e-view-mark-custom)
(mu4e-view-mode-map "*" mu4e-view-mark-for-something) ; TODO: Don't override "*".
(mu4e-view-mode-map "m" mu4e-view-mark-for-move)
(mu4e-view-mode-map "r" mu4e-view-mark-for-refile)
(mu4e-view-mode-map "D" mu4e-view-mark-for-delete)
(mu4e-view-mode-map "d" mu4e-view-mark-for-trash)
(mu4e-view-mode-map "=" mu4e-view-mark-for-untrash)
(mu4e-view-mode-map "u" mu4e-view-unmark)
(mu4e-view-mode-map "U" mu4e-view-unmark-all)
(mu4e-view-mode-map "?" mu4e-view-mark-for-unread)
(mu4e-view-mode-map "!" mu4e-view-mark-for-read)
(mu4e-view-mode-map "%" mu4e-view-mark-pattern)
(mu4e-view-mode-map "+" mu4e-view-mark-for-flag)
(mu4e-view-mode-map "-" mu4e-view-mark-for-unflag)
(mu4e-view-mode-map "\C-u" evil-scroll-up)
(mu4e-view-mode-map "zr" mu4e-headers-toggle-include-related)
(mu4e-view-mode-map "zt" mu4e-headers-toggle-threading)
(mu4e-view-mode-map "za" mu4e-view-toggle-hide-cited)
(mu4e-view-mode-map "gl" mu4e-show-log)
(mu4e-view-mode-map "s" mu4e-view-search-edit)
(mu4e-view-mode-map "|" mu4e-view-pipe)
(mu4e-view-mode-map "." mu4e-view-raw-message)
(mu4e-view-mode-map ,(kbd "C--") mu4e-headers-split-view-shrink)
(mu4e-view-mode-map ,(kbd "C-+") mu4e-headers-split-view-grow)
(mu4e-view-mode-map "T" (lambda ()
(interactive)
(mu4e-headers-mark-thread nil '(read)))))
;; TODO: Add mu4e-headers-search-bookmark?
"All evil-mu4e bindings.")
(defun evil-collection-mu4e-set-bindings ()
"Set the bindings."
;; WARNING: With lexical binding, lambdas from `mapc' and `dolist' become
;; closures in which we must use `evil-define-key*' instead of
;; `evil-define-key'.
(dolist (binding evil-collection-mu4e-mode-map-bindings)
(evil-collection-define-key 'normal
(nth 0 binding) (nth 1 binding) (nth 2 binding)))
(evil-define-key 'operator mu4e-view-mode-map
"u" '(menu-item
""
nil
:filter (lambda (&optional _)
(when (memq evil-this-operator
'(evil-yank evil-cp-yank evil-sp-yank lispyville-yank))
(setq evil-inhibit-operator t)
#'mu4e-view-save-url)))))
;;; Update mu4e-main-view
;;; To avoid confusion the main-view is updated to show the keys that are in use
;;; for evil-mu4e.
(defvar evil-collection-mu4e-begin-region-basic "\n Basics"
"The place where to start overriding Basic section.")
(defvar evil-collection-mu4e-end-region-basic "a new message\n"
"The place where to end overriding Basic section.")
(defvar evil-collection-mu4e-new-region-basic
(concat (mu4e~main-action-str "\t* [J]ump to some maildir\n" 'mu4e-jump-to-maildir)
(mu4e~main-action-str "\t* enter a [s]earch query\n" 'mu4e-search)
(mu4e~main-action-str "\t* [C]ompose a new message\n" 'mu4e-compose-new))
"Define the evil-mu4e Basic region.")
(defvar evil-collection-mu4e-begin-region-misc "\n Misc"
"The place where to start overriding Misc section.")
(defvar evil-collection-mu4e-end-region-misc "q]uit"
"The place where to end overriding Misc section.")
(defvar evil-collection-mu4e-new-region-misc
(concat
(mu4e~main-action-str "\t* [;]Switch focus\n" 'mu4e-context-switch)
(mu4e~main-action-str "\t* [u]pdate email & database (Alternatively: gr)\n"
'mu4e-update-mail-and-index)
;; show the queue functions if `smtpmail-queue-dir' is defined
(if (file-directory-p smtpmail-queue-dir)
(mu4e~main-view-queue)
"")
"\n"
(mu4e~main-action-str "\t* [N]ews\n" 'mu4e-news)
(mu4e~main-action-str "\t* [A]bout mu4e\n" 'mu4e-about)
(mu4e~main-action-str "\t* [H]elp\n" 'mu4e-display-manual)
(mu4e~main-action-str "\t* [q]uit\n" 'mu4e-quit))
"Define the evil-mu4e Misc region.")
(defun evil-collection-mu4e-replace-region (new-region start end)
"Replace region between START and END with NEW-REGION.
START end END end are regular expressions."
;; move to start of region
(goto-char (point-min))
(re-search-forward start)
;; insert new headings
(insert "\n\n")
(insert new-region)
;; Delete text until end of region.
(let ((start-point (point))
(end-point (re-search-forward end)))
(delete-region start-point end-point)))
(defun evil-collection-mu4e-update-main-view ()
"Update 'Basic' and 'Misc' regions to reflect the new
keybindings."
(evil-collection-mu4e-replace-region evil-collection-mu4e-new-region-basic
evil-collection-mu4e-begin-region-basic
evil-collection-mu4e-end-region-basic)
(evil-collection-mu4e-replace-region evil-collection-mu4e-new-region-misc
evil-collection-mu4e-begin-region-misc
evil-collection-mu4e-end-region-misc))
;;; Initialize evil-collection-mu4e
(defun evil-collection-mu4e-setup ()
"Initialize evil-mu4e if necessary.
If mu4e-main-mode is in evil-state-motion-modes, initialization
is already done earlier."
(evil-collection-mu4e-set-state)
(evil-collection-mu4e-set-bindings)
(add-hook 'mu4e-main-mode-hook 'evil-collection-mu4e-update-main-view))
(provide 'evil-collection-mu4e)
;;; evil-collection-mu4e.el ends here