Synch to No Gnus 200501120840.
[elisp/gnus.git-] / lisp / pop3.el
index d4a6ae1..833805c 100644 (file)
@@ -77,7 +77,6 @@
   (require 'cl))
 
 (require 'mail-utils)
-(require 'nnheader)
 
 (defgroup pop3 nil
   "Post Office Protocol"
 
 (defcustom pop3-connection-type nil
   "*POP3 connection type."
-  :type 'boolean
+  :type '(choice (const :tag "Not specified" nil)
+                (const tls)
+                (const ssl))
   :group 'pop3)
 
 (defcustom pop3-password-required t
@@ -130,7 +131,14 @@ values are 'apop."
   :group 'pop3)
 
 (defcustom pop3-leave-mail-on-server nil
-  "*Non-nil if the mail is to be left on the POP server after fetching."
+  "*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 "21.4" ;; Oort Gnus
   :type 'boolean
   :group 'pop3)
@@ -142,25 +150,23 @@ Used for APOP authentication.")
 (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" :format "%t: %v\n" :size 0))
+                (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 "%t: %v\n" :size 0))
+                (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 :format "%t: %v\n" :size 0)
+  :type 'file
   :group 'pop3)
 
-(defcustom pop3-uidl-support nil
+(defvar pop3-uidl-support nil
   "Alist of servers and flags of whether they support UIDLs.
-Users don't have to set this value."
-  :type 'boolean
-  :group 'pop3)
+Users don't have to set this value.")
 
 (defvar pop3-uidl-obarray (make-vector 31 0)
   "Uidl hash table.")
@@ -177,18 +183,44 @@ Users don't have to set this value."
       "openssl"
     "ssleay")
   "The program to run in a subprocess to open an SSL connection."
-  :type '(string :format "%t: %v\n" :size 0)
+  :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\n" :size 0))
+  :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")))
@@ -315,7 +347,7 @@ Argument PORT specifies connecting port."
                    (goto-char (point-max))
                    (forward-line -1)
                    (not (looking-at "+OK")))
-         (nnheader-accept-process-output process)
+         (pop3-accept-process-output process)
          (sit-for 1))
        (delete-region (point-min) (point)))
       (and process (memq (process-status process) '(open run))
@@ -371,7 +403,7 @@ Return the response string if optional second argument RETURN is non-nil."
       (goto-char pop3-read-point)
       (while (and (memq (process-status process) '(open run))
                  (not (search-forward "\r\n" nil t)))
-       (nnheader-accept-process-output process)
+       (pop3-accept-process-output process)
        (goto-char pop3-read-point))
       (setq match-end (point))
       (goto-char pop3-read-point)
@@ -732,8 +764,7 @@ If msgno is invalid, return nil.  Otherwise, return a string."
     (set-buffer (process-buffer process))
     (goto-char start)
     (while (not (re-search-forward "^\\.\r\n" nil t))
-      ;; Fixme: Shouldn't depend on nnheader.
-      (nnheader-accept-process-output process)
+      (pop3-accept-process-output process)
       (goto-char start))
     (setq pop3-read-point (point-marker))
     (goto-char (match-beginning 0))