Merge following change from main trunk.
[elisp/wanderlust.git] / elmo / elmo-vars.el
index 1389b5c..7d6d0e7 100644 (file)
@@ -1,4 +1,4 @@
-;;; elmo-vars.el -- User variables for ELMO.
+;;; elmo-vars.el --- User variables for ELMO.
 
 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
 
 ;;
 
 ;;; Commentary:
-;; 
+;;
 
 ;;; Code:
-;; 
+;;
 (require 'poe)
 
 ;; silence byte compiler
 (defgroup elmo nil
   "ELMO, Elisp Library for Message Orchestration."
   :tag "ELMO"
+  :prefix "elmo-"
   :group 'news
   :group 'mail)
 
-;; NNTP
-(defvar elmo-default-nntp-server  "localhost"
-  "*Default NNTP server.")
-(defvar elmo-default-nntp-user nil
-  "*Default User of NNTP.  nil means no user authentication.")
-(defvar elmo-default-nntp-port 119
-  "*Default Port number of NNTP.")
-(defvar elmo-default-nntp-stream-type nil
-  "*Default stream type for NNTP.
-Any symbol value of `elmo-network-stream-type-alist'.")
-(defvar elmo-nntp-stream-type-alist nil
-  "*Stream bindings for NNTP.
-This is taken precedence over `elmo-network-stream-type-alist'.")
+(defgroup elmo-setting nil
+  "ELMO common settings."
+  :prefix "elmo-"
+  :group 'elmo)
 
 ;; Local
-(defvar elmo-localdir-folder-path "~/Mail"
-  "*Local mail folder path.")
 (defvar elmo-localnews-folder-path "~/News"
   "*Local news folder path.")
 (defvar elmo-maildir-folder-path "~/Maildir"
@@ -66,7 +56,10 @@ This is taken precedence over `elmo-network-stream-type-alist'.")
   "*All Folders that match this list will be treated as Maildir.
 Each elements are regexp of folder name (This is obsolete).")
 
-(defvar elmo-msgdb-dir "~/.elmo"
+(defvar elmo-msgdb-file-header-chop-length 2048
+  "*Number of bytes to get header in one reading from file.")
+
+(defvar elmo-msgdb-directory "~/.elmo"
   "*ELMO Message Database path.")
 (defvar elmo-passwd-alist-file-name "passwd"
   "*ELMO Password filename.")
@@ -82,8 +75,127 @@ Each elements are regexp of folder name (This is obsolete).")
   "A hook called when message is deleted from database.")
 (defvar elmo-nntp-post-pre-hook nil
   "A hook called just before the nntp posting.")
-(defvar elmo-lang "ja"
-  "Language for displayed messages.")
+
+;;; IMAP4
+
+(defcustom elmo-imap4-default-mailbox "inbox"
+  "*Default IMAP4 mailbox."
+  :type 'string
+  :group 'elmo
+  :group 'elmo-setting)
+
+(defcustom elmo-imap4-default-server "localhost"
+  "*Default IMAP4 server."
+  :type 'string
+  :group 'elmo
+  :group 'elmo-setting)
+
+(defcustom elmo-imap4-default-authenticate-type 'login
+  "*Default Authentication type for IMAP4."
+  :type 'symbol
+  :group 'elmo)
+
+(defcustom elmo-imap4-default-user (or (getenv "USER")
+                                      (getenv "LOGNAME")
+                                      (user-login-name))
+  "*Default username for IMAP4."
+  :type 'string
+  :group 'elmo
+  :group 'elmo-setting)
+
+(defcustom elmo-imap4-default-port 143
+  "*Default Port number of IMAP."
+  :type 'integer
+  :group 'elmo
+  :group 'elmo-setting)
+
+(defcustom elmo-imap4-default-stream-type nil
+  "*Default stream type for IMAP4.
+Any symbol value of `elmo-network-stream-type-alist' or
+`elmo-imap4-stream-type-alist'."
+  :type 'symbol
+  :group 'elmo)
+
+(defvar elmo-imap4-stream-type-alist nil
+  "*Stream bindings for IMAP4.
+This is taken precedence over `elmo-network-stream-type-alist'.")
+
+;;; NNTP
+
+;; User options
+(defcustom elmo-nntp-default-server "localhost"
+  "*Default NNTP server."
+  :type 'string
+  :group 'elmo
+  :group 'elmo-setting)
+
+(defcustom elmo-nntp-default-user nil
+  "*Default User of NNTP.  nil means no user authentication."
+  :type '(choice (const nil)
+                string)
+  :group 'elmo
+  :group 'elmo-setting)
+
+(defcustom elmo-nntp-default-port 119
+  "*Default Port number of NNTP."
+  :type 'integer
+  :group 'elmo
+  :group 'elmo-setting)
+
+(defcustom elmo-nntp-default-stream-type nil
+  "*Default stream type for NNTP.
+Any symbol value of `elmo-network-stream-type-alist' or
+`elmo-nntp-stream-type-alist'."
+  :type 'symbol
+  :group 'elmo)
+
+(defvar elmo-nntp-stream-type-alist nil
+  "*Stream bindings for NNTP.
+This is taken precedence over `elmo-network-stream-type-alist'.")
+
+;;; POP3
+
+;; POP3
+(defcustom elmo-pop3-default-user (or (getenv "USER")
+                                     (getenv "LOGNAME")
+                                     (user-login-name))
+  "*Default username for POP3."
+  :type 'string
+  :group 'elmo
+  :group 'elmo-setting)
+
+(defcustom elmo-pop3-default-server  "localhost"
+  "*Default POP3 server."
+  :type 'string
+  :group 'elmo
+  :group 'elmo-setting)
+
+(defcustom elmo-pop3-default-authenticate-type 'user
+  "*Default Authentication type for POP3."
+  :type 'symbol
+  :group 'elmo)
+
+(defcustom elmo-pop3-default-port 110
+  "*Default POP3 port."
+  :type 'integer
+  :group 'elmo
+  :group 'elmo-setting)
+
+(defcustom elmo-pop3-default-stream-type nil
+  "*Default stream type for POP3.
+Any symbol value of `elmo-network-stream-type-alist' or
+`elmo-pop3-stream-type-alist'."
+  :type 'symbol
+  :group 'elmo)
+
+(defvar elmo-pop3-stream-type-alist nil
+  "*Stream bindings for POP3.
+This is taken precedence over `elmo-network-stream-type-alist'.")
+
+(defcustom elmo-lang "ja"
+  "Language for displayed messages."
+  :type 'string
+  :group 'elmo-setting)
 
 (defvar elmo-mime-charset 'iso-2022-jp)
 
@@ -104,11 +216,6 @@ Each elements are regexp of folder name (This is obsolete).")
   "Folder list cache (for access folder).")
 (defvar elmo-msgdb-finfo-filename "finfo"
   "Folder information cache...list of '(filename . '(new unread all)).")
-(defvar elmo-msgdb-append-list-filename "append"
-  "Appended messages...Structure is same as number-alist.
-For disconnected operations.")
-(defvar elmo-msgdb-resume-list-filename "resume"
-  "Resumed messages.  For disconnected operations.")
 (defvar elmo-msgdb-lock-list-filename "lock"
   "Locked messages...list of message-id.
 For disconnected operations.")
@@ -128,16 +235,9 @@ For disconnected operations.")
 (defvar elmo-msgdb-extra-fields nil
   "Extra fields for msgdb.")
 
-(defvar elmo-queue-filename "queue"
-  "*IMAP pending event queue is saved in this file.")
-(defvar elmo-enable-disconnected-operation nil
+(defvar elmo-enable-disconnected-operation t
   "*Enable disconnected operations.")
 
-(defvar elmo-nntp-overview-fetch-chop-length 200
- "*Number of overviews to fetch in one request in nntp.")
-(defvar elmo-localdir-header-chop-length 2048
-  "*Number of bytes to get header in one reading from file.")
-
 (defvar elmo-auto-change-plugged 600
   "*Time to expire change plugged state automatically, as the number of seconds.
 Don't change plugged state automatically if nil.")
@@ -163,15 +263,12 @@ If function, return value of function.")
 (defvar elmo-path-sep "/"
   "*Path separator.")
 (defvar elmo-plugged t)
-(defvar elmo-use-semi nil)
+
 (defvar elmo-no-subject "(No Subject in original.)"
   "*A string used when no subject field exists.")
 (defvar elmo-no-from "nobody@nowhere?"
   "*A string used when no from field exists.")
 
-(defvar elmo-multi-divide-number 100000
-  "*Multi divider number.")
-
 ;; database dynamic linking
 (defvar elmo-database-dl-module
   (expand-file-name "database.so" exec-directory))
@@ -195,7 +292,7 @@ If function, return value of function.")
                              ;; static/dl-database
                              (fboundp 'open-database)))
 
-(defvar elmo-date-match (not (boundp 'nemacs-version))
+(defvar elmo-date-match t
   "Date match is available or not.")
 
 (defvar elmo-network-stream-type-alist
@@ -224,14 +321,9 @@ Arguments for this function are NAME, BUFFER, HOST and SERVICE.")
 
 (defvar elmo-cache-expire-default-age 50
   "Cache expiration age (days).")
-(defvar elmo-cache-dirname "cache"
-  "Directory name for cache storage.")
 
-(defvar elmo-use-buffer-cache t
-  "Use buffer cache.")
-
-(defvar elmo-buffer-cache-size 10
-  "*Number of buffer for message cache.")
+(defvar elmo-cache-directory (expand-file-name "cache" elmo-msgdb-directory)
+  "Directory name for cache storage.")
 
 (defvar elmo-pack-number-check-strict t
   "Pack number strictly.")
@@ -260,23 +352,6 @@ Arguments for this function are NAME, BUFFER, HOST and SERVICE.")
     ("/"  . " s")
     ("\\" . " b")))
 
-(defvar elmo-nntp-use-cache t
-  "Use cache in nntp folder.")
-
-(defvar elmo-pop3-use-cache t
-  "Use cache in pop3 folder.")
-
-(defvar elmo-localdir-lockfile-list nil)
-
-(defvar elmo-nntp-max-number-precedes-list-active nil
-  "Non-nil means max number of msgdb is set as the max number of `list active'.
-(Needed for inn 2.3 or later?).")
-
-(defvar elmo-pop3-send-command-synchronously nil
-  "If non-nil, commands are send synchronously.
-If server doesn't accept asynchronous commands, this variable should be
-set as non-nil.")
-
 (defvar elmo-hash-minimum-size 1023
   "Minimum size of hash table.")
 
@@ -292,6 +367,18 @@ set as non-nil.")
 (defvar elmo-display-progress-threshold 20
   "*Displaying progress gauge if number of messages are more than this value.")
 
+(defvar elmo-inhibit-number-mapping nil
+  "Global switch to inhibit number mapping (e.g. Inhibit UIDL on POP3).")
+
+(defvar elmo-display-retrieval-progress-threshold 30000
+  "*Don't display progress if the message size is smaller than this value.")
+
+(defvar elmo-inhibit-display-retrieval-progress nil
+  "Global switch to inhibit display progress of each message's retrieval.")
+
+(defvar elmo-dop-queue nil
+  "Global variable for storing disconnected operation queues.")
+
 (require 'product)
 (product-provide (provide 'elmo-vars) (require 'elmo-version))