cgit.sxemacs.org Git - gnus/blob - lisp/mail-source.el

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