cgit.sxemacs.org Git - gnus/blob - lisp/pop3.el

   1 ;;; pop3.el --- Post Office Protocol (RFC 1460) interface
   2
   3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
   4 ;;        Free Software Foundation, Inc.
   5
   6 ;; Author: Richard L. Pieri <ratinox@peorth.gweep.net>
   7 ;; Maintainer: FSF
   8 ;; Keywords: mail
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software; you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation; either version 2, or (at your option)
  15 ;; any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  25 ;; Boston, MA 02110-1301, USA.
  26
  27 ;;; Commentary:
  28
  29 ;; Most of the standard Post Office Protocol version 3 (RFC 1460) commands
  30 ;; are implemented.  The LIST command has not been implemented due to lack
  31 ;; of actual usefulness.
  32 ;; The optional POP3 command TOP has not been implemented.
  33
  34 ;; This program was inspired by Kyle E. Jones's vm-pop program.
  35
  36 ;;; Code:
  37
  38 (require 'mail-utils)
  39
  40 (defgroup pop3 nil
  41   "Post Office Protocol."
  42   :group 'mail
  43   :group 'mail-source)
  44
  45 (defcustom pop3-maildrop (or (user-login-name)
  46                              (getenv "LOGNAME")
  47                              (getenv "USER"))
  48   "*POP3 maildrop."
  49   :version "22.1" ;; Oort Gnus
  50   :type 'string
  51   :group 'pop3)
  52
  53 (defcustom pop3-mailhost (or (getenv "MAILHOST") ;; nil -> mismatch
  54                              "pop3")
  55   "*POP3 mailhost."
  56   :version "22.1" ;; Oort Gnus
  57   :type 'string
  58   :group 'pop3)
  59
  60 (defcustom pop3-port 110
  61   "*POP3 port."
  62   :version "22.1" ;; Oort Gnus
  63   :type 'number
  64   :group 'pop3)
  65
  66 (defcustom pop3-password-required t
  67   "*Non-nil if a password is required when connecting to POP server."
  68   :version "22.1" ;; Oort Gnus
  69   :type 'boolean
  70   :group 'pop3)
  71
  72 ;; Should this be customizable?
  73 (defvar pop3-password nil
  74   "*Password to use when connecting to POP server.")
  75
  76 (defcustom pop3-authentication-scheme 'pass
  77   "*POP3 authentication scheme.
  78 Defaults to 'pass, for the standard USER/PASS authentication.  Other valid
  79 values are 'apop."
  80   :version "22.1" ;; Oort Gnus
  81   :type '(choice (const :tag "USER/PASS" pass)
  82                  (const :tag "APOP" apop))
  83   :group 'pop3)
  84
  85 (defcustom pop3-leave-mail-on-server nil
  86   "*Non-nil if the mail is to be left on the POP server after fetching.
  87
  88 If `pop3-leave-mail-on-server' is non-nil the mail is to be left
  89 on the POP server after fetching.  Note that POP servers maintain
  90 no state information between sessions, so what the client
  91 believes is there and what is actually there may not match up.
  92 If they do not, then the whole thing can fall apart and leave you
  93 with a corrupt mailbox."
  94   :version "22.1" ;; Oort Gnus
  95   :type 'boolean
  96   :group 'pop3)
  97
  98 (defvar pop3-timestamp nil
  99   "Timestamp returned when initially connected to the POP server.
 100 Used for APOP authentication.")
 101
 102 (defvar pop3-read-point nil)
 103 (defvar pop3-debug nil)
 104
 105 ;; Borrowed from nnheader-accept-process-output in nnheader.el.
 106 (defvar pop3-read-timeout
 107   (if (string-match "windows-nt\\|os/2\\|emx\\|cygwin"
 108                     (symbol-name system-type))
 109       ;; http://thread.gmane.org/v9655t3pjo.fsf@marauder.physik.uni-ulm.de
 110       ;;
 111       ;; IIRC, values lower than 1.0 didn't/don't work on Windows/DOS.
 112       ;;
 113       ;; There should probably be a runtime test to determine the timing
 114       ;; resolution, or a primitive to report it.  I don't know off-hand
 115       ;; what's possible.  Perhaps better, maybe the Windows/DOS primitive
 116       ;; could round up non-zero timeouts to a minimum of 1.0?
 117       1.0
 118     0.1)
 119   "How long pop3 should wait between checking for the end of output.
 120 Shorter values mean quicker response, but are more CPU intensive.")
 121
 122 ;; Borrowed from nnheader-accept-process-output in nnheader.el.
 123 (defun pop3-accept-process-output (process)
 124   (accept-process-output
 125    process
 126    (truncate pop3-read-timeout)
 127    (truncate (* (- pop3-read-timeout
 128                    (truncate pop3-read-timeout))
 129                 1000))))
 130
 131 (defun pop3-movemail (&optional crashbox)
 132   "Transfer contents of a maildrop to the specified CRASHBOX."
 133   (or crashbox (setq crashbox (expand-file-name "~/.crashbox")))
 134   (let* ((process (pop3-open-server pop3-mailhost pop3-port))
 135          (crashbuf (get-buffer-create " *pop3-retr*"))
 136          (n 1)
 137          message-count
 138          (pop3-password pop3-password))
 139     ;; for debugging only
 140     (if pop3-debug (switch-to-buffer (process-buffer process)))
 141     ;; query for password
 142     (if (and pop3-password-required (not pop3-password))
 143         (setq pop3-password
 144               (read-passwd (format "Password for %s: " pop3-maildrop))))
 145     (cond ((equal 'apop pop3-authentication-scheme)
 146            (pop3-apop process pop3-maildrop))
 147           ((equal 'pass pop3-authentication-scheme)
 148            (pop3-user process pop3-maildrop)
 149            (pop3-pass process))
 150           (t (error "Invalid POP3 authentication scheme")))
 151     (setq message-count (car (pop3-stat process)))
 152     (unwind-protect
 153         (while (<= n message-count)
 154           (message "Retrieving message %d of %d from %s..."
 155                    n message-count pop3-mailhost)
 156           (pop3-retr process n crashbuf)
 157           (save-excursion
 158             (set-buffer crashbuf)
 159             (let ((coding-system-for-write 'binary))
 160               (write-region (point-min) (point-max) crashbox t 'nomesg))
 161             (set-buffer (process-buffer process))
 162             (while (> (buffer-size) 5000)
 163               (goto-char (point-min))
 164               (forward-line 50)
 165               (delete-region (point-min) (point))))
 166           (unless pop3-leave-mail-on-server
 167             (pop3-dele process n))
 168           (setq n (+ 1 n))
 169           (if pop3-debug (sit-for 1) (sit-for 0.1))
 170           )
 171       (pop3-quit process))
 172     (kill-buffer crashbuf)
 173     )
 174   t)
 175
 176 (defun pop3-get-message-count ()
 177   "Return the number of messages in the maildrop."
 178   (let* ((process (pop3-open-server pop3-mailhost pop3-port))
 179          message-count
 180          (pop3-password pop3-password))
 181     ;; for debugging only
 182     (if pop3-debug (switch-to-buffer (process-buffer process)))
 183     ;; query for password
 184     (if (and pop3-password-required (not pop3-password))
 185         (setq pop3-password
 186               (read-passwd (format "Password for %s: " pop3-maildrop))))
 187     (cond ((equal 'apop pop3-authentication-scheme)
 188            (pop3-apop process pop3-maildrop))
 189           ((equal 'pass pop3-authentication-scheme)
 190            (pop3-user process pop3-maildrop)
 191            (pop3-pass process))
 192           (t (error "Invalid POP3 authentication scheme")))
 193     (setq message-count (car (pop3-stat process)))
 194     (pop3-quit process)
 195     message-count))
 196
 197 (defun pop3-open-server (mailhost port)
 198   "Open TCP connection to MAILHOST on PORT.
 199 Returns the process associated with the connection."
 200   (let ((coding-system-for-read 'binary)
 201         (coding-system-for-write 'binary)
 202         process)
 203     (save-excursion
 204       (set-buffer (get-buffer-create (concat " trace of POP session to "
 205                                              mailhost)))
 206       (erase-buffer)
 207       (setq pop3-read-point (point-min))
 208       (setq process (open-network-stream "POP" (current-buffer) mailhost port))
 209       (let ((response (pop3-read-response process t)))
 210         (setq pop3-timestamp
 211               (substring response (or (string-match "<" response) 0)
 212                          (+ 1 (or (string-match ">" response) -1)))))
 213       process)))
 214
 215 ;; Support functions
 216
 217 (defun pop3-process-filter (process output)
 218   (save-excursion
 219     (set-buffer (process-buffer process))
 220     (goto-char (point-max))
 221     (insert output)))
 222
 223 (defun pop3-send-command (process command)
 224   (set-buffer (process-buffer process))
 225   (goto-char (point-max))
 226   ;; (if (= (aref command 0) ?P)
 227   ;;     (insert "PASS <omitted>\r\n")
 228   ;;   (insert command "\r\n"))
 229   (setq pop3-read-point (point))
 230   (goto-char (point-max))
 231   (process-send-string process (concat command "\r\n")))
 232
 233 (defun pop3-read-response (process &optional return)
 234   "Read the response from the server.
 235 Return the response string if optional second argument is non-nil."
 236   (let ((case-fold-search nil)
 237         match-end)
 238     (save-excursion
 239       (set-buffer (process-buffer process))
 240       (goto-char pop3-read-point)
 241       (while (and (memq (process-status process) '(open run))
 242                   (not (search-forward "\r\n" nil t)))
 243         (pop3-accept-process-output process)
 244         (goto-char pop3-read-point))
 245       (setq match-end (point))
 246       (goto-char pop3-read-point)
 247       (if (looking-at "-ERR")
 248           (error (buffer-substring (point) (- match-end 2)))
 249         (if (not (looking-at "+OK"))
 250             (progn (setq pop3-read-point match-end) nil)
 251           (setq pop3-read-point match-end)
 252           (if return
 253               (buffer-substring (point) match-end)
 254             t)
 255           )))))
 256
 257 (defun pop3-clean-region (start end)
 258   (setq end (set-marker (make-marker) end))
 259   (save-excursion
 260     (goto-char start)
 261     (while (and (< (point) end) (search-forward "\r\n" end t))
 262       (replace-match "\n" t t))
 263     (goto-char start)
 264     (while (and (< (point) end) (re-search-forward "^\\." end t))
 265       (replace-match "" t t)
 266       (forward-char)))
 267   (set-marker end nil))
 268
 269 (eval-when-compile (defvar parse-time-months))
 270
 271 ;; Copied from message-make-date.
 272 (defun pop3-make-date (&optional now)
 273   "Make a valid date header.
 274 If NOW, use that time instead."
 275   (require 'parse-time)
 276   (let* ((now (or now (current-time)))
 277          (zone (nth 8 (decode-time now)))
 278          (sign "+"))
 279     (when (< zone 0)
 280       (setq sign "-")
 281       (setq zone (- zone)))
 282     (concat
 283      (format-time-string "%d" now)
 284      ;; The month name of the %b spec is locale-specific.  Pfff.
 285      (format " %s "
 286              (capitalize (car (rassoc (nth 4 (decode-time now))
 287                                       parse-time-months))))
 288      (format-time-string "%Y %H:%M:%S " now)
 289      ;; We do all of this because XEmacs doesn't have the %z spec.
 290      (format "%s%02d%02d" sign (/ zone 3600) (/ (% zone 3600) 60)))))
 291
 292 (defun pop3-munge-message-separator (start end)
 293   "Check to see if a message separator exists.  If not, generate one."
 294   (save-excursion
 295     (save-restriction
 296       (narrow-to-region start end)
 297       (goto-char (point-min))
 298       (if (not (or (looking-at "From .?") ; Unix mail
 299                    (looking-at "\001\001\001\001\n") ; MMDF
 300                    (looking-at "BABYL OPTIONS:") ; Babyl
 301                    ))
 302           (let* ((from (mail-strip-quoted-names (mail-fetch-field "From")))
 303                  (tdate (mail-fetch-field "Date"))
 304                  (date (split-string (or (and tdate
 305                                               (not (string= "" tdate))
 306                                               tdate)
 307                                          (pop3-make-date))
 308                                      " "))
 309                  (From_))
 310             ;; sample date formats I have seen
 311             ;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT)
 312             ;; Date: 08 Jul 1996 23:22:24 -0400
 313             ;; should be
 314             ;; Tue Jul 9 09:04:21 1996
 315             (setq date
 316                   (cond ((not date)
 317                          "Tue Jan 1 00:00:0 1900")
 318                         ((string-match "[A-Z]" (nth 0 date))
 319                          (format "%s %s %s %s %s"
 320                                  (nth 0 date) (nth 2 date) (nth 1 date)
 321                                  (nth 4 date) (nth 3 date)))
 322                         (t
 323                          ;; this really needs to be better but I don't feel
 324                          ;; like writing a date to day converter.
 325                          (format "Sun %s %s %s %s"
 326                                  (nth 1 date) (nth 0 date)
 327                                  (nth 3 date) (nth 2 date)))
 328                         ))
 329             (setq From_ (format "\nFrom %s  %s\n" from date))
 330             (while (string-match "," From_)
 331               (setq From_ (concat (substring From_ 0 (match-beginning 0))
 332                                   (substring From_ (match-end 0)))))
 333             (goto-char (point-min))
 334             (insert From_)
 335             (if (search-forward "\n\n" nil t)
 336                 nil
 337               (goto-char (point-max))
 338               (insert "\n"))
 339             (narrow-to-region (point) (point-max))
 340             (let ((size (- (point-max) (point-min))))
 341               (goto-char (point-min))
 342               (widen)
 343               (forward-line -1)
 344               (insert (format "Content-Length: %s\n" size)))
 345             )))))
 346
 347 ;; The Command Set
 348
 349 ;; AUTHORIZATION STATE
 350
 351 (defun pop3-user (process user)
 352   "Send USER information to POP3 server."
 353   (pop3-send-command process (format "USER %s" user))
 354   (let ((response (pop3-read-response process t)))
 355     (if (not (and response (string-match "+OK" response)))
 356         (error "USER %s not valid" user))))
 357
 358 (defun pop3-pass (process)
 359   "Send authentication information to the server."
 360   (pop3-send-command process (format "PASS %s" pop3-password))
 361   (let ((response (pop3-read-response process t)))
 362     (if (not (and response (string-match "+OK" response)))
 363         (pop3-quit process))))
 364
 365 (defun pop3-apop (process user)
 366   "Send alternate authentication information to the server."
 367   (let ((pass pop3-password))
 368     (if (and pop3-password-required (not pass))
 369         (setq pass
 370               (read-passwd (format "Password for %s: " pop3-maildrop))))
 371     (if pass
 372         (let ((hash (md5 (concat pop3-timestamp pass) nil nil 'binary)))
 373           (pop3-send-command process (format "APOP %s %s" user hash))
 374           (let ((response (pop3-read-response process t)))
 375             (if (not (and response (string-match "+OK" response)))
 376                 (pop3-quit process)))))
 377     ))
 378
 379 ;; TRANSACTION STATE
 380
 381 (defun pop3-stat (process)
 382   "Return the number of messages in the maildrop and the maildrop's size."
 383   (pop3-send-command process "STAT")
 384   (let ((response (pop3-read-response process t)))
 385     (list (string-to-number (nth 1 (split-string response " ")))
 386           (string-to-number (nth 2 (split-string response " "))))
 387     ))
 388
 389 (defun pop3-list (process &optional msg)
 390   "Scan listing of available messages.
 391 This function currently does nothing.")
 392
 393 (defun pop3-retr (process msg crashbuf)
 394   "Retrieve message-id MSG to buffer CRASHBUF."
 395   (pop3-send-command process (format "RETR %s" msg))
 396   (pop3-read-response process)
 397   (let ((start pop3-read-point) end)
 398     (save-excursion
 399       (set-buffer (process-buffer process))
 400       (while (not (re-search-forward "^\\.\r\n" nil t))
 401         (pop3-accept-process-output process)
 402         (goto-char start))
 403       (setq pop3-read-point (point-marker))
 404       ;; this code does not seem to work for some POP servers...
 405       ;; and I cannot figure out why not.
 406       ;;      (goto-char (match-beginning 0))
 407       ;;      (backward-char 2)
 408       ;;      (if (not (looking-at "\r\n"))
 409       ;;          (insert "\r\n"))
 410       ;;      (re-search-forward "\\.\r\n")
 411       (goto-char (match-beginning 0))
 412       (setq end (point-marker))
 413       (pop3-clean-region start end)
 414       (pop3-munge-message-separator start end)
 415       (save-excursion
 416         (set-buffer crashbuf)
 417         (erase-buffer))
 418       (copy-to-buffer crashbuf start end)
 419       (delete-region start end)
 420       )))
 421
 422 (defun pop3-dele (process msg)
 423   "Mark message-id MSG as deleted."
 424   (pop3-send-command process (format "DELE %s" msg))
 425   (pop3-read-response process))
 426
 427 (defun pop3-noop (process msg)
 428   "No-operation."
 429   (pop3-send-command process "NOOP")
 430   (pop3-read-response process))
 431
 432 (defun pop3-last (process)
 433   "Return highest accessed message-id number for the session."
 434   (pop3-send-command process "LAST")
 435   (let ((response (pop3-read-response process t)))
 436     (string-to-number (nth 1 (split-string response " ")))
 437     ))
 438
 439 (defun pop3-rset (process)
 440   "Remove all delete marks from current maildrop."
 441   (pop3-send-command process "RSET")
 442   (pop3-read-response process))
 443
 444 ;; UPDATE
 445
 446 (defun pop3-quit (process)
 447   "Close connection to POP3 server.
 448 Tell server to remove all messages marked as deleted, unlock the maildrop,
 449 and close the connection."
 450   (pop3-send-command process "QUIT")
 451   (pop3-read-response process t)
 452   (if process
 453       (save-excursion
 454         (set-buffer (process-buffer process))
 455         (goto-char (point-max))
 456         (delete-process process))))
 457 \f
 458 ;; Summary of POP3 (Post Office Protocol version 3) commands and responses
 459
 460 ;;; AUTHORIZATION STATE
 461
 462 ;; Initial TCP connection
 463 ;; Arguments: none
 464 ;; Restrictions: none
 465 ;; Possible responses:
 466 ;;  +OK [POP3 server ready]
 467
 468 ;; USER name
 469 ;; Arguments: a server specific user-id (required)
 470 ;; Restrictions: authorization state [after unsuccessful USER or PASS
 471 ;; Possible responses:
 472 ;;  +OK [valid user-id]
 473 ;;  -ERR [invalid user-id]
 474
 475 ;; PASS string
 476 ;; Arguments: a server/user-id specific password (required)
 477 ;; Restrictions: authorization state, after successful USER
 478 ;; Possible responses:
 479 ;;  +OK [maildrop locked and ready]
 480 ;;  -ERR [invalid password]
 481 ;;  -ERR [unable to lock maildrop]
 482
 483 ;;; TRANSACTION STATE
 484
 485 ;; STAT
 486 ;; Arguments: none
 487 ;; Restrictions: transaction state
 488 ;; Possible responses:
 489 ;;  +OK nn mm [# of messages, size of maildrop]
 490
 491 ;; LIST [msg]
 492 ;; Arguments: a message-id (optional)
 493 ;; Restrictions: transaction state; msg must not be deleted
 494 ;; Possible responses:
 495 ;;  +OK [scan listing follows]
 496 ;;  -ERR [no such message]
 497
 498 ;; RETR msg
 499 ;; Arguments: a message-id (required)
 500 ;; Restrictions: transaction state; msg must not be deleted
 501 ;; Possible responses:
 502 ;;  +OK [message contents follow]
 503 ;;  -ERR [no such message]
 504
 505 ;; DELE msg
 506 ;; Arguments: a message-id (required)
 507 ;; Restrictions: transaction state; msg must not be deleted
 508 ;; Possible responses:
 509 ;;  +OK [message deleted]
 510 ;;  -ERR [no such message]
 511
 512 ;; NOOP
 513 ;; Arguments: none
 514 ;; Restrictions: transaction state
 515 ;; Possible responses:
 516 ;;  +OK
 517
 518 ;; LAST
 519 ;; Arguments: none
 520 ;; Restrictions: transaction state
 521 ;; Possible responses:
 522 ;;  +OK nn [highest numbered message accessed]
 523
 524 ;; RSET
 525 ;; Arguments: none
 526 ;; Restrictions: transaction state
 527 ;; Possible responses:
 528 ;;  +OK [all delete marks removed]
 529
 530 ;;; UPDATE STATE
 531
 532 ;; QUIT
 533 ;; Arguments: none
 534 ;; Restrictions: none
 535 ;; Possible responses:
 536 ;;  +OK [TCP connection closed]
 537
 538 (provide 'pop3)
 539
 540 ;;; arch-tag: 2facc142-1d74-498e-82af-4659b64cac12
 541 ;;; pop3.el ends here