1 ;;; mail-source.el --- functions for fetching mail
2 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;; Keywords: news, mail
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
31 (eval-when-compile (defvar display-time-mail-function)))
33 (autoload 'pop3-movemail "pop3")
34 (autoload 'pop3-get-message-count "pop3")
35 (autoload 'nnheader-cancel-timer "nnheader")
36 (autoload 'nnheader-run-at-time "nnheader"))
37 (require 'format-spec)
39 (require 'message) ;; for `message-directory'
41 (defgroup mail-source nil
42 "The mail-fetching library."
46 ;; Define these at compile time to avoid dragging in imap always.
47 (defconst mail-source-imap-authenticators
50 (list 'const (car a)))
51 imap-authenticator-alist)))
52 (defconst mail-source-imap-streams
55 (list 'const (car a)))
58 (defcustom mail-sources nil
59 "*Where the mail backends will look for incoming mail.
60 This variable is a list of mail source specifiers.
61 See Info node `(gnus)Mail Source Specifiers'."
63 :link '(custom-manual "(gnus)Mail Source Specifiers")
65 (choice :format "%[Value Menu%] %v"
67 (cons :tag "Spool file"
68 (const :format "" file)
69 (checklist :tag "Options" :greedy t
71 (const :format "" :value :path)
73 (cons :tag "Several files in a directory"
74 (const :format "" directory)
75 (checklist :tag "Options" :greedy t
77 (const :format "" :value :path)
78 (directory :tag "Path"))
80 (const :format "" :value :suffix)
81 (string :tag "Suffix"))
83 (const :format "" :value :predicate)
84 (function :tag "Predicate"))
86 (const :format "" :value :prescript)
87 (choice :tag "Prescript"
90 (function :format "%v")))
92 (const :format "" :value :postscript)
93 (choice :tag "Postscript"
96 (function :format "%v")))
98 (const :format "" :value :plugged)
99 (boolean :tag "Plugged"))))
100 (cons :tag "POP3 server"
101 (const :format "" pop)
102 (checklist :tag "Options" :greedy t
104 (const :format "" :value :server)
105 (string :tag "Server"))
107 (const :format "" :value :port)
110 (number :format "%v")
111 (string :format "%v")))
113 (const :format "" :value :user)
114 (string :tag "User"))
116 (const :format "" :value :password)
117 (string :tag "Password"))
119 (const :format "" :value :program)
120 (string :tag "Program"))
122 (const :format "" :value :prescript)
123 (choice :tag "Prescript"
125 (string :format "%v")
126 (function :format "%v")))
128 (const :format "" :value :postscript)
129 (choice :tag "Postscript"
131 (string :format "%v")
132 (function :format "%v")))
134 (const :format "" :value :function)
135 (function :tag "Function"))
138 :value :authentication)
139 (choice :tag "Authentication"
144 (const :format "" :value :plugged)
145 (boolean :tag "Plugged"))))
146 (cons :tag "Maildir (qmail, postfix...)"
147 (const :format "" maildir)
148 (checklist :tag "Options" :greedy t
150 (const :format "" :value :path)
151 (directory :tag "Path"))
153 (const :format "" :value :plugged)
154 (boolean :tag "Plugged"))))
155 (cons :tag "IMAP server"
156 (const :format "" imap)
157 (checklist :tag "Options" :greedy t
159 (const :format "" :value :server)
160 (string :tag "Server"))
162 (const :format "" :value :port)
167 (const :format "" :value :user)
168 (string :tag "User"))
170 (const :format "" :value :password)
171 (string :tag "Password"))
173 (const :format "" :value :stream)
174 (choice :tag "Stream"
176 ,@mail-source-imap-streams))
178 (const :format "" :value :program)
179 (string :tag "Program"))
182 :value :authenticator)
183 (choice :tag "Authenticator"
185 ,@mail-source-imap-authenticators))
187 (const :format "" :value :mailbox)
188 (string :tag "Mailbox"
191 (const :format "" :value :predicate)
192 (string :tag "Predicate"
193 :value "UNSEEN UNDELETED"))
195 (const :format "" :value :fetchflag)
196 (string :tag "Fetchflag"
201 (boolean :tag "Dontexpunge"))
203 (const :format "" :value :plugged)
204 (boolean :tag "Plugged"))))
205 (cons :tag "Webmail server"
206 (const :format "" webmail)
207 (checklist :tag "Options" :greedy t
209 (const :format "" :value :subtype)
210 ;; Should be generated from
211 ;; `webmail-type-definition', but we
212 ;; can't require webmail without W3.
213 (choice :tag "Subtype"
221 (const :format "" :value :user)
222 (string :tag "User"))
224 (const :format "" :value :password)
225 (string :tag "Password"))
229 (boolean :tag "Dontexpunge"))
231 (const :format "" :value :plugged)
232 (boolean :tag "Plugged")))))))
234 (defcustom mail-source-ignore-errors nil
235 "*Ignore errors when querying mail sources.
236 If nil, the user will be prompted when an error occurs. If non-nil,
237 the error will be ignored.")
239 (defcustom mail-source-primary-source nil
240 "*Primary source for incoming mail.
241 If non-nil, this maildrop will be checked periodically for new mail."
245 (defcustom mail-source-flash t
246 "*If non-nil, flash periodically when mail is available."
250 (defcustom mail-source-crash-box "~/.emacs-mail-crash-box"
251 "File where mail will be stored while processing it."
255 (defcustom mail-source-directory message-directory
256 "Directory where files (if any) will be stored."
260 (defcustom mail-source-default-file-modes 384
261 "Set the mode bits of all new mail files to this integer."
265 (defcustom mail-source-delete-incoming nil
266 "*If non-nil, delete incoming files after handling.
267 If t, delete immediately, if nil, never delete. If a positive number, delete
268 files older than number of days."
269 ;; Note: The removing happens in `mail-source-callback', i.e. no old
270 ;; incoming files will be deleted, unless you receive new mail.
272 ;; You may also set this to `nil' and call `mail-source-delete-old-incoming'
273 ;; from a hook or interactively.
275 :type '(choice (const :tag "immediately" t)
276 (const :tag "never" nil)
277 (integer :tag "days")))
279 (defcustom mail-source-delete-old-incoming-confirm t
280 "*If non-nil, ask for for confirmation before deleting old incoming files.
281 This variable only applies when `mail-source-delete-incoming' is a positive
286 (defcustom mail-source-incoming-file-prefix "Incoming"
287 "Prefix for file name for storing incoming mail"
291 (defcustom mail-source-report-new-mail-interval 5
292 "Interval in minutes between checks for new mail."
296 (defcustom mail-source-idle-time-delay 5
297 "Number of idle seconds to wait before checking for new mail."
301 (defcustom mail-source-movemail-program nil
302 "If non-nil, name of program for fetching new mail."
304 :type '(choice (const nil) string))
306 ;;; Internal variables.
308 (defvar mail-source-string ""
309 "A dynamically bound string that says what the current mail source is.")
311 (defvar mail-source-new-mail-available nil
312 "Flag indicating when new mail is available.")
315 (defvar mail-source-common-keyword-map
317 "Mapping from keywords to default values.
318 Common keywords should be listed here.")
320 (defvar mail-source-keyword-map
325 (:path (or (getenv "MAIL")
326 (expand-file-name (user-login-name) rmail-spool-directory))))
333 (:predicate identity))
338 (:server (getenv "MAILHOST"))
340 (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
344 (:authentication password))
346 (:path (or (getenv "MAILDIR") "~/Maildir/"))
347 (:subdirs ("new" "cur"))
350 (:server (getenv "MAILHOST"))
355 (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
358 (:predicate "UNSEEN UNDELETED")
359 (:fetchflag "\\Deleted")
363 (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
366 (:authentication password)))
367 "Mapping from keywords to default values.
368 All keywords that can be used must be listed here."))
370 (defvar mail-source-fetcher-alist
371 '((file mail-source-fetch-file)
372 (directory mail-source-fetch-directory)
373 (pop mail-source-fetch-pop)
374 (maildir mail-source-fetch-maildir)
375 (imap mail-source-fetch-imap)
376 (webmail mail-source-fetch-webmail))
377 "A mapping from source type to fetcher function.")
379 (defvar mail-source-password-cache nil)
381 (defvar mail-source-plugged t)
386 (defun mail-source-strip-keyword (keyword)
387 "Strip the leading colon off the KEYWORD."
388 (intern (substring (symbol-name keyword) 1))))
391 (defun mail-source-bind-1 (type)
392 (let* ((defaults (cdr (assq type mail-source-keyword-map)))
394 (while (setq default (pop defaults))
395 (push (list (mail-source-strip-keyword (car default))
400 (defmacro mail-source-bind (type-source &rest body)
401 "Return a `let' form that binds all variables in source TYPE.
402 TYPE-SOURCE is a list where the first element is the TYPE, and
403 the second variable is the SOURCE.
404 At run time, the mail source specifier SOURCE will be inspected,
405 and the variables will be set according to it. Variables not
406 specified will be given default values.
408 After this is done, BODY will be executed in the scope
411 The variables bound and their default values are described by
412 the `mail-source-keyword-map' variable."
413 `(let ,(mail-source-bind-1 (car type-source))
414 (mail-source-set-1 ,(cadr type-source))
417 (put 'mail-source-bind 'lisp-indent-function 1)
418 (put 'mail-source-bind 'edebug-form-spec '(sexp body))
420 (defun mail-source-set-1 (source)
421 (let* ((type (pop source))
422 (defaults (cdr (assq type mail-source-keyword-map)))
423 default value keyword)
424 (while (setq default (pop defaults))
425 (set (mail-source-strip-keyword (setq keyword (car default)))
426 (if (setq value (plist-get source keyword))
427 (mail-source-value value)
428 (mail-source-value (cadr default)))))))
431 (defun mail-source-bind-common-1 ()
432 (let* ((defaults mail-source-common-keyword-map)
434 (while (setq default (pop defaults))
435 (push (list (mail-source-strip-keyword (car default))
440 (defun mail-source-set-common-1 (source)
441 (let* ((type (pop source))
442 (defaults mail-source-common-keyword-map)
443 (defaults-1 (cdr (assq type mail-source-keyword-map)))
444 default value keyword)
445 (while (setq default (pop defaults))
446 (set (mail-source-strip-keyword (setq keyword (car default)))
447 (if (setq value (plist-get source keyword))
448 (mail-source-value value)
449 (if (setq value (assq keyword defaults-1))
450 (mail-source-value (cadr value))
451 (mail-source-value (cadr default))))))))
453 (defmacro mail-source-bind-common (source &rest body)
454 "Return a `let' form that binds all common variables.
455 See `mail-source-bind'."
456 `(let ,(mail-source-bind-common-1)
457 (mail-source-set-common-1 source)
460 (put 'mail-source-bind-common 'lisp-indent-function 1)
461 (put 'mail-source-bind-common 'edebug-form-spec '(sexp body))
463 (defun mail-source-value (value)
464 "Return the value of VALUE."
471 (functionp (car value)))
473 ;; Just return the value.
477 (defun mail-source-fetch (source callback)
478 "Fetch mail from SOURCE and call CALLBACK zero or more times.
479 CALLBACK will be called with the name of the file where (some of)
480 the mail from SOURCE is put.
481 Return the number of files that were found."
482 (mail-source-bind-common source
483 (if (or mail-source-plugged plugged)
485 (let ((function (cadr (assq (car source) mail-source-fetcher-alist)))
488 (error "%S is an invalid mail source specification" source))
489 ;; If there's anything in the crash box, we do it first.
490 (when (file-exists-p mail-source-crash-box)
491 (message "Processing mail from %s..." mail-source-crash-box)
492 (setq found (mail-source-callback
493 callback mail-source-crash-box)))
495 (if (or debug-on-quit debug-on-error)
496 (funcall function source callback)
498 (funcall function source callback)
500 (if (and (not mail-source-ignore-errors)
503 (format "Mail source %s error (%s). Continue? "
504 (if (memq ':password source)
505 (let ((s (copy-sequence source)))
506 (setcar (cdr (memq ':password s))
511 (error "Cannot get new mail"))
515 (if (fboundp 'make-temp-file)
516 (defalias 'mail-source-make-complex-temp-name 'make-temp-file)
517 (defun mail-source-make-complex-temp-name (prefix)
518 (let ((newname (make-temp-name prefix))
520 (while (file-exists-p newname)
521 (setq newprefix (concat newprefix "x"))
522 (setq newname (make-temp-name newprefix)))
525 (defun mail-source-delete-old-incoming (&optional age confirm)
526 "Remove incoming files older than AGE days.
527 If CONFIRM is non-nil, ask for confirmation before removing a file."
529 (let* ((high2days (/ 65536.0 60 60 24));; convert high bits to days
530 (low2days (/ 1.0 65536.0)) ;; convert low bits to days
531 (diff (if (natnump age) age 30));; fallback, if no valid AGE given
533 (setq files (directory-files
534 mail-source-directory t
535 (concat mail-source-incoming-file-prefix "*"))
536 currday (* (car (current-time)) high2days)
537 currday (+ currday (* low2days (nth 1 (current-time)))))
539 (let* ((ffile (car files))
540 (bfile (gnus-replace-in-string
541 ffile "\\`.*/\\([^/]+\\)\\'" "\\1"))
542 (filetime (nth 5 (file-attributes ffile)))
543 (fileday (* (car filetime) high2days))
544 (fileday (+ fileday (* low2days (nth 1 filetime)))))
545 (setq files (cdr files))
546 (when (and (> (- currday fileday) diff)
547 (gnus-message 8 "File `%s' is older than %s day(s)"
550 (y-or-n-p (concat "Remove file `" bfile "'? "))))
551 (delete-file ffile))))))
553 (defun mail-source-callback (callback info)
554 "Call CALLBACK on the mail file, and then remove the mail file.
555 Pass INFO on to CALLBACK."
556 (if (or (not (file-exists-p mail-source-crash-box))
557 (zerop (nth 7 (file-attributes mail-source-crash-box))))
559 (when (file-exists-p mail-source-crash-box)
560 (delete-file mail-source-crash-box))
563 (funcall callback mail-source-crash-box info)
564 (when (file-exists-p mail-source-crash-box)
565 ;; Delete or move the incoming mail out of the way.
566 (if (eq mail-source-delete-incoming t)
567 (delete-file mail-source-crash-box)
569 (mail-source-make-complex-temp-name
571 mail-source-incoming-file-prefix
572 mail-source-directory))))
573 (unless (file-exists-p (file-name-directory incoming))
574 (make-directory (file-name-directory incoming) t))
575 (rename-file mail-source-crash-box incoming t)
576 ;; remove old incoming files?
577 (when (natnump mail-source-delete-incoming)
578 (mail-source-delete-old-incoming
579 mail-source-delete-incoming
580 mail-source-delete-old-incoming-confirm))))))))
582 (defun mail-source-movemail (from to)
583 "Move FROM to TO using movemail."
584 (if (not (file-writable-p to))
585 (error "Can't write to crash box %s. Not moving mail" to)
586 (let ((to (file-truename (expand-file-name to)))
588 (setq to (file-truename to)
589 from (file-truename from))
590 ;; Set TO if have not already done so, and rename or copy
591 ;; the file FROM to TO if and as appropriate.
594 ;; The crash box exists already.
596 ((not (file-exists-p from))
597 ;; There is no inbox.
599 ((zerop (nth 7 (file-attributes from)))
603 ;; If getting from mail spool directory, use movemail to move
604 ;; rather than just renaming, so as to interlock with the
608 (setq errors (generate-new-buffer " *mail source loss*"))
609 (let ((default-directory "/"))
615 (or mail-source-movemail-program
616 (expand-file-name "movemail" exec-directory))
617 nil errors nil from to)))))
618 (when (file-exists-p to)
619 (set-file-modes to mail-source-default-file-modes))
620 (if (and (or (not (buffer-modified-p errors))
621 (zerop (buffer-size errors)))
623 ;; No output => movemail won.
626 ;; There may be a warning about older revisions. We
628 (goto-char (point-min))
629 (if (search-forward "older revision" nil t)
631 ;; Probably a real error.
632 (subst-char-in-region (point-min) (point-max) ?\n ?\ )
633 (goto-char (point-max))
634 (skip-chars-backward " \t")
635 (delete-region (point) (point-max))
636 (goto-char (point-min))
637 (when (looking-at "movemail: ")
638 (delete-region (point-min) (match-end 0)))
639 ;; Result may be a signal description string.
641 (format "movemail: %s (%s return). Continue? "
642 (buffer-string) result))
643 (error "%s" (buffer-string)))
646 (buffer-name errors))
647 (kill-buffer errors))
648 ;; Return whether we moved successfully or not.
651 (defun mail-source-movemail-and-remove (from to)
652 "Move FROM to TO using movemail, then remove FROM if empty."
653 (or (not (mail-source-movemail from to))
654 (not (zerop (nth 7 (file-attributes from))))
657 (defun mail-source-fetch-with-program (program)
658 (zerop (call-process shell-file-name nil nil nil
659 shell-command-switch program)))
661 (defun mail-source-run-script (script spec &optional delay)
663 (if (functionp script)
665 (mail-source-call-script
666 (format-spec script spec))))
670 (defun mail-source-call-script (script)
671 (let ((background nil))
672 (when (string-match "& *$" script)
673 (setq script (substring script 0 (match-beginning 0))
675 (call-process shell-file-name nil background nil
676 shell-command-switch script)))
679 ;;; Different fetchers
682 (defun mail-source-fetch-file (source callback)
683 "Fetcher for single-file sources."
684 (mail-source-bind (file source)
685 (mail-source-run-script
686 prescript (format-spec-make ?t mail-source-crash-box)
688 (let ((mail-source-string (format "file:%s" path)))
689 (if (mail-source-movemail path mail-source-crash-box)
691 (mail-source-callback callback path)
692 (mail-source-run-script
693 postscript (format-spec-make ?t mail-source-crash-box)))
696 (defun mail-source-fetch-directory (source callback)
697 "Fetcher for directory sources."
698 (mail-source-bind (directory source)
699 (mail-source-run-script
700 prescript (format-spec-make ?t path) prescript-delay)
702 (mail-source-string (format "directory:%s" path)))
703 (dolist (file (directory-files
704 path t (concat (regexp-quote suffix) "$")))
705 (when (and (file-regular-p file)
706 (funcall predicate file)
707 (mail-source-movemail file mail-source-crash-box))
708 (incf found (mail-source-callback callback file))))
709 (mail-source-run-script postscript (format-spec-make ?t path))
712 (defun mail-source-fetch-pop (source callback)
713 "Fetcher for single-file sources."
714 (mail-source-bind (pop source)
715 (mail-source-run-script
717 (format-spec-make ?p password ?t mail-source-crash-box
718 ?s server ?P port ?u user)
720 (let ((from (format "%s:%s:%s" server user port))
721 (mail-source-string (format "pop:%s@%s" user server))
723 (when (eq authentication 'password)
726 (cdr (assoc from mail-source-password-cache))
728 (format "Password for %s at %s: " user server)))))
730 (setenv "MAILHOST" server))
734 (mail-source-fetch-with-program
737 (format-spec-make ?p password ?t mail-source-crash-box
738 ?s server ?P port ?u user))))
740 (funcall function mail-source-crash-box))
741 ;; The default is to use pop3.el.
743 (let ((pop3-password password)
745 (pop3-mailhost server)
747 (pop3-authentication-scheme
748 (if (eq authentication 'apop) 'apop 'pass)))
749 (if (or debug-on-quit debug-on-error)
750 (save-excursion (pop3-movemail mail-source-crash-box))
752 (save-excursion (pop3-movemail mail-source-crash-box))
754 ;; We nix out the password in case the error
755 ;; was because of a wrong password being given.
756 (setq mail-source-password-cache
757 (delq (assoc from mail-source-password-cache)
758 mail-source-password-cache))
759 (signal (car err) (cdr err)))))))))
762 (when (eq authentication 'password)
763 (unless (assoc from mail-source-password-cache)
764 (push (cons from password) mail-source-password-cache)))
766 (mail-source-callback callback server)
767 ;; Update display-time's mail flag, if relevant.
768 (if (equal source mail-source-primary-source)
769 (setq mail-source-new-mail-available nil))
770 (mail-source-run-script
772 (format-spec-make ?p password ?t mail-source-crash-box
773 ?s server ?P port ?u user))))
774 ;; We nix out the password in case the error
775 ;; was because of a wrong password being given.
776 (setq mail-source-password-cache
777 (delq (assoc from mail-source-password-cache)
778 mail-source-password-cache))
781 (defun mail-source-check-pop (source)
782 "Check whether there is new mail."
783 (mail-source-bind (pop source)
784 (let ((from (format "%s:%s:%s" server user port))
785 (mail-source-string (format "pop:%s@%s" user server))
787 (when (eq authentication 'password)
790 (cdr (assoc from mail-source-password-cache))
792 (format "Password for %s at %s: " user server))))
793 (unless (assoc from mail-source-password-cache)
794 (push (cons from password) mail-source-password-cache)))
796 (setenv "MAILHOST" server))
799 ;; No easy way to check whether mail is waiting for these.
802 ;; The default is to use pop3.el.
804 (let ((pop3-password password)
806 (pop3-mailhost server)
808 (pop3-authentication-scheme
809 (if (eq authentication 'apop) 'apop 'pass)))
810 (if (or debug-on-quit debug-on-error)
811 (save-excursion (pop3-get-message-count))
813 (save-excursion (pop3-get-message-count))
815 ;; We nix out the password in case the error
816 ;; was because of a wrong password being given.
817 (setq mail-source-password-cache
818 (delq (assoc from mail-source-password-cache)
819 mail-source-password-cache))
820 (signal (car err) (cdr err)))))))))
822 ;; Inform display-time that we have new mail.
823 (setq mail-source-new-mail-available (> result 0))
824 ;; We nix out the password in case the error
825 ;; was because of a wrong password being given.
826 (setq mail-source-password-cache
827 (delq (assoc from mail-source-password-cache)
828 mail-source-password-cache)))
831 (defun mail-source-touch-pop ()
832 "Open and close a POP connection shortly.
833 POP server should be defined in `mail-source-primary-source' (which is
834 preferred) or `mail-sources'. You may use it for the POP-before-SMTP
835 authentication. To do that, you need to set the option
836 `message-send-mail-function' to `message-smtpmail-send-it' and put the
837 following line in .gnus file:
839 \(add-hook 'message-send-mail-hook 'mail-source-touch-pop)
841 (let ((sources (if mail-source-primary-source
842 (list mail-source-primary-source)
845 (if (eq 'pop (car (car sources)))
846 (mail-source-check-pop (car sources)))
847 (setq sources (cdr sources)))))
849 (defun mail-source-new-mail-p ()
850 "Handler for `display-time' to indicate when new mail is available."
851 ;; Flash (ie. ring the visible bell) if mail is available.
852 (if (and mail-source-flash mail-source-new-mail-available)
853 (let ((visible-bell t))
855 ;; Only report flag setting; flag is updated on a different schedule.
856 mail-source-new-mail-available)
859 (defvar mail-source-report-new-mail nil)
860 (defvar mail-source-report-new-mail-timer nil)
861 (defvar mail-source-report-new-mail-idle-timer nil)
864 (if (featurep 'xemacs)
868 (defun mail-source-start-idle-timer ()
869 ;; Start our idle timer if necessary, so we delay the check until the
870 ;; user isn't typing.
871 (unless mail-source-report-new-mail-idle-timer
872 (setq mail-source-report-new-mail-idle-timer
874 mail-source-idle-time-delay
878 (mail-source-check-pop mail-source-primary-source)
879 (setq mail-source-report-new-mail-idle-timer nil)))))
880 ;; Since idle timers created when Emacs is already in the idle
881 ;; state don't get activated until Emacs _next_ becomes idle, we
882 ;; need to force our timer to be considered active now. We do
883 ;; this by being naughty and poking the timer internals directly
884 ;; (element 0 of the vector is nil if the timer is active).
885 (aset mail-source-report-new-mail-idle-timer 0 nil)))
887 (defun mail-source-report-new-mail (arg)
888 "Toggle whether to report when new mail is available.
889 This only works when `display-time' is enabled."
891 (if (not mail-source-primary-source)
892 (error "Need to set `mail-source-primary-source' to check for new mail"))
893 (let ((on (if (null arg)
894 (not mail-source-report-new-mail)
895 (> (prefix-numeric-value arg) 0))))
896 (setq mail-source-report-new-mail on)
897 (and mail-source-report-new-mail-timer
898 (nnheader-cancel-timer mail-source-report-new-mail-timer))
899 (and mail-source-report-new-mail-idle-timer
900 (nnheader-cancel-timer mail-source-report-new-mail-idle-timer))
901 (setq mail-source-report-new-mail-timer nil)
902 (setq mail-source-report-new-mail-idle-timer nil)
906 ;; display-time-mail-function is an Emacs 21 feature.
907 (setq display-time-mail-function #'mail-source-new-mail-p)
908 ;; Set up the main timer.
909 (setq mail-source-report-new-mail-timer
910 (nnheader-run-at-time
911 (* 60 mail-source-report-new-mail-interval)
912 (* 60 mail-source-report-new-mail-interval)
913 #'mail-source-start-idle-timer))
914 ;; When you get new mail, clear "Mail" from the mode line.
915 (add-hook 'nnmail-post-get-new-mail-hook
916 'display-time-event-handler)
917 (message "Mail check enabled"))
918 (setq display-time-mail-function nil)
919 (remove-hook 'nnmail-post-get-new-mail-hook
920 'display-time-event-handler)
921 (message "Mail check disabled"))))
923 (defun mail-source-fetch-maildir (source callback)
924 "Fetcher for maildir sources."
925 (mail-source-bind (maildir source)
928 (unless (string-match "/$" path)
929 (setq path (concat path "/")))
930 (dolist (subdir subdirs)
931 (when (file-directory-p (concat path subdir))
932 (setq mail-source-string (format "maildir:%s%s" path subdir))
933 (dolist (file (directory-files (concat path subdir) t))
934 (when (and (not (file-directory-p file))
936 (funcall function file mail-source-crash-box)
937 (let ((coding-system-for-write
938 mm-text-coding-system)
939 (coding-system-for-read
940 mm-text-coding-system))
941 (with-temp-file mail-source-crash-box
942 (insert-file-contents file)
943 (goto-char (point-min))
944 ;;; ;; Unix mail format
945 ;;; (unless (looking-at "\n*From ")
946 ;;; (insert "From maildir "
947 ;;; (current-time-string) "\n"))
948 ;;; (while (re-search-forward "^From " nil t)
949 ;;; (replace-match ">From "))
950 ;;; (goto-char (point-max))
953 (insert "\001\001\001\001\n"))
954 (delete-file file)))))
955 (incf found (mail-source-callback callback file))))))
959 (autoload 'imap-open "imap")
960 (autoload 'imap-authenticate "imap")
961 (autoload 'imap-mailbox-select "imap")
962 (autoload 'imap-mailbox-unselect "imap")
963 (autoload 'imap-mailbox-close "imap")
964 (autoload 'imap-search "imap")
965 (autoload 'imap-fetch "imap")
966 (autoload 'imap-close "imap")
967 (autoload 'imap-error-text "imap")
968 (autoload 'imap-message-flags-add "imap")
969 (autoload 'imap-list-to-message-set "imap")
970 (autoload 'imap-range-to-message-set "imap")
971 (autoload 'nnheader-ms-strip-cr "nnheader"))
973 (defvar mail-source-imap-file-coding-system 'binary
974 "Coding system for the crashbox made by `mail-source-fetch-imap'.")
976 (defun mail-source-fetch-imap (source callback)
977 "Fetcher for imap sources."
978 (mail-source-bind (imap source)
979 (let* ((from (format "%s:%s:%s" server user port))
981 (buffer-name " *imap source*")
982 (buf (get-buffer-create (generate-new-buffer-name buffer-name)))
983 (mail-source-string (format "imap:%s:%s" server mailbox))
984 (imap-shell-program (or (list program) imap-shell-program))
986 (if (and (imap-open server port stream authentication buffer-name)
988 user (or (cdr (assoc from mail-source-password-cache))
990 (imap-mailbox-select mailbox nil buf))
991 (let ((coding-system-for-write mail-source-imap-file-coding-system)
993 (with-temp-file mail-source-crash-box
994 ;; Avoid converting 8-bit chars from inserted strings to
996 (mm-disable-multibyte)
998 (with-current-buffer buf
999 (when (or imap-password
1000 (assoc from mail-source-password-cache))
1001 (push (cons from imap-password) mail-source-password-cache)))
1002 ;; if predicate is nil, use all uids
1003 (dolist (uid (imap-search (or predicate "1:*") buf))
1005 (if (imap-capability 'IMAP4rev1 buf)
1006 (caddar (imap-fetch uid "BODY.PEEK[]"
1007 'BODYDETAIL nil buf))
1008 (imap-fetch uid "RFC822.PEEK" 'RFC822 nil buf)))
1010 (insert "From imap " (current-time-string) "\n")
1012 (insert str "\n\n"))
1013 (while (re-search-forward "^From " nil t)
1014 (replace-match ">From "))
1015 (goto-char (point-max))))
1016 (nnheader-ms-strip-cr))
1017 (incf found (mail-source-callback callback server))
1018 (when (and remove fetchflag)
1019 (imap-message-flags-add
1020 (imap-range-to-message-set (gnus-compress-sequence remove))
1023 (imap-mailbox-unselect buf)
1024 (imap-mailbox-close nil buf))
1027 ;; We nix out the password in case the error
1028 ;; was because of a wrong password being given.
1029 (setq mail-source-password-cache
1030 (delq (assoc from mail-source-password-cache)
1031 mail-source-password-cache))
1032 (error (imap-error-text buf)))
1037 (autoload 'webmail-fetch "webmail"))
1039 (defun mail-source-fetch-webmail (source callback)
1040 "Fetch for webmail source."
1041 (mail-source-bind (webmail source)
1042 (let ((mail-source-string (format "webmail:%s:%s" subtype user))
1043 (webmail-newmail-only dontexpunge)
1044 (webmail-move-to-trash-can (not dontexpunge)))
1045 (when (eq authentication 'password)
1048 (cdr (assoc (format "webmail:%s:%s" subtype user)
1049 mail-source-password-cache))
1051 (format "Password for %s at %s: " user subtype))))
1053 (not (assoc (format "webmail:%s:%s" subtype user)
1054 mail-source-password-cache)))
1055 (push (cons (format "webmail:%s:%s" subtype user) password)
1056 mail-source-password-cache)))
1057 (webmail-fetch mail-source-crash-box subtype user password)
1058 (mail-source-callback callback (symbol-name subtype)))))
1060 (provide 'mail-source)
1062 ;;; mail-source.el ends here