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 (error (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 (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))
182 (defun pop3-clean-region (start end)
183 (setq end (set-marker (make-marker) end))
186 (while (and (< (point) end) (search-forward "\r\n" end t))
187 (replace-match "\n" t t))
189 (while (and (< (point) end) (re-search-forward "^\\." end t))
190 (replace-match "" t t)
192 (set-marker end nil))
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 'message-make-date)) (autoload 'message-make-date "message"))
199 (narrow-to-region start end)
200 (goto-char (point-min))
201 (if (not (or (looking-at "From .?") ; Unix mail
202 (looking-at "\001\001\001\001\n") ; MMDF
203 (looking-at "BABYL OPTIONS:") ; Babyl
205 (let ((from (mail-strip-quoted-names (mail-fetch-field "From")))
206 (date (split-string (or (mail-fetch-field "Date")
207 (message-make-date))))
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
213 ;; Tue Jul 9 09:04:21 1996
215 (cond ((string-match "[A-Z]" (nth 0 date))
216 (format "%s %s %s %s %s"
217 (nth 0 date) (nth 2 date) (nth 1 date)
218 (nth 4 date) (nth 3 date)))
220 ;; this really needs to be better but I don't feel
221 ;; like writing a date to day converter.
222 (format "Sun %s %s %s %s"
223 (nth 1 date) (nth 0 date)
224 (nth 3 date) (nth 2 date)))
226 (setq From_ (format "\nFrom %s %s\n" from date))
227 (while (string-match "," From_)
228 (setq From_ (concat (substring From_ 0 (match-beginning 0))
229 (substring From_ (match-end 0)))))
230 (goto-char (point-min))
235 ;; AUTHORIZATION STATE
237 (defun pop3-user (process user)
238 "Send USER information to POP3 server."
239 (pop3-send-command process (format "USER %s" user))
240 (let ((response (pop3-read-response process t)))
241 (if (not (and response (string-match "+OK" response)))
242 (error (format "USER %s not valid." user)))))
244 (defun pop3-pass (process)
245 "Send authentication information to the server."
246 (pop3-send-command process (format "PASS %s" pop3-password))
247 (let ((response (pop3-read-response process t)))
248 (if (not (and response (string-match "+OK" response)))
249 (pop3-quit process))))
251 (defun pop3-apop (process user)
252 "Send alternate authentication information to the server."
253 (if (not (fboundp 'md5)) (autoload 'md5 "md5"))
254 (let ((hash (md5 (concat pop3-timestamp pop3-password))))
255 (pop3-send-command process (format "APOP %s %s" user hash))
256 (let ((response (pop3-read-response process t)))
257 (if (not (and response (string-match "+OK" response)))
258 (pop3-quit process)))))
262 (defun pop3-stat (process)
263 "Return the number of messages in the maildrop and the maildrop's size."
264 (pop3-send-command process "STAT")
265 (let ((response (pop3-read-response process t)))
266 (list (string-to-int (nth 1 (split-string response)))
267 (string-to-int (nth 2 (split-string response))))
270 (defun pop3-list (process &optional msg)
271 "Scan listing of available messages.
272 This function currently does nothing.")
274 (defun pop3-retr (process msg crashbuf)
275 "Retrieve message-id MSG to buffer CRASHBUF."
276 (pop3-send-command process (format "RETR %s" msg))
277 (pop3-read-response process)
278 (let ((start pop3-read-point) end)
280 (set-buffer (process-buffer process))
281 (while (not (re-search-forward "^\\.\r\n" nil t))
282 (accept-process-output process 3)
283 ;; bill@att.com ... to save wear and tear on the heap
284 ;; uncommented because the condensed version below is a problem for
286 (if (> (buffer-size) 20000) (sleep-for 1))
287 (if (> (buffer-size) 50000) (sleep-for 1))
288 (if (> (buffer-size) 100000) (sleep-for 1))
289 (if (> (buffer-size) 200000) (sleep-for 1))
290 (if (> (buffer-size) 500000) (sleep-for 1))
293 ;; (sometimes causes problems for really large messages.)
294 ; (if (> (buffer-size) 20000) (sleep-for (/ (buffer-size) 20000)))
296 (setq pop3-read-point (point-marker))
297 ;; this code does not seem to work for some POP servers...
298 ;; and I cannot figure out why not.
299 ; (goto-char (match-beginning 0))
301 ; (if (not (looking-at "\r\n"))
303 ; (re-search-forward "\\.\r\n")
304 (goto-char (match-beginning 0))
305 (setq end (point-marker))
306 (pop3-clean-region start end)
307 (pop3-munge-message-separator start end)
309 (set-buffer crashbuf)
311 (copy-to-buffer crashbuf start end)
312 (delete-region start end)
315 (defun pop3-dele (process msg)
316 "Mark message-id MSG as deleted."
317 (pop3-send-command process (format "DELE %s" msg))
318 (pop3-read-response process))
320 (defun pop3-noop (process msg)
322 (pop3-send-command process "NOOP")
323 (pop3-read-response process))
325 (defun pop3-last (process)
326 "Return highest accessed message-id number for the session."
327 (pop3-send-command process "LAST")
328 (let ((response (pop3-read-response process t)))
329 (string-to-int (nth 1 (split-string response)))
332 (defun pop3-rset (process)
333 "Remove all delete marks from current maildrop."
334 (pop3-send-command process "RSET")
335 (pop3-read-response process))
339 (defun pop3-quit (process)
340 "Close connection to POP3 server.
341 Tell server to remove all messages marked as deleted, unlock the maildrop,
342 and close the connection."
343 (pop3-send-command process "QUIT")
344 (pop3-read-response process t)
347 (set-buffer (process-buffer process))
348 (goto-char (point-max))
349 (delete-process process))))
351 ;; Summary of POP3 (Post Office Protocol version 3) commands and responses
353 ;;; AUTHORIZATION STATE
355 ;; Initial TCP connection
357 ;; Restrictions: none
358 ;; Possible responses:
359 ;; +OK [POP3 server ready]
362 ;; Arguments: a server specific user-id (required)
363 ;; Restrictions: authorization state [after unsuccessful USER or PASS
364 ;; Possible responses:
365 ;; +OK [valid user-id]
366 ;; -ERR [invalid user-id]
369 ;; Arguments: a server/user-id specific password (required)
370 ;; Restrictions: authorization state, after successful USER
371 ;; Possible responses:
372 ;; +OK [maildrop locked and ready]
373 ;; -ERR [invalid password]
374 ;; -ERR [unable to lock maildrop]
376 ;;; TRANSACTION STATE
380 ;; Restrictions: transaction state
381 ;; Possible responses:
382 ;; +OK nn mm [# of messages, size of maildrop]
385 ;; Arguments: a message-id (optional)
386 ;; Restrictions: transaction state; msg must not be deleted
387 ;; Possible responses:
388 ;; +OK [scan listing follows]
389 ;; -ERR [no such message]
392 ;; Arguments: a message-id (required)
393 ;; Restrictions: transaction state; msg must not be deleted
394 ;; Possible responses:
395 ;; +OK [message contents follow]
396 ;; -ERR [no such message]
399 ;; Arguments: a message-id (required)
400 ;; Restrictions: transaction state; msg must not be deleted
401 ;; Possible responses:
402 ;; +OK [message deleted]
403 ;; -ERR [no such message]
407 ;; Restrictions: transaction state
408 ;; Possible responses:
413 ;; Restrictions: transaction state
414 ;; Possible responses:
415 ;; +OK nn [highest numbered message accessed]
419 ;; Restrictions: transaction state
420 ;; Possible responses:
421 ;; +OK [all delete marks removed]
427 ;; Restrictions: none
428 ;; Possible responses:
429 ;; +OK [TCP connection closed]