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 Free Software Foundation, Inc.
   4
   5 ;; Author: Richard L. Pieri <ratinox@peorth.gweep.net>
   6 ;; Keywords: mail, pop3
   7 ;; Version: 1.3m
   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 2, 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., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; Most of the standard Post Office Protocol version 3 (RFC 1460) commands
  29 ;; are implemented.  The LIST command has not been implemented due to lack
  30 ;; of actual usefulness.
  31 ;; The optional POP3 command TOP has not been implemented.
  32
  33 ;; This program was inspired by Kyle E. Jones's vm-pop program.
  34
  35 ;;; Code:
  36
  37 (require 'mail-utils)
  38 (provide 'pop3)
  39
  40 (defconst pop3-version "1.3m")
  41
  42 (defvar pop3-maildrop (or (user-login-name) (getenv "LOGNAME") (getenv "USER") nil)
  43   "*POP3 maildrop.")
  44 (defvar pop3-mailhost (or (getenv "MAILHOST") nil)
  45   "*POP3 mailhost.")
  46 (defvar pop3-port 110
  47   "*POP3 port.")
  48
  49 (defvar pop3-password-required t
  50   "*Non-nil if a password is required when connecting to POP server.")
  51 (defvar pop3-password nil
  52   "*Password to use when connecting to POP server.")
  53
  54 (defvar pop3-authentication-scheme 'pass
  55   "*POP3 authentication scheme.
  56 Defaults to 'pass, for the standard USER/PASS authentication.  Other valid
  57 values are 'apop.")
  58
  59 (defvar pop3-timestamp nil
  60   "Timestamp returned when initially connected to the POP server.
  61 Used for APOP authentication.")
  62
  63 (defvar pop3-read-point nil)
  64 (defvar pop3-debug nil)
  65
  66 (defun pop3-movemail (&optional crashbox)
  67   "Transfer contents of a maildrop to the specified CRASHBOX."
  68   (or crashbox (setq crashbox (expand-file-name "~/.crashbox")))
  69   (let* ((process (pop3-open-server pop3-mailhost pop3-port))
  70          (crashbuf (get-buffer-create " *pop3-retr*"))
  71          (n 1)
  72          message-count
  73          (pop3-password pop3-password)
  74          )
  75     ;; for debugging only
  76     (if pop3-debug (switch-to-buffer (process-buffer process)))
  77     ;; query for password
  78     (if (and pop3-password-required (not pop3-password))
  79         (setq pop3-password
  80               (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
  81     (cond ((equal 'apop pop3-authentication-scheme)
  82            (pop3-apop process pop3-maildrop))
  83           ((equal 'pass pop3-authentication-scheme)
  84            (pop3-user process pop3-maildrop)
  85            (pop3-pass process))
  86           (t (error "Invalid POP3 authentication scheme.")))
  87     (setq message-count (car (pop3-stat process)))
  88     (while (<= n message-count)
  89       (message (format "Retrieving message %d of %d from %s..."
  90                        n message-count pop3-mailhost))
  91       (pop3-retr process n crashbuf)
  92       (save-excursion
  93         (set-buffer crashbuf)
  94         (write-region-as-binary (point-min) (point-max) crashbox 'append)
  95         (set-buffer (process-buffer process))
  96         (while (> (buffer-size) 5000)
  97           (goto-char (point-min))
  98           (forward-line 50)
  99           (delete-region (point-min) (point))))
 100       (pop3-dele process n)
 101       (setq n (+ 1 n))
 102       (if pop3-debug (sit-for 1) (sit-for 0.1))
 103       )
 104     (pop3-quit process)
 105     (kill-buffer crashbuf)
 106     )
 107   )
 108
 109 (defun pop3-open-server (mailhost port)
 110   "Open TCP connection to MAILHOST.
 111 Returns the process associated with the connection."
 112   (let ((process-buffer
 113          (get-buffer-create (format "trace of POP session to %s" mailhost)))
 114         (process))
 115     (save-excursion
 116       (set-buffer process-buffer)
 117       (erase-buffer)
 118       (setq pop3-read-point (point-min))
 119       )
 120     (setq process
 121           (open-network-stream-as-binary "POP" process-buffer mailhost port))
 122     (let ((response (pop3-read-response process t)))
 123       (setq pop3-timestamp
 124             (substring response (or (string-match "<" response) 0)
 125                        (+ 1 (or (string-match ">" response) -1)))))
 126     process))
 127
 128 ;; Support functions
 129
 130 (defun pop3-process-filter (process output)
 131   (save-excursion
 132     (set-buffer (process-buffer process))
 133     (goto-char (point-max))
 134     (insert output)))
 135
 136 (defun pop3-send-command (process command)
 137     (set-buffer (process-buffer process))
 138     (goto-char (point-max))
 139 ;;    (if (= (aref command 0) ?P)
 140 ;;      (insert "PASS <omitted>\r\n")
 141 ;;      (insert command "\r\n"))
 142     (setq pop3-read-point (point))
 143     (goto-char (point-max))
 144     (process-send-string process command)
 145     (process-send-string process "\r\n")
 146     )
 147
 148 (defun pop3-read-response (process &optional return)
 149   "Read the response from the server.
 150 Return the response string if optional second argument is non-nil."
 151   (let ((case-fold-search nil)
 152         match-end)
 153     (save-excursion
 154       (set-buffer (process-buffer process))
 155       (goto-char pop3-read-point)
 156       (while (not (search-forward "\r\n" nil t))
 157         (accept-process-output process 3)
 158         (goto-char pop3-read-point))
 159       (setq match-end (point))
 160       (goto-char pop3-read-point)
 161       (if (looking-at "-ERR")
 162           (signal 'error (list (buffer-substring (point) (- match-end 2))))
 163         (if (not (looking-at "+OK"))
 164             (progn (setq pop3-read-point match-end) nil)
 165           (setq pop3-read-point match-end)
 166           (if return
 167               (buffer-substring (point) match-end)
 168             t)
 169           )))))
 170
 171 (defvar pop3-read-passwd nil)
 172 (defun pop3-read-passwd (prompt)
 173   (if (not pop3-read-passwd)
 174       (if (functionp 'read-passwd)
 175           (setq pop3-read-passwd 'read-passwd)
 176         (if (load "passwd" t)
 177             (setq pop3-read-passwd 'read-passwd)
 178           (autoload 'ange-ftp-read-passwd "ange-ftp")
 179           (setq pop3-read-passwd 'ange-ftp-read-passwd))))
 180   (funcall pop3-read-passwd prompt))
 181
 182 (defun pop3-clean-region (start end)
 183   (setq end (set-marker (make-marker) end))
 184   (save-excursion
 185     (goto-char start)
 186     (while (and (< (point) end) (search-forward "\r\n" end t))
 187       (replace-match "\n" t t))
 188     (goto-char start)
 189     (while (and (< (point) end) (re-search-forward "^\\." end t))
 190       (replace-match "" t t)
 191       (forward-char)))
 192   (set-marker end nil))
 193
 194 (defun pop3-munge-message-separator (start end)
 195   "Check to see if a message separator exists.  If not, generate one."
 196   (if (not (fboundp 'parse-time-string))
 197       (autoload 'parse-time-string "parse-time"))
 198   (save-excursion
 199     (save-restriction
 200       (narrow-to-region start end)
 201       (goto-char (point-min))
 202       (if (not (or (looking-at "From .?") ; Unix mail
 203                    (looking-at "\001\001\001\001\n") ; MMDF
 204                    (looking-at "BABYL OPTIONS:") ; Babyl
 205                    ))
 206           (let ((from (mail-strip-quoted-names (mail-fetch-field "From")))
 207                 (date (mail-fetch-field "Date"))
 208                 (From_))
 209             ;; sample date formats I have seen
 210             ;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT)
 211             ;; Date: 08 Jul 1996 23:22:24 -0400
 212             ;; should be
 213             ;; Tue Jul 9 09:04:21 1996
 214             (setq date (format-time-string
 215                         "%a %b %e %T %Y"
 216                         (if date
 217                             (apply 'encode-time (parse-time-string date))
 218                           (current-time))))
 219             (setq From_ (format "\nFrom %s  %s\n" from date))
 220             (while (string-match "," From_)
 221               (setq From_ (concat (substring From_ 0 (match-beginning 0))
 222                                   (substring From_ (match-end 0)))))
 223             (goto-char (point-min))
 224             (insert From_))))))
 225
 226 ;; The Command Set
 227
 228 ;; AUTHORIZATION STATE
 229
 230 (defun pop3-user (process user)
 231   "Send USER information to POP3 server."
 232   (pop3-send-command process (format "USER %s" user))
 233   (let ((response (pop3-read-response process t)))
 234     (if (not (and response (string-match "+OK" response)))
 235         (error (format "USER %s not valid." user)))))
 236
 237 (defun pop3-pass (process)
 238   "Send authentication information to the server."
 239   (pop3-send-command process (format "PASS %s" pop3-password))
 240   (let ((response (pop3-read-response process t)))
 241     (if (not (and response (string-match "+OK" response)))
 242         (pop3-quit process))))
 243
 244 (defun pop3-apop (process user)
 245   "Send alternate authentication information to the server."
 246   (if (not (fboundp 'md5)) (autoload 'md5 "md5"))
 247   (let ((hash (md5 (concat pop3-timestamp pop3-password))))
 248     (pop3-send-command process (format "APOP %s %s" user hash))
 249     (let ((response (pop3-read-response process t)))
 250       (if (not (and response (string-match "+OK" response)))
 251           (pop3-quit process)))))
 252
 253 ;; TRANSACTION STATE
 254
 255 (defun pop3-stat (process)
 256   "Return the number of messages in the maildrop and the maildrop's size."
 257   (pop3-send-command process "STAT")
 258   (let ((response (pop3-read-response process t)))
 259     (list (string-to-int (nth 1 (split-string response)))
 260           (string-to-int (nth 2 (split-string response))))
 261     ))
 262
 263 (defun pop3-list (process &optional msg)
 264   "Scan listing of available messages.
 265 This function currently does nothing.")
 266
 267 (defun pop3-retr (process msg crashbuf)
 268   "Retrieve message-id MSG to buffer CRASHBUF."
 269   (pop3-send-command process (format "RETR %s" msg))
 270   (pop3-read-response process)
 271   (let ((start pop3-read-point) end)
 272     (save-excursion
 273       (set-buffer (process-buffer process))
 274       (while (not (re-search-forward "^\\.\r\n" nil t))
 275         (accept-process-output process 3)
 276         ;; bill@att.com ... to save wear and tear on the heap
 277         ;; uncommented because the condensed version below is a problem for
 278         ;; some.
 279         (if (> (buffer-size)  20000) (sleep-for 1))
 280         (if (> (buffer-size)  50000) (sleep-for 1))
 281         (if (> (buffer-size) 100000) (sleep-for 1))
 282         (if (> (buffer-size) 200000) (sleep-for 1))
 283         (if (> (buffer-size) 500000) (sleep-for 1))
 284         ;; bill@att.com
 285         ;; condensed into:
 286         ;; (sometimes causes problems for really large messages.)
 287 ;       (if (> (buffer-size) 20000) (sleep-for (/ (buffer-size) 20000)))
 288         (goto-char start))
 289       (setq pop3-read-point (point-marker))
 290 ;; this code does not seem to work for some POP servers...
 291 ;; and I cannot figure out why not.
 292 ;      (goto-char (match-beginning 0))
 293 ;      (backward-char 2)
 294 ;      (if (not (looking-at "\r\n"))
 295 ;         (insert "\r\n"))
 296 ;      (re-search-forward "\\.\r\n")
 297       (goto-char (match-beginning 0))
 298       (setq end (point-marker))
 299       (pop3-clean-region start end)
 300       (pop3-munge-message-separator start end)
 301       (save-excursion
 302         (set-buffer crashbuf)
 303         (erase-buffer))
 304       (copy-to-buffer crashbuf start end)
 305       (delete-region start end)
 306       )))
 307
 308 (defun pop3-dele (process msg)
 309   "Mark message-id MSG as deleted."
 310   (pop3-send-command process (format "DELE %s" msg))
 311   (pop3-read-response process))
 312
 313 (defun pop3-noop (process msg)
 314   "No-operation."
 315   (pop3-send-command process "NOOP")
 316   (pop3-read-response process))
 317
 318 (defun pop3-last (process)
 319   "Return highest accessed message-id number for the session."
 320   (pop3-send-command process "LAST")
 321   (let ((response (pop3-read-response process t)))
 322     (string-to-int (nth 1 (split-string response)))
 323     ))
 324
 325 (defun pop3-rset (process)
 326   "Remove all delete marks from current maildrop."
 327   (pop3-send-command process "RSET")
 328   (pop3-read-response process))
 329
 330 ;; UPDATE
 331
 332 (defun pop3-quit (process)
 333   "Close connection to POP3 server.
 334 Tell server to remove all messages marked as deleted, unlock the maildrop,
 335 and close the connection."
 336   (pop3-send-command process "QUIT")
 337   (pop3-read-response process t)
 338   (if process
 339       (save-excursion
 340         (set-buffer (process-buffer process))
 341         (goto-char (point-max))
 342         (delete-process process))))
 343 \f
 344 ;; Summary of POP3 (Post Office Protocol version 3) commands and responses
 345
 346 ;;; AUTHORIZATION STATE
 347
 348 ;; Initial TCP connection
 349 ;; Arguments: none
 350 ;; Restrictions: none
 351 ;; Possible responses:
 352 ;;  +OK [POP3 server ready]
 353
 354 ;; USER name
 355 ;; Arguments: a server specific user-id (required)
 356 ;; Restrictions: authorization state [after unsuccessful USER or PASS
 357 ;; Possible responses:
 358 ;;  +OK [valid user-id]
 359 ;;  -ERR [invalid user-id]
 360
 361 ;; PASS string
 362 ;; Arguments: a server/user-id specific password (required)
 363 ;; Restrictions: authorization state, after successful USER
 364 ;; Possible responses:
 365 ;;  +OK [maildrop locked and ready]
 366 ;;  -ERR [invalid password]
 367 ;;  -ERR [unable to lock maildrop]
 368
 369 ;;; TRANSACTION STATE
 370
 371 ;; STAT
 372 ;; Arguments: none
 373 ;; Restrictions: transaction state
 374 ;; Possible responses:
 375 ;;  +OK nn mm [# of messages, size of maildrop]
 376
 377 ;; LIST [msg]
 378 ;; Arguments: a message-id (optional)
 379 ;; Restrictions: transaction state; msg must not be deleted
 380 ;; Possible responses:
 381 ;;  +OK [scan listing follows]
 382 ;;  -ERR [no such message]
 383
 384 ;; RETR msg
 385 ;; Arguments: a message-id (required)
 386 ;; Restrictions: transaction state; msg must not be deleted
 387 ;; Possible responses:
 388 ;;  +OK [message contents follow]
 389 ;;  -ERR [no such message]
 390
 391 ;; DELE msg
 392 ;; Arguments: a message-id (required)
 393 ;; Restrictions: transaction state; msg must not be deleted
 394 ;; Possible responses:
 395 ;;  +OK [message deleted]
 396 ;;  -ERR [no such message]
 397
 398 ;; NOOP
 399 ;; Arguments: none
 400 ;; Restrictions: transaction state
 401 ;; Possible responses:
 402 ;;  +OK
 403
 404 ;; LAST
 405 ;; Arguments: none
 406 ;; Restrictions: transaction state
 407 ;; Possible responses:
 408 ;;  +OK nn [highest numbered message accessed]
 409
 410 ;; RSET
 411 ;; Arguments: none
 412 ;; Restrictions: transaction state
 413 ;; Possible responses:
 414 ;;  +OK [all delete marks removed]
 415
 416 ;;; UPDATE STATE
 417
 418 ;; QUIT
 419 ;; Arguments: none
 420 ;; Restrictions: none
 421 ;; Possible responses:
 422 ;;  +OK [TCP connection closed]