1 ;; notmuch-mua.el --- emacs style mail-user-agent
3 ;; Copyright © David Edmondson
5 ;; This file is part of Notmuch.
7 ;; Notmuch is free software: you can redistribute it and/or modify it
8 ;; under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
12 ;; Notmuch is distributed in the hope that it will be useful, but
13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 ;; General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with Notmuch. If not, see <http://www.gnu.org/licenses/>.
20 ;; Authors: David Edmondson <dme@dme.org>
24 (require 'format-spec)
26 (require 'notmuch-lib)
27 (require 'notmuch-address)
29 (eval-when-compile (require 'cl))
31 (declare-function notmuch-show-insert-bodypart "notmuch-show" (msg part depth &optional hide))
35 (defcustom notmuch-mua-send-hook '(notmuch-mua-message-send-hook)
36 "Hook run before sending messages."
39 :group 'notmuch-hooks)
41 (defcustom notmuch-mua-compose-in 'current-window
43 "Where to create the mail buffer used to compose a new message.
44 Possible values are `current-window' (default), `new-window' and
45 `new-frame'. If set to `current-window', the mail buffer will be
46 displayed in the current window, so the old buffer will be
47 restored when the mail buffer is killed. If set to `new-window'
48 or `new-frame', the mail buffer will be displayed in a new
49 window/frame that will be destroyed when the buffer is killed.
50 You may want to customize `message-kill-buffer-on-exit'
52 (when (< emacs-major-version 24)
53 " Due to a known bug in Emacs 23, you should not set
54 this to `new-window' if `message-kill-buffer-on-exit' is
55 disabled: this would result in an incorrect behavior."))
57 :type '(choice (const :tag "Compose in the current window" current-window)
58 (const :tag "Compose mail in a new window" new-window)
59 (const :tag "Compose mail in a new frame" new-frame)))
61 (defcustom notmuch-mua-user-agent-function 'notmuch-mua-user-agent-full
62 "Function used to generate a `User-Agent:' string. If this is
63 `nil' then no `User-Agent:' will be generated."
64 :type '(choice (const :tag "No user agent string" nil)
65 (const :tag "Full" notmuch-mua-user-agent-full)
66 (const :tag "Notmuch" notmuch-mua-user-agent-notmuch)
67 (const :tag "Emacs" notmuch-mua-user-agent-emacs)
68 (function :tag "Custom user agent function"
69 :value notmuch-mua-user-agent-full))
72 (defcustom notmuch-mua-hidden-headers '("^User-Agent:")
73 "Headers that are added to the `message-mode' hidden headers
75 :type '(repeat string)
78 (defgroup notmuch-reply nil
79 "Replying to messages in notmuch"
82 (defcustom notmuch-mua-cite-function 'message-cite-original
83 "*Function for citing an original message.
84 Predefined functions include `message-cite-original' and
85 `message-cite-original-without-signature'.
86 Note that these functions use `mail-citation-hook' if that is non-nil."
87 :type '(radio (function-item message-cite-original)
88 (function-item message-cite-original-without-signature)
89 (function-item sc-cite-original)
90 (function :tag "Other"))
91 :link '(custom-manual "(message)Insertion Variables")
92 :group 'notmuch-reply)
96 (defun notmuch-mua-get-switch-function ()
97 "Get a switch function according to `notmuch-mua-compose-in'."
98 (cond ((eq notmuch-mua-compose-in 'current-window)
100 ((eq notmuch-mua-compose-in 'new-window)
101 'switch-to-buffer-other-window)
102 ((eq notmuch-mua-compose-in 'new-frame)
103 'switch-to-buffer-other-frame)
104 (t (error "Invalid value for `notmuch-mua-compose-in'"))))
106 (defun notmuch-mua-maybe-set-window-dedicated ()
107 "Set the selected window as dedicated according to
108 `notmuch-mua-compose-in'."
109 (when (or (eq notmuch-mua-compose-in 'new-frame)
110 (eq notmuch-mua-compose-in 'new-window))
111 (set-window-dedicated-p (selected-window) t)))
113 (defun notmuch-mua-user-agent-full ()
114 "Generate a `User-Agent:' string suitable for notmuch."
115 (concat (notmuch-mua-user-agent-notmuch)
117 (notmuch-mua-user-agent-emacs)))
119 (defun notmuch-mua-user-agent-notmuch ()
120 "Generate a `User-Agent:' string suitable for notmuch."
121 (let ((notmuch-version (if (string= notmuch-emacs-version "unknown")
122 (notmuch-cli-version)
123 notmuch-emacs-version)))
124 (concat "Notmuch/" notmuch-version " (http://notmuchmail.org)")))
126 (defun notmuch-mua-user-agent-emacs ()
127 "Generate a `User-Agent:' string suitable for notmuch."
128 (concat "Emacs/" emacs-version " (" system-configuration ")"))
130 (defun notmuch-mua-add-more-hidden-headers ()
131 "Add some headers to the list that are hidden by default."
132 (mapc (lambda (header)
133 (when (not (member header message-hidden-headers))
134 (push header message-hidden-headers)))
135 notmuch-mua-hidden-headers))
137 (defun notmuch-mua-reply-crypto (parts)
138 "Add mml sign-encrypt flag if any part of original message is encrypted."
139 (loop for part in parts
140 if (notmuch-match-content-type (plist-get part :content-type) "multipart/encrypted")
141 do (mml-secure-message-sign-encrypt)
142 else if (notmuch-match-content-type (plist-get part :content-type) "multipart/*")
143 do (notmuch-mua-reply-crypto (plist-get part :content))))
145 (defun notmuch-mua-get-quotable-parts (parts)
146 (loop for part in parts
147 if (notmuch-match-content-type (plist-get part :content-type) "multipart/alternative")
148 collect (let* ((subparts (plist-get part :content))
149 (types (mapcar (lambda (part) (plist-get part :content-type)) subparts))
150 (chosen-type (car (notmuch-multipart/alternative-choose types))))
151 (loop for part in (reverse subparts)
152 if (notmuch-match-content-type (plist-get part :content-type) chosen-type)
154 else if (notmuch-match-content-type (plist-get part :content-type) "multipart/*")
155 append (notmuch-mua-get-quotable-parts (plist-get part :content))
156 else if (notmuch-match-content-type (plist-get part :content-type) "text/*")
159 (defun notmuch-mua-insert-quotable-part (message part)
160 ;; We don't want text properties leaking from the show renderer into
161 ;; the reply so we use a temp buffer. Also we don't want hooks, such
162 ;; as notmuch-wash-*, to be run on the quotable part so we set
163 ;; notmuch-show-insert-text/plain-hook to nil.
164 (insert (with-temp-buffer
165 (let ((notmuch-show-insert-text/plain-hook nil))
166 ;; Show the part but do not add buttons.
167 (notmuch-show-insert-bodypart message part 0 'no-buttons))
168 (buffer-substring-no-properties (point-min) (point-max)))))
170 ;; There is a bug in emacs 23's message.el that results in a newline
171 ;; not being inserted after the References header, so the next header
172 ;; is concatenated to the end of it. This function fixes the problem,
173 ;; while guarding against the possibility that some current or future
174 ;; version of emacs has the bug fixed.
175 (defun notmuch-mua-insert-references (original-func header references)
176 (funcall original-func header references)
177 (unless (bolp) (insert "\n")))
179 (defun notmuch-mua-reply (query-string &optional sender reply-all)
180 (let ((args '("reply" "--format=sexp" "--format-version=1"))
181 (process-crypto notmuch-show-process-crypto)
185 (setq args (append args '("--decrypt"))))
188 (setq args (append args '("--reply-to=all")))
189 (setq args (append args '("--reply-to=sender"))))
190 (setq args (append args (list query-string)))
192 ;; Get the reply object as SEXP, and parse it into an elisp object.
193 (setq reply (apply #'notmuch-call-notmuch-sexp args))
195 ;; Extract the original message to simplify the following code.
196 (setq original (plist-get reply :original))
198 ;; Extract the headers of both the reply and the original message.
199 (let* ((original-headers (plist-get original :headers))
200 (reply-headers (plist-get reply :reply-headers)))
202 ;; If sender is non-nil, set the From: header to its value.
204 (plist-put reply-headers :From sender))
206 ;; Overlay the composition window on that being used to read
207 ;; the original message.
208 ((same-window-regexps '("\\*mail .*")))
210 ;; We modify message-header-format-alist to get around a bug in message.el.
211 ;; See the comment above on notmuch-mua-insert-references.
212 (let ((message-header-format-alist
213 (loop for pair in message-header-format-alist
214 if (eq (car pair) 'References)
215 collect (cons 'References
217 'notmuch-mua-insert-references
221 (notmuch-mua-mail (plist-get reply-headers :To)
222 (plist-get reply-headers :Subject)
223 (notmuch-headers-plist-to-alist reply-headers)
224 nil (notmuch-mua-get-switch-function))))
226 ;; Insert the message body - but put it in front of the signature
227 ;; if one is present, and after any other content
228 ;; message*setup-hooks may have added to the message body already.
231 (narrow-to-region (point) (point-max))
232 (goto-char (point-max))
233 (if (re-search-backward message-signature-separator nil t)
234 (if message-signature-insert-empty-line
236 (goto-char (point-max))))
238 (let ((from (plist-get original-headers :From))
239 (date (plist-get original-headers :Date))
242 ;; notmuch-mua-cite-function constructs a citation line based
243 ;; on the From and Date headers of the original message, which
244 ;; are assumed to be in the buffer.
245 (insert "From: " from "\n")
246 (insert "Date: " date "\n\n")
248 ;; Get the parts of the original message that should be quoted; this includes
249 ;; all the text parts, except the non-preferred ones in a multipart/alternative.
250 (let ((quotable-parts (notmuch-mua-get-quotable-parts (plist-get original :body))))
251 (mapc (apply-partially 'notmuch-mua-insert-quotable-part original) quotable-parts))
255 ;; Quote the original message according to the user's configured style.
256 (funcall notmuch-mua-cite-function)))
258 ;; Crypto processing based crypto content of the original message
260 (notmuch-mua-reply-crypto (plist-get original :body))))
262 ;; Push mark right before signature, if any.
263 (message-goto-signature)
269 (set-buffer-modified-p nil))
271 (define-derived-mode notmuch-message-mode message-mode "Message[Notmuch]"
272 "Notmuch message composition mode. Mostly like `message-mode'"
273 (when notmuch-address-command
274 (notmuch-address-setup)))
276 (put 'notmuch-message-mode 'flyspell-mode-predicate 'mail-mode-flyspell-verify)
278 (define-key notmuch-message-mode-map (kbd "C-c C-c") #'notmuch-mua-send-and-exit)
279 (define-key notmuch-message-mode-map (kbd "C-c C-s") #'notmuch-mua-send)
281 (defun notmuch-mua-pop-to-buffer (name switch-function)
282 "Pop to buffer NAME, and warn if it already exists and is
283 modified. This function is notmuch addaptation of
284 `message-pop-to-buffer'."
285 (let ((buffer (get-buffer name)))
287 (buffer-name buffer))
288 (let ((window (get-buffer-window buffer 0)))
290 ;; Raise the frame already displaying the message buffer.
292 (gnus-select-frame-set-input-focus (window-frame window))
293 (select-window window))
294 (funcall switch-function buffer)
296 (when (and (buffer-modified-p)
299 "Message already being composed; erase? ")
301 (error "Message being composed")))
302 (funcall switch-function name)
305 (notmuch-message-mode)))
307 (defun notmuch-mua-mail (&optional to subject other-headers continue
308 switch-function yank-action send-actions
309 return-action &rest ignored)
310 "Invoke the notmuch mail composition window."
313 (when notmuch-mua-user-agent-function
314 (let ((user-agent (funcall notmuch-mua-user-agent-function)))
315 (when (not (string= "" user-agent))
316 (push (cons 'User-Agent user-agent) other-headers))))
318 (unless (assq 'From other-headers)
319 (push (cons 'From (concat
320 (notmuch-user-name) " <" (notmuch-user-primary-email) ">")) other-headers))
322 (notmuch-mua-pop-to-buffer (message-buffer-name "mail" to)
323 (or switch-function (notmuch-mua-get-switch-function)))
326 ;; The following is copied from `message-mail'
327 `((To . ,(or to "")) (Subject . ,(or subject "")))
328 ;; C-h f compose-mail says that headers should be specified as
329 ;; (string . value); however all the rest of message expects
330 ;; headers to be symbols, not strings (eg message-header-format-alist).
331 ;; http://lists.gnu.org/archive/html/emacs-devel/2011-01/msg00337.html
332 ;; We need to convert any string input, eg from rmail-start-mail.
333 (dolist (h other-headers other-headers)
334 (if (stringp (car h)) (setcar h (intern (capitalize (car h))))))))
335 (args (list yank-action send-actions)))
336 ;; message-setup-1 in Emacs 23 does not accept return-action
337 ;; argument. Pass it only if it is supplied by the caller. This
338 ;; will never be the case when we're called by `compose-mail' in
340 (when return-action (nconc args '(return-action)))
341 (apply 'message-setup-1 headers args))
342 (notmuch-fcc-header-setup)
343 (message-sort-headers)
344 (message-hide-headers)
345 (set-buffer-modified-p nil)
346 (notmuch-mua-maybe-set-window-dedicated)
350 (defcustom notmuch-identities nil
351 "Identities that can be used as the From: address when composing a new message.
353 If this variable is left unset, then a list will be constructed from the
354 name and addresses configured in the notmuch configuration file."
355 :type '(repeat string)
356 :group 'notmuch-send)
358 (defcustom notmuch-always-prompt-for-sender nil
359 "Always prompt for the From: address when composing or forwarding a message.
361 This is not taken into account when replying to a message, because in that case
362 the From: header is already filled in by notmuch."
364 :group 'notmuch-send)
366 (defvar notmuch-mua-sender-history nil)
368 ;; Workaround: Running `ido-completing-read' in emacs 23.1, 23.2 and 23.3
369 ;; without some explicit initialization fill freeze the operation.
370 ;; Hence, we advice `ido-completing-read' to ensure required initialization
372 (if (and (= emacs-major-version 23) (< emacs-minor-version 4))
373 (defadvice ido-completing-read (before notmuch-ido-mode-init activate)
374 (ido-init-completion-maps)
375 (add-hook 'minibuffer-setup-hook 'ido-minibuffer-setup)
376 (add-hook 'choose-completion-string-functions
377 'ido-choose-completion-string)
378 (ad-disable-advice 'ido-completing-read 'before 'notmuch-ido-mode-init)
379 (ad-activate 'ido-completing-read)))
381 (defun notmuch-mua-prompt-for-sender ()
382 "Prompt for a sender from the user's configured identities."
383 (if notmuch-identities
384 (ido-completing-read "Send mail from: " notmuch-identities
385 nil nil nil 'notmuch-mua-sender-history
386 (car notmuch-identities))
387 (let* ((name (notmuch-user-name))
388 (addrs (cons (notmuch-user-primary-email)
389 (notmuch-user-other-email)))
391 (ido-completing-read (concat "Sender address for " name ": ") addrs
392 nil nil nil 'notmuch-mua-sender-history
394 (concat name " <" address ">"))))
396 (put 'notmuch-mua-new-mail 'notmuch-prefix-doc "... and prompt for sender")
397 (defun notmuch-mua-new-mail (&optional prompt-for-sender)
400 If PROMPT-FOR-SENDER is non-nil, the user will be prompted for
401 the From: address first."
404 (when (or prompt-for-sender notmuch-always-prompt-for-sender)
405 (list (cons 'From (notmuch-mua-prompt-for-sender))))))
406 (notmuch-mua-mail nil nil other-headers nil (notmuch-mua-get-switch-function))))
408 (defun notmuch-mua-new-forward-message (&optional prompt-for-sender)
409 "Invoke the notmuch message forwarding window.
411 The current buffer must contain an RFC2822 message to forward.
413 If PROMPT-FOR-SENDER is non-nil, the user will be prompted for
414 the From: address first."
415 (let* ((cur (current-buffer))
416 (message-forward-decoded-p nil)
417 (subject (message-make-forward-subject))
419 (when (or prompt-for-sender notmuch-always-prompt-for-sender)
420 (list (cons 'From (notmuch-mua-prompt-for-sender))))))
421 (notmuch-mua-mail nil subject other-headers nil (notmuch-mua-get-switch-function))
422 (message-forward-make-body cur)
423 ;; `message-forward-make-body' shows the User-agent header. Hide
425 (message-hide-headers)
426 (set-buffer-modified-p nil)))
428 (defun notmuch-mua-new-reply (query-string &optional prompt-for-sender reply-all)
429 "Compose a reply to the message identified by QUERY-STRING.
431 If PROMPT-FOR-SENDER is non-nil, the user will be prompted for
432 the From: address first. If REPLY-ALL is non-nil, the message
433 will be addressed to all recipients of the source message."
435 ;; In current emacs (24.3) select-active-regions is set to t by
436 ;; default. The reply insertion code sets the region to the quoted
437 ;; message to make it easy to delete (kill-region or C-w). These two
438 ;; things combine to put the quoted message in the primary selection.
440 ;; This is not what the user wanted and is a privacy risk (accidental
441 ;; pasting of the quoted message). We can avoid some of the problems
442 ;; by let-binding select-active-regions to nil. This fixes if the
443 ;; primary selection was previously in a non-emacs window but not if
444 ;; it was in an emacs window. To avoid the problem in the latter case
445 ;; we deactivate mark.
448 (when prompt-for-sender
449 (notmuch-mua-prompt-for-sender)))
450 (select-active-regions nil))
451 (notmuch-mua-reply query-string sender reply-all)
454 (defun notmuch-mua-send-and-exit (&optional arg)
456 (let ((message-fcc-handler-function #'notmuch-fcc-handler))
457 (message-send-and-exit arg)))
459 (defun notmuch-mua-send (&optional arg)
461 (let ((message-fcc-handler-function #'notmuch-fcc-handler))
464 (defun notmuch-mua-kill-buffer ()
466 (message-kill-buffer))
468 (defun notmuch-mua-message-send-hook ()
469 "The default function used for `notmuch-mua-send-hook', this
470 simply runs the corresponding `message-mode' hook functions."
471 (run-hooks 'message-send-hook))
475 (define-mail-user-agent 'notmuch-user-agent
476 'notmuch-mua-mail 'notmuch-mua-send-and-exit
477 'notmuch-mua-kill-buffer 'notmuch-mua-send-hook)
479 ;; Add some more headers to the list that `message-mode' hides when
480 ;; composing a message.
481 (notmuch-mua-add-more-hidden-headers)
485 (provide 'notmuch-mua)