]> git.notmuchmail.org Git - notmuch/blobdiff - emacs/notmuch-maildir-fcc.el
emacs: make modifications to message Fcc vars buffer-local
[notmuch] / emacs / notmuch-maildir-fcc.el
index 64f60bc62bee9a23989da3104765831c19b89068..c2f2f4cb127db3d9f2c786b8c8236cffe558193e 100644 (file)
 ;; To use this as the fcc handler for message-mode,
 ;; customize the notmuch-fcc-dirs variable
 
+(eval-when-compile (require 'cl))
 (require 'message)
 
+(require 'notmuch-lib)
+
 (defvar notmuch-maildir-fcc-count 0)
 
-(defcustom notmuch-fcc-dirs nil
- "If set to non-nil, this will cause message mode to file (fcc) your mail in the specified directory, depending on your From address.
+(defcustom notmuch-fcc-dirs "sent"
+ "Determines the maildir directory in which 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 list: the folder is chosen based on the From address of the
+  current message using a list of regular expressions and
+  corresponding folders:
+
+     ((\"Sebastian@SSpaeth.de\" . \"privat\")
+      (\"spaetz@sspaeth.de\" . \"OUTBOX.OSS\")
+      (\".*\" . \"defaultinbox\"))
 
- The first entry (a list) is used as a default fallback
- when nothing matches. So in the easiest case notmuch-fcc-dirs is
- just something like ((\"INBOX.Sent\"))
+  If none of the regular expressions match the From address, no
+  Fcc header will be added.
 
- If you need a more fancy setup, where you want different Outboxes depending
- on your From address, you use something like this:
+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).
 
-     (   (\"defaultinbox\")
-         (\"Sebastian Spaeth <Sebastian@SSpaeth.de>\" . \"privat\")
-         (\"Sebastian Spaeth <SSpaeth@ethz.ch>\" . \"uni\")
-     )
+You will be prompted to create the directory if it does not exist
+yet when sending a mail."
 
This will constructs a path, concatenating the content of the
- variable 'message-directory' (a message mode variable
- customizable via m-x
- customize-variable<RET>message-directory<RET>) and the second
- part in the alist."
: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
-)
-
-(defun notmuch-fcc-initialization ()
-  "If notmuch-fcc-directories is set,
-   hook them into the message-fcc-handler-function"
-(if (not (eq notmuch-fcc-dirs nil)) (progn
-    ;Set up the message-fcc-handler to move mails to the maildir in Fcc
-    ;The parameter is hardcoded to mark messages as "seen"
-    (setq message-fcc-handler-function
-          '(lambda (destdir)
-             (notmuch-maildir-fcc-write-buffer-to-maildir destdir t)))
-    ;add a hook to actually insert the Fcc header when sending
-    ;(preferrably we would use message-header-setup-up, but notmuch-reply
-    ; munges headers after that is run, so it won't work for replies within
-    ; notmuch)
-    (add-hook 'message-send-hook 'notmuch-fcc-header-setup))))
+ :group 'notmuch-send)
+
+(defun notmuch-fcc-handler (destdir)
+  "Write buffer to `destdir', marking it as sent
+
+Intended to be dynamically bound to `message-fcc-handler-function'"
+    (notmuch-maildir-fcc-write-buffer-to-maildir destdir t))
 
 (defun notmuch-fcc-header-setup ()
-  "Can be added to message-send-hook and will set the FCC header
-      based on the values of notmuch-fcc-directories (see the
-      variable customization there for examples). It uses the
-      first entry as default fallback if no From address
-      matches."
-  ; only do something if notmuch-fcc-dirs is set
-  (if notmuch-fcc-dirs
-   (let ((subdir
-          (cdr (assoc-string (message-fetch-field "from") notmuch-fcc-dirs t))))
-     (if (eq subdir nil) (setq subdir (car (car notmuch-fcc-dirs))))
-     (message-remove-header "Fcc")
-     (message-add-header (concat "Fcc: " message-directory subdir)))))
+  "Add an Fcc header to the current message buffer.
+
+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"
+
+  (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
+                  (catch 'first-match
+                    (dolist (re-folder notmuch-fcc-dirs)
+                      (when (string-match-p (car re-folder) from)
+                        (throw 'first-match re-folder))))))
+            (if match
+                (cdr match)
+              (message "No Fcc header added.")
+              nil)))
 
+         (t
+          (error "Invalid `notmuch-fcc-dirs' setting (neither string nor list)")))))
+
+    (when subdir
+      (message-add-header
+       (concat "Fcc: "
+              (file-truename
+               ;; If the resulting directory is not an absolute path,
+               ;; prepend the standard notmuch database path.
+               (if (= (elt subdir 0) ?/)
+                   subdir
+                 (concat (notmuch-database-path) "/" subdir)))))
+      
+      ;; finally test if fcc points to a valid maildir
+      (let ((fcc-header (message-field-value "Fcc")))
+       (unless (notmuch-maildir-fcc-dir-is-maildir-p fcc-header)
+         (cond ((not (file-writable-p fcc-header))
+                (error (format "No permission to create %s, which does not exist"
+                               fcc-header)))
+               ((y-or-n-p (format "%s is not a maildir. Create it? "
+                                  fcc-header))
+                (notmuch-maildir-fcc-create-maildir fcc-header))
+               (t
+                (error "Message not sent"))))))))
 (defun notmuch-maildir-fcc-host-fixer (hostname)
   (replace-regexp-in-string "/\\|:"
-                           '(lambda (s)
-                               (cond ((string-equal s "/") "\\057")
-                                     ((string-equal s ":") "\\072")
-                                     (t s)))
+                           (lambda (s)
+                             (cond ((string-equal s "/") "\\057")
+                                   ((string-equal s ":") "\\072")
+                                   (t s)))
                            hostname
                            t
                            t))
 
 (defun notmuch-maildir-fcc-make-uniq-maildir-id ()
-   (let* ((ct (current-time))
-         (timeid (+ (* (car ct) 65536) (cadr ct)))
-         (microseconds (car (cdr (cdr ct))))
+   (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"
-            timeid
+            ftime
             (emacs-pid)
             microseconds
             notmuch-maildir-fcc-count
        (file-exists-p (concat dir "/new/"))
        (file-exists-p (concat dir "/tmp/"))))
 
+(defun notmuch-maildir-fcc-create-maildir (path)
+  (cond ((or (not (file-exists-p path)) (file-directory-p path))
+        (make-directory (concat path "/cur/") t)
+        (make-directory (concat path "/new/") t)
+        (make-directory (concat path "/tmp/") t))
+       ((file-regular-p path)
+        (error "%s is a file. Can't create maildir." path))
+       (t
+        (error "I don't know how to create a maildir here"))))
+
 (defun notmuch-maildir-fcc-save-buffer-to-tmp (destdir)
   "Returns the msg id of the message written to the temp directory
 if successful, nil if not."
@@ -148,5 +209,5 @@ return t if successful, and nil otherwise."
          (delete-file (concat destdir "/tmp/" msg-id))))
       t)))
 
-(notmuch-fcc-initialization)
 (provide 'notmuch-maildir-fcc)
+