elmo/elmo-vars.el

   1 ;;; elmo-vars.el -- User variables for ELMO.
   2
   3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
   4
   5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
   6 ;; Keywords: mail, net news
   7
   8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
   9
  10 ;; This program is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14 ;;
  15 ;; This program is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19 ;;
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24 ;;
  25
  26 ;;; Commentary:
  27 ;;
  28
  29 ;;; Code:
  30 ;;
  31 (require 'poe)
  32
  33 (eval-when-compile
  34   (defun-maybe dynamic-link (a))
  35   (defun-maybe dynamic-call (a b)))
  36
  37 ;; IMAP4
  38 (defvar elmo-default-imap4-mailbox "inbox"
  39   "*Default IMAP4 mailbox.")
  40 (defvar elmo-default-imap4-server "localhost"
  41   "*Default IMAP4 server.")
  42 (defvar elmo-default-imap4-authenticate-type 'login
  43   "*Default Authentication type for IMAP4.")
  44 (defvar elmo-default-imap4-user (or (getenv "USER")
  45                                     (getenv "LOGNAME")
  46                                     (user-login-name))
  47   "*Default username for IMAP4.")
  48 (defvar elmo-default-imap4-port 143
  49   "*Default Port number of IMAP.")
  50 (defvar elmo-default-imap4-stream-type nil
  51   "*Default stream type for IMAP4.
  52 Any symbol value of `elmo-network-stream-type-alist'.")
  53 (defvar elmo-imap4-stream-type-alist nil
  54   "*Stream bindings for IMAP4.
  55 This is taken precedence over `elmo-network-stream-type-alist'.")
  56
  57 ;; POP3
  58 (defvar elmo-default-pop3-user (or (getenv "USER")
  59                                    (getenv "LOGNAME")
  60                                    (user-login-name))
  61   "*Default username for POP3.")
  62 (defvar elmo-default-pop3-server  "localhost"
  63   "*Default POP3 server.")
  64 (defvar elmo-default-pop3-authenticate-type 'user
  65   "*Default Authentication type for POP3.")
  66 (defvar elmo-default-pop3-port 110
  67   "*Default POP3 port.")
  68 (defvar elmo-default-pop3-stream-type nil
  69   "*Default stream type for POP3.
  70 Any symbol value of `elmo-network-stream-type-alist'.")
  71 (defvar elmo-pop3-stream-type-alist nil
  72   "*Stream bindings for POP3.
  73 This is taken precedence over `elmo-network-stream-type-alist'.")
  74 (defvar elmo-pop3-use-uidl t
  75   "*If non-nil, use UIDL.")
  76
  77 ;; NNTP
  78 (defvar elmo-default-nntp-server  "localhost"
  79   "*Default NNTP server.")
  80 (defvar elmo-default-nntp-user nil
  81   "*Default User of NNTP.  nil means no user authentication.")
  82 (defvar elmo-default-nntp-port 119
  83   "*Default Port number of NNTP.")
  84 (defvar elmo-default-nntp-stream-type nil
  85   "*Default stream type for NNTP.
  86 Any symbol value of `elmo-network-stream-type-alist'.")
  87 (defvar elmo-nntp-stream-type-alist nil
  88   "*Stream bindings for NNTP.
  89 This is taken precedence over `elmo-network-stream-type-alist'.")
  90
  91 ;; Local
  92 (defvar elmo-localdir-folder-path "~/Mail"
  93   "*Local mail folder path.")
  94 (defvar elmo-localnews-folder-path "~/News"
  95   "*Local news folder path.")
  96 (defvar elmo-maildir-folder-path "~/Maildir"
  97   "*Maildir folder path.")
  98 (defvar elmo-maildir-list '("\\+~/Maildir")
  99   "*All Folders that match this list will be treated as Maildir.
 100 Each elements are regexp of folder name (This is obsolete).")
 101
 102 (defvar elmo-msgdb-dir "~/.elmo"
 103   "*ELMO Message Database path.")
 104 (defvar elmo-passwd-alist-file-name "passwd"
 105   "*ELMO Password filename.")
 106 (defvar elmo-passwd-life-time nil
 107   "*Duration of ELMO Password in seconds.  nil means infinity.")
 108 (defvar elmo-warning-threshold 30000
 109   "*Display warning when the bytes of message exceeds this value.")
 110 (defvar elmo-msg-appended-hook nil
 111   "A hook called when message is appended to database.")
 112 (defvar elmo-msg-deleted-hook nil
 113   "A hook called when message is deleted from database.")
 114 (defvar elmo-nntp-post-pre-hook nil
 115   "A hook called just before the nntp posting.")
 116 (defvar elmo-lang "ja"
 117   "Language for displayed messages.")
 118
 119 (defvar elmo-mime-charset 'iso-2022-jp)
 120
 121 (defvar elmo-msgdb-mark-filename "mark"
 122   "Mark database.")
 123 (defvar elmo-msgdb-overview-filename "overview"
 124   "Overview database.")
 125 (defvar elmo-msgdb-number-filename "number"
 126   "Message number <=> Message-ID database.")
 127 (defvar elmo-msgdb-location-filename "location"
 128   "Message number <=> Actual location symbol.")
 129 (defvar elmo-msgdb-seen-filename "seen"
 130   "Seen message list for append.")
 131 (defvar elmo-msgdb-killed-filename "killed"
 132   "Deleted messages... contains elmo-killed-msgs-list.")
 133 (defvar elmo-msgdb-validity-filename "validity")
 134 (defvar elmo-msgdb-flist-filename "flist"
 135   "Folder list cache (for access folder).")
 136 (defvar elmo-msgdb-finfo-filename "finfo"
 137   "Folder information cache...list of '(filename . '(new unread all)).")
 138 (defvar elmo-msgdb-append-list-filename "append"
 139   "Appended messages...Structure is same as number-alist.
 140 For disconnected operations.")
 141 (defvar elmo-msgdb-resume-list-filename "resume"
 142   "Resumed messages.  For disconnected operations.")
 143 (defvar elmo-msgdb-lock-list-filename "lock"
 144   "Locked messages...list of message-id.
 145 For disconnected operations.")
 146 (defvar elmo-msgdb-global-mark-filename "global-mark"
 147   "Alist of global mark.")
 148 (defvar elmo-lost+found-folder "+lost+found"
 149   "Lost and found.")
 150 (defvar elmo-crosspost-alist-filename "crosspost-alist"
 151   "Alist of crosspost messages.")
 152
 153 (defvar elmo-use-server-diff t
 154   "Non-nil forces to get unread message information on server.")
 155
 156 (defvar elmo-imap4-disuse-server-flag-mailbox-regexp "^#mh" ; UW imapd
 157   "Regexp to match IMAP4 mailbox names whose message flags on server should be ignored.
 158 (Except `\\Deleted' flag).")
 159
 160 (defvar elmo-msgdb-extra-fields nil
 161   "Extra fields for msgdb.")
 162
 163 (defvar elmo-queue-filename "queue"
 164   "*IMAP pending event queue is saved in this file.")
 165 (defvar elmo-enable-disconnected-operation nil
 166   "*Enable disconnected operations.")
 167
 168 (defvar elmo-imap4-overview-fetch-chop-length 200
 169   "*Number of overviews to fetch in one request in imap4.")
 170 (defvar elmo-nntp-overview-fetch-chop-length 200
 171  "*Number of overviews to fetch in one request in nntp.")
 172 (defvar elmo-localdir-header-chop-length 2048
 173   "*Number of bytes to get header in one reading from file.")
 174 (defvar elmo-imap4-force-login nil
 175   "*Non-nil forces to try 'login' if there is no 'auth' capability in imapd.")
 176 (defvar elmo-imap4-use-select-to-update-status nil
 177   "*Some imapd have to send select command to update status.
 178 (ex. UW imapd 4.5-BETA?).  For these imapd, you must set this variable t.")
 179 (defvar elmo-imap4-use-modified-utf7 nil
 180   "*Use mofidied UTF-7 (rfc2060) encoding for IMAP4 folder name.")
 181
 182 (defvar elmo-auto-change-plugged 600
 183   "*Time to expire change plugged state automatically, as the number of seconds.
 184 Don't change plugged state automatically if nil.")
 185 (defvar elmo-plugged-condition 'one
 186   "*The condition for `elmo-plugged' becomes on.
 187 If `all', when all ports are on.  If `one', when even one port is on.
 188 If `independent', independent port plugged.
 189 If function, return value of function.")
 190
 191 (defvar elmo-plug-on-servers nil)
 192
 193 (defvar elmo-plug-on-exclude-servers
 194   (list "localhost"
 195         (system-name)
 196         (and (string-match "[^.]+" (system-name))
 197              (substring (system-name) 0 (match-end 0)))))
 198
 199 (defvar elmo-plugged-alist nil)
 200
 201 (defvar elmo-dop-flush-confirm t
 202   "*Flush disconnected operations queue with confirmation.")
 203
 204 (defvar elmo-path-sep "/"
 205   "*Path separator.")
 206 (defvar elmo-plugged t)
 207 (defvar elmo-use-semi nil)
 208 (defvar elmo-no-subject "(No Subject in original.)"
 209   "*A string used when no subject field exists.")
 210 (defvar elmo-no-from "nobody@nowhere?"
 211   "*A string used when no from field exists.")
 212
 213 (defvar elmo-multi-divide-number 100000
 214   "*Multi divider number.")
 215
 216 ;;; User variables for elmo-archive.
 217 (defvar elmo-archive-default-type 'zip
 218   "*Default archiver type.  The value must be a symbol.")
 219
 220 ;; database dynamic linking
 221 (defvar elmo-database-dl-module
 222   (expand-file-name "database.so" exec-directory))
 223
 224 (defvar elmo-database-dl-handle
 225   (if (and (fboundp 'dynamic-link)
 226            (file-exists-p
 227             elmo-database-dl-module))
 228       (if (fboundp 'open-database)
 229           t ;;
 230         (dynamic-link elmo-database-dl-module))))
 231
 232 (if (and elmo-database-dl-handle
 233          (integerp elmo-database-dl-handle))
 234     (dynamic-call "emacs_database_init" elmo-database-dl-handle))
 235
 236 (defvar elmo-use-database (or (featurep 'dbm)
 237                               (featurep 'gnudbm)
 238                               (featurep 'berkdb)
 239                               (featurep 'berkeley-db)
 240                               ;; static/dl-database
 241                               (fboundp 'open-database)))
 242
 243 (defvar elmo-date-match (not (boundp 'nemacs-version))
 244   "Date match is available or not.")
 245
 246 (defconst elmo-spec-alist
 247   '((?%  . imap4)
 248     (?-  . nntp)
 249     (?\+ . localdir)
 250     (?\* . multi)
 251     (?\/ . filter)
 252     (?\$ . archive)
 253     (?&  . pop3)
 254     (?=  . localnews)
 255     (?'  . internal)
 256     (?|  . pipe)
 257     (?.  . maildir)))
 258
 259 (defvar elmo-network-stream-type-alist
 260   '(("!"      ssl       ssl      open-ssl-stream)
 261     ("!!"     starttls  starttls starttls-open-stream)
 262     ("!socks" socks     socks    socks-open-network-stream))
 263   "An alist of (SPEC-STRING SYMBOL FEATURE OPEN-STREAM-FUNCTION).
 264 SPEC-STRING is a string for stream-type spec (it must start with '!').
 265 SYMBOL is a symbol which indicates the name of the stream type.
 266 SYMBOL should be identical in this alist.
 267 FEATURE is a symbol of the feature for OPEN-STREAM-FUNCTION.
 268 OPEN-STREAM-FUNCTION is a function to open network stream.
 269 Arguments for this function are NAME, BUFFER, HOST and SERVICE.")
 270
 271 (defvar elmo-debug nil)
 272 (defconst mmelmo-entity-buffer-name "*MMELMO-BUFFER*")
 273
 274 (defvar elmo-folder-info-hashtb nil
 275   "Array of folder database information '(max length new unread).")
 276
 277 (defvar elmo-crosspost-message-alist nil
 278   "List of crosspost message.")
 279
 280 (defvar elmo-cache-expire-default-method "size"
 281   "Default expiration method.")
 282
 283 (defvar elmo-cache-expire-default-size 30000
 284   "Cache expiration disk size (Kilo bytes).  This must be float value.")
 285
 286 (defvar elmo-cache-expire-default-age 50
 287   "Cache expiration age (days).")
 288 (defvar elmo-cache-dirname "cache"
 289   "Directory name for cache storage.")
 290
 291 (defvar elmo-use-buffer-cache t
 292   "Use buffer cache.")
 293
 294 (defvar elmo-buffer-cache-size 10
 295   "*Number of buffer for message cache.")
 296
 297 (defvar elmo-pack-number-check-strict t
 298   "Pack number strictly.")
 299
 300 (defvar elmo-have-link-count
 301   (not
 302    ;; OS/2: EMX always returns the link count "1" :-(
 303    (or (memq system-type '(OS/2 emx))
 304        ;; Meadow seems to have pseudo link count.(suggestion by S.YAMAGUCHI)
 305        (and (eq system-type 'windows-nt) (not (featurep 'meadow)))))
 306   "Your file system has link count, or not.")
 307
 308 (defvar elmo-weekday-name-en '["Sun" "Mon" "Tue" "Wed" "Thu" "Fri" "Sat"])
 309 (defvar elmo-weekday-name-ja '["\e$BF|\e(B" "\e$B7n\e(B" "\e$B2P\e(B" "\e$B?e\e(B" "\e$BLZ\e(B" "\e$B6b\e(B" "\e$BEZ\e(B"])
 310 (defvar elmo-weekday-name-fr '["Dim" "Lun" "Mar" "Mer" "Jeu" "Ven" "Sam"])
 311 (defvar elmo-weekday-name-de '["Son" "Mon" "Die" "Mit" "Don" "Fre" "Sam"])
 312
 313 (defvar elmo-msgid-replace-string-alist
 314   '((":"  . " c")
 315     ("*"  . " a")
 316     ("?"  . " q")
 317     ("<"  . " l")
 318     (">"  . " g")
 319     ("\"" . " d")
 320     ("|"  . " p")
 321     ("/"  . " s")
 322     ("\\" . " b")))
 323
 324 (defvar elmo-archive-use-cache nil
 325   "Use cache in archive folder.")
 326
 327 (defvar elmo-nntp-use-cache t
 328   "Use cache in nntp folder.")
 329
 330 (defvar elmo-imap4-use-cache t
 331   "Use cache in imap4 folder.")
 332
 333 (defvar elmo-pop3-use-cache t
 334   "Use cache in pop3 folder.")
 335
 336 (defvar elmo-localdir-lockfile-list nil)
 337
 338 (defvar elmo-nntp-max-number-precedes-list-active nil
 339   "Non-nil means max number of msgdb is set as the max number of `list active'.
 340 (Needed for inn 2.3 or later?).")
 341
 342 (defvar elmo-use-killed-list t
 343   "If non-nil, deleted messages are saved as `killed'
 344 and do not appear again.")
 345
 346 (defvar elmo-pop3-send-command-synchronously nil
 347   "If non-nil, commands are send synchronously.
 348 If server doesn't accept asynchronous commands, this variable should be
 349 set as non-nil.")
 350
 351 (defvar elmo-hash-maximum-size 4096
 352   "Maximum size of hash table.")
 353
 354 (defvar elmo-use-decoded-cache (featurep 'xemacs)
 355   "Use cache of decoded mime charset string.")
 356
 357 (defvar elmo-use-overview-hashtb t
 358   "Use hash table of overview.")
 359
 360 (defvar elmo-display-progress-threshold 20
 361   "*Displaying progress gauge if number of messages are more than this value.")
 362
 363 (defvar elmo-inhibit-read-cache nil
 364   "*Global switch to inhibit reading cache.")
 365
 366 (defvar elmo-inhibit-display-retrieval-progress nil
 367   "Global switch to inhibit display progress of each message's retrieval.")
 368
 369 (defvar elmo-display-retrieval-progress-threshold 30000
 370   "*Don't display progress if the message size is smaller than this value.")
 371
 372 (require 'product)
 373 (product-provide (provide 'elmo-vars) (require 'elmo-version))
 374
 375 ;;; elmo-vars.el ends here