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