git.chise.org Git - elisp/gnus.git-/blob - lisp/pop3.el

   1 ;;; pop3.el --- Post Office Protocol (RFC 1460) interface
   2
   3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001
   4 ;;        Free Software Foundation, Inc.
   5
   6 ;; Author: Richard L. Pieri <ratinox@peorth.gweep.net>
   7 ;;      Daiki Ueno  <ueno@ueda.info.waseda.ac.jp>
   8 ;; Maintainer: FSF
   9 ;; Keywords: mail
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs is free software; you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation; either version 2, or (at your option)
  16 ;; any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  26 ;; Boston, MA 02111-1307, USA.
  27
  28 ;;; Commentary:
  29
  30 ;; Most of the standard Post Office Protocol version 3 (RFC 1460) commands
  31 ;; are implemented.  The LIST command has not been implemented due to lack
  32 ;; of actual usefulness.
  33 ;; The optional POP3 command TOP has not been implemented.
  34
  35 ;; This program was inspired by Kyle E. Jones's vm-pop program.
  36
  37 ;;; Code:
  38
  39 (eval-when-compile (require 'cl))
  40 (eval-when-compile (require 'static))
  41
  42 (require 'mail-utils)
  43
  44 (defvar pop3-maildrop (or (user-login-name) (getenv "LOGNAME") (getenv "USER") nil)
  45   "*POP3 maildrop.")
  46 (defvar pop3-mailhost (or (getenv "MAILHOST") nil)
  47   "*POP3 mailhost.")
  48 (defvar pop3-port 110
  49   "*POP3 port.")
  50 (defvar pop3-connection-type nil
  51   "*POP3 connection type.")
  52
  53 (defvar pop3-password-required t
  54   "*Non-nil if a password is required when connecting to POP server.")
  55 (defvar pop3-password nil
  56   "*Password to use when connecting to POP server.")
  57
  58 (defvar pop3-authentication-scheme 'pass
  59   "*POP3 authentication scheme.
  60 Defaults to 'pass, for the standard USER/PASS authentication.  Other valid
  61 values are 'apop.")
  62
  63 (defvar pop3-timestamp nil
  64   "Timestamp returned when initially connected to the POP server.
  65 Used for APOP authentication.")
  66
  67 (defvar pop3-leave-mail-on-server nil
  68   "Non-nil if mail is to be left on the server and UIDL used for message retrieval.")
  69
  70 (defvar pop3-maximum-message-size nil
  71   "If non-nil only download messages smaller than this.")
  72
  73 (defvar pop3-except-header-regexp nil
  74   "If non-nil we do not retrieve messages whose headers are matching this regexp.")
  75
  76 (defvar pop3-uidl-file-name "~/.uidls"
  77   "File in which to store the UIDL of processed messages.")
  78
  79 (defvar pop3-uidl-support 'dont-know
  80   "Whether the server supports UIDL.
  81 Nil means no, t means yes, not-nil-or-t means yet to be determined.")
  82
  83 (defvar pop3-uidl-obarray (make-vector 31 0)
  84   "Uidl hash table.")
  85
  86 (defvar pop3-read-point nil)
  87 (defvar pop3-debug nil)
  88
  89 (eval-and-compile
  90   (autoload 'open-ssl-stream "ssl")
  91   (autoload 'starttls-open-stream "starttls")
  92   (autoload 'starttls-negotiate "starttls"))
  93
  94 (defvar pop3-ssl-program-name
  95   (if (exec-installed-p "openssl")
  96       "openssl"
  97     "ssleay")
  98   "The program to run in a subprocess to open an SSL connection.")
  99
 100 (defvar pop3-ssl-program-arguments
 101   '("s_client" "-quiet")
 102   "Arguments to be passed to the program `pop3-ssl-program-name'.")
 103
 104 (defun pop3-progress-message (format percent &rest args)
 105   (apply (function message) format args))
 106
 107 (defun pop3-movemail (&optional crashbox)
 108   "Transfer contents of a maildrop to the specified CRASHBOX."
 109   (or crashbox (setq crashbox (expand-file-name "~/.crashbox")))
 110   (let* ((process (pop3-open-server pop3-mailhost pop3-port))
 111          (crashbuf (get-buffer-create " *pop3-retr*"))
 112          (n 1)
 113          message-count
 114          (pop3-password pop3-password)
 115          (pop3-uidl-file-name (convert-standard-filename
 116                                (concat pop3-uidl-file-name "-"
 117                                        pop3-mailhost)))
 118          retrieved-messages messages)
 119     ;; for debugging only
 120     (if pop3-debug (switch-to-buffer (process-buffer process)))
 121     ;; query for password
 122     (if (and pop3-password-required (not pop3-password))
 123         (setq pop3-password
 124               (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
 125     (cond ((equal 'apop pop3-authentication-scheme)
 126            (pop3-apop process pop3-maildrop))
 127           ((equal 'pass pop3-authentication-scheme)
 128            (pop3-user process pop3-maildrop)
 129            (pop3-pass process))
 130           (t (error "Invalid POP3 authentication scheme")))
 131     ;; get messages that are suitable for download
 132     (message "Retrieving message list...")
 133     (setq messages (pop3-get-message-numbers process)
 134           message-count (length (cdr messages)))
 135     (message "Retrieving message list...%d of %d unread"
 136              message-count (pop messages))
 137     (unwind-protect
 138         (unless (not (stringp crashbox))
 139           (while messages
 140             (pop3-progress-message
 141              "Retrieving message %d of %d (%d octets) from %s..."
 142              (floor (* (/ (float n) message-count) 100))
 143              n message-count (cdar messages) pop3-mailhost)
 144             (pop3-retr process (caar messages) crashbuf)
 145             (push (caar messages) retrieved-messages)
 146             (setq messages (cdr messages)
 147                   n (1+ n)))
 148           (with-current-buffer crashbuf
 149             (write-region-as-binary (point-min) (point-max)
 150                                     crashbox 'append 'nomesg))
 151           ;; mark messages as read
 152           (when pop3-leave-mail-on-server
 153             (pop3-save-uidls))
 154           ;; now delete the messages we have retrieved
 155           (unless pop3-leave-mail-on-server
 156             (dolist (n retrieved-messages)
 157               (message "Deleting message %d of %d from %s..."
 158                        n message-count pop3-mailhost)
 159               (pop3-dele process n)))
 160           )
 161       (pop3-quit process))
 162     (kill-buffer crashbuf)
 163     message-count))
 164
 165 (defun pop3-get-message-count ()
 166   "Return the number of messages in the maildrop."
 167   (let* ((process (pop3-open-server pop3-mailhost pop3-port))
 168          message-count
 169          (pop3-password pop3-password)
 170          )
 171     ;; for debugging only
 172     (if pop3-debug (switch-to-buffer (process-buffer process)))
 173     ;; query for password
 174     (if (and pop3-password-required (not pop3-password))
 175         (setq pop3-password
 176               (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
 177     (cond ((equal 'apop pop3-authentication-scheme)
 178            (pop3-apop process pop3-maildrop))
 179           ((equal 'pass pop3-authentication-scheme)
 180            (pop3-user process pop3-maildrop)
 181            (pop3-pass process))
 182           (t (error "Invalid POP3 authentication scheme")))
 183     (setq message-count (car (pop3-stat process)))
 184     (pop3-quit process)
 185     message-count))
 186
 187 (defun pop3-open-server (mailhost port)
 188   "Open TCP connection to MAILHOST on PORT.
 189 Returns the process associated with the connection.
 190 Argument PORT specifies connecting port."
 191   (let (process)
 192     (save-excursion
 193       (set-buffer (get-buffer-create (concat " trace of POP session to "
 194                                              mailhost)))
 195       (erase-buffer)
 196       (setq pop3-read-point (point-min))
 197       (setq
 198        process
 199        (cond
 200         ((eq pop3-connection-type 'ssl)
 201          (pop3-open-ssl-stream "POP" (current-buffer) mailhost port))
 202         ((eq pop3-connection-type 'tls)
 203          (pop3-open-tls-stream "POP" (current-buffer) mailhost port))
 204         (t
 205          (open-network-stream-as-binary "POP" (current-buffer)
 206                                         mailhost port))))
 207       (let ((response (pop3-read-response process t)))
 208         (setq pop3-timestamp
 209               (substring response (or (string-match "<" response) 0)
 210                          (+ 1 (or (string-match ">" response) -1)))))
 211       process)))
 212
 213 (defun pop3-open-ssl-stream-1 (name buffer host service extra-arg)
 214   (require 'path-util)
 215   (let* ((ssl-program-name
 216           pop3-ssl-program-name)
 217          (ssl-program-arguments
 218           `(,@pop3-ssl-program-arguments
 219             ,extra-arg
 220             "-connect" ,(format "%s:%d" host service)))
 221          (process (open-ssl-stream name buffer host service)))
 222     (when process
 223       (with-current-buffer buffer
 224         (goto-char (point-min))
 225         (while (and (memq (process-status process) '(open run))
 226                     (goto-char (point-max))
 227                     (forward-line -1)
 228                     (not (looking-at "+OK")))
 229           (accept-process-output process 1)
 230           (sit-for 1))
 231         (delete-region (point-min) (point)))
 232       (and process (memq (process-status process) '(open run))
 233            process))))
 234
 235 (defun pop3-open-ssl-stream (name buffer host service)
 236   "Open a SSL connection for a service to a host.
 237 Returns a subprocess-object to represent the connection.
 238 Args are NAME BUFFER HOST SERVICE."
 239   (cond ((eq system-type 'windows-nt)
 240          (let (selective-display
 241                (coding-system-for-write 'binary)
 242                (coding-system-for-read 'raw-text-dos))
 243            (or (pop3-open-ssl-stream-1 name buffer host service "-ssl3")
 244                (pop3-open-ssl-stream-1 name buffer host service "-ssl2"))))
 245         (t
 246          (as-binary-process
 247           (or (pop3-open-ssl-stream-1 name buffer host service "-ssl3")
 248               (pop3-open-ssl-stream-1 name buffer host service "-ssl2"))))))
 249
 250 (defun pop3-open-tls-stream (name buffer host service)
 251   "Open a TLSv1 connection for a service to a host.
 252 Returns a subprocess-object to represent the connection.
 253 Args are NAME BUFFER HOST SERVICE."
 254   (let ((process
 255          (as-binary-process (starttls-open-stream
 256                              name buffer host service))))
 257     (pop3-stls process)
 258     (starttls-negotiate process)
 259     process))
 260
 261 ;; Support functions
 262
 263 (defun pop3-process-filter (process output)
 264   (save-excursion
 265     (set-buffer (process-buffer process))
 266     (goto-char (point-max))
 267     (insert output)))
 268
 269 (defun pop3-send-command (process command)
 270   (set-buffer (process-buffer process))
 271   (goto-char (point-max))
 272 ;;  (if (= (aref command 0) ?P)
 273 ;;      (insert "PASS <omitted>\r\n")
 274 ;;    (insert command "\r\n"))
 275   (setq pop3-read-point (point))
 276   (goto-char (point-max))
 277   (process-send-string process (concat command "\r\n"))
 278   )
 279
 280 (defun pop3-read-response (process &optional return)
 281   "Read the response from the server PROCESS.
 282 Return the response string if optional second argument RETURN is non-nil."
 283   (let ((case-fold-search nil)
 284         match-end)
 285     (save-excursion
 286       (set-buffer (process-buffer process))
 287       (goto-char pop3-read-point)
 288       (while (not (search-forward "\r\n" nil t))
 289         (accept-process-output process 3)
 290         (goto-char pop3-read-point))
 291       (setq match-end (point))
 292       (goto-char pop3-read-point)
 293       (if (looking-at "-ERR")
 294           (error (buffer-substring (point) (- match-end 2)))
 295         (if (not (looking-at "+OK"))
 296             (progn (setq pop3-read-point match-end) nil)
 297           (setq pop3-read-point match-end)
 298           (if return
 299               (buffer-substring (point) match-end)
 300             t)
 301           )))))
 302
 303 (defvar pop3-read-passwd nil)
 304 (defun pop3-read-passwd (prompt)
 305   (if (not pop3-read-passwd)
 306       (if (fboundp 'read-passwd)
 307           (setq pop3-read-passwd 'read-passwd)
 308         (if (load "passwd" t)
 309             (setq pop3-read-passwd 'read-passwd)
 310           (autoload 'ange-ftp-read-passwd "ange-ftp")
 311           (setq pop3-read-passwd 'ange-ftp-read-passwd))))
 312   (funcall pop3-read-passwd prompt))
 313
 314 (defun pop3-clean-region (start end)
 315   (setq end (set-marker (make-marker) end))
 316   (save-excursion
 317     (goto-char start)
 318     (while (and (< (point) end) (search-forward "\r\n" end t))
 319       (replace-match "\n" t t))
 320     (goto-char start)
 321     (while (re-search-forward "\n\n\\(From \\)" end t)
 322       (replace-match "\n\n>\\1" t nil))
 323     (goto-char start)
 324     (while (and (< (point) end) (re-search-forward "^\\." end t))
 325       (replace-match "" t t)
 326       (forward-char)))
 327   (set-marker end nil))
 328
 329 (eval-when-compile (defvar parse-time-months))
 330
 331 ;; Copied from message-make-date.
 332 (defun pop3-make-date (&optional now)
 333   "Make a valid date header.
 334 If NOW, use that time instead."
 335   (require 'parse-time)
 336   (let* ((now (or now (current-time)))
 337          (zone (nth 8 (decode-time now)))
 338          (sign "+"))
 339     (when (< zone 0)
 340       (setq sign "-")
 341       (setq zone (- zone)))
 342     (concat
 343      (format-time-string "%d" now)
 344      ;; The month name of the %b spec is locale-specific.  Pfff.
 345      (format " %s "
 346              (capitalize (car (rassoc (nth 4 (decode-time now))
 347                                       parse-time-months))))
 348      (format-time-string "%Y %H:%M:%S " now)
 349      ;; We do all of this because XEmacs doesn't have the %z spec.
 350      (format "%s%02d%02d" sign (/ zone 3600) (/ (% zone 3600) 60)))))
 351
 352 (defun pop3-munge-message-separator (start end)
 353   "Check to see if a message separator exists.  If not, generate one."
 354   (save-excursion
 355     (save-restriction
 356       (narrow-to-region start end)
 357       (goto-char (point-min))
 358       (if (not (or (looking-at "From .?") ; Unix mail
 359                    (looking-at "\001\001\001\001\n") ; MMDF
 360                    (looking-at "BABYL OPTIONS:") ; Babyl
 361                    ))
 362           (let* ((from (mail-strip-quoted-names (mail-fetch-field "From")))
 363                  (tdate (mail-fetch-field "Date"))
 364                  (date (split-string (or (and tdate
 365                                               (not (string= "" tdate))
 366                                               tdate)
 367                                          (pop3-make-date))
 368                                      " "))
 369                  (From_))
 370             ;; sample date formats I have seen
 371             ;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT)
 372             ;; Date: 08 Jul 1996 23:22:24 -0400
 373             ;; should be
 374             ;; Tue Jul 9 09:04:21 1996
 375             (setq date
 376                   (cond ((string-match "[A-Z]" (nth 0 date))
 377                          (format "%s %s %s %s %s"
 378                                  (nth 0 date) (nth 2 date) (nth 1 date)
 379                                  (nth 4 date) (nth 3 date)))
 380                         (t
 381                          ;; this really needs to be better but I don't feel
 382                          ;; like writing a date to day converter.
 383                          (format "Sun %s %s %s %s"
 384                                  (nth 1 date) (nth 0 date)
 385                                  (nth 3 date) (nth 2 date)))
 386                         ))
 387             (setq From_ (format "\nFrom %s  %s\n" from date))
 388             (while (string-match "," From_)
 389               (setq From_ (concat (substring From_ 0 (match-beginning 0))
 390                                   (substring From_ (match-end 0)))))
 391             (goto-char (point-min))
 392             (insert From_)
 393             (if (search-forward "\n\n" nil t)
 394                 nil
 395               (goto-char (point-max))
 396               (insert "\n"))
 397             (narrow-to-region (point) (point-max))
 398             (let ((size (- (point-max) (point-min))))
 399               (goto-char (point-min))
 400               (widen)
 401               (forward-line -1)
 402               (insert (format "Content-Length: %s\n" size)))
 403             )))))
 404
 405 ;; UIDL support
 406
 407 (defun pop3-get-message-numbers (process)
 408   "Get the list of message numbers and lengths to retrieve via PROCESS."
 409   ;; we use the LIST comand first anyway to get the message lengths.
 410   ;; then if we're leaving mail on the server, see if the UIDL command
 411   ;; is implemented. if so, we use it to get the message number list.
 412   (let* ((messages (pop3-list process))
 413          (total (or (pop messages) 0))
 414          (uidl (if pop3-leave-mail-on-server
 415                    (pop3-get-uidl process)))
 416          out)
 417     (while messages
 418       ;; only retrieve messages matching our regexp or in the uidl list
 419       (when (and
 420              ;; remove elements not in the uidl, this assumes the uidl is short
 421              (or (not (eq pop3-uidl-support t))
 422                  (memq (caar messages) uidl))
 423              (caar messages)
 424              ;; don't download messages that are too large
 425              (not (and pop3-maximum-message-size
 426                        (> (cdar messages) pop3-maximum-message-size)))
 427              (not (and pop3-except-header-regexp
 428                        (string-match pop3-except-header-regexp
 429                                      (pop3-top process (caar messages) 0)))))
 430         (push (car messages) out))
 431       (setq messages (cdr messages)))
 432     (cons total (reverse out))))
 433
 434 (defun pop3-get-uidl (process)
 435   "Use PROCESS to get a list of unread message numbers."
 436   (let ((messages (pop3-uidl process)) uidl)
 437     (if (or (null messages) (null pop3-uidl-support))
 438         (setq pop3-uidl-support nil)
 439       (setq pop3-uidl-support t)
 440       (save-excursion
 441         (with-temp-buffer
 442           (when (file-readable-p pop3-uidl-file-name)
 443             (insert-file-contents pop3-uidl-file-name))
 444           (goto-char (point-min))
 445           (while (looking-at "\\([^ \n\t]+\\)")
 446             (set (intern (match-string 1) pop3-uidl-obarray)
 447                  (cons nil t))
 448             (forward-line 1))
 449           ))
 450       (dolist (message (cdr messages))
 451         (if (setq uidl (intern-soft (cdr message) pop3-uidl-obarray))
 452             (setcar (symbol-value uidl) (car message))
 453           (set (intern (cdr message) pop3-uidl-obarray)
 454                (cons (car message) nil))))
 455       (pop3-get-unread-message-numbers))
 456     ))
 457
 458 (defun pop3-get-unread-message-numbers ()
 459   "Return a sorted list of unread msg numbers to retrieve."
 460   (let (nums)
 461     (mapatoms (lambda (atom)
 462                 (if (not (cdr (symbol-value atom)))
 463                     (push (car (symbol-value atom)) nums)))
 464               pop3-uidl-obarray)
 465     (sort nums '<)))
 466
 467 (defun pop3-save-uidls ()
 468   "Save the updated UIDLs to disk for use next time."
 469   (when (and pop3-leave-mail-on-server
 470              ;; UIDL hash table is non-empty
 471              (let ((len (length pop3-uidl-obarray)))
 472                (while (< 0 len)
 473                  (setq len (if (symbolp (aref pop3-uidl-obarray (1- len)))
 474                                -1 (1- len))))
 475                (minusp len)))
 476     (when (file-readable-p pop3-uidl-file-name)
 477       (copy-file pop3-uidl-file-name
 478                  (concat pop3-uidl-file-name ".old")
 479                  'overwrite 'keeptime))
 480     (save-excursion
 481       (with-temp-file pop3-uidl-file-name
 482         (mapatoms
 483          (lambda (atom)
 484            (when (car (symbol-value atom))
 485              (insert (format "%s\n" atom))))
 486          pop3-uidl-obarray)))
 487     (fillarray pop3-uidl-obarray 0)))
 488
 489
 490 ;; The Command Set
 491
 492 ;; AUTHORIZATION STATE
 493
 494 (defun pop3-user (process user)
 495   "Send USER information to POP3 server."
 496   (pop3-send-command process (format "USER %s" user))
 497   (let ((response (pop3-read-response process t)))
 498     (if (not (and response (string-match "+OK" response)))
 499         (error (format "USER %s not valid" user)))))
 500
 501 (defun pop3-pass (process)
 502   "Send authentication information to the server."
 503   (pop3-send-command process (format "PASS %s" pop3-password))
 504   (let ((response (pop3-read-response process t)))
 505     (if (not (and response (string-match "+OK" response)))
 506         (pop3-quit process))))
 507
 508 (static-unless (and (fboundp 'md5) (subrp (symbol-function 'md5)))
 509   (eval-and-compile
 510     (require 'path-util)
 511     (if (module-installed-p 'md5)
 512         (progn
 513           (autoload 'md5 "md5")
 514           (fset 'pop3-md5 'md5))
 515
 516       (defvar pop3-md5-program "md5"
 517         "*Program to encode its input in MD5.")
 518
 519       (defun pop3-md5 (string)
 520         (with-temp-buffer
 521           (insert string)
 522           (call-process-region (point-min) (point-max)
 523                                (or shell-file-name "/bin/sh")
 524                                t (current-buffer) nil
 525                                "-c" pop3-md5-program)
 526           ;; The meaningful output is the first 32 characters.
 527           ;; Don't return the newline that follows them!
 528           (buffer-substring (point-min) (+ (point-min) 32))))
 529       )))
 530
 531 (defun pop3-apop (process user)
 532   "Send alternate authentication information to the server."
 533   (let ((pass pop3-password))
 534     (if (and pop3-password-required (not pass))
 535         (setq pass
 536               (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
 537     (if pass
 538         (let ((hash (static-if (and (fboundp 'md5)
 539                                     (subrp (symbol-function 'md5)))
 540                         (md5 (concat pop3-timestamp pass))
 541                       (pop3-md5 (concat pop3-timestamp pass)))))
 542           (pop3-send-command process (format "APOP %s %s" user hash))
 543           (let ((response (pop3-read-response process t)))
 544             (if (not (and response (string-match "+OK" response)))
 545                 (pop3-quit process)))))
 546     ))
 547
 548 (defun pop3-stls (process)
 549   "Query whether TLS extension is supported"
 550   (pop3-send-command process "STLS")
 551   (let ((response (pop3-read-response process t)))
 552     (if (not (and response (string-match "+OK" response)))
 553         (pop3-quit process))))
 554
 555 ;; TRANSACTION STATE
 556
 557 (defun pop3-stat (process)
 558   "Return the number of messages in the maildrop and the maildrop's size."
 559   (pop3-send-command process "STAT")
 560   (let ((response (pop3-read-response process t)))
 561     (list (string-to-int (nth 1 (split-string response " ")))
 562           (string-to-int (nth 2 (split-string response " "))))
 563     ))
 564
 565 (defun pop3-retr (process msg crashbuf)
 566   "Retrieve message-id MSG to buffer CRASHBUF."
 567   (pop3-send-command process (format "RETR %s" msg))
 568   (pop3-read-response process)
 569   (save-excursion
 570     (let ((region (pop3-get-extended-response process)))
 571       (pop3-munge-message-separator (car region) (cadr region))
 572       (append-to-buffer crashbuf (car region) (cadr region))
 573       (delete-region (car region) (cadr region))
 574       )))
 575
 576 (defun pop3-dele (process msg)
 577   "Mark message-id MSG as deleted."
 578   (pop3-send-command process (format "DELE %s" msg))
 579   (pop3-read-response process))
 580
 581 (defun pop3-noop (process msg)
 582   "No-operation."
 583   (pop3-send-command process "NOOP")
 584   (pop3-read-response process))
 585
 586 (defun pop3-last (process)
 587   "Return highest accessed message-id number for the session."
 588   (pop3-send-command process "LAST")
 589   (let ((response (pop3-read-response process t)))
 590     (string-to-int (nth 1 (split-string response " ")))
 591     ))
 592
 593 (defun pop3-rset (process)
 594   "Remove all delete marks from current maildrop."
 595   (pop3-send-command process "RSET")
 596   (pop3-read-response process))
 597
 598 ;; UPDATE
 599
 600 (defun pop3-quit (process)
 601   "Close connection to POP3 server.
 602 Tell server to remove all messages marked as deleted, unlock the maildrop,
 603 and close the connection."
 604   (pop3-send-command process "QUIT")
 605   (pop3-read-response process t)
 606   (when process
 607     (save-excursion
 608       (set-buffer (process-buffer process))
 609       (goto-char (point-max))
 610       (delete-process process))))
 611
 612 (defun pop3-uidl (process &optional msgno)
 613   "Return the results of a UIDL command in PROCESS for optional MSGNO.
 614 If UIDL is unsupported on this mail server or if msgno is invalid, return nil.
 615 Otherwise, return a list in the form
 616
 617    (N (1 UIDL-1) (2 UIDL-2) ... (N UIDL-N))
 618
 619 where
 620
 621    N is an integer for the number of UIDLs returned (could be 0)
 622    UIDL-n is a string."
 623
 624   (if msgno
 625       (pop3-send-command process (format "UIDL %d" msgno))
 626     (pop3-send-command process "UIDL"))
 627
 628   (if (null (pop3-read-response process t))
 629       nil ;; UIDL is not supported on this server
 630     (let (pairs uidl)
 631       (save-excursion
 632         (save-restriction
 633           (apply 'narrow-to-region (pop3-get-extended-response process))
 634           (goto-char (point-min))
 635           (while (looking-at "\\([^ \n\t]*\\) \\([^ \n\t]*\\)")
 636             (setq msgno (string-to-int (match-string 1))
 637                   uidl (match-string 2))
 638             (push (cons msgno uidl) pairs)
 639             (beginning-of-line 2))
 640           (cons (length pairs) (nreverse pairs))
 641           )))))
 642
 643 (defun pop3-list (process &optional msgno)
 644   "Return the results of a LIST command for PROCESS and optional MSGNO.
 645 If (optional) msgno is invalid, return nil.  Otherwise, return a list
 646 in the form
 647
 648    (N (1 LEN-1) (2 LEN-2) ... (N LEN-N))
 649
 650 where
 651
 652    N is an integer for the number of msg/len pairs (could be 0)
 653    LEN-n is an integer."
 654   (if msgno
 655       (pop3-send-command process (format "LIST %d" msgno))
 656     (pop3-send-command process "LIST"))
 657
 658   (if (null (pop3-read-response process t))
 659       nil ;; MSGNO is not valid number
 660     (let (pairs len)
 661       (save-excursion
 662         (save-restriction
 663           (apply 'narrow-to-region (pop3-get-extended-response process))
 664           (goto-char (point-min))
 665           (while (looking-at "\\([^ \n\t]*\\) \\([^ \n\t]*\\)")
 666             (setq msgno (string-to-int (match-string 1))
 667                   len (string-to-int (match-string 2)))
 668             (push (cons msgno len) pairs)
 669             (beginning-of-line 2))
 670           (cons (length pairs) (nreverse pairs))
 671           )))))
 672
 673 (defun pop3-top (process msgno &optional lines)
 674   "Return the top LINES of messages for PROCESS and MSGNO.
 675 If msgno is invalid, return nil.  Otherwise, return a string."
 676   (pop3-send-command process (format "TOP %d %d" msgno (or lines 1)))
 677   (if (pop3-read-response process t)
 678       nil ;; MSGNO is not valid number
 679     (save-excursion
 680       (apply 'buffer-substring (pop3-get-extended-response process)))
 681     ))
 682
 683 ;;; Utility code
 684
 685 (defun pop3-get-extended-response (process)
 686   "Get the extended pop3 response in the PROCESS buffer."
 687   (let ((start pop3-read-point) end)
 688     (set-buffer (process-buffer process))
 689     (goto-char start)
 690     (while (not (re-search-forward "^\\.\r\n" nil t))
 691       (accept-process-output process 3)
 692       (goto-char start))
 693     (setq pop3-read-point (point-marker))
 694     (goto-char (match-beginning 0))
 695     (setq end (point-marker))
 696     (pop3-clean-region start end)
 697     (list start end)))
 698
 699 \f
 700 ;; Summary of POP3 (Post Office Protocol version 3) commands and responses
 701
 702 ;;; AUTHORIZATION STATE
 703
 704 ;; Initial TCP connection
 705 ;; Arguments: none
 706 ;; Restrictions: none
 707 ;; Possible responses:
 708 ;;  +OK [POP3 server ready]
 709
 710 ;; USER name
 711 ;; Arguments: a server specific user-id (required)
 712 ;; Restrictions: authorization state [after unsuccessful USER or PASS
 713 ;; Possible responses:
 714 ;;  +OK [valid user-id]
 715 ;;  -ERR [invalid user-id]
 716
 717 ;; PASS string
 718 ;; Arguments: a server/user-id specific password (required)
 719 ;; Restrictions: authorization state, after successful USER
 720 ;; Possible responses:
 721 ;;  +OK [maildrop locked and ready]
 722 ;;  -ERR [invalid password]
 723 ;;  -ERR [unable to lock maildrop]
 724
 725 ;; STLS
 726 ;; Arguments: none
 727 ;; Restrictions: authorization state
 728 ;; Possible responses:
 729 ;;  +OK [negotiation is ready]
 730 ;;  -ERR [security layer is already active]
 731
 732 ;;; TRANSACTION STATE
 733
 734 ;; STAT
 735 ;; Arguments: none
 736 ;; Restrictions: transaction state
 737 ;; Possible responses:
 738 ;;  +OK nn mm [# of messages, size of maildrop]
 739
 740 ;; LIST [msg]
 741 ;; Arguments: a message-id (optional)
 742 ;; Restrictions: transaction state; msg must not be deleted
 743 ;; Possible responses:
 744 ;;  +OK [scan listing follows]
 745 ;;  -ERR [no such message]
 746
 747 ;; TOP msg [lines]
 748 ;; Arguments: a message-id (required), number of lines (optional)
 749 ;; Restrictions: transaction state; msg must not be deleted
 750 ;; Possible responses:
 751 ;;  +OK [partial message listing follows]
 752 ;;  -ERR [no such message]
 753
 754 ;; UIDL [msg]
 755 ;; Arguments: a message-id (optional)
 756 ;; Restrictions: transaction state; msg must not be deleted
 757 ;; Possible responses:
 758 ;;  +OK [uidl listing follows]
 759 ;;  -ERR [no such message]
 760
 761 ;; RETR msg
 762 ;; Arguments: a message-id (required)
 763 ;; Restrictions: transaction state; msg must not be deleted
 764 ;; Possible responses:
 765 ;;  +OK [message contents follow]
 766 ;;  -ERR [no such message]
 767
 768 ;; DELE msg
 769 ;; Arguments: a message-id (required)
 770 ;; Restrictions: transaction state; msg must not be deleted
 771 ;; Possible responses:
 772 ;;  +OK [message deleted]
 773 ;;  -ERR [no such message]
 774
 775 ;; NOOP
 776 ;; Arguments: none
 777 ;; Restrictions: transaction state
 778 ;; Possible responses:
 779 ;;  +OK
 780
 781 ;; LAST
 782 ;; Arguments: none
 783 ;; Restrictions: transaction state
 784 ;; Possible responses:
 785 ;;  +OK nn [highest numbered message accessed]
 786
 787 ;; RSET
 788 ;; Arguments: none
 789 ;; Restrictions: transaction state
 790 ;; Possible responses:
 791 ;;  +OK [all delete marks removed]
 792
 793 ;;; UPDATE STATE
 794
 795 ;; QUIT
 796 ;; Arguments: none
 797 ;; Restrictions: none
 798 ;; Possible responses:
 799 ;;  +OK [TCP connection closed]
 800
 801 (provide 'pop3)
 802
 803 ;;; pop3.el ends here