mu/mu4e/mu4e-actions.el

;;; mu4e-actions.el -- part of mu4e, the mu mail user agent -*- lexical-binding: t -*-

;; Copyright (C) 2011-2019 Dirk-Jan C. Binnema

;; Author: Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
;; Maintainer: Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>

;; This file is not part of GNU Emacs.

;; GNU Emacs 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 of the License, or
;; (at your option) any later version.

;; GNU Emacs 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.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; Example actions for messages, attachments (see chapter 'Actions' in the
;; manual)

;;; Code:

(require 'cl-lib)
(require 'ido)

(require 'mu4e-utils)
(require 'mu4e-message)
(require 'mu4e-meta)

(declare-function mu4e~proc-extract     "mu4e-proc")
(declare-function mu4e-headers-search   "mu4e-headers")

(defvar mu4e-headers-include-related)
(defvar mu4e-headers-show-threads)
(defvar mu4e-view-show-addresses)
(defvar mu4e-view-date-format)


;;; UNNAMED

(defun mu4e-action-count-lines (msg)
  "Count the number of lines in the e-mail MSG.
Works for headers view and message-view."
  (message "Number of lines: %s"
           (shell-command-to-string
            (concat "wc -l < " (shell-quote-argument (mu4e-message-field msg :path))))))

;;; UNNAMED

(defvar mu4e-msg2pdf
  (let ((exec-path (cons (concat mu4e-builddir "/toys/msg2pdf/") exec-path)))
    (locate-file "msg2pdf" exec-path exec-suffixes))
  "Path to the msg2pdf toy.")

(defun mu4e-action-view-as-pdf (msg)
  "Convert MSG to pdf, then show it.
Works for the message view."
  (unless (file-executable-p mu4e-msg2pdf)
    (mu4e-error "Program msg2pdf not found; please set `mu4e-msg2pdf'"))
  (let* ((pdf
          (shell-command-to-string
           (concat mu4e-msg2pdf " "
                   (shell-quote-argument (mu4e-message-field msg :path))
                   " 2> /dev/null")))
         (pdf (and pdf (> (length pdf) 5)
                   (substring pdf 0 -1)))) ;; chop \n
    (unless (and pdf (file-exists-p pdf))
      (mu4e-warn "Failed to create PDF file"))
    (find-file pdf)))

;;; UNNAMED

(defun mu4e~action-header-to-html (msg field)
  "Convert the FIELD of MSG to an HTML string."
  (mapconcat
   (lambda(c)
     (let* ((name (when (car c)
                    (replace-regexp-in-string "[[:cntrl:]]" "" (car c))))
            (email (when (cdr c)
                     (replace-regexp-in-string "[[:cntrl:]]" "" (cdr c))))
            (addr (if mu4e-view-show-addresses
                      (if name (format "%s <%s>" name email) email)
                    (or name email))) ;; name may be nil
            ;; Escape HTML entities
            (addr (replace-regexp-in-string "&" "&amp;" addr))
            (addr (replace-regexp-in-string "<" "&lt;" addr))
            (addr (replace-regexp-in-string ">" "&gt;" addr)))
       addr))
   (mu4e-message-field msg field) ", "))

(defun mu4e~write-body-to-html (msg)
  "Write MSG's body (either html or text) to a temporary file;
return the filename."
  (let* ((html (mu4e-message-field msg :body-html))
         (txt (mu4e-message-field msg :body-txt))
         (tmpfile (mu4e-make-temp-file "html"))
         (attachments (cl-remove-if (lambda (part)
                                      (or (null (plist-get part :attachment))
                                          (null (plist-get part :cid))))
                                    (mu4e-message-field msg :parts))))
    (unless (or html txt)
      (mu4e-error "No body part for this message"))
    (with-temp-buffer
      (insert "<head><meta charset=\"UTF-8\"></head>\n")
      (insert (concat "<p><strong>From</strong>: "
                      (mu4e~action-header-to-html msg :from) "</br>"))
      (insert (concat "<strong>To</strong>: "
                      (mu4e~action-header-to-html msg :to) "</br>"))
      (insert (concat "<strong>Date</strong>: "
                      (format-time-string mu4e-view-date-format (mu4e-message-field msg :date)) "</br>"))
      (insert (concat "<strong>Subject</strong>: " (mu4e-message-field msg :subject) "</p>"))
      (insert (or html (concat "<pre>" txt "</pre>")))
      (write-file tmpfile)
      ;; rewrite attachment urls
      (mapc (lambda (attachment)
              (goto-char (point-min))
              (while (re-search-forward (format "src=\"cid:%s\""
                                                (plist-get attachment :cid)) nil t)
                (if (plist-get attachment :temp)
                    (replace-match (format "src=\"%s\""
                                           (plist-get attachment :temp)))
                  (replace-match (format "src=\"%s%s\"" temporary-file-directory
                                         (plist-get attachment :name)))
                  (let ((tmp-attachment-name
                         (format "%s%s" temporary-file-directory
                                 (plist-get attachment :name))))
                    (mu4e~proc-extract 'save (mu4e-message-field msg :docid)
                                       (plist-get attachment :index)
                                       mu4e-decryption-policy tmp-attachment-name)
                    (mu4e-remove-file-later tmp-attachment-name)))))
            attachments)
      (save-buffer)
      tmpfile)))

(defun mu4e-action-view-in-browser (msg)
  "View the body of MSG in a web browser.
You can influence the browser to use with the variable
`browse-url-generic-program', and see the discussion of privacy
aspects in `(mu4e) Displaying rich-text messages'."
  (browse-url (concat "file://"
                      (mu4e~write-body-to-html msg))))

(defun mu4e-action-view-with-xwidget (msg)
  "View the body of MSG inside xwidget-webkit.
This is only available in Emacs 25+; also see the discussion of
privacy aspects in `(mu4e) Displaying rich-text messages'."
  (unless (fboundp 'xwidget-webkit-browse-url)
    (mu4e-error "No xwidget support available"))
  (xwidget-webkit-browse-url
   (concat "file://" (mu4e~write-body-to-html msg)) t))

;;; UNNAMED

(defconst mu4e-text2speech-command "festival --tts"
  "Program that speaks out text it receives on standard input.")

(defun mu4e-action-message-to-speech (msg)
  "Pronounce MSG's body text using `mu4e-text2speech-command'."
  (unless (mu4e-message-field msg :body-txt)
    (mu4e-warn "No text body for this message"))
  (with-temp-buffer
    (insert (mu4e-message-field msg :body-txt))
    (shell-command-on-region (point-min) (point-max)
                             mu4e-text2speech-command)))

;;; UNNAMED

(defvar mu4e-captured-message nil
  "The most recently captured message.")

(defun mu4e-action-capture-message (msg)
  "Remember MSG.
Later, we can create an attachment based on this message with
`mu4e-compose-attach-captured-message'."
  (setq mu4e-captured-message msg)
  (message "Message has been captured"))

;;; UNNAMED

(defun mu4e-action-copy-message-file-path (msg)
  "Save the full path for the current MSG to the kill ring."
  (kill-new (mu4e-message-field msg :path)))

;;; UNNAMED

(defvar mu4e-org-contacts-file nil
  "File to store contact information for org-contacts.
Needed by `mu4e-action-add-org-contact'.")

(eval-when-compile ;; silence compiler warning about free variable
  (unless (require 'org-capture nil 'noerror)
    (defvar org-capture-templates nil)))

(defun mu4e-action-add-org-contact (msg)
  "Add an org-contact based on the sender ddress of the current MSG.
You need to set `mu4e-org-contacts-file' to the full path to the
file where you store your org-contacts."
  (unless (require 'org-capture nil 'noerror)
    (mu4e-error "Feature org-capture is not available"))
  (unless mu4e-org-contacts-file
    (mu4e-error "Variable `mu4e-org-contacts-file' is nil"))
  (let* ((sender (car-safe (mu4e-message-field msg :from)))
         (name (car-safe sender)) (email (cdr-safe sender))
         (blurb
          (format
           (concat
            "* %%?%s\n"
            ":PROPERTIES:\n"
            ":EMAIL: %s\n"
            ":NICK:\n"
            ":BIRTHDAY:\n"
            ":END:\n\n")
           (or name email "")
           (or email "")))
         (key "mu4e-add-org-contact-key")
         (org-capture-templates
          (append org-capture-templates
                  (list (list key "contacts" 'entry
                              (list 'file mu4e-org-contacts-file) blurb)))))
    (message "%S" org-capture-templates)
    (when (fboundp 'org-capture)
      (org-capture nil key))))

;;; UNNAMED

(defvar mu4e~patch-directory-history nil
  "History of directories we have applied patches to.")

;; This essentially works around the fact that read-directory-name
;; can't have custom history.
(defun mu4e~read-patch-directory (&optional prompt)
  "Read a `PROMPT'ed directory name via `completing-read' with history."
  (unless prompt
    (setq prompt "Target directory:"))
  (file-truename
   (completing-read prompt 'read-file-name-internal #'file-directory-p
                    nil nil 'mu4e~patch-directory-history)))

(defun mu4e-action-git-apply-patch (msg)
  "Apply `MSG' as a git patch."
  (let ((path (mu4e~read-patch-directory "Target directory: ")))
    (let ((default-directory path))
      (shell-command
       (format "git apply %s"
               (shell-quote-argument (mu4e-message-field msg :path)))))))

(defun mu4e-action-git-apply-mbox (msg &optional signoff)
  "Apply `MSG' a git patch with optional `SIGNOFF'.

If the `default-directory' matches the most recent history entry don't
bother asking for the git tree again (useful for bulk actions)."

  (let ((cwd (substring-no-properties
              (or (car mu4e~patch-directory-history)
                  "not-a-dir"))))
    (unless (and (stringp cwd) (string= default-directory cwd))
      (setq cwd (mu4e~read-patch-directory "Target directory: ")))
    (let ((default-directory cwd))
      (shell-command
       (format "git am %s %s"
               (if signoff "--signoff" "")
               (shell-quote-argument (mu4e-message-field msg :path)))))))

;;; UNNAMED

(defvar mu4e-action-tags-header "X-Keywords"
  "Header where tags are stored.
Used by `mu4e-action-retag-message'. Make sure it is one of the
headers mu recognizes for storing tags: X-Keywords, X-Label,
Keywords. Also note that changing this setting on already tagged
messages can lead to messages with multiple tags headers.")

(defvar mu4e-action-tags-completion-list '()
  "List of tags for completion in `mu4e-action-retag-message'.")

(defun mu4e~contains-line-matching (regexp path)
  "Return non-nil if the file at PATH contain a line matching REGEXP.
Otherwise return nil."
  (with-temp-buffer
    (insert-file-contents path)
    (save-excursion
      (goto-char (point-min))
      (re-search-forward regexp nil t))))

(defun mu4e~replace-first-line-matching (regexp to-string path)
  "Replace first line matching REGEXP in PATH with TO-STRING."
  (with-temp-file path
    (insert-file-contents path)
    (save-excursion
      (goto-char (point-min))
      (if (re-search-forward regexp nil t)
          (replace-match to-string nil nil)))))

(defun mu4e-action-retag-message (msg &optional retag-arg)
  "Change tags of MSG with RETAG-ARG.

RETAG-ARG is a comma-separated list of additions and removals.

Example: +tag,+long tag,-oldtag
would add 'tag' and 'long tag', and remove 'oldtag'."
  (let* (
         (path (mu4e-message-field msg :path))
         (oldtags (mu4e-message-field msg :tags))
         (tags-completion
          (append
           mu4e-action-tags-completion-list
           (mapcar (lambda (tag) (format "+%s" tag))
                   mu4e-action-tags-completion-list)
           (mapcar (lambda (tag) (format "-%s" tag))
                   oldtags)))
         (retag (if retag-arg
                    (split-string retag-arg ",")
                  (completing-read-multiple "Tags: " tags-completion)))
         (header  mu4e-action-tags-header)
         (sep     (cond ((string= header "Keywords") ", ")
                        ((string= header "X-Label") " ")
                        ((string= header "X-Keywords") ", ")
                        (t ", ")))
         (taglist (if oldtags (copy-sequence oldtags) '()))
         tagstr)
    (dolist (tag retag taglist)
      (cond
       ((string-match "^\\+\\(.+\\)" tag)
        (setq taglist (push (match-string 1 tag) taglist)))
       ((string-match "^\\-\\(.+\\)" tag)
        (setq taglist (delete (match-string 1 tag) taglist)))
       (t
        (setq taglist (push tag taglist)))))

    (setq taglist (sort (delete-dups taglist) 'string<))
    (setq tagstr (mapconcat 'identity taglist sep))

    (setq tagstr (replace-regexp-in-string "[\\&]" "\\\\\\&" tagstr))
    (setq tagstr (replace-regexp-in-string "[/]"   "\\&" tagstr))

    (if (not (mu4e~contains-line-matching (concat header ":.*") path))
        ;; Add tags header just before the content
        (mu4e~replace-first-line-matching
         "^$" (concat header ": " tagstr "\n") path)

      ;; replaces keywords, restricted to the header
      (mu4e~replace-first-line-matching
       (concat header ":.*")
       (concat header ": " tagstr)
       path))

    (mu4e-message (concat "tagging: " (mapconcat 'identity taglist ", ")))
    (mu4e-refresh-message path)))

(defun mu4e-action-show-thread (msg)
  "Show thread for message at point with point remaining on MSG.
I.e., point remains on the message with the message-id where the
action was invoked. If invoked in view mode, continue to display
the message."
  (let ((msgid (mu4e-message-field msg :message-id)))
    (when msgid
      (let ((mu4e-headers-show-threads t)
            (mu4e-headers-include-related t))
        (mu4e-headers-search
         (format "msgid:%s" msgid)
         nil nil nil
         msgid (and (eq major-mode 'mu4e-view-mode)
                    (not (eq mu4e-split-view 'single-window))))))))

;;; _
(provide 'mu4e-actions)
;;; mu4e-actions.el ends here
-												Add lexical-binding to all files and fix warnings

about free variables (declare) and unused lexical vars (prefix with "_").

											
										
										
											2019-09-16 19:54:59 +02:00
+								;;; mu4e-actions.el -- part of mu4e, the mu mail user agent -*- lexical-binding: t -*-
-												mu4e: Remove excess semicolons from library headers

Placing two semicolons on an otherwise empty line helps to logically
"connect" the surrounding "paragraphs", which in (only) some cases
makes sense.

Previously the three paragraphs of the permission statement were not
connected to each other like this, which is perfectly fine.  However
the preceding "This file is not part of GNU Emacs." line was connected
to the first paragraph, which does not make sense considering that the
latter is not connected two the second paragraph, which it relates to
more.

Once those two semicolons are gone, it also makes sense to remove
those from the second line.

											
										
										
											2020-02-11 12:23:40 +01:00
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								;; Copyright (C) 2011-2019 Dirk-Jan C. Binnema
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
 								;; Author: Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
 								;; Maintainer: Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
 								;; This file is not part of GNU Emacs.
-												mu4e: Remove excess semicolons from library headers

Placing two semicolons on an otherwise empty line helps to logically
"connect" the surrounding "paragraphs", which in (only) some cases
makes sense.

Previously the three paragraphs of the permission statement were not
connected to each other like this, which is perfectly fine.  However
the preceding "This file is not part of GNU Emacs." line was connected
to the first paragraph, which does not make sense considering that the
latter is not connected two the second paragraph, which it relates to
more.

Once those two semicolons are gone, it also makes sense to remove
those from the second line.

											
										
										
											2020-02-11 12:23:40 +01:00
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								;; GNU Emacs 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 of the License, or
 								;; (at your option) any later version.
 								;; GNU Emacs 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.
 								;; You should have received a copy of the GNU General Public License
 								;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 								;;; Commentary:
 								;; Example actions for messages, attachments (see chapter 'Actions' in the
 								;; manual)
 								;;; Code:
-												mu4e: Split libraries into outline sections

											
										
										
											2020-02-11 15:10:35 +01:00
-												mu4e: Replace cl with cl-lib

											
										
										
											2018-09-18 02:53:27 +02:00
+								(require 'cl-lib)
-												* mu4e: mu4e-actions: require 'ido'

											
										
										
											2013-10-08 05:52:29 +02:00
+								(require 'ido)
-												* mu4e: fix byte-compilation warnings

											
										
										
											2012-06-10 15:14:21 +02:00
-												mu4e: clean up creating html files

Clean up the creation of html files a bit, and automatically clean them
up after a short while, so we don't clutter /tmp.

Refactor the html-generating actions, so we don't repeat ourselves too
much.

											
										
										
											2016-02-20 10:21:24 +01:00
+								(require 'mu4e-utils)
-												* mu4e: mu4e-message part 3

											
										
										
											2012-09-26 16:28:30 +02:00
+								(require 'mu4e-message)
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								(require 'mu4e-meta)
-												mu4e-actions: fix some compiler warnings

											
										
										
											2019-05-25 09:37:59 +02:00
+								(declare-function mu4e~proc-extract     "mu4e-proc")
 								(declare-function mu4e-headers-search   "mu4e-headers")
-												* mu4e: mu4e-message part 3

											
										
										
											2012-09-26 16:28:30 +02:00
-												Add lexical-binding to all files and fix warnings

about free variables (declare) and unused lexical vars (prefix with "_").

											
										
										
											2019-09-16 19:54:59 +02:00
+								(defvar mu4e-headers-include-related)
 								(defvar mu4e-headers-show-threads)
 								(defvar mu4e-view-show-addresses)
 								(defvar mu4e-view-date-format)
-												* mu4e-actions.el: add some example actions for showing messages in a browers, text2speech

											
										
										
											2012-05-12 16:10:57 +02:00
-												mu4e: Split libraries into outline sections

											
										
										
											2020-02-11 15:10:35 +01:00
+								;;; UNNAMED
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								(defun mu4e-action-count-lines (msg)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Count the number of lines in the e-mail MSG.
-												improve doc-strings

The first sentence should summarize the variable's or function's
purpose and it should fit on the first line.  Change existing
doc-string by:

* Move first sentence onto first line even if that makes it _a bit_
  long.
* Move additional notes out of first sentence and add them later,
  possibly as complete sentences.
* If I am uncertain whether doing the above would alter the meaning,
  _don't_ do it.
* If fitting the initial sentence on the first line would require a
  complete rewrite of the doc-string _don't_ do so unless it is very
  easy to do.
* Remove indentation from second and later lines if it is there to
  align them with the first in the source code, instead of in
  `describe-*' output.
* Make "pullet point" lists a bit more consistent.

Obviously this does not fix all problems but it's a start.

											
										
										
											2012-11-10 14:01:17 +01:00
+								Works for headers view and message-view."
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								  (message "Number of lines: %s"
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								           (shell-command-to-string
 								            (concat "wc -l < " (shell-quote-argument (mu4e-message-field msg :path))))))
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
-												mu4e: Split libraries into outline sections

											
										
										
											2020-02-11 15:10:35 +01:00
+								;;; UNNAMED
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
-												mu4e: msg2pdf: don't require builddir for default

Try to find msg2pdf in addition to builddir, since it seems some people
/ distros are actually installing it.

											
										
										
											2017-01-30 20:05:04 +01:00
+								(defvar mu4e-msg2pdf
 								  (let ((exec-path (cons (concat mu4e-builddir "/toys/msg2pdf/") exec-path)))
 								    (locate-file "msg2pdf" exec-path exec-suffixes))
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								  "Path to the msg2pdf toy.")
 								(defun mu4e-action-view-as-pdf (msg)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Convert MSG to pdf, then show it.
-												improve doc-strings

The first sentence should summarize the variable's or function's
purpose and it should fit on the first line.  Change existing
doc-string by:

* Move first sentence onto first line even if that makes it _a bit_
  long.
* Move additional notes out of first sentence and add them later,
  possibly as complete sentences.
* If I am uncertain whether doing the above would alter the meaning,
  _don't_ do it.
* If fitting the initial sentence on the first line would require a
  complete rewrite of the doc-string _don't_ do so unless it is very
  easy to do.
* Remove indentation from second and later lines if it is there to
  align them with the first in the source code, instead of in
  `describe-*' output.
* Make "pullet point" lists a bit more consistent.

Obviously this does not fix all problems but it's a start.

											
										
										
											2012-11-10 14:01:17 +01:00
+								Works for the message view."
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								  (unless (file-executable-p mu4e-msg2pdf)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								    (mu4e-error "Program msg2pdf not found; please set `mu4e-msg2pdf'"))
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								  (let* ((pdf
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								          (shell-command-to-string
 								           (concat mu4e-msg2pdf " "
 								                   (shell-quote-argument (mu4e-message-field msg :path))
 								                   " 2> /dev/null")))
 								         (pdf (and pdf (> (length pdf) 5)
 								                   (substring pdf 0 -1)))) ;; chop \n
-												* make the msg2pdf action a bit more robust

											
										
										
											2012-04-29 16:32:34 +02:00
+								    (unless (and pdf (file-exists-p pdf))
-												* mu4e: mu4e-message part 3

											
										
										
											2012-09-26 16:28:30 +02:00
+								      (mu4e-warn "Failed to create PDF file"))
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								    (find-file pdf)))
-												mu4e: Split libraries into outline sections

											
										
										
											2020-02-11 15:10:35 +01:00
 								;;; UNNAMED
-												mu4e: cosmetic

Clear up some overly long lines.

											
										
										
											2017-01-03 16:45:03 +01:00
-												Do not repeat the "From" and "To" when converting to HTML

Before this commit the HTML was looking as

From: From: email
To: To: email

											
										
										
											2019-04-20 12:14:44 +02:00
+								(defun mu4e~action-header-to-html (msg field)
 								  "Convert the FIELD of MSG to an HTML string."
 								  (mapconcat
 								   (lambda(c)
 								     (let* ((name (when (car c)
 								                    (replace-regexp-in-string "[[:cntrl:]]" "" (car c))))
 								            (email (when (cdr c)
 								                     (replace-regexp-in-string "[[:cntrl:]]" "" (cdr c))))
-												Escape HTML entities

											
										
										
											2019-04-21 21:58:42 +02:00
+								            (addr (if mu4e-view-show-addresses
 								                      (if name (format "%s <%s>" name email) email)
-												mu4e: fix a remaining local variable 'short'

in the function 'mu4e~action-header-to-html'

											
										
										
											2019-04-30 18:53:12 +02:00
+								                    (or name email))) ;; name may be nil
-												Escape HTML entities

											
										
										
											2019-04-21 21:58:42 +02:00
+								            ;; Escape HTML entities
 								            (addr (replace-regexp-in-string "&" "&amp;" addr))
 								            (addr (replace-regexp-in-string "<" "&lt;" addr))
 								            (addr (replace-regexp-in-string ">" "&gt;" addr)))
 								       addr))
-												Do not repeat the "From" and "To" when converting to HTML

Before this commit the HTML was looking as

From: From: email
To: To: email

											
										
										
											2019-04-20 12:14:44 +02:00
+								   (mu4e-message-field msg field) ", "))
-												mu4e: clean up creating html files

Clean up the creation of html files a bit, and automatically clean them
up after a short while, so we don't clutter /tmp.

Refactor the html-generating actions, so we don't repeat ourselves too
much.

											
										
										
											2016-02-20 10:21:24 +01:00
+								(defun mu4e~write-body-to-html (msg)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Write MSG's body (either html or text) to a temporary file;
-												mu4e: clean up creating html files

Clean up the creation of html files a bit, and automatically clean them
up after a short while, so we don't clutter /tmp.

Refactor the html-generating actions, so we don't repeat ourselves too
much.

											
										
										
											2016-02-20 10:21:24 +01:00
+								return the filename."
-												* mu4e: mu4e-message part 3

											
										
										
											2012-09-26 16:28:30 +02:00
+								  (let* ((html (mu4e-message-field msg :body-html))
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								         (txt (mu4e-message-field msg :body-txt))
 								         (tmpfile (mu4e-make-temp-file "html"))
 								         (attachments (cl-remove-if (lambda (part)
 								                                      (or (null (plist-get part :attachment))
 								                                          (null (plist-get part :cid))))
 								                                    (mu4e-message-field msg :parts))))
-												* mu4e: improve mu4e-action-view-in-browser

											
										
										
											2012-08-30 11:54:26 +02:00
+								    (unless (or html txt)
 								      (mu4e-error "No body part for this message"))
 								    (with-temp-buffer
-												mu4e: explicitly specify utf8 for html-view actions

Explicitly add the (html 5) <meta charset ...> for UTF-8; not all
browsers default to UTF-8 and could show the class "Â" characters when
interpreting UTF-8 as ISO-8859-1.

											
										
										
											2016-01-31 11:48:12 +01:00
+								      (insert "<head><meta charset=\"UTF-8\"></head>\n")
-												mu4e-actions: fix mu4e~write-body-to-html

Use mu4e~view-construct-contacts-header instead of a non-existing
function.

											
										
										
											2019-04-15 06:19:44 +02:00
+								      (insert (concat "<p><strong>From</strong>: "
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								                      (mu4e~action-header-to-html msg :from) "</br>"))
-												mu4e-actions: fix mu4e~write-body-to-html

Use mu4e~view-construct-contacts-header instead of a non-existing
function.

											
										
										
											2019-04-15 06:19:44 +02:00
+								      (insert (concat "<strong>To</strong>: "
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								                      (mu4e~action-header-to-html msg :to) "</br>"))
-												mu4e-actions: fix mu4e~write-body-to-html

Use mu4e~view-construct-contacts-header instead of a non-existing
function.

											
										
										
											2019-04-15 06:19:44 +02:00
+								      (insert (concat "<strong>Date</strong>: "
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								                      (format-time-string mu4e-view-date-format (mu4e-message-field msg :date)) "</br>"))
-												Issue #1385: get mu4e-action-view-in-browser to show headers

Here is a very simple patch that achieves what I want, though I am
sure there are nicer ways of doing it.

											
										
										
											2019-02-20 19:17:53 +01:00
+								      (insert (concat "<strong>Subject</strong>: " (mu4e-message-field msg :subject) "</p>"))
-												* mu4e: improve mu4e-action-view-in-browser

											
										
										
											2012-08-30 11:54:26 +02:00
+								      (insert (or html (concat "<pre>" txt "</pre>")))
-												* fix mu4e-action-view-in-browser (thanks semente!)

											
										
										
											2012-09-25 06:38:57 +02:00
+								      (write-file tmpfile)
-												mu4e: handle attached image when write msg body to html

											
										
										
											2016-04-16 17:13:47 +02:00
+								      ;; rewrite attachment urls
 								      (mapc (lambda (attachment)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								              (goto-char (point-min))
 								              (while (re-search-forward (format "src=\"cid:%s\""
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								                                                (plist-get attachment :cid)) nil t)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								                (if (plist-get attachment :temp)
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								                    (replace-match (format "src=\"%s\""
 								                                           (plist-get attachment :temp)))
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								                  (replace-match (format "src=\"%s%s\"" temporary-file-directory
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								                                         (plist-get attachment :name)))
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								                  (let ((tmp-attachment-name
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								                         (format "%s%s" temporary-file-directory
 								                                 (plist-get attachment :name))))
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								                    (mu4e~proc-extract 'save (mu4e-message-field msg :docid)
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								                                       (plist-get attachment :index)
 								                                       mu4e-decryption-policy tmp-attachment-name)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								                    (mu4e-remove-file-later tmp-attachment-name)))))
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								            attachments)
-												mu4e: handle attached image when write msg body to html

											
										
										
											2016-04-16 17:13:47 +02:00
+								      (save-buffer)
-												mu4e: clean up creating html files

Clean up the creation of html files a bit, and automatically clean them
up after a short while, so we don't clutter /tmp.

Refactor the html-generating actions, so we don't repeat ourselves too
much.

											
										
										
											2016-02-20 10:21:24 +01:00
+								      tmpfile)))
-												* mu4e-actions.el: add some example actions for showing messages in a browers, text2speech

											
										
										
											2012-05-12 16:10:57 +02:00
-												mu4e: clean up creating html files

Clean up the creation of html files a bit, and automatically clean them
up after a short while, so we don't clutter /tmp.

Refactor the html-generating actions, so we don't repeat ourselves too
much.

											
										
										
											2016-02-20 10:21:24 +01:00
+								(defun mu4e-action-view-in-browser (msg)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "View the body of MSG in a web browser.
-												mu4e: clean up creating html files

Clean up the creation of html files a bit, and automatically clean them
up after a short while, so we don't clutter /tmp.

Refactor the html-generating actions, so we don't repeat ourselves too
much.

											
										
										
											2016-02-20 10:21:24 +01:00
+								You can influence the browser to use with the variable
-												mu4e: mention privacy aspects of browser

Mention the privacy aspects of opening a message in a browser, and what
to do about it.

											
										
										
											2016-03-15 05:40:21 +01:00
+								`browse-url-generic-program', and see the discussion of privacy
 								aspects in `(mu4e) Displaying rich-text messages'."
-												mu4e: clean up creating html files

Clean up the creation of html files a bit, and automatically clean them
up after a short while, so we don't clutter /tmp.

Refactor the html-generating actions, so we don't repeat ourselves too
much.

											
										
										
											2016-02-20 10:21:24 +01:00
+								  (browse-url (concat "file://"
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								                      (mu4e~write-body-to-html msg))))
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
-												mu4e: add mu4e-action-view-with-xwidget

Action for using xwidget/webkit to display emails in a webkit widget
inside mu4e. This currently requires the git-version of emacs (emacs-25
branch).

											
										
										
											2016-01-24 11:32:09 +01:00
+								(defun mu4e-action-view-with-xwidget (msg)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "View the body of MSG inside xwidget-webkit.
 								This is only available in Emacs 25+; also see the discussion of
 								privacy aspects in `(mu4e) Displaying rich-text messages'."
-												mu4e: add mu4e-action-view-with-xwidget

Action for using xwidget/webkit to display emails in a webkit widget
inside mu4e. This currently requires the git-version of emacs (emacs-25
branch).

											
										
										
											2016-01-24 11:32:09 +01:00
+								  (unless (fboundp 'xwidget-webkit-browse-url)
 								    (mu4e-error "No xwidget support available"))
-												mu4e: clean up creating html files

Clean up the creation of html files a bit, and automatically clean them
up after a short while, so we don't clutter /tmp.

Refactor the html-generating actions, so we don't repeat ourselves too
much.

											
										
										
											2016-02-20 10:21:24 +01:00
+								  (xwidget-webkit-browse-url
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								   (concat "file://" (mu4e~write-body-to-html msg)) t))
-												mu4e: add mu4e-action-view-with-xwidget

Action for using xwidget/webkit to display emails in a webkit widget
inside mu4e. This currently requires the git-version of emacs (emacs-25
branch).

											
										
										
											2016-01-24 11:32:09 +01:00
-												mu4e: Split libraries into outline sections

											
										
										
											2020-02-11 15:10:35 +01:00
+								;;; UNNAMED
-												mu4e: add mu4e-action-view-with-xwidget

Action for using xwidget/webkit to display emails in a webkit widget
inside mu4e. This currently requires the git-version of emacs (emacs-25
branch).

											
										
										
											2016-01-24 11:32:09 +01:00
 								(defconst mu4e-text2speech-command "festival --tts"
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Program that speaks out text it receives on standard input.")
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
-												* mu4e-actions.el: add some example actions for showing messages in a browers, text2speech

											
										
										
											2012-05-12 16:10:57 +02:00
+								(defun mu4e-action-message-to-speech (msg)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Pronounce MSG's body text using `mu4e-text2speech-command'."
-												* mu4e: mu4e-message part 3

											
										
										
											2012-09-26 16:28:30 +02:00
+								  (unless (mu4e-message-field msg :body-txt)
 								    (mu4e-warn "No text body for this message"))
-												* mu4e-actions.el: add some example actions for showing messages in a browers, text2speech

											
										
										
											2012-05-12 16:10:57 +02:00
+								  (with-temp-buffer
-												* mu4e: mu4e-message part 3

											
										
										
											2012-09-26 16:28:30 +02:00
+								    (insert (mu4e-message-field msg :body-txt))
-												* mu4e-actions.el: add some example actions for showing messages in a browers, text2speech

											
										
										
											2012-05-12 16:10:57 +02:00
+								    (shell-command-on-region (point-min) (point-max)
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								                             mu4e-text2speech-command)))
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
-												mu4e: Split libraries into outline sections

											
										
										
											2020-02-11 15:10:35 +01:00
+								;;; UNNAMED
-												* minor / cosmetic

											
										
										
											2012-04-24 17:48:07 +02:00
 								(defvar mu4e-captured-message nil
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "The most recently captured message.")
-												* minor / cosmetic

											
										
										
											2012-04-24 17:48:07 +02:00
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								(defun mu4e-action-capture-message (msg)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Remember MSG.
 								Later, we can create an attachment based on this message with
 								`mu4e-compose-attach-captured-message'."
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								  (setq mu4e-captured-message msg)
 								  (message "Message has been captured"))
-												mu4e: Split libraries into outline sections

											
										
										
											2020-02-11 15:10:35 +01:00
+								;;; UNNAMED
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
-												mu4e: add action mu4e-action-copy-message-file-path

Allow for copying the file path of the current message; useful for
developers.

											
										
										
											2017-08-27 16:35:23 +02:00
+								(defun mu4e-action-copy-message-file-path (msg)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Save the full path for the current MSG to the kill ring."
-												mu4e: add action mu4e-action-copy-message-file-path

Allow for copying the file path of the current message; useful for
developers.

											
										
										
											2017-08-27 16:35:23 +02:00
+								  (kill-new (mu4e-message-field msg :path)))
-												mu4e: Split libraries into outline sections

											
										
										
											2020-02-11 15:10:35 +01:00
+								;;; UNNAMED
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								(defvar mu4e-org-contacts-file nil
-												improve doc-strings

The first sentence should summarize the variable's or function's
purpose and it should fit on the first line.  Change existing
doc-string by:

* Move first sentence onto first line even if that makes it _a bit_
  long.
* Move additional notes out of first sentence and add them later,
  possibly as complete sentences.
* If I am uncertain whether doing the above would alter the meaning,
  _don't_ do it.
* If fitting the initial sentence on the first line would require a
  complete rewrite of the doc-string _don't_ do so unless it is very
  easy to do.
* Remove indentation from second and later lines if it is there to
  align them with the first in the source code, instead of in
  `describe-*' output.
* Make "pullet point" lists a bit more consistent.

Obviously this does not fix all problems but it's a start.

											
										
										
											2012-11-10 14:01:17 +01:00
+								  "File to store contact information for org-contacts.
 								Needed by `mu4e-action-add-org-contact'.")
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
 								(eval-when-compile ;; silence compiler warning about free variable
 								  (unless (require 'org-capture nil 'noerror)
 								    (defvar org-capture-templates nil)))
 								(defun mu4e-action-add-org-contact (msg)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Add an org-contact based on the sender ddress of the current MSG.
 								You need to set `mu4e-org-contacts-file' to the full path to the
 								file where you store your org-contacts."
-												* mu4e: don't require org directly

											
										
										
											2012-09-03 10:15:27 +02:00
+								  (unless (require 'org-capture nil 'noerror)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								    (mu4e-error "Feature org-capture is not available"))
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								  (unless mu4e-org-contacts-file
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								    (mu4e-error "Variable `mu4e-org-contacts-file' is nil"))
-												* mu4e: mu4e-message part 3

											
										
										
											2012-09-26 16:28:30 +02:00
+								  (let* ((sender (car-safe (mu4e-message-field msg :from)))
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								         (name (car-safe sender)) (email (cdr-safe sender))
 								         (blurb
 								          (format
 								           (concat
 								            "* %%?%s\n"
 								            ":PROPERTIES:\n"
 								            ":EMAIL: %s\n"
 								            ":NICK:\n"
 								            ":BIRTHDAY:\n"
 								            ":END:\n\n")
 								           (or name email "")
 								           (or email "")))
 								         (key "mu4e-add-org-contact-key")
 								         (org-capture-templates
 								          (append org-capture-templates
 								                  (list (list key "contacts" 'entry
 								                              (list 'file mu4e-org-contacts-file) blurb)))))
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								    (message "%S" org-capture-templates)
-												* silence some more compiler warnings

											
										
										
											2012-06-10 11:21:41 +02:00
+								    (when (fboundp 'org-capture)
 								      (org-capture nil key))))
-												* mu4e-actions.el: add some example actions for showing messages in a browers, text2speech

											
										
										
											2012-05-12 16:10:57 +02:00
-												mu4e: Split libraries into outline sections

											
										
										
											2020-02-11 15:10:35 +01:00
+								;;; UNNAMED
-												mu4e/mu4e-actions: re-factor apply-patch/mbox

The old code directly hacked around with ido-read-directory to achieve
its smarts. However other completion methods are available so this
re-factors the code to use an appropriately predicated completing-read
with a new history variable which is just used for patch application.

											
										
										
											2018-05-21 19:53:42 +02:00
 								(defvar mu4e~patch-directory-history nil
 								  "History of directories we have applied patches to.")
 								;; This essentially works around the fact that read-directory-name
 								;; can't have custom history.
 								(defun mu4e~read-patch-directory (&optional prompt)
 								  "Read a `PROMPT'ed directory name via `completing-read' with history."
 								  (unless prompt
 								    (setq prompt "Target directory:"))
 								  (file-truename
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								   (completing-read prompt 'read-file-name-internal #'file-directory-p
 								                    nil nil 'mu4e~patch-directory-history)))
-												mu4e/mu4e-actions: re-factor apply-patch/mbox

The old code directly hacked around with ido-read-directory to achieve
its smarts. However other completion methods are available so this
re-factors the code to use an appropriately predicated completing-read
with a new history variable which is just used for patch application.

											
										
										
											2018-05-21 19:53:42 +02:00
-												* mu4e: add example mu4e-action-git-apply-patch

											
										
										
											2012-10-29 11:26:17 +01:00
+								(defun mu4e-action-git-apply-patch (msg)
-												mu4e/mu4e-actions: re-factor apply-patch/mbox

The old code directly hacked around with ido-read-directory to achieve
its smarts. However other completion methods are available so this
re-factors the code to use an appropriately predicated completing-read
with a new history variable which is just used for patch application.

											
										
										
											2018-05-21 19:53:42 +02:00
+								  "Apply `MSG' as a git patch."
 								  (let ((path (mu4e~read-patch-directory "Target directory: ")))
 								    (let ((default-directory path))
 								      (shell-command
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								       (format "git apply %s"
 								               (shell-quote-argument (mu4e-message-field msg :path)))))))
-												mu4e-actions.el: add mu4e-action-git-apply-mbox example

Apply patch is useful when you might want to change the patch. However
for reviews you may well just want stuff applied directly to the
commit history.

											
										
										
											2013-10-25 13:09:26 +02:00
-												mu4e/mu4e-actions: optional apply signoff

Maintainers often want to apply patches with their signoff. Support
this with an optional argument.

											
										
										
											2017-06-26 11:08:35 +02:00
+								(defun mu4e-action-git-apply-mbox (msg &optional signoff)
-												mu4e/mu4e-actions: re-factor apply-patch/mbox

The old code directly hacked around with ido-read-directory to achieve
its smarts. However other completion methods are available so this
re-factors the code to use an appropriately predicated completing-read
with a new history variable which is just used for patch application.

											
										
										
											2018-05-21 19:53:42 +02:00
+								  "Apply `MSG' a git patch with optional `SIGNOFF'.
-												mu4e-actions: improve mbox handling for multiple marks

This avoids prompting the user over and over if the directory hasn't
changed. I've also ensured the paths are escaped with
shell-quote-argument.

											
										
										
											2015-08-31 16:07:10 +02:00
 								If the `default-directory' matches the most recent history entry don't
 								bother asking for the git tree again (useful for bulk actions)."
-												mu4e/mu4e-actions: re-factor apply-patch/mbox

The old code directly hacked around with ido-read-directory to achieve
its smarts. However other completion methods are available so this
re-factors the code to use an appropriately predicated completing-read
with a new history variable which is just used for patch application.

											
										
										
											2018-05-21 19:53:42 +02:00
+								  (let ((cwd (substring-no-properties
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								              (or (car mu4e~patch-directory-history)
 								                  "not-a-dir"))))
-												mu4e-actions: improve mbox handling for multiple marks

This avoids prompting the user over and over if the directory hasn't
changed. I've also ensured the paths are escaped with
shell-quote-argument.

											
										
										
											2015-08-31 16:07:10 +02:00
+								    (unless (and (stringp cwd) (string= default-directory cwd))
-												mu4e/mu4e-actions: re-factor apply-patch/mbox

The old code directly hacked around with ido-read-directory to achieve
its smarts. However other completion methods are available so this
re-factors the code to use an appropriately predicated completing-read
with a new history variable which is just used for patch application.

											
										
										
											2018-05-21 19:53:42 +02:00
+								      (setq cwd (mu4e~read-patch-directory "Target directory: ")))
 								    (let ((default-directory cwd))
 								      (shell-command
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								       (format "git am %s %s"
 								               (if signoff "--signoff" "")
 								               (shell-quote-argument (mu4e-message-field msg :path)))))))
-												mu4e-actions.el: add mu4e-action-git-apply-mbox example

Apply patch is useful when you might want to change the patch. However
for reviews you may well just want stuff applied directly to the
commit history.

											
										
										
											2013-10-25 13:09:26 +02:00
-												mu4e: Split libraries into outline sections

											
										
										
											2020-02-11 15:10:35 +01:00
+								;;; UNNAMED
-												* mu4e: add example mu4e-action-git-apply-patch

											
										
										
											2012-10-29 11:26:17 +01:00
-												Adds an action to change tags header

New action mu4e-action-retag-message that reads tag changes from the user and
modifies the corresponding header (X-Keywords, X-Label, etc) on the message.

											
										
										
											2012-12-06 19:14:05 +01:00
+								(defvar mu4e-action-tags-header "X-Keywords"
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Header where tags are stored.
 								Used by `mu4e-action-retag-message'. Make sure it is one of the
 								headers mu recognizes for storing tags: X-Keywords, X-Label,
 								Keywords. Also note that changing this setting on already tagged
 								messages can lead to messages with multiple tags headers.")
-												Adds an action to change tags header

New action mu4e-action-retag-message that reads tag changes from the user and
modifies the corresponding header (X-Keywords, X-Label, etc) on the message.

											
										
										
											2012-12-06 19:14:05 +01:00
-												add rudimentary completion support for retag action

This adds a variable mu4e-action-tags-completion-list, that contains a
list of commonly used tags to suggest as completion terms during a retag
actions.

Along the way, the retag action accepts as argument a comma-separated
list of +tag and -tag keywords, instead of a space-separated one,
removing the need to quote tags with spaces in them, and making it
consistent with the behaviour of completing-read-multiple.

											
										
										
											2014-10-30 14:08:14 +01:00
+								(defvar mu4e-action-tags-completion-list '()
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "List of tags for completion in `mu4e-action-retag-message'.")
-												add rudimentary completion support for retag action

This adds a variable mu4e-action-tags-completion-list, that contains a
list of commonly used tags to suggest as completion terms during a retag
actions.

Along the way, the retag action accepts as argument a comma-separated
list of +tag and -tag keywords, instead of a space-separated one,
removing the need to quote tags with spaces in them, and making it
consistent with the behaviour of completing-read-multiple.

											
										
										
											2014-10-30 14:08:14 +01:00
-												* mu4e: Whoops, uses actual correct helper function naming conventions (~ instead of -)

											
										
										
											2013-03-16 18:42:41 +01:00
+								(defun mu4e~contains-line-matching (regexp path)
-												mu4e~contains-line-matching: Cosmetics

											
										
										
											2020-02-13 09:28:15 +01:00
+								  "Return non-nil if the file at PATH contain a line matching REGEXP.
 								Otherwise return nil."
-												* mu4e: replaces sed with elisp in re-tag action

											
										
										
											2013-03-11 22:36:36 +01:00
+								  (with-temp-buffer
 								    (insert-file-contents path)
-												* mu4e: don't use beginning-of-buffer non-interactively (fixes compilation warning)

											
										
										
											2013-03-17 18:45:16 +01:00
+								    (save-excursion
 								      (goto-char (point-min))
-												mu4e~contains-line-matching: Cosmetics

											
										
										
											2020-02-13 09:28:15 +01:00
+								      (re-search-forward regexp nil t))))
-												* mu4e: replaces sed with elisp in re-tag action

											
										
										
											2013-03-11 22:36:36 +01:00
-												* mu4e: Whoops, uses actual correct helper function naming conventions (~ instead of -)

											
										
										
											2013-03-16 18:42:41 +01:00
+								(defun mu4e~replace-first-line-matching (regexp to-string path)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Replace first line matching REGEXP in PATH with TO-STRING."
-												* mu4e: replaces sed with elisp in re-tag action

											
										
										
											2013-03-11 22:36:36 +01:00
+								  (with-temp-file path
 								    (insert-file-contents path)
-												* mu4e: don't use beginning-of-buffer non-interactively (fixes compilation warning)

											
										
										
											2013-03-17 18:45:16 +01:00
+								    (save-excursion
 								      (goto-char (point-min))
-												* cosmetics

											
										
										
											2013-03-17 10:58:08 +01:00
+								      (if (re-search-forward regexp nil t)
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								          (replace-match to-string nil nil)))))
-												* mu4e: replaces sed with elisp in re-tag action

											
										
										
											2013-03-11 22:36:36 +01:00
-												* some fixes for the retagging action (thanks to Abdó Roig-Maranges)

											
										
										
											2012-12-15 11:06:32 +01:00
+								(defun mu4e-action-retag-message (msg &optional retag-arg)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Change tags of MSG with RETAG-ARG.
-												add rudimentary completion support for retag action

This adds a variable mu4e-action-tags-completion-list, that contains a
list of commonly used tags to suggest as completion terms during a retag
actions.

Along the way, the retag action accepts as argument a comma-separated
list of +tag and -tag keywords, instead of a space-separated one,
removing the need to quote tags with spaces in them, and making it
consistent with the behaviour of completing-read-multiple.

											
										
										
											2014-10-30 14:08:14 +01:00
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								RETAG-ARG is a comma-separated list of additions and removals.
-												add rudimentary completion support for retag action

This adds a variable mu4e-action-tags-completion-list, that contains a
list of commonly used tags to suggest as completion terms during a retag
actions.

Along the way, the retag action accepts as argument a comma-separated
list of +tag and -tag keywords, instead of a space-separated one,
removing the need to quote tags with spaces in them, and making it
consistent with the behaviour of completing-read-multiple.

											
										
										
											2014-10-30 14:08:14 +01:00
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								Example: +tag,+long tag,-oldtag
 								would add 'tag' and 'long tag', and remove 'oldtag'."
-												add rudimentary completion support for retag action

This adds a variable mu4e-action-tags-completion-list, that contains a
list of commonly used tags to suggest as completion terms during a retag
actions.

Along the way, the retag action accepts as argument a comma-separated
list of +tag and -tag keywords, instead of a space-separated one,
removing the need to quote tags with spaces in them, and making it
consistent with the behaviour of completing-read-multiple.

											
										
										
											2014-10-30 14:08:14 +01:00
+								  (let* (
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								         (path (mu4e-message-field msg :path))
 								         (oldtags (mu4e-message-field msg :tags))
 								         (tags-completion
 								          (append
 								           mu4e-action-tags-completion-list
 								           (mapcar (lambda (tag) (format "+%s" tag))
 								                   mu4e-action-tags-completion-list)
 								           (mapcar (lambda (tag) (format "-%s" tag))
 								                   oldtags)))
 								         (retag (if retag-arg
 								                    (split-string retag-arg ",")
 								                  (completing-read-multiple "Tags: " tags-completion)))
 								         (header  mu4e-action-tags-header)
 								         (sep     (cond ((string= header "Keywords") ", ")
 								                        ((string= header "X-Label") " ")
 								                        ((string= header "X-Keywords") ", ")
 								                        (t ", ")))
 								         (taglist (if oldtags (copy-sequence oldtags) '()))
 								         tagstr)
-												add rudimentary completion support for retag action

This adds a variable mu4e-action-tags-completion-list, that contains a
list of commonly used tags to suggest as completion terms during a retag
actions.

Along the way, the retag action accepts as argument a comma-separated
list of +tag and -tag keywords, instead of a space-separated one,
removing the need to quote tags with spaces in them, and making it
consistent with the behaviour of completing-read-multiple.

											
										
										
											2014-10-30 14:08:14 +01:00
+								    (dolist (tag retag taglist)
-												* mu4e: make the +/- in +tag, -tag only match at the beginning of words

											
										
										
											2013-03-16 16:58:17 +01:00
+								      (cond
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								       ((string-match "^\\+\\(.+\\)" tag)
 								        (setq taglist (push (match-string 1 tag) taglist)))
 								       ((string-match "^\\-\\(.+\\)" tag)
 								        (setq taglist (delete (match-string 1 tag) taglist)))
 								       (t
 								        (setq taglist (push tag taglist)))))
-												* mu4e: don't use beginning-of-buffer non-interactively (fixes compilation warning)

											
										
										
											2013-03-17 18:45:16 +01:00
-												Adds an action to change tags header

New action mu4e-action-retag-message that reads tag changes from the user and
modifies the corresponding header (X-Keywords, X-Label, etc) on the message.

											
										
										
											2012-12-06 19:14:05 +01:00
+								    (setq taglist (sort (delete-dups taglist) 'string<))
 								    (setq tagstr (mapconcat 'identity taglist sep))
-												* mu4e: don't use beginning-of-buffer non-interactively (fixes compilation warning)

											
										
										
											2013-03-17 18:45:16 +01:00
-												* mu4e: replaces sed with elisp in re-tag action

											
										
										
											2013-03-11 22:36:36 +01:00
+								    (setq tagstr (replace-regexp-in-string "[\\&]" "\\\\\\&" tagstr))
 								    (setq tagstr (replace-regexp-in-string "[/]"   "\\&" tagstr))
-												* mu4e: don't use beginning-of-buffer non-interactively (fixes compilation warning)

											
										
										
											2013-03-17 18:45:16 +01:00
-												* mu4e: Whoops, uses actual correct helper function naming conventions (~ instead of -)

											
										
										
											2013-03-16 18:42:41 +01:00
+								    (if (not (mu4e~contains-line-matching (concat header ":.*") path))
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								        ;; Add tags header just before the content
 								        (mu4e~replace-first-line-matching
 								         "^$" (concat header ": " tagstr "\n") path)
-												* mu4e: don't use beginning-of-buffer non-interactively (fixes compilation warning)

											
										
										
											2013-03-17 18:45:16 +01:00
-												* mu4e: replaces sed with elisp in re-tag action

											
										
										
											2013-03-11 22:36:36 +01:00
+								      ;; replaces keywords, restricted to the header
-												* mu4e: Whoops, uses actual correct helper function naming conventions (~ instead of -)

											
										
										
											2013-03-16 18:42:41 +01:00
+								      (mu4e~replace-first-line-matching
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								       (concat header ":.*")
 								       (concat header ": " tagstr)
 								       path))
-												* mu4e: don't use beginning-of-buffer non-interactively (fixes compilation warning)

											
										
										
											2013-03-17 18:45:16 +01:00
-												* some fixes for the retagging action (thanks to Abdó Roig-Maranges)

											
										
										
											2012-12-15 11:06:32 +01:00
+								    (mu4e-message (concat "tagging: " (mapconcat 'identity taglist ", ")))
-												mu4e: update to use server maildir/database/addresses

Mkae mu4e-maildir and mu4e-personal-addresses obsolete, we get those
from the server.

											
										
										
											2020-02-06 19:28:24 +01:00
+								    (mu4e-refresh-message path)))
-												mu4e: added action to show the current thread only

Add an action for view and headers buffer to show only the messages in
the current thread.

											
										
										
											2015-11-07 06:36:31 +01:00
 								(defun mu4e-action-show-thread (msg)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								  "Show thread for message at point with point remaining on MSG.
 								I.e., point remains on the message with the message-id where the
 								action was invoked. If invoked in view mode, continue to display
 								the message."
-												mu4e: added action to show the current thread only

Add an action for view and headers buffer to show only the messages in
the current thread.

											
										
										
											2015-11-07 06:36:31 +01:00
+								  (let ((msgid (mu4e-message-field msg :message-id)))
 								    (when msgid
 								      (let ((mu4e-headers-show-threads t)
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								            (mu4e-headers-include-related t))
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								        (mu4e-headers-search
-												mu4e: Fix indentation

											
										
										
											2020-02-11 12:00:46 +01:00
+								         (format "msgid:%s" msgid)
 								         nil nil nil
 								         msgid (and (eq major-mode 'mu4e-view-mode)
 								                    (not (eq mu4e-split-view 'single-window))))))))
-												Adds an action to change tags header

New action mu4e-action-retag-message that reads tag changes from the user and
modifies the corresponding header (X-Keywords, X-Label, etc) on the message.

											
										
										
											2012-12-06 19:14:05 +01:00
-												mu4e: Place provide forms in their own sections

Use "_" as the title of that section so that it is less distracting
when sections are collapsed to get an overview of the library.

Using a separate section is useful because it reduces the risk of
accidentally into the middle of a library.

											
										
										
											2020-02-11 13:26:45 +01:00
+								;;; _
-												* mu4e-actions: split of the example actions (i.e..,
  mu4e-(view|view-attachment|header)-actions into their own file

											
										
										
											2012-04-24 17:11:56 +02:00
+								(provide 'mu4e-actions)
-												mu4e-actions: fix whitespace, flycheck warnings

											
										
										
											2019-04-15 06:38:58 +02:00
+								;;; mu4e-actions.el ends here