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