1 ;;; pop3.el --- Post Office Protocol (RFC 1460) interface
3 ;; Copyright (C) 1996,1997 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.3h")
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-movemail-file-coding-system nil
64 "Crashbox made by pop3-movemail with this coding system.")
66 (defvar pop3-read-point nil)
67 (defvar pop3-debug nil)
69 (defun pop3-movemail (&optional crashbox)
70 "Transfer contents of a maildrop to the specified CRASHBOX."
71 (or crashbox (setq crashbox (expand-file-name "~/.crashbox")))
72 (let* ((process (pop3-open-server pop3-mailhost pop3-port))
73 (crashbuf (get-buffer-create " *pop3-retr*"))
76 (pop3-password pop3-password)
79 (if pop3-debug (switch-to-buffer (process-buffer process)))
81 (if (and pop3-password-required (not pop3-password))
83 (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
84 (cond ((equal 'apop pop3-authentication-scheme)
85 (pop3-apop process pop3-maildrop))
86 ((equal 'pass pop3-authentication-scheme)
87 (pop3-user process pop3-maildrop)
89 (t (error "Invalid POP3 authentication scheme.")))
90 (setq message-count (car (pop3-stat process)))
91 (while (<= n message-count)
92 (message (format "Retrieving message %d of %d from %s..."
93 n message-count pop3-mailhost))
94 (pop3-retr process n crashbuf)
97 (let ((coding-system-for-write pop3-movemail-file-coding-system))
98 (append-to-file (point-min) (point-max) crashbox))
99 (set-buffer (process-buffer process))
100 (while (> (buffer-size) 5000)
101 (goto-char (point-min))
103 (delete-region (point-min) (point))))
104 (pop3-dele process n)
106 (if pop3-debug (sit-for 1) (sit-for 0.1))
109 (kill-buffer crashbuf)
113 (defun pop3-open-server (mailhost port)
114 "Open TCP connection to MAILHOST.
115 Returns the process associated with the connection."
116 (let ((process-buffer
117 (get-buffer-create (format "trace of POP session to %s" mailhost)))
120 (set-buffer process-buffer)
123 (open-network-stream "POP" process-buffer mailhost port))
124 (setq pop3-read-point (point-min))
125 (let ((response (pop3-read-response process t)))
127 (substring response (or (string-match "<" response) 0)
128 (+ 1 (or (string-match ">" response) -1)))))
134 (defun pop3-process-filter (process output)
136 (set-buffer (process-buffer process))
137 (goto-char (point-max))
140 (defun pop3-send-command (process command)
141 (set-buffer (process-buffer process))
142 (goto-char (point-max))
143 ;; (if (= (aref command 0) ?P)
144 ;; (insert "PASS <omitted>\r\n")
145 ;; (insert command "\r\n"))
146 (setq pop3-read-point (point))
147 (goto-char (point-max))
148 (process-send-string process command)
149 (process-send-string process "\r\n")
152 (defun pop3-read-response (process &optional return)
153 "Read the response from the server.
154 Return the response string if optional second argument is non-nil."
155 (let ((case-fold-search nil)
158 (set-buffer (process-buffer process))
159 (goto-char pop3-read-point)
160 (while (not (search-forward "\r\n" nil t))
161 (accept-process-output process 3)
162 (goto-char pop3-read-point))
163 (setq match-end (point))
164 (goto-char pop3-read-point)
165 (if (looking-at "-ERR")
166 (error (buffer-substring (point) (- match-end 2)))
167 (if (not (looking-at "+OK"))
168 (progn (setq pop3-read-point match-end) nil)
169 (setq pop3-read-point match-end)
171 (buffer-substring (point) match-end)
175 (defun pop3-string-to-list (string &optional regexp)
176 "Chop up a string into a list."
178 (regexp (or regexp " "))
179 (string (if (string-match "\r" string)
180 (substring string 0 (match-beginning 0))
182 (store-match-data nil)
184 (if (string-match regexp string)
185 (setq list (cons (substring string 0 (- (match-end 0) 1)) list)
186 string (substring string (match-end 0)))
187 (setq list (cons string list)
191 (defvar pop3-read-passwd nil)
192 (defun pop3-read-passwd (prompt)
193 (if (not pop3-read-passwd)
194 (if (load "passwd" t)
195 (setq pop3-read-passwd 'read-passwd)
196 (autoload 'ange-ftp-read-passwd "ange-ftp")
197 (setq pop3-read-passwd 'ange-ftp-read-passwd)))
198 (funcall pop3-read-passwd prompt))
200 (defun pop3-clean-region (start end)
201 (setq end (set-marker (make-marker) end))
204 (while (and (< (point) end) (search-forward "\r\n" end t))
205 (replace-match "\n" t t))
207 (while (and (< (point) end) (re-search-forward "^\\." end t))
208 (replace-match "" t t)
210 (set-marker end nil))
212 (defun pop3-munge-message-separator (start end)
213 "Check to see if a message separator exists. If not, generate one."
214 (if (not (fboundp 'message-make-date)) (autoload 'message-make-date "message"))
217 (narrow-to-region start end)
218 (goto-char (point-min))
219 (if (not (or (looking-at "From .?") ; Unix mail
220 (looking-at "\001\001\001\001\n") ; MMDF
221 (looking-at "BABYL OPTIONS:") ; Babyl
223 (let ((from (mail-strip-quoted-names (mail-fetch-field "From")))
224 (date (pop3-string-to-list (or (mail-fetch-field "Date")
225 (message-make-date))))
227 ;; sample date formats I have seen
228 ;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT)
229 ;; Date: 08 Jul 1996 23:22:24 -0400
231 ;; Tue Jul 9 09:04:21 1996
233 (cond ((string-match "[A-Z]" (nth 0 date))
234 (format "%s %s %s %s %s"
235 (nth 0 date) (nth 2 date) (nth 1 date)
236 (nth 4 date) (nth 3 date)))
238 ;; this really needs to be better but I don't feel
239 ;; like writing a date to day converter.
240 (format "Sun %s %s %s %s"
241 (nth 1 date) (nth 0 date)
242 (nth 3 date) (nth 2 date)))
244 (setq From_ (format "\nFrom %s %s\n" from date))
245 (while (string-match "," From_)
246 (setq From_ (concat (substring From_ 0 (match-beginning 0))
247 (substring From_ (match-end 0)))))
248 (goto-char (point-min))
253 ;; AUTHORIZATION STATE
255 (defun pop3-user (process user)
256 "Send USER information to POP3 server."
257 (pop3-send-command process (format "USER %s" user))
258 (let ((response (pop3-read-response process t)))
259 (if (not (and response (string-match "+OK" response)))
260 (error (format "USER %s not valid." user)))))
262 (defun pop3-pass (process)
263 "Send authentication information to the server."
264 (pop3-send-command process (format "PASS %s" pop3-password))
265 (let ((response (pop3-read-response process t)))
266 (if (not (and response (string-match "+OK" response)))
267 (pop3-quit process))))
269 (defun pop3-apop (process user)
270 "Send alternate authentication information to the server."
271 (if (not (fboundp 'md5)) (autoload 'md5 "md5"))
272 (let ((hash (md5 (concat pop3-timestamp pop3-password))))
273 (pop3-send-command process (format "APOP %s %s" user hash))
274 (let ((response (pop3-read-response process t)))
275 (if (not (and response (string-match "+OK" response)))
276 (pop3-quit process)))))
280 (defun pop3-stat (process)
281 "Return the number of messages in the maildrop and the maildrop's size."
282 (pop3-send-command process "STAT")
283 (let ((response (pop3-read-response process t)))
284 (list (string-to-int (nth 1 (pop3-string-to-list response)))
285 (string-to-int (nth 2 (pop3-string-to-list response))))
288 (defun pop3-list (process &optional msg)
289 "Scan listing of available messages.
290 This function currently does nothing.")
292 (defun pop3-retr (process msg crashbuf)
293 "Retrieve message-id MSG to buffer CRASHBUF."
294 (pop3-send-command process (format "RETR %s" msg))
295 (pop3-read-response process)
296 (let ((start pop3-read-point) end)
298 (set-buffer (process-buffer process))
299 (while (not (re-search-forward "^\\.\r\n" nil t))
300 (accept-process-output process 3)
301 ;; bill@att.com ... to save wear and tear on the heap
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 (setq pop3-read-point (point-marker))
310 ;; this code does not seem to work for some POP servers...
311 ;; and I cannot figure out why not.
312 ; (goto-char (match-beginning 0))
314 ; (if (not (looking-at "\r\n"))
316 ; (re-search-forward "\\.\r\n")
317 (goto-char (match-beginning 0))
318 (setq end (point-marker))
319 (pop3-clean-region start end)
320 (pop3-munge-message-separator start end)
322 (set-buffer crashbuf)
324 (copy-to-buffer crashbuf start end)
325 (delete-region start end)
328 (defun pop3-dele (process msg)
329 "Mark message-id MSG as deleted."
330 (pop3-send-command process (format "DELE %s" msg))
331 (pop3-read-response process))
333 (defun pop3-noop (process msg)
335 (pop3-send-command process "NOOP")
336 (pop3-read-response process))
338 (defun pop3-last (process)
339 "Return highest accessed message-id number for the session."
340 (pop3-send-command process "LAST")
341 (let ((response (pop3-read-response process t)))
342 (string-to-int (nth 1 (pop3-string-to-list response)))
345 (defun pop3-rset (process)
346 "Remove all delete marks from current maildrop."
347 (pop3-send-command process "RSET")
348 (pop3-read-response process))
352 (defun pop3-quit (process)
353 "Close connection to POP3 server.
354 Tell server to remove all messages marked as deleted, unlock the maildrop,
355 and close the connection."
356 (pop3-send-command process "QUIT")
357 (pop3-read-response process t)
360 (set-buffer (process-buffer process))
361 (goto-char (point-max))
362 (delete-process process))))
364 ;; Summary of POP3 (Post Office Protocol version 3) commands and responses
366 ;;; AUTHORIZATION STATE
368 ;; Initial TCP connection
370 ;; Restrictions: none
371 ;; Possible responses:
372 ;; +OK [POP3 server ready]
375 ;; Arguments: a server specific user-id (required)
376 ;; Restrictions: authorization state [after unsuccessful USER or PASS
377 ;; Possible responses:
378 ;; +OK [valid user-id]
379 ;; -ERR [invalid user-id]
382 ;; Arguments: a server/user-id specific password (required)
383 ;; Restrictions: authorization state, after successful USER
384 ;; Possible responses:
385 ;; +OK [maildrop locked and ready]
386 ;; -ERR [invalid password]
387 ;; -ERR [unable to lock maildrop]
389 ;;; TRANSACTION STATE
393 ;; Restrictions: transaction state
394 ;; Possible responses:
395 ;; +OK nn mm [# of messages, size of maildrop]
398 ;; Arguments: a message-id (optional)
399 ;; Restrictions: transaction state; msg must not be deleted
400 ;; Possible responses:
401 ;; +OK [scan listing follows]
402 ;; -ERR [no such message]
405 ;; Arguments: a message-id (required)
406 ;; Restrictions: transaction state; msg must not be deleted
407 ;; Possible responses:
408 ;; +OK [message contents follow]
409 ;; -ERR [no such message]
412 ;; Arguments: a message-id (required)
413 ;; Restrictions: transaction state; msg must not be deleted
414 ;; Possible responses:
415 ;; +OK [message deleted]
416 ;; -ERR [no such message]
420 ;; Restrictions: transaction state
421 ;; Possible responses:
426 ;; Restrictions: transaction state
427 ;; Possible responses:
428 ;; +OK nn [highest numbered message accessed]
432 ;; Restrictions: transaction state
433 ;; Possible responses:
434 ;; +OK [all delete marks removed]
440 ;; Restrictions: none
441 ;; Possible responses:
442 ;; +OK [TCP connection closed]