17493
|
1 ;;; pop3.el --- Post Office Protocol (RFC 1460) interface
|
|
2
|
31716
|
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000
|
|
4 ;; Free Software Foundation, Inc.
|
17493
|
5
|
|
6 ;; Author: Richard L. Pieri <ratinox@peorth.gweep.net>
|
26108
|
7 ;; Maintainer: FSF
|
|
8 ;; Keywords: mail
|
17493
|
9
|
|
10 ;; This file is part of GNU Emacs.
|
|
11
|
|
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)
|
|
15 ;; any later version.
|
|
16
|
|
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.
|
|
21
|
|
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.
|
|
26
|
|
27 ;;; Commentary:
|
|
28
|
|
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.
|
|
33
|
|
34 ;; This program was inspired by Kyle E. Jones's vm-pop program.
|
|
35
|
|
36 ;;; Code:
|
|
37
|
|
38 (require 'mail-utils)
|
|
39
|
24357
|
40 (defvar pop3-maildrop (or (user-login-name) (getenv "LOGNAME") (getenv "USER") nil)
|
17493
|
41 "*POP3 maildrop.")
|
|
42 (defvar pop3-mailhost (or (getenv "MAILHOST") nil)
|
|
43 "*POP3 mailhost.")
|
|
44 (defvar pop3-port 110
|
|
45 "*POP3 port.")
|
|
46
|
|
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.")
|
|
51
|
|
52 (defvar pop3-authentication-scheme 'pass
|
|
53 "*POP3 authentication scheme.
|
|
54 Defaults to 'pass, for the standard USER/PASS authentication. Other valid
|
|
55 values are 'apop.")
|
|
56
|
|
57 (defvar pop3-timestamp nil
|
|
58 "Timestamp returned when initially connected to the POP server.
|
|
59 Used for APOP authentication.")
|
|
60
|
|
61 (defvar pop3-read-point nil)
|
|
62 (defvar pop3-debug nil)
|
|
63
|
|
64 (defun pop3-movemail (&optional crashbox)
|
|
65 "Transfer contents of a maildrop to the specified CRASHBOX."
|
|
66 (or crashbox (setq crashbox (expand-file-name "~/.crashbox")))
|
|
67 (let* ((process (pop3-open-server pop3-mailhost pop3-port))
|
|
68 (crashbuf (get-buffer-create " *pop3-retr*"))
|
|
69 (n 1)
|
24357
|
70 message-count
|
|
71 (pop3-password pop3-password)
|
|
72 )
|
17493
|
73 ;; for debugging only
|
|
74 (if pop3-debug (switch-to-buffer (process-buffer process)))
|
24357
|
75 ;; query for password
|
|
76 (if (and pop3-password-required (not pop3-password))
|
|
77 (setq pop3-password
|
|
78 (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
|
17493
|
79 (cond ((equal 'apop pop3-authentication-scheme)
|
|
80 (pop3-apop process pop3-maildrop))
|
|
81 ((equal 'pass pop3-authentication-scheme)
|
|
82 (pop3-user process pop3-maildrop)
|
|
83 (pop3-pass process))
|
26108
|
84 (t (error "Invalid POP3 authentication scheme")))
|
17493
|
85 (setq message-count (car (pop3-stat process)))
|
26108
|
86 (unwind-protect
|
|
87 (while (<= n message-count)
|
|
88 (message (format "Retrieving message %d of %d from %s..."
|
|
89 n message-count pop3-mailhost))
|
|
90 (pop3-retr process n crashbuf)
|
|
91 (save-excursion
|
|
92 (set-buffer crashbuf)
|
34618
|
93 (let ((coding-system-for-write 'binary))
|
26944
|
94 (write-region (point-min) (point-max) crashbox t 'nomesg))
|
26108
|
95 (set-buffer (process-buffer process))
|
|
96 (while (> (buffer-size) 5000)
|
|
97 (goto-char (point-min))
|
|
98 (forward-line 50)
|
|
99 (delete-region (point-min) (point))))
|
|
100 (pop3-dele process n)
|
|
101 (setq n (+ 1 n))
|
|
102 (if pop3-debug (sit-for 1) (sit-for 0.1))
|
|
103 )
|
|
104 (pop3-quit process))
|
17493
|
105 (kill-buffer crashbuf)
|
|
106 )
|
26108
|
107 t)
|
17493
|
108
|
35453
|
109 (defun pop3-get-message-count ()
|
|
110 "Return the number of messages in the maildrop."
|
|
111 (let* ((process (pop3-open-server pop3-mailhost pop3-port))
|
|
112 message-count
|
|
113 (pop3-password pop3-password)
|
|
114 )
|
|
115 ;; for debugging only
|
|
116 (if pop3-debug (switch-to-buffer (process-buffer process)))
|
|
117 ;; query for password
|
|
118 (if (and pop3-password-required (not pop3-password))
|
|
119 (setq pop3-password
|
|
120 (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
|
|
121 (cond ((equal 'apop pop3-authentication-scheme)
|
|
122 (pop3-apop process pop3-maildrop))
|
|
123 ((equal 'pass pop3-authentication-scheme)
|
|
124 (pop3-user process pop3-maildrop)
|
|
125 (pop3-pass process))
|
38412
|
126 (t (error "Invalid POP3 authentication scheme")))
|
35453
|
127 (setq message-count (car (pop3-stat process)))
|
|
128 (pop3-quit process)
|
|
129 message-count))
|
|
130
|
17493
|
131 (defun pop3-open-server (mailhost port)
|
26108
|
132 "Open TCP connection to MAILHOST on PORT.
|
17493
|
133 Returns the process associated with the connection."
|
28835
|
134 (let ((coding-system-for-read 'binary)
|
24357
|
135 (coding-system-for-write 'binary)
|
28835
|
136 process)
|
17493
|
137 (save-excursion
|
28835
|
138 (set-buffer (get-buffer-create (concat " trace of POP session to "
|
|
139 mailhost)))
|
24357
|
140 (erase-buffer)
|
|
141 (setq pop3-read-point (point-min))
|
28835
|
142 (setq process (open-network-stream "POP"(current-buffer) mailhost port))
|
|
143 (let ((response (pop3-read-response process t)))
|
|
144 (setq pop3-timestamp
|
|
145 (substring response (or (string-match "<" response) 0)
|
|
146 (+ 1 (or (string-match ">" response) -1)))))
|
|
147 process)))
|
17493
|
148
|
|
149 ;; Support functions
|
|
150
|
|
151 (defun pop3-process-filter (process output)
|
|
152 (save-excursion
|
|
153 (set-buffer (process-buffer process))
|
|
154 (goto-char (point-max))
|
|
155 (insert output)))
|
|
156
|
|
157 (defun pop3-send-command (process command)
|
|
158 (set-buffer (process-buffer process))
|
|
159 (goto-char (point-max))
|
|
160 ;; (if (= (aref command 0) ?P)
|
|
161 ;; (insert "PASS <omitted>\r\n")
|
|
162 ;; (insert command "\r\n"))
|
|
163 (setq pop3-read-point (point))
|
|
164 (goto-char (point-max))
|
26108
|
165 (process-send-string process (concat command "\r\n"))
|
17493
|
166 )
|
|
167
|
|
168 (defun pop3-read-response (process &optional return)
|
|
169 "Read the response from the server.
|
|
170 Return the response string if optional second argument is non-nil."
|
|
171 (let ((case-fold-search nil)
|
|
172 match-end)
|
|
173 (save-excursion
|
|
174 (set-buffer (process-buffer process))
|
|
175 (goto-char pop3-read-point)
|
|
176 (while (not (search-forward "\r\n" nil t))
|
19969
|
177 (accept-process-output process 3)
|
17493
|
178 (goto-char pop3-read-point))
|
|
179 (setq match-end (point))
|
|
180 (goto-char pop3-read-point)
|
|
181 (if (looking-at "-ERR")
|
|
182 (error (buffer-substring (point) (- match-end 2)))
|
|
183 (if (not (looking-at "+OK"))
|
|
184 (progn (setq pop3-read-point match-end) nil)
|
|
185 (setq pop3-read-point match-end)
|
|
186 (if return
|
|
187 (buffer-substring (point) match-end)
|
|
188 t)
|
|
189 )))))
|
|
190
|
|
191 (defvar pop3-read-passwd nil)
|
|
192 (defun pop3-read-passwd (prompt)
|
|
193 (if (not pop3-read-passwd)
|
24599
|
194 (if (fboundp 'read-passwd)
|
17493
|
195 (setq pop3-read-passwd 'read-passwd)
|
24599
|
196 (if (load "passwd" t)
|
|
197 (setq pop3-read-passwd 'read-passwd)
|
|
198 (autoload 'ange-ftp-read-passwd "ange-ftp")
|
|
199 (setq pop3-read-passwd 'ange-ftp-read-passwd))))
|
17493
|
200 (funcall pop3-read-passwd prompt))
|
|
201
|
|
202 (defun pop3-clean-region (start end)
|
|
203 (setq end (set-marker (make-marker) end))
|
|
204 (save-excursion
|
|
205 (goto-char start)
|
|
206 (while (and (< (point) end) (search-forward "\r\n" end t))
|
|
207 (replace-match "\n" t t))
|
|
208 (goto-char start)
|
|
209 (while (and (< (point) end) (re-search-forward "^\\." end t))
|
|
210 (replace-match "" t t)
|
|
211 (forward-char)))
|
|
212 (set-marker end nil))
|
|
213
|
33369
|
214 (eval-when-compile (defvar parse-time-months))
|
|
215
|
|
216 ;; Copied from message-make-date.
|
|
217 (defun pop3-make-date (&optional now)
|
|
218 "Make a valid date header.
|
|
219 If NOW, use that time instead."
|
|
220 (require 'parse-time)
|
|
221 (let* ((now (or now (current-time)))
|
|
222 (zone (nth 8 (decode-time now)))
|
|
223 (sign "+"))
|
|
224 (when (< zone 0)
|
|
225 (setq sign "-")
|
|
226 (setq zone (- zone)))
|
|
227 (concat
|
|
228 (format-time-string "%d" now)
|
|
229 ;; The month name of the %b spec is locale-specific. Pfff.
|
|
230 (format " %s "
|
|
231 (capitalize (car (rassoc (nth 4 (decode-time now))
|
|
232 parse-time-months))))
|
|
233 (format-time-string "%Y %H:%M:%S " now)
|
|
234 ;; We do all of this because XEmacs doesn't have the %z spec.
|
|
235 (format "%s%02d%02d" sign (/ zone 3600) (/ (% zone 3600) 60)))))
|
|
236
|
17493
|
237 (defun pop3-munge-message-separator (start end)
|
|
238 "Check to see if a message separator exists. If not, generate one."
|
|
239 (save-excursion
|
|
240 (save-restriction
|
|
241 (narrow-to-region start end)
|
|
242 (goto-char (point-min))
|
|
243 (if (not (or (looking-at "From .?") ; Unix mail
|
|
244 (looking-at "\001\001\001\001\n") ; MMDF
|
|
245 (looking-at "BABYL OPTIONS:") ; Babyl
|
|
246 ))
|
|
247 (let ((from (mail-strip-quoted-names (mail-fetch-field "From")))
|
28835
|
248 (date (split-string (or (mail-fetch-field "Date")
|
33369
|
249 (pop3-make-date))
|
28835
|
250 " "))
|
17493
|
251 (From_))
|
|
252 ;; sample date formats I have seen
|
|
253 ;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT)
|
|
254 ;; Date: 08 Jul 1996 23:22:24 -0400
|
|
255 ;; should be
|
|
256 ;; Tue Jul 9 09:04:21 1996
|
|
257 (setq date
|
|
258 (cond ((string-match "[A-Z]" (nth 0 date))
|
|
259 (format "%s %s %s %s %s"
|
|
260 (nth 0 date) (nth 2 date) (nth 1 date)
|
|
261 (nth 4 date) (nth 3 date)))
|
|
262 (t
|
|
263 ;; this really needs to be better but I don't feel
|
|
264 ;; like writing a date to day converter.
|
|
265 (format "Sun %s %s %s %s"
|
|
266 (nth 1 date) (nth 0 date)
|
|
267 (nth 3 date) (nth 2 date)))
|
|
268 ))
|
|
269 (setq From_ (format "\nFrom %s %s\n" from date))
|
|
270 (while (string-match "," From_)
|
|
271 (setq From_ (concat (substring From_ 0 (match-beginning 0))
|
|
272 (substring From_ (match-end 0)))))
|
|
273 (goto-char (point-min))
|
26108
|
274 (insert From_)
|
33369
|
275 (if (search-forward "\n\n" nil t)
|
|
276 nil
|
|
277 (goto-char (point-max))
|
|
278 (insert "\n"))
|
26108
|
279 (narrow-to-region (point) (point-max))
|
|
280 (let ((size (- (point-max) (point-min))))
|
|
281 (goto-char (point-min))
|
|
282 (widen)
|
|
283 (forward-line -1)
|
|
284 (insert (format "Content-Length: %s\n" size)))
|
|
285 )))))
|
17493
|
286
|
|
287 ;; The Command Set
|
|
288
|
|
289 ;; AUTHORIZATION STATE
|
|
290
|
|
291 (defun pop3-user (process user)
|
|
292 "Send USER information to POP3 server."
|
|
293 (pop3-send-command process (format "USER %s" user))
|
|
294 (let ((response (pop3-read-response process t)))
|
|
295 (if (not (and response (string-match "+OK" response)))
|
38412
|
296 (error (format "USER %s not valid" user)))))
|
17493
|
297
|
|
298 (defun pop3-pass (process)
|
|
299 "Send authentication information to the server."
|
24357
|
300 (pop3-send-command process (format "PASS %s" pop3-password))
|
|
301 (let ((response (pop3-read-response process t)))
|
|
302 (if (not (and response (string-match "+OK" response)))
|
|
303 (pop3-quit process))))
|
19633
|
304
|
17493
|
305 (defun pop3-apop (process user)
|
|
306 "Send alternate authentication information to the server."
|
|
307 (let ((pass pop3-password))
|
|
308 (if (and pop3-password-required (not pass))
|
|
309 (setq pass
|
|
310 (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
|
|
311 (if pass
|
19633
|
312 (let ((hash (pop3-md5 (concat pop3-timestamp pass))))
|
17493
|
313 (pop3-send-command process (format "APOP %s %s" user hash))
|
|
314 (let ((response (pop3-read-response process t)))
|
|
315 (if (not (and response (string-match "+OK" response)))
|
|
316 (pop3-quit process)))))
|
|
317 ))
|
|
318
|
|
319 ;; TRANSACTION STATE
|
|
320
|
33369
|
321 (eval-and-compile
|
|
322 (if (fboundp 'md5)
|
|
323 (defalias 'pop3-md5 'md5)
|
|
324 (defvar pop3-md5-program "md5"
|
|
325 "*Program to encode its input in MD5.")
|
24357
|
326
|
33369
|
327 (defun pop3-md5 (string)
|
|
328 (with-temp-buffer
|
|
329 (insert string)
|
|
330 (call-process-region (point-min) (point-max)
|
|
331 pop3-md5-program
|
|
332 t (current-buffer) nil)
|
|
333 ;; The meaningful output is the first 32 characters.
|
|
334 ;; Don't return the newline that follows them!
|
|
335 (buffer-substring 1 33)))))
|
24357
|
336
|
17493
|
337 (defun pop3-stat (process)
|
|
338 "Return the number of messages in the maildrop and the maildrop's size."
|
|
339 (pop3-send-command process "STAT")
|
|
340 (let ((response (pop3-read-response process t)))
|
28835
|
341 (list (string-to-int (nth 1 (split-string response " ")))
|
|
342 (string-to-int (nth 2 (split-string response " "))))
|
17493
|
343 ))
|
|
344
|
|
345 (defun pop3-list (process &optional msg)
|
|
346 "Scan listing of available messages.
|
|
347 This function currently does nothing.")
|
|
348
|
|
349 (defun pop3-retr (process msg crashbuf)
|
|
350 "Retrieve message-id MSG to buffer CRASHBUF."
|
|
351 (pop3-send-command process (format "RETR %s" msg))
|
|
352 (pop3-read-response process)
|
|
353 (let ((start pop3-read-point) end)
|
|
354 (save-excursion
|
|
355 (set-buffer (process-buffer process))
|
|
356 (while (not (re-search-forward "^\\.\r\n" nil t))
|
19969
|
357 (accept-process-output process 3)
|
17493
|
358 ;; bill@att.com ... to save wear and tear on the heap
|
24357
|
359 ;; uncommented because the condensed version below is a problem for
|
|
360 ;; some.
|
17493
|
361 (if (> (buffer-size) 20000) (sleep-for 1))
|
|
362 (if (> (buffer-size) 50000) (sleep-for 1))
|
|
363 (if (> (buffer-size) 100000) (sleep-for 1))
|
|
364 (if (> (buffer-size) 200000) (sleep-for 1))
|
|
365 (if (> (buffer-size) 500000) (sleep-for 1))
|
|
366 ;; bill@att.com
|
24357
|
367 ;; condensed into:
|
|
368 ;; (sometimes causes problems for really large messages.)
|
|
369 ; (if (> (buffer-size) 20000) (sleep-for (/ (buffer-size) 20000)))
|
17493
|
370 (goto-char start))
|
|
371 (setq pop3-read-point (point-marker))
|
|
372 ;; this code does not seem to work for some POP servers...
|
|
373 ;; and I cannot figure out why not.
|
|
374 ; (goto-char (match-beginning 0))
|
|
375 ; (backward-char 2)
|
|
376 ; (if (not (looking-at "\r\n"))
|
|
377 ; (insert "\r\n"))
|
|
378 ; (re-search-forward "\\.\r\n")
|
|
379 (goto-char (match-beginning 0))
|
|
380 (setq end (point-marker))
|
|
381 (pop3-clean-region start end)
|
|
382 (pop3-munge-message-separator start end)
|
|
383 (save-excursion
|
|
384 (set-buffer crashbuf)
|
|
385 (erase-buffer))
|
|
386 (copy-to-buffer crashbuf start end)
|
|
387 (delete-region start end)
|
|
388 )))
|
|
389
|
|
390 (defun pop3-dele (process msg)
|
|
391 "Mark message-id MSG as deleted."
|
|
392 (pop3-send-command process (format "DELE %s" msg))
|
|
393 (pop3-read-response process))
|
|
394
|
|
395 (defun pop3-noop (process msg)
|
|
396 "No-operation."
|
|
397 (pop3-send-command process "NOOP")
|
|
398 (pop3-read-response process))
|
|
399
|
|
400 (defun pop3-last (process)
|
|
401 "Return highest accessed message-id number for the session."
|
|
402 (pop3-send-command process "LAST")
|
|
403 (let ((response (pop3-read-response process t)))
|
28835
|
404 (string-to-int (nth 1 (split-string response " ")))
|
17493
|
405 ))
|
|
406
|
|
407 (defun pop3-rset (process)
|
|
408 "Remove all delete marks from current maildrop."
|
|
409 (pop3-send-command process "RSET")
|
|
410 (pop3-read-response process))
|
|
411
|
|
412 ;; UPDATE
|
|
413
|
|
414 (defun pop3-quit (process)
|
|
415 "Close connection to POP3 server.
|
|
416 Tell server to remove all messages marked as deleted, unlock the maildrop,
|
|
417 and close the connection."
|
|
418 (pop3-send-command process "QUIT")
|
|
419 (pop3-read-response process t)
|
|
420 (if process
|
|
421 (save-excursion
|
|
422 (set-buffer (process-buffer process))
|
|
423 (goto-char (point-max))
|
|
424 (delete-process process))))
|
|
425
|
|
426 ;; Summary of POP3 (Post Office Protocol version 3) commands and responses
|
|
427
|
|
428 ;;; AUTHORIZATION STATE
|
|
429
|
|
430 ;; Initial TCP connection
|
|
431 ;; Arguments: none
|
|
432 ;; Restrictions: none
|
|
433 ;; Possible responses:
|
|
434 ;; +OK [POP3 server ready]
|
|
435
|
|
436 ;; USER name
|
|
437 ;; Arguments: a server specific user-id (required)
|
|
438 ;; Restrictions: authorization state [after unsuccessful USER or PASS
|
|
439 ;; Possible responses:
|
|
440 ;; +OK [valid user-id]
|
|
441 ;; -ERR [invalid user-id]
|
|
442
|
|
443 ;; PASS string
|
|
444 ;; Arguments: a server/user-id specific password (required)
|
|
445 ;; Restrictions: authorization state, after successful USER
|
|
446 ;; Possible responses:
|
|
447 ;; +OK [maildrop locked and ready]
|
|
448 ;; -ERR [invalid password]
|
|
449 ;; -ERR [unable to lock maildrop]
|
|
450
|
|
451 ;;; TRANSACTION STATE
|
|
452
|
|
453 ;; STAT
|
|
454 ;; Arguments: none
|
|
455 ;; Restrictions: transaction state
|
|
456 ;; Possible responses:
|
|
457 ;; +OK nn mm [# of messages, size of maildrop]
|
|
458
|
|
459 ;; LIST [msg]
|
|
460 ;; Arguments: a message-id (optional)
|
|
461 ;; Restrictions: transaction state; msg must not be deleted
|
|
462 ;; Possible responses:
|
|
463 ;; +OK [scan listing follows]
|
|
464 ;; -ERR [no such message]
|
|
465
|
|
466 ;; RETR msg
|
|
467 ;; Arguments: a message-id (required)
|
|
468 ;; Restrictions: transaction state; msg must not be deleted
|
|
469 ;; Possible responses:
|
|
470 ;; +OK [message contents follow]
|
|
471 ;; -ERR [no such message]
|
|
472
|
|
473 ;; DELE msg
|
|
474 ;; Arguments: a message-id (required)
|
|
475 ;; Restrictions: transaction state; msg must not be deleted
|
|
476 ;; Possible responses:
|
|
477 ;; +OK [message deleted]
|
|
478 ;; -ERR [no such message]
|
|
479
|
|
480 ;; NOOP
|
|
481 ;; Arguments: none
|
|
482 ;; Restrictions: transaction state
|
|
483 ;; Possible responses:
|
|
484 ;; +OK
|
|
485
|
|
486 ;; LAST
|
|
487 ;; Arguments: none
|
|
488 ;; Restrictions: transaction state
|
|
489 ;; Possible responses:
|
|
490 ;; +OK nn [highest numbered message accessed]
|
|
491
|
|
492 ;; RSET
|
|
493 ;; Arguments: none
|
|
494 ;; Restrictions: transaction state
|
|
495 ;; Possible responses:
|
|
496 ;; +OK [all delete marks removed]
|
|
497
|
|
498 ;;; UPDATE STATE
|
|
499
|
|
500 ;; QUIT
|
|
501 ;; Arguments: none
|
|
502 ;; Restrictions: none
|
|
503 ;; Possible responses:
|
|
504 ;; +OK [TCP connection closed]
|
26108
|
505
|
|
506 (provide 'pop3)
|
|
507
|
|
508 ;;; pop3.el ends here
|