]> git.notmuchmail.org Git - notmuch/blobdiff - emacs/notmuch-mua.el
emacs: postpone a message
[notmuch] / emacs / notmuch-mua.el
index 803459a7a7752a948cc42350c716068c07a93b44..b68cdf2625ffafc8956d4c415ce9bcf920a0359e 100644 (file)
@@ -1,4 +1,4 @@
-;; notmuch-mua.el --- emacs style mail-user-agent
+;;; notmuch-mua.el --- emacs style mail-user-agent
 ;;
 ;; Copyright © David Edmondson
 ;;
 ;; General Public License for more details.
 ;;
 ;; You should have received a copy of the GNU General Public License
-;; along with Notmuch.  If not, see <http://www.gnu.org/licenses/>.
+;; along with Notmuch.  If not, see <https://www.gnu.org/licenses/>.
 ;;
 ;; Authors: David Edmondson <dme@dme.org>
 
+;;; Code:
+
 (require 'message)
 (require 'mm-view)
 (require 'format-spec)
 
 (eval-when-compile (require 'cl))
 
-(declare-function notmuch-show-insert-bodypart "notmuch-show" (msg part depth &optional hide))
+(declare-function notmuch-show-insert-body "notmuch-show" (msg body depth))
+(declare-function notmuch-fcc-header-setup "notmuch-maildir-fcc" ())
+(declare-function notmuch-maildir-message-do-fcc "notmuch-maildir-fcc" ())
+(declare-function notmuch-draft-postpone "notmuch-draft" ())
+(declare-function notmuch-draft-save "notmuch-draft" ())
 
 ;;
 
@@ -50,7 +56,7 @@ window/frame that will be destroyed when the buffer is killed.
 You may want to customize `message-kill-buffer-on-exit'
 accordingly."
    (when (< emacs-major-version 24)
-           " Due to a known bug in Emacs 23, you should not set
+          " Due to a known bug in Emacs 23, you should not set
 this to `new-window' if `message-kill-buffer-on-exit' is
 disabled: this would result in an incorrect behavior."))
   :group 'notmuch-send
@@ -58,7 +64,7 @@ disabled: this would result in an incorrect behavior."))
                 (const :tag "Compose mail in a new window"  new-window)
                 (const :tag "Compose mail in a new frame"   new-frame)))
 
-(defcustom notmuch-mua-user-agent-function 'notmuch-mua-user-agent-full
+(defcustom notmuch-mua-user-agent-function nil
   "Function used to generate a `User-Agent:' string. If this is
 `nil' then no `User-Agent:' will be generated."
   :type '(choice (const :tag "No user agent string" nil)
@@ -69,7 +75,7 @@ disabled: this would result in an incorrect behavior."))
                           :value notmuch-mua-user-agent-full))
   :group 'notmuch-send)
 
-(defcustom notmuch-mua-hidden-headers '("^User-Agent:")
+(defcustom notmuch-mua-hidden-headers nil
   "Headers that are added to the `message-mode' hidden headers
 list."
   :type '(repeat string)
@@ -91,6 +97,23 @@ Note that these functions use `mail-citation-hook' if that is non-nil."
   :link '(custom-manual "(message)Insertion Variables")
   :group 'notmuch-reply)
 
+(defcustom notmuch-mua-reply-insert-header-p-function
+  'notmuch-show-reply-insert-header-p-never
+  "Function to decide which parts get a header when replying.
+
+This function specifies which parts of a mime message with
+mutiple parts get a header."
+  :type '(radio (const :tag "No part headers"
+                              notmuch-show-reply-insert-header-p-never)
+               (const :tag "All except multipart/* and hidden parts"
+                              notmuch-show-reply-insert-header-p-trimmed)
+               (const :tag "Only for included text parts"
+                              notmuch-show-reply-insert-header-p-minimal)
+               (const :tag "Exactly as in show view"
+                              notmuch-show-insert-header-p)
+               (function :tag "Other"))
+  :group 'notmuch-reply)
+
 ;;
 
 (defun notmuch-mua-get-switch-function ()
@@ -121,7 +144,7 @@ Note that these functions use `mail-citation-hook' if that is non-nil."
   (let ((notmuch-version (if (string= notmuch-emacs-version "unknown")
                             (notmuch-cli-version)
                           notmuch-emacs-version)))
-    (concat "Notmuch/" notmuch-version " (http://notmuchmail.org)")))
+    (concat "Notmuch/" notmuch-version " (https://notmuchmail.org)")))
 
 (defun notmuch-mua-user-agent-emacs ()
   "Generate a `User-Agent:' string suitable for notmuch."
@@ -142,31 +165,6 @@ Note that these functions use `mail-citation-hook' if that is non-nil."
        else if (notmuch-match-content-type (plist-get part :content-type) "multipart/*")
          do (notmuch-mua-reply-crypto (plist-get part :content))))
 
-(defun notmuch-mua-get-quotable-parts (parts)
-  (loop for part in parts
-       if (notmuch-match-content-type (plist-get part :content-type) "multipart/alternative")
-         collect (let* ((subparts (plist-get part :content))
-                       (types (mapcar (lambda (part) (plist-get part :content-type)) subparts))
-                       (chosen-type (car (notmuch-multipart/alternative-choose types))))
-                  (loop for part in (reverse subparts)
-                        if (notmuch-match-content-type (plist-get part :content-type) chosen-type)
-                        return part))
-       else if (notmuch-match-content-type (plist-get part :content-type) "multipart/*")
-         append (notmuch-mua-get-quotable-parts (plist-get part :content))
-       else if (notmuch-match-content-type (plist-get part :content-type) "text/*")
-         collect part))
-
-(defun notmuch-mua-insert-quotable-part (message part)
-  ;; We don't want text properties leaking from the show renderer into
-  ;; the reply so we use a temp buffer. Also we don't want hooks, such
-  ;; as notmuch-wash-*, to be run on the quotable part so we set
-  ;; notmuch-show-insert-text/plain-hook to nil.
-  (insert (with-temp-buffer
-           (let ((notmuch-show-insert-text/plain-hook nil))
-             ;; Show the part but do not add buttons.
-             (notmuch-show-insert-bodypart message part 0 'no-buttons))
-           (buffer-substring-no-properties (point-min) (point-max)))))
-
 ;; There is a bug in emacs 23's message.el that results in a newline
 ;; not being inserted after the References header, so the next header
 ;; is concatenated to the end of it. This function fixes the problem,
@@ -245,10 +243,27 @@ Note that these functions use `mail-citation-hook' if that is non-nil."
        (insert "From: " from "\n")
        (insert "Date: " date "\n\n")
 
-       ;; Get the parts of the original message that should be quoted; this includes
-       ;; all the text parts, except the non-preferred ones in a multipart/alternative.
-       (let ((quotable-parts (notmuch-mua-get-quotable-parts (plist-get original :body))))
-         (mapc (apply-partially 'notmuch-mua-insert-quotable-part original) quotable-parts))
+       (insert (with-temp-buffer
+                 (let
+                     ;; Don't attempt to clean up messages, excerpt
+                     ;; citations, etc. in the original message before
+                     ;; quoting.
+                     ((notmuch-show-insert-text/plain-hook nil)
+                      ;; Don't omit long parts.
+                      (notmuch-show-max-text-part-size 0)
+                      ;; Insert headers for parts as appropriate for replying.
+                      (notmuch-show-insert-header-p-function notmuch-mua-reply-insert-header-p-function)
+                      ;; Ensure that any encrypted parts are
+                      ;; decrypted during the generation of the reply
+                      ;; text.
+                      (notmuch-show-process-crypto process-crypto)
+                      ;; Don't indent multipart sub-parts.
+                      (notmuch-show-indent-multipart nil))
+                   ;; We don't want sigstatus buttons (an information leak and usually wrong anyway).
+                   (letf (((symbol-function 'notmuch-crypto-insert-sigstatus-button) #'ignore)
+                          ((symbol-function 'notmuch-crypto-insert-encstatus-button) #'ignore))
+                         (notmuch-show-insert-body original (plist-get original :body) 0)
+                         (buffer-substring-no-properties (point-min) (point-max))))))
 
        (set-mark (point))
        (goto-char start)
@@ -269,16 +284,46 @@ Note that these functions use `mail-citation-hook' if that is non-nil."
   (set-buffer-modified-p nil))
 
 (define-derived-mode notmuch-message-mode message-mode "Message[Notmuch]"
-  "Notmuch message composition mode. Mostly like `message-mode'")
+  "Notmuch message composition mode. Mostly like `message-mode'"
+  (notmuch-address-setup))
+
+(put 'notmuch-message-mode 'flyspell-mode-predicate 'mail-mode-flyspell-verify)
 
 (define-key notmuch-message-mode-map (kbd "C-c C-c") #'notmuch-mua-send-and-exit)
 (define-key notmuch-message-mode-map (kbd "C-c C-s") #'notmuch-mua-send)
-
-
-(defun notmuch-mua-mail (&optional to subject other-headers &rest other-args)
-  "Invoke the notmuch mail composition window.
-
-OTHER-ARGS are passed through to `message-mail'."
+(define-key notmuch-message-mode-map (kbd "C-c C-p") #'notmuch-draft-postpone)
+(define-key notmuch-message-mode-map (kbd "C-x C-s") #'notmuch-draft-save)
+
+(defun notmuch-mua-pop-to-buffer (name switch-function)
+  "Pop to buffer NAME, and warn if it already exists and is
+modified. This function is notmuch addaptation of
+`message-pop-to-buffer'."
+  (let ((buffer (get-buffer name)))
+    (if (and buffer
+            (buffer-name buffer))
+       (let ((window (get-buffer-window buffer 0)))
+         (if window
+             ;; Raise the frame already displaying the message buffer.
+             (progn
+               (gnus-select-frame-set-input-focus (window-frame window))
+               (select-window window))
+           (funcall switch-function buffer)
+           (set-buffer buffer))
+         (when (and (buffer-modified-p)
+                    (not (prog1
+                             (y-or-n-p
+                              "Message already being composed; erase? ")
+                           (message nil))))
+           (error "Message being composed")))
+      (funcall switch-function name)
+      (set-buffer name))
+    (erase-buffer)
+    (notmuch-message-mode)))
+
+(defun notmuch-mua-mail (&optional to subject other-headers continue
+                                  switch-function yank-action send-actions
+                                  return-action &rest ignored)
+  "Invoke the notmuch mail composition window."
   (interactive)
 
   (when notmuch-mua-user-agent-function
@@ -287,11 +332,32 @@ OTHER-ARGS are passed through to `message-mail'."
        (push (cons 'User-Agent user-agent) other-headers))))
 
   (unless (assq 'From other-headers)
-    (push (cons 'From (concat
-                      (notmuch-user-name) " <" (notmuch-user-primary-email) ">")) other-headers))
-
-  (apply #'message-mail to subject other-headers other-args)
-  (notmuch-message-mode)
+    (push (cons 'From (message-make-from
+                      (notmuch-user-name) (notmuch-user-primary-email))) other-headers))
+
+  (notmuch-mua-pop-to-buffer (message-buffer-name "mail" to)
+                            (or switch-function (notmuch-mua-get-switch-function)))
+  (let ((headers
+        (append
+         ;; The following is copied from `message-mail'
+         `((To . ,(or to "")) (Subject . ,(or subject "")))
+         ;; C-h f compose-mail says that headers should be specified as
+         ;; (string . value); however all the rest of message expects
+         ;; headers to be symbols, not strings (eg message-header-format-alist).
+         ;; https://lists.gnu.org/archive/html/emacs-devel/2011-01/msg00337.html
+         ;; We need to convert any string input, eg from rmail-start-mail.
+         (dolist (h other-headers other-headers)
+           (if (stringp (car h)) (setcar h (intern (capitalize (car h))))))))
+       (args (list yank-action send-actions))
+       ;; Cause `message-setup-1' to do things relevant for mail,
+       ;; such as observe `message-default-mail-headers'.
+       (message-this-is-mail t))
+    ;; message-setup-1 in Emacs 23 does not accept return-action
+    ;; argument. Pass it only if it is supplied by the caller. This
+    ;; will never be the case when we're called by `compose-mail' in
+    ;; Emacs 23.
+    (when return-action (nconc args '(return-action)))
+    (apply 'message-setup-1 headers args))
   (notmuch-fcc-header-setup)
   (message-sort-headers)
   (message-hide-headers)
@@ -344,7 +410,7 @@ the From: header is already filled in by notmuch."
            (ido-completing-read (concat "Sender address for " name ": ") addrs
                                 nil nil nil 'notmuch-mua-sender-history
                                 (car addrs))))
-      (concat name " <" address ">"))))
+      (message-make-from name address))))
 
 (put 'notmuch-mua-new-mail 'notmuch-prefix-doc "... and prompt for sender")
 (defun notmuch-mua-new-mail (&optional prompt-for-sender)
@@ -358,25 +424,53 @@ the From: address first."
           (list (cons 'From (notmuch-mua-prompt-for-sender))))))
     (notmuch-mua-mail nil nil other-headers nil (notmuch-mua-get-switch-function))))
 
-(defun notmuch-mua-new-forward-message (&optional prompt-for-sender)
-  "Invoke the notmuch message forwarding window.
-
-The current buffer must contain an RFC2822 message to forward.
+(defun notmuch-mua-new-forward-messages (messages &optional prompt-for-sender)
+  "Compose a new message forwarding MESSAGES.
 
-If PROMPT-FOR-SENDER is non-nil, the user will be prompted for
-the From: address first."
-  (let* ((cur (current-buffer))
-        (message-forward-decoded-p nil)
-        (subject (message-make-forward-subject))
-        (other-headers
+If PROMPT-FOR-SENDER is non-nil, the user will be prompteed for
+the From: address."
+  (let* ((other-headers
          (when (or prompt-for-sender notmuch-always-prompt-for-sender)
-           (list (cons 'From (notmuch-mua-prompt-for-sender))))))
-    (notmuch-mua-mail nil subject other-headers nil (notmuch-mua-get-switch-function))
-    (message-forward-make-body cur)
-    ;; `message-forward-make-body' shows the User-agent header.  Hide
-    ;; it again.
-    (message-hide-headers)
-    (set-buffer-modified-p nil)))
+           (list (cons 'From (notmuch-mua-prompt-for-sender)))))
+        forward-subject) ;; Comes from the first message and is
+                         ;; applied later.
+
+    ;; Generate the template for the outgoing message.
+    (notmuch-mua-mail nil "" other-headers nil (notmuch-mua-get-switch-function))
+
+    (save-excursion
+      ;; Insert all of the forwarded messages.
+      (mapc (lambda (id)
+             (let ((temp-buffer (get-buffer-create
+                                 (concat "*notmuch-fwd-raw-" id "*"))))
+               ;; Get the raw version of this message in the buffer.
+               (with-current-buffer temp-buffer
+                 (erase-buffer)
+                 (let ((coding-system-for-read 'no-conversion))
+                   (call-process notmuch-command nil t nil "show" "--format=raw" id))
+                 ;; Because we process the messages in reverse order,
+                 ;; always generate a forwarded subject, then use the
+                 ;; last (i.e. first) one.
+                 (setq forward-subject (message-make-forward-subject)))
+               ;; Make a copy ready to be forwarded in the
+               ;; composition buffer.
+               (message-forward-make-body temp-buffer)
+               ;; Kill the temporary buffer.
+               (kill-buffer temp-buffer)))
+           ;; `message-forward-make-body' always puts the message at
+           ;; the top, so do them in reverse order.
+           (reverse messages))
+
+      ;; Add in the appropriate subject.
+      (save-restriction
+       (message-narrow-to-headers)
+       (message-remove-header "Subject")
+       (message-add-header (concat "Subject: " forward-subject)))
+
+      ;; `message-forward-make-body' shows the User-agent header.  Hide
+      ;; it again.
+      (message-hide-headers)
+      (set-buffer-modified-p nil))))
 
 (defun notmuch-mua-new-reply (query-string &optional prompt-for-sender reply-all)
   "Compose a reply to the message identified by QUERY-STRING.
@@ -404,15 +498,64 @@ will be addressed to all recipients of the source message."
     (notmuch-mua-reply query-string sender reply-all)
     (deactivate-mark)))
 
+(defun notmuch-mua-check-no-misplaced-secure-tag ()
+  "Query user if there is a misplaced secure mml tag.
+
+Emacs message-send will (probably) ignore a secure mml tag unless
+it is at the start of the body. Returns t if there is no such
+tag, or the user confirms they mean it."
+  (save-excursion
+    (let ((body-start (progn (message-goto-body) (point))))
+      (goto-char (point-max))
+      (or
+       ;; We are always fine if there is no secure tag.
+       (not (search-backward "<#secure" nil 't))
+       ;; There is a secure tag, so it must be at the start of the
+       ;; body, with no secure tag earlier (i.e., in the headers).
+       (and (= (point) body-start)
+           (not (search-backward "<#secure" nil 't)))
+       ;; The user confirms they means it.
+       (yes-or-no-p "\
+There is a <#secure> tag not at the start of the body. It is
+likely that the message will be sent unsigned and unencrypted.
+Really send? ")))))
+
+(defun notmuch-mua-check-secure-tag-has-newline ()
+  "Query if the secure mml tag has a newline following it.
+
+Emacs message-send will (probably) ignore a correctly placed
+secure mml tag unless it is followed by a newline. Returns t if
+any secure tag is followed by a newline, or the user confirms
+they mean it."
+  (save-excursion
+    (message-goto-body)
+    (or
+     ;; There is no (correctly placed) secure tag.
+     (not (looking-at "<#secure"))
+     ;; The secure tag is followed by a newline.
+     (looking-at "<#secure[^\n>]*>\n")
+     ;; The user confirms they means it.
+     (yes-or-no-p "\
+The <#secure> tag at the start of the body is not followed by a
+newline. It is likely that the message will be sent unsigned and
+unencrypted.  Really send? "))))
+
+(defun notmuch-mua-send-common (arg &optional exit)
+  (interactive "P")
+  (when (and (notmuch-mua-check-no-misplaced-secure-tag)
+            (notmuch-mua-check-secure-tag-has-newline))
+    (letf (((symbol-function 'message-do-fcc) #'notmuch-maildir-message-do-fcc))
+         (if exit
+             (message-send-and-exit arg)
+           (message-send arg)))))
+
 (defun notmuch-mua-send-and-exit (&optional arg)
   (interactive "P")
-  (let ((message-fcc-handler-function #'notmuch-fcc-handler))
-    (message-send-and-exit arg)))
+  (notmuch-mua-send-common arg 't))
 
 (defun notmuch-mua-send (&optional arg)
   (interactive "P")
-  (let ((message-fcc-handler-function #'notmuch-fcc-handler))
-    (message-send arg)))
+  (notmuch-mua-send-common arg))
 
 (defun notmuch-mua-kill-buffer ()
   (interactive)
@@ -436,3 +579,5 @@ simply runs the corresponding `message-mode' hook functions."
 ;;
 
 (provide 'notmuch-mua)
+
+;;; notmuch-mua.el ends here