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 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
30 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
32 (require 'format-spec)
37 (autoload 'auth-source-user-or-password "auth-source")
38 (autoload 'pop3-movemail "pop3")
39 (autoload 'pop3-get-message-count "pop3")
40 (autoload 'nnheader-cancel-timer "nnheader"))
42 (require 'message) ;; for `message-directory'
44 (defvar display-time-mail-function)
46 (defgroup mail-source nil
47 "The mail-fetching library."
51 ;; Define these at compile time to avoid dragging in imap always.
52 (defconst mail-source-imap-authenticators
55 (list 'const (car a)))
56 imap-authenticator-alist)))
57 (defconst mail-source-imap-streams
60 (list 'const (car a)))
63 (defcustom mail-sources '((file))
64 "Where the mail backends will look for incoming mail.
65 This variable is a list of mail source specifiers.
66 See Info node `(gnus)Mail Source Specifiers'."
68 :version "23.1" ;; No Gnus
69 :link '(custom-manual "(gnus)Mail Source Specifiers")
71 (const :tag "None" nil)
73 (choice :format "%[Value Menu%] %v"
75 (cons :tag "Group parameter `mail-source'"
76 (const :format "" group))
77 (cons :tag "Spool file"
78 (const :format "" file)
79 (checklist :tag "Options" :greedy t
81 (const :format "" :value :path)
83 (cons :tag "Several files in a directory"
84 (const :format "" directory)
85 (checklist :tag "Options" :greedy t
87 (const :format "" :value :path)
88 (directory :tag "Path"))
90 (const :format "" :value :suffix)
91 (string :tag "Suffix"))
93 (const :format "" :value :predicate)
94 (function :tag "Predicate"))
96 (const :format "" :value :prescript)
97 (choice :tag "Prescript"
100 (function :format "%v")))
102 (const :format "" :value :postscript)
103 (choice :tag "Postscript"
105 (string :format "%v")
106 (function :format "%v")))
108 (const :format "" :value :plugged)
109 (boolean :tag "Plugged"))))
110 (cons :tag "POP3 server"
111 (const :format "" pop)
112 (checklist :tag "Options" :greedy t
114 (const :format "" :value :server)
115 (string :tag "Server"))
117 (const :format "" :value :port)
120 (integer :format "%v")
121 (string :format "%v")))
123 (const :format "" :value :user)
124 (string :tag "User"))
126 (const :format "" :value :password)
127 (string :tag "Password"))
129 (const :format "" :value :program)
130 (string :tag "Program"))
132 (const :format "" :value :prescript)
133 (choice :tag "Prescript"
135 (string :format "%v")
136 (function :format "%v")
137 (const :tag "None" nil)))
139 (const :format "" :value :postscript)
140 (choice :tag "Postscript"
142 (string :format "%v")
143 (function :format "%v")
144 (const :tag "None" nil)))
146 (const :format "" :value :function)
147 (function :tag "Function"))
150 :value :authentication)
151 (choice :tag "Authentication"
156 (const :format "" :value :plugged)
157 (boolean :tag "Plugged"))
159 (const :format "" :value :stream)
160 (choice :tag "Stream"
162 (const :tag "Clear" nil)
164 (const :tag "SSL/TLS" ssl)))))
165 (cons :tag "Maildir (qmail, postfix...)"
166 (const :format "" maildir)
167 (checklist :tag "Options" :greedy t
169 (const :format "" :value :path)
170 (directory :tag "Path"))
172 (const :format "" :value :plugged)
173 (boolean :tag "Plugged"))))
174 (cons :tag "IMAP server"
175 (const :format "" imap)
176 (checklist :tag "Options" :greedy t
178 (const :format "" :value :server)
179 (string :tag "Server"))
181 (const :format "" :value :port)
186 (const :format "" :value :user)
187 (string :tag "User"))
189 (const :format "" :value :password)
190 (string :tag "Password"))
192 (const :format "" :value :stream)
193 (choice :tag "Stream"
195 ,@mail-source-imap-streams))
197 (const :format "" :value :program)
198 (string :tag "Program"))
201 :value :authenticator)
202 (choice :tag "Authenticator"
204 ,@mail-source-imap-authenticators))
206 (const :format "" :value :mailbox)
207 (string :tag "Mailbox"
210 (const :format "" :value :predicate)
211 (string :tag "Predicate"
212 :value "UNSEEN UNDELETED"))
214 (const :format "" :value :fetchflag)
215 (string :tag "Fetchflag"
220 (boolean :tag "Dontexpunge"))
222 (const :format "" :value :plugged)
223 (boolean :tag "Plugged"))))
224 (cons :tag "Webmail server"
225 (const :format "" webmail)
226 (checklist :tag "Options" :greedy t
228 (const :format "" :value :subtype)
229 ;; Should be generated from
230 ;; `webmail-type-definition', but we
231 ;; can't require webmail without W3.
232 (choice :tag "Subtype"
240 (const :format "" :value :user)
241 (string :tag "User"))
243 (const :format "" :value :password)
244 (string :tag "Password"))
248 (boolean :tag "Dontexpunge"))
250 (const :format "" :value :plugged)
251 (boolean :tag "Plugged"))))))))
253 (defcustom mail-source-ignore-errors nil
254 "*Ignore errors when querying mail sources.
255 If nil, the user will be prompted when an error occurs. If non-nil,
256 the error will be ignored."
261 (defcustom mail-source-primary-source nil
262 "*Primary source for incoming mail.
263 If non-nil, this maildrop will be checked periodically for new mail."
267 (defcustom mail-source-flash t
268 "*If non-nil, flash periodically when mail is available."
272 (defcustom mail-source-crash-box "~/.emacs-mail-crash-box"
273 "File where mail will be stored while processing it."
277 (defcustom mail-source-directory message-directory
278 "Directory where incoming mail source files (if any) will be stored."
282 (defcustom mail-source-default-file-modes 384
283 "Set the mode bits of all new mail files to this integer."
287 (defcustom mail-source-delete-incoming
288 10 ;; development versions
289 ;; 2 ;; released versions
290 "If non-nil, delete incoming files after handling.
291 If t, delete immediately, if nil, never delete. If a positive number, delete
292 files older than number of days.
294 Removing of old files happens in `mail-source-callback', i.e. no
295 old incoming files will be deleted unless you receive new mail.
296 You may also set this variable to nil and call
297 `mail-source-delete-old-incoming' interactively."
299 :version "22.2" ;; No Gnus / Gnus 5.10.10 (default changed)
300 :type '(choice (const :tag "immediately" t)
301 (const :tag "never" nil)
302 (integer :tag "days")))
304 (defcustom mail-source-delete-old-incoming-confirm nil
305 "If non-nil, ask for confirmation before deleting old incoming files.
306 This variable only applies when `mail-source-delete-incoming' is a positive
308 :version "22.2" ;; No Gnus / Gnus 5.10.10 (default changed)
312 (defcustom mail-source-incoming-file-prefix "Incoming"
313 "Prefix for file name for storing incoming mail"
317 (defcustom mail-source-report-new-mail-interval 5
318 "Interval in minutes between checks for new mail."
322 (defcustom mail-source-idle-time-delay 5
323 "Number of idle seconds to wait before checking for new mail."
327 (defcustom mail-source-movemail-program nil
328 "If non-nil, name of program for fetching new mail."
331 :type '(choice (const nil) string))
333 ;;; Internal variables.
335 (defvar mail-source-string ""
336 "A dynamically bound string that says what the current mail source is.")
338 (defvar mail-source-new-mail-available nil
339 "Flag indicating when new mail is available.")
342 (defvar mail-source-common-keyword-map
344 "Mapping from keywords to default values.
345 Common keywords should be listed here.")
347 (defvar mail-source-keyword-map
352 (:path (or (getenv "MAIL")
353 (expand-file-name (user-login-name) rmail-spool-directory))))
360 (:predicate identity))
365 (:server (getenv "MAILHOST"))
367 (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
371 (:authentication password)
374 (:path (or (getenv "MAILDIR") "~/Maildir/"))
375 (:subdirs ("cur" "new"))
378 (:server (getenv "MAILHOST"))
383 (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
386 (:predicate "UNSEEN UNDELETED")
387 (:fetchflag "\\Deleted")
394 (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
397 (:authentication password)))
398 "Mapping from keywords to default values.
399 All keywords that can be used must be listed here."))
401 (defvar mail-source-fetcher-alist
402 '((file mail-source-fetch-file)
403 (directory mail-source-fetch-directory)
404 (pop mail-source-fetch-pop)
405 (maildir mail-source-fetch-maildir)
406 (imap mail-source-fetch-imap)
407 (webmail mail-source-fetch-webmail))
408 "A mapping from source type to fetcher function.")
410 (defvar mail-source-password-cache nil)
412 (defvar mail-source-plugged t)
417 (defun mail-source-strip-keyword (keyword)
418 "Strip the leading colon off the KEYWORD."
419 (intern (substring (symbol-name keyword) 1))))
421 ;; generate a list of variable names paired with nil values
422 ;; suitable for usage in a `let' form
424 (defun mail-source-bind-1 (type)
425 (let* ((defaults (cdr (assq type mail-source-keyword-map)))
427 (while (setq default (pop defaults))
428 (push (list (mail-source-strip-keyword (car default))
433 (defmacro mail-source-bind (type-source &rest body)
434 "Return a `let' form that binds all variables in source TYPE.
435 TYPE-SOURCE is a list where the first element is the TYPE, and
436 the second variable is the SOURCE.
437 At run time, the mail source specifier SOURCE will be inspected,
438 and the variables will be set according to it. Variables not
439 specified will be given default values.
441 The user and password will be loaded from the auth-source values
442 if those are available. They override the original user and
443 password in a second `let' form.
445 After this is done, BODY will be executed in the scope
446 of the second `let' form.
448 The variables bound and their default values are described by
449 the `mail-source-keyword-map' variable."
450 `(let* ,(mail-source-bind-1 (car type-source))
451 (mail-source-set-1 ,(cadr type-source))
454 (put 'mail-source-bind 'lisp-indent-function 1)
455 (put 'mail-source-bind 'edebug-form-spec '(sexp body))
457 (defun mail-source-set-1 (source)
458 (let* ((type (pop source))
459 (defaults (cdr (assq type mail-source-keyword-map)))
460 default value keyword user-auth pass-auth)
461 (while (setq default (pop defaults))
462 ;; for each default :SYMBOL, set SYMBOL to the plist value for :SYMBOL
463 ;; using `mail-source-value' to evaluate the plist value
464 (set (mail-source-strip-keyword (setq keyword (car default)))
465 ;; note the following reasons for this structure:
466 ;; 1) the auth-sources user and password override everything
467 ;; 2) it avoids macros, so it's cleaner
468 ;; 3) it falls through to the mail-sources and then default values
473 (auth-source-user-or-password
475 ;; this is "host" in auth-sources
476 (if (boundp 'server) (symbol-value 'server) "")
480 (eq keyword :password)
482 (auth-source-user-or-password
484 ;; this is "host" in auth-sources
485 (if (boundp 'server) (symbol-value 'server) "")
488 (t (if (setq value (plist-get source keyword))
489 (mail-source-value value)
490 (mail-source-value (cadr default)))))))))
493 (defun mail-source-bind-common-1 ()
494 (let* ((defaults mail-source-common-keyword-map)
496 (while (setq default (pop defaults))
497 (push (list (mail-source-strip-keyword (car default))
502 (defun mail-source-set-common-1 (source)
503 (let* ((type (pop source))
504 (defaults mail-source-common-keyword-map)
505 (defaults-1 (cdr (assq type mail-source-keyword-map)))
506 default value keyword)
507 (while (setq default (pop defaults))
508 (set (mail-source-strip-keyword (setq keyword (car default)))
509 (if (setq value (plist-get source keyword))
510 (mail-source-value value)
511 (if (setq value (assq keyword defaults-1))
512 (mail-source-value (cadr value))
513 (mail-source-value (cadr default))))))))
515 (defmacro mail-source-bind-common (source &rest body)
516 "Return a `let' form that binds all common variables.
517 See `mail-source-bind'."
518 `(let ,(mail-source-bind-common-1)
519 (mail-source-set-common-1 source)
522 (put 'mail-source-bind-common 'lisp-indent-function 1)
523 (put 'mail-source-bind-common 'edebug-form-spec '(sexp body))
525 (defun mail-source-value (value)
526 "Return the value of VALUE."
532 ((and (listp value) (symbolp (car value)) (fboundp (car value)))
534 ;; Just return the value.
538 (defun mail-source-fetch (source callback)
539 "Fetch mail from SOURCE and call CALLBACK zero or more times.
540 CALLBACK will be called with the name of the file where (some of)
541 the mail from SOURCE is put.
542 Return the number of files that were found."
543 (mail-source-bind-common source
544 (if (or mail-source-plugged plugged)
546 (let ((function (cadr (assq (car source) mail-source-fetcher-alist)))
549 (error "%S is an invalid mail source specification" source))
550 ;; If there's anything in the crash box, we do it first.
551 (when (file-exists-p mail-source-crash-box)
552 (message "Processing mail from %s..." mail-source-crash-box)
553 (setq found (mail-source-callback
554 callback mail-source-crash-box))
555 (mail-source-delete-crash-box))
557 (if (or debug-on-quit debug-on-error)
558 (funcall function source callback)
560 (funcall function source callback)
562 (if (and (not mail-source-ignore-errors)
565 (format "Mail source %s error (%s). Continue? "
566 (if (memq ':password source)
567 (let ((s (copy-sequence source)))
568 (setcar (cdr (memq ':password s))
573 (error "Cannot get new mail"))
576 (defun mail-source-delete-old-incoming (&optional age confirm)
577 "Remove incoming files older than AGE days.
578 If CONFIRM is non-nil, ask for confirmation before removing a file."
580 (let* ((high2days (/ 65536.0 60 60 24));; convert high bits to days
581 (low2days (/ 1.0 65536.0)) ;; convert low bits to days
582 (diff (if (natnump age) age 30));; fallback, if no valid AGE given
584 (setq files (directory-files
585 mail-source-directory t
587 (regexp-quote mail-source-incoming-file-prefix)))
588 currday (* (car (current-time)) high2days)
589 currday (+ currday (* low2days (nth 1 (current-time)))))
591 (let* ((ffile (car files))
592 (bfile (gnus-replace-in-string
593 ffile "\\`.*/\\([^/]+\\)\\'" "\\1"))
594 (filetime (nth 5 (file-attributes ffile)))
595 (fileday (* (car filetime) high2days))
596 (fileday (+ fileday (* low2days (nth 1 filetime)))))
597 (setq files (cdr files))
598 (when (and (> (- currday fileday) diff)
602 Delete old (> %s day(s)) incoming mail file `%s'? " diff bfile))
604 Deleting old (> %s day(s)) incoming mail file `%s'." diff bfile)
606 (delete-file ffile))))))
608 (defun mail-source-callback (callback info)
609 "Call CALLBACK on the mail file. Pass INFO on to CALLBACK."
610 (if (or (not (file-exists-p mail-source-crash-box))
611 (zerop (nth 7 (file-attributes mail-source-crash-box))))
613 (when (file-exists-p mail-source-crash-box)
614 (delete-file mail-source-crash-box))
616 (funcall callback mail-source-crash-box info)))
618 (defun mail-source-delete-crash-box ()
619 (when (file-exists-p mail-source-crash-box)
620 ;; Delete or move the incoming mail out of the way.
621 (if (eq mail-source-delete-incoming t)
622 (delete-file mail-source-crash-box)
626 mail-source-incoming-file-prefix
627 mail-source-directory))))
628 (unless (file-exists-p (file-name-directory incoming))
629 (make-directory (file-name-directory incoming) t))
630 (rename-file mail-source-crash-box incoming t)
631 ;; remove old incoming files?
632 (when (natnump mail-source-delete-incoming)
633 (mail-source-delete-old-incoming
634 mail-source-delete-incoming
635 mail-source-delete-old-incoming-confirm))))))
637 (defun mail-source-movemail (from to)
638 "Move FROM to TO using movemail."
639 (if (not (file-writable-p to))
640 (error "Can't write to crash box %s. Not moving mail" to)
641 (let ((to (file-truename (expand-file-name to)))
643 (setq to (file-truename to)
644 from (file-truename from))
645 ;; Set TO if have not already done so, and rename or copy
646 ;; the file FROM to TO if and as appropriate.
649 ;; The crash box exists already.
651 ((not (file-exists-p from))
652 ;; There is no inbox.
654 ((zerop (nth 7 (file-attributes from)))
658 ;; If getting from mail spool directory, use movemail to move
659 ;; rather than just renaming, so as to interlock with the
663 (setq errors (generate-new-buffer " *mail source loss*"))
664 (let ((default-directory "/"))
670 (or mail-source-movemail-program
671 (expand-file-name "movemail" exec-directory))
672 nil errors nil from to)))))
673 (when (file-exists-p to)
674 (set-file-modes to mail-source-default-file-modes))
675 (if (and (or (not (buffer-modified-p errors))
676 (zerop (buffer-size errors)))
677 (and (numberp result)
679 ;; No output => movemail won.
682 ;; There may be a warning about older revisions. We
684 (goto-char (point-min))
685 (if (search-forward "older revision" nil t)
687 ;; Probably a real error.
688 (subst-char-in-region (point-min) (point-max) ?\n ?\ )
689 (goto-char (point-max))
690 (skip-chars-backward " \t")
691 (delete-region (point) (point-max))
692 (goto-char (point-min))
693 (when (looking-at "movemail: ")
694 (delete-region (point-min) (match-end 0)))
695 ;; Result may be a signal description string.
697 (format "movemail: %s (%s return). Continue? "
698 (buffer-string) result))
699 (error "%s" (buffer-string)))
702 (buffer-name errors))
703 (kill-buffer errors))
704 ;; Return whether we moved successfully or not.
707 (defun mail-source-movemail-and-remove (from to)
708 "Move FROM to TO using movemail, then remove FROM if empty."
709 (or (not (mail-source-movemail from to))
710 (not (zerop (nth 7 (file-attributes from))))
713 (defun mail-source-fetch-with-program (program)
714 (eq 0 (call-process shell-file-name nil nil nil
715 shell-command-switch program)))
717 (defun mail-source-run-script (script spec &optional delay)
719 (if (functionp script)
721 (mail-source-call-script
722 (format-spec script spec))))
726 (defun mail-source-call-script (script)
727 (let ((background nil)
728 (stderr (get-buffer-create " *mail-source-stderr*"))
730 (when (string-match "& *$" script)
731 (setq script (substring script 0 (match-beginning 0))
734 (call-process shell-file-name nil background nil
735 shell-command-switch script))
737 (not (zerop result)))
739 (message "Mail source error: %s" (buffer-string)))
740 (kill-buffer stderr)))
743 ;;; Different fetchers
746 (defun mail-source-fetch-file (source callback)
747 "Fetcher for single-file sources."
748 (mail-source-bind (file source)
749 (mail-source-run-script
750 prescript (format-spec-make ?t mail-source-crash-box)
752 (let ((mail-source-string (format "file:%s" path)))
753 (if (mail-source-movemail path mail-source-crash-box)
755 (mail-source-callback callback path)
756 (mail-source-run-script
757 postscript (format-spec-make ?t mail-source-crash-box))
758 (mail-source-delete-crash-box))
761 (defun mail-source-fetch-directory (source callback)
762 "Fetcher for directory sources."
763 (mail-source-bind (directory source)
764 (mail-source-run-script
765 prescript (format-spec-make ?t path) prescript-delay)
767 (mail-source-string (format "directory:%s" path)))
768 (dolist (file (directory-files
769 path t (concat (regexp-quote suffix) "$")))
770 (when (and (file-regular-p file)
771 (funcall predicate file)
772 (mail-source-movemail file mail-source-crash-box))
773 (incf found (mail-source-callback callback file))
774 (mail-source-run-script postscript (format-spec-make ?t path))
775 (mail-source-delete-crash-box)))
778 (defun mail-source-fetch-pop (source callback)
779 "Fetcher for single-file sources."
780 (mail-source-bind (pop source)
781 ;; fixme: deal with stream type in format specs
782 (mail-source-run-script
784 (format-spec-make ?p password ?t mail-source-crash-box
785 ?s server ?P port ?u user)
787 (let ((from (format "%s:%s:%s" server user port))
788 (mail-source-string (format "pop:%s@%s" user server))
790 (when (eq authentication 'password)
793 (cdr (assoc from mail-source-password-cache))
795 (format "Password for %s at %s: " user server)))))
797 (setenv "MAILHOST" server))
801 (mail-source-fetch-with-program
804 (format-spec-make ?p password ?t mail-source-crash-box
805 ?s server ?P port ?u user))))
807 (funcall function mail-source-crash-box))
808 ;; The default is to use pop3.el.
811 (let ((pop3-password password)
813 (pop3-mailhost server)
815 (pop3-authentication-scheme
816 (if (eq authentication 'apop) 'apop 'pass))
817 (pop3-stream-type stream))
818 (if (or debug-on-quit debug-on-error)
819 (save-excursion (pop3-movemail mail-source-crash-box))
821 (save-excursion (pop3-movemail mail-source-crash-box))
823 ;; We nix out the password in case the error
824 ;; was because of a wrong password being given.
825 (setq mail-source-password-cache
826 (delq (assoc from mail-source-password-cache)
827 mail-source-password-cache))
828 (signal (car err) (cdr err)))))))))
831 (when (eq authentication 'password)
832 (unless (assoc from mail-source-password-cache)
833 (push (cons from password) mail-source-password-cache)))
835 (mail-source-callback callback server)
836 ;; Update display-time's mail flag, if relevant.
837 (if (equal source mail-source-primary-source)
838 (setq mail-source-new-mail-available nil))
839 (mail-source-run-script
841 (format-spec-make ?p password ?t mail-source-crash-box
842 ?s server ?P port ?u user))
843 (mail-source-delete-crash-box)))
844 ;; We nix out the password in case the error
845 ;; was because of a wrong password being given.
846 (setq mail-source-password-cache
847 (delq (assoc from mail-source-password-cache)
848 mail-source-password-cache))
851 (defun mail-source-check-pop (source)
852 "Check whether there is new mail."
853 (mail-source-bind (pop source)
854 (let ((from (format "%s:%s:%s" server user port))
855 (mail-source-string (format "pop:%s@%s" user server))
857 (when (eq authentication 'password)
860 (cdr (assoc from mail-source-password-cache))
862 (format "Password for %s at %s: " user server))))
863 (unless (assoc from mail-source-password-cache)
864 (push (cons from password) mail-source-password-cache)))
866 (setenv "MAILHOST" server))
869 ;; No easy way to check whether mail is waiting for these.
872 ;; The default is to use pop3.el.
875 (let ((pop3-password password)
877 (pop3-mailhost server)
879 (pop3-authentication-scheme
880 (if (eq authentication 'apop) 'apop 'pass)))
881 (if (or debug-on-quit debug-on-error)
882 (save-excursion (pop3-get-message-count))
884 (save-excursion (pop3-get-message-count))
886 ;; We nix out the password in case the error
887 ;; was because of a wrong password being given.
888 (setq mail-source-password-cache
889 (delq (assoc from mail-source-password-cache)
890 mail-source-password-cache))
891 (signal (car err) (cdr err)))))))))
893 ;; Inform display-time that we have new mail.
894 (setq mail-source-new-mail-available (> result 0))
895 ;; We nix out the password in case the error
896 ;; was because of a wrong password being given.
897 (setq mail-source-password-cache
898 (delq (assoc from mail-source-password-cache)
899 mail-source-password-cache)))
902 (defun mail-source-touch-pop ()
903 "Open and close a POP connection shortly.
904 POP server should be defined in `mail-source-primary-source' (which is
905 preferred) or `mail-sources'. You may use it for the POP-before-SMTP
906 authentication. To do that, you need to set the
907 `message-send-mail-function' variable as `message-smtpmail-send-it'
908 and put the following line in your ~/.gnus.el file:
910 \(add-hook 'message-send-mail-hook 'mail-source-touch-pop)
912 See the Gnus manual for details."
913 (let ((sources (if mail-source-primary-source
914 (list mail-source-primary-source)
917 (if (eq 'pop (car (car sources)))
918 (mail-source-check-pop (car sources)))
919 (setq sources (cdr sources)))))
921 (defun mail-source-new-mail-p ()
922 "Handler for `display-time' to indicate when new mail is available."
923 ;; Flash (ie. ring the visible bell) if mail is available.
924 (if (and mail-source-flash mail-source-new-mail-available)
925 (let ((visible-bell t))
927 ;; Only report flag setting; flag is updated on a different schedule.
928 mail-source-new-mail-available)
931 (defvar mail-source-report-new-mail nil)
932 (defvar mail-source-report-new-mail-timer nil)
933 (defvar mail-source-report-new-mail-idle-timer nil)
935 (defun mail-source-start-idle-timer ()
936 ;; Start our idle timer if necessary, so we delay the check until the
937 ;; user isn't typing.
938 (unless mail-source-report-new-mail-idle-timer
939 (setq mail-source-report-new-mail-idle-timer
941 mail-source-idle-time-delay
945 (mail-source-check-pop mail-source-primary-source)
946 (setq mail-source-report-new-mail-idle-timer nil)))))
947 ;; Since idle timers created when Emacs is already in the idle
948 ;; state don't get activated until Emacs _next_ becomes idle, we
949 ;; need to force our timer to be considered active now. We do
950 ;; this by being naughty and poking the timer internals directly
951 ;; (element 0 of the vector is nil if the timer is active).
952 (aset mail-source-report-new-mail-idle-timer 0 nil)))
954 (defun mail-source-report-new-mail (arg)
955 "Toggle whether to report when new mail is available.
956 This only works when `display-time' is enabled."
958 (if (not mail-source-primary-source)
959 (error "Need to set `mail-source-primary-source' to check for new mail"))
960 (let ((on (if (null arg)
961 (not mail-source-report-new-mail)
962 (> (prefix-numeric-value arg) 0))))
963 (setq mail-source-report-new-mail on)
964 (and mail-source-report-new-mail-timer
965 (nnheader-cancel-timer mail-source-report-new-mail-timer))
966 (and mail-source-report-new-mail-idle-timer
967 (nnheader-cancel-timer mail-source-report-new-mail-idle-timer))
968 (setq mail-source-report-new-mail-timer nil)
969 (setq mail-source-report-new-mail-idle-timer nil)
973 ;; display-time-mail-function is an Emacs 21 feature.
974 (setq display-time-mail-function #'mail-source-new-mail-p)
975 ;; Set up the main timer.
976 (setq mail-source-report-new-mail-timer
978 (* 60 mail-source-report-new-mail-interval)
979 (* 60 mail-source-report-new-mail-interval)
980 #'mail-source-start-idle-timer))
981 ;; When you get new mail, clear "Mail" from the mode line.
982 (add-hook 'nnmail-post-get-new-mail-hook
983 'display-time-event-handler)
984 (message "Mail check enabled"))
985 (setq display-time-mail-function nil)
986 (remove-hook 'nnmail-post-get-new-mail-hook
987 'display-time-event-handler)
988 (message "Mail check disabled"))))
990 (defun mail-source-fetch-maildir (source callback)
991 "Fetcher for maildir sources."
992 (mail-source-bind (maildir source)
995 (unless (string-match "/$" path)
996 (setq path (concat path "/")))
997 (dolist (subdir subdirs)
998 (when (file-directory-p (concat path subdir))
999 (setq mail-source-string (format "maildir:%s%s" path subdir))
1000 (dolist (file (directory-files (concat path subdir) t))
1001 (when (and (not (file-directory-p file))
1003 (funcall function file mail-source-crash-box)
1004 (let ((coding-system-for-write
1005 mm-text-coding-system)
1006 (coding-system-for-read
1007 mm-text-coding-system))
1008 (with-temp-file mail-source-crash-box
1009 (insert-file-contents file)
1010 (goto-char (point-min))
1011 ;;; ;; Unix mail format
1012 ;;; (unless (looking-at "\n*From ")
1013 ;;; (insert "From maildir "
1014 ;;; (current-time-string) "\n"))
1015 ;;; (while (re-search-forward "^From " nil t)
1016 ;;; (replace-match ">From "))
1017 ;;; (goto-char (point-max))
1020 (insert "\001\001\001\001\n"))
1021 (delete-file file)))))
1022 (incf found (mail-source-callback callback file))
1023 (mail-source-delete-crash-box)))))
1027 (autoload 'imap-open "imap")
1028 (autoload 'imap-authenticate "imap")
1029 (autoload 'imap-mailbox-select "imap")
1030 (autoload 'imap-mailbox-unselect "imap")
1031 (autoload 'imap-mailbox-close "imap")
1032 (autoload 'imap-search "imap")
1033 (autoload 'imap-fetch "imap")
1034 (autoload 'imap-close "imap")
1035 (autoload 'imap-error-text "imap")
1036 (autoload 'imap-message-flags-add "imap")
1037 (autoload 'imap-list-to-message-set "imap")
1038 (autoload 'imap-range-to-message-set "imap")
1039 (autoload 'nnheader-ms-strip-cr "nnheader"))
1041 (autoload 'gnus-compress-sequence "gnus-range")
1043 (defvar mail-source-imap-file-coding-system 'binary
1044 "Coding system for the crashbox made by `mail-source-fetch-imap'.")
1046 ;; Autoloads will bring in imap before this is called.
1047 (declare-function imap-capability "imap" (&optional identifier buffer))
1049 (defun mail-source-fetch-imap (source callback)
1050 "Fetcher for imap sources."
1051 (mail-source-bind (imap source)
1052 (mail-source-run-script
1053 prescript (format-spec-make ?p password ?t mail-source-crash-box
1054 ?s server ?P port ?u user)
1056 (let ((from (format "%s:%s:%s" server user port))
1058 (buf (generate-new-buffer " *imap source*"))
1059 (mail-source-string (format "imap:%s:%s" server mailbox))
1060 (imap-shell-program (or (list program) imap-shell-program))
1062 (if (and (imap-open server port stream authentication buf)
1064 user (or (cdr (assoc from mail-source-password-cache))
1066 (imap-mailbox-select mailbox nil buf))
1067 (let ((coding-system-for-write mail-source-imap-file-coding-system)
1069 (with-temp-file mail-source-crash-box
1070 ;; Avoid converting 8-bit chars from inserted strings to
1072 (mm-disable-multibyte)
1073 ;; remember password
1074 (with-current-buffer buf
1075 (when (and imap-password
1076 (not (assoc from mail-source-password-cache)))
1077 (push (cons from imap-password) mail-source-password-cache)))
1078 ;; if predicate is nil, use all uids
1079 (dolist (uid (imap-search (or predicate "1:*") buf))
1081 (if (imap-capability 'IMAP4rev1 buf)
1082 (caddar (imap-fetch uid "BODY.PEEK[]"
1083 'BODYDETAIL nil buf))
1084 (imap-fetch uid "RFC822.PEEK" 'RFC822 nil buf)))
1086 (insert "From imap " (current-time-string) "\n")
1088 (insert str "\n\n"))
1089 (while (let ((case-fold-search nil))
1090 (re-search-forward "^From " nil t))
1091 (replace-match ">From "))
1092 (goto-char (point-max))))
1093 (nnheader-ms-strip-cr))
1094 (incf found (mail-source-callback callback server))
1095 (mail-source-delete-crash-box)
1096 (when (and remove fetchflag)
1097 (setq remove (nreverse remove))
1098 (imap-message-flags-add
1099 (imap-range-to-message-set (gnus-compress-sequence remove))
1102 (imap-mailbox-unselect buf)
1103 (imap-mailbox-close nil buf))
1106 ;; We nix out the password in case the error
1107 ;; was because of a wrong password being given.
1108 (setq mail-source-password-cache
1109 (delq (assoc from mail-source-password-cache)
1110 mail-source-password-cache))
1111 (error "IMAP error: %s" (imap-error-text buf)))
1113 (mail-source-run-script
1115 (format-spec-make ?p password ?t mail-source-crash-box
1116 ?s server ?P port ?u user))
1120 (autoload 'webmail-fetch "webmail"))
1122 (defun mail-source-fetch-webmail (source callback)
1123 "Fetch for webmail source."
1124 (mail-source-bind (webmail source)
1125 (let ((mail-source-string (format "webmail:%s:%s" subtype user))
1126 (webmail-newmail-only dontexpunge)
1127 (webmail-move-to-trash-can (not dontexpunge)))
1128 (when (eq authentication 'password)
1131 (cdr (assoc (format "webmail:%s:%s" subtype user)
1132 mail-source-password-cache))
1134 (format "Password for %s at %s: " user subtype))))
1136 (not (assoc (format "webmail:%s:%s" subtype user)
1137 mail-source-password-cache)))
1138 (push (cons (format "webmail:%s:%s" subtype user) password)
1139 mail-source-password-cache)))
1140 (webmail-fetch mail-source-crash-box subtype user password)
1141 (mail-source-callback callback (symbol-name subtype))
1142 (mail-source-delete-crash-box))))
1144 (provide 'mail-source)
1146 ;; arch-tag: 72948025-1d17-4d6c-bb12-ef1aa2c490fd
1147 ;;; mail-source.el ends here