[bpt/emacs.git] / lisp / gnus / pop3.el

;;; pop3.el --- Post Office Protocol (RFC 1460) interface

;; Copyright (C) 1996, 1997, 1998, 1999, 2000
;;        Free Software Foundation, Inc.

;; Author: Richard L. Pieri <ratinox@peorth.gweep.net>
;; Maintainer: FSF
;; Keywords: mail

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:

;; Most of the standard Post Office Protocol version 3 (RFC 1460) commands
;; are implemented.  The LIST command has not been implemented due to lack
;; of actual usefulness.
;; The optional POP3 command TOP has not been implemented.

;; This program was inspired by Kyle E. Jones's vm-pop program.

;;; Code:

(require 'mail-utils)

(defvar pop3-maildrop (or (user-login-name) (getenv "LOGNAME") (getenv "USER") nil)
  "*POP3 maildrop.")
(defvar pop3-mailhost (or (getenv "MAILHOST") nil)
  "*POP3 mailhost.")
(defvar pop3-port 110
  "*POP3 port.")

(defvar pop3-password-required t
  "*Non-nil if a password is required when connecting to POP server.")
(defvar pop3-password nil
  "*Password to use when connecting to POP server.")

(defvar pop3-authentication-scheme 'pass
  "*POP3 authentication scheme.
Defaults to 'pass, for the standard USER/PASS authentication.  Other valid
values are 'apop.")

(defvar pop3-timestamp nil
  "Timestamp returned when initially connected to the POP server.
Used for APOP authentication.")

(defvar pop3-read-point nil)
(defvar pop3-debug nil)

(defun pop3-movemail (&optional crashbox)
  "Transfer contents of a maildrop to the specified CRASHBOX."
  (or crashbox (setq crashbox (expand-file-name "~/.crashbox")))
  (let* ((process (pop3-open-server pop3-mailhost pop3-port))
	 (crashbuf (get-buffer-create " *pop3-retr*"))
	 (n 1)
	 message-count
	 (pop3-password pop3-password)
	 )
    ;; for debugging only
    (if pop3-debug (switch-to-buffer (process-buffer process)))
    ;; query for password
    (if (and pop3-password-required (not pop3-password))
	(setq pop3-password
	      (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
    (cond ((equal 'apop pop3-authentication-scheme)
	   (pop3-apop process pop3-maildrop))
	  ((equal 'pass pop3-authentication-scheme)
	   (pop3-user process pop3-maildrop)
	   (pop3-pass process))
	  (t (error "Invalid POP3 authentication scheme")))
    (setq message-count (car (pop3-stat process)))
    (unwind-protect
	(while (<= n message-count)
	  (message (format "Retrieving message %d of %d from %s..."
			   n message-count pop3-mailhost))
	  (pop3-retr process n crashbuf)
	  (save-excursion
	    (set-buffer crashbuf)
	    (let ((coding-system-for-write 'binary))
	      (write-region (point-min) (point-max) crashbox t 'nomesg))
	    (set-buffer (process-buffer process))
	    (while (> (buffer-size) 5000)
	      (goto-char (point-min))
	      (forward-line 50)
	      (delete-region (point-min) (point))))
	  (pop3-dele process n)
	  (setq n (+ 1 n))
	  (if pop3-debug (sit-for 1) (sit-for 0.1))
	  )
      (pop3-quit process))
    (kill-buffer crashbuf)
    )
  t)

(defun pop3-get-message-count ()
  "Return the number of messages in the maildrop."
  (let* ((process (pop3-open-server pop3-mailhost pop3-port))
	 message-count
	 (pop3-password pop3-password)
	 )
    ;; for debugging only
    (if pop3-debug (switch-to-buffer (process-buffer process)))
    ;; query for password
    (if (and pop3-password-required (not pop3-password))
	(setq pop3-password
	      (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
    (cond ((equal 'apop pop3-authentication-scheme)
	   (pop3-apop process pop3-maildrop))
	  ((equal 'pass pop3-authentication-scheme)
	   (pop3-user process pop3-maildrop)
	   (pop3-pass process))
	  (t (error "Invalid POP3 authentication scheme")))
    (setq message-count (car (pop3-stat process)))
    (pop3-quit process)
    message-count))

(defun pop3-open-server (mailhost port)
  "Open TCP connection to MAILHOST on PORT.
Returns the process associated with the connection."
  (let ((coding-system-for-read 'binary)
	(coding-system-for-write 'binary)
	process)
    (save-excursion
      (set-buffer (get-buffer-create (concat " trace of POP session to "
					     mailhost)))
      (erase-buffer)
      (setq pop3-read-point (point-min))
      (setq process (open-network-stream "POP"(current-buffer) mailhost port))
      (let ((response (pop3-read-response process t)))
	(setq pop3-timestamp
	      (substring response (or (string-match "<" response) 0)
			 (+ 1 (or (string-match ">" response) -1)))))
      process)))

;; Support functions

(defun pop3-process-filter (process output)
  (save-excursion
    (set-buffer (process-buffer process))
    (goto-char (point-max))
    (insert output)))

(defun pop3-send-command (process command)
    (set-buffer (process-buffer process))
    (goto-char (point-max))
;;    (if (= (aref command 0) ?P)
;;	(insert "PASS <omitted>\r\n")
;;      (insert command "\r\n"))
    (setq pop3-read-point (point))
    (goto-char (point-max))
    (process-send-string process (concat command "\r\n"))
    )

(defun pop3-read-response (process &optional return)
  "Read the response from the server.
Return the response string if optional second argument is non-nil."
  (let ((case-fold-search nil)
	match-end)
    (save-excursion
      (set-buffer (process-buffer process))
      (goto-char pop3-read-point)
      (while (not (search-forward "\r\n" nil t))
	(accept-process-output process 3)
	(goto-char pop3-read-point))
      (setq match-end (point))
      (goto-char pop3-read-point)
      (if (looking-at "-ERR")
	  (error (buffer-substring (point) (- match-end 2)))
	(if (not (looking-at "+OK"))
	    (progn (setq pop3-read-point match-end) nil)
	  (setq pop3-read-point match-end)
	  (if return
	      (buffer-substring (point) match-end)
	    t)
	  )))))

(defvar pop3-read-passwd nil)
(defun pop3-read-passwd (prompt)
  (if (not pop3-read-passwd)
      (if (fboundp 'read-passwd)
	  (setq pop3-read-passwd 'read-passwd)
	(if (load "passwd" t)
	    (setq pop3-read-passwd 'read-passwd)
	  (autoload 'ange-ftp-read-passwd "ange-ftp")
	  (setq pop3-read-passwd 'ange-ftp-read-passwd))))
  (funcall pop3-read-passwd prompt))

(defun pop3-clean-region (start end)
  (setq end (set-marker (make-marker) end))
  (save-excursion
    (goto-char start)
    (while (and (< (point) end) (search-forward "\r\n" end t))
      (replace-match "\n" t t))
    (goto-char start)
    (while (and (< (point) end) (re-search-forward "^\\." end t))
      (replace-match "" t t)
      (forward-char)))
  (set-marker end nil))

(eval-when-compile (defvar parse-time-months))

;; Copied from message-make-date.
(defun pop3-make-date (&optional now)
  "Make a valid date header.
If NOW, use that time instead."
  (require 'parse-time)
  (let* ((now (or now (current-time)))
	 (zone (nth 8 (decode-time now)))
	 (sign "+"))
    (when (< zone 0)
      (setq sign "-")
      (setq zone (- zone)))
    (concat
     (format-time-string "%d" now)
     ;; The month name of the %b spec is locale-specific.  Pfff.
     (format " %s "
	     (capitalize (car (rassoc (nth 4 (decode-time now))
				      parse-time-months))))
     (format-time-string "%Y %H:%M:%S " now)
     ;; We do all of this because XEmacs doesn't have the %z spec.
     (format "%s%02d%02d" sign (/ zone 3600) (/ (% zone 3600) 60)))))

(defun pop3-munge-message-separator (start end)
  "Check to see if a message separator exists.  If not, generate one."
  (save-excursion
    (save-restriction
      (narrow-to-region start end)
      (goto-char (point-min))
      (if (not (or (looking-at "From .?") ; Unix mail
		   (looking-at "\001\001\001\001\n") ; MMDF
		   (looking-at "BABYL OPTIONS:") ; Babyl
		   ))
	  (let ((from (mail-strip-quoted-names (mail-fetch-field "From")))
		(date (split-string (or (mail-fetch-field "Date")
					(pop3-make-date))
				    " "))
		(From_))
	    ;; sample date formats I have seen
	    ;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT)
	    ;; Date: 08 Jul 1996 23:22:24 -0400
	    ;; should be
	    ;; Tue Jul 9 09:04:21 1996
	    (setq date
		  (cond ((string-match "[A-Z]" (nth 0 date))
			 (format "%s %s %s %s %s"
				 (nth 0 date) (nth 2 date) (nth 1 date)
				 (nth 4 date) (nth 3 date)))
			(t
			 ;; this really needs to be better but I don't feel
			 ;; like writing a date to day converter.
			 (format "Sun %s %s %s %s"
				 (nth 1 date) (nth 0 date)
				 (nth 3 date) (nth 2 date)))
			))
	    (setq From_ (format "\nFrom %s  %s\n" from date))
	    (while (string-match "," From_)
	      (setq From_ (concat (substring From_ 0 (match-beginning 0))
				  (substring From_ (match-end 0)))))
	    (goto-char (point-min))
	    (insert From_)
	    (if (search-forward "\n\n" nil t)
		nil
	      (goto-char (point-max))
	      (insert "\n"))
	    (narrow-to-region (point) (point-max))
	    (let ((size (- (point-max) (point-min))))
	      (goto-char (point-min))
	      (widen)
	      (forward-line -1)
	      (insert (format "Content-Length: %s\n" size)))
	    )))))

;; The Command Set

;; AUTHORIZATION STATE

(defun pop3-user (process user)
  "Send USER information to POP3 server."
  (pop3-send-command process (format "USER %s" user))
  (let ((response (pop3-read-response process t)))
    (if (not (and response (string-match "+OK" response)))
	(error (format "USER %s not valid" user)))))

(defun pop3-pass (process)
  "Send authentication information to the server."
  (pop3-send-command process (format "PASS %s" pop3-password))
  (let ((response (pop3-read-response process t)))
    (if (not (and response (string-match "+OK" response)))
	(pop3-quit process))))

(defun pop3-apop (process user)
  "Send alternate authentication information to the server."
  (let ((pass pop3-password))
    (if (and pop3-password-required (not pass))
	(setq pass
	      (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
    (if pass
	(let ((hash (pop3-md5 (concat pop3-timestamp pass))))
	  (pop3-send-command process (format "APOP %s %s" user hash))
	  (let ((response (pop3-read-response process t)))
	    (if (not (and response (string-match "+OK" response)))
		(pop3-quit process)))))
    ))

;; TRANSACTION STATE

(eval-and-compile
  (if (fboundp 'md5)
      (defalias 'pop3-md5 'md5)
    (defvar pop3-md5-program "md5"
      "*Program to encode its input in MD5.")

    (defun pop3-md5 (string)
      (with-temp-buffer
	(insert string)
	(call-process-region (point-min) (point-max)
			     pop3-md5-program
			     t (current-buffer) nil)
	;; The meaningful output is the first 32 characters.
	;; Don't return the newline that follows them!
	(buffer-substring 1 33)))))

(defun pop3-stat (process)
  "Return the number of messages in the maildrop and the maildrop's size."
  (pop3-send-command process "STAT")
  (let ((response (pop3-read-response process t)))
    (list (string-to-int (nth 1 (split-string response " ")))
	  (string-to-int (nth 2 (split-string response " "))))
    ))

(defun pop3-list (process &optional msg)
  "Scan listing of available messages.
This function currently does nothing.")

(defun pop3-retr (process msg crashbuf)
  "Retrieve message-id MSG to buffer CRASHBUF."
  (pop3-send-command process (format "RETR %s" msg))
  (pop3-read-response process)
  (let ((start pop3-read-point) end)
    (save-excursion
      (set-buffer (process-buffer process))
      (while (not (re-search-forward "^\\.\r\n" nil t))
	(accept-process-output process 3)
	;; bill@att.com ... to save wear and tear on the heap
	;; uncommented because the condensed version below is a problem for
	;; some.
	(if (> (buffer-size)  20000) (sleep-for 1))
	(if (> (buffer-size)  50000) (sleep-for 1))
	(if (> (buffer-size) 100000) (sleep-for 1))
	(if (> (buffer-size) 200000) (sleep-for 1))
	(if (> (buffer-size) 500000) (sleep-for 1))
	;; bill@att.com
	;; condensed into:
	;; (sometimes causes problems for really large messages.)
;	(if (> (buffer-size) 20000) (sleep-for (/ (buffer-size) 20000)))
	(goto-char start))
      (setq pop3-read-point (point-marker))
;; this code does not seem to work for some POP servers...
;; and I cannot figure out why not.
;      (goto-char (match-beginning 0))
;      (backward-char 2)
;      (if (not (looking-at "\r\n"))
;	  (insert "\r\n"))
;      (re-search-forward "\\.\r\n")
      (goto-char (match-beginning 0))
      (setq end (point-marker))
      (pop3-clean-region start end)
      (pop3-munge-message-separator start end)
      (save-excursion
	(set-buffer crashbuf)
	(erase-buffer))
      (copy-to-buffer crashbuf start end)
      (delete-region start end)
      )))

(defun pop3-dele (process msg)
  "Mark message-id MSG as deleted."
  (pop3-send-command process (format "DELE %s" msg))
  (pop3-read-response process))

(defun pop3-noop (process msg)
  "No-operation."
  (pop3-send-command process "NOOP")
  (pop3-read-response process))

(defun pop3-last (process)
  "Return highest accessed message-id number for the session."
  (pop3-send-command process "LAST")
  (let ((response (pop3-read-response process t)))
    (string-to-int (nth 1 (split-string response " ")))
    ))

(defun pop3-rset (process)
  "Remove all delete marks from current maildrop."
  (pop3-send-command process "RSET")
  (pop3-read-response process))

;; UPDATE

(defun pop3-quit (process)
  "Close connection to POP3 server.
Tell server to remove all messages marked as deleted, unlock the maildrop,
and close the connection."
  (pop3-send-command process "QUIT")
  (pop3-read-response process t)
  (if process
      (save-excursion
	(set-buffer (process-buffer process))
	(goto-char (point-max))
	(delete-process process))))
\f
;; Summary of POP3 (Post Office Protocol version 3) commands and responses

;;; AUTHORIZATION STATE

;; Initial TCP connection
;; Arguments: none
;; Restrictions: none
;; Possible responses:
;;  +OK [POP3 server ready]

;; USER name
;; Arguments: a server specific user-id (required)
;; Restrictions: authorization state [after unsuccessful USER or PASS
;; Possible responses:
;;  +OK [valid user-id]
;;  -ERR [invalid user-id]

;; PASS string
;; Arguments: a server/user-id specific password (required)
;; Restrictions: authorization state, after successful USER
;; Possible responses:
;;  +OK [maildrop locked and ready]
;;  -ERR [invalid password]
;;  -ERR [unable to lock maildrop]

;;; TRANSACTION STATE

;; STAT
;; Arguments: none
;; Restrictions: transaction state
;; Possible responses:
;;  +OK nn mm [# of messages, size of maildrop]

;; LIST [msg]
;; Arguments: a message-id (optional)
;; Restrictions: transaction state; msg must not be deleted
;; Possible responses:
;;  +OK [scan listing follows]
;;  -ERR [no such message]

;; RETR msg
;; Arguments: a message-id (required)
;; Restrictions: transaction state; msg must not be deleted
;; Possible responses:
;;  +OK [message contents follow]
;;  -ERR [no such message]

;; DELE msg
;; Arguments: a message-id (required)
;; Restrictions: transaction state; msg must not be deleted
;; Possible responses:
;;  +OK [message deleted]
;;  -ERR [no such message]

;; NOOP
;; Arguments: none
;; Restrictions: transaction state
;; Possible responses:
;;  +OK

;; LAST
;; Arguments: none
;; Restrictions: transaction state
;; Possible responses:
;;  +OK nn [highest numbered message accessed]

;; RSET
;; Arguments: none
;; Restrictions: transaction state
;; Possible responses:
;;  +OK [all delete marks removed]

;;; UPDATE STATE

;; QUIT
;; Arguments: none
;; Restrictions: none
;; Possible responses:
;;  +OK [TCP connection closed]

(provide 'pop3)

;;; pop3.el ends here
Commit	Line	Data
eec82323 LMI	1	;;; pop3.el --- Post Office Protocol (RFC 1460) interface
eec82323 LMI	2
16409b0b GM	3	;; Copyright (C) 1996, 1997, 1998, 1999, 2000
16409b0b GM	4	;; Free Software Foundation, Inc.
eec82323 LMI	5
eec82323 LMI	6	;; Author: Richard L. Pieri <ratinox@peorth.gweep.net>
dd5da9b8 DL	7	;; Maintainer: FSF
dd5da9b8 DL	8	;; Keywords: mail
eec82323 LMI	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., 59 Temple Place - Suite 330,
	25	;; Boston, MA 02111-1307, 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)
eec82323	39
6748645f	40	(defvar pop3-maildrop (or (user-login-name) (getenv "LOGNAME") (getenv "USER") nil)
eec82323 LMI	41	"*POP3 maildrop.")
	42	(defvar pop3-mailhost (or (getenv "MAILHOST") nil)
	43	"*POP3 mailhost.")
	44	(defvar pop3-port 110
	45	"*POP3 port.")
	46
	47	(defvar pop3-password-required t
	48	"*Non-nil if a password is required when connecting to POP server.")
	49	(defvar pop3-password nil
	50	"*Password to use when connecting to POP server.")
	51
	52	(defvar pop3-authentication-scheme 'pass
	53	"*POP3 authentication scheme.
	54	Defaults to 'pass, for the standard USER/PASS authentication. Other valid
	55	values are 'apop.")
	56
	57	(defvar pop3-timestamp nil
	58	"Timestamp returned when initially connected to the POP server.
	59	Used for APOP authentication.")
	60
	61	(defvar pop3-read-point nil)
	62	(defvar pop3-debug nil)
	63
	64	(defun pop3-movemail (&optional crashbox)
	65	"Transfer contents of a maildrop to the specified CRASHBOX."
	66	(or crashbox (setq crashbox (expand-file-name "~/.crashbox")))
	67	(let* ((process (pop3-open-server pop3-mailhost pop3-port))
	68	(crashbuf (get-buffer-create " pop3-retr"))
	69	(n 1)
6748645f LMI	70	message-count
	71	(pop3-password pop3-password)
	72	)
eec82323 LMI	73	;; for debugging only
eec82323 LMI	74	(if pop3-debug (switch-to-buffer (process-buffer process)))
6748645f LMI	75	;; query for password
	76	(if (and pop3-password-required (not pop3-password))
	77	(setq pop3-password
	78	(pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
eec82323 LMI	79	(cond ((equal 'apop pop3-authentication-scheme)
	80	(pop3-apop process pop3-maildrop))
	81	((equal 'pass pop3-authentication-scheme)
	82	(pop3-user process pop3-maildrop)
	83	(pop3-pass process))
dd5da9b8	84	(t (error "Invalid POP3 authentication scheme")))
eec82323	85	(setq message-count (car (pop3-stat process)))
dd5da9b8 DL	86	(unwind-protect
	87	(while (<= n message-count)
	88	(message (format "Retrieving message %d of %d from %s..."
	89	n message-count pop3-mailhost))
	90	(pop3-retr process n crashbuf)
	91	(save-excursion
	92	(set-buffer crashbuf)
4c4b227a	93	(let ((coding-system-for-write 'binary))
a9c810bf	94	(write-region (point-min) (point-max) crashbox t 'nomesg))
dd5da9b8 DL	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))
eec82323 LMI	105	(kill-buffer crashbuf)
eec82323 LMI	106	)
dd5da9b8	107	t)
eec82323	108
619ac84f SZ	109	(defun pop3-get-message-count ()
	110	"Return the number of messages in the maildrop."
	111	(let* ((process (pop3-open-server pop3-mailhost pop3-port))
	112	message-count
	113	(pop3-password pop3-password)
	114	)
	115	;; for debugging only
	116	(if pop3-debug (switch-to-buffer (process-buffer process)))
	117	;; query for password
	118	(if (and pop3-password-required (not pop3-password))
	119	(setq pop3-password
	120	(pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
	121	(cond ((equal 'apop pop3-authentication-scheme)
	122	(pop3-apop process pop3-maildrop))
	123	((equal 'pass pop3-authentication-scheme)
	124	(pop3-user process pop3-maildrop)
	125	(pop3-pass process))
55535639	126	(t (error "Invalid POP3 authentication scheme")))
619ac84f SZ	127	(setq message-count (car (pop3-stat process)))
	128	(pop3-quit process)
	129	message-count))
	130
eec82323	131	(defun pop3-open-server (mailhost port)
dd5da9b8	132	"Open TCP connection to MAILHOST on PORT.
eec82323	133	Returns the process associated with the connection."
4cac7481	134	(let ((coding-system-for-read 'binary)
6748645f	135	(coding-system-for-write 'binary)
4cac7481	136	process)
eec82323	137	(save-excursion
4cac7481 DL	138	(set-buffer (get-buffer-create (concat " trace of POP session to "
4cac7481 DL	139	mailhost)))
6748645f LMI	140	(erase-buffer)
6748645f LMI	141	(setq pop3-read-point (point-min))
4cac7481 DL	142	(setq process (open-network-stream "POP"(current-buffer) mailhost port))
	143	(let ((response (pop3-read-response process t)))
	144	(setq pop3-timestamp
	145	(substring response (or (string-match "<" response) 0)
	146	(+ 1 (or (string-match ">" response) -1)))))
	147	process)))
eec82323 LMI	148
	149	;; Support functions
	150
	151	(defun pop3-process-filter (process output)
	152	(save-excursion
	153	(set-buffer (process-buffer process))
	154	(goto-char (point-max))
	155	(insert output)))
	156
	157	(defun pop3-send-command (process command)
	158	(set-buffer (process-buffer process))
	159	(goto-char (point-max))
	160	;; (if (= (aref command 0) ?P)
	161	;; (insert "PASS <omitted>\r\n")
	162	;; (insert command "\r\n"))
	163	(setq pop3-read-point (point))
	164	(goto-char (point-max))
dd5da9b8	165	(process-send-string process (concat command "\r\n"))
eec82323 LMI	166	)
	167
	168	(defun pop3-read-response (process &optional return)
	169	"Read the response from the server.
	170	Return the response string if optional second argument is non-nil."
	171	(let ((case-fold-search nil)
	172	match-end)
	173	(save-excursion
	174	(set-buffer (process-buffer process))
	175	(goto-char pop3-read-point)
	176	(while (not (search-forward "\r\n" nil t))
a8151ef7	177	(accept-process-output process 3)
eec82323 LMI	178	(goto-char pop3-read-point))
	179	(setq match-end (point))
	180	(goto-char pop3-read-point)
	181	(if (looking-at "-ERR")
	182	(error (buffer-substring (point) (- match-end 2)))
	183	(if (not (looking-at "+OK"))
	184	(progn (setq pop3-read-point match-end) nil)
	185	(setq pop3-read-point match-end)
	186	(if return
	187	(buffer-substring (point) match-end)
	188	t)
	189	)))))
	190
eec82323 LMI	191	(defvar pop3-read-passwd nil)
	192	(defun pop3-read-passwd (prompt)
	193	(if (not pop3-read-passwd)
ff88af37	194	(if (fboundp 'read-passwd)
eec82323	195	(setq pop3-read-passwd 'read-passwd)
ff88af37 RS	196	(if (load "passwd" t)
	197	(setq pop3-read-passwd 'read-passwd)
	198	(autoload 'ange-ftp-read-passwd "ange-ftp")
	199	(setq pop3-read-passwd 'ange-ftp-read-passwd))))
eec82323 LMI	200	(funcall pop3-read-passwd prompt))
	201
	202	(defun pop3-clean-region (start end)
	203	(setq end (set-marker (make-marker) end))
	204	(save-excursion
	205	(goto-char start)
	206	(while (and (< (point) end) (search-forward "\r\n" end t))
	207	(replace-match "\n" t t))
	208	(goto-char start)
	209	(while (and (< (point) end) (re-search-forward "^\\." end t))
	210	(replace-match "" t t)
	211	(forward-char)))
	212	(set-marker end nil))
	213
daaeed87 DL	214	(eval-when-compile (defvar parse-time-months))
	215
	216	;; Copied from message-make-date.
	217	(defun pop3-make-date (&optional now)
	218	"Make a valid date header.
	219	If NOW, use that time instead."
	220	(require 'parse-time)
	221	(let* ((now (or now (current-time)))
	222	(zone (nth 8 (decode-time now)))
	223	(sign "+"))
	224	(when (< zone 0)
	225	(setq sign "-")
	226	(setq zone (- zone)))
	227	(concat
	228	(format-time-string "%d" now)
	229	;; The month name of the %b spec is locale-specific. Pfff.
	230	(format " %s "
	231	(capitalize (car (rassoc (nth 4 (decode-time now))
	232	parse-time-months))))
	233	(format-time-string "%Y %H:%M:%S " now)
	234	;; We do all of this because XEmacs doesn't have the %z spec.
	235	(format "%s%02d%02d" sign (/ zone 3600) (/ (% zone 3600) 60)))))
	236
eec82323 LMI	237	(defun pop3-munge-message-separator (start end)
	238	"Check to see if a message separator exists. If not, generate one."
	239	(save-excursion
	240	(save-restriction
	241	(narrow-to-region start end)
	242	(goto-char (point-min))
	243	(if (not (or (looking-at "From .?") ; Unix mail
	244	(looking-at "\001\001\001\001\n") ; MMDF
	245	(looking-at "BABYL OPTIONS:") ; Babyl
	246	))
	247	(let ((from (mail-strip-quoted-names (mail-fetch-field "From")))
4cac7481	248	(date (split-string (or (mail-fetch-field "Date")
daaeed87	249	(pop3-make-date))
4cac7481	250	" "))
eec82323 LMI	251	(From_))
	252	;; sample date formats I have seen
	253	;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT)
	254	;; Date: 08 Jul 1996 23:22:24 -0400
	255	;; should be
	256	;; Tue Jul 9 09:04:21 1996
	257	(setq date
	258	(cond ((string-match "[A-Z]" (nth 0 date))
	259	(format "%s %s %s %s %s"
	260	(nth 0 date) (nth 2 date) (nth 1 date)
	261	(nth 4 date) (nth 3 date)))
	262	(t
	263	;; this really needs to be better but I don't feel
	264	;; like writing a date to day converter.
	265	(format "Sun %s %s %s %s"
	266	(nth 1 date) (nth 0 date)
	267	(nth 3 date) (nth 2 date)))
	268	))
	269	(setq From_ (format "\nFrom %s %s\n" from date))
	270	(while (string-match "," From_)
	271	(setq From_ (concat (substring From_ 0 (match-beginning 0))
	272	(substring From_ (match-end 0)))))
	273	(goto-char (point-min))
dd5da9b8	274	(insert From_)
daaeed87 DL	275	(if (search-forward "\n\n" nil t)
	276	nil
	277	(goto-char (point-max))
	278	(insert "\n"))
dd5da9b8 DL	279	(narrow-to-region (point) (point-max))
	280	(let ((size (- (point-max) (point-min))))
	281	(goto-char (point-min))
	282	(widen)
	283	(forward-line -1)
	284	(insert (format "Content-Length: %s\n" size)))
	285	)))))
eec82323 LMI	286
	287	;; The Command Set
	288
	289	;; AUTHORIZATION STATE
	290
	291	(defun pop3-user (process user)
	292	"Send USER information to POP3 server."
	293	(pop3-send-command process (format "USER %s" user))
	294	(let ((response (pop3-read-response process t)))
	295	(if (not (and response (string-match "+OK" response)))
55535639	296	(error (format "USER %s not valid" user)))))
eec82323 LMI	297
	298	(defun pop3-pass (process)
	299	"Send authentication information to the server."
6748645f LMI	300	(pop3-send-command process (format "PASS %s" pop3-password))
	301	(let ((response (pop3-read-response process t)))
	302	(if (not (and response (string-match "+OK" response)))
	303	(pop3-quit process))))
	304
	305	(defun pop3-apop (process user)
	306	"Send alternate authentication information to the server."
eec82323 LMI	307	(let ((pass pop3-password))
	308	(if (and pop3-password-required (not pass))
	309	(setq pass
	310	(pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
	311	(if pass
6748645f LMI	312	(let ((hash (pop3-md5 (concat pop3-timestamp pass))))
6748645f LMI	313	(pop3-send-command process (format "APOP %s %s" user hash))
eec82323 LMI	314	(let ((response (pop3-read-response process t)))
	315	(if (not (and response (string-match "+OK" response)))
	316	(pop3-quit process)))))
	317	))
	318
6748645f LMI	319	;; TRANSACTION STATE
6748645f LMI	320
daaeed87 DL	321	(eval-and-compile
	322	(if (fboundp 'md5)
	323	(defalias 'pop3-md5 'md5)
	324	(defvar pop3-md5-program "md5"
	325	"*Program to encode its input in MD5.")
	326
	327	(defun pop3-md5 (string)
	328	(with-temp-buffer
	329	(insert string)
	330	(call-process-region (point-min) (point-max)
	331	pop3-md5-program
	332	t (current-buffer) nil)
	333	;; The meaningful output is the first 32 characters.
	334	;; Don't return the newline that follows them!
	335	(buffer-substring 1 33)))))
838bf473	336
eec82323 LMI	337	(defun pop3-stat (process)
	338	"Return the number of messages in the maildrop and the maildrop's size."
	339	(pop3-send-command process "STAT")
	340	(let ((response (pop3-read-response process t)))
4cac7481 DL	341	(list (string-to-int (nth 1 (split-string response " ")))
4cac7481 DL	342	(string-to-int (nth 2 (split-string response " "))))
eec82323 LMI	343	))
	344
	345	(defun pop3-list (process &optional msg)
	346	"Scan listing of available messages.
	347	This function currently does nothing.")
	348
	349	(defun pop3-retr (process msg crashbuf)
	350	"Retrieve message-id MSG to buffer CRASHBUF."
	351	(pop3-send-command process (format "RETR %s" msg))
	352	(pop3-read-response process)
	353	(let ((start pop3-read-point) end)
	354	(save-excursion
	355	(set-buffer (process-buffer process))
	356	(while (not (re-search-forward "^\\.\r\n" nil t))
a8151ef7	357	(accept-process-output process 3)
eec82323	358	;; bill@att.com ... to save wear and tear on the heap
6748645f LMI	359	;; uncommented because the condensed version below is a problem for
6748645f LMI	360	;; some.
eec82323 LMI	361	(if (> (buffer-size) 20000) (sleep-for 1))
	362	(if (> (buffer-size) 50000) (sleep-for 1))
	363	(if (> (buffer-size) 100000) (sleep-for 1))
	364	(if (> (buffer-size) 200000) (sleep-for 1))
	365	(if (> (buffer-size) 500000) (sleep-for 1))
	366	;; bill@att.com
6748645f LMI	367	;; condensed into:
	368	;; (sometimes causes problems for really large messages.)
	369	; (if (> (buffer-size) 20000) (sleep-for (/ (buffer-size) 20000)))
eec82323 LMI	370	(goto-char start))
	371	(setq pop3-read-point (point-marker))
	372	;; this code does not seem to work for some POP servers...
	373	;; and I cannot figure out why not.
	374	; (goto-char (match-beginning 0))
	375	; (backward-char 2)
	376	; (if (not (looking-at "\r\n"))
	377	; (insert "\r\n"))
	378	; (re-search-forward "\\.\r\n")
	379	(goto-char (match-beginning 0))
	380	(setq end (point-marker))
	381	(pop3-clean-region start end)
	382	(pop3-munge-message-separator start end)
	383	(save-excursion
	384	(set-buffer crashbuf)
	385	(erase-buffer))
	386	(copy-to-buffer crashbuf start end)
	387	(delete-region start end)
	388	)))
	389
	390	(defun pop3-dele (process msg)
	391	"Mark message-id MSG as deleted."
	392	(pop3-send-command process (format "DELE %s" msg))
	393	(pop3-read-response process))
	394
	395	(defun pop3-noop (process msg)
	396	"No-operation."
	397	(pop3-send-command process "NOOP")
	398	(pop3-read-response process))
	399
	400	(defun pop3-last (process)
	401	"Return highest accessed message-id number for the session."
	402	(pop3-send-command process "LAST")
	403	(let ((response (pop3-read-response process t)))
4cac7481	404	(string-to-int (nth 1 (split-string response " ")))
eec82323 LMI	405	))
	406
	407	(defun pop3-rset (process)
	408	"Remove all delete marks from current maildrop."
	409	(pop3-send-command process "RSET")
	410	(pop3-read-response process))
	411
	412	;; UPDATE
	413
	414	(defun pop3-quit (process)
	415	"Close connection to POP3 server.
	416	Tell server to remove all messages marked as deleted, unlock the maildrop,
	417	and close the connection."
	418	(pop3-send-command process "QUIT")
	419	(pop3-read-response process t)
	420	(if process
	421	(save-excursion
	422	(set-buffer (process-buffer process))
	423	(goto-char (point-max))
	424	(delete-process process))))
	425	\f
	426	;; Summary of POP3 (Post Office Protocol version 3) commands and responses
	427
	428	;;; AUTHORIZATION STATE
	429
	430	;; Initial TCP connection
	431	;; Arguments: none
	432	;; Restrictions: none
	433	;; Possible responses:
	434	;; +OK [POP3 server ready]
	435
	436	;; USER name
	437	;; Arguments: a server specific user-id (required)
	438	;; Restrictions: authorization state [after unsuccessful USER or PASS
	439	;; Possible responses:
	440	;; +OK [valid user-id]
	441	;; -ERR [invalid user-id]
	442
	443	;; PASS string
	444	;; Arguments: a server/user-id specific password (required)
	445	;; Restrictions: authorization state, after successful USER
	446	;; Possible responses:
	447	;; +OK [maildrop locked and ready]
	448	;; -ERR [invalid password]
	449	;; -ERR [unable to lock maildrop]
	450
	451	;;; TRANSACTION STATE
	452
	453	;; STAT
	454	;; Arguments: none
	455	;; Restrictions: transaction state
	456	;; Possible responses:
	457	;; +OK nn mm [# of messages, size of maildrop]
	458
	459	;; LIST [msg]
	460	;; Arguments: a message-id (optional)
	461	;; Restrictions: transaction state; msg must not be deleted
	462	;; Possible responses:
	463	;; +OK [scan listing follows]
	464	;; -ERR [no such message]
	465
	466	;; RETR msg
	467	;; Arguments: a message-id (required)
	468	;; Restrictions: transaction state; msg must not be deleted
469	;; Possible responses:
470	;; +OK [message contents follow]
471	;; -ERR [no such message]
472
473	;; DELE msg
474	;; Arguments: a message-id (required)
475	;; Restrictions: transaction state; msg must not be deleted
476	;; Possible responses:
477	;; +OK [message deleted]
478	;; -ERR [no such message]
479
480	;; NOOP
481	;; Arguments: none
482	;; Restrictions: transaction state
483	;; Possible responses:
484	;; +OK
485
486	;; LAST
487	;; Arguments: none
488	;; Restrictions: transaction state
489	;; Possible responses:
490	;; +OK nn [highest numbered message accessed]
491
492	;; RSET
493	;; Arguments: none
494	;; Restrictions: transaction state
495	;; Possible responses:
496	;; +OK [all delete marks removed]
497
498	;;; UPDATE STATE
499
500	;; QUIT
501	;; Arguments: none
502	;; Restrictions: none
503	;; Possible responses:
504	;; +OK [TCP connection closed]
dd5da9b8 DL	505
	506	(provide 'pop3)
	507
	508	;;; pop3.el ends here