1 ;;; pop3.el --- Post Office Protocol (RFC 1460) interface
3 ;; Copyright (C) 1996-2011 Free Software Foundation, Inc.
5 ;; Author: Richard L. Pieri <ratinox@peorth.gweep.net>
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 3 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
26 ;; Most of the standard Post Office Protocol version 3 (RFC 1460) commands
27 ;; are implemented. The LIST command has not been implemented due to lack
28 ;; of actual usefulness.
29 ;; The optional POP3 command TOP has not been implemented.
31 ;; This program was inspired by Kyle E. Jones's vm-pop program.
35 (eval-when-compile (require 'cl
))
37 (defvar parse-time-months
)
40 "Post Office Protocol."
44 (defcustom pop3-maildrop
(or (user-login-name)
48 :version
"22.1" ;; Oort Gnus
52 (defcustom pop3-mailhost
(or (getenv "MAILHOST") ;; nil -> mismatch
55 :version
"22.1" ;; Oort Gnus
59 (defcustom pop3-port
110
61 :version
"22.1" ;; Oort Gnus
65 (defcustom pop3-password-required t
66 "*Non-nil if a password is required when connecting to POP server."
67 :version
"22.1" ;; Oort Gnus
71 ;; Should this be customizable?
72 (defvar pop3-password nil
73 "*Password to use when connecting to POP server.")
75 (defcustom pop3-authentication-scheme
'pass
76 "*POP3 authentication scheme.
77 Defaults to `pass', for the standard USER/PASS authentication. The other
78 valid value is 'apop'."
79 :type
'(choice (const :tag
"Normal user/password" pass
)
80 (const :tag
"APOP" apop
))
81 :version
"22.1" ;; Oort Gnus
84 (defcustom pop3-stream-length
100
85 "How many messages should be requested at one time.
86 The lower the number, the more latency-sensitive the fetching
87 will be. If your pop3 server doesn't support streaming at all,
93 (defcustom pop3-leave-mail-on-server nil
94 "*Non-nil if the mail is to be left on the POP server after fetching.
96 If `pop3-leave-mail-on-server' is non-nil the mail is to be left
97 on the POP server after fetching. Note that POP servers maintain
98 no state information between sessions, so what the client
99 believes is there and what is actually there may not match up.
100 If they do not, then you may get duplicate mails or the whole
101 thing can fall apart and leave you with a corrupt mailbox."
102 ;; We can't use the UILD support from XEmacs mail-lib or cvs.m17n.org:
103 ;; http://thread.gmane.org/v9lld8fml4.fsf@marauder.physik.uni-ulm.de
104 ;; http://thread.gmane.org/b9yy8hzy9ej.fsf@jpl.org
105 ;; Any volunteer to re-implement this?
106 :version
"22.1" ;; Oort Gnus
110 (defvar pop3-timestamp nil
111 "Timestamp returned when initially connected to the POP server.
112 Used for APOP authentication.")
114 (defvar pop3-read-point nil
)
115 (defvar pop3-debug nil
)
117 ;; Borrowed from nnheader-accept-process-output in nnheader.el. See the
118 ;; comments there for explanations about the values.
121 (if (and (fboundp 'nnheader-accept-process-output
)
122 (boundp 'nnheader-read-timeout
))
123 (defalias 'pop3-accept-process-output
'nnheader-accept-process-output
)
124 ;; Borrowed from `nnheader.el':
125 (defvar pop3-read-timeout
126 (if (string-match "windows-nt\\|os/2\\|cygwin"
127 (symbol-name system-type
))
130 "How long pop3 should wait between checking for the end of output.
131 Shorter values mean quicker response, but are more CPU intensive.")
132 (defun pop3-accept-process-output (process)
133 (accept-process-output
135 (truncate pop3-read-timeout
)
136 (truncate (* (- pop3-read-timeout
137 (truncate pop3-read-timeout
))
141 (defun pop3-movemail (file)
142 "Transfer contents of a maildrop to the specified FILE.
143 Use streaming commands."
144 (let* ((process (pop3-open-server pop3-mailhost pop3-port
))
145 message-count message-total-size
)
147 (with-current-buffer (process-buffer process
)
148 (let ((size (pop3-stat process
)))
149 (setq message-count
(car size
)
150 message-total-size
(cadr size
)))
151 (when (> message-count
0)
152 (pop3-send-streaming-command
153 process
"RETR" message-count message-total-size
)
154 (pop3-write-to-file file
)
155 (unless pop3-leave-mail-on-server
156 (pop3-send-streaming-command
157 process
"DELE" message-count nil
))))
161 (defun pop3-send-streaming-command (process command count total-size
)
165 (process-send-string process
(format "%s %d\r\n" command i
))
166 ;; Only do 100 messages at a time to avoid pipe stalls.
167 (when (zerop (% i pop3-stream-length
))
168 (pop3-wait-for-messages process i total-size
))
170 (pop3-wait-for-messages process count total-size
))
172 (defun pop3-wait-for-messages (process count total-size
)
173 (while (< (pop3-number-of-responses total-size
) count
)
175 (message "pop3 retrieved %dKB (%d%%)"
176 (truncate (/ (buffer-size) 1000))
177 (truncate (* (/ (* (buffer-size) 1.0)
179 (pop3-accept-process-output process
)))
181 (defun pop3-write-to-file (file)
182 (let ((pop-buffer (current-buffer))
187 (setq temp-buffer
(current-buffer))
188 (with-current-buffer pop-buffer
189 (goto-char (point-min))
190 (while (re-search-forward "^\\+OK" nil t
)
193 (when (re-search-forward "^\\.\r?\n" nil t
)
197 (with-current-buffer temp-buffer
198 (goto-char (point-max))
199 (let ((hstart (point)))
200 (insert-buffer-substring pop-buffer beg end
)
201 (pop3-clean-region hstart
(point))
202 (goto-char (point-max))
203 (pop3-munge-message-separator hstart
(point))
204 (goto-char (point-max))))))
205 (let ((coding-system-for-write 'binary
))
206 (goto-char (point-min))
207 ;; Check whether something inserted a newline at the start and
211 (write-region (point-min) (point-max) file nil
'nomesg
)))))
213 (defun pop3-number-of-responses (endp)
216 (goto-char (point-min))
217 (while (or (and (re-search-forward "^\\+OK" nil t
)
219 (re-search-forward "^\\.\r?\n" nil t
)))
220 (re-search-forward "^-ERR " nil t
))
224 (defun pop3-logon (process)
225 (let ((pop3-password pop3-password
))
226 ;; for debugging only
227 (if pop3-debug
(switch-to-buffer (process-buffer process
)))
228 ;; query for password
229 (if (and pop3-password-required
(not pop3-password
))
231 (read-passwd (format "Password for %s: " pop3-maildrop
))))
232 (cond ((equal 'apop pop3-authentication-scheme
)
233 (pop3-apop process pop3-maildrop
))
234 ((equal 'pass pop3-authentication-scheme
)
235 (pop3-user process pop3-maildrop
)
237 (t (error "Invalid POP3 authentication scheme")))))
239 (defun pop3-get-message-count ()
240 "Return the number of messages in the maildrop."
241 (let* ((process (pop3-open-server pop3-mailhost pop3-port
))
243 (pop3-password pop3-password
))
244 ;; for debugging only
245 (if pop3-debug
(switch-to-buffer (process-buffer process
)))
246 ;; query for password
247 (if (and pop3-password-required
(not pop3-password
))
249 (read-passwd (format "Password for %s: " pop3-maildrop
))))
250 (cond ((equal 'apop pop3-authentication-scheme
)
251 (pop3-apop process pop3-maildrop
))
252 ((equal 'pass pop3-authentication-scheme
)
253 (pop3-user process pop3-maildrop
)
255 (t (error "Invalid POP3 authentication scheme")))
256 (setq message-count
(car (pop3-stat process
)))
260 (autoload 'open-tls-stream
"tls")
261 (autoload 'starttls-open-stream
"starttls")
262 (autoload 'starttls-negotiate
"starttls") ; avoid warning
264 (defcustom pop3-stream-type nil
265 "*Transport security type for POP3 connexions.
266 This may be either nil (plain connexion), `ssl' (use an
267 SSL/TSL-secured stream) or `starttls' (use the starttls mechanism
268 to turn on TLS security after opening the stream). However, if
269 this is nil, `ssl' is assumed for connexions to port
271 :version
"23.1" ;; No Gnus
273 :type
'(choice (const :tag
"Plain" nil
)
274 (const :tag
"SSL/TLS" ssl
)
278 (if (fboundp 'set-process-query-on-exit-flag
)
279 (defalias 'pop3-set-process-query-on-exit-flag
280 'set-process-query-on-exit-flag
)
281 (defalias 'pop3-set-process-query-on-exit-flag
282 'process-kill-without-query
)))
284 (defun pop3-open-server (mailhost port
)
285 "Open TCP connection to MAILHOST on PORT.
286 Returns the process associated with the connection."
287 (let ((coding-system-for-read 'binary
)
288 (coding-system-for-write 'binary
)
291 (get-buffer-create (concat " trace of POP session to "
294 (setq pop3-read-point
(point-min))
297 ((or (eq pop3-stream-type
'ssl
)
298 (and (not pop3-stream-type
) (member port
'(995 "pop3s"))))
299 ;; gnutls-cli, openssl don't accept service names
300 (if (or (equal port
"pop3s")
303 (let ((process (open-tls-stream "POP" (current-buffer)
306 ;; There's a load of info printed that needs deleting.
309 ;; - either we received the +OK line
310 ;; - or accept-process-output timed out without getting
313 (setq again
(memq (process-status process
)
315 (setq again
(pop3-accept-process-output process
))
316 (goto-char (point-max))
318 (cond ((looking-at "\\+OK")
320 (delete-region (point-min) (point)))
323 (error "POP SSL connexion failed")))))
325 ((eq pop3-stream-type
'starttls
)
326 ;; gnutls-cli, openssl don't accept service names
327 (if (equal port
"pop3")
329 ;; Delay STLS until server greeting is read (Bug#7438).
330 (starttls-open-stream "POP" (current-buffer)
331 mailhost
(or port
110)))
333 (open-network-stream "POP" (current-buffer) mailhost port
))))
334 (let ((response (pop3-read-response process t
)))
336 (substring response
(or (string-match "<" response
) 0)
337 (+ 1 (or (string-match ">" response
) -
1)))))
338 (when (eq pop3-stream-type
'starttls
)
339 (pop3-send-command process
"STLS")
340 (let ((response (pop3-read-response process t
)))
341 (if (and response
(string-match "+OK" response
))
342 (starttls-negotiate process
)
344 (error "POP server doesn't support starttls"))))
345 (pop3-set-process-query-on-exit-flag process nil
)
350 (defun pop3-send-command (process command
)
351 (set-buffer (process-buffer process
))
352 (goto-char (point-max))
353 ;; (if (= (aref command 0) ?P)
354 ;; (insert "PASS <omitted>\r\n")
355 ;; (insert command "\r\n"))
356 (setq pop3-read-point
(point))
357 (goto-char (point-max))
358 (process-send-string process
(concat command
"\r\n")))
360 (defun pop3-read-response (process &optional return
)
361 "Read the response from the server.
362 Return the response string if optional second argument is non-nil."
363 (let ((case-fold-search nil
)
365 (with-current-buffer (process-buffer process
)
366 (goto-char pop3-read-point
)
367 (while (and (memq (process-status process
) '(open run
))
368 (not (search-forward "\r\n" nil t
)))
369 (pop3-accept-process-output process
)
370 (goto-char pop3-read-point
))
371 (setq match-end
(point))
372 (goto-char pop3-read-point
)
373 (if (looking-at "-ERR")
374 (error "%s" (buffer-substring (point) (- match-end
2)))
375 (if (not (looking-at "+OK"))
376 (progn (setq pop3-read-point match-end
) nil
)
377 (setq pop3-read-point match-end
)
379 (buffer-substring (point) match-end
)
383 (defun pop3-clean-region (start end
)
384 (setq end
(set-marker (make-marker) end
))
387 (while (and (< (point) end
) (search-forward "\r\n" end t
))
388 (replace-match "\n" t t
))
390 (while (and (< (point) end
) (re-search-forward "^\\." end t
))
391 (replace-match "" t t
)
393 (set-marker end nil
))
395 ;; Copied from message-make-date.
396 (defun pop3-make-date (&optional now
)
397 "Make a valid date header.
398 If NOW, use that time instead."
399 (require 'parse-time
)
400 (let* ((now (or now
(current-time)))
401 (zone (nth 8 (decode-time now
)))
405 (setq zone
(- zone
)))
407 (format-time-string "%d" now
)
408 ;; The month name of the %b spec is locale-specific. Pfff.
410 (capitalize (car (rassoc (nth 4 (decode-time now
))
411 parse-time-months
))))
412 (format-time-string "%Y %H:%M:%S " now
)
413 ;; We do all of this because XEmacs doesn't have the %z spec.
414 (format "%s%02d%02d" sign
(/ zone
3600) (/ (% zone
3600) 60)))))
416 (defun pop3-munge-message-separator (start end
)
417 "Check to see if a message separator exists. If not, generate one."
420 (narrow-to-region start end
)
421 (goto-char (point-min))
422 (if (not (or (looking-at "From .?") ; Unix mail
423 (looking-at "\001\001\001\001\n") ; MMDF
424 (looking-at "BABYL OPTIONS:") ; Babyl
426 (let* ((from (mail-strip-quoted-names (mail-fetch-field "From")))
427 (tdate (mail-fetch-field "Date"))
428 (date (split-string (or (and tdate
429 (not (string= "" tdate
))
434 ;; sample date formats I have seen
435 ;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT)
436 ;; Date: 08 Jul 1996 23:22:24 -0400
438 ;; Tue Jul 9 09:04:21 1996
440 ;; Fixme: This should use timezone on the date field contents.
443 "Tue Jan 1 00:00:0 1900")
444 ((string-match "[A-Z]" (nth 0 date
))
445 (format "%s %s %s %s %s"
446 (nth 0 date
) (nth 2 date
) (nth 1 date
)
447 (nth 4 date
) (nth 3 date
)))
449 ;; this really needs to be better but I don't feel
450 ;; like writing a date to day converter.
451 (format "Sun %s %s %s %s"
452 (nth 1 date
) (nth 0 date
)
453 (nth 3 date
) (nth 2 date
)))
455 (setq From_
(format "\nFrom %s %s\n" from date
))
456 (while (string-match "," From_
)
457 (setq From_
(concat (substring From_
0 (match-beginning 0))
458 (substring From_
(match-end 0)))))
459 (goto-char (point-min))
461 (if (search-forward "\n\n" nil t
)
463 (goto-char (point-max))
465 (let ((size (- (point-max) (point))))
467 (insert (format "Content-Length: %s\n" size
)))
472 ;; AUTHORIZATION STATE
474 (defun pop3-user (process user
)
475 "Send USER information to POP3 server."
476 (pop3-send-command process
(format "USER %s" user
))
477 (let ((response (pop3-read-response process t
)))
478 (if (not (and response
(string-match "+OK" response
)))
479 (error "USER %s not valid" user
))))
481 (defun pop3-pass (process)
482 "Send authentication information to the server."
483 (pop3-send-command process
(format "PASS %s" pop3-password
))
484 (let ((response (pop3-read-response process t
)))
485 (if (not (and response
(string-match "+OK" response
)))
486 (pop3-quit process
))))
488 (defun pop3-apop (process user
)
489 "Send alternate authentication information to the server."
490 (let ((pass pop3-password
))
491 (if (and pop3-password-required
(not pass
))
493 (read-passwd (format "Password for %s: " pop3-maildrop
))))
495 (let ((hash (md5 (concat pop3-timestamp pass
) nil nil
'binary
)))
496 (pop3-send-command process
(format "APOP %s %s" user hash
))
497 (let ((response (pop3-read-response process t
)))
498 (if (not (and response
(string-match "+OK" response
)))
499 (pop3-quit process
)))))
504 (defun pop3-stat (process)
505 "Return the number of messages in the maildrop and the maildrop's size."
506 (pop3-send-command process
"STAT")
507 (let ((response (pop3-read-response process t
)))
508 (list (string-to-number (nth 1 (split-string response
" ")))
509 (string-to-number (nth 2 (split-string response
" "))))
512 (defun pop3-list (process &optional msg
)
513 "If MSG is nil, return an alist of (MESSAGE-ID . SIZE) pairs.
514 Otherwise, return the size of the message-id MSG"
515 (pop3-send-command process
(if msg
516 (format "LIST %d" msg
)
518 (let ((response (pop3-read-response process t
)))
520 (string-to-number (nth 2 (split-string response
" ")))
521 (let ((start pop3-read-point
) end
)
522 (with-current-buffer (process-buffer process
)
523 (while (not (re-search-forward "^\\.\r\n" nil t
))
524 (pop3-accept-process-output process
)
526 (setq pop3-read-point
(point-marker))
527 (goto-char (match-beginning 0))
528 (setq end
(point-marker))
529 (mapcar #'(lambda (s) (let ((split (split-string s
" ")))
530 (cons (string-to-number (nth 0 split
))
531 (string-to-number (nth 1 split
)))))
532 (split-string (buffer-substring start end
) "\r\n" t
)))))))
534 (defun pop3-retr (process msg crashbuf
)
535 "Retrieve message-id MSG to buffer CRASHBUF."
536 (pop3-send-command process
(format "RETR %s" msg
))
537 (pop3-read-response process
)
538 (let ((start pop3-read-point
) end
)
539 (with-current-buffer (process-buffer process
)
540 (while (not (re-search-forward "^\\.\r\n" nil t
))
541 (pop3-accept-process-output process
)
543 (setq pop3-read-point
(point-marker))
544 ;; this code does not seem to work for some POP servers...
545 ;; and I cannot figure out why not.
546 ;; (goto-char (match-beginning 0))
548 ;; (if (not (looking-at "\r\n"))
550 ;; (re-search-forward "\\.\r\n")
551 (goto-char (match-beginning 0))
552 (setq end
(point-marker))
553 (pop3-clean-region start end
)
554 (pop3-munge-message-separator start end
)
555 (with-current-buffer crashbuf
557 (copy-to-buffer crashbuf start end
)
558 (delete-region start end
)
561 (defun pop3-dele (process msg
)
562 "Mark message-id MSG as deleted."
563 (pop3-send-command process
(format "DELE %s" msg
))
564 (pop3-read-response process
))
566 (defun pop3-noop (process msg
)
568 (pop3-send-command process
"NOOP")
569 (pop3-read-response process
))
571 (defun pop3-last (process)
572 "Return highest accessed message-id number for the session."
573 (pop3-send-command process
"LAST")
574 (let ((response (pop3-read-response process t
)))
575 (string-to-number (nth 1 (split-string response
" ")))
578 (defun pop3-rset (process)
579 "Remove all delete marks from current maildrop."
580 (pop3-send-command process
"RSET")
581 (pop3-read-response process
))
585 (defun pop3-quit (process)
586 "Close connection to POP3 server.
587 Tell server to remove all messages marked as deleted, unlock the maildrop,
588 and close the connection."
589 (pop3-send-command process
"QUIT")
590 (pop3-read-response process t
)
592 (with-current-buffer (process-buffer process
)
593 (goto-char (point-max))
594 (delete-process process
))))
596 ;; Summary of POP3 (Post Office Protocol version 3) commands and responses
598 ;;; AUTHORIZATION STATE
600 ;; Initial TCP connection
602 ;; Restrictions: none
603 ;; Possible responses:
604 ;; +OK [POP3 server ready]
607 ;; Arguments: a server specific user-id (required)
608 ;; Restrictions: authorization state [after unsuccessful USER or PASS
609 ;; Possible responses:
610 ;; +OK [valid user-id]
611 ;; -ERR [invalid user-id]
614 ;; Arguments: a server/user-id specific password (required)
615 ;; Restrictions: authorization state, after successful USER
616 ;; Possible responses:
617 ;; +OK [maildrop locked and ready]
618 ;; -ERR [invalid password]
619 ;; -ERR [unable to lock maildrop]
623 ;; Restrictions: Only permitted in AUTHORIZATION state.
624 ;; Possible responses:
628 ;;; TRANSACTION STATE
632 ;; Restrictions: transaction state
633 ;; Possible responses:
634 ;; +OK nn mm [# of messages, size of maildrop]
637 ;; Arguments: a message-id (optional)
638 ;; Restrictions: transaction state; msg must not be deleted
639 ;; Possible responses:
640 ;; +OK [scan listing follows]
641 ;; -ERR [no such message]
644 ;; Arguments: a message-id (required)
645 ;; Restrictions: transaction state; msg must not be deleted
646 ;; Possible responses:
647 ;; +OK [message contents follow]
648 ;; -ERR [no such message]
651 ;; Arguments: a message-id (required)
652 ;; Restrictions: transaction state; msg must not be deleted
653 ;; Possible responses:
654 ;; +OK [message deleted]
655 ;; -ERR [no such message]
659 ;; Restrictions: transaction state
660 ;; Possible responses:
665 ;; Restrictions: transaction state
666 ;; Possible responses:
667 ;; +OK nn [highest numbered message accessed]
671 ;; Restrictions: transaction state
672 ;; Possible responses:
673 ;; +OK [all delete marks removed]
679 ;; Restrictions: none
680 ;; Possible responses:
681 ;; +OK [TCP connection closed]
685 ;;; pop3.el ends here