code.delx.au - gnu-emacs/blob - lisp/gnus/mail-source.el

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