X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=lisp%2Fpop3.el;h=8a43c4755503acb6418e8daa9db405c274db3bce;hb=779dd81d09cb6fa76e6a0fd64147099b7cf0119d;hp=8c4c08fca1c05d45dcc1952cb0f55afac8121370;hpb=0c4b59d3908f205a5942cc34faffe6d3e7bb3250;p=elisp%2Fgnus.git- diff --git a/lisp/pop3.el b/lisp/pop3.el index 8c4c08f..8a43c47 100644 --- a/lisp/pop3.el +++ b/lisp/pop3.el @@ -1,12 +1,15 @@ ;;; pop3.el --- Post Office Protocol (RFC 1460) interface -;; Copyright (C) 1996,97,98 Free Software Foundation, Inc. +;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, +;; 2004, 2005 Free Software Foundation, Inc. ;; Author: Richard L. Pieri -;; Keywords: mail, pop3 -;; Version: 1.3l+ +;; Daiki Ueno +;; Katsumi Yamaoka +;; Maintainer: Volunteers +;; Keywords: mail -;; This file is part of GNU Emacs. +;; This file is part of T-gnus. ;; GNU Emacs is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by @@ -20,8 +23,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs; see the file COPYING. If not, write to the -;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, -;; Boston, MA 02111-1307, USA. +;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. ;;; Commentary: @@ -32,40 +35,197 @@ ;; This program was inspired by Kyle E. Jones's vm-pop program. -;;; Code: +;;; Gnus: + +;; Put something like the following line in your ~/.gnus.el file if +;; you'd like to use this module together with Gnus, not T-gnus. +;; +;;(eval-after-load "mail-source" '(require 'pop3)) +;; +;; There are two ways to install this module; one is to replace +;; pop3.el of the Gnus version with this module when installing Gnus; +;; the other is to replace pop3.el of the Gnus version which has been +;; installed with this module and byte-compile it. + +;; Note: you should not modify the value for the `pop' section of the +;; `mail-source-keyword-map' variable. + +;; This program provides the following features in addition to Gnus: + +;; 1. You can use SSL or STARTTLS stream to connect to mail servers. +;; For example, specify the `:connection' keyword and the value pair +;; in a mail-source as follows: +;; +;;(setq mail-sources '((pop :server "pop3.mail.server" :port 995 +;; :connection ssl :authentication apop))) +;; +;; For STARTTLS stream, use `tls' isntead of `ssl'. The default +;; connection type is defined by `pop3-connection-type' which +;; defaults to nil. + +;; 2. You can fetch mails without deleting them in mail servers. To do +;; that, specify the `:leave' keyword with the value t as follows: +;; +;;(setq mail-sources '((pop :server "pop3.mail.server" :leave t))) +;; +;; Already read mails are registered into the ~/.uidls-SERVER file +;; (which is the default, see `pop3-uidl-file-name'), and you will +;; never need to fetch them twice. The default value for the +;; `:leave' keyword is specified by the `pop3-leave-mail-on-server' +;; variable. You have no need to modify that value normally. + +;; 3. See the source code for some other miscellaneous extended features. -(require 'mail-utils) -(provide 'pop3) +;;; Code: -(defconst pop3-version "1.3l+") +(eval-when-compile + (require 'cl)) -(defvar pop3-maildrop (or (user-login-name) (getenv "LOGNAME") (getenv "USER") nil) - "*POP3 maildrop.") -(defvar pop3-mailhost (or (getenv "MAILHOST") nil) - "*POP3 mailhost.") -(defvar pop3-port 110 - "*POP3 port.") +(require 'mail-utils) -(defvar pop3-password-required t - "*Non-nil if a password is required when connecting to POP server.") +(defgroup pop3 nil + "Post Office Protocol." + :group 'mail + :group 'mail-source) + +(defcustom pop3-maildrop (or (user-login-name) + (getenv "LOGNAME") + (getenv "USER")) + "*POP3 maildrop." + :version "22.1" ;; Oort Gnus + :type 'string + :group 'pop3) + +(defcustom pop3-mailhost (or (getenv "MAILHOST") ;; nil -> mismatch + "pop3") + "*POP3 mailhost." + :version "22.1" ;; Oort Gnus + :type 'string + :group 'pop3) + +(defcustom pop3-port 110 + "*POP3 port." + :version "22.1" ;; Oort Gnus + :type 'number + :group 'pop3) + +(defcustom pop3-connection-type nil + "*POP3 connection type." + :type '(choice (const :tag "Not specified" nil) + (const tls) + (const ssl)) + :group 'pop3) + +(defcustom pop3-password-required t + "*Non-nil if a password is required when connecting to POP server." + :version "22.1" ;; Oort Gnus + :type 'boolean + :group 'pop3) + +;; Should this be customizable? (defvar pop3-password nil "*Password to use when connecting to POP server.") -(defvar pop3-authentication-scheme 'pass +(defcustom pop3-authentication-scheme 'pass "*POP3 authentication scheme. -Defaults to 'pass, for the standard USER/PASS authentication. Other valid -values are 'apop.") +Defaults to `pass', for the standard USER/PASS authentication. The other +valid value is 'apop'." + :type '(choice (const :tag "Normal user/password" pass) + (const :tag "APOP" apop)) + :version "22.1" ;; Oort Gnus + :group 'pop3) + +(defcustom pop3-leave-mail-on-server nil + "*Non-nil if the mail is to be left on the POP server after fetching. + +If `pop3-leave-mail-on-server' is non-nil the mail is to be left +on the POP server after fetching. Note that POP servers maintain +no state information between sessions, so what the client +believes is there and what is actually there may not match up. +If they do not, then the whole thing can fall apart and leave you +with a corrupt mailbox." + :version "22.1" ;; Oort Gnus + :type 'boolean + :group 'pop3) (defvar pop3-timestamp nil "Timestamp returned when initially connected to the POP server. Used for APOP authentication.") -(defvar pop3-movemail-file-coding-system 'binary - "Crashbox made by pop3-movemail with this coding system.") +(defcustom pop3-maximum-message-size nil + "If non-nil only download messages smaller than this." + :type '(choice (const :tag "Unlimited" nil) + (integer :tag "Maximum size")) + :group 'pop3) + +(defcustom pop3-except-header-regexp nil + "If non-nil we do not retrieve messages whose headers are matching this regexp." + :type '(choice (const :tag "Retrieve any messages" nil) + (regexp :format "\n%t: %v")) + :group 'pop3) + +(defcustom pop3-uidl-file-name "~/.uidls" + "File in which to store the UIDL of processed messages." + :type 'file + :group 'pop3) + +(defvar pop3-uidl-support nil + "Alist of servers and flags of whether they support UIDLs. +Users don't have to set this value.") + +(defvar pop3-uidl-obarray (make-vector 31 0) + "Uidl hash table.") (defvar pop3-read-point nil) (defvar pop3-debug nil) +(eval-and-compile + (autoload 'starttls-open-stream "starttls") + (autoload 'starttls-negotiate "starttls")) + +(defcustom pop3-ssl-program-name + (if (executable-find "openssl") + "openssl" + "ssleay") + "The program to run in a subprocess to open an SSL connection." + :type 'string + :group 'pop3) + +(defcustom pop3-ssl-program-arguments + '("s_client" "-quiet") + "Arguments to be passed to the program `pop3-ssl-program-name'." + :type '(repeat (string :format "%v")) + :group 'pop3) + +(defun pop3-progress-message (format percent &rest args) + (apply (function message) format args)) + +;; Borrowed from nnheader-accept-process-output in nnheader.el. +(defvar pop3-read-timeout + (if (string-match "windows-nt\\|os/2\\|emx\\|cygwin" + (symbol-name system-type)) + ;; http://thread.gmane.org/v9655t3pjo.fsf@marauder.physik.uni-ulm.de + ;; + ;; IIRC, values lower than 1.0 didn't/don't work on Windows/DOS. + ;; + ;; There should probably be a runtime test to determine the timing + ;; resolution, or a primitive to report it. I don't know off-hand + ;; what's possible. Perhaps better, maybe the Windows/DOS primitive + ;; could round up non-zero timeouts to a minimum of 1.0? + 1.0 + 0.1) + "How long pop3 should wait between checking for the end of output. +Shorter values mean quicker response, but are more CPU intensive.") + +;; Borrowed from nnheader-accept-process-output in nnheader.el. +(defun pop3-accept-process-output (process) + (accept-process-output + process + (truncate pop3-read-timeout) + (truncate (* (- pop3-read-timeout + (truncate pop3-read-timeout)) + 1000)))) + (defun pop3-movemail (&optional crashbox) "Transfer contents of a maildrop to the specified CRASHBOX." (or crashbox (setq crashbox (expand-file-name "~/.crashbox"))) @@ -74,58 +234,175 @@ Used for APOP authentication.") (n 1) message-count (pop3-password pop3-password) - ) + (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 + (if (and pop3-password-required (not pop3-password)) + (setq pop3-password + (read-passwd (format "Password for %s: " pop3-maildrop)))) + (cond ((equal 'apop pop3-authentication-scheme) + (pop3-apop process pop3-maildrop)) + ((equal 'pass pop3-authentication-scheme) + (pop3-user process pop3-maildrop) + (pop3-pass process)) + (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 (cdr messages))) + (message "Retrieving message list...%d of %d unread" + message-count (pop messages)) + (unwind-protect + (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 + (let ((coding-system-for-write 'binary) + jka-compr-compression-info-list jam-zcat-filename-list) + (write-region (point-min) (point-max) + 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 "Deleting message %d of %d from %s..." + n message-count pop3-mailhost) + (pop3-dele process n)))) + (pop3-quit process)) + (kill-buffer crashbuf) + message-count)) + +(defun pop3-get-message-count () + "Return the number of messages in the maildrop." + (let* ((process (pop3-open-server pop3-mailhost pop3-port)) + message-count + (pop3-password pop3-password)) ;; for debugging only (if pop3-debug (switch-to-buffer (process-buffer process))) ;; query for password (if (and pop3-password-required (not pop3-password)) (setq pop3-password - (pop3-read-passwd (format "Password for %s: " pop3-maildrop)))) + (read-passwd (format "Password for %s: " pop3-maildrop)))) (cond ((equal 'apop pop3-authentication-scheme) (pop3-apop process pop3-maildrop)) ((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"))) (setq message-count (car (pop3-stat process))) - (while (<= n message-count) - (message (format "Retrieving message %d of %d from %s..." - n message-count pop3-mailhost)) - (pop3-retr process n crashbuf) - (save-excursion - (set-buffer crashbuf) - (let ((coding-system-for-write pop3-movemail-file-coding-system)) - (append-to-file (point-min) (point-max) crashbox)) - (set-buffer (process-buffer process)) - (while (> (buffer-size) 5000) - (goto-char (point-min)) - (forward-line 50) - (delete-region (point-min) (point)))) - (pop3-dele process n) - (setq n (+ 1 n)) - (if pop3-debug (sit-for 1) (sit-for 0.1)) - ) (pop3-quit process) - (kill-buffer crashbuf) - ) - ) + message-count)) + +(defcustom pop3-stream-type nil + "*Transport security type for POP3 connexions. +This may be either nil (plain connexion), `ssl' (use an +SSL/TSL-secured stream) or `starttls' (use the starttls mechanism +to turn on TLS security after opening the stream). However, if +this is nil, `ssl' is assumed for connexions to port +995 (pop3s)." + :version "23.0" ;; No Gnus + :group 'pop3 + :type '(choice (const :tag "Plain" nil) + (const :tag "SSL/TLS" ssl) + (const starttls))) (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) - (coding-system-for-read 'binary)) + "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) + (set-buffer (get-buffer-create (concat " trace of POP session to " + mailhost))) (erase-buffer) - (setq process (open-network-stream "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))))) + (setq pop3-read-point (point-min)) + (setq + process + (cond + ((or (eq pop3-connection-type 'ssl) + (eq pop3-stream-type 'ssl) + (and (not pop3-stream-type) (member port '(995 "pop3s")))) + ;; gnutls-cli, openssl don't accept service names + (if (or (equal port "pop3s") + (null port)) + (setq port 995)) + (pop3-open-ssl-stream "POP" (current-buffer) mailhost port)) + ((or (memq pop3-connection-type '(tls starttls)) + (memq pop3-stream-type '(tls starttls))) + ;; gnutls-cli, openssl don't accept service names + (if (equal port "pop3") + (setq port 110)) + (pop3-open-tls-stream "POP" (current-buffer) + mailhost (or port 110))) + (t + (let ((coding-system-for-read 'binary) + (coding-system-for-write 'binary)) + (open-network-stream "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))) + +(eval-when-compile + (autoload 'open-ssl-stream "ssl")) + +(defun pop3-open-ssl-stream-1 (name buffer host service extra-arg) + (require 'ssl) + (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))) + (when process + ;; There's a load of info printed that needs deleting. + (with-current-buffer buffer + (goto-char (point-min)) + (while (and (memq (process-status process) '(open run)) + (goto-char (point-max)) + (forward-line -1) + (not (looking-at "+OK"))) + (pop3-accept-process-output process) + (sit-for 1)) + (delete-region (point-min) (point))) + (and process (memq (process-status process) '(open run)) + process)))) + +(defun pop3-open-ssl-stream (name buffer host service) + "Open a SSL connection for a service to a host. +Returns a subprocess-object to represent the connection. +Args are NAME BUFFER HOST SERVICE." + (let (selective-display ;; Disable ^M to nl translation. + (coding-system-for-read 'binary) + (coding-system-for-write 'binary)) + (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* (selective-display ;; Disable ^M to nl translation. + (coding-system-for-read 'binary) + (coding-system-for-write 'binary) + (process (starttls-open-stream name buffer host service))) + (pop3-stls process) + (starttls-negotiate process) process)) ;; Support functions @@ -137,27 +414,26 @@ Returns the process associated with the connection." (insert output))) (defun pop3-send-command (process command) - (set-buffer (process-buffer process)) - (goto-char (point-max)) -;; (if (= (aref command 0) ?P) -;; (insert "PASS \r\n") -;; (insert command "\r\n")) - (setq pop3-read-point (point)) - (goto-char (point-max)) - (process-send-string process command) - (process-send-string process "\r\n") - ) + (set-buffer (process-buffer process)) + (goto-char (point-max)) + ;; (if (= (aref command 0) ?P) + ;; (insert "PASS \r\n") + ;; (insert command "\r\n")) + (setq pop3-read-point (point)) + (goto-char (point-max)) + (process-send-string process (concat command "\r\n"))) (defun pop3-read-response (process &optional return) - "Read the response from the server. -Return the response string if optional second argument is non-nil." + "Read the response from the server PROCESS. +Return the response string if optional second argument RETURN is non-nil." (let ((case-fold-search nil) match-end) (save-excursion (set-buffer (process-buffer process)) (goto-char pop3-read-point) - (while (not (search-forward "\r\n" nil t)) - (accept-process-output process 3) + (while (and (memq (process-status process) '(open run)) + (not (search-forward "\r\n" nil t))) + (pop3-accept-process-output process) (goto-char pop3-read-point)) (setq match-end (point)) (goto-char pop3-read-point) @@ -168,33 +444,7 @@ Return the response string if optional second argument is non-nil." (setq pop3-read-point match-end) (if return (buffer-substring (point) match-end) - t) - ))))) - -(defun pop3-string-to-list (string &optional regexp) - "Chop up a string into a list." - (let ((list) - (regexp (or regexp " ")) - (string (if (string-match "\r" string) - (substring string 0 (match-beginning 0)) - string))) - (store-match-data nil) - (while string - (if (string-match regexp string) - (setq list (cons (substring string 0 (- (match-end 0) 1)) list) - string (substring string (match-end 0))) - (setq list (cons string list) - string nil))) - (nreverse list))) - -(defvar pop3-read-passwd nil) -(defun pop3-read-passwd (prompt) - (if (not pop3-read-passwd) - (if (load "passwd" t) - (setq pop3-read-passwd 'read-passwd) - (autoload 'ange-ftp-read-passwd "ange-ftp") - (setq pop3-read-passwd 'ange-ftp-read-passwd))) - (funcall pop3-read-passwd prompt)) + t)))))) (defun pop3-clean-region (start end) (setq end (set-marker (make-marker) end)) @@ -203,33 +453,65 @@ Return the response string if optional second argument is non-nil." (while (and (< (point) end) (search-forward "\r\n" end t)) (replace-match "\n" t t)) (goto-char start) + (while (re-search-forward "\n\n\\(From \\)" end t) + (replace-match "\n\n>\\1" t nil)) + (goto-char start) (while (and (< (point) end) (re-search-forward "^\\." end t)) (replace-match "" t t) (forward-char))) (set-marker end nil)) +(eval-when-compile (defvar parse-time-months)) + +;; Copied from message-make-date. +(defun pop3-make-date (&optional now) + "Make a valid date header. +If NOW, use that time instead." + (require 'parse-time) + (let* ((now (or now (current-time))) + (zone (nth 8 (decode-time now))) + (sign "+")) + (when (< zone 0) + (setq sign "-") + (setq zone (- zone))) + (concat + (format-time-string "%d" now) + ;; The month name of the %b spec is locale-specific. Pfff. + (format " %s " + (capitalize (car (rassoc (nth 4 (decode-time now)) + parse-time-months)))) + (format-time-string "%Y %H:%M:%S " now) + ;; We do all of this because XEmacs doesn't have the %z spec. + (format "%s%02d%02d" sign (/ zone 3600) (/ (% zone 3600) 60))))) + (defun pop3-munge-message-separator (start end) "Check to see if a message separator exists. If not, generate one." - (if (not (fboundp 'message-make-date)) (autoload 'message-make-date "message")) (save-excursion (save-restriction (narrow-to-region start end) (goto-char (point-min)) (if (not (or (looking-at "From .?") ; Unix mail (looking-at "\001\001\001\001\n") ; MMDF - (looking-at "BABYL OPTIONS:") ; Babyl - )) - (let ((from (mail-strip-quoted-names (mail-fetch-field "From"))) - (date (pop3-string-to-list (or (mail-fetch-field "Date") - (message-make-date)))) - (From_)) + (looking-at "BABYL OPTIONS:"))) ; Babyl + (let* ((from (mail-strip-quoted-names (mail-fetch-field "From"))) + (tdate (mail-fetch-field "Date")) + (date (split-string (or (and tdate + (not (string= "" tdate)) + tdate) + (pop3-make-date)) + " ")) + (From_)) ;; sample date formats I have seen ;; Date: Tue, 9 Jul 1996 09:04:21 -0400 (EDT) ;; Date: 08 Jul 1996 23:22:24 -0400 ;; should be ;; Tue Jul 9 09:04:21 1996 + + ;; Fixme: This should use timezone on the date field contents. (setq date - (cond ((string-match "[A-Z]" (nth 0 date)) + (cond ((not date) + "Tue Jan 1 00:00:0 1900") + ((string-match "[A-Z]" (nth 0 date)) (format "%s %s %s %s %s" (nth 0 date) (nth 2 date) (nth 1 date) (nth 4 date) (nth 3 date))) @@ -238,14 +520,111 @@ Return the response string if optional second argument is non-nil." ;; like writing a date to day converter. (format "Sun %s %s %s %s" (nth 1 date) (nth 0 date) - (nth 3 date) (nth 2 date))) - )) + (nth 3 date) (nth 2 date))))) (setq From_ (format "\nFrom %s %s\n" from date)) (while (string-match "," From_) (setq From_ (concat (substring From_ 0 (match-beginning 0)) (substring From_ (match-end 0))))) (goto-char (point-min)) - (insert From_)))))) + (insert From_) + (if (search-forward "\n\n" nil t) + nil + (goto-char (point-max)) + (insert "\n")) + (narrow-to-region (point) (point-max)) + (let ((size (- (point-max) (point-min)))) + (goto-char (point-min)) + (widen) + (forward-line -1) + (insert (format "Content-Length: %s\n" size)))))))) + +;; UIDL support + +(defun pop3-get-message-numbers (process) + "Get the list of message numbers and lengths to retrieve via PROCESS." + ;; 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)) + (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 (and pop3-leave-mail-on-server + (cdr (assoc pop3-mailhost pop3-uidl-support)))) + (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 (nreverse out)))) + +(defun pop3-get-uidl (process) + "Use PROCESS to get a list of unread message numbers." + (let ((messages (pop3-uidl process)) + (support (assoc pop3-mailhost pop3-uidl-support)) + uidl) + (if support + (setcdr support (and messages t)) + (push (cons pop3-mailhost (and messages t)) + pop3-uidl-support)) + (when messages + (save-excursion + (with-temp-buffer + (when (file-readable-p pop3-uidl-file-name) + (insert-file-contents pop3-uidl-file-name)) + (goto-char (point-min)) + (while (looking-at "\\([^ \n\t]+\\)") + (set (intern (match-string 1) pop3-uidl-obarray) + (cons nil t)) + (forward-line 1)))) + (dolist (message (cdr messages)) + (if (setq uidl (intern-soft (cdr message) pop3-uidl-obarray)) + (setcar (symbol-value uidl) (car message)) + (set (intern (cdr message) pop3-uidl-obarray) + (cons (car message) nil)))) + (pop3-get-unread-message-numbers)))) + +(defun pop3-get-unread-message-numbers () + "Return a sorted list of unread msg numbers to retrieve." + (let (nums) + (mapatoms (lambda (atom) + (if (not (cdr (symbol-value atom))) + (push (car (symbol-value atom)) nums))) + pop3-uidl-obarray) + (sort nums '<))) + +(defun pop3-save-uidls () + "Save the updated UIDLs to disk for use next time." + (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-file pop3-uidl-file-name + (mapatoms + (lambda (atom) + (when (car (symbol-value atom)) + (insert (format "%s\n" atom)))) + pop3-uidl-obarray))) + (fillarray pop3-uidl-obarray 0))) + ;; The Command Set @@ -256,7 +635,7 @@ Return the response string if optional second argument is non-nil." (pop3-send-command process (format "USER %s" user)) (let ((response (pop3-read-response process t))) (if (not (and response (string-match "+OK" response))) - (error (format "USER %s not valid." user))))) + (error "USER %s not valid" user)))) (defun pop3-pass (process) "Send authentication information to the server." @@ -267,12 +646,25 @@ Return the response string if optional second argument is non-nil." (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 + (read-passwd (format "Password for %s: " pop3-maildrop)))) + (if pass + ;; Note that `md5' should never encode a given string to use for + ;; the apop authentication, so we should specify `binary'. + (let ((hash (md5 (concat pop3-timestamp pass) nil nil 'binary))) + (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 @@ -280,54 +672,18 @@ Return the response string if optional second argument is non-nil." "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 (pop3-string-to-list response))) - (string-to-int (nth 2 (pop3-string-to-list response)))) - )) - -(defun pop3-list (process &optional msg) - "Scan listing of available messages. -This function currently does nothing.") + (list (string-to-number (nth 1 (split-string response " "))) + (string-to-number (nth 2 (split-string response " ")))))) (defun pop3-retr (process msg crashbuf) "Retrieve message-id MSG to buffer CRASHBUF." (pop3-send-command process (format "RETR %s" msg)) (pop3-read-response process) - (let ((start pop3-read-point) end) - (save-excursion - (set-buffer (process-buffer process)) - (while (not (re-search-forward "^\\.\r\n" nil t)) - (accept-process-output process 3) - ;; bill@att.com ... to save wear and tear on the heap - ;; uncommented because the condensed version below is a problem for - ;; some. - (if (> (buffer-size) 20000) (sleep-for 1)) - (if (> (buffer-size) 50000) (sleep-for 1)) - (if (> (buffer-size) 100000) (sleep-for 1)) - (if (> (buffer-size) 200000) (sleep-for 1)) - (if (> (buffer-size) 500000) (sleep-for 1)) - ;; bill@att.com - ;; condensed into: - ;; (sometimes causes problems for really large messages.) -; (if (> (buffer-size) 20000) (sleep-for (/ (buffer-size) 20000))) - (goto-char start)) - (setq pop3-read-point (point-marker)) -;; this code does not seem to work for some POP servers... -;; and I cannot figure out why not. -; (goto-char (match-beginning 0)) -; (backward-char 2) -; (if (not (looking-at "\r\n")) -; (insert "\r\n")) -; (re-search-forward "\\.\r\n") - (goto-char (match-beginning 0)) - (setq end (point-marker)) - (pop3-clean-region start end) - (pop3-munge-message-separator start end) - (save-excursion - (set-buffer crashbuf) - (erase-buffer)) - (copy-to-buffer crashbuf start end) - (delete-region start end) - ))) + (save-excursion + (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) "Mark message-id MSG as deleted." @@ -343,8 +699,7 @@ This function currently does nothing.") "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 (pop3-string-to-list response))) - )) + (string-to-number (nth 1 (split-string response " "))))) (defun pop3-rset (process) "Remove all delete marks from current maildrop." @@ -359,11 +714,113 @@ Tell server to remove all messages marked as deleted, unlock the maildrop, and close the connection." (pop3-send-command process "QUIT") (pop3-read-response process t) - (if process + (when process + (save-excursion + (set-buffer (process-buffer process)) + (goto-char (point-max)) + (delete-process process)))) + +(defun pop3-uidl (process &optional msgno) + "Return the results of a UIDL command in PROCESS for optional MSGNO. +If UIDL is unsupported on this mail server or if msgno is invalid, return nil. +Otherwise, return a list in the form + + (N (1 UIDL-1) (2 UIDL-2) ... (N UIDL-N)) + +where + + N is an integer for the number of UIDLs returned (could be 0) + UIDL-n is a string." + + (if msgno + (pop3-send-command process (format "UIDL %d" msgno)) + (pop3-send-command process "UIDL")) + + (if (null (pop3-read-response process t)) + nil ;; UIDL is not supported on this server + (let (pairs uidl) + (save-excursion + (save-restriction + (apply 'narrow-to-region (pop3-get-extended-response process)) + (goto-char (point-min)) + (while (looking-at "\\([^ \n\t]*\\) \\([^ \n\t]*\\)") + (setq msgno (string-to-number (match-string 1)) + uidl (match-string 2)) + (push (cons msgno uidl) pairs) + (beginning-of-line 2)) + (cons (length pairs) (nreverse pairs))))))) + +(defun pop3-list (process &optional msgno) + "Return the results of a LIST command for PROCESS and optional MSGNO. +If (optional) msgno is invalid, return nil. Otherwise, return a list +in the form + + (N (1 LEN-1) (2 LEN-2) ... (N LEN-N)) + +where + + N is an integer for the number of msg/len pairs (could be 0) + LEN-n is an integer." + (if msgno + (pop3-send-command process (format "LIST %d" msgno)) + (pop3-send-command process "LIST")) + + (if (null (pop3-read-response process t)) + nil ;; MSGNO is not valid number + (let (pairs len) (save-excursion - (set-buffer (process-buffer process)) - (goto-char (point-max)) - (delete-process process)))) + (save-restriction + (apply 'narrow-to-region (pop3-get-extended-response process)) + (goto-char (point-min)) + (while (looking-at "\\([^ \n\t]*\\) \\([^ \n\t]*\\)") + (setq msgno (string-to-number (match-string 1)) + len (string-to-number (match-string 2))) + (push (cons msgno len) pairs) + (beginning-of-line 2)) + (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) + "Get the extended pop3 response in the PROCESS buffer." + (let ((start pop3-read-point) end) + (set-buffer (process-buffer process)) + (goto-char start) + (while (not (re-search-forward "^\\.\r\n" nil t)) + (pop3-accept-process-output process) + (goto-char start)) + (setq pop3-read-point (point-marker)) + (goto-char (match-beginning 0)) + (setq end (point-marker)) + (pop3-clean-region start end) + (list start end))) + +;;; Advise the mail-source function in order to use this module in Gnus. + +(eval-after-load "mail-source" + '(if (member '(:connection) + (assq 'pop (symbol-value 'mail-source-keyword-map))) + nil ;; T-gnus is running. + (defadvice mail-source-fetch-pop (around bind-t-gnus-keywords activate) + "Bind `pop3-connection-type' and `pop3-leave-mail-on-server' according +to `mail-sources' while fetching mails with Gnus." + (let ((pop3-connection-type (or (plist-get (cdr (ad-get-arg 0)) + :connection) + pop3-connection-type)) + (pop3-leave-mail-on-server (or (plist-get (cdr (ad-get-arg 0)) + :leave) + pop3-leave-mail-on-server))) + ad-do-it)))) + ;; Summary of POP3 (Post Office Protocol version 3) commands and responses @@ -390,6 +847,20 @@ and close the connection." ;; -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] + +;; STLS (RFC 2595) +;; Arguments: none +;; Restrictions: Only permitted in AUTHORIZATION state. +;; Possible responses: +;; +OK +;; -ERR + ;;; TRANSACTION STATE ;; STAT @@ -405,6 +876,20 @@ and close the connection." ;; +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 +;; Possible responses: +;; +OK [uidl listing follows] +;; -ERR [no such message] + ;; RETR msg ;; Arguments: a message-id (required) ;; Restrictions: transaction state; msg must not be deleted @@ -444,3 +929,7 @@ and close the connection." ;; Restrictions: none ;; Possible responses: ;; +OK [TCP connection closed] + +(provide 'pop3) + +;;; pop3.el ends here