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))
456 (auth-source-user-or-password
458 server ; this is "host" in auth-sources
460 (when (boundp 'user) (symbol-value 'user))))
463 (auth-source-user-or-password
465 server ; this is "host" in auth-sources
467 (when (boundp 'user) (symbol-value 'user)))))
471 (unintern 'password))
474 (put 'mail-source-bind 'lisp-indent-function 1)
475 (put 'mail-source-bind 'edebug-form-spec '(sexp body))
477 (defun mail-source-set-1 (source)
478 (let* ((type (pop source))
479 (defaults (cdr (assq type mail-source-keyword-map)))
480 default value keyword)
481 (while (setq default (pop defaults))
482 ;; for each default :SYMBOL, set SYMBOL to the plist value for :SYMBOL
483 ;; using `mail-source-value' to evaluate the plist value
484 (set (mail-source-strip-keyword (setq keyword (car default)))
485 (if (setq value (plist-get source keyword))
486 (mail-source-value value)
487 (mail-source-value (cadr default)))))))
490 (defun mail-source-bind-common-1 ()
491 (let* ((defaults mail-source-common-keyword-map)
493 (while (setq default (pop defaults))
494 (push (list (mail-source-strip-keyword (car default))
499 (defun mail-source-set-common-1 (source)
500 (let* ((type (pop source))
501 (defaults mail-source-common-keyword-map)
502 (defaults-1 (cdr (assq type mail-source-keyword-map)))
503 default value keyword)
504 (while (setq default (pop defaults))
505 (set (mail-source-strip-keyword (setq keyword (car default)))
506 (if (setq value (plist-get source keyword))
507 (mail-source-value value)
508 (if (setq value (assq keyword defaults-1))
509 (mail-source-value (cadr value))
510 (mail-source-value (cadr default))))))))
512 (defmacro mail-source-bind-common (source &rest body)
513 "Return a `let' form that binds all common variables.
514 See `mail-source-bind'."
515 `(let ,(mail-source-bind-common-1)
516 (mail-source-set-common-1 source)
519 (put 'mail-source-bind-common 'lisp-indent-function 1)
520 (put 'mail-source-bind-common 'edebug-form-spec '(sexp body))
522 (defun mail-source-value (value)
523 "Return the value of VALUE."
529 ((and (listp value) (symbolp (car value)) (fboundp (car value)))
531 ;; Just return the value.
535 (defun mail-source-fetch (source callback)
536 "Fetch mail from SOURCE and call CALLBACK zero or more times.
537 CALLBACK will be called with the name of the file where (some of)
538 the mail from SOURCE is put.
539 Return the number of files that were found."
540 (mail-source-bind-common source
541 (if (or mail-source-plugged plugged)
543 (let ((function (cadr (assq (car source) mail-source-fetcher-alist)))
546 (error "%S is an invalid mail source specification" source))
547 ;; If there's anything in the crash box, we do it first.
548 (when (file-exists-p mail-source-crash-box)
549 (message "Processing mail from %s..." mail-source-crash-box)
550 (setq found (mail-source-callback
551 callback mail-source-crash-box))
552 (mail-source-delete-crash-box))
554 (if (or debug-on-quit debug-on-error)
555 (funcall function source callback)
557 (funcall function source callback)
559 (if (and (not mail-source-ignore-errors)
562 (format "Mail source %s error (%s). Continue? "
563 (if (memq ':password source)
564 (let ((s (copy-sequence source)))
565 (setcar (cdr (memq ':password s))
570 (error "Cannot get new mail"))
573 (defun mail-source-delete-old-incoming (&optional age confirm)
574 "Remove incoming files older than AGE days.
575 If CONFIRM is non-nil, ask for confirmation before removing a file."
577 (let* ((high2days (/ 65536.0 60 60 24));; convert high bits to days
578 (low2days (/ 1.0 65536.0)) ;; convert low bits to days
579 (diff (if (natnump age) age 30));; fallback, if no valid AGE given
581 (setq files (directory-files
582 mail-source-directory t
584 (regexp-quote mail-source-incoming-file-prefix)))
585 currday (* (car (current-time)) high2days)
586 currday (+ currday (* low2days (nth 1 (current-time)))))
588 (let* ((ffile (car files))
589 (bfile (gnus-replace-in-string
590 ffile "\\`.*/\\([^/]+\\)\\'" "\\1"))
591 (filetime (nth 5 (file-attributes ffile)))
592 (fileday (* (car filetime) high2days))
593 (fileday (+ fileday (* low2days (nth 1 filetime)))))
594 (setq files (cdr files))
595 (when (and (> (- currday fileday) diff)
599 Delete old (> %s day(s)) incoming mail file `%s'? " diff bfile))
601 Deleting old (> %s day(s)) incoming mail file `%s'." diff bfile)
603 (delete-file ffile))))))
605 (defun mail-source-callback (callback info)
606 "Call CALLBACK on the mail file. Pass INFO on to CALLBACK."
607 (if (or (not (file-exists-p mail-source-crash-box))
608 (zerop (nth 7 (file-attributes mail-source-crash-box))))
610 (when (file-exists-p mail-source-crash-box)
611 (delete-file mail-source-crash-box))
613 (funcall callback mail-source-crash-box info)))
615 (defun mail-source-delete-crash-box ()
616 (when (file-exists-p mail-source-crash-box)
617 ;; Delete or move the incoming mail out of the way.
618 (if (eq mail-source-delete-incoming t)
619 (delete-file mail-source-crash-box)
623 mail-source-incoming-file-prefix
624 mail-source-directory))))
625 (unless (file-exists-p (file-name-directory incoming))
626 (make-directory (file-name-directory incoming) t))
627 (rename-file mail-source-crash-box incoming t)
628 ;; remove old incoming files?
629 (when (natnump mail-source-delete-incoming)
630 (mail-source-delete-old-incoming
631 mail-source-delete-incoming
632 mail-source-delete-old-incoming-confirm))))))
634 (defun mail-source-movemail (from to)
635 "Move FROM to TO using movemail."
636 (if (not (file-writable-p to))
637 (error "Can't write to crash box %s. Not moving mail" to)
638 (let ((to (file-truename (expand-file-name to)))
640 (setq to (file-truename to)
641 from (file-truename from))
642 ;; Set TO if have not already done so, and rename or copy
643 ;; the file FROM to TO if and as appropriate.
646 ;; The crash box exists already.
648 ((not (file-exists-p from))
649 ;; There is no inbox.
651 ((zerop (nth 7 (file-attributes from)))
655 ;; If getting from mail spool directory, use movemail to move
656 ;; rather than just renaming, so as to interlock with the
660 (setq errors (generate-new-buffer " *mail source loss*"))
661 (let ((default-directory "/"))
667 (or mail-source-movemail-program
668 (expand-file-name "movemail" exec-directory))
669 nil errors nil from to)))))
670 (when (file-exists-p to)
671 (set-file-modes to mail-source-default-file-modes))
672 (if (and (or (not (buffer-modified-p errors))
673 (zerop (buffer-size errors)))
674 (and (numberp result)
676 ;; No output => movemail won.
679 ;; There may be a warning about older revisions. We
681 (goto-char (point-min))
682 (if (search-forward "older revision" nil t)
684 ;; Probably a real error.
685 (subst-char-in-region (point-min) (point-max) ?\n ?\ )
686 (goto-char (point-max))
687 (skip-chars-backward " \t")
688 (delete-region (point) (point-max))
689 (goto-char (point-min))
690 (when (looking-at "movemail: ")
691 (delete-region (point-min) (match-end 0)))
692 ;; Result may be a signal description string.
694 (format "movemail: %s (%s return). Continue? "
695 (buffer-string) result))
696 (error "%s" (buffer-string)))
699 (buffer-name errors))
700 (kill-buffer errors))
701 ;; Return whether we moved successfully or not.
704 (defun mail-source-movemail-and-remove (from to)
705 "Move FROM to TO using movemail, then remove FROM if empty."
706 (or (not (mail-source-movemail from to))
707 (not (zerop (nth 7 (file-attributes from))))
710 (defun mail-source-fetch-with-program (program)
711 (eq 0 (call-process shell-file-name nil nil nil
712 shell-command-switch program)))
714 (defun mail-source-run-script (script spec &optional delay)
716 (if (functionp script)
718 (mail-source-call-script
719 (format-spec script spec))))
723 (defun mail-source-call-script (script)
724 (let ((background nil)
725 (stderr (get-buffer-create " *mail-source-stderr*"))
727 (when (string-match "& *$" script)
728 (setq script (substring script 0 (match-beginning 0))
731 (call-process shell-file-name nil background nil
732 shell-command-switch script))
734 (not (zerop result)))
736 (message "Mail source error: %s" (buffer-string)))
737 (kill-buffer stderr)))
740 ;;; Different fetchers
743 (defun mail-source-fetch-file (source callback)
744 "Fetcher for single-file sources."
745 (mail-source-bind (file source)
746 (mail-source-run-script
747 prescript (format-spec-make ?t mail-source-crash-box)
749 (let ((mail-source-string (format "file:%s" path)))
750 (if (mail-source-movemail path mail-source-crash-box)
752 (mail-source-callback callback path)
753 (mail-source-run-script
754 postscript (format-spec-make ?t mail-source-crash-box))
755 (mail-source-delete-crash-box))
758 (defun mail-source-fetch-directory (source callback)
759 "Fetcher for directory sources."
760 (mail-source-bind (directory source)
761 (mail-source-run-script
762 prescript (format-spec-make ?t path) prescript-delay)
764 (mail-source-string (format "directory:%s" path)))
765 (dolist (file (directory-files
766 path t (concat (regexp-quote suffix) "$")))
767 (when (and (file-regular-p file)
768 (funcall predicate file)
769 (mail-source-movemail file mail-source-crash-box))
770 (incf found (mail-source-callback callback file))
771 (mail-source-run-script postscript (format-spec-make ?t path))
772 (mail-source-delete-crash-box)))
775 (defun mail-source-fetch-pop (source callback)
776 "Fetcher for single-file sources."
777 (mail-source-bind (pop source)
778 ;; fixme: deal with stream type in format specs
779 (mail-source-run-script
781 (format-spec-make ?p password ?t mail-source-crash-box
782 ?s server ?P port ?u user)
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)))))
794 (setenv "MAILHOST" server))
798 (mail-source-fetch-with-program
801 (format-spec-make ?p password ?t mail-source-crash-box
802 ?s server ?P port ?u user))))
804 (funcall function mail-source-crash-box))
805 ;; The default is to use pop3.el.
808 (let ((pop3-password password)
810 (pop3-mailhost server)
812 (pop3-authentication-scheme
813 (if (eq authentication 'apop) 'apop 'pass))
814 (pop3-stream-type stream))
815 (if (or debug-on-quit debug-on-error)
816 (save-excursion (pop3-movemail mail-source-crash-box))
818 (save-excursion (pop3-movemail mail-source-crash-box))
820 ;; We nix out the password in case the error
821 ;; was because of a wrong password being given.
822 (setq mail-source-password-cache
823 (delq (assoc from mail-source-password-cache)
824 mail-source-password-cache))
825 (signal (car err) (cdr err)))))))))
828 (when (eq authentication 'password)
829 (unless (assoc from mail-source-password-cache)
830 (push (cons from password) mail-source-password-cache)))
832 (mail-source-callback callback server)
833 ;; Update display-time's mail flag, if relevant.
834 (if (equal source mail-source-primary-source)
835 (setq mail-source-new-mail-available nil))
836 (mail-source-run-script
838 (format-spec-make ?p password ?t mail-source-crash-box
839 ?s server ?P port ?u user))
840 (mail-source-delete-crash-box)))
841 ;; We nix out the password in case the error
842 ;; was because of a wrong password being given.
843 (setq mail-source-password-cache
844 (delq (assoc from mail-source-password-cache)
845 mail-source-password-cache))
848 (defun mail-source-check-pop (source)
849 "Check whether there is new mail."
850 (mail-source-bind (pop source)
851 (let ((from (format "%s:%s:%s" server user port))
852 (mail-source-string (format "pop:%s@%s" user server))
854 (when (eq authentication 'password)
857 (cdr (assoc from mail-source-password-cache))
859 (format "Password for %s at %s: " user server))))
860 (unless (assoc from mail-source-password-cache)
861 (push (cons from password) mail-source-password-cache)))
863 (setenv "MAILHOST" server))
866 ;; No easy way to check whether mail is waiting for these.
869 ;; The default is to use pop3.el.
872 (let ((pop3-password password)
874 (pop3-mailhost server)
876 (pop3-authentication-scheme
877 (if (eq authentication 'apop) 'apop 'pass)))
878 (if (or debug-on-quit debug-on-error)
879 (save-excursion (pop3-get-message-count))
881 (save-excursion (pop3-get-message-count))
883 ;; We nix out the password in case the error
884 ;; was because of a wrong password being given.
885 (setq mail-source-password-cache
886 (delq (assoc from mail-source-password-cache)
887 mail-source-password-cache))
888 (signal (car err) (cdr err)))))))))
890 ;; Inform display-time that we have new mail.
891 (setq mail-source-new-mail-available (> result 0))
892 ;; We nix out the password in case the error
893 ;; was because of a wrong password being given.
894 (setq mail-source-password-cache
895 (delq (assoc from mail-source-password-cache)
896 mail-source-password-cache)))
899 (defun mail-source-touch-pop ()
900 "Open and close a POP connection shortly.
901 POP server should be defined in `mail-source-primary-source' (which is
902 preferred) or `mail-sources'. You may use it for the POP-before-SMTP
903 authentication. To do that, you need to set the
904 `message-send-mail-function' variable as `message-smtpmail-send-it'
905 and put the following line in your ~/.gnus.el file:
907 \(add-hook 'message-send-mail-hook 'mail-source-touch-pop)
909 See the Gnus manual for details."
910 (let ((sources (if mail-source-primary-source
911 (list mail-source-primary-source)
914 (if (eq 'pop (car (car sources)))
915 (mail-source-check-pop (car sources)))
916 (setq sources (cdr sources)))))
918 (defun mail-source-new-mail-p ()
919 "Handler for `display-time' to indicate when new mail is available."
920 ;; Flash (ie. ring the visible bell) if mail is available.
921 (if (and mail-source-flash mail-source-new-mail-available)
922 (let ((visible-bell t))
924 ;; Only report flag setting; flag is updated on a different schedule.
925 mail-source-new-mail-available)
928 (defvar mail-source-report-new-mail nil)
929 (defvar mail-source-report-new-mail-timer nil)
930 (defvar mail-source-report-new-mail-idle-timer nil)
932 (defun mail-source-start-idle-timer ()
933 ;; Start our idle timer if necessary, so we delay the check until the
934 ;; user isn't typing.
935 (unless mail-source-report-new-mail-idle-timer
936 (setq mail-source-report-new-mail-idle-timer
938 mail-source-idle-time-delay
942 (mail-source-check-pop mail-source-primary-source)
943 (setq mail-source-report-new-mail-idle-timer nil)))))
944 ;; Since idle timers created when Emacs is already in the idle
945 ;; state don't get activated until Emacs _next_ becomes idle, we
946 ;; need to force our timer to be considered active now. We do
947 ;; this by being naughty and poking the timer internals directly
948 ;; (element 0 of the vector is nil if the timer is active).
949 (aset mail-source-report-new-mail-idle-timer 0 nil)))
951 (defun mail-source-report-new-mail (arg)
952 "Toggle whether to report when new mail is available.
953 This only works when `display-time' is enabled."
955 (if (not mail-source-primary-source)
956 (error "Need to set `mail-source-primary-source' to check for new mail"))
957 (let ((on (if (null arg)
958 (not mail-source-report-new-mail)
959 (> (prefix-numeric-value arg) 0))))
960 (setq mail-source-report-new-mail on)
961 (and mail-source-report-new-mail-timer
962 (nnheader-cancel-timer mail-source-report-new-mail-timer))
963 (and mail-source-report-new-mail-idle-timer
964 (nnheader-cancel-timer mail-source-report-new-mail-idle-timer))
965 (setq mail-source-report-new-mail-timer nil)
966 (setq mail-source-report-new-mail-idle-timer nil)
970 ;; display-time-mail-function is an Emacs 21 feature.
971 (setq display-time-mail-function #'mail-source-new-mail-p)
972 ;; Set up the main timer.
973 (setq mail-source-report-new-mail-timer
975 (* 60 mail-source-report-new-mail-interval)
976 (* 60 mail-source-report-new-mail-interval)
977 #'mail-source-start-idle-timer))
978 ;; When you get new mail, clear "Mail" from the mode line.
979 (add-hook 'nnmail-post-get-new-mail-hook
980 'display-time-event-handler)
981 (message "Mail check enabled"))
982 (setq display-time-mail-function nil)
983 (remove-hook 'nnmail-post-get-new-mail-hook
984 'display-time-event-handler)
985 (message "Mail check disabled"))))
987 (defun mail-source-fetch-maildir (source callback)
988 "Fetcher for maildir sources."
989 (mail-source-bind (maildir source)
992 (unless (string-match "/$" path)
993 (setq path (concat path "/")))
994 (dolist (subdir subdirs)
995 (when (file-directory-p (concat path subdir))
996 (setq mail-source-string (format "maildir:%s%s" path subdir))
997 (dolist (file (directory-files (concat path subdir) t))
998 (when (and (not (file-directory-p file))
1000 (funcall function file mail-source-crash-box)
1001 (let ((coding-system-for-write
1002 mm-text-coding-system)
1003 (coding-system-for-read
1004 mm-text-coding-system))
1005 (with-temp-file mail-source-crash-box
1006 (insert-file-contents file)
1007 (goto-char (point-min))
1008 ;;; ;; Unix mail format
1009 ;;; (unless (looking-at "\n*From ")
1010 ;;; (insert "From maildir "
1011 ;;; (current-time-string) "\n"))
1012 ;;; (while (re-search-forward "^From " nil t)
1013 ;;; (replace-match ">From "))
1014 ;;; (goto-char (point-max))
1017 (insert "\001\001\001\001\n"))
1018 (delete-file file)))))
1019 (incf found (mail-source-callback callback file))
1020 (mail-source-delete-crash-box)))))
1024 (autoload 'imap-open "imap")
1025 (autoload 'imap-authenticate "imap")
1026 (autoload 'imap-mailbox-select "imap")
1027 (autoload 'imap-mailbox-unselect "imap")
1028 (autoload 'imap-mailbox-close "imap")
1029 (autoload 'imap-search "imap")
1030 (autoload 'imap-fetch "imap")
1031 (autoload 'imap-close "imap")
1032 (autoload 'imap-error-text "imap")
1033 (autoload 'imap-message-flags-add "imap")
1034 (autoload 'imap-list-to-message-set "imap")
1035 (autoload 'imap-range-to-message-set "imap")
1036 (autoload 'nnheader-ms-strip-cr "nnheader"))
1038 (autoload 'gnus-compress-sequence "gnus-range")
1040 (defvar mail-source-imap-file-coding-system 'binary
1041 "Coding system for the crashbox made by `mail-source-fetch-imap'.")
1043 ;; Autoloads will bring in imap before this is called.
1044 (declare-function imap-capability "imap" (&optional identifier buffer))
1046 (defun mail-source-fetch-imap (source callback)
1047 "Fetcher for imap sources."
1048 (mail-source-bind (imap source)
1049 (mail-source-run-script
1050 prescript (format-spec-make ?p password ?t mail-source-crash-box
1051 ?s server ?P port ?u user)
1053 (let ((from (format "%s:%s:%s" server user port))
1055 (buf (generate-new-buffer " *imap source*"))
1056 (mail-source-string (format "imap:%s:%s" server mailbox))
1057 (imap-shell-program (or (list program) imap-shell-program))
1059 (if (and (imap-open server port stream authentication buf)
1061 user (or (cdr (assoc from mail-source-password-cache))
1063 (imap-mailbox-select mailbox nil buf))
1064 (let ((coding-system-for-write mail-source-imap-file-coding-system)
1066 (with-temp-file mail-source-crash-box
1067 ;; Avoid converting 8-bit chars from inserted strings to
1069 (mm-disable-multibyte)
1070 ;; remember password
1071 (with-current-buffer buf
1072 (when (and imap-password
1073 (not (assoc from mail-source-password-cache)))
1074 (push (cons from imap-password) mail-source-password-cache)))
1075 ;; if predicate is nil, use all uids
1076 (dolist (uid (imap-search (or predicate "1:*") buf))
1078 (if (imap-capability 'IMAP4rev1 buf)
1079 (caddar (imap-fetch uid "BODY.PEEK[]"
1080 'BODYDETAIL nil buf))
1081 (imap-fetch uid "RFC822.PEEK" 'RFC822 nil buf)))
1083 (insert "From imap " (current-time-string) "\n")
1085 (insert str "\n\n"))
1086 (while (let ((case-fold-search nil))
1087 (re-search-forward "^From " nil t))
1088 (replace-match ">From "))
1089 (goto-char (point-max))))
1090 (nnheader-ms-strip-cr))
1091 (incf found (mail-source-callback callback server))
1092 (mail-source-delete-crash-box)
1093 (when (and remove fetchflag)
1094 (setq remove (nreverse remove))
1095 (imap-message-flags-add
1096 (imap-range-to-message-set (gnus-compress-sequence remove))
1099 (imap-mailbox-unselect buf)
1100 (imap-mailbox-close nil buf))
1103 ;; We nix out the password in case the error
1104 ;; was because of a wrong password being given.
1105 (setq mail-source-password-cache
1106 (delq (assoc from mail-source-password-cache)
1107 mail-source-password-cache))
1108 (error "IMAP error: %s" (imap-error-text buf)))
1110 (mail-source-run-script
1112 (format-spec-make ?p password ?t mail-source-crash-box
1113 ?s server ?P port ?u user))
1117 (autoload 'webmail-fetch "webmail"))
1119 (defun mail-source-fetch-webmail (source callback)
1120 "Fetch for webmail source."
1121 (mail-source-bind (webmail source)
1122 (let ((mail-source-string (format "webmail:%s:%s" subtype user))
1123 (webmail-newmail-only dontexpunge)
1124 (webmail-move-to-trash-can (not dontexpunge)))
1125 (when (eq authentication 'password)
1128 (cdr (assoc (format "webmail:%s:%s" subtype user)
1129 mail-source-password-cache))
1131 (format "Password for %s at %s: " user subtype))))
1133 (not (assoc (format "webmail:%s:%s" subtype user)
1134 mail-source-password-cache)))
1135 (push (cons (format "webmail:%s:%s" subtype user) password)
1136 mail-source-password-cache)))
1137 (webmail-fetch mail-source-crash-box subtype user password)
1138 (mail-source-callback callback (symbol-name subtype))
1139 (mail-source-delete-crash-box))))
1141 (provide 'mail-source)
1143 ;; arch-tag: 72948025-1d17-4d6c-bb12-ef1aa2c490fd
1144 ;;; mail-source.el ends here