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, 2009, 2010, 2011, 2012 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 (defun mail-source-delete-old-incoming (&optional age confirm)
 578   "Remove incoming files older than AGE days.
 579 If CONFIRM is non-nil, ask for confirmation before removing a file."
 580   (interactive "P")
 581   (let* ((high2days (/ 65536.0 60 60 24));; convert high bits to days
 582          (low2days  (/ 1.0 65536.0))     ;; convert low bits to days
 583          (diff (if (natnump age) age 30));; fallback, if no valid AGE given
 584          currday files)
 585     (setq files (directory-files
 586                  mail-source-directory t
 587                  (concat "\\`"
 588                          (regexp-quote mail-source-incoming-file-prefix)))
 589           currday (* (car (current-time)) high2days)
 590           currday (+ currday (* low2days (nth 1 (current-time)))))
 591     (while files
 592       (let* ((ffile (car files))
 593              (bfile (gnus-replace-in-string
 594                      ffile "\\`.*/\\([^/]+\\)\\'" "\\1"))
 595              (filetime (nth 5 (file-attributes ffile)))
 596              (fileday (* (car filetime) high2days))
 597              (fileday (+ fileday (* low2days (nth 1 filetime)))))
 598         (setq files (cdr files))
 599         (when (and (> (- currday fileday) diff)
 600                    (if confirm
 601                        (y-or-n-p
 602                         (format "\
 603 Delete old (> %s day(s)) incoming mail file `%s'? " diff bfile))
 604                      (gnus-message 8 "\
 605 Deleting old (> %s day(s)) incoming mail file `%s'." diff bfile)
 606                      t))
 607           (delete-file ffile))))))
 608
 609 (defun mail-source-callback (callback info)
 610   "Call CALLBACK on the mail file.  Pass INFO on to CALLBACK."
 611   (if (or (not (file-exists-p mail-source-crash-box))
 612           (zerop (nth 7 (file-attributes mail-source-crash-box))))
 613       (progn
 614         (when (file-exists-p mail-source-crash-box)
 615           (delete-file mail-source-crash-box))
 616         0)
 617     (funcall callback mail-source-crash-box info)))
 618
 619 (defun mail-source-delete-crash-box ()
 620   (when (file-exists-p mail-source-crash-box)
 621     ;; Delete or move the incoming mail out of the way.
 622     (if (eq mail-source-delete-incoming t)
 623         (delete-file mail-source-crash-box)
 624       (let ((incoming
 625              (mm-make-temp-file
 626               (expand-file-name
 627                mail-source-incoming-file-prefix
 628                mail-source-directory))))
 629         (unless (file-exists-p (file-name-directory incoming))
 630           (make-directory (file-name-directory incoming) t))
 631         (rename-file mail-source-crash-box incoming t)
 632         ;; remove old incoming files?
 633         (when (natnump mail-source-delete-incoming)
 634           (mail-source-delete-old-incoming
 635            mail-source-delete-incoming
 636            mail-source-delete-old-incoming-confirm))))))
 637
 638 (defun mail-source-movemail (from to)
 639   "Move FROM to TO using movemail."
 640   (if (not (file-writable-p to))
 641       (error "Can't write to crash box %s.  Not moving mail" to)
 642     (let ((to (file-truename (expand-file-name to)))
 643           errors result)
 644       (setq to (file-truename to)
 645             from (file-truename from))
 646       ;; Set TO if have not already done so, and rename or copy
 647       ;; the file FROM to TO if and as appropriate.
 648       (cond
 649        ((file-exists-p to)
 650         ;; The crash box exists already.
 651         t)
 652        ((not (file-exists-p from))
 653         ;; There is no inbox.
 654         (setq to nil))
 655        ((zerop (nth 7 (file-attributes from)))
 656         ;; Empty file.
 657         (setq to nil))
 658        (t
 659         ;; If getting from mail spool directory, use movemail to move
 660         ;; rather than just renaming, so as to interlock with the
 661         ;; mailer.
 662         (unwind-protect
 663             (save-excursion
 664               (setq errors (generate-new-buffer " *mail source loss*"))
 665               (let ((default-directory "/"))
 666                 (setq result
 667                       (apply
 668                        'call-process
 669                        (append
 670                         (list
 671                          (or mail-source-movemail-program
 672                              (expand-file-name "movemail" exec-directory))
 673                          nil errors nil from to)))))
 674               (when (file-exists-p to)
 675                 (set-file-modes to mail-source-default-file-modes))
 676               (if (and (or (not (buffer-modified-p errors))
 677                            (zerop (buffer-size errors)))
 678                        (and (numberp result)
 679                             (zerop result)))
 680                   ;; No output => movemail won.
 681                   t
 682                 (set-buffer errors)
 683                 ;; There may be a warning about older revisions.  We
 684                 ;; ignore that.
 685                 (goto-char (point-min))
 686                 (if (search-forward "older revision" nil t)
 687                     t
 688                   ;; Probably a real error.
 689                   (subst-char-in-region (point-min) (point-max) ?\n ?\  )
 690                   (goto-char (point-max))
 691                   (skip-chars-backward " \t")
 692                   (delete-region (point) (point-max))
 693                   (goto-char (point-min))
 694                   (when (looking-at "movemail: ")
 695                     (delete-region (point-min) (match-end 0)))
 696                   ;; Result may be a signal description string.
 697                   (unless (yes-or-no-p
 698                            (format "movemail: %s (%s return).  Continue? "
 699                                    (buffer-string) result))
 700                     (error "%s" (buffer-string)))
 701                   (setq to nil)))))))
 702       (when (and errors
 703                  (buffer-name errors))
 704         (kill-buffer errors))
 705       ;; Return whether we moved successfully or not.
 706       to)))
 707
 708 (defun mail-source-movemail-and-remove (from to)
 709   "Move FROM to TO using movemail, then remove FROM if empty."
 710   (or (not (mail-source-movemail from to))
 711       (not (zerop (nth 7 (file-attributes from))))
 712       (delete-file from)))
 713
 714 (defun mail-source-fetch-with-program (program)
 715   (eq 0 (call-process shell-file-name nil nil nil
 716                       shell-command-switch program)))
 717
 718 (defun mail-source-run-script (script spec &optional delay)
 719   (when script
 720     (if (functionp script)
 721         (funcall script)
 722       (mail-source-call-script
 723        (format-spec script spec))))
 724   (when delay
 725     (sleep-for delay)))
 726
 727 (defun mail-source-call-script (script)
 728   (let ((background nil)
 729         (stderr (get-buffer-create " *mail-source-stderr*"))
 730         result)
 731     (when (string-match "& *$" script)
 732       (setq script (substring script 0 (match-beginning 0))
 733             background 0))
 734     (setq result
 735           (call-process shell-file-name nil background nil
 736                         shell-command-switch script))
 737     (when (and result
 738                (not (zerop result)))
 739       (set-buffer stderr)
 740       (message "Mail source error: %s" (buffer-string)))
 741     (kill-buffer stderr)))
 742
 743 ;;;
 744 ;;; Different fetchers
 745 ;;;
 746
 747 (defun mail-source-fetch-file (source callback)
 748   "Fetcher for single-file sources."
 749   (mail-source-bind (file source)
 750     (mail-source-run-script
 751      prescript (format-spec-make ?t mail-source-crash-box)
 752      prescript-delay)
 753     (let ((mail-source-string (format "file:%s" path)))
 754       (if (mail-source-movemail path mail-source-crash-box)
 755           (prog1
 756               (mail-source-callback callback path)
 757             (mail-source-run-script
 758              postscript (format-spec-make ?t mail-source-crash-box))
 759             (mail-source-delete-crash-box))
 760         0))))
 761
 762 (defun mail-source-fetch-directory (source callback)
 763   "Fetcher for directory sources."
 764   (mail-source-bind (directory source)
 765     (mail-source-run-script
 766      prescript (format-spec-make ?t path) prescript-delay)
 767     (let ((found 0)
 768           (mail-source-string (format "directory:%s" path)))
 769       (dolist (file (directory-files
 770                      path t (concat (regexp-quote suffix) "$")))
 771         (when (and (file-regular-p file)
 772                    (funcall predicate file)
 773                    (mail-source-movemail file mail-source-crash-box))
 774           (incf found (mail-source-callback callback file))
 775           (mail-source-run-script postscript (format-spec-make ?t path))
 776           (mail-source-delete-crash-box)))
 777       found)))
 778
 779 (defun mail-source-fetch-pop (source callback)
 780   "Fetcher for single-file sources."
 781   (mail-source-bind (pop source)
 782     ;; fixme: deal with stream type in format specs
 783     (mail-source-run-script
 784      prescript
 785      (format-spec-make ?p password ?t mail-source-crash-box
 786                        ?s server ?P port ?u user)
 787      prescript-delay)
 788     (let ((from (format "%s:%s:%s" server user port))
 789           (mail-source-string (format "pop:%s@%s" user server))
 790           result)
 791       (when (eq authentication 'password)
 792         (setq password
 793               (or password
 794                   (cdr (assoc from mail-source-password-cache))
 795                   (read-passwd
 796                    (format "Password for %s at %s: " user server)))))
 797       (when server
 798         (setenv "MAILHOST" server))
 799       (setq result
 800             (cond
 801              (program
 802               (mail-source-fetch-with-program
 803                (format-spec
 804                 program
 805                 (format-spec-make ?p password ?t mail-source-crash-box
 806                                   ?s server ?P port ?u user))))
 807              (function
 808               (funcall function mail-source-crash-box))
 809              ;; The default is to use pop3.el.
 810              (t
 811               (require 'pop3)
 812               (let ((pop3-password password)
 813                     (pop3-maildrop user)
 814                     (pop3-mailhost server)
 815                     (pop3-port port)
 816                     (pop3-authentication-scheme
 817                      (if (eq authentication 'apop) 'apop 'pass))
 818                     (pop3-stream-type stream))
 819                 (if (or debug-on-quit debug-on-error)
 820                     (save-excursion (pop3-movemail mail-source-crash-box))
 821                   (condition-case err
 822                       (save-excursion (pop3-movemail mail-source-crash-box))
 823                     (error
 824                      ;; We nix out the password in case the error
 825                      ;; was because of a wrong password being given.
 826                      (setq mail-source-password-cache
 827                            (delq (assoc from mail-source-password-cache)
 828                                  mail-source-password-cache))
 829                      (signal (car err) (cdr err)))))))))
 830       (if result
 831           (progn
 832             (when (eq authentication 'password)
 833               (unless (assoc from mail-source-password-cache)
 834                 (push (cons from password) mail-source-password-cache)))
 835             (prog1
 836                 (mail-source-callback callback server)
 837               ;; Update display-time's mail flag, if relevant.
 838               (if (equal source mail-source-primary-source)
 839                   (setq mail-source-new-mail-available nil))
 840               (mail-source-run-script
 841                postscript
 842                (format-spec-make ?p password ?t mail-source-crash-box
 843                                  ?s server ?P port ?u user))
 844               (mail-source-delete-crash-box)))
 845         ;; We nix out the password in case the error
 846         ;; was because of a wrong password being given.
 847         (setq mail-source-password-cache
 848               (delq (assoc from mail-source-password-cache)
 849                     mail-source-password-cache))
 850         0))))
 851
 852 (defun mail-source-check-pop (source)
 853   "Check whether there is new mail."
 854   (mail-source-bind (pop source)
 855     (let ((from (format "%s:%s:%s" server user port))
 856           (mail-source-string (format "pop:%s@%s" user server))
 857           result)
 858       (when (eq authentication 'password)
 859         (setq password
 860               (or password
 861                   (cdr (assoc from mail-source-password-cache))
 862                   (read-passwd
 863                    (format "Password for %s at %s: " user server))))
 864         (unless (assoc from mail-source-password-cache)
 865           (push (cons from password) mail-source-password-cache)))
 866       (when server
 867         (setenv "MAILHOST" server))
 868       (setq result
 869             (cond
 870              ;; No easy way to check whether mail is waiting for these.
 871              (program)
 872              (function)
 873              ;; The default is to use pop3.el.
 874              (t
 875               (require 'pop3)
 876               (let ((pop3-password password)
 877                     (pop3-maildrop user)
 878                     (pop3-mailhost server)
 879                     (pop3-port port)
 880                     (pop3-authentication-scheme
 881                      (if (eq authentication 'apop) 'apop 'pass)))
 882                 (if (or debug-on-quit debug-on-error)
 883                     (save-excursion (pop3-get-message-count))
 884                   (condition-case err
 885                       (save-excursion (pop3-get-message-count))
 886                     (error
 887                      ;; We nix out the password in case the error
 888                      ;; was because of a wrong password being given.
 889                      (setq mail-source-password-cache
 890                            (delq (assoc from mail-source-password-cache)
 891                                  mail-source-password-cache))
 892                      (signal (car err) (cdr err)))))))))
 893       (if result
 894           ;; Inform display-time that we have new mail.
 895           (setq mail-source-new-mail-available (> result 0))
 896         ;; We nix out the password in case the error
 897         ;; was because of a wrong password being given.
 898         (setq mail-source-password-cache
 899               (delq (assoc from mail-source-password-cache)
 900                     mail-source-password-cache)))
 901       result)))
 902
 903 (defun mail-source-touch-pop ()
 904   "Open and close a POP connection shortly.
 905 POP server should be defined in `mail-source-primary-source' (which is
 906 preferred) or `mail-sources'.  You may use it for the POP-before-SMTP
 907 authentication.  To do that, you need to set the
 908 `message-send-mail-function' variable as `message-smtpmail-send-it'
 909 and put the following line in your ~/.gnus.el file:
 910
 911 \(add-hook 'message-send-mail-hook 'mail-source-touch-pop)
 912
 913 See the Gnus manual for details."
 914   (let ((sources (if mail-source-primary-source
 915                      (list mail-source-primary-source)
 916                    mail-sources)))
 917     (while sources
 918       (if (eq 'pop (car (car sources)))
 919           (mail-source-check-pop (car sources)))
 920       (setq sources (cdr sources)))))
 921
 922 (defun mail-source-new-mail-p ()
 923   "Handler for `display-time' to indicate when new mail is available."
 924   ;; Flash (ie. ring the visible bell) if mail is available.
 925   (if (and mail-source-flash mail-source-new-mail-available)
 926       (let ((visible-bell t))
 927         (ding)))
 928   ;; Only report flag setting; flag is updated on a different schedule.
 929   mail-source-new-mail-available)
 930
 931
 932 (defvar mail-source-report-new-mail nil)
 933 (defvar mail-source-report-new-mail-timer nil)
 934 (defvar mail-source-report-new-mail-idle-timer nil)
 935
 936 (defun mail-source-start-idle-timer ()
 937   ;; Start our idle timer if necessary, so we delay the check until the
 938   ;; user isn't typing.
 939   (unless mail-source-report-new-mail-idle-timer
 940     (setq mail-source-report-new-mail-idle-timer
 941           (run-with-idle-timer
 942            mail-source-idle-time-delay
 943            nil
 944            (lambda ()
 945              (unwind-protect
 946                  (mail-source-check-pop mail-source-primary-source)
 947                (setq mail-source-report-new-mail-idle-timer nil)))))
 948     ;; Since idle timers created when Emacs is already in the idle
 949     ;; state don't get activated until Emacs _next_ becomes idle, we
 950     ;; need to force our timer to be considered active now.  We do
 951     ;; this by being naughty and poking the timer internals directly
 952     ;; (element 0 of the vector is nil if the timer is active).
 953     (aset mail-source-report-new-mail-idle-timer 0 nil)))
 954
 955 (defun mail-source-report-new-mail (arg)
 956   "Toggle whether to report when new mail is available.
 957 This only works when `display-time' is enabled."
 958   (interactive "P")
 959   (if (not mail-source-primary-source)
 960       (error "Need to set `mail-source-primary-source' to check for new mail"))
 961   (let ((on (if (null arg)
 962                 (not mail-source-report-new-mail)
 963               (> (prefix-numeric-value arg) 0))))
 964     (setq mail-source-report-new-mail on)
 965     (and mail-source-report-new-mail-timer
 966          (nnheader-cancel-timer mail-source-report-new-mail-timer))
 967     (and mail-source-report-new-mail-idle-timer
 968          (nnheader-cancel-timer mail-source-report-new-mail-idle-timer))
 969     (setq mail-source-report-new-mail-timer nil)
 970     (setq mail-source-report-new-mail-idle-timer nil)
 971     (if on
 972         (progn
 973           (require 'time)
 974           ;; display-time-mail-function is an Emacs 21 feature.
 975           (setq display-time-mail-function #'mail-source-new-mail-p)
 976           ;; Set up the main timer.
 977           (setq mail-source-report-new-mail-timer
 978                 (run-at-time
 979                  (* 60 mail-source-report-new-mail-interval)
 980                  (* 60 mail-source-report-new-mail-interval)
 981                  #'mail-source-start-idle-timer))
 982           ;; When you get new mail, clear "Mail" from the mode line.
 983           (add-hook 'nnmail-post-get-new-mail-hook
 984                     'display-time-event-handler)
 985           (message "Mail check enabled"))
 986       (setq display-time-mail-function nil)
 987       (remove-hook 'nnmail-post-get-new-mail-hook
 988                    'display-time-event-handler)
 989       (message "Mail check disabled"))))
 990
 991 (defun mail-source-fetch-maildir (source callback)
 992   "Fetcher for maildir sources."
 993   (mail-source-bind (maildir source)
 994     (let ((found 0)
 995           mail-source-string)
 996       (unless (string-match "/$" path)
 997         (setq path (concat path "/")))
 998       (dolist (subdir subdirs)
 999         (when (file-directory-p (concat path subdir))
1000           (setq mail-source-string (format "maildir:%s%s" path subdir))
1001           (dolist (file (directory-files (concat path subdir) t))
1002             (when (and (not (file-directory-p file))
1003                        (not (if function
1004                                 (funcall function file mail-source-crash-box)
1005                               (let ((coding-system-for-write
1006                                      mm-text-coding-system)
1007                                     (coding-system-for-read
1008                                      mm-text-coding-system))
1009                                 (with-temp-file mail-source-crash-box
1010                                   (insert-file-contents file)
1011                                   (goto-char (point-min))
1012 ;;;                               ;; Unix mail format
1013 ;;;                               (unless (looking-at "\n*From ")
1014 ;;;                                 (insert "From maildir "
1015 ;;;                                         (current-time-string) "\n"))
1016 ;;;                               (while (re-search-forward "^From " nil t)
1017 ;;;                                 (replace-match ">From "))
1018 ;;;                               (goto-char (point-max))
1019 ;;;                               (insert "\n\n")
1020                                   ;; MMDF mail format
1021                                   (insert "\001\001\001\001\n"))
1022                                 (delete-file file)))))
1023               (incf found (mail-source-callback callback file))
1024               (mail-source-delete-crash-box)))))
1025       found)))
1026
1027 (autoload 'imap-open "imap")
1028 (autoload 'imap-authenticate "imap")
1029 (autoload 'imap-mailbox-select "imap")
1030 (autoload 'imap-mailbox-unselect "imap")
1031 (autoload 'imap-mailbox-close "imap")
1032 (autoload 'imap-search "imap")
1033 (autoload 'imap-fetch "imap")
1034 (autoload 'imap-close "imap")
1035 (autoload 'imap-error-text "imap")
1036 (autoload 'imap-message-flags-add "imap")
1037 (autoload 'imap-list-to-message-set "imap")
1038 (autoload 'imap-range-to-message-set "imap")
1039 (autoload 'nnheader-ms-strip-cr "nnheader")
1040
1041 (autoload 'gnus-compress-sequence "gnus-range")
1042
1043 (defvar mail-source-imap-file-coding-system 'binary
1044   "Coding system for the crashbox made by `mail-source-fetch-imap'.")
1045
1046 ;; Autoloads will bring in imap before this is called.
1047 (declare-function imap-capability "imap" (&optional identifier buffer))
1048
1049 (defun mail-source-fetch-imap (source callback)
1050   "Fetcher for imap sources."
1051   (mail-source-bind (imap source)
1052     (mail-source-run-script
1053      prescript (format-spec-make ?p password ?t mail-source-crash-box
1054                                  ?s server ?P port ?u user)
1055      prescript-delay)
1056     (let ((from (format "%s:%s:%s" server user port))
1057           (found 0)
1058           (buf (generate-new-buffer " *imap source*"))
1059           (mail-source-string (format "imap:%s:%s" server mailbox))
1060           (imap-shell-program (or (list program) imap-shell-program))
1061           remove)
1062       (if (and (imap-open server port stream authentication buf)
1063                (imap-authenticate
1064                 user (or (cdr (assoc from mail-source-password-cache))
1065                          password) buf)
1066                (imap-mailbox-select mailbox nil buf))
1067           (let ((coding-system-for-write mail-source-imap-file-coding-system)
1068                 str)
1069             (with-temp-file mail-source-crash-box
1070               ;; Avoid converting 8-bit chars from inserted strings to
1071               ;; multibyte.
1072               (mm-disable-multibyte)
1073               ;; remember password
1074               (with-current-buffer buf
1075                 (when (and imap-password
1076                            (not (assoc from mail-source-password-cache)))
1077                   (push (cons from imap-password) mail-source-password-cache)))
1078               ;; if predicate is nil, use all uids
1079               (dolist (uid (imap-search (or predicate "1:*") buf))
1080                 (when (setq str
1081                             (if (imap-capability 'IMAP4rev1 buf)
1082                                 (caddar (imap-fetch uid "BODY.PEEK[]"
1083                                                     'BODYDETAIL nil buf))
1084                               (imap-fetch uid "RFC822.PEEK" 'RFC822 nil buf)))
1085                   (push uid remove)
1086                   (insert "From imap " (current-time-string) "\n")
1087                   (save-excursion
1088                     (insert str "\n\n"))
1089                   (while (let ((case-fold-search nil))
1090                            (re-search-forward "^From " nil t))
1091                     (replace-match ">From "))
1092                   (goto-char (point-max))))
1093               (nnheader-ms-strip-cr))
1094             (incf found (mail-source-callback callback server))
1095             (mail-source-delete-crash-box)
1096             (when (and remove fetchflag)
1097               (setq remove (nreverse remove))
1098               (imap-message-flags-add
1099                (imap-range-to-message-set (gnus-compress-sequence remove))
1100                fetchflag nil buf))
1101             (if dontexpunge
1102                 (imap-mailbox-unselect buf)
1103               (imap-mailbox-close nil buf))
1104             (imap-close buf))
1105         (imap-close buf)
1106         ;; We nix out the password in case the error
1107         ;; was because of a wrong password being given.
1108         (setq mail-source-password-cache
1109               (delq (assoc from mail-source-password-cache)
1110                     mail-source-password-cache))
1111         (error "IMAP error: %s" (imap-error-text buf)))
1112       (kill-buffer buf)
1113       (mail-source-run-script
1114        postscript
1115        (format-spec-make ?p password ?t mail-source-crash-box
1116                          ?s server ?P port ?u user))
1117       found)))
1118
1119 (autoload 'webmail-fetch "webmail")
1120
1121 (defun mail-source-fetch-webmail (source callback)
1122   "Fetch for webmail source."
1123   (mail-source-bind (webmail source)
1124     (let ((mail-source-string (format "webmail:%s:%s" subtype user))
1125           (webmail-newmail-only dontexpunge)
1126           (webmail-move-to-trash-can (not dontexpunge)))
1127       (when (eq authentication 'password)
1128         (setq password
1129               (or password
1130                   (cdr (assoc (format "webmail:%s:%s" subtype user)
1131                               mail-source-password-cache))
1132                   (read-passwd
1133                    (format "Password for %s at %s: " user subtype))))
1134         (when (and password
1135                    (not (assoc (format "webmail:%s:%s" subtype user)
1136                                mail-source-password-cache)))
1137           (push (cons (format "webmail:%s:%s" subtype user) password)
1138                 mail-source-password-cache)))
1139       (webmail-fetch mail-source-crash-box subtype user password)
1140       (mail-source-callback callback (symbol-name subtype))
1141       (mail-source-delete-crash-box))))
1142
1143 (provide 'mail-source)
1144
1145 ;; arch-tag: 72948025-1d17-4d6c-bb12-ef1aa2c490fd
1146 ;;; mail-source.el ends here