;;; pop3.el --- Post Office Protocol (RFC 1460) interface
-;; Copyright (C) 1996-1999 Free Software Foundation, Inc.
+;; Copyright (C) 1996, 1997, 1998, 1999, 2000
+;; Free Software Foundation, Inc.
;; Author: Richard L. Pieri <ratinox@peorth.gweep.net>
;; Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
-;; Keywords: mail, pop3
-;; Version: 1.3s
+;; Maintainer: FSF
+;; Keywords: mail
;; This file is part of GNU Emacs.
;;; Code:
-(require 'mail-utils)
-(provide 'pop3)
+(eval-when-compile (require 'cl))
+(eval-when-compile (require 'static))
-(defconst pop3-version "1.3s")
+(require 'mail-utils)
(defvar pop3-maildrop (or (user-login-name) (getenv "LOGNAME") (getenv "USER") nil)
"*POP3 maildrop.")
Used for APOP authentication.")
(defvar pop3-leave-mail-on-server nil
- "Non-nil if mail is to be left on the server and UIDL used for
-message retrieval.")
+ "Non-nil if mail is to be left on the server and UIDL used for message retrieval.")
(defvar pop3-maximum-message-size nil
"If non-nil only download messages smaller than this.")
+(defvar pop3-except-header-regexp nil
+ "If non-nil we do not retrieve messages whose headers are matching this regexp.")
+
(defvar pop3-uidl-file-name "~/.uidls"
"File in which to store the UIDL of processed messages.")
(defvar pop3-debug nil)
(eval-and-compile
- (autoload 'open-ssl-stream "ssl"))
+ (autoload 'open-ssl-stream "ssl")
+ (autoload 'starttls-open-stream "starttls")
+ (autoload 'starttls-negotiate "starttls"))
+
+(defvar pop3-ssl-program-name
+ (if (exec-installed-p "openssl")
+ "openssl"
+ "ssleay")
+ "The program to run in a subprocess to open an SSL connection.")
(defvar pop3-ssl-program-arguments
- '("-quiet")
+ '("s_client" "-quiet")
"Arguments to be passed to the program `pop3-ssl-program-name'.")
+(defun pop3-progress-message (format percent &rest args)
+ (apply (function message) format args))
+
(defun pop3-movemail (&optional crashbox)
"Transfer contents of a maildrop to the specified CRASHBOX."
(or crashbox (setq crashbox (expand-file-name "~/.crashbox")))
(let* ((process (pop3-open-server pop3-mailhost pop3-port))
(crashbuf (get-buffer-create " *pop3-retr*"))
(n 1)
- (msgid 1)
- (msglen 0)
message-count
(pop3-password pop3-password)
- (pop3-uidl-file-name
- (concat pop3-uidl-file-name "-" pop3-mailhost))
- (retrieved-messages nil)
- messages)
+ (pop3-uidl-file-name (convert-standard-filename
+ (concat pop3-uidl-file-name "-"
+ pop3-mailhost)))
+ retrieved-messages messages)
;; for debugging only
(if pop3-debug (switch-to-buffer (process-buffer process)))
;; query for password
((equal 'pass pop3-authentication-scheme)
(pop3-user process pop3-maildrop)
(pop3-pass process))
- (t (error "Invalid POP3 authentication scheme.")))
+ (t (error "Invalid POP3 authentication scheme")))
;; get messages that are suitable for download
(message "Retrieving message list...")
(setq messages (pop3-get-message-numbers process)
- message-count (length messages))
- (message (format "Retrieving message list...%d unread" message-count))
+ message-count (length (cdr messages)))
+ (message "Retrieving message list...%d of %d unread"
+ message-count (pop messages))
(unwind-protect
- (progn
- (while (<= n message-count)
- (setq msgid (caar messages)
- msglen (cdar messages)
- messages (cdr messages))
- ;; only retrieve messages matching our regexp or in the uidl list
- (unless (or (not msgid)
- ;; don't download messages that are too large
- (and pop3-maximum-message-size
- (> msglen pop3-maximum-message-size)))
- (message (format "Retrieving message %d of %d from %s..."
- n message-count pop3-mailhost))
- (pop3-retr process msgid crashbuf)
- (setq retrieved-messages (cons msgid retrieved-messages)))
- (setq n (1+ n)))
+ (unless (not (stringp crashbox))
+ (while messages
+ (pop3-progress-message
+ "Retrieving message %d of %d (%d octets) from %s..."
+ (floor (* (/ (float n) message-count) 100))
+ n message-count (cdar messages) pop3-mailhost)
+ (pop3-retr process (caar messages) crashbuf)
+ (push (caar messages) retrieved-messages)
+ (setq messages (cdr messages)
+ n (1+ n)))
(with-current-buffer crashbuf
(write-region-as-binary (point-min) (point-max)
- crashbox 'append 'nomesg)
- )
+ crashbox 'append 'nomesg))
;; mark messages as read
(when pop3-leave-mail-on-server
(pop3-save-uidls))
;; now delete the messages we have retrieved
(unless pop3-leave-mail-on-server
(dolist (n retrieved-messages)
- (message (format "Deleting message %d of %d from %s..."
- n message-count pop3-mailhost))
+ (message "Deleting message %d of %d from %s..."
+ n message-count pop3-mailhost)
(pop3-dele process n)))
)
(pop3-quit process))
(kill-buffer crashbuf)
- t))
+ message-count))
(defun pop3-open-server (mailhost port)
- "Open TCP connection to MAILHOST.
-Returns the process associated with the connection."
- (let ((process-buffer
- (get-buffer-create (format "trace of POP session to %s" mailhost)))
- (process))
+ "Open TCP connection to MAILHOST on PORT.
+Returns the process associated with the connection.
+Argument PORT specifies connecting port."
+ (let (process)
(save-excursion
- (set-buffer process-buffer)
- (erase-buffer))
- (setq
- process
- (cond
- ((eq pop3-connection-type 'ssl)
- (pop3-open-ssl-stream "POP" process-buffer mailhost port))
- (t
- (open-network-stream-as-binary "POP" process-buffer mailhost port))))
- (setq pop3-read-point (point-min))
- (let ((response (pop3-read-response process t)))
- (setq pop3-timestamp
- (substring response (or (string-match "<" response) 0)
- (+ 1 (or (string-match ">" response) -1)))))
- process))
+ (set-buffer (get-buffer-create (concat " trace of POP session to "
+ mailhost)))
+ (erase-buffer)
+ (setq pop3-read-point (point-min))
+ (setq
+ process
+ (cond
+ ((eq pop3-connection-type 'ssl)
+ (pop3-open-ssl-stream "POP" (current-buffer) mailhost port))
+ ((eq pop3-connection-type 'tls)
+ (pop3-open-tls-stream "POP" (current-buffer) mailhost port))
+ (t
+ (open-network-stream-as-binary "POP" (current-buffer)
+ mailhost port))))
+ (let ((response (pop3-read-response process t)))
+ (setq pop3-timestamp
+ (substring response (or (string-match "<" response) 0)
+ (+ 1 (or (string-match ">" response) -1)))))
+ process)))
(defun pop3-open-ssl-stream-1 (name buffer host service extra-arg)
- (let* ((ssl-program-arguments
+ (require 'path-util)
+ (let* ((ssl-program-name
+ pop3-ssl-program-name)
+ (ssl-program-arguments
`(,@pop3-ssl-program-arguments ,extra-arg
"-connect" ,(format "%s:%d" host service)))
(process (open-ssl-stream name buffer host service)))
process))))
(defun pop3-open-ssl-stream (name buffer host service)
- "Open a SSL connection for a service to a host."
- (as-binary-process
- (or (pop3-open-ssl-stream-1 name buffer host service "-ssl3")
- (pop3-open-ssl-stream-1 name buffer host service "-ssl2"))))
+ "Open a SSL connection for a service to a host.
+Returns a subprocess-object to represent the connection.
+Args are NAME BUFFER HOST SERVICE."
+ (cond ((eq system-type 'windows-nt)
+ (let (selective-display
+ (coding-system-for-write 'binary)
+ (coding-system-for-read 'raw-text-dos))
+ (or (pop3-open-ssl-stream-1 name buffer host service "-ssl3")
+ (pop3-open-ssl-stream-1 name buffer host service "-ssl2"))))
+ (t
+ (as-binary-process
+ (or (pop3-open-ssl-stream-1 name buffer host service "-ssl3")
+ (pop3-open-ssl-stream-1 name buffer host service "-ssl2"))))))
+
+(defun pop3-open-tls-stream (name buffer host service)
+ "Open a TLSv1 connection for a service to a host.
+Returns a subprocess-object to represent the connection.
+Args are NAME BUFFER HOST SERVICE."
+ (let ((process
+ (as-binary-process (starttls-open-stream
+ name buffer host service))))
+ (pop3-stls process)
+ (starttls-negotiate process)
+ process))
;; Support functions
(setq match-end (point))
(goto-char pop3-read-point)
(if (looking-at "-ERR")
- (signal 'error (list (buffer-substring (point) (- match-end 2))))
+ (error (buffer-substring (point) (- match-end 2)))
(if (not (looking-at "+OK"))
(progn (setq pop3-read-point match-end) nil)
(setq pop3-read-point match-end)
(defvar pop3-read-passwd nil)
(defun pop3-read-passwd (prompt)
(if (not pop3-read-passwd)
- (if (functionp 'read-passwd)
+ (if (fboundp 'read-passwd)
(setq pop3-read-passwd 'read-passwd)
(if (load "passwd" t)
(setq pop3-read-passwd 'read-passwd)
;; we use the LIST comand first anyway to get the message lengths.
;; then if we're leaving mail on the server, see if the UIDL command
;; is implemented. if so, we use it to get the message number list.
- (let ((messages (pop3-list process))
- (uidl (if pop3-leave-mail-on-server
- (pop3-get-uidl process))))
- (when messages
- (pop messages)
- (cond
- ((eq pop3-uidl-support t)
- ;; remove elements not in the uidl, this assumes the uidl is short
- (remove-if-not
- (lambda (message) (memq (car message) uidl))
- (reverse messages)))
- (t messages)))))
+ (let* ((messages (pop3-list process))
+ (total (or (pop messages) 0))
+ (uidl (if pop3-leave-mail-on-server
+ (pop3-get-uidl process)))
+ out)
+ (while messages
+ ;; only retrieve messages matching our regexp or in the uidl list
+ (when (and
+ ;; remove elements not in the uidl, this assumes the uidl is short
+ (or (not (eq pop3-uidl-support t))
+ (memq (caar messages) uidl))
+ (caar messages)
+ ;; don't download messages that are too large
+ (not (and pop3-maximum-message-size
+ (> (cdar messages) pop3-maximum-message-size)))
+ (not (and pop3-except-header-regexp
+ (string-match pop3-except-header-regexp
+ (pop3-top process (caar messages) 0)))))
+ (push (car messages) out))
+ (setq messages (cdr messages)))
+ (cons total (reverse out))))
(defun pop3-get-uidl (process)
"Use PROCESS to get a list of unread message numbers."
(defun pop3-save-uidls ()
"Save the updated UIDLs to disk for use next time."
- (when (and pop3-leave-mail-on-server
- pop3-uidl-obarray
- (catch 'found
- (dotimes (i (length pop3-uidl-obarray))
- (if (symbolp (aref pop3-uidl-obarray i))
- (throw 'found t)))))
+ (when (and pop3-leave-mail-on-server
+ ;; UIDL hash table is non-empty
+ (let ((len (length pop3-uidl-obarray)))
+ (while (< 0 len)
+ (setq len (if (symbolp (aref pop3-uidl-obarray (1- len)))
+ -1 (1- len))))
+ (minusp len)))
+ (when (file-readable-p pop3-uidl-file-name)
+ (copy-file pop3-uidl-file-name
+ (concat pop3-uidl-file-name ".old")
+ 'overwrite 'keeptime))
(save-excursion
- (with-temp-buffer
- (when (file-readable-p pop3-uidl-file-name)
- (copy-file pop3-uidl-file-name
- (concat pop3-uidl-file-name ".old")
- 'overwrite 'keeptime))
- (mapatoms
+ (with-temp-file pop3-uidl-file-name
+ (mapatoms
(lambda (atom)
(when (car (symbol-value atom))
(insert (format "%s\n" atom))))
- pop3-uidl-obarray)
- (write-file pop3-uidl-file-name)))))
+ pop3-uidl-obarray)))
+ (fillarray pop3-uidl-obarray 0)))
+
;; The Command Set
(if (not (and response (string-match "+OK" response)))
(pop3-quit process))))
+(static-unless (and (fboundp 'md5) (subrp (symbol-function 'md5)))
+ (eval-and-compile
+ (require 'path-util)
+ (if (module-installed-p 'md5)
+ (progn
+ (autoload 'md5 "md5")
+ (fset 'pop3-md5 'md5))
+
+ (defvar pop3-md5-program "md5"
+ "*Program to encode its input in MD5.")
+
+ (defun pop3-md5 (string)
+ (with-temp-buffer
+ (insert string)
+ (call-process-region (point-min) (point-max)
+ (or shell-file-name "/bin/sh")
+ t (current-buffer) nil
+ "-c" pop3-md5-program)
+ ;; The meaningful output is the first 32 characters.
+ ;; Don't return the newline that follows them!
+ (buffer-substring (point-min) (+ (point-min) 32))))
+ )))
+
(defun pop3-apop (process user)
"Send alternate authentication information to the server."
- (if (not (fboundp 'md5)) (autoload 'md5 "md5"))
- (let ((hash (md5 (concat pop3-timestamp pop3-password))))
- (pop3-send-command process (format "APOP %s %s" user hash))
- (let ((response (pop3-read-response process t)))
- (if (not (and response (string-match "+OK" response)))
- (pop3-quit process)))))
+ (let ((pass pop3-password))
+ (if (and pop3-password-required (not pass))
+ (setq pass
+ (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
+ (if pass
+ (let ((hash (static-if (and (fboundp 'md5)
+ (subrp (symbol-function 'md5)))
+ (md5 (concat pop3-timestamp pass))
+ (pop3-md5 (concat pop3-timestamp pass)))))
+ (pop3-send-command process (format "APOP %s %s" user hash))
+ (let ((response (pop3-read-response process t)))
+ (if (not (and response (string-match "+OK" response)))
+ (pop3-quit process)))))
+ ))
+
+(defun pop3-stls (process)
+ "Query whether TLS extension is supported"
+ (pop3-send-command process "STLS")
+ (let ((response (pop3-read-response process t)))
+ (if (not (and response (string-match "+OK" response)))
+ (pop3-quit process))))
;; TRANSACTION STATE
"Return the number of messages in the maildrop and the maildrop's size."
(pop3-send-command process "STAT")
(let ((response (pop3-read-response process t)))
- (list (string-to-int (nth 1 (split-string response)))
- (string-to-int (nth 2 (split-string response))))
+ (list (string-to-int (nth 1 (split-string response " ")))
+ (string-to-int (nth 2 (split-string response " "))))
))
(defun pop3-retr (process msg crashbuf)
(pop3-send-command process (format "RETR %s" msg))
(pop3-read-response process)
(save-excursion
- (save-restriction
- (apply 'narrow-to-region (pop3-get-extended-response process))
- (pop3-munge-message-separator (point-min) (point-max))
- (append-to-buffer crashbuf (point-min) (point-max))
- (delete-region (point-min) (point-max))
+ (let ((region (pop3-get-extended-response process)))
+ (pop3-munge-message-separator (car region) (cadr region))
+ (append-to-buffer crashbuf (car region) (cadr region))
+ (delete-region (car region) (cadr region))
)))
(defun pop3-dele (process msg)
"Return highest accessed message-id number for the session."
(pop3-send-command process "LAST")
(let ((response (pop3-read-response process t)))
- (string-to-int (nth 1 (split-string response)))
+ (string-to-int (nth 1 (split-string response " ")))
))
(defun pop3-rset (process)
(save-excursion
(set-buffer (process-buffer process))
(goto-char (point-max))
- (delete-process process)
- )))
+ (delete-process process))))
(defun pop3-uidl (process &optional msgno)
"Return the results of a UIDL command in PROCESS for optional MSGNO.
(cons (length pairs) (nreverse pairs))
)))))
+(defun pop3-top (process msgno &optional lines)
+ "Return the top LINES of messages for PROCESS and MSGNO.
+If msgno is invalid, return nil. Otherwise, return a string."
+ (pop3-send-command process (format "TOP %d %d" msgno (or lines 1)))
+ (if (pop3-read-response process t)
+ nil ;; MSGNO is not valid number
+ (save-excursion
+ (apply 'buffer-substring (pop3-get-extended-response process)))
+ ))
+
;;; Utility code
(defun pop3-get-extended-response (process)
;; -ERR [invalid password]
;; -ERR [unable to lock maildrop]
+;; STLS
+;; Arguments: none
+;; Restrictions: authorization state
+;; Possible responses:
+;; +OK [negotiation is ready]
+;; -ERR [security layer is already active]
+
;;; TRANSACTION STATE
;; STAT
;; +OK [scan listing follows]
;; -ERR [no such message]
+;; TOP msg [lines]
+;; Arguments: a message-id (required), number of lines (optional)
+;; Restrictions: transaction state; msg must not be deleted
+;; Possible responses:
+;; +OK [partial message listing follows]
+;; -ERR [no such message]
+
;; UIDL [msg]
;; Arguments: a message-id (optional)
;; Restrictions: transaction state; msg must not be deleted
;; Restrictions: none
;; Possible responses:
;; +OK [TCP connection closed]
+
+(provide 'pop3)
+
+;;; pop3.el ends here
projects / elisp / gnus.git- / blobdiff