1 ;;; elmo-vars.el --- User variables for ELMO.
3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
6 ;; Keywords: mail, net news
8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
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)
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.
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.
33 ;; silence byte compiler
35 (defun-maybe dynamic-link (a))
36 (defun-maybe dynamic-call (a b)))
38 ;; bind colon keywords for old Emacsen.
41 :symbol-for-testing-whether-colon-keyword-is-available-or-not
43 (let ((kwds '(:cc :date :extra :message-id :number :references :subject)))
45 (set (car kwds) (car kwds))
46 (setq kwds (cdr kwds)))))))
49 "ELMO, Elisp Library for Message Orchestration."
55 (defgroup elmo-setting nil
56 "ELMO common settings."
60 (defcustom elmo-digest-flags '(unread)
61 "Flags which are treated as `digest'."
62 :type '(repeat (symbol :tag "flag"))
65 (defcustom elmo-preserved-flags '(forwarded answered cached new unread)
66 "A list to define preserved flags.
67 Flags in this list can be searched by `any' flag condition.
68 If you want to treat a flag in this list as a `digest' flag,
69 you have to add it to `elmo-digest-flags'.
71 :type '(repeat (symbol :tag "flag"))
76 (defcustom elmo-msgdb-default-type 'standard
77 "*Default type of Message Database for ELMO."
78 :type '(radio (const legacy)
83 (defcustom elmo-msgdb-convert-type 'auto
84 "*MODB conversion type."
85 :type '(radio (const sync)
87 (const :tag "No convert" nil))
91 (defcustom elmo-init-hook '(elmo-global-mark-migrate)
92 "*A hook called when elmo is initialized."
96 (defvar elmo-msgdb-file-header-chop-length 2048
97 "*Number of bytes to get header in one reading from file.")
99 (defcustom elmo-msgdb-directory "~/.elmo"
100 "*ELMO Message Database path."
103 :group 'elmo-setting)
104 (defvar elmo-passwd-alist-file-name "passwd"
105 "*ELMO Password filename.")
106 (defcustom elmo-passwd-life-time nil
107 "*Duration of ELMO Password in seconds. nil means infinity."
108 :type '(choice (const :tag "Infinity" nil)
111 :group 'elmo-setting)
113 (defvar elmo-warning-threshold 30000
114 "*Display warning when the bytes of message exceeds this value.")
116 (defvar elmo-msg-appended-hook nil
117 "A hook called when message is appended to database.")
118 (defvar elmo-msg-deleted-hook nil
119 "A hook called when message is deleted from database.")
120 (defvar elmo-nntp-post-pre-hook nil
121 "A hook called just before the nntp posting.")
125 (defcustom elmo-imap4-default-server "localhost"
126 "*Default IMAP4 server."
129 :group 'elmo-setting)
131 (defcustom elmo-imap4-default-authenticate-type 'login
132 "*Default Authentication type for IMAP4."
133 :type '(radio (const :tag "encoded password transmission (login)" login)
134 (const :tag "CRAM-MD5 authentication (cram-md5)" cram-md5)
135 (const :tag "DIGEST-MD5 authentication (digest-md5)" digest-md5)
136 (const :tag "plain password transmission (clear)" clear)
137 (const :tag "NTLM authentication (ntlm)" ntlm)
138 (function :tag "Other"))
141 (defcustom elmo-imap4-default-user (or (getenv "USER")
144 "*Default username for IMAP4."
147 :group 'elmo-setting)
149 (defcustom elmo-imap4-default-port 143
150 "*Default Port number of IMAP."
153 :group 'elmo-setting)
155 (defcustom elmo-imap4-default-stream-type nil
156 "*Default stream type for IMAP4.
157 Any symbol value of `elmo-network-stream-type-alist' or
158 `elmo-imap4-stream-type-alist'."
162 (defvar elmo-imap4-stream-type-alist nil
163 "*Stream bindings for IMAP4.
164 This is taken precedence over `elmo-network-stream-type-alist'.")
169 (defcustom elmo-nntp-default-server "localhost"
170 "*Default NNTP server."
173 :group 'elmo-setting)
175 (defcustom elmo-nntp-default-user nil
176 "*Default User of NNTP. nil means no user authentication."
177 :type '(choice (const nil)
180 :group 'elmo-setting)
182 (defcustom elmo-nntp-default-port 119
183 "*Default Port number of NNTP."
186 :group 'elmo-setting)
188 (defcustom elmo-nntp-default-stream-type nil
189 "*Default stream type for NNTP.
190 Any symbol value of `elmo-network-stream-type-alist' or
191 `elmo-nntp-stream-type-alist'."
195 (defvar elmo-nntp-stream-type-alist nil
196 "*Stream bindings for NNTP.
197 This is taken precedence over `elmo-network-stream-type-alist'.")
202 (defcustom elmo-pop3-default-user (or (getenv "USER")
205 "*Default username for POP3."
208 :group 'elmo-setting)
210 (defcustom elmo-pop3-default-server "localhost"
211 "*Default POP3 server."
214 :group 'elmo-setting)
216 (defcustom elmo-pop3-default-authenticate-type 'user
217 "*Default Authentication type for POP3."
218 :type '(radio (const :tag "plain password transmission (user)" user)
219 (const :tag "APOP authentication (apop)" apop)
220 (const :tag "CRAM-MD5 authentication (cram-md5)" cram-md5)
221 (const :tag "DIGEST-MD5 authentication (digest-md5)" digest-md5)
222 (const :tag "NTLM authentication (ntlm)" ntlm)
223 (function :tag "Other"))
226 (defcustom elmo-pop3-default-port 110
227 "*Default POP3 port."
230 :group 'elmo-setting)
232 (defcustom elmo-pop3-default-stream-type nil
233 "*Default stream type for POP3.
234 Any symbol value of `elmo-network-stream-type-alist' or
235 `elmo-pop3-stream-type-alist'."
239 (defvar elmo-pop3-stream-type-alist nil
240 "*Stream bindings for POP3.
241 This is taken precedence over `elmo-network-stream-type-alist'.")
243 (defcustom elmo-lang "ja"
244 "Language for displayed messages."
246 :group 'elmo-setting)
248 (defvar elmo-mime-charset 'iso-2022-jp)
250 (defvar elmo-msgdb-mark-filename "mark"
252 (defvar elmo-msgdb-overview-filename "overview"
253 "Overview database.")
254 (defvar elmo-msgdb-number-filename "number"
255 "Message number <=> Message-ID database.")
256 (defvar elmo-msgdb-location-filename "location"
257 "Message number <=> Actual location symbol.")
258 (defvar elmo-msgdb-seen-filename "seen"
259 "Seen message list for append.")
260 (defvar elmo-msgdb-killed-filename "killed"
261 "Deleted messages... contains elmo-killed-msgs-list.")
262 (defvar elmo-msgdb-validity-filename "validity")
263 (defvar elmo-msgdb-flist-filename "flist"
264 "Folder list cache (for access folder).")
265 (defvar elmo-msgdb-finfo-filename "finfo"
266 "Folder information cache...list of '(filename . '(new unread all)).")
267 (defvar elmo-msgdb-lock-list-filename "lock"
268 "Locked messages...list of message-id.
269 For disconnected operations.")
270 (defvar elmo-lost+found-folder "+lost+found"
272 (defvar elmo-crosspost-alist-filename "crosspost-alist"
273 "Alist of crosspost messages.")
275 (defvar elmo-use-server-diff t
276 "Non-nil forces to get unread message information on server.")
278 (defvar elmo-strict-diff-folder-list nil
279 "List of regexps of folder name which should be checked its diff strictly.")
281 (defcustom elmo-msgdb-prefer-in-reply-to-for-parent nil
282 "*Non-nil to prefer In-Reply-To header for finding parent message on thread,
283 rather than References header."
286 :group 'elmo-setting)
288 (defcustom elmo-msgdb-extra-fields nil
289 "Extra fields for msgdb."
290 :type '(repeat string)
292 :group 'elmo-setting)
294 (defcustom elmo-enable-disconnected-operation t
295 "*Non-nil enables disconnected operations."
298 :group 'elmo-setting)
300 (defvar elmo-auto-change-plugged 600
301 "*Time to expire change plugged state automatically, as the number of seconds.
302 Don't change plugged state automatically if nil.")
303 (defvar elmo-plugged-condition 'one
304 "*The condition for `elmo-plugged' becomes on.
305 If `all', when all ports are on. If `one', when even one port is on.
306 If `independent', independent port plugged.
307 If function, return value of function.")
309 (defvar elmo-plug-on-servers nil)
311 (defvar elmo-plug-on-exclude-servers
314 (and (string-match "[^.]+" (system-name))
315 (substring (system-name) 0 (match-end 0)))))
317 (defvar elmo-plugged-alist nil)
319 (defvar elmo-dop-flush-confirm t
320 "*Flush disconnected operations queue with confirmation.")
322 (defvar elmo-path-sep "/"
324 (defvar elmo-plugged t)
326 (defvar elmo-no-subject "(No Subject in original.)"
327 "*A string used when no subject field exists.")
328 (defvar elmo-no-from "nobody@nowhere?"
329 "*A string used when no from field exists.")
331 ;; database dynamic linking
332 (defvar elmo-database-dl-module
333 (expand-file-name "database.so" exec-directory))
335 (defvar elmo-database-dl-handle
336 (if (and (fboundp 'dynamic-link)
338 elmo-database-dl-module))
339 (if (fboundp 'open-database)
341 (dynamic-link elmo-database-dl-module))))
343 (if (and elmo-database-dl-handle
344 (integerp elmo-database-dl-handle))
345 (dynamic-call "emacs_database_init" elmo-database-dl-handle))
347 (defvar elmo-use-database (or (featurep 'dbm)
350 (featurep 'berkeley-db)
351 ;; static/dl-database
352 (fboundp 'open-database)))
354 (defvar elmo-date-match t
355 "Date match is available or not.")
357 (defvar elmo-network-stream-type-alist
358 '(("!" ssl ssl open-ssl-stream)
359 ("!!" starttls starttls starttls-open-stream)
360 ("!socks" socks socks socks-open-network-stream)
361 ("!direct" direct nil open-network-stream))
362 "An alist of (SPEC-STRING SYMBOL FEATURE OPEN-STREAM-FUNCTION).
363 SPEC-STRING is a string for stream-type spec (it must start with '!').
364 SYMBOL is a symbol which indicates the name of the stream type.
365 SYMBOL should be identical in this alist.
366 FEATURE is a symbol of the feature for OPEN-STREAM-FUNCTION.
367 OPEN-STREAM-FUNCTION is a function to open network stream.
368 Arguments for this function are NAME, BUFFER, HOST and SERVICE.")
370 (defvar elmo-folder-info-hashtb nil
371 "Array of folder database information '(max length new unread).")
373 (defvar elmo-crosspost-message-alist nil
374 "List of crosspost message.")
376 (defvar elmo-cache-expire-default-method "size"
377 "Default expiration method.")
379 (defvar elmo-cache-expire-default-size 30000
380 "Cache expiration disk size (Kilo bytes). This must be float value.")
382 (defvar elmo-cache-expire-default-age 50
383 "Cache expiration age (days).")
385 (defvar elmo-cache-directory (expand-file-name "cache" elmo-msgdb-directory)
386 "Directory name for cache storage.")
388 (defvar elmo-pack-number-check-strict t
389 "Pack number strictly.")
391 (defvar elmo-have-link-count
393 ;; OS/2: EMX always returns the link count "1" :-(
394 (or (memq system-type '(OS/2 emx))
395 ;; Meadow seems to have pseudo link count.(suggestion by S.YAMAGUCHI)
396 (and (eq system-type 'windows-nt) (not (featurep 'meadow)))))
397 "Your file system has link count, or not.")
399 (defvar elmo-weekday-name-en '["Sun" "Mon" "Tue" "Wed" "Thu" "Fri" "Sat"])
400 (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"])
401 (defvar elmo-weekday-name-fr '["Dim" "Lun" "Mar" "Mer" "Jeu" "Ven" "Sam"])
402 (defvar elmo-weekday-name-de '["Son" "Mon" "Die" "Mit" "Don" "Fre" "Sam"])
404 (defvar elmo-filename-replace-string-alist
415 (defvar elmo-hash-minimum-size 1023
416 "Minimum size of hash table.")
418 (defvar elmo-hash-maximum-size 4095
419 "Maximum size of hash table.")
421 (defvar elmo-use-decoded-cache (featurep 'xemacs)
422 "Use cache of decoded mime charset string.")
424 (defvar elmo-display-progress-threshold 20
425 "*Displaying progress gauge if number of messages are more than this value.")
427 (defvar elmo-inhibit-number-mapping nil
428 "Global switch to inhibit number mapping (e.g. Inhibit UIDL on POP3).")
430 (defvar elmo-display-retrieval-progress-threshold 30000
431 "*Don't display progress if the message size is smaller than this value.")
433 (defvar elmo-inhibit-display-retrieval-progress nil
434 "Global switch to inhibit display progress of each message's retrieval.")
436 (defvar elmo-dop-queue nil
437 "Global variable for storing disconnected operation queues.")
439 (defcustom elmo-mime-display-as-is-coding-system (if (boundp 'MULE)
440 '*autoconv* 'undecided)
441 "*Coding system used when message is displayed as is."
445 (defcustom elmo-mailing-list-name-spec-list
447 (x-sequence "^\\([^ ]+\\)")
448 (subject "^\\s(\\(\\S)+\\)[ :][0-9]+\\s)[ \t]*")
449 (list-post "<mailto:\\(.+\\)@")
450 (list-id "<\\([^.]+\\)\\." "^\\([^.]+\\)\\.")
451 (mailing-list ("\\(^\\|; \\)contact \\([^@]+\\)-[^-@]+@" . 2))
452 (return-path "^<\\([^@>]+\\)-return-[0-9]+-")
453 (delivered-to "^mailing list \\([^@]+\\)@"))
454 "*List of spec to extract mailing list name from field value."
456 (choice (symbol :tag "Field Name")
457 (list (symbol :tag "Field Name")
460 (integer :tag "Match Index"))))))
463 (defcustom elmo-mailing-list-count-spec-list
466 (x-sequence "^[^ ]+ \\([^ ]+\\)")
467 (subject "^\\s(\\S)+[ :]\\([0-9]+\\)\\s)[ \t]*")
468 (return-path "^<[^@>]+-return-\\([0-9]+\\)-"))
469 "*List of spec to extract mailing list count from field value."
471 (choice (symbol :tag "Field Name")
472 (list (symbol :tag "Field Name")
475 (integer :tag "Match Index"))))))
479 (product-provide (provide 'elmo-vars) (require 'elmo-version))
481 ;;; elmo-vars.el ends here