1 ;;; mail-source.el --- functions for fetching mail
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news, mail
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
32 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
34 (require 'format-spec)
39 (autoload 'auth-source-user-or-password "auth-source")
40 (autoload 'pop3-movemail "pop3")
41 (autoload 'pop3-get-message-count "pop3")
42 (autoload 'nnheader-cancel-timer "nnheader"))
44 (require 'message) ;; for `message-directory'
46 (defvar display-time-mail-function)
48 (defgroup mail-source nil
49 "The mail-fetching library."
53 ;; Define these at compile time to avoid dragging in imap always.
54 (defconst mail-source-imap-authenticators
57 (list 'const (car a)))
58 imap-authenticator-alist)))
59 (defconst mail-source-imap-streams
62 (list 'const (car a)))
65 (defcustom mail-sources '((file))
66 "Where the mail backends will look for incoming mail.
67 This variable is a list of mail source specifiers.
68 See Info node `(gnus)Mail Source Specifiers'."
70 :version "23.1" ;; No Gnus
71 :link '(custom-manual "(gnus)Mail Source Specifiers")
73 (const :tag "None" nil)
75 (choice :format "%[Value Menu%] %v"
77 (cons :tag "Group parameter `mail-source'"
78 (const :format "" group))
79 (cons :tag "Spool file"
80 (const :format "" file)
81 (checklist :tag "Options" :greedy t
83 (const :format "" :value :path)
85 (cons :tag "Several files in a directory"
86 (const :format "" directory)
87 (checklist :tag "Options" :greedy t
89 (const :format "" :value :path)
90 (directory :tag "Path"))
92 (const :format "" :value :suffix)
93 (string :tag "Suffix"))
95 (const :format "" :value :predicate)
96 (function :tag "Predicate"))
98 (const :format "" :value :prescript)
99 (choice :tag "Prescript"
101 (string :format "%v")
102 (function :format "%v")))
104 (const :format "" :value :postscript)
105 (choice :tag "Postscript"
107 (string :format "%v")
108 (function :format "%v")))
110 (const :format "" :value :plugged)
111 (boolean :tag "Plugged"))))
112 (cons :tag "POP3 server"
113 (const :format "" pop)
114 (checklist :tag "Options" :greedy t
116 (const :format "" :value :server)
117 (string :tag "Server"))
119 (const :format "" :value :port)
122 (integer :format "%v")
123 (string :format "%v")))
125 (const :format "" :value :user)
126 (string :tag "User"))
128 (const :format "" :value :password)
129 (string :tag "Password"))
131 (const :format "" :value :program)
132 (string :tag "Program"))
134 (const :format "" :value :prescript)
135 (choice :tag "Prescript"
137 (string :format "%v")
138 (function :format "%v")
139 (const :tag "None" nil)))
141 (const :format "" :value :postscript)
142 (choice :tag "Postscript"
144 (string :format "%v")
145 (function :format "%v")
146 (const :tag "None" nil)))
148 (const :format "" :value :function)
149 (function :tag "Function"))
152 :value :authentication)
153 (choice :tag "Authentication"
158 (const :format "" :value :plugged)
159 (boolean :tag "Plugged"))
161 (const :format "" :value :stream)
162 (choice :tag "Stream"
164 (const :tag "Clear" nil)
166 (const :tag "SSL/TLS" ssl)))))
167 (cons :tag "Maildir (qmail, postfix...)"
168 (const :format "" maildir)
169 (checklist :tag "Options" :greedy t
171 (const :format "" :value :path)
172 (directory :tag "Path"))
174 (const :format "" :value :plugged)
175 (boolean :tag "Plugged"))))
176 (cons :tag "IMAP server"
177 (const :format "" imap)
178 (checklist :tag "Options" :greedy t
180 (const :format "" :value :server)
181 (string :tag "Server"))
183 (const :format "" :value :port)
188 (const :format "" :value :user)
189 (string :tag "User"))
191 (const :format "" :value :password)
192 (string :tag "Password"))
194 (const :format "" :value :stream)
195 (choice :tag "Stream"
197 ,@mail-source-imap-streams))
199 (const :format "" :value :program)
200 (string :tag "Program"))
203 :value :authenticator)
204 (choice :tag "Authenticator"
206 ,@mail-source-imap-authenticators))
208 (const :format "" :value :mailbox)
209 (string :tag "Mailbox"
212 (const :format "" :value :predicate)
213 (string :tag "Predicate"
214 :value "UNSEEN UNDELETED"))
216 (const :format "" :value :fetchflag)
217 (string :tag "Fetchflag"
222 (boolean :tag "Dontexpunge"))
224 (const :format "" :value :plugged)
225 (boolean :tag "Plugged"))))
226 (cons :tag "Webmail server"
227 (const :format "" webmail)
228 (checklist :tag "Options" :greedy t
230 (const :format "" :value :subtype)
231 ;; Should be generated from
232 ;; `webmail-type-definition', but we
233 ;; can't require webmail without W3.
234 (choice :tag "Subtype"
242 (const :format "" :value :user)
243 (string :tag "User"))
245 (const :format "" :value :password)
246 (string :tag "Password"))
250 (boolean :tag "Dontexpunge"))
252 (const :format "" :value :plugged)
253 (boolean :tag "Plugged"))))))))
255 (defcustom mail-source-ignore-errors nil
256 "*Ignore errors when querying mail sources.
257 If nil, the user will be prompted when an error occurs. If non-nil,
258 the error will be ignored."
263 (defcustom mail-source-primary-source nil
264 "*Primary source for incoming mail.
265 If non-nil, this maildrop will be checked periodically for new mail."
269 (defcustom mail-source-flash t
270 "*If non-nil, flash periodically when mail is available."
274 (defcustom mail-source-crash-box "~/.emacs-mail-crash-box"
275 "File where mail will be stored while processing it."
279 (defcustom mail-source-directory message-directory
280 "Directory where incoming mail source files (if any) will be stored."
284 (defcustom mail-source-default-file-modes 384
285 "Set the mode bits of all new mail files to this integer."
289 (defcustom mail-source-delete-incoming
290 10 ;; development versions
291 ;; 2 ;; released versions
292 "If non-nil, delete incoming files after handling.
293 If t, delete immediately, if nil, never delete. If a positive number, delete
294 files older than number of days.
296 Removing of old files happens in `mail-source-callback', i.e. no
297 old incoming files will be deleted unless you receive new mail.
298 You may also set this variable to nil and call
299 `mail-source-delete-old-incoming' interactively."
301 :version "22.2" ;; No Gnus / Gnus 5.10.10 (default changed)
302 :type '(choice (const :tag "immediately" t)
303 (const :tag "never" nil)
304 (integer :tag "days")))
306 (defcustom mail-source-delete-old-incoming-confirm nil
307 "If non-nil, ask for confirmation before deleting old incoming files.
308 This variable only applies when `mail-source-delete-incoming' is a positive
310 :version "22.2" ;; No Gnus / Gnus 5.10.10 (default changed)
314 (defcustom mail-source-incoming-file-prefix "Incoming"
315 "Prefix for file name for storing incoming mail"
319 (defcustom mail-source-report-new-mail-interval 5
320 "Interval in minutes between checks for new mail."
324 (defcustom mail-source-idle-time-delay 5
325 "Number of idle seconds to wait before checking for new mail."
329 (defcustom mail-source-movemail-program nil
330 "If non-nil, name of program for fetching new mail."
333 :type '(choice (const nil) string))
335 ;;; Internal variables.
337 (defvar mail-source-string ""
338 "A dynamically bound string that says what the current mail source is.")
340 (defvar mail-source-new-mail-available nil
341 "Flag indicating when new mail is available.")
344 (defvar mail-source-common-keyword-map
346 "Mapping from keywords to default values.
347 Common keywords should be listed here.")
349 (defvar mail-source-keyword-map
354 (:path (or (getenv "MAIL")
355 (expand-file-name (user-login-name) rmail-spool-directory))))
362 (:predicate identity))
367 (:server (getenv "MAILHOST"))
369 (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
373 (:authentication password)
376 (:path (or (getenv "MAILDIR") "~/Maildir/"))
377 (:subdirs ("cur" "new"))
380 (:server (getenv "MAILHOST"))
385 (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
388 (:predicate "UNSEEN UNDELETED")
389 (:fetchflag "\\Deleted")
396 (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
399 (:authentication password)))
400 "Mapping from keywords to default values.
401 All keywords that can be used must be listed here."))
403 (defvar mail-source-fetcher-alist
404 '((file mail-source-fetch-file)
405 (directory mail-source-fetch-directory)
406 (pop mail-source-fetch-pop)
407 (maildir mail-source-fetch-maildir)
408 (imap mail-source-fetch-imap)
409 (webmail mail-source-fetch-webmail))
410 "A mapping from source type to fetcher function.")
412 (defvar mail-source-password-cache nil)
414 (defvar mail-source-plugged t)
419 (defun mail-source-strip-keyword (keyword)
420 "Strip the leading colon off the KEYWORD."
421 (intern (substring (symbol-name keyword) 1))))
423 ;; generate a list of variable names paired with nil values
424 ;; suitable for usage in a `let' form
426 (defun mail-source-bind-1 (type)
427 (let* ((defaults (cdr (assq type mail-source-keyword-map)))
429 (while (setq default (pop defaults))
430 (push (list (mail-source-strip-keyword (car default))
435 (defmacro mail-source-bind (type-source &rest body)
436 "Return a `let' form that binds all variables in source TYPE.
437 TYPE-SOURCE is a list where the first element is the TYPE, and
438 the second variable is the SOURCE.
439 At run time, the mail source specifier SOURCE will be inspected,
440 and the variables will be set according to it. Variables not
441 specified will be given default values.
443 The user and password will be loaded from the auth-source values
444 if those are available. They override the original user and
445 password in a second `let' form.
447 After this is done, BODY will be executed in the scope
448 of the second `let' form.
450 The variables bound and their default values are described by
451 the `mail-source-keyword-map' variable."
452 `(let* ,(mail-source-bind-1 (car type-source))
453 (mail-source-set-1 ,(cadr type-source))
455 (auth-source-user-or-password
457 server ; this is "host" in auth-sources
461 (auth-source-user-or-password
463 server ; this is "host" in auth-sources
468 (put 'mail-source-bind 'lisp-indent-function 1)
469 (put 'mail-source-bind 'edebug-form-spec '(sexp body))
471 (defun mail-source-set-1 (source)
472 (let* ((type (pop source))
473 (defaults (cdr (assq type mail-source-keyword-map)))
474 default value keyword)
475 (while (setq default (pop defaults))
476 ;; for each default :SYMBOL, set SYMBOL to the plist value for :SYMBOL
477 ;; using `mail-source-value' to evaluate the plist value
478 (set (mail-source-strip-keyword (setq keyword (car default)))
479 (if (setq value (plist-get source keyword))
480 (mail-source-value value)
481 (mail-source-value (cadr default)))))))
484 (defun mail-source-bind-common-1 ()
485 (let* ((defaults mail-source-common-keyword-map)
487 (while (setq default (pop defaults))
488 (push (list (mail-source-strip-keyword (car default))
493 (defun mail-source-set-common-1 (source)
494 (let* ((type (pop source))
495 (defaults mail-source-common-keyword-map)
496 (defaults-1 (cdr (assq type mail-source-keyword-map)))
497 default value keyword)
498 (while (setq default (pop defaults))
499 (set (mail-source-strip-keyword (setq keyword (car default)))
500 (if (setq value (plist-get source keyword))
501 (mail-source-value value)
502 (if (setq value (assq keyword defaults-1))
503 (mail-source-value (cadr value))
504 (mail-source-value (cadr default))))))))
506 (defmacro mail-source-bind-common (source &rest body)
507 "Return a `let' form that binds all common variables.
508 See `mail-source-bind'."
509 `(let ,(mail-source-bind-common-1)
510 (mail-source-set-common-1 source)
513 (put 'mail-source-bind-common 'lisp-indent-function 1)
514 (put 'mail-source-bind-common 'edebug-form-spec '(sexp body))
516 (defun mail-source-value (value)
517 "Return the value of VALUE."
523 ((and (listp value) (symbolp (car value)) (fboundp (car value)))
525 ;; Just return the value.
529 (defun mail-source-fetch (source callback)
530 "Fetch mail from SOURCE and call CALLBACK zero or more times.
531 CALLBACK will be called with the name of the file where (some of)
532 the mail from SOURCE is put.
533 Return the number of files that were found."
534 (mail-source-bind-common source
535 (if (or mail-source-plugged plugged)
537 (let ((function (cadr (assq (car source) mail-source-fetcher-alist)))
540 (error "%S is an invalid mail source specification" source))
541 ;; If there's anything in the crash box, we do it first.
542 (when (file-exists-p mail-source-crash-box)
543 (message "Processing mail from %s..." mail-source-crash-box)
544 (setq found (mail-source-callback
545 callback mail-source-crash-box))
546 (mail-source-delete-crash-box))
548 (if (or debug-on-quit debug-on-error)
549 (funcall function source callback)
551 (funcall function source callback)
553 (if (and (not mail-source-ignore-errors)
556 (format "Mail source %s error (%s). Continue? "
557 (if (memq ':password source)
558 (let ((s (copy-sequence source)))
559 (setcar (cdr (memq ':password s))
564 (error "Cannot get new mail"))
567 (defun mail-source-delete-old-incoming (&optional age confirm)
568 "Remove incoming files older than AGE days.
569 If CONFIRM is non-nil, ask for confirmation before removing a file."
571 (let* ((high2days (/ 65536.0 60 60 24));; convert high bits to days
572 (low2days (/ 1.0 65536.0)) ;; convert low bits to days
573 (diff (if (natnump age) age 30));; fallback, if no valid AGE given
575 (setq files (directory-files
576 mail-source-directory t
578 (regexp-quote mail-source-incoming-file-prefix)))
579 currday (* (car (current-time)) high2days)
580 currday (+ currday (* low2days (nth 1 (current-time)))))
582 (let* ((ffile (car files))
583 (bfile (gnus-replace-in-string
584 ffile "\\`.*/\\([^/]+\\)\\'" "\\1"))
585 (filetime (nth 5 (file-attributes ffile)))
586 (fileday (* (car filetime) high2days))
587 (fileday (+ fileday (* low2days (nth 1 filetime)))))
588 (setq files (cdr files))
589 (when (and (> (- currday fileday) diff)
593 Delete old (> %s day(s)) incoming mail file `%s'? " diff bfile))
595 Deleting old (> %s day(s)) incoming mail file `%s'." diff bfile)
597 (delete-file ffile))))))
599 (defun mail-source-callback (callback info)
600 "Call CALLBACK on the mail file. Pass INFO on to CALLBACK."
601 (if (or (not (file-exists-p mail-source-crash-box))
602 (zerop (nth 7 (file-attributes mail-source-crash-box))))
604 (when (file-exists-p mail-source-crash-box)
605 (delete-file mail-source-crash-box))
607 (funcall callback mail-source-crash-box info)))
609 (defun mail-source-delete-crash-box ()
610 (when (file-exists-p mail-source-crash-box)
611 ;; Delete or move the incoming mail out of the way.
612 (if (eq mail-source-delete-incoming t)
613 (delete-file mail-source-crash-box)
617 mail-source-incoming-file-prefix
618 mail-source-directory))))
619 (unless (file-exists-p (file-name-directory incoming))
620 (make-directory (file-name-directory incoming) t))
621 (rename-file mail-source-crash-box incoming t)
622 ;; remove old incoming files?
623 (when (natnump mail-source-delete-incoming)
624 (mail-source-delete-old-incoming
625 mail-source-delete-incoming
626 mail-source-delete-old-incoming-confirm))))))
628 (defun mail-source-movemail (from to)
629 "Move FROM to TO using movemail."
630 (if (not (file-writable-p to))
631 (error "Can't write to crash box %s. Not moving mail" to)
632 (let ((to (file-truename (expand-file-name to)))
634 (setq to (file-truename to)
635 from (file-truename from))
636 ;; Set TO if have not already done so, and rename or copy
637 ;; the file FROM to TO if and as appropriate.
640 ;; The crash box exists already.
642 ((not (file-exists-p from))
643 ;; There is no inbox.
645 ((zerop (nth 7 (file-attributes from)))
649 ;; If getting from mail spool directory, use movemail to move
650 ;; rather than just renaming, so as to interlock with the
654 (setq errors (generate-new-buffer " *mail source loss*"))
655 (let ((default-directory "/"))
661 (or mail-source-movemail-program
662 (expand-file-name "movemail" exec-directory))
663 nil errors nil from to)))))
664 (when (file-exists-p to)
665 (set-file-modes to mail-source-default-file-modes))
666 (if (and (or (not (buffer-modified-p errors))
667 (zerop (buffer-size errors)))
668 (and (numberp result)
670 ;; No output => movemail won.
673 ;; There may be a warning about older revisions. We
675 (goto-char (point-min))
676 (if (search-forward "older revision" nil t)
678 ;; Probably a real error.
679 (subst-char-in-region (point-min) (point-max) ?\n ?\ )
680 (goto-char (point-max))
681 (skip-chars-backward " \t")
682 (delete-region (point) (point-max))
683 (goto-char (point-min))
684 (when (looking-at "movemail: ")
685 (delete-region (point-min) (match-end 0)))
686 ;; Result may be a signal description string.
688 (format "movemail: %s (%s return). Continue? "
689 (buffer-string) result))
690 (error "%s" (buffer-string)))
693 (buffer-name errors))
694 (kill-buffer errors))
695 ;; Return whether we moved successfully or not.
698 (defun mail-source-movemail-and-remove (from to)
699 "Move FROM to TO using movemail, then remove FROM if empty."
700 (or (not (mail-source-movemail from to))
701 (not (zerop (nth 7 (file-attributes from))))
704 (defun mail-source-fetch-with-program (program)
705 (eq 0 (call-process shell-file-name nil nil nil
706 shell-command-switch program)))
708 (defun mail-source-run-script (script spec &optional delay)
710 (if (functionp script)
712 (mail-source-call-script
713 (format-spec script spec))))
717 (defun mail-source-call-script (script)
718 (let ((background nil)
719 (stderr (get-buffer-create " *mail-source-stderr*"))
721 (when (string-match "& *$" script)
722 (setq script (substring script 0 (match-beginning 0))
725 (call-process shell-file-name nil background nil
726 shell-command-switch script))
728 (not (zerop result)))
730 (message "Mail source error: %s" (buffer-string)))
731 (kill-buffer stderr)))
734 ;;; Different fetchers
737 (defun mail-source-fetch-file (source callback)
738 "Fetcher for single-file sources."
739 (mail-source-bind (file source)
740 (mail-source-run-script
741 prescript (format-spec-make ?t mail-source-crash-box)
743 (let ((mail-source-string (format "file:%s" path)))
744 (if (mail-source-movemail path mail-source-crash-box)
746 (mail-source-callback callback path)
747 (mail-source-run-script
748 postscript (format-spec-make ?t mail-source-crash-box))
749 (mail-source-delete-crash-box))
752 (defun mail-source-fetch-directory (source callback)
753 "Fetcher for directory sources."
754 (mail-source-bind (directory source)
755 (mail-source-run-script
756 prescript (format-spec-make ?t path) prescript-delay)
758 (mail-source-string (format "directory:%s" path)))
759 (dolist (file (directory-files
760 path t (concat (regexp-quote suffix) "$")))
761 (when (and (file-regular-p file)
762 (funcall predicate file)
763 (mail-source-movemail file mail-source-crash-box))
764 (incf found (mail-source-callback callback file))
765 (mail-source-run-script postscript (format-spec-make ?t path))
766 (mail-source-delete-crash-box)))
769 (defun mail-source-fetch-pop (source callback)
770 "Fetcher for single-file sources."
771 (mail-source-bind (pop source)
772 ;; fixme: deal with stream type in format specs
773 (mail-source-run-script
775 (format-spec-make ?p password ?t mail-source-crash-box
776 ?s server ?P port ?u user)
778 (let ((from (format "%s:%s:%s" server user port))
779 (mail-source-string (format "pop:%s@%s" user server))
781 (when (eq authentication 'password)
784 (cdr (assoc from mail-source-password-cache))
786 (format "Password for %s at %s: " user server)))))
788 (setenv "MAILHOST" server))
792 (mail-source-fetch-with-program