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