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 'notmuch-lib)
25 (require 'notmuch-address)
29 (defcustom notmuch-mua-send-hook '(notmuch-mua-message-send-hook)
30 "Hook run before sending messages."
34 (defcustom notmuch-mua-user-agent-function 'notmuch-mua-user-agent-full
35 "Function used to generate a `User-Agent:' string. If this is
36 `nil' then no `User-Agent:' will be generated."
38 :type '(choice (const :tag "No user agent string" nil)
39 (const :tag "Full" notmuch-mua-user-agent-full)
40 (const :tag "Notmuch" notmuch-mua-user-agent-notmuch)
41 (const :tag "Emacs" notmuch-mua-user-agent-emacs)
42 (function :tag "Custom user agent function"
43 :value notmuch-mua-user-agent-full)))
45 (defcustom notmuch-mua-hidden-headers '("^User-Agent:")
46 "Headers that are added to the `message-mode' hidden headers
49 :type '(repeat string))
53 (defun notmuch-mua-user-agent-full ()
54 "Generate a `User-Agent:' string suitable for notmuch."
55 (concat (notmuch-mua-user-agent-notmuch)
57 (notmuch-mua-user-agent-emacs)))
59 (defun notmuch-mua-user-agent-notmuch ()
60 "Generate a `User-Agent:' string suitable for notmuch."
61 (concat "Notmuch/" (notmuch-version) " (http://notmuchmail.org)"))
63 (defun notmuch-mua-user-agent-emacs ()
64 "Generate a `User-Agent:' string suitable for notmuch."
65 (concat "Emacs/" emacs-version " (" system-configuration ")"))
67 (defun notmuch-mua-add-more-hidden-headers ()
68 "Add some headers to the list that are hidden by default."
69 (mapc (lambda (header)
70 (when (not (member header message-hidden-headers))
71 (push header message-hidden-headers)))
72 notmuch-mua-hidden-headers))
74 (defun notmuch-mua-reply (query-string &optional sender)
78 (if notmuch-show-process-crypto
79 (setq args (append args '("--decrypt"))))
80 (setq args (append args (list query-string)))
81 ;; This make assumptions about the output of `notmuch reply', but
82 ;; really only that the headers come first followed by a blank
83 ;; line and then the body.
85 (apply 'call-process (append (list notmuch-command nil (list t t) nil) args))
86 (goto-char (point-min))
87 (if (re-search-forward "^$" nil t)
90 (narrow-to-region (point-min) (point))
91 (goto-char (point-min))
92 (setq headers (mail-header-extract)))))
94 (setq body (buffer-substring (point) (point-max))))
95 ;; If sender is non-nil, set the From: header to its value.
97 (mail-header-set 'from sender headers))
99 ;; Overlay the composition window on that being used to read
100 ;; the original message.
101 ((same-window-regexps '("\\*mail .*")))
102 (notmuch-mua-mail (mail-header 'to headers)
103 (mail-header 'subject headers)
104 (message-headers-to-generate headers t '(to subject))))
105 ;; insert the message body - but put it in front of the signature
107 (goto-char (point-max))
108 (if (re-search-backward message-signature-separator nil t)
110 (goto-char (point-max)))
112 (set-buffer-modified-p nil)
115 ;; Original message may contain (malicious) MML tags. We must
116 ;; properly quote them in the reply. Note that using `point-max'
117 ;; instead of `mark' here is wrong. The buffer may include user's
118 ;; signature which should not be MML-quoted.
119 (mml-quote-region (point) (point-max)))
121 (defun notmuch-mua-forward-message ()
124 (when notmuch-mua-user-agent-function
125 (let ((user-agent (funcall notmuch-mua-user-agent-function)))
126 (when (not (string= "" user-agent))
127 (message-add-header (format "User-Agent: %s" user-agent)))))
128 (message-sort-headers)
129 (message-hide-headers)
130 (set-buffer-modified-p nil)
134 (defun notmuch-mua-mail (&optional to subject other-headers &rest other-args)
135 "Invoke the notmuch mail composition window.
137 OTHER-ARGS are passed through to `message-mail'."
140 (when notmuch-mua-user-agent-function
141 (let ((user-agent (funcall notmuch-mua-user-agent-function)))
142 (when (not (string= "" user-agent))
143 (push (cons "User-Agent" user-agent) other-headers))))
145 (unless (mail-header 'from other-headers)
146 (push (cons "From" (concat
147 (notmuch-user-name) " <" (notmuch-user-primary-email) ">")) other-headers))
149 (apply #'message-mail to subject other-headers other-args)
150 (message-sort-headers)
151 (message-hide-headers)
152 (set-buffer-modified-p nil)
156 (defcustom notmuch-identities nil
157 "Identities that can be used as the From: address when composing a new message.
159 If this variable is left unset, then a list will be constructed from the
160 name and addresses configured in the notmuch configuration file."
162 :type '(repeat string))
164 (defcustom notmuch-always-prompt-for-sender nil
165 "Always prompt for the From: address when composing or forwarding a message.
167 This is not taken into account when replying to a message, because in that case
168 the From: header is already filled in by notmuch."
172 (defvar notmuch-mua-sender-history nil)
174 (defun notmuch-mua-prompt-for-sender ()
176 (let (name addresses one-name-only)
177 ;; If notmuch-identities is non-nil, check if there is a fixed user name.
178 (if notmuch-identities
179 (let ((components (mapcar 'mail-extract-address-components notmuch-identities)))
180 (setq name (caar components)
181 addresses (mapcar 'cadr components)
184 (mapcar (lambda (identity)
185 (string-equal name (car identity)))
187 ;; If notmuch-identities is nil, use values from the notmuch configuration file.
188 (setq name (notmuch-user-name)
189 addresses (cons (notmuch-user-primary-email) (notmuch-user-other-email))
191 ;; Now prompt the user, either for an email address only or for a full identity.
194 (ido-completing-read (concat "Sender address for " name ": ") addresses
195 nil nil nil 'notmuch-mua-sender-history (car addresses))))
196 (concat name " <" address ">"))
197 (ido-completing-read "Send mail From: " notmuch-identities
198 nil nil nil 'notmuch-mua-sender-history (car notmuch-identities)))))
200 (defun notmuch-mua-new-mail (&optional prompt-for-sender)
201 "Invoke the notmuch mail composition window.
203 If PROMPT-FOR-SENDER is non-nil, the user will be prompted for
204 the From: address first."
207 (when (or prompt-for-sender notmuch-always-prompt-for-sender)
208 (list (cons 'from (notmuch-mua-prompt-for-sender))))))
209 (notmuch-mua-mail nil nil other-headers)))
211 (defun notmuch-mua-new-forward-message (&optional prompt-for-sender)
212 "Invoke the notmuch message forwarding window.
214 If PROMPT-FOR-SENDER is non-nil, the user will be prompted for
215 the From: address first."
217 (if (or prompt-for-sender notmuch-always-prompt-for-sender)
218 (let* ((sender (notmuch-mua-prompt-for-sender))
219 (address-components (mail-extract-address-components sender))
220 (user-full-name (car address-components))
221 (user-mail-address (cadr address-components)))
222 (notmuch-mua-forward-message))
223 (notmuch-mua-forward-message)))
225 (defun notmuch-mua-new-reply (query-string &optional prompt-for-sender)
226 "Invoke the notmuch reply window."
229 (when prompt-for-sender
230 (notmuch-mua-prompt-for-sender))))
231 (notmuch-mua-reply query-string sender)))
233 (defun notmuch-mua-send-and-exit (&optional arg)
235 (message-send-and-exit arg))
237 (defun notmuch-mua-kill-buffer ()
239 (message-kill-buffer))
241 (defun notmuch-mua-message-send-hook ()
242 "The default function used for `notmuch-mua-send-hook', this
243 simply runs the corresponding `message-mode' hook functions."
244 (run-hooks 'message-send-hook))
248 (define-mail-user-agent 'notmuch-user-agent
249 'notmuch-mua-mail 'notmuch-mua-send-and-exit
250 'notmuch-mua-kill-buffer 'notmuch-mua-send-hook)
252 ;; Add some more headers to the list that `message-mode' hides when
253 ;; composing a message.
254 (notmuch-mua-add-more-hidden-headers)
258 (provide 'notmuch-mua)