1 ;;; pop3.el --- Post Office Protocol (RFC 1460) interface
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002
4 ;; Free Software Foundation, Inc.
6 ;; 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 (defvar pop3-maildrop
(or (user-login-name) (getenv "LOGNAME") (getenv "USER") nil
)
42 (defvar pop3-mailhost
(or (getenv "MAILHOST") nil
)
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.")
52 (defvar pop3-authentication-scheme
'pass
53 "*POP3 authentication scheme.
54 Defaults to 'pass, for the standard USER/PASS authentication. Other valid
57 (defvar pop3-leave-mail-on-server nil
58 "*Non-nil if the mail is to be left on the POP server after fetching.")
60 (defvar pop3-timestamp nil
61 "Timestamp returned when initially connected to the POP server.
62 Used for APOP authentication.")
64 (defvar pop3-read-point nil
)
65 (defvar pop3-debug nil
)
67 (defun pop3-movemail (&optional crashbox
)
68 "Transfer contents of a maildrop to the specified CRASHBOX."
69 (or crashbox
(setq crashbox
(expand-file-name "~/.crashbox")))
70 (let* ((process (pop3-open-server pop3-mailhost pop3-port
))
71 (crashbuf (get-buffer-create " *pop3-retr*"))
74 (pop3-password pop3-password
)
77 (if pop3-debug
(switch-to-buffer (process-buffer process
)))
79 (if (and pop3-password-required
(not pop3-password
))
81 (pop3-read-passwd (format "Password for %s: " pop3-maildrop
))))
82 (cond ((equal 'apop pop3-authentication-scheme
)
83 (pop3-apop process pop3-maildrop
))
84 ((equal 'pass pop3-authentication-scheme
)
85 (pop3-user process pop3-maildrop
)
87 (t (error "Invalid POP3 authentication scheme")))
88 (setq message-count
(car (pop3-stat process
)))
90 (while (<= n message-count
)
91 (message (format "Retrieving message %d of %d from %s..."
92 n message-count pop3-mailhost
))
93 (pop3-retr process n crashbuf
)
96 (let ((coding-system-for-write 'binary
))
97 (write-region (point-min) (point-max) crashbox t
'nomesg
))
98 (set-buffer (process-buffer process
))
99 (while (> (buffer-size) 5000)
100 (goto-char (point-min))
102 (delete-region (point-min) (point))))
103 (unless pop3-leave-mail-on-server
104 (pop3-dele process n
))
106 (if pop3-debug
(sit-for 1) (sit-for 0.1))
109 (kill-buffer crashbuf
)
113 (defun pop3-get-message-count ()
114 "Return the number of messages in the maildrop."
115 (let* ((process (pop3-open-server pop3-mailhost pop3-port
))
117 (pop3-password pop3-password
)
119 ;; for debugging only
120 (if pop3-debug
(switch-to-buffer (process-buffer process
)))
121 ;; query for password
122 (if (and pop3-password-required
(not pop3-password
))
124 (pop3-read-passwd (format "Password for %s: " pop3-maildrop
))))
125 (cond ((equal 'apop pop3-authentication-scheme
)
126 (pop3-apop process pop3-maildrop
))
127 ((equal 'pass pop3-authentication-scheme
)
128 (pop3-user process pop3-maildrop
)
130 (t (error "Invalid POP3 authentication scheme")))
131 (setq message-count
(car (pop3-stat process
)))
135 (defun pop3-open-server (mailhost port
)
136 "Open TCP connection to MAILHOST on PORT.
137 Returns the process associated with the connection."
138 (let ((coding-system-for-read 'binary
)
139 (coding-system-for-write 'binary
)
142 (set-buffer (get-buffer-create (concat " trace of POP session to "
145 (setq pop3-read-point
(point-min))
146 (setq process
(open-network-stream "POP" (current-buffer) mailhost port
))
147 (let ((response (pop3-read-response process t
)))
149 (substring response
(or (string-match "<" response
) 0)
150 (+ 1 (or (string-match ">" response
) -
1)))))
155 (defun pop3-process-filter (process output
)
157 (set-buffer (process-buffer process
))
158 (goto-char (point-max))
161 (defun pop3-send-command (process command
)
162 (set-buffer (process-buffer process
))
163 (goto-char (point-max))
164 ;; (if (= (aref command 0) ?P)
165 ;; (insert "PASS <omitted>\r\n")
166 ;; (insert command "\r\n"))
167 (setq pop3-read-point
(point))
168 (goto-char (point-max))
169 (process-send-string process
(concat command
"\r\n"))
172 (defun pop3-read-response (process &optional return
)
173 "Read the response from the server.
174 Return the response string if optional second argument is non-nil."
175 (let ((case-fold-search nil
)
178 (set-buffer (process-buffer process
))
179 (goto-char pop3-read-point
)
180 (while (not (search-forward "\r\n" nil t
))
181 (accept-process-output process
3)
182 (goto-char pop3-read-point
))
183 (setq match-end
(point))
184 (goto-char pop3-read-point
)
185 (if (looking-at "-ERR")
186 (error (buffer-substring (point) (- match-end
2)))
187 (if (not (looking-at "+OK"))
188 (progn (setq pop3-read-point match-end
) nil
)
189 (setq pop3-read-point match-end
)
191 (buffer-substring (point) match-end
)
195 (defvar pop3-read-passwd nil
)
196 (defun pop3-read-passwd (prompt)
197 (if (not pop3-read-passwd
)
198 (if (fboundp 'read-passwd
)
199 (setq pop3-read-passwd
'read-passwd
)
200 (if (load "passwd" t
)
201 (setq pop3-read-passwd
'read-passwd
)
202 (autoload 'ange-ftp-read-passwd
"ange-ftp")
203 (setq pop3-read-passwd
'ange-ftp-read-passwd
))))
204 (funcall pop3-read-passwd prompt
))
206 (defun pop3-clean-region (start end
)
207 (setq end
(set-marker (make-marker) end
))
210 (while (and (< (point) end
) (search-forward "\r\n" end t
))
211 (replace-match "\n" t t
))
213 (while (and (< (point) end
) (re-search-forward "^\\." end t
))
214 (replace-match "" t t
)
216 (set-marker end nil
))
218 (eval-when-compile (defvar parse-time-months
))
220 ;; Copied from message-make-date.
221 (defun pop3-make-date (&optional now
)
222 "Make a valid date header.
223 If NOW, use that time instead."
224 (require 'parse-time
)
225 (let* ((now (or now
(current-time)))
226 (zone (nth 8 (decode-time now
)))
230 (setq zone
(- zone
)))
232 (format-time-string "%d" now
)
233 ;; The month name of the %b spec is locale-specific. Pfff.
235 (capitalize (car (rassoc (nth 4 (decode-time now
))
236 parse-time-months
))))
237 (format-time-string "%Y %H:%M:%S " now
)
238 ;; We do all of this because XEmacs doesn't have the %z spec.
239 (format "%s%02d%02d" sign
(/ zone
3600) (/ (% zone
3600) 60)))))
241 (defun pop3-munge-message-separator (start end
)
242 "Check to see if a message separator exists. If not, generate one."
245 (narrow-to-region start end
)
246 (goto-char (point-min))
247 (if (not (or (looking-at "From .?") ; Unix mail
248 (looking-at "\001\001\001\001\n") ; MMDF
249 (looking-at "BABYL OPTIONS:") ; Babyl
251 (let* ((from (mail-strip-quoted-names (mail-fetch-field "From")))
252 (tdate (mail-fetch-field "Date"))
253 (date (split-string (or (and tdate
254 (not (string= "" tdate
))
259 ;; sample date formats I have seen
260 ;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT)
261 ;; Date: 08 Jul 1996 23:22:24 -0400
263 ;; Tue Jul 9 09:04:21 1996
266 "Tue Jan 1 00:00:0 1900")
267 ((string-match "[A-Z]" (nth 0 date
))
268 (format "%s %s %s %s %s"
269 (nth 0 date
) (nth 2 date
) (nth 1 date
)
270 (nth 4 date
) (nth 3 date
)))
272 ;; this really needs to be better but I don't feel
273 ;; like writing a date to day converter.
274 (format "Sun %s %s %s %s"
275 (nth 1 date
) (nth 0 date
)
276 (nth 3 date
) (nth 2 date
)))
278 (setq From_
(format "\nFrom %s %s\n" from date
))
279 (while (string-match "," From_
)
280 (setq From_
(concat (substring From_
0 (match-beginning 0))
281 (substring From_
(match-end 0)))))
282 (goto-char (point-min))
284 (if (search-forward "\n\n" nil t
)
286 (goto-char (point-max))
288 (narrow-to-region (point) (point-max))
289 (let ((size (- (point-max) (point-min))))
290 (goto-char (point-min))
293 (insert (format "Content-Length: %s\n" size
)))
298 ;; AUTHORIZATION STATE
300 (defun pop3-user (process user
)
301 "Send USER information to POP3 server."
302 (pop3-send-command process
(format "USER %s" user
))
303 (let ((response (pop3-read-response process t
)))
304 (if (not (and response
(string-match "+OK" response
)))
305 (error (format "USER %s not valid" user
)))))
307 (defun pop3-pass (process)
308 "Send authentication information to the server."
309 (pop3-send-command process
(format "PASS %s" pop3-password
))
310 (let ((response (pop3-read-response process t
)))
311 (if (not (and response
(string-match "+OK" response
)))
312 (pop3-quit process
))))
314 (defun pop3-apop (process user
)
315 "Send alternate authentication information to the server."
316 (let ((pass pop3-password
))
317 (if (and pop3-password-required
(not pass
))
319 (pop3-read-passwd (format "Password for %s: " pop3-maildrop
))))
321 (let ((hash (pop3-md5 (concat pop3-timestamp pass
))))
322 (pop3-send-command process
(format "APOP %s %s" user hash
))
323 (let ((response (pop3-read-response process t
)))
324 (if (not (and response
(string-match "+OK" response
)))
325 (pop3-quit process
)))))
332 (defalias 'pop3-md5
'md5
)
333 (defvar pop3-md5-program
"md5"
334 "*Program to encode its input in MD5.")
336 (defun pop3-md5 (string)
339 (call-process-region (point-min) (point-max)
341 t
(current-buffer) nil
)
342 ;; The meaningful output is the first 32 characters.
343 ;; Don't return the newline that follows them!
344 (buffer-substring (point-min) (+ 32 (point-min)))))))
346 (defun pop3-stat (process)
347 "Return the number of messages in the maildrop and the maildrop's size."
348 (pop3-send-command process
"STAT")
349 (let ((response (pop3-read-response process t
)))
350 (list (string-to-int (nth 1 (split-string response
" ")))
351 (string-to-int (nth 2 (split-string response
" "))))
354 (defun pop3-list (process &optional msg
)
355 "Scan listing of available messages.
356 This function currently does nothing.")
358 (defun pop3-retr (process msg crashbuf
)
359 "Retrieve message-id MSG to buffer CRASHBUF."
360 (pop3-send-command process
(format "RETR %s" msg
))
361 (pop3-read-response process
)
362 (let ((start pop3-read-point
) end
)
364 (set-buffer (process-buffer process
))
365 (while (not (re-search-forward "^\\.\r\n" nil t
))
366 (accept-process-output process
3)
367 ;; bill@att.com ... to save wear and tear on the heap
368 ;; uncommented because the condensed version below is a problem for
370 (if (> (buffer-size) 20000) (sleep-for 1))
371 (if (> (buffer-size) 50000) (sleep-for 1))
372 (if (> (buffer-size) 100000) (sleep-for 1))
373 (if (> (buffer-size) 200000) (sleep-for 1))
374 (if (> (buffer-size) 500000) (sleep-for 1))
377 ;; (sometimes causes problems for really large messages.)
378 ; (if (> (buffer-size) 20000) (sleep-for (/ (buffer-size) 20000)))
380 (setq pop3-read-point
(point-marker))
381 ;; this code does not seem to work for some POP servers...
382 ;; and I cannot figure out why not.
383 ; (goto-char (match-beginning 0))
385 ; (if (not (looking-at "\r\n"))
387 ; (re-search-forward "\\.\r\n")
388 (goto-char (match-beginning 0))
389 (setq end
(point-marker))
390 (pop3-clean-region start end
)
391 (pop3-munge-message-separator start end
)
393 (set-buffer crashbuf
)
395 (copy-to-buffer crashbuf start end
)
396 (delete-region start end
)
399 (defun pop3-dele (process msg
)
400 "Mark message-id MSG as deleted."
401 (pop3-send-command process
(format "DELE %s" msg
))
402 (pop3-read-response process
))
404 (defun pop3-noop (process msg
)
406 (pop3-send-command process
"NOOP")
407 (pop3-read-response process
))
409 (defun pop3-last (process)
410 "Return highest accessed message-id number for the session."
411 (pop3-send-command process
"LAST")
412 (let ((response (pop3-read-response process t
)))
413 (string-to-int (nth 1 (split-string response
" ")))
416 (defun pop3-rset (process)
417 "Remove all delete marks from current maildrop."
418 (pop3-send-command process
"RSET")
419 (pop3-read-response process
))
423 (defun pop3-quit (process)
424 "Close connection to POP3 server.
425 Tell server to remove all messages marked as deleted, unlock the maildrop,
426 and close the connection."
427 (pop3-send-command process
"QUIT")
428 (pop3-read-response process t
)
431 (set-buffer (process-buffer process
))
432 (goto-char (point-max))
433 (delete-process process
))))
435 ;; Summary of POP3 (Post Office Protocol version 3) commands and responses
437 ;;; AUTHORIZATION STATE
439 ;; Initial TCP connection
441 ;; Restrictions: none
442 ;; Possible responses:
443 ;; +OK [POP3 server ready]
446 ;; Arguments: a server specific user-id (required)
447 ;; Restrictions: authorization state [after unsuccessful USER or PASS
448 ;; Possible responses:
449 ;; +OK [valid user-id]
450 ;; -ERR [invalid user-id]
453 ;; Arguments: a server/user-id specific password (required)
454 ;; Restrictions: authorization state, after successful USER
455 ;; Possible responses:
456 ;; +OK [maildrop locked and ready]
457 ;; -ERR [invalid password]
458 ;; -ERR [unable to lock maildrop]
460 ;;; TRANSACTION STATE
464 ;; Restrictions: transaction state
465 ;; Possible responses:
466 ;; +OK nn mm [# of messages, size of maildrop]
469 ;; Arguments: a message-id (optional)
470 ;; Restrictions: transaction state; msg must not be deleted
471 ;; Possible responses:
472 ;; +OK [scan listing follows]
473 ;; -ERR [no such message]
476 ;; Arguments: a message-id (required)
477 ;; Restrictions: transaction state; msg must not be deleted
478 ;; Possible responses:
479 ;; +OK [message contents follow]
480 ;; -ERR [no such message]
483 ;; Arguments: a message-id (required)
484 ;; Restrictions: transaction state; msg must not be deleted
485 ;; Possible responses:
486 ;; +OK [message deleted]
487 ;; -ERR [no such message]
491 ;; Restrictions: transaction state
492 ;; Possible responses:
497 ;; Restrictions: transaction state
498 ;; Possible responses:
499 ;; +OK nn [highest numbered message accessed]
503 ;; Restrictions: transaction state
504 ;; Possible responses:
505 ;; +OK [all delete marks removed]
511 ;; Restrictions: none
512 ;; Possible responses:
513 ;; +OK [TCP connection closed]
517 ;;; arch-tag: 2facc142-1d74-498e-82af-4659b64cac12
518 ;;; pop3.el ends here