1 ;;; pop3.el --- Post Office Protocol (RFC 1460) interface
3 ;; Copyright (C) 1996, 96, 97, 98, 1999 Free Software Foundation, Inc.
5 ;; Author: Richard L. Pieri <ratinox@peorth.gweep.net>
10 ;; This file is part of GNU Emacs.
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)
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.
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.
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.
34 ;; This program was inspired by Kyle E. Jones's vm-pop program.
40 (defconst pop3-version
"1.3s")
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 "Coding system for the crashbox made by `pop3-movemail'.")
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
)))
92 (while (<= n message-count
)
93 (message (format "Retrieving message %d of %d from %s..."
94 n message-count pop3-mailhost
))
95 (pop3-retr process n crashbuf
)
98 (let ((coding-system-for-write pop3-movemail-file-coding-system
))
99 (write-region (point-min) (point-max) crashbox t
'nomesg
))
100 (set-buffer (process-buffer process
))
101 (while (> (buffer-size) 5000)
102 (goto-char (point-min))
104 (delete-region (point-min) (point))))
105 (pop3-dele process n
)
107 (if pop3-debug
(sit-for 1) (sit-for 0.1))
110 (kill-buffer crashbuf
)
114 (defun pop3-open-server (mailhost port
)
115 "Open TCP connection to MAILHOST on PORT.
116 Returns the process associated with the connection."
117 (let ((coding-system-for-read 'binary
)
118 (coding-system-for-write 'binary
)
121 (set-buffer (get-buffer-create (concat " trace of POP session to "
124 (setq pop3-read-point
(point-min))
125 (setq process
(open-network-stream "POP"(current-buffer) mailhost port
))
126 (let ((response (pop3-read-response process t
)))
128 (substring response
(or (string-match "<" response
) 0)
129 (+ 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
(concat command
"\r\n"))
151 (defun pop3-read-response (process &optional return
)
152 "Read the response from the server.
153 Return the response string if optional second argument is non-nil."
154 (let ((case-fold-search nil
)
157 (set-buffer (process-buffer process
))
158 (goto-char pop3-read-point
)
159 (while (not (search-forward "\r\n" nil t
))
160 (accept-process-output process
3)
161 (goto-char pop3-read-point
))
162 (setq match-end
(point))
163 (goto-char pop3-read-point
)
164 (if (looking-at "-ERR")
165 (error (buffer-substring (point) (- match-end
2)))
166 (if (not (looking-at "+OK"))
167 (progn (setq pop3-read-point match-end
) nil
)
168 (setq pop3-read-point match-end
)
170 (buffer-substring (point) match-end
)
174 (defvar pop3-read-passwd nil
)
175 (defun pop3-read-passwd (prompt)
176 (if (not pop3-read-passwd
)
177 (if (fboundp 'read-passwd
)
178 (setq pop3-read-passwd
'read-passwd
)
179 (if (load "passwd" t
)
180 (setq pop3-read-passwd
'read-passwd
)
181 (autoload 'ange-ftp-read-passwd
"ange-ftp")
182 (setq pop3-read-passwd
'ange-ftp-read-passwd
))))
183 (funcall pop3-read-passwd prompt
))
185 (defun pop3-clean-region (start end
)
186 (setq end
(set-marker (make-marker) end
))
189 (while (and (< (point) end
) (search-forward "\r\n" end t
))
190 (replace-match "\n" t t
))
192 (while (and (< (point) end
) (re-search-forward "^\\." end t
))
193 (replace-match "" t t
)
195 (set-marker end nil
))
197 (defun pop3-munge-message-separator (start end
)
198 "Check to see if a message separator exists. If not, generate one."
199 (if (not (fboundp 'message-make-date
)) (autoload 'message-make-date
"message"))
202 (narrow-to-region start end
)
203 (goto-char (point-min))
204 (if (not (or (looking-at "From .?") ; Unix mail
205 (looking-at "\001\001\001\001\n") ; MMDF
206 (looking-at "BABYL OPTIONS:") ; Babyl
208 (let ((from (mail-strip-quoted-names (mail-fetch-field "From")))
209 (date (split-string (or (mail-fetch-field "Date")
213 ;; sample date formats I have seen
214 ;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT)
215 ;; Date: 08 Jul 1996 23:22:24 -0400
217 ;; Tue Jul 9 09:04:21 1996
219 (cond ((string-match "[A-Z]" (nth 0 date
))
220 (format "%s %s %s %s %s"
221 (nth 0 date
) (nth 2 date
) (nth 1 date
)
222 (nth 4 date
) (nth 3 date
)))
224 ;; this really needs to be better but I don't feel
225 ;; like writing a date to day converter.
226 (format "Sun %s %s %s %s"
227 (nth 1 date
) (nth 0 date
)
228 (nth 3 date
) (nth 2 date
)))
230 (setq From_
(format "\nFrom %s %s\n" from date
))
231 (while (string-match "," From_
)
232 (setq From_
(concat (substring From_
0 (match-beginning 0))
233 (substring From_
(match-end 0)))))
234 (goto-char (point-min))
236 (re-search-forward "\n\n")
237 (narrow-to-region (point) (point-max))
238 (let ((size (- (point-max) (point-min))))
239 (goto-char (point-min))
242 (insert (format "Content-Length: %s\n" size
)))
247 ;; AUTHORIZATION STATE
249 (defun pop3-user (process user
)
250 "Send USER information to POP3 server."
251 (pop3-send-command process
(format "USER %s" user
))
252 (let ((response (pop3-read-response process t
)))
253 (if (not (and response
(string-match "+OK" response
)))
254 (error (format "USER %s not valid." user
)))))
256 (defun pop3-pass (process)
257 "Send authentication information to the server."
258 (pop3-send-command process
(format "PASS %s" pop3-password
))
259 (let ((response (pop3-read-response process t
)))
260 (if (not (and response
(string-match "+OK" response
)))
261 (pop3-quit process
))))
263 (defun pop3-apop (process user
)
264 "Send alternate authentication information to the server."
265 (let ((pass pop3-password
))
266 (if (and pop3-password-required
(not pass
))
268 (pop3-read-passwd (format "Password for %s: " pop3-maildrop
))))
270 (let ((hash (pop3-md5 (concat pop3-timestamp pass
))))
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
)))))
279 (defvar pop3-md5-program
"md5"
280 "*Program to encode its input in MD5.")
282 (defun pop3-md5 (string)
285 (call-process-region (point-min) (point-max)
286 (or shell-file-name
"/bin/sh")
287 t
(current-buffer) nil
288 "-c" pop3-md5-program
)
289 ;; The meaningful output is the first 32 characters.
290 ;; Don't return the newline that follows them!
291 (buffer-substring (point-min) (+ (point-min) 32))))
293 (defun pop3-stat (process)
294 "Return the number of messages in the maildrop and the maildrop's size."
295 (pop3-send-command process
"STAT")
296 (let ((response (pop3-read-response process t
)))
297 (list (string-to-int (nth 1 (split-string response
" ")))
298 (string-to-int (nth 2 (split-string response
" "))))
301 (defun pop3-list (process &optional msg
)
302 "Scan listing of available messages.
303 This function currently does nothing.")
305 (defun pop3-retr (process msg crashbuf
)
306 "Retrieve message-id MSG to buffer CRASHBUF."
307 (pop3-send-command process
(format "RETR %s" msg
))
308 (pop3-read-response process
)
309 (let ((start pop3-read-point
) end
)
311 (set-buffer (process-buffer process
))
312 (while (not (re-search-forward "^\\.\r\n" nil t
))
313 (accept-process-output process
3)
314 ;; bill@att.com ... to save wear and tear on the heap
315 ;; uncommented because the condensed version below is a problem for
317 (if (> (buffer-size) 20000) (sleep-for 1))
318 (if (> (buffer-size) 50000) (sleep-for 1))
319 (if (> (buffer-size) 100000) (sleep-for 1))
320 (if (> (buffer-size) 200000) (sleep-for 1))
321 (if (> (buffer-size) 500000) (sleep-for 1))
324 ;; (sometimes causes problems for really large messages.)
325 ; (if (> (buffer-size) 20000) (sleep-for (/ (buffer-size) 20000)))
327 (setq pop3-read-point
(point-marker))
328 ;; this code does not seem to work for some POP servers...
329 ;; and I cannot figure out why not.
330 ; (goto-char (match-beginning 0))
332 ; (if (not (looking-at "\r\n"))
334 ; (re-search-forward "\\.\r\n")
335 (goto-char (match-beginning 0))
336 (setq end
(point-marker))
337 (pop3-clean-region start end
)
338 (pop3-munge-message-separator start end
)
340 (set-buffer crashbuf
)
342 (copy-to-buffer crashbuf start end
)
343 (delete-region start end
)
346 (defun pop3-dele (process msg
)
347 "Mark message-id MSG as deleted."
348 (pop3-send-command process
(format "DELE %s" msg
))
349 (pop3-read-response process
))
351 (defun pop3-noop (process msg
)
353 (pop3-send-command process
"NOOP")
354 (pop3-read-response process
))
356 (defun pop3-last (process)
357 "Return highest accessed message-id number for the session."
358 (pop3-send-command process
"LAST")
359 (let ((response (pop3-read-response process t
)))
360 (string-to-int (nth 1 (split-string response
" ")))
363 (defun pop3-rset (process)
364 "Remove all delete marks from current maildrop."
365 (pop3-send-command process
"RSET")
366 (pop3-read-response process
))
370 (defun pop3-quit (process)
371 "Close connection to POP3 server.
372 Tell server to remove all messages marked as deleted, unlock the maildrop,
373 and close the connection."
374 (pop3-send-command process
"QUIT")
375 (pop3-read-response process t
)
378 (set-buffer (process-buffer process
))
379 (goto-char (point-max))
380 (delete-process process
))))
382 ;; Summary of POP3 (Post Office Protocol version 3) commands and responses
384 ;;; AUTHORIZATION STATE
386 ;; Initial TCP connection
388 ;; Restrictions: none
389 ;; Possible responses:
390 ;; +OK [POP3 server ready]
393 ;; Arguments: a server specific user-id (required)
394 ;; Restrictions: authorization state [after unsuccessful USER or PASS
395 ;; Possible responses:
396 ;; +OK [valid user-id]
397 ;; -ERR [invalid user-id]
400 ;; Arguments: a server/user-id specific password (required)
401 ;; Restrictions: authorization state, after successful USER
402 ;; Possible responses:
403 ;; +OK [maildrop locked and ready]
404 ;; -ERR [invalid password]
405 ;; -ERR [unable to lock maildrop]
407 ;;; TRANSACTION STATE
411 ;; Restrictions: transaction state
412 ;; Possible responses:
413 ;; +OK nn mm [# of messages, size of maildrop]
416 ;; Arguments: a message-id (optional)
417 ;; Restrictions: transaction state; msg must not be deleted
418 ;; Possible responses:
419 ;; +OK [scan listing follows]
420 ;; -ERR [no such message]
423 ;; Arguments: a message-id (required)
424 ;; Restrictions: transaction state; msg must not be deleted
425 ;; Possible responses:
426 ;; +OK [message contents follow]
427 ;; -ERR [no such message]
430 ;; Arguments: a message-id (required)
431 ;; Restrictions: transaction state; msg must not be deleted
432 ;; Possible responses:
433 ;; +OK [message deleted]
434 ;; -ERR [no such message]
438 ;; Restrictions: transaction state
439 ;; Possible responses:
444 ;; Restrictions: transaction state
445 ;; Possible responses:
446 ;; +OK nn [highest numbered message accessed]
450 ;; Restrictions: transaction state
451 ;; Possible responses:
452 ;; +OK [all delete marks removed]
458 ;; Restrictions: none
459 ;; Possible responses:
460 ;; +OK [TCP connection closed]
464 ;;; pop3.el ends here