]> git.notmuchmail.org Git - notmuch/blobdiff - emacs/notmuch-maildir-fcc.el
emacs: Increase consistency of library headers
[notmuch] / emacs / notmuch-maildir-fcc.el
index 1218c01e19e2e51a599c66f98014101187c2e300..aa07b26afca8622334a1729c594b2a1c4e231929 100644 (file)
@@ -1,28 +1,28 @@
-;;; notmuch-maildir-fcc.el ---
-
-;; This file is free software; you can redistribute it and/or modify
-;; it under the terms of the GNU General Public License as published
-;; by the Free Software Foundation; either version 2, or (at your
-;; option) any later version.
-
-;; This program 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.
-
+;;; notmuch-maildir-fcc.el --- inserting using a fcc handler
+
+;; Copyright © Jesse Rosenthal
+;;
+;; This file is part of Notmuch.
+;;
+;; Notmuch 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.
+;;
+;; Notmuch 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; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
-
-;;; Commentary:
-
-;; To use this as the fcc handler for message-mode,
-;; customize the notmuch-fcc-dirs variable
+;; along with Notmuch.  If not, see <https://www.gnu.org/licenses/>.
+;;
+;; Authors: Jesse Rosenthal <jrosenthal@jhu.edu>
 
 ;;; Code:
 
-(eval-when-compile (require 'cl))
+(eval-when-compile (require 'cl-lib))
+
 (require 'message)
 
 (require 'notmuch-lib)
 (defvar notmuch-maildir-fcc-count 0)
 
 (defcustom notmuch-fcc-dirs "sent"
"Determines the maildir directory in which to save outgoing mail.
 "Determines the Fcc Header which says where to save outgoing mail.
 
 Three types of values are permitted:
 
 - nil: no Fcc header is added,
 
-- a string: the value of `notmuch-fcc-dirs' is the name of the
-  folder to use,
+- a string: the value of `notmuch-fcc-dirs' is the Fcc header to
+  be used.
 
 - a list: the folder is chosen based on the From address of the
   current message using a list of regular expressions and
@@ -50,23 +50,34 @@ Three types of values are permitted:
   If none of the regular expressions match the From address, no
   Fcc header will be added.
 
-In all cases, a relative FCC directory will be understood to
-specify a directory within the notmuch mail store, (as set by
-the database.path option in the notmuch configuration file).
-
-You will be prompted to create the directory if it does not exist
-yet when sending a mail."
-
- :type '(choice
-        (const :tag "No FCC header" nil)
-        (string :tag "A single folder")
-        (repeat :tag "A folder based on the From header"
-                (cons regexp (string :tag "Folder"))))
- :require 'notmuch-fcc-initialization
- :group 'notmuch-send)
+If `notmuch-maildir-use-notmuch-insert' is set (the default) then
+the header should be of the form \"folder +tag1 -tag2\" where
+folder is the folder (relative to the notmuch mailstore) to store
+the message in, and tag1 and tag2 are tag changes to apply to the
+stored message. This string is split using `split-string-and-unquote',
+so a folder name containing spaces can be specified by
+quoting each space with an immediately preceding backslash
+or surrounding the entire folder name in double quotes.
+
+If `notmuch-maildir-use-notmuch-insert' is nil then the Fcc
+header should be the directory where the message should be
+saved. A relative directory will be understood to specify a
+directory within the notmuch mail store, (as set by the
+database.path option in the notmuch configuration file).
+
+In all cases you will be prompted to create the folder or
+directory if it does not exist yet when sending a mail."
+
+  :type '(choice
+         (const :tag "No FCC header" nil)
+         (string :tag "A single folder")
+         (repeat :tag "A folder based on the From header"
+                 (cons regexp (string :tag "Folder"))))
+  :require 'notmuch-fcc-initialization
+  :group 'notmuch-send)
 
 (defcustom notmuch-maildir-use-notmuch-insert 't
-  "Should fcc use notmuch insert instead of simple fcc"
+  "Should fcc use notmuch insert instead of simple fcc."
   :type '(choice :tag "Fcc Method"
                 (const :tag "Use notmuch insert" t)
                 (const :tag "Use simple fcc" nil))
@@ -81,23 +92,19 @@ yet when sending a mail."
 Sets the Fcc header based on the values of `notmuch-fcc-dirs'.
 
 Originally intended to be use a hook function, but now called directly
-by notmuch-mua-mail"
-
+by notmuch-mua-mail."
   (let ((subdir
         (cond
          ((or (not notmuch-fcc-dirs)
               (message-field-value "Fcc"))
           ;; Nothing set or an existing header.
           nil)
-
          ((stringp notmuch-fcc-dirs)
           notmuch-fcc-dirs)
-
          ((and (listp notmuch-fcc-dirs)
                (stringp (car notmuch-fcc-dirs)))
           ;; Old style - no longer works.
           (error "Invalid `notmuch-fcc-dirs' setting (old style)"))
-
          ((listp notmuch-fcc-dirs)
           (let* ((from (message-field-value "From"))
                  (match
@@ -109,10 +116,8 @@ by notmuch-mua-mail"
                 (cdr match)
               (message "No Fcc header added.")
               nil)))
-
          (t
           (error "Invalid `notmuch-fcc-dirs' setting (neither string nor list)")))))
-
     (when subdir
       (if notmuch-maildir-use-notmuch-insert
          (notmuch-maildir-add-notmuch-insert-style-fcc-header subdir)
@@ -121,10 +126,10 @@ by notmuch-mua-mail"
 (defun notmuch-maildir-add-notmuch-insert-style-fcc-header (subdir)
   ;; Notmuch insert does not accept absolute paths, so check the user
   ;; really want this header inserted.
-
   (when (or (not (= (elt subdir 0) ?/))
-           (y-or-n-p (format "Fcc header %s is an absolute path and notmuch insert is requested.\nInsert header anyway? "
-                             subdir)))
+           (y-or-n-p
+            (format "Fcc header %s is an absolute path and notmuch insert is requested.
+Insert header anyway? " subdir)))
     (message-add-header (concat "Fcc: " subdir))))
 
 (defun notmuch-maildir-add-file-style-fcc-header (subdir)
@@ -158,8 +163,7 @@ This is taken from the function message-do-fcc."
   (message-encode-message-body)
   (save-restriction
     (message-narrow-to-headers)
-    (let ((mail-parse-charset message-default-charset))
-      (mail-encode-encoded-word-buffer)))
+    (mail-encode-encoded-word-buffer))
   (goto-char (point-min))
   (when (re-search-forward
         (concat "^" (regexp-quote mail-header-separator) "$")
@@ -195,6 +199,7 @@ This is a rearranged version of message mode's message-do-fcc."
 If `notmuch-maildir-use-notmuch-insert` is set then store the
 message using notmuch insert. Otherwise store the message using
 normal fcc."
+  (message "Doing Fcc...")
   (if notmuch-maildir-use-notmuch-insert
       (notmuch-maildir-fcc-with-notmuch-insert fcc-header)
     (notmuch-maildir-fcc-file-fcc fcc-header)))
@@ -209,7 +214,7 @@ This inserts the current buffer as a message into the notmuch
 database in folder FOLDER. If CREATE is non-nil it will supply
 the --create-folder flag to create the folder if necessary. TAGS
 should be a list of tag changes to apply to the inserted message."
-  (let* ((args (append (when create (list "--create-folder"))
+  (let* ((args (append (and create (list "--create-folder"))
                       (list (concat "--folder=" folder))
                       tags)))
     (apply 'notmuch-call-notmuch-process
@@ -221,8 +226,12 @@ should be a list of tag changes to apply to the inserted message."
 The fcc-header should be of the form \"folder +tag1 -tag2\" where
 folder is the folder (relative to the notmuch mailstore) to store
 the message in, and tag1 and tag2 are tag changes to apply to the
-stored message. If CREATE is non-nil then create the folder if
-necessary."
+stored message. This string is split using `split-string-and-unquote',
+so a folder name containing spaces can be specified by
+quoting each space with an immediately preceding backslash
+or surrounding the entire folder name in double quotes.
+
+If CREATE is non-nil then create the folder if necessary."
   (let* ((args (split-string-and-unquote fcc-header))
         (folder (car args))
         (tags (cdr args)))
@@ -233,15 +242,14 @@ necessary."
       ;; typo, or just the user want a new folder, let the user decide
       ;; how to deal with it.
       (error
-       (let ((response (read-char-choice
-                       "Insert failed: (r)etry, (c)reate folder, (i)gnore, or  (e)dit the header? "
-                       '(?r ?c ?i ?e))))
-        (case response
-              (?r (notmuch-maildir-fcc-with-notmuch-insert fcc-header))
-              (?c (notmuch-maildir-fcc-with-notmuch-insert fcc-header 't))
-              (?i 't)
-              (?e (notmuch-maildir-fcc-with-notmuch-insert
-                   (read-from-minibuffer "Fcc header: " fcc-header)))))))))
+       (let ((response (notmuch-read-char-choice "Insert failed: \
+\(r)etry, (c)reate folder, (i)gnore, or (e)dit the header? " '(?r ?c ?i ?e))))
+        (cl-case response
+          (?r (notmuch-maildir-fcc-with-notmuch-insert fcc-header))
+          (?c (notmuch-maildir-fcc-with-notmuch-insert fcc-header 't))
+          (?i 't)
+          (?e (notmuch-maildir-fcc-with-notmuch-insert
+               (read-from-minibuffer "Fcc header: " fcc-header)))))))))
 
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
@@ -258,16 +266,16 @@ necessary."
                            t))
 
 (defun notmuch-maildir-fcc-make-uniq-maildir-id ()
-   (let* ((ftime (float-time))
-         (microseconds (mod (* 1000000 ftime) 1000000))
-         (hostname (notmuch-maildir-fcc-host-fixer system-name)))
-     (setq notmuch-maildir-fcc-count (+ notmuch-maildir-fcc-count 1))
-     (format "%d.%d_%d_%d.%s"
-            ftime
-            (emacs-pid)
-            microseconds
-            notmuch-maildir-fcc-count
-            hostname)))
+  (let* ((ftime (float-time))
+        (microseconds (mod (* 1000000 ftime) 1000000))
+        (hostname (notmuch-maildir-fcc-host-fixer (system-name))))
+    (setq notmuch-maildir-fcc-count (+ notmuch-maildir-fcc-count 1))
+    (format "%d.%d_%d_%d.%s"
+           ftime
+           (emacs-pid)
+           microseconds
+           notmuch-maildir-fcc-count
+           hostname)))
 
 (defun notmuch-maildir-fcc-dir-is-maildir-p (dir)
   (and (file-exists-p (concat dir "/cur/"))
@@ -306,7 +314,7 @@ if successful, nil if not."
 (defun notmuch-maildir-fcc-move-tmp-to-cur (destdir msg-id &optional mark-seen)
   (add-name-to-file
    (concat destdir "/tmp/" msg-id)
-   (concat destdir "/cur/" msg-id ":2," (when mark-seen "S"))))
+   (concat destdir "/cur/" msg-id ":2," (and mark-seen "S"))))
 
 (defun notmuch-maildir-fcc-file-fcc (fcc-header)
   "Write the message to the file specified by FCC-HEADER.
@@ -317,19 +325,19 @@ if needed."
       (notmuch-maildir-fcc-write-buffer-to-maildir fcc-header 't)
     ;; The fcc-header is not a valid maildir see if the user wants to
     ;; fix it in some way.
-    (let* ((prompt (format "Fcc %s is not a maildir: (r)etry, (c)reate folder, (i)gnore, or  (e)dit the header? "
-                          fcc-header))
-           (response (read-char-choice prompt '(?r ?c ?i ?e))))
-        (case response
-              (?r (notmuch-maildir-fcc-file-fcc fcc-header))
-              (?c (if (file-writable-p fcc-header)
-                      (notmuch-maildir-fcc-create-maildir fcc-header)
-                    (message "No permission to create %s." fcc-header)
-                    (sit-for 2))
-                  (notmuch-maildir-fcc-file-fcc fcc-header))
-              (?i 't)
-              (?e (notmuch-maildir-fcc-file-fcc
-                   (read-from-minibuffer "Fcc header: " fcc-header)))))))
+    (let* ((prompt (format "Fcc %s is not a maildir: \
+\(r)etry, (c)reate folder, (i)gnore, or (e)dit the header? " fcc-header))
+          (response (notmuch-read-char-choice prompt '(?r ?c ?i ?e))))
+      (cl-case response
+       (?r (notmuch-maildir-fcc-file-fcc fcc-header))
+       (?c (if (file-writable-p fcc-header)
+               (notmuch-maildir-fcc-create-maildir fcc-header)
+             (message "No permission to create %s." fcc-header)
+             (sit-for 2))
+           (notmuch-maildir-fcc-file-fcc fcc-header))
+       (?i 't)
+       (?e (notmuch-maildir-fcc-file-fcc
+            (read-from-minibuffer "Fcc header: " fcc-header)))))))
 
 (defun notmuch-maildir-fcc-write-buffer-to-maildir (destdir &optional mark-seen)
   "Writes the current buffer to maildir destdir. If mark-seen is