1 ;;; pop3.el --- Post Office Protocol (RFC 1460) interface
3 ;; Copyright (C) 1996,1997,1998 Free Software Foundation, Inc.
5 ;; Author: Richard L. Pieri <ratinox@peorth.gweep.net>
6 ;; Keywords: mail, pop3
9 ;; This file is part of GNU Emacs.
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)
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.
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.
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.
33 ;; This program was inspired by Kyle E. Jones's vm-pop program.
40 (defconst pop3-version "1.3m")
42 (defvar pop3-maildrop (or (user-login-name) (getenv "LOGNAME") (getenv "USER") nil)
44 (defvar pop3-mailhost (or (getenv "MAILHOST") nil)
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.")
54 (defvar pop3-authentication-scheme 'pass
55 "*POP3 authentication scheme.
56 Defaults to 'pass, for the standard USER/PASS authentication. Other valid
59 (defvar pop3-timestamp nil
60 "Timestamp returned when initially connected to the POP server.
61 Used for APOP authentication.")
63 (defvar pop3-read-point nil)
64 (defvar pop3-debug nil)
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*"))
73 (pop3-password pop3-password)
76 (if pop3-debug (switch-to-buffer (process-buffer process)))
78 (if (and pop3-password-required (not 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)
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)
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))
99 (delete-region (point-min) (point))))
100 (pop3-dele process n)
102 (if pop3-debug (sit-for 1) (sit-for 0.1))
105 (kill-buffer crashbuf)
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)))
116 (set-buffer process-buffer)
118 (setq pop3-read-point (point-min))
121 (open-network-stream-as-binary "POP" process-buffer mailhost port))
122 (let ((response (pop3-read-response process t)))
124 (substring response (or (string-match "<" response) 0)
125 (+ 1 (or (string-match ">" response) -1)))))
130 (defun pop3-process-filter (process output)
132 (set-buffer (process-buffer process))
133 (goto-char (point-max))
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")
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)
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)
167 (buffer-substring (point) match-end)
171 (defun pop3-string-to-list (string &optional regexp)
172 "Chop up a string into a list."
174 (regexp (or regexp " "))
175 (string (if (string-match "\r" string)
176 (substring string 0 (match-beginning 0))
178 (store-match-data nil)
180 (if (string-match regexp string)
181 (setq list (cons (substring string 0 (- (match-end 0) 1)) list)
182 string (substring string (match-end 0)))
183 (setq list (cons string list)
187 (defvar pop3-read-passwd nil)
188 (defun pop3-read-passwd (prompt)
189 (if (not pop3-read-passwd)
190 (if (functionp 'read-passwd)
191 (setq pop3-read-passwd 'read-passwd)
192 (if (load "passwd" t)
193 (setq pop3-read-passwd 'read-passwd)
194 (autoload 'ange-ftp-read-passwd "ange-ftp")
195 (setq pop3-read-passwd 'ange-ftp-read-passwd))))
196 (funcall pop3-read-passwd prompt))
198 (defun pop3-clean-region (start end)
199 (setq end (set-marker (make-marker) end))
202 (while (and (< (point) end) (search-forward "\r\n" end t))
203 (replace-match "\n" t t))
205 (while (and (< (point) end) (re-search-forward "^\\." end t))
206 (replace-match "" t t)
208 (set-marker end nil))
210 (defun pop3-munge-message-separator (start end)
211 "Check to see if a message separator exists. If not, generate one."
212 (if (not (fboundp 'message-make-date)) (autoload 'message-make-date "message"))
215 (narrow-to-region start end)
216 (goto-char (point-min))
217 (if (not (or (looking-at "From .?") ; Unix mail
218 (looking-at "\001\001\001\001\n") ; MMDF
219 (looking-at "BABYL OPTIONS:") ; Babyl
221 (let ((from (mail-strip-quoted-names (mail-fetch-field "From")))
222 (date (pop3-string-to-list (or (mail-fetch-field "Date")
223 (message-make-date))))
225 ;; sample date formats I have seen
226 ;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT)
227 ;; Date: 08 Jul 1996 23:22:24 -0400
229 ;; Tue Jul 9 09:04:21 1996
231 (cond ((string-match "[A-Z]" (nth 0 date))
232 (format "%s %s %s %s %s"
233 (nth 0 date) (nth 2 date) (nth 1 date)
234 (nth 4 date) (nth 3 date)))
236 ;; this really needs to be better but I don't feel
237 ;; like writing a date to day converter.
238 (format "Sun %s %s %s %s"
239 (nth 1 date) (nth 0 date)
240 (nth 3 date) (nth 2 date)))
242 (setq From_ (format "\nFrom %s %s\n" from date))
243 (while (string-match "," From_)
244 (setq From_ (concat (substring From_ 0 (match-beginning 0))
245 (substring From_ (match-end 0)))))
246 (goto-char (point-min))
251 ;; AUTHORIZATION STATE
253 (defun pop3-user (process user)
254 "Send USER information to POP3 server."
255 (pop3-send-command process (format "USER %s" user))
256 (let ((response (pop3-read-response process t)))
257 (if (not (and response (string-match "+OK" response)))
258 (error (format "USER %s not valid." user)))))
260 (defun pop3-pass (process)
261 "Send authentication information to the server."
262 (pop3-send-command process (format "PASS %s" pop3-password))
263 (let ((response (pop3-read-response process t)))
264 (if (not (and response (string-match "+OK" response)))
265 (pop3-quit process))))
267 (defun pop3-apop (process user)
268 "Send alternate authentication information to the server."
269 (if (not (fboundp 'md5)) (autoload 'md5 "md5"))
270 (let ((hash (md5 (concat pop3-timestamp pop3-password))))
271 (pop3-send-command process (format "APOP %s %s" user hash))
272 (let ((response (pop3-read-response process t)))
273 (if (not (and response (string-match "+OK" response)))
274 (pop3-quit process)))))
278 (defun pop3-stat (process)
279 "Return the number of messages in the maildrop and the maildrop's size."
280 (pop3-send-command process "STAT")
281 (let ((response (pop3-read-response process t)))
282 (list (string-to-int (nth 1 (pop3-string-to-list response)))
283 (string-to-int (nth 2 (pop3-string-to-list response))))
286 (defun pop3-list (process &optional msg)
287 "Scan listing of available messages.
288 This function currently does nothing.")
290 (defun pop3-retr (process msg crashbuf)
291 "Retrieve message-id MSG to buffer CRASHBUF."
292 (pop3-send-command process (format "RETR %s" msg))
293 (pop3-read-response process)
294 (let ((start pop3-read-point) end)
296 (set-buffer (process-buffer process))
297 (while (not (re-search-forward "^\\.\r\n" nil t))
298 (accept-process-output process 3)
299 ;; bill@att.com ... to save wear and tear on the heap
300 ;; uncommented because the condensed version below is a problem for
302 (if (> (buffer-size) 20000) (sleep-for 1))
303 (if (> (buffer-size) 50000) (sleep-for 1))
304 (if (> (buffer-size) 100000) (sleep-for 1))
305 (if (> (buffer-size) 200000) (sleep-for 1))
306 (if (> (buffer-size) 500000) (sleep-for 1))
309 ;; (sometimes causes problems for really large messages.)
310 ; (if (> (buffer-size) 20000) (sleep-for (/ (buffer-size) 20000)))
312 (setq pop3-read-point (point-marker))
313 ;; this code does not seem to work for some POP servers...
314 ;; and I cannot figure out why not.
315 ; (goto-char (match-beginning 0))
317 ; (if (not (looking-at "\r\n"))
319 ; (re-search-forward "\\.\r\n")
320 (goto-char (match-beginning 0))
321 (setq end (point-marker))
322 (pop3-clean-region start end)
323 (pop3-munge-message-separator start end)
325 (set-buffer crashbuf)
327 (copy-to-buffer crashbuf start end)
328 (delete-region start end)
331 (defun pop3-dele (process msg)
332 "Mark message-id MSG as deleted."
333 (pop3-send-command process (format "DELE %s" msg))
334 (pop3-read-response process))
336 (defun pop3-noop (process msg)
338 (pop3-send-command process "NOOP")
339 (pop3-read-response process))
341 (defun pop3-last (process)
342 "Return highest accessed message-id number for the session."
343 (pop3-send-command process "LAST")
344 (let ((response (pop3-read-response process t)))
345 (string-to-int (nth 1 (pop3-string-to-list response)))
348 (defun pop3-rset (process)
349 "Remove all delete marks from current maildrop."
350 (pop3-send-command process "RSET")
351 (pop3-read-response process))
355 (defun pop3-quit (process)
356 "Close connection to POP3 server.
357 Tell server to remove all messages marked as deleted, unlock the maildrop,
358 and close the connection."
359 (pop3-send-command process "QUIT")
360 (pop3-read-response process t)
363 (set-buffer (process-buffer process))
364 (goto-char (point-max))
365 (delete-process process))))
367 ;; Summary of POP3 (Post Office Protocol version 3) commands and responses
369 ;;; AUTHORIZATION STATE
371 ;; Initial TCP connection
373 ;; Restrictions: none
374 ;; Possible responses:
375 ;; +OK [POP3 server ready]
378 ;; Arguments: a server specific user-id (required)
379 ;; Restrictions: authorization state [after unsuccessful USER or PASS
380 ;; Possible responses:
381 ;; +OK [valid user-id]
382 ;; -ERR [invalid user-id]
385 ;; Arguments: a server/user-id specific password (required)
386 ;; Restrictions: authorization state, after successful USER
387 ;; Possible responses:
388 ;; +OK [maildrop locked and ready]
389 ;; -ERR [invalid password]
390 ;; -ERR [unable to lock maildrop]
392 ;;; TRANSACTION STATE
396 ;; Restrictions: transaction state
397 ;; Possible responses:
398 ;; +OK nn mm [# of messages, size of maildrop]
401 ;; Arguments: a message-id (optional)
402 ;; Restrictions: transaction state; msg must not be deleted
403 ;; Possible responses:
404 ;; +OK [scan listing follows]
405 ;; -ERR [no such message]
408 ;; Arguments: a message-id (required)
409 ;; Restrictions: transaction state; msg must not be deleted
410 ;; Possible responses:
411 ;; +OK [message contents follow]
412 ;; -ERR [no such message]
415 ;; Arguments: a message-id (required)
416 ;; Restrictions: transaction state; msg must not be deleted
417 ;; Possible responses:
418 ;; +OK [message deleted]
419 ;; -ERR [no such message]
423 ;; Restrictions: transaction state
424 ;; Possible responses:
429 ;; Restrictions: transaction state
430 ;; Possible responses:
431 ;; +OK nn [highest numbered message accessed]
435 ;; Restrictions: transaction state
436 ;; Possible responses:
437 ;; +OK [all delete marks removed]
443 ;; Restrictions: none
444 ;; Possible responses:
445 ;; +OK [TCP connection closed]