git.chise.org Git - elisp/gnus.git-/blob - lisp/mail-source.el

   1 ;;; mail-source.el --- functions for fetching mail
   2 ;; Copyright (C) 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   5 ;; Keywords: news, mail
   6
   7 ;; This file is part of GNU Emacs.
   8
   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)
  12 ;; any later version.
  13
  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.
  18
  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.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (eval-when-compile
  29   (require 'cl)
  30   (require 'imap)
  31   (eval-when-compile (defvar display-time-mail-function)))
  32 (eval-and-compile
  33   (defvar pop3-leave-mail-on-server)
  34   (autoload 'pop3-movemail "pop3")
  35   (autoload 'pop3-get-message-count "pop3")
  36   (autoload 'nnheader-cancel-timer "nnheader")
  37   (autoload 'nnheader-run-at-time "nnheader"))
  38 (require 'format-spec)
  39 (require 'message) ;; for `message-directory'
  40
  41 (defgroup mail-source nil
  42   "The mail-fetching library."
  43   :version "21.1"
  44   :group 'gnus)
  45
  46 ;; Define these at compile time to avoid dragging in imap always.
  47 (defconst mail-source-imap-authenticators
  48   (eval-when-compile
  49     (mapcar (lambda (a)
  50               (list 'const (car a)))
  51             imap-authenticator-alist)))
  52 (defconst mail-source-imap-streams
  53   (eval-when-compile
  54     (mapcar (lambda (a)
  55               (list 'const (car a)))
  56             imap-stream-alist)))
  57
  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'."
  62   :group 'mail-source
  63   :type `(repeat
  64           (choice :format "%[Value Menu%] %v"
  65                   :value (file)
  66                   (cons :tag "Spool file"
  67                         (const :format "" file)
  68                         (checklist :tag "Options" :greedy t
  69                                    (group :inline t
  70                                           (const :format "" :value :path)
  71                                           file)))
  72                   (cons :tag "Several files in a directory"
  73                         (const :format "" directory)
  74                         (checklist :tag "Options" :greedy t
  75                                    (group :inline t
  76                                           (const :format "" :value :path)
  77                                           (directory :tag "Path"))
  78                                    (group :inline t
  79                                           (const :format "" :value :suffix)
  80                                           (string :tag "Suffix"))
  81                                    (group :inline t
  82                                           (const :format "" :value :predicate)
  83                                           (function :tag "Predicate"))
  84                                    (group :inline t
  85                                           (const :format "" :value :prescript)
  86                                           (string :tag "Prescript"))
  87                                    (group :inline t
  88                                           (const :format "" :value :postscript)
  89                                           (string :tag "Postscript"))
  90                                    (group :inline t
  91                                           (const :format "" :value :plugged)
  92                                           (boolean :tag "Plugged"))))
  93                   (cons :tag "POP3 server"
  94                         (const :format "" pop)
  95                         (checklist :tag "Options" :greedy t
  96                                    (group :inline t
  97                                           (const :format "" :value :server)
  98                                           (string :tag "Server"))
  99                                    (group :inline t
 100                                           (const :format "" :value :port)
 101                                           (choice :tag "Port"
 102                                                   :value "pop3"
 103                                                   (number :format "%v")
 104                                                   (string :format "%v")))
 105                                    (group :inline t
 106                                           (const :format "" :value :user)
 107                                           (string :tag "User"))
 108                                    (group :inline t
 109                                           (const :format "" :value :password)
 110                                           (string :tag "Password"))
 111                                    (group :inline t
 112                                           (const :format "" :value :program)
 113                                           (string :tag "Program"))
 114                                    (group :inline t
 115                                           (const :format "" :value :prescript)
 116                                           (string :tag "Prescript"))
 117                                    (group :inline t
 118                                           (const :format "" :value :postscript)
 119                                           (string :tag "Postscript"))
 120                                    (group :inline t
 121                                           (const :format "" :value :function)
 122                                           (function :tag "Function"))
 123                                    (group :inline t
 124                                           (const :format ""
 125                                                  :value :authentication)
 126                                           (choice :tag "Authentication"
 127                                                   :value apop
 128                                                   (const password)
 129                                                   (const apop)))
 130                                    (group :inline t
 131                                           (const :format "" :value :plugged)
 132                                           (boolean :tag "Plugged"))))
 133                   (cons :tag "Maildir (qmail, postfix...)"
 134                         (const :format "" maildir)
 135                         (checklist :tag "Options" :greedy t
 136                                    (group :inline t
 137                                           (const :format "" :value :path)
 138                                           (directory :tag "Path"))
 139                                    (group :inline t
 140                                           (const :format "" :value :plugged)
 141                                           (boolean :tag "Plugged"))))
 142                   (cons :tag "IMAP server"
 143                         (const :format "" imap)
 144                         (checklist :tag "Options" :greedy t
 145                                    (group :inline t
 146                                           (const :format "" :value :server)
 147                                           (string :tag "Server"))
 148                                    (group :inline t
 149                                           (const :format "" :value :port)
 150                                           (choice :tag "Port"
 151                                                   :value 143
 152                                                   number string))
 153                                    (group :inline t
 154                                           (const :format "" :value :user)
 155                                           (string :tag "User"))
 156                                    (group :inline t
 157                                           (const :format "" :value :password)
 158                                           (string :tag "Password"))
 159                                    (group :inline t
 160                                           (const :format "" :value :stream)
 161                                           (choice :tag "Stream"
 162                                                   :value network
 163                                                   ,@mail-source-imap-streams))
 164                                    (group :inline t
 165                                           (const :format "" :value :program)
 166                                           (string :tag "Program"))
 167                                    (group :inline t
 168                                           (const :format ""
 169                                                  :value :authenticator)
 170                                           (choice :tag "Authenticator"
 171                                                   :value login
 172                                                   ,@mail-source-imap-authenticators))
 173                                    (group :inline t
 174                                           (const :format "" :value :mailbox)
 175                                           (string :tag "Mailbox"
 176                                                   :value "INBOX"))
 177                                    (group :inline t
 178                                           (const :format "" :value :predicate)
 179                                           (string :tag "Predicate"
 180                                                   :value "UNSEEN UNDELETED"))
 181                                    (group :inline t
 182                                           (const :format "" :value :fetchflag)
 183                                           (string :tag "Fetchflag"
 184                                                   :value  "\\Deleted"))
 185                                    (group :inline t
 186                                           (const :format ""
 187                                                  :value :dontexpunge)
 188                                           (boolean :tag "Dontexpunge"))
 189                                    (group :inline t
 190                                           (const :format "" :value :plugged)
 191                                           (boolean :tag "Plugged"))))
 192                   (cons :tag "Webmail server"
 193                         (const :format "" webmail)
 194                         (checklist :tag "Options" :greedy t
 195                                    (group :inline t
 196                                           (const :format "" :value :subtype)
 197                                           ;; Should be generated from
 198                                           ;; `webmail-type-definition', but we
 199                                           ;; can't require webmail without W3.
 200                                           (choice :tag "Subtype"
 201                                                   :value hotmail
 202                                                   (const hotmail)
 203                                                   (const yahoo)
 204                                                   (const netaddress)
 205                                                   (const netscape)
 206                                                   (const my-deja)))
 207                                    (group :inline t
 208                                           (const :format "" :value :user)
 209                                           (string :tag "User"))
 210                                    (group :inline t
 211                                           (const :format "" :value :password)
 212                                           (string :tag "Password"))
 213                                    (group :inline t
 214                                           (const :format ""
 215                                                  :value :dontexpunge)
 216                                           (boolean :tag "Dontexpunge"))
 217                                    (group :inline t
 218                                           (const :format "" :value :plugged)
 219                                           (boolean :tag "Plugged")))))))
 220
 221 (defcustom mail-source-primary-source nil
 222   "*Primary source for incoming mail.
 223 If non-nil, this maildrop will be checked periodically for new mail."
 224   :group 'mail-source
 225   :type 'sexp)
 226
 227 (defcustom mail-source-flash t
 228   "*If non-nil, flash periodically when mail is available."
 229   :group 'mail-source
 230   :type 'boolean)
 231
 232 (defcustom mail-source-crash-box "~/.emacs-mail-crash-box"
 233   "File where mail will be stored while processing it."
 234   :group 'mail-source
 235   :type 'file)
 236
 237 (defcustom mail-source-directory message-directory
 238   "Directory where files (if any) will be stored."
 239   :group 'mail-source
 240   :type 'directory)
 241
 242 (defcustom mail-source-default-file-modes 384
 243   "Set the mode bits of all new mail files to this integer."
 244   :group 'mail-source
 245   :type 'integer)
 246
 247 (defcustom mail-source-delete-incoming nil
 248   "*If non-nil, delete incoming files after handling."
 249   :group 'mail-source
 250   :type 'boolean)
 251
 252 (defcustom mail-source-incoming-file-prefix "Incoming"
 253   "Prefix for file name for storing incoming mail"
 254   :group 'mail-source
 255   :type 'string)
 256
 257 (defcustom mail-source-report-new-mail-interval 5
 258   "Interval in minutes between checks for new mail."
 259   :group 'mail-source
 260   :type 'number)
 261
 262 (defcustom mail-source-idle-time-delay 5
 263   "Number of idle seconds to wait before checking for new mail."
 264   :group 'mail-source
 265   :type 'number)
 266
 267 (defcustom mail-source-movemail-program nil
 268   "If non-nil, name of program for fetching new mail."
 269   :group 'mail-source
 270   :type '(choice (const nil) string))
 271
 272 ;;; Internal variables.
 273
 274 (defvar mail-source-string ""
 275   "A dynamically bound string that says what the current mail source is.")
 276
 277 (defvar mail-source-new-mail-available nil
 278   "Flag indicating when new mail is available.")
 279
 280 (eval-and-compile
 281   (defvar mail-source-common-keyword-map
 282     '((:plugged))
 283     "Mapping from keywords to default values.
 284 Common keywords should be listed here.")
 285
 286   (defvar mail-source-keyword-map
 287     '((file
 288        (:prescript)
 289        (:prescript-delay)
 290        (:postscript)
 291        (:path (or (getenv "MAIL")
 292                   (expand-file-name (user-login-name) rmail-spool-directory))))
 293       (directory
 294        (:prescript)
 295        (:prescript-delay)
 296        (:postscript)
 297        (:path)
 298        (:suffix ".spool")
 299        (:predicate identity))
 300       (pop
 301        (:prescript)
 302        (:prescript-delay)
 303        (:postscript)
 304        (:server (getenv "MAILHOST"))
 305        (:port 110)
 306        (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
 307        (:program)
 308        (:function)
 309        (:password)
 310        (:connection)
 311        (:authentication password)
 312        (:leave))
 313       (maildir
 314        (:path (or (getenv "MAILDIR") "~/Maildir/"))
 315        (:subdirs ("new" "cur"))
 316        (:function))
 317       (imap
 318        (:server (getenv "MAILHOST"))
 319        (:port)
 320        (:stream)
 321        (:program)
 322        (:authentication)
 323        (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
 324        (:password)
 325        (:mailbox "INBOX")
 326        (:predicate "UNSEEN UNDELETED")
 327        (:fetchflag "\\Deleted")
 328        (:dontexpunge))
 329       (webmail
 330        (:subtype hotmail)
 331        (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
 332        (:password)
 333        (:dontexpunge)
 334        (:authentication password)))
 335     "Mapping from keywords to default values.
 336 All keywords that can be used must be listed here."))
 337
 338 (defvar mail-source-fetcher-alist
 339   '((file mail-source-fetch-file)
 340     (directory mail-source-fetch-directory)
 341     (pop mail-source-fetch-pop)
 342     (maildir mail-source-fetch-maildir)
 343     (imap mail-source-fetch-imap)
 344     (webmail mail-source-fetch-webmail))
 345   "A mapping from source type to fetcher function.")
 346
 347 (defvar mail-source-password-cache nil)
 348
 349 (defvar mail-source-plugged t)
 350
 351 ;;; Functions
 352
 353 (eval-and-compile
 354   (defun mail-source-strip-keyword (keyword)
 355     "Strip the leading colon off the KEYWORD."
 356     (intern (substring (symbol-name keyword) 1))))
 357
 358 (eval-and-compile
 359   (defun mail-source-bind-1 (type)
 360     (let* ((defaults (cdr (assq type mail-source-keyword-map)))
 361            default bind)
 362       (while (setq default (pop defaults))
 363         (push (list (mail-source-strip-keyword (car default))
 364                     nil)
 365               bind))
 366       bind)))
 367
 368 (defmacro mail-source-bind (type-source &rest body)
 369   "Return a `let' form that binds all variables in source TYPE.
 370 TYPE-SOURCE is a list where the first element is the TYPE, and
 371 the second variable is the SOURCE.
 372 At run time, the mail source specifier SOURCE will be inspected,
 373 and the variables will be set according to it.  Variables not
 374 specified will be given default values.
 375
 376 After this is done, BODY will be executed in the scope
 377 of the `let' form.
 378
 379 The variables bound and their default values are described by
 380 the `mail-source-keyword-map' variable."
 381   `(let ,(mail-source-bind-1 (car type-source))
 382      (mail-source-set-1 ,(cadr type-source))
 383      ,@body))
 384
 385 (put 'mail-source-bind 'lisp-indent-function 1)
 386 (put 'mail-source-bind 'edebug-form-spec '(sexp body))
 387
 388 (defun mail-source-set-1 (source)
 389   (let* ((type (pop source))
 390          (defaults (cdr (assq type mail-source-keyword-map)))
 391          default value keyword)
 392     (while (setq default (pop defaults))
 393       (set (mail-source-strip-keyword (setq keyword (car default)))
 394            (if (setq value (plist-get source keyword))
 395                (mail-source-value value)
 396              (mail-source-value (cadr default)))))))
 397
 398 (eval-and-compile
 399   (defun mail-source-bind-common-1 ()
 400     (let* ((defaults mail-source-common-keyword-map)
 401            default bind)
 402       (while (setq default (pop defaults))
 403         (push (list (mail-source-strip-keyword (car default))
 404                     nil)
 405               bind))
 406       bind)))
 407
 408 (defun mail-source-set-common-1 (source)
 409   (let* ((type (pop source))
 410          (defaults mail-source-common-keyword-map)
 411          (defaults-1 (cdr (assq type mail-source-keyword-map)))
 412          default value keyword)
 413     (while (setq default (pop defaults))
 414       (set (mail-source-strip-keyword (setq keyword (car default)))
 415            (if (setq value (plist-get source keyword))
 416                (mail-source-value value)
 417              (if (setq value (assq  keyword defaults-1))
 418                  (mail-source-value (cadr value))
 419                (mail-source-value (cadr default))))))))
 420
 421 (defmacro mail-source-bind-common (source &rest body)
 422   "Return a `let' form that binds all common variables.
 423 See `mail-source-bind'."
 424   `(let ,(mail-source-bind-common-1)
 425      (mail-source-set-common-1 source)
 426      ,@body))
 427
 428 (put 'mail-source-bind-common 'lisp-indent-function 1)
 429 (put 'mail-source-bind-common 'edebug-form-spec '(sexp body))
 430
 431 (defun mail-source-value (value)
 432   "Return the value of VALUE."
 433   (cond
 434    ;; String
 435    ((stringp value)
 436     value)
 437    ;; Function
 438    ((and (listp value)
 439          (functionp (car value)))
 440     (eval value))
 441    ;; Just return the value.
 442    (t
 443     value)))
 444
 445 (defun mail-source-fetch (source callback)
 446   "Fetch mail from SOURCE and call CALLBACK zero or more times.
 447 CALLBACK will be called with the name of the file where (some of)
 448 the mail from SOURCE is put.
 449 Return the number of files that were found."
 450   (mail-source-bind-common source
 451     (if (or mail-source-plugged plugged)
 452         (save-excursion
 453           (let ((function (cadr (assq (car source) mail-source-fetcher-alist)))
 454                 (found 0))
 455             (unless function
 456               (error "%S is an invalid mail source specification" source))
 457             ;; If there's anything in the crash box, we do it first.
 458             (when (file-exists-p mail-source-crash-box)
 459               (message "Processing mail from %s..." mail-source-crash-box)
 460               (setq found (mail-source-callback
 461                            callback mail-source-crash-box)))
 462             (+ found
 463                (if (or debug-on-quit debug-on-error)
 464                    (funcall function source callback)
 465                  (condition-case err
 466                      (funcall function source callback)
 467                    (error
 468                     (unless (yes-or-no-p
 469                              (format "Mail source error (%s).  Continue? "
 470                                      (cadr err)))
 471                       (error "Cannot get new mail"))
 472                     0)))))))))
 473
 474 (eval-and-compile
 475   (if (fboundp 'make-temp-file)
 476       (defalias 'mail-source-make-complex-temp-name 'make-temp-file)
 477     (defun mail-source-make-complex-temp-name (prefix)
 478       (let ((newname (make-temp-name prefix))
 479             (newprefix prefix))
 480         (while (file-exists-p newname)
 481           (setq newprefix (concat newprefix "x"))
 482           (setq newname (make-temp-name newprefix)))
 483         newname))))
 484
 485 (defun mail-source-callback (callback info)
 486   "Call CALLBACK on the mail file, and then remove the mail file.
 487 Pass INFO on to CALLBACK."
 488   (if (or (not (file-exists-p mail-source-crash-box))
 489           (zerop (nth 7 (file-attributes mail-source-crash-box))))
 490       (progn
 491         (when (file-exists-p mail-source-crash-box)
 492           (delete-file mail-source-crash-box))
 493         0)
 494     (prog1
 495         (funcall callback mail-source-crash-box info)
 496       (when (file-exists-p mail-source-crash-box)
 497         ;; Delete or move the incoming mail out of the way.
 498         (if mail-source-delete-incoming
 499             (delete-file mail-source-crash-box)
 500           (let ((incoming
 501                  (mail-source-make-complex-temp-name
 502                   (expand-file-name
 503                    mail-source-incoming-file-prefix
 504                    mail-source-directory))))
 505             (unless (file-exists-p (file-name-directory incoming))
 506               (make-directory (file-name-directory incoming) t))
 507             (rename-file mail-source-crash-box incoming t)))))))
 508
 509 (defun mail-source-movemail (from to)
 510   "Move FROM to TO using movemail."
 511   (if (not (file-writable-p to))
 512       (error "Can't write to crash box %s.  Not moving mail" to)
 513     (let ((to (file-truename (expand-file-name to)))
 514           errors result)
 515       (setq to (file-truename to)
 516             from (file-truename from))
 517       ;; Set TO if have not already done so, and rename or copy
 518       ;; the file FROM to TO if and as appropriate.
 519       (cond
 520        ((file-exists-p to)
 521         ;; The crash box exists already.
 522         t)
 523        ((not (file-exists-p from))
 524         ;; There is no inbox.
 525         (setq to nil))
 526        ((zerop (nth 7 (file-attributes from)))
 527         ;; Empty file.
 528         (setq to nil))
 529        (t
 530         ;; If getting from mail spool directory, use movemail to move
 531         ;; rather than just renaming, so as to interlock with the
 532         ;; mailer.
 533         (unwind-protect
 534             (save-excursion
 535               (setq errors (generate-new-buffer " *mail source loss*"))
 536               (let ((default-directory "/"))
 537                 (setq result
 538                       (apply
 539                        'call-process
 540                        (append
 541                         (list
 542                          (or mail-source-movemail-program
 543                              (expand-file-name "movemail" exec-directory))
 544                          nil errors nil from to)))))
 545               (when (file-exists-p to)
 546                 (set-file-modes to mail-source-default-file-modes))
 547               (if (and (or (not (buffer-modified-p errors))
 548                            (zerop (buffer-size errors)))
 549                        (zerop result))
 550                   ;; No output => movemail won.
 551                   t
 552                 (set-buffer errors)
 553                 ;; There may be a warning about older revisions.  We
 554                 ;; ignore that.
 555                 (goto-char (point-min))
 556                 (if (search-forward "older revision" nil t)
 557                     t
 558                   ;; Probably a real error.
 559                   (subst-char-in-region (point-min) (point-max) ?\n ?\  )
 560                   (goto-char (point-max))
 561                   (skip-chars-backward " \t")
 562                   (delete-region (point) (point-max))
 563                   (goto-char (point-min))
 564                   (when (looking-at "movemail: ")
 565                     (delete-region (point-min) (match-end 0)))
 566                   ;; Result may be a signal description string.
 567                   (unless (yes-or-no-p
 568                            (format "movemail: %s (%s return).  Continue? "
 569                                    (buffer-string) result))
 570                     (error "%s" (buffer-string)))
 571                   (setq to nil)))))))
 572       (when (and errors
 573                  (buffer-name errors))
 574         (kill-buffer errors))
 575       ;; Return whether we moved successfully or not.
 576       to)))
 577
 578 (defun mail-source-movemail-and-remove (from to)
 579   "Move FROM to TO using movemail, then remove FROM if empty."
 580   (or (not (mail-source-movemail from to))
 581       (not (zerop (nth 7 (file-attributes from))))
 582       (delete-file from)))
 583
 584 (defvar mail-source-read-passwd nil)
 585 (defun mail-source-read-passwd (prompt &rest args)
 586   "Read a password using PROMPT.
 587 If ARGS, PROMPT is used as an argument to `format'."
 588   (let ((prompt
 589          (if args
 590              (apply 'format prompt args)
 591            prompt)))
 592     (unless mail-source-read-passwd
 593       (if (or (fboundp 'read-passwd) (load "passwd" t))
 594           (setq mail-source-read-passwd 'read-passwd)
 595         (unless (fboundp 'ange-ftp-read-passwd)
 596           (autoload 'ange-ftp-read-passwd "ange-ftp"))
 597         (setq mail-source-read-passwd 'ange-ftp-read-passwd)))
 598     (funcall mail-source-read-passwd prompt)))
 599
 600 (defun mail-source-fetch-with-program (program)
 601   (zerop (call-process shell-file-name nil nil nil
 602                        shell-command-switch program)))
 603
 604 (defun mail-source-run-script (script spec &optional delay)
 605   (when script
 606     (if (and (symbolp script) (fboundp script))
 607         (funcall script)
 608       (mail-source-call-script
 609        (format-spec script spec))))
 610   (when delay
 611     (sleep-for delay)))
 612
 613 (defun mail-source-call-script (script)
 614   (let ((background nil))
 615     (when (string-match "& *$" script)
 616       (setq script (substring script 0 (match-beginning 0))
 617             background 0))
 618     (call-process shell-file-name nil background nil
 619                   shell-command-switch script)))
 620
 621 ;;;
 622 ;;; Different fetchers
 623 ;;;
 624
 625 (defun mail-source-fetch-file (source callback)
 626   "Fetcher for single-file sources."
 627   (mail-source-bind (file source)
 628     (mail-source-run-script
 629      prescript (format-spec-make ?t mail-source-crash-box)
 630      prescript-delay)
 631     (let ((mail-source-string (format "file:%s" path)))
 632       (if (mail-source-movemail path mail-source-crash-box)
 633           (prog1
 634               (mail-source-callback callback path)
 635             (mail-source-run-script
 636              postscript (format-spec-make ?t mail-source-crash-box)))
 637         0))))
 638
 639 (defun mail-source-fetch-directory (source callback)
 640   "Fetcher for directory sources."
 641   (mail-source-bind (directory source)
 642     (mail-source-run-script
 643      prescript (format-spec-make ?t path)
 644      prescript-delay)
 645     (let ((found 0)
 646           (mail-source-string (format "directory:%s" path)))
 647       (dolist (file (directory-files
 648                      path t (concat (regexp-quote suffix) "$")))
 649         (when (and (file-regular-p file)
 650                    (funcall predicate file)
 651                    (mail-source-movemail file mail-source-crash-box))
 652           (incf found (mail-source-callback callback file))))
 653       (mail-source-run-script
 654        postscript (format-spec-make ?t path))
 655       found)))
 656
 657 (defun mail-source-fetch-pop (source callback)
 658   "Fetcher for single-file sources."
 659   (mail-source-bind (pop source)
 660     (mail-source-run-script
 661      prescript
 662      (format-spec-make ?p password ?t mail-source-crash-box
 663                        ?s server ?P port ?u user)
 664      prescript-delay)
 665     (let ((from (format "%s:%s:%s" server user port))
 666           (mail-source-string (format "pop:%s@%s" user server))
 667           result)
 668       (when (eq authentication 'password)
 669         (setq password
 670               (or password
 671                   (cdr (assoc from mail-source-password-cache))
 672                   (mail-source-read-passwd
 673                    (format "Password for %s at %s: " user server)))))
 674       (when server
 675         (setenv "MAILHOST" server))
 676       (setq result
 677             (cond
 678              (program
 679               (mail-source-fetch-with-program
 680                (format-spec
 681                 program
 682                 (format-spec-make ?p password ?t mail-source-crash-box
 683                                   ?s server ?P port ?u user))))
 684              (function
 685               (funcall function mail-source-crash-box))
 686              ;; The default is to use pop3.el.
 687              (t
 688               (let ((pop3-password password)
 689                     (pop3-maildrop user)
 690                     (pop3-mailhost server)
 691                     (pop3-port port)
 692                     (pop3-authentication-scheme
 693                      (if (eq authentication 'apop) 'apop 'pass))
 694                     (pop3-connection-type connection)
 695                     (pop3-leave-mail-on-server
 696                      (or leave
 697                          (and (boundp 'pop3-leave-mail-on-server)
 698                               pop3-leave-mail-on-server))))
 699                 (if (or debug-on-quit debug-on-error)
 700                     (save-excursion (pop3-movemail mail-source-crash-box))
 701                   (condition-case err
 702                       (save-excursion (pop3-movemail mail-source-crash-box))
 703                     (error
 704                      ;; We nix out the password in case the error
 705                      ;; was because of a wrong password being given.
 706                      (setq mail-source-password-cache
 707                            (delq (assoc from mail-source-password-cache)
 708                                  mail-source-password-cache))
 709                      (signal (car err) (cdr err)))))))))
 710       (if result
 711           (progn
 712             (when (eq authentication 'password)
 713               (unless (assoc from mail-source-password-cache)
 714                 (push (cons from password) mail-source-password-cache)))
 715             (prog1
 716                 (mail-source-callback callback server)
 717               ;; Update display-time's mail flag, if relevant.
 718               (if (equal source mail-source-primary-source)
 719                   (setq mail-source-new-mail-available nil))
 720               (mail-source-run-script
 721                postscript
 722                (format-spec-make ?p password ?t mail-source-crash-box
 723                                  ?s server ?P port ?u user))))
 724         ;; We nix out the password in case the error
 725         ;; was because of a wrong password being given.
 726         (setq mail-source-password-cache
 727               (delq (assoc from mail-source-password-cache)
 728                     mail-source-password-cache))
 729         0))))
 730
 731 (defun mail-source-check-pop (source)
 732   "Check whether there is new mail."
 733   (mail-source-bind (pop source)
 734     (let ((from (format "%s:%s:%s" server user port))
 735           (mail-source-string (format "pop:%s@%s" user server))
 736           result)
 737       (when (eq authentication 'password)
 738         (setq password
 739               (or password
 740                   (cdr (assoc from mail-source-password-cache))
 741                   (mail-source-read-passwd
 742                    (format "Password for %s at %s: " user server))))
 743         (unless (assoc from mail-source-password-cache)
 744           (push (cons from password) mail-source-password-cache)))
 745       (when server
 746         (setenv "MAILHOST" server))
 747       (setq result
 748             (cond
 749              ;; No easy way to check whether mail is waiting for these.
 750              (program)
 751              (function)
 752              ;; The default is to use pop3.el.
 753              (t
 754               (let ((pop3-password password)
 755                     (pop3-maildrop user)
 756                     (pop3-mailhost server)
 757                     (pop3-port port)
 758                     (pop3-authentication-scheme
 759                      (if (eq authentication 'apop) 'apop 'pass)))
 760                 (if (or debug-on-quit debug-on-error)
 761                     (save-excursion (pop3-get-message-count))
 762                   (condition-case err
 763                       (save-excursion (pop3-get-message-count))
 764                     (error
 765                      ;; We nix out the password in case the error
 766                      ;; was because of a wrong password being given.
 767                      (setq mail-source-password-cache
 768                            (delq (assoc from mail-source-password-cache)
 769                                  mail-source-password-cache))
 770                      (signal (car err) (cdr err)))))))))
 771       (if result
 772           ;; Inform display-time that we have new mail.
 773           (setq mail-source-new-mail-available (> result 0))
 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)))
 779       result)))
 780
 781 (defun mail-source-new-mail-p ()
 782   "Handler for `display-time' to indicate when new mail is available."
 783   ;; Flash (ie. ring the visible bell) if mail is available.
 784   (if (and mail-source-flash mail-source-new-mail-available)
 785       (let ((visible-bell t))
 786         (ding)))
 787   ;; Only report flag setting; flag is updated on a different schedule.
 788   mail-source-new-mail-available)
 789
 790
 791 (defvar mail-source-report-new-mail nil)
 792 (defvar mail-source-report-new-mail-timer nil)
 793 (defvar mail-source-report-new-mail-idle-timer nil)
 794
 795 (eval-when-compile
 796   (if (featurep 'xemacs)
 797       (require 'itimer)
 798     (require 'timer)))
 799
 800 (defun mail-source-start-idle-timer ()
 801   ;; Start our idle timer if necessary, so we delay the check until the
 802   ;; user isn't typing.
 803   (unless mail-source-report-new-mail-idle-timer
 804     (setq mail-source-report-new-mail-idle-timer
 805           (run-with-idle-timer
 806            mail-source-idle-time-delay
 807            nil
 808            (lambda ()
 809              (unwind-protect
 810                  (mail-source-check-pop mail-source-primary-source)
 811                (setq mail-source-report-new-mail-idle-timer nil)))))
 812     ;; Since idle timers created when Emacs is already in the idle
 813     ;; state don't get activated until Emacs _next_ becomes idle, we
 814     ;; need to force our timer to be considered active now.  We do
 815     ;; this by being naughty and poking the timer internals directly
 816     ;; (element 0 of the vector is nil if the timer is active).
 817     (aset mail-source-report-new-mail-idle-timer 0 nil)))
 818
 819 (defun mail-source-report-new-mail (arg)
 820   "Toggle whether to report when new mail is available.
 821 This only works when `display-time' is enabled."
 822   (interactive "P")
 823   (if (not mail-source-primary-source)
 824       (error "Need to set `mail-source-primary-source' to check for new mail"))
 825   (let ((on (if (null arg)
 826                 (not mail-source-report-new-mail)
 827               (> (prefix-numeric-value arg) 0))))
 828     (setq mail-source-report-new-mail on)
 829     (and mail-source-report-new-mail-timer
 830          (nnheader-cancel-timer mail-source-report-new-mail-timer))
 831     (and mail-source-report-new-mail-idle-timer
 832          (nnheader-cancel-timer mail-source-report-new-mail-idle-timer))
 833     (setq mail-source-report-new-mail-timer nil)
 834     (setq mail-source-report-new-mail-idle-timer nil)
 835     (if on
 836         (progn
 837           (require 'time)
 838           ;; display-time-mail-function is an Emacs 21 feature.
 839           (setq display-time-mail-function #'mail-source-new-mail-p)
 840           ;; Set up the main timer.
 841           (setq mail-source-report-new-mail-timer
 842                 (nnheader-run-at-time
 843                  (* 60 mail-source-report-new-mail-interval)
 844                  (* 60 mail-source-report-new-mail-interval)
 845                  #'mail-source-start-idle-timer))
 846           ;; When you get new mail, clear "Mail" from the mode line.
 847           (add-hook 'nnmail-post-get-new-mail-hook
 848                     'display-time-event-handler)
 849           (message "Mail check enabled"))
 850       (setq display-time-mail-function nil)
 851       (remove-hook 'nnmail-post-get-new-mail-hook
 852                    'display-time-event-handler)
 853       (message "Mail check disabled"))))
 854
 855 (defun mail-source-fetch-maildir (source callback)
 856   "Fetcher for maildir sources."
 857   (mail-source-bind (maildir source)
 858     (let ((found 0)
 859           mail-source-string)
 860       (unless (string-match "/$" path)
 861         (setq path (concat path "/")))
 862       (dolist (subdir subdirs)
 863         (when (file-directory-p (concat path subdir))
 864           (setq mail-source-string (format "maildir:%s%s" path subdir))
 865           (dolist (file (directory-files (concat path subdir) t))
 866             (when (and (not (file-directory-p file))
 867                        (not (if function
 868                                 (funcall function file mail-source-crash-box)
 869                               (let ((coding-system-for-write
 870                                      nnheader-text-coding-system)
 871                                     (coding-system-for-read
 872                                      nnheader-text-coding-system)
 873                                     (output-coding-system
 874                                      nnheader-text-coding-system)
 875                                     (input-coding-system
 876                                      nnheader-text-coding-system))
 877                                 (with-temp-file mail-source-crash-box
 878                                   (insert-file-contents file)
 879                                   (goto-char (point-min))
 880 ;;;                               ;; Unix mail format
 881 ;;;                               (unless (looking-at "\n*From ")
 882 ;;;                                 (insert "From maildir "
 883 ;;;                                         (current-time-string) "\n"))
 884 ;;;                               (while (re-search-forward "^From " nil t)
 885 ;;;                                 (replace-match ">From "))
 886 ;;;                               (goto-char (point-max))
 887 ;;;                               (insert "\n\n")
 888                                   ;; MMDF mail format
 889                                   (insert "\001\001\001\001\n"))
 890                                 (delete-file file)))))
 891               (incf found (mail-source-callback callback file))))))
 892       found)))
 893
 894 (eval-and-compile
 895   (autoload 'imap-open "imap")
 896   (autoload 'imap-authenticate "imap")
 897   (autoload 'imap-mailbox-select "imap")
 898   (autoload 'imap-mailbox-unselect "imap")
 899   (autoload 'imap-mailbox-close "imap")
 900   (autoload 'imap-search "imap")
 901   (autoload 'imap-fetch "imap")
 902   (autoload 'imap-close "imap")
 903   (autoload 'imap-error-text "imap")
 904   (autoload 'imap-message-flags-add "imap")
 905   (autoload 'imap-list-to-message-set "imap")
 906   (autoload 'imap-range-to-message-set "imap"))
 907
 908 (defvar mail-source-imap-file-coding-system 'binary
 909   "Coding system for the crashbox made by `mail-source-fetch-imap'.")
 910
 911 (defun mail-source-fetch-imap (source callback)
 912   "Fetcher for imap sources."
 913   (mail-source-bind (imap source)
 914     (let ((from (format "%s:%s:%s" server user port))
 915           (found 0)
 916           (buf (get-buffer-create
 917                 (format " *imap source %s:%s:%s *" server user mailbox)))
 918           (mail-source-string (format "imap:%s:%s" server mailbox))
 919           (imap-shell-program (or (list program) imap-shell-program))
 920           remove)
 921       (if (and (imap-open server port stream authentication buf)
 922                (imap-authenticate
 923                 user (or (cdr (assoc from mail-source-password-cache))
 924                          password) buf)
 925                (imap-mailbox-select mailbox nil buf))
 926           (let ((coding-system-for-write mail-source-imap-file-coding-system)
 927                 (output-coding-system mail-source-imap-file-coding-system)
 928                 str)
 929             (with-temp-file mail-source-crash-box
 930               ;; Avoid converting 8-bit chars from inserted strings to
 931               ;; multibyte.
 932               (set-buffer-multibyte nil)
 933               ;; remember password
 934               (with-current-buffer buf
 935                 (when (or imap-password
 936                           (assoc from mail-source-password-cache))
 937                   (push (cons from imap-password) mail-source-password-cache)))
 938               ;; if predicate is nil, use all uids
 939               (dolist (uid (imap-search (or predicate "1:*") buf))
 940                 (when (setq str
 941                             (if (imap-capability 'IMAP4rev1 buf)
 942                                 (caddar (imap-fetch uid "BODY.PEEK[]"
 943                                                     'BODYDETAIL nil buf))
 944                               (imap-fetch uid "RFC822.PEEK" 'RFC822 nil buf)))
 945                   (push uid remove)
 946                   (insert "From imap " (current-time-string) "\n")
 947                   (save-excursion
 948                     (insert str "\n\n"))
 949                   (while (re-search-forward "^From " nil t)
 950                     (replace-match ">From "))
 951                   (goto-char (point-max))))
 952               (nnheader-ms-strip-cr))
 953             (incf found (mail-source-callback callback server))
 954             (when (and remove fetchflag)
 955               (imap-message-flags-add
 956                (imap-range-to-message-set (gnus-compress-sequence remove))
 957                fetchflag nil buf))
 958             (if dontexpunge
 959                 (imap-mailbox-unselect buf)
 960               (imap-mailbox-close nil buf))
 961             (imap-close buf))
 962         (imap-close buf)
 963         ;; We nix out the password in case the error
 964         ;; was because of a wrong password being given.
 965         (setq mail-source-password-cache
 966               (delq (assoc from mail-source-password-cache)
 967                     mail-source-password-cache))
 968         (error (imap-error-text buf)))
 969       (kill-buffer buf)
 970       found)))
 971
 972 (eval-and-compile
 973   (autoload 'webmail-fetch "webmail"))
 974
 975 (defun mail-source-fetch-webmail (source callback)
 976   "Fetch for webmail source."
 977   (mail-source-bind (webmail source)
 978     (let ((mail-source-string (format "webmail:%s:%s" subtype user))
 979           (webmail-newmail-only dontexpunge)
 980           (webmail-move-to-trash-can (not dontexpunge)))
 981       (when (eq authentication 'password)
 982         (setq password
 983               (or password
 984                   (cdr (assoc (format "webmail:%s:%s" subtype user)
 985                               mail-source-password-cache))
 986                   (mail-source-read-passwd
 987                    (format "Password for %s at %s: " user subtype))))
 988         (when (and password
 989                    (not (assoc (format "webmail:%s:%s" subtype user)
 990                                mail-source-password-cache)))
 991           (push (cons (format "webmail:%s:%s" subtype user) password)
 992                 mail-source-password-cache)))
 993       (webmail-fetch mail-source-crash-box subtype user password)
 994       (mail-source-callback callback (symbol-name subtype)))))
 995
 996 (provide 'mail-source)
 997
 998 ;;; mail-source.el ends here