1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust,
20 Yet another message interface on Emacsen.
22 Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata},
24 @w{Kenichi Okada}, @w{Kaoru Takahashi},
25 @w{Bun Mizuhara} and @w{Masayuki Osada}.
27 This edition is for Wanderlust version @value{VERSION}.
29 Permission is granted to make and distribute verbatim copies of
30 this manual provided the copyright notice and this permission notice
31 are preserved on all copies.
34 Permission is granted to process this file through TeX and print the
35 results, provided the printed document carries copying permission
36 notice identical to this one except for the removal of this paragraph
37 (this paragraph not being relevant to the printed manual).
40 Permission is granted to copy and distribute modified versions of this
41 manual under the conditions for verbatim copying, provided that the entire
42 resulting derived work is distributed under the terms of a permission
43 notice identical to this one.
45 Permission is granted to copy and distribute translations of this manual
46 into another language, under the above conditions for modified versions.
52 @title Wanderlust User's Manual
53 @subtitle Yet another message interface on Emacsen
54 @subtitle for Wanderlust version @value{VERSION}
55 @author Yuuichi Teranishi
56 @author Fujikazu Okunishi
57 @author Masahiro Murata
59 @author Kaoru Takahashi
61 @author Masayuki Osada
64 @vskip 0pt plus 1filll
65 Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi},
66 @w{Fujikazu Okunishi}, @w{Masahiro Murata},
67 @w{Kenichi Okada}, @w{Kaoru Takahashi},
68 @w{Bun Mizuhara} and @w{Masayuki Osada}.
70 This manual is for Wanderlust version @value{VERSION}.
72 Permission is granted to make and distribute verbatim copies of
73 this manual provided the copyright notice and this permission notice
74 are preserved on all copies.
76 Permission is granted to copy and distribute modified versions of this
77 manual under the conditions for verbatim copying, provided that the entire
78 resulting derived work is distributed under the terms of a permission
79 notice identical to this one.
81 Permission is granted to copy and distribute translations of this manual
82 into another language, under the above conditions for modified versions.
88 @node Top, Introduction, (dir), (dir)
89 @top Wanderlust User's Manual
101 This manual is for Wanderlust @value{VERSION}.
106 * Introduction:: Read this first.
107 * Start Me Up:: Invoking Wanderlust.
108 * Folders:: How to specify folders.
109 * Folder:: Selecting and editing folders.
110 * Summary:: Reading and refiling messages.
111 * Message:: Saving and playing MIME multipart entities.
112 * Draft:: Draft buffer, sending mail and news.
113 * Disconnected Operations:: Off-Line management
114 * Expire and Archive:: Automatic expiration and archiving of messages.
115 * Scoring:: Score of the messages.
116 * Customization:: Customizing Wanderlust.
117 * Mailing List:: Wanderlust mailing list
118 * Addition:: Additional Information
123 @node Introduction, Start Me Up, Top, Top
124 @chapter Introduction of Wanderlust
127 Wanderlust is an mail/news management system on Emacsen.
128 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
130 The main features of Wanderlust:
133 @item Pure elisp implementation.
134 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
135 @item Unified access method to messages based on Mew-like Folder Specification.
136 @item Mew-like Key-bind and mark handling.
137 @item Manages unread messages.
138 @item Interactive thread display.
139 @item Folder Mode shows the list of subscribed folders.
140 @item Message Cache, Disconnected Operation (Read Only).
141 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
142 @item MIME compliant (by SEMI or tm).
143 @item Transmission of news and mail are unified by Message transmitting draft.
144 @item Graphical list of folders (XEmacs and Emacs 21).
145 @item View a part of message without retrieving the whole message (IMAP4).
146 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
147 @item Virtual Folders.
148 @item Supports compressed folder using common archiving utilities.
149 @item Old articles in folders are automatically removed/archived (Expiration).
150 @item Automatic re-file.
151 @item Template function makes it convenient to send fixed form messages.
157 Wanderlust is supposed to run on following Emacsen:
158 @c Wanderlust runs even on Nemacs 3.3.2 based on Emacs 18.55, 18.59 (with
159 @c limited functionality).
162 @item Nemacs 3.3.2 (Caution: limited functionality)
163 @item Mule 2.3 based on Emacs 19.28
164 @item Mule 2.3 based on Emacs 19.34
165 @item Emacs 20.2 or later
166 @item XEmacs 20.4 or later
167 @item Meadow 1.00 or later
168 @item Mule for Windows v1.22
169 @item NTEmacs 20.4 or later
173 IMAP4 connectivity with following imapd are confirmed to work with
177 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c
178 @item Cyrus imapd 1.4
179 @item Cyrus imapd 1.5.19
180 @item Cyrus imapd 1.6.22
181 @item Cyrus imapd 2.0.5
182 @item AIR MAIL (AIRC imapd release 2.00)
184 @item Microsoft Exchange Server 5.5
185 @item Sun Internet Mail Server 4.0
188 @c LDAP connectivity with following LDAPd are confirmed to work with
192 @node Start Me Up, Folders, Introduction, Top
193 @chapter Start up Wanderlust
196 The necessary procedure for starting Wanderlust is explained in steps
199 (Of course, you need a mail/news readable environment in advance)
202 * MIME Modules:: Installing the MIME modules.
203 * Download:: Download and extract the packages.
204 * Install:: Byte-compile and install.
205 * Minimal Settings:: @file{.emacs} setup.
206 * Mail Addresses:: Address book definition.
207 * Folder Definition:: Folder definition.
208 * Start Wanderlust:: Starting Wanderlust
212 @node MIME Modules, Download, Start Me Up, Start Me Up
213 @section Installing MIME modules
220 SEMI or tm must be installed to make Wanderlust work correctly.
222 SEMI does not run on Emacs19.28 or earlier
223 @footnote{SEMI runs on Emacs 19.34. @*
224 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} describes how to.},
225 so you must install tm, the predecessor of SEMI. (tm version 8.7 or later
228 However, SEMI is recommended because of its wider functionality.
230 Refer to the documents of each package for detailed installation procedure.
232 SEMI and tm can be downloaded from these sites:
236 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
237 tm: http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
241 You need packages named APEL and FLIM to use SEMI.
242 You can download APEL and FLIM from following URLs:
246 APEL: ftp://ftp.m17n.org/pub/mule/apel/
247 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
251 You have to install APEL, FLIM and SEMI in this order.
252 Generally @samp{make install} will do the job.
253 (In XEmacs 21, @samp{make install-package}.)
255 Recommended combination of APEL, FLIM and SEMI are following:
258 @item APEL 10.2, FLIM 1.12.7 and SEMI 1.13.4
259 @item APEL 10.2, FLIM 1.13.2 and SEMI 1.13.7
262 Combination of APEL 10.2 and FLIM 1.12.7 makes following error
263 while compiling FLIM 1.12.7.
266 Please install latest APEL 7.3 or later.
269 In this case, please comment out following lines in @file{FLIM-CFG}.
273 (or (fboundp 'write-region-as-binary)
274 (error "Please install latest APEL 7.3 or later."))
275 (or (fboundp 'insert-file-contents-as-binary)
276 (error "Please install latest APEL 7.3 or later."))
280 You can also use many other FLIM/SEMI variants. Combination of the
281 latest versions should work. For example, following combination is
285 @item APEL 10.2, Chao 1.14.1 and REMI 1.14.1
288 @c You have to re-install Wanderlust
289 @c if you upgraded APEL, FLIM, SEMI or tm.
291 @node Download, Install, MIME Modules, Start Me Up
292 @section Download and Extract the Package
295 You can download Wanderlust package from following sites:
299 ftp://ftp.gohome.org/wl/
302 Mirrored ftp/http sites:
306 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
307 http://www.jpl.org/elips/wl/
308 http://www.ring.gr.jp/archives/text/elisp/wl/
309 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
310 ftp://opaopa.org/pub/mirror/elisp/wl/
314 Extract the obtained package to your working directory:
319 % tar zxvf wl-@var{version}.tar.gz
320 % cd wl-@var{version}
324 @subsection To use SSL (Secure Socket Layer)
329 SSL (Secure Socket Layer) can be used for
330 SMTP, IMAP, NNTP and POP connections in Wanderlust.
332 There are two ways to use SSL. One is to start SSL negotiation just after
333 the connection establishment (generic way).
334 The other one is to start SSL negotiation by invoking STARTTLS command in
337 To use the formar SSL (generic SSL), you must install @file{ssl.el} in
338 the @file{utils} directory. OpenSSL command @command{openssl} is also
339 required to use @file{ssl.el}. You must set PATH to the directory that
340 OpenSSL commands are installed.
342 To use the latter SSL(STARTTLS), you must install starttls package in
344 You can download starttls package from the following site.
347 ftp://opaopa.org/pub/elisp/
350 @node Install, Minimal Settings, Download, Start Me Up
351 @section Byte-compile and install
358 @subsection Installation
360 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
361 Set the Emacs's command name to @code{EMACS}.
362 Set package installation directory to @code{LISPDIR}.
363 Then, please execute following commands.
372 Destination directory is auto-probed if you leave @code{LISPDIR}
373 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
375 If you are using an Emacs variant which does not merge specified directory
376 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
377 then you will see the error message:
380 Cannot open load file: mime-setup
384 In this case, either add destination directories of custom, APEL, FLIM
385 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
386 @code{load-path} in @file{WL-CFG} in extracted directory.
388 If you want to use BBDB, then the necessary modules are byte-compiled and
389 installed when BBDB directory is added to @code{load-path}.
392 @subsection @file{WL-CFG}
394 Contents of the file @file{WL-CFG} is loaded under installation if a file
395 with that name exists in extracted directory. You can use @file{WL-CFG} to
396 configure @code{load-path} to extra packages such as SEMI if needed.
398 If you want to specify the install directory of Wanderlust related
399 files, then set following variables in @file{WL-CFG}
403 A directory to install WL modules.
404 This directory is relative directory from @code{LISPDIR}.
405 WL modules include @file{wl*.el}, @file{wl*.elc} files.
406 @c Modules under the directory @file{util/} are also installed if
407 @c it detected as necessary.
410 A directory to install ELMO modules.
411 This directory is relative directory from @code{LISPDIR}.
412 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
413 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
417 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
419 If you want to install ELMO related files under a sub-directory
420 such as "elmo" then add following to @file{WL-CFG}:
423 (setq ELMO_PREFIX "elmo")
426 @subsection Install as a XEmacs package
427 @cindex XEmacs package
428 @cindex XEmacs package install
429 @cindex Package, XEmacs
430 @cindex Package install, XEmacs
431 @c @cindex install-package
433 It is possible to install Wanderlust as one of packages of XEmacs (21.0
434 or later). Configuration for autoload and icon-path in local
435 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
438 Follow the next example to install Wanderlust as an XEmacs package.
444 % make install-package
448 package directory is auto-probed, if SEMI is installed.
449 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
451 @subsection Run in place
453 If wl and elmo directories are defined in @code{load-path}, then
454 byte-compilation and installation are not necessary to start Wanderlust.
455 For example, if package is extracted in @file{~/work}, Wanderlust can be
456 invoked with following setting in @file{~/.emacs}.
460 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
461 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
467 Manual is described in Info format. Please do following.
476 If you install Wanderlust as a XEmacs package, Info file is already
477 installed too, so there are no need of these commands.
479 Manual directory is automatically detected. Of course, it can be
480 configured by @code{INFODIR} in @file{Makefile}.
482 You can read manual at the following URL:
485 http://www.gohome.org/wl/doc/wl-euc_toc.html
488 @node Minimal Settings, Mail Addresses, Install, Start Me Up
489 @section Set up .emacs
490 @cindex Minimal Settings
492 @cindex Configuration
496 The Wanderlust package contains two module groups.
499 @item ELMO (elmo-*.el)
500 These modules show everything as folders. This is the back-end for WL.
502 These modules controls the behavior of main body of Wanderlust.
503 They are also the front-end for ELMO.
506 You can customize the behavior of Wanderlust by changing the value
507 of environmental variables which begins with @code{elmo-} and @code{wl-}.
509 The minimal requirement for settings is as the following.
513 ;; @r{The setting to use SEMI/tm}
516 ;; @r{autoload configuration}
517 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
518 (autoload 'wl "wl" "Wanderlust" t)
519 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
521 ;; @r{Directory where icons are placed (XEmacs or Emacs 21). Default value
523 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
524 (setq wl-icon-dir "~/work/wl/etc")
526 ;; @r{SMTP server for mail posting. Default: @code{nil}}
527 (setq wl-smtp-posting-server "your.smtp.server.com")
528 ;; @r{NNTP server for news posting. Default: @code{nil}}
529 (setq wl-nntp-posting-server "your.nntp.server.com")
533 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
534 file exists). So it is convenient to gather Wanderlust specific settings
535 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
536 because you can't write them in @file{.emacs}
537 (if you write it to @file{.emacs}, you'll get an error).
540 All above described settings except (load "mime-setup") and autoload
541 configuration can be written in
544 @subsection @code{mail-user-agent}
545 @cindex Default Mailer
546 @cindex Mailer, Default
547 @vindex mail-user-agent
550 If you write following setting in you @file{.emacs}, you can
551 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
552 This means it enables you to run Wanderlust as a default mail composer
555 It is effective only when your Emacs can define @code{mail-user-agent}.
556 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
560 (autoload 'wl-user-agent-compose "wl-draft" nil t)
561 (if (boundp 'mail-user-agent)
562 (setq mail-user-agent 'wl-user-agent))
563 (if (fboundp 'define-mail-user-agent)
564 (define-mail-user-agent
566 'wl-user-agent-compose
574 @node Mail Addresses, Folder Definition, Minimal Settings, Start Me Up
575 @section Address book
576 @cindex Address book Definition
578 @cindex Alias, Address
580 The file @file{~/.addresses} is a simple address book for Wanderlust.
581 Make address file @file{~/.addresses}, and edit to suit your requirement.
583 The data written in @file{~/.addresses} are used for address completion
584 under draft editing mode. Furthermore, they are used when showing names
585 in summary display mode. You can safely skip this section, if you don't
586 want to customize address completion and summary display.
587 It is possible to add/change/remove addresses from @file{~/.addresses} in
588 summary buffer after Wanderlust is invoked. @refill
590 The format is very simple. Like this. @refill
595 # @r{Lines begin with @samp{#} are comment.}
596 # @r{Empty lines are ignored}
598 # @r{Format of each line:}
599 # @var{email-address} "@var{nickname} "@var{realname}"
601 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
602 foo@@bar.gohome.org "Mr. Foo" "John Foo"
603 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
608 One line defines one persons description.
610 Actually, in default setup, @var{nickname} is used in summary-mode and
611 @var{realname} is used in draft preparation mode. This behavior is
612 better understood if you try it and confirmed the function first. You
613 can write and try a small definition, so you will know the idea of the
614 address book before writing a big one.
616 And, if MH alias file is specified in variable @code{wl-alias-file},
617 it is used as an address information in the draft preparation mode.
619 If variable @code{wl-use-ldap} is non-nil (initial setting is nil),
620 address completion in draft mode uses LDAP information.
622 If you use LDAP, you have to set @code{wl-ldap-server},
623 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
624 not have LDAP feature as built-in feature (Currently only XEmacs can
625 have built-in LDAP feature), you have to set command exec PATH to the
626 program `ldapsearch'.
628 @node Folder Definition, Start Wanderlust, Mail Addresses, Start Me Up
629 @section Folder Definition
630 @cindex Folder Definition
633 Define the folders you want to subscribe in file @file{~/.folders}.
634 The contents written in @file{~/.folders} become the folders which
635 you subscribe to as it is.
637 You can skip this section because it is possible to add/edit the
638 subscribe folders from the buffer for list of folders.
640 Format for @file{~/.folders} is very simple. Here is an example:
645 # @r{Lines begin with @samp{#} are comment.}
646 # @r{Empty lines are ignored}
648 # @var{folder name} "@var{folder nickname}"
649 # @r{(nicknames are not necessary)}
654 %#mh/Backup@@my.imap.server.com "Sent"
657 %#mh/spool/wl "Wanderlust ML"
658 %#mh/spool/elips "ELIPS ML"
659 %#mh/spool/tm-ja "tm Japanese ML"
660 %#mh/spool/xemacs-beta "XEmacs beta"
661 -fj.news.reader.gnus@@other.nntp.server.com "Gnus Net news"
662 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
665 # @r{If folder name ends with @samp{/}, that means an `access group',}
666 # @r{all subfolders automatically included in one folder group.}
668 %#mh/expire@@localhost /
669 # @r{All MH folders are included in one folder group.}
674 Each line contains one folder you want to read. The definition of folders
675 will be explained in detail in the next section.
677 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will become one folder group.
678 One folder group is treated as a directory which can bed opened and closed in
679 folder mode. It is convenient for collecting some folders and putting them
682 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
683 line and you have to write it that way (It is because the parser sucks).
685 There are two types of groups. One is like @samp{Emacsen} from above
686 example which the user chooses his favorite folders as a group.
688 The other one is @dfn{access group} like @samp{+} from above example.
689 It makes all the sub-folders in a folder to a group.
690 (It differs from the type of the folder. For example, @samp{+} makes entire
691 MH sub-directories to one group)
693 This behavior is better understood if you try it and confirmed the function
694 first. You can write and try a small folder definition, so you will know the
695 idea of the folder function before writing the real one.
697 @node Start Wanderlust, , Folder Definition, Start Me Up
698 @section Start Wanderlust
699 @cindex Start Wanderlust
701 If installation and configuration worked well, you can invoke Wanderlust by
702 typing following command in Emacs.
709 After initialization, Folder Mode which shows the list of folders will appear.
710 That means the folders you defined in the @file{~/.folders} are listed
711 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
712 can skip folder checking.
715 @node Folders, Folder, Start Me Up, Top
716 @chapter Wanderlust's folders
719 This chapter describes the folder types which Wanderlust is able to handle.
721 Wanderlust uses ELMO as it's interface, so every folder types supported
722 by ELMO is usable in Wanderlust.
724 As of version @value{VERSION}, 10 types of folders are predefined. These are
725 IMAP, NNTP, LocalDir(MH), News Spool, POP, Archive, Multi, Filter, Pipe
726 and Internal folder types.
729 * IMAP Folder:: @samp{%} -- IMAP folder
730 * NNTP Folder:: @samp{-} -- NNTP folder
731 * MH Folder:: @samp{+} -- MH folder
732 * Maildir Folder:: @samp{.} -- Maildir folder
733 * News Spool Folder:: @samp{=} -- News spool folder
734 * Archive Folder:: @samp{$} -- Archive folder
735 * POP Folder:: @samp{&} -- POP folder
736 * Multi Folder:: @samp{*} -- Multi folder
737 * Filter Folder:: @samp{/} -- Filter folder
738 * Pipe Folder:: @samp{|} -- Pipe folder
739 * Internal Folder:: @samp{'} -- Internal folder
743 @node IMAP Folder, NNTP Folder, Folders, Folders
750 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
756 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
761 'login (encoded password transmission), 'cram-md5 (CRAM-MD5
762 authentication), 'digest-md5 (DIGEST-MD5 authentication) or 'plain (or
763 nil, plain password transmission) as @var{authenticate-type}.
764 (To use CRAM-MD5 or DIGEST-MD5 authentication, you must install @file{utils/sasl} package.)
769 @var{username} -> The value of @code{elmo-default-imap4-user}.
770 Initial setting is @env{USER} environment variable or
771 @env{LOGNAME} environment variable or return value of
772 @code{(user-login-name)}.
773 @var{authenticate-type} -> The value of @code{elmo-default-imap4-authenticate-type}.
774 Initial setting is "auth".
775 @var{hostname} -> The value of @code{elmo-default-imap4-server}.
776 Initial setting is "localhost".
777 @var{port} -> The value of @code{elmo-default-imap4-port}.
778 Initial setting is 143.
781 You can omit the @var{hostname} from folder names if you set
782 @code{elmo-default-imap4-server} as your main IMAP server.
783 For example, you can specify a folder as @samp{foo%imap@@gateway} even
784 if you have to go through a firewall.
786 SSL (Secure Socket Layer) connection will be used if a folder name
787 ends with @samp{!}. Or, if the value of @code{elmo-default-imap4-ssl} is non-nil,
788 SSL will be the default connection.
789 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
790 If the value of @code{elmo-default-imap4-ssl} is 'starttls,
791 STARTTLS will be the default connection.
793 If you specify 'login, 'cram-md5 or 'digest-md5 as authentication
794 method, the password is sent in encoded form. But, if your server is
795 unable to receive an encoded password, authentication will fall back to
796 'plain (that is, sending password in raw format) after confirmation to
797 user. If @code{elmo-imap4-force-login} is non-nil, authentication will
798 fall back to 'plain without confirmation (default value is nil).
804 %inbox -> IMAP mailbox "inbox"
805 %#mh/inbox -> IMAP mailbox "#mh/inbox"
807 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
808 %inbox:hoge/login@@server1
809 -> server1's IMAP mailbox "inbox"
810 of user "hoge", with plain password authentication
815 @subsection International mailbox names (Modified UTF7)
816 @cindex Modified UTF7
822 You can use international mailbox names in @var{mailbox} part, if you
823 are using Emacs which can treat unicode and
824 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
827 Currently, following Emacsen can treat unicode.
830 @item Emacs 20.3 or later + Mule-UCS
832 If you installed Mule-UCS package, Emacs can treat unicode.
833 You can obtain Mule-UCS package from following URL.
836 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
839 @item XEmacs 21.2.13 or later + ucs-conv package
841 By default, XEmacs 21 cannot treat unicodes, but if you installed
842 ucs-conv package, it can.
843 You can obtain ucs-conv package from following anonymous CVS.
847 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
848 Password: NULL (Just enter return key)
849 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
853 You also need utf7 conversion programs, @code{u7tou8} and @code{u8tou7}
854 to use international mailbox name in the current XEmacs. These programs
855 are included in the UTF7 package which can be obtained from following
859 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
863 @node NNTP Folder, MH Folder, IMAP Folder, Folders
868 A folder to access USENET news via NNTP protocol (RFC 977).
869 One newsgroup is treated as a folder.
875 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
881 @var{hostname} -> The value of @code{elmo-default-nntp-server}.
882 Initial setting is "localhost".
883 @var{username} -> The value of @code{elmo-default-nntp-user}.
884 Initial setting is nil.
885 @var{port} -> The value of @code{elmo-default-nntp-port}.
886 Initial setting is 119.
889 AUTHINFO is used as authentication method if the @var{username} is non-nil.
890 SSL will be default method if @code{elmo-default-nntp-ssl} is non-nil even
891 if the folder name doesn't end with @samp{!}.
892 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
893 if the value of @code{elmo-default-nntp-ssl} is 'starttls,
894 STARTTLS will be the default connection.
900 -fj.rec.tv -> Newsgroup `fj.rec.tv'.
901 -fj.rec.tv@@newsserver -> Newsgroup `fj.rec.tv' on newsserver.
905 @node MH Folder, Maildir Folder, NNTP Folder, Folders
911 A folder to access MH format mail (1 file is 1 mail).
916 @samp{+} @var{directory-name}
919 Normally, @var{directory-name} is an relative path to the variable
920 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
921 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
922 (this is also true for drive-letters).
924 Message number is used for the name of the message file.
930 +inbox -> "~/Mail/inbox"
931 +from/teranisi -> "~/Mail/from/teranisi"
936 @node Maildir Folder, News Spool Folder, MH Folder, Folders
937 @section Maildir Folder
938 @cindex Maildir Folder
942 A folder to access to Maildir format (1 file is 1 mail).
947 @samp{.} [@var{directory-name}]
950 Normally, @var{directory-name} is a relative path to the variable
951 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
952 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
953 (this is also true for drive-letters).
955 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
956 Messages are contained in the @file{cur} directory. All
957 message files in the @file{new} directory are moved to @file{cur}
958 directory when you access to the folder. All message files contained in
959 the @file{tmp} directory and not accessed for 36 hours are deleted.
961 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
968 .inbox -> "~/Maildir/inbox"
969 .from/teranisi -> "~/Maildir/from/teranisi"
975 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
976 @section News Spool Folder
977 @cindex News spool Folder
981 This folder handles locally saved news articles which are proposed by Mew/IM.
982 You can also read articles directly from a spool-file which is retrieved
983 by an utility like gnspool.
988 @samp{=} @var{directory-name}
991 @var{directory-name} is a sub-directory to the directory defined by variable
992 @code{elmo-localnews-folder-path} (default is @file{~/News})
993 You can use @samp{.} as directory delimiter as well as @samp{/}.
999 =fj/os/os2 -> "~/News/fj/os/os2"
1000 =fj.os.bsd.freebsd -> "~/News/fj/os/bsd/freebsd"
1005 @node Archive Folder, POP Folder, News Spool Folder, Folders
1006 @section Archive Folder
1007 @cindex Archive Folder
1011 This method can handle archive files, which are compressed by utilities
1012 such as Info-ZIP or LHA, as one folder.
1018 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1022 @var{path-name} is the relative path from
1023 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1024 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1025 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1026 also permitted under the environment of ange-ftp, efs.
1028 The actual file name of the archive folder is
1029 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1030 under the @var{path-name}. If a file named @var{path-name} exists, it is
1031 treated as folder. The suffix is automatically decided for
1032 @var{archiver-type}.
1034 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1035 (Initial setting is 'zip) is referred.
1037 @var{prefix} specifies the internal directory structure of the archive.
1038 For example, if the ML server is fml, @file{msend.tar.gz} has a structure like
1039 @file{spool/1}, so you have to specify @samp{spool} as @var{prefix}.
1045 $teranisi -> "~/Mail/teranisi/elmo-archive.zip"
1046 $bsd/freebsd;lha -> "~/Mail/bsd/freebsd/elmo-archive.lzh"
1047 $/foo@@server:~/bar;zoo -> "~/bar/elmo-archive.zoo" on ftp server
1048 $d:/msend.tar.gz;tgz;spool -> "d:/msend.tar.gz"
1053 * Archiver:: Archivers supported
1054 * Archive Tips:: TIPS
1055 * Archive Vars:: Customization
1059 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1060 @subsection Supported Archives
1070 By default, following archives are supported.
1074 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1075 GNU TAR('tgz, 'tar) ;; read-only
1079 If your archiver can include multiple files in one archive, you have a
1080 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1081 of the candidate. TAR is supported read-only because it cannot delete
1082 file in the archive ('mv)).
1084 gzip, bzip, bzip2 cannot be used as an archiver of Wanderlust because
1085 they cannot include multiple files. Archivers that cannot extract files
1086 to standard output are also not supported.
1088 @subsection OS specific information about archiver.
1090 Behaviors of the following archivers are confirmed by further experiences.
1091 (@samp{*} mark means recommended archiver).
1094 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1095 LHA OS/2 version Rel.2.06b Feb 18, 1998
1096 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1097 *Zip 2.2 (November 3rd 1997).
1098 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1099 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1100 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1102 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1103 LHa for UNIX V 1.14c
1104 UnZip 5.32 of 3 November 1997
1105 Zip 2.2 (November 3rd 1997)
1106 GNU tar 1.12 (1.11.x is no good)
1107 gzip 1.2.4 (18 Aug 93)
1109 [Win32] Win.98/Meadow
1113 GNU tar 1.11.8 + 1.5(WIN32)
1120 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1121 Hiramatsu version of LHA is only supported.
1122 In Win32, LHa32 is only supported (DOS version is no good).
1124 * Caution about GNU tar
1126 You have to take care about GNU tar's version because
1127 many version has problem on deleting file from archive.
1129 Please test @option{--delete} @option{-f} options work. Otherwise, your
1130 archive will be destroyed. No problem is reported on above versions of
1134 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1136 @cindex Archive Tips
1138 For comfortable migration, usage of @code{wl-summary-archive}
1139 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1140 archive folders created by expiration, you must set non-nil value to
1141 @code{elmo-archive-treat-file}.
1143 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1144 in processing speed. For comfortable use, Emacs20 is recommended.
1145 (If re-search's performance is the problem, 19.3x or later may be okay.)
1147 If many files are included in one archive,
1148 it takes long time to access to the archive folder because
1149 archiver starting overhead is increased (especially LHA).
1150 150-200 messages in one archive is recommended.
1152 Of course, following is possible @t{:-)}
1153 (meanings of these variables are described later.)
1157 (setq wl-fcc "$backup")
1158 (setq wl-trash-folder "$trash;lha")
1162 @node Archive Vars, , Archive Tips, Archive Folder
1163 @subsection Variables About Archive Folder
1164 @cindex Archive variables
1167 @item elmo-archive-default-type
1168 @vindex elmo-archive-default-type
1169 The initial setting is 'zip.
1170 Set archiver type by symbol.
1172 @item elmo-archive-@var{type}-method-alist
1173 @vindex elmo-archive-TYPE-method-alist
1174 Define archiver @var{type}'s methods.
1175 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1176 Each element of the alist is following.
1180 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1181 (@var{action} . @var{function}) ;; function
1185 Currently available actions are following.
1189 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1190 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1197 actions enclosed with braces are optional (They are used for better
1200 @item elmo-archive-suffix-alist
1201 @vindex elmo-archive-suffix-alist
1202 An alist of archiver-type (symbol) and suffix.
1204 @item elmo-archive-file-regexp-alist
1205 @vindex elmo-archive-file-regexp-alist
1206 An alist of a regexp to get file number from list output of archiver
1207 and archiver-type (symbol).
1209 @item elmo-archive-method-list
1210 @vindex elmo-archive-method-list
1211 A list of elmo-archive-@var{type}-method-alist
1212 (@var{type} is a symbol of archiver-type).
1214 @item elmo-archive-lha-dos-compatible
1215 @vindex elmo-archive-lha-dos-compatible
1216 The initial setting is t on OS/2 and Win32.
1217 If non-nil, LHA is DOS (Mr. Yoshizaki original) compatible.
1219 @item elmo-archive-cmdstr-max-length
1220 @vindex elmo-archive-cmdstr-max-length
1221 The initial setting is 8000.
1223 Max length of command line argument for external archiver program.
1224 Emacs does not have a limit of command line byte length, but some OS
1225 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1226 this limit because it calls external archiver program directly (not
1227 called via shell). For example, you cannot delete messages if archiver
1228 program must receive larger bytes of arguments to delete. OS/2 have a
1229 command line argument limit of 8190 bytes, so we defined default as 8000
1232 However, you don't have an influence of command line argument limit
1233 if the archiver has `actions' to receive target file information from
1234 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1237 @node POP Folder, Multi Folder, Archive Folder, Folders
1245 A folder to access e-mails via POP3 protocol (RFC 1939).
1251 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1256 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1257 as @var{authenticate-type}.
1261 @var{username} -> The value of @code{elmo-default-pop3-user}.
1262 Initial setting is @env{USER} environment variable or
1263 @env{LOGNAME} environment variable or return value of
1264 @code{(user-login-name)}.
1265 @var{authenticate-type} -> The value of @code{elmo-default-pop3-authenticate-type}.
1266 Initial setting is "user".
1267 @var{hostname} -> The value of @code{elmo-default-pop3-server}.
1268 Initial setting is "localhost".
1269 @var{port} -> The value of @code{elmo-default-pop3-port}.
1270 Initial setting is 110.
1277 &hoge@@localhost -> access to localhost as user "hoge".
1278 &hoge@@popserver:109 -> access to the server "popserver" on port 109
1283 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1284 (XEmacs doesn't need @file{md5.el}).
1285 @file{md5.el} is included in @file{utils/sasl/lisp/} or Emacs/W3 package:
1288 http://www.cs.indiana.edu/elisp/w3/docs.html
1291 or LCD archive (GPL2).
1293 If the last character of the folder name is @samp{!}, Wanderlust connects to
1294 the POP server via SSL (Secure Socket Layer). If you set non-nil
1295 value to @code{elmo-default-pop-ssl}, you don't have to put @samp{!} in the
1296 end of the folder name to use SSL.
1297 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
1298 if the value of @code{elmo-default-pop-ssl} is 'starttls,
1299 STARTTLS will be the default connection.
1301 @node Multi Folder, Filter Folder, POP Folder, Folders
1302 @section Multi Folder
1303 @cindex Multi Folder
1305 @cindex Folder, Multiple
1306 @cindex Folder, Marge
1308 A folder to access to a folder which collects messages from
1309 multiple folders virtually.
1315 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1319 After @samp{*} character, specify multiple folders you want to collect
1320 separated by ',' like
1321 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1327 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1328 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1329 treated as one folder.
1331 *+inbox,-fj.rec.tv,%inbox
1332 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1337 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1338 @section Filter Folder
1339 @cindex Filter Folder
1341 @cindex Folder, Filtering
1342 @cindex Folder, Virtual
1344 A folder to access to a folder which collects all messages that
1345 satisfy a condition virtually.
1350 @samp{/} @var{condition} @samp{/} @var{target-folder}
1353 In the @var{condition} part, you can specify following.
1357 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1359 first: @var{number} messages are picked from top of folder.
1360 last: @var{number} messages are picked from bottom of folder.
1366 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1367 /first:20/%inbox -> First 20 messages from %inbox are picked.
1372 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1374 since: only messages arrived since @var{date} are picked.
1375 before: only messages arrived before @var{date} are picked.
1377 You can specify following as @var{date}.
1381 yesterday -> a day before today.
1382 lastweek -> same day of last week.
1383 lastmonth -> same day of last month.
1384 lastyear -> same day of last year.
1385 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1386 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1394 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1396 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1402 Field filter: @samp{@var{field}:@var{value}}
1404 All messages that have @var{field} and its value is @var{value} are picked.
1405 @var{field} and @var{value} are case insensitive.
1411 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1412 and its value includes "teranisi" string are picked.
1413 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1421 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1422 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1424 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1425 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1431 /from:teranisi&!to:teranisi/+inbox
1432 -> In +inbox, messages are picked if the message's
1433 From: field includes "teranisi" and
1434 To: field doesn't include "teranisi".
1436 /tocc:"Yuuichi Teranishi"/+inbox
1437 -> In +inbox, messages are picked if the
1438 message's To: field or Cc: field includes
1439 "Yuuichi Teranishi".
1441 /(from:yt|from:teranisi)&subject:report/+inbox
1442 -> In +inbox, messages are picked if the message's
1443 From: field includes "yt" or "teranisi", and
1444 Subject includes "report".
1450 Tip for string description:
1452 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1453 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1454 should be escaped with @samp{\} in it). You can enclose the string with
1455 @samp{"} even it does not contain these characters.
1461 *%inbox,/from:teranisi/%inbox@@server
1462 -> Messages in %inbox or
1463 message is in the %inbox@@server folder and it's From field
1464 includes "teranisi" are collected.
1466 /last:100//to:teranisi/*+inbox,%inbox
1467 -> Latest 100 messages which is in the +inbox or %inbox folder
1468 and To: field matches "teranisi".
1470 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1471 -> Pick messages which have From: field and it includes "hogehoge"
1472 from latest 20 messages in the %#mh/inbox@@localhost
1473 and To: or Cc: field includes "teranisi".
1476 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1477 @section Pipe Folder
1481 @cindex Download Message
1482 @cindex Incorporate Message
1484 In the pipe folder, messages are automatically transferred from the source
1485 folder to destination folder.
1490 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1493 When you access to the pipe folder, messages are automatically transferred
1494 from @var{source-folder} to @var{destination-folder}.
1495 It is convenient if you want to download messages to local disk via POP.
1496 For example, if you specify following
1499 |&username@@popserver|+inbox
1502 and access to it, messages are downloaded automatically from
1503 &username@@popserver to @samp{+inbox}.
1509 %inbox|%myinbox -> Download %inbox to %myinbox.
1510 *&user@@popserver1,&user@@popserver2|+inbox
1511 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1515 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1517 @node Internal Folder, , Pipe Folder, Folders
1518 @section Internal folder
1519 @cindex Internal Folder
1521 @cindex Folder, @samp{$} mark
1523 A folder to access to internal messages of Wanderlust.
1535 A folder named 'mark is a special virtual folder which collects messages
1536 which have important mark @samp{$}.
1538 You can review important messages at once after you put important marks
1539 on the messages in the different folders.
1541 In this folder, if you delete message, important mark @samp{$} put on
1542 the message is removed. If you append messages to this folder, the
1543 message will have @samp{$} mark.
1545 You can access to the cached messages fetched via network by accessing
1546 to the folders named 'cache/00 - 1F. 00 - 1F are the name of the
1547 subdirectories of the cache directory (@file{~/.elmo/cache}).
1550 @node Folder, Summary, Folders, Top
1551 @chapter Folder mode
1554 After you start Wanderlust, folder mode is appeared firstly.
1555 It contains folder list you subscribed.
1556 You can select and edit folders in this mode.
1559 * Selecting Folder:: Select folder you want to read.
1560 * Folder Manager:: Editing folders.
1564 @node Selecting Folder, Folder Manager, Folder, Folder
1565 @section Selecting Folder
1566 @cindex Selecting Folder
1568 @subsection Usage (TIPS)
1570 @subsubsection Check new, unread number
1572 Folder mode looks like this.
1573 (In XEmacs, it looks much nicer @t{;-)})
1577 [-]Desktop:14186/35580/67263
1582 [-]Emacsen:0/34/4837
1583 Wanderlust ML:0/0/558
1586 XEmacs Beta:0/29/255
1597 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1601 @kbd{s} key on the folder line updates these numbers.
1602 It changes its color if it has many new messages.
1604 The whole folder mode is a folder group named @samp{Desktop}.
1605 Folder group open/close by return key.
1606 A operation to a folder group is treated as operations on the
1608 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1609 six children folders update its unread number status.
1611 @subsubsection Select Folder
1613 To enter summary mode of the folder, type return (or space) key on
1615 If the variable @code{wl-stay-folder-window} has non-nil value,
1616 summary window appears on the right of the folder mode window.
1618 @subsection Key bindings
1620 Folder mode's key binding (related to selecting folders) is following.
1625 @kindex @key{SPC} (Folder)
1626 @kindex @key{RET} (Folder)
1627 @findex wl-folder-jump-to-current-entity
1628 Enter to the summary mode of the folder at the current cursor point.
1629 If the cursor is on the top of folder group line,
1630 the folder group is opened or closed.
1631 When the cursor is on the access group and this command is called
1632 with prefix argument, folder children list is updated to the newest one.
1633 (Children list is updated recursively if the access folder has hierarchical
1635 (@code{wl-folder-jump-to-current-entity})
1638 @kindex M-@key{RET} (Folder)
1639 @findex wl-folder-update-recursive-current-entity
1640 Folder children list of the access group at the current cursor point
1641 is updated to the newest one.
1642 (Children list is updated recursively if the access folder has hierarchical
1644 (@code{wl-folder-update-recursive-current-entity})
1649 Create a new draft message.
1654 @findex wl-folder-write-current-newsgroup
1655 If the current cursor point is on the NNTP folder,
1656 create a new draft message which already has newsgroups field.
1657 (@code{wl-folder-write-current-newsgroup})
1660 @kindex C-c C-o (Folder)
1661 @findex wl-jump-to-draft-buffer
1662 Move to the draft buffer if available. If multiple draft buffer exists,
1663 moved to one after another. If prefix argument is specified, load draft
1664 folder's message to the draft buffer and jump to it.
1665 (@code{wl-jump-to-draft-buffer})
1669 @findex wl-folder-check-current-entity
1670 Update new and unread number information of the folder at the current
1672 (@code{wl-folder-check-current-entity})
1676 @findex wl-folder-sync-current-entity
1677 Update summary information of the folder at the current cursor point.
1678 (@code{wl-folder-sync-current-entity})
1681 @kindex r s (Folder)
1682 @findex wl-folder-check-region
1683 Update new and unread number information of the folders in the currently
1685 (@code{wl-folder-check-region})
1688 @kindex r S (Folder)
1689 @findex wl-folder-sync-region
1690 Update summary information of the folders in the currently selected region.
1691 (@code{wl-folder-sync-region})
1695 @findex wl-status-update
1696 Sync up address book status with @file{~/.addresses}'s content.
1697 (@code{wl-status-update})
1701 @findex wl-folder-prev-unread
1702 Jump cursor to the folder which have unread messages on the upward from
1703 current cursor point.
1704 (@code{wl-folder-prev-unread})
1708 Jump cursor to the folder which have unread messages on the downward
1709 from current cursor point.
1710 (@code{wl-folder-next-unread})
1714 Move cursor to the folder on the previous line.
1715 (@code{wl-folder-prev-entity})
1719 Move cursor to the folder on the next line.
1720 (@code{wl-folder-next-entity})
1724 Jump to the folder specified by the user input.
1725 (@code{wl-folder-jump-folder})
1729 @findex wl-folder-prefetch-current-entity
1730 Prefetch new messages of the folder at the current cursor point by
1731 @code{wl-summary-incorporate}.
1732 If the cursor is on the folder group, it is executed recursively.
1733 (@code{wl-folder-prefetch-current-entity})
1737 @findex wl-folder-mark-as-read-all-current-entity
1738 Mark all unread messages of the folder at the current cursor point as read.
1739 If the cursor is on the folder group, it is executed recursively.
1740 (@code{wl-folder-mark-as-read-all-current-entity})
1744 @findex wl-folder-goto-first-unread-folder
1745 Enter summary mode of the first unread folder.
1746 (@code{wl-folder-goto-first-unread-folder})
1750 @findex wl-folder-empty-trash
1752 (@code{wl-folder-empty-trash})
1756 @findex wl-folder-open-all-unread-folder
1757 All unread folder is opened.
1758 (@code{wl-folder-open-all-unread-folder})
1762 @findex wl-folder-open-close
1763 Folder group is opened/closed.
1764 (@code{wl-thread-open-close})
1768 All folder group is opened.
1769 (@code{wl-folder-open-all})
1773 All folder group is closed.
1774 (@code{wl-folder-close-all})
1784 (@code{wl-folder-suspend})
1787 @kindex M-s (Folder)
1788 Save current folder status.
1792 @kindex M-t (Folder)
1793 Toggle Wanderlust's offline/online status.
1794 (@code{wl-toggle-plugged})
1797 @kindex C-t (Folder)
1798 Start Wanderlust's plug-status manager.
1799 (@code{wl-plugged-change})
1802 @subsection Customize variables
1805 @item wl-folders-file
1806 @vindex wl-folders-file
1807 The initial setting is @file{~/.folders}.
1808 Subscribed folders are described (saved) in this file.
1810 @item wl-folder-info-save
1811 @vindex wl-folder-info-save
1812 The initial setting is t.
1813 If non-nil, unread information is saved and used in the next Wanderlust session.
1815 @item wl-stay-folder-window
1816 @vindex wl-stay-folder-window
1817 The initial setting is nil.
1818 If non-nil, summary window is appeared on the right side of the folder buffer.
1820 @item wl-folder-window-width
1821 @vindex wl-folder-window-width
1822 The initial setting is 20.
1823 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1825 @item wl-folder-many-unsync-threshold
1826 @vindex wl-folder-many-unsync-threshold
1827 The initial setting is 70.
1828 If the number of unread messages is more than this value,
1829 folder color is changed.
1831 @item wl-highlight-folder-by-numbers
1832 @vindex wl-highlight-folder-by-numbers
1833 This option controls how to highlight each line in the folder buffer.
1834 The default value is @code{t}, highlighting with various colors based on
1835 the message numbers. If it is @code{nil}, highlighting with various
1836 colors based on the folder status. In addition, if it is a number
1837 (e.g. @code{1}), highlighting will be done based on both the message
1838 numbers and the folder status.
1840 @item wl-folder-desktop-name
1841 @vindex wl-folder-desktop-name
1842 The initial setting is @samp{Desktop}.
1843 The name of top folder group.
1845 @item wl-folder-petname-alist
1846 @vindex wl-folder-petname-alist
1847 The initial setting is nil.
1848 An alist of folder's realname and its nickname.
1850 @item wl-folder-access-subscribe-alist
1851 @vindex wl-folder-access-subscribe-alist
1852 The initial setting is nil.
1854 Control automatic subscribing and unsubscribing of the children list
1860 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1864 If @var{subscribe-flag} is non-nil, folders which have name matched to
1865 @var{regexp-of-folders} are displayed. Otherwise, hidden.
1866 However, already unsubscribed folder is not displayed even
1867 when the @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be specified.
1873 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1874 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1875 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1876 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1880 @item wl-folder-hierarchy-access-folders
1881 @vindex wl-folder-hierarchy-access-folders
1882 The initial setting is '("-" "-alt").
1883 A list of access groups which creates children folder list hierarchically.
1885 For example, if you specify
1886 @code{wl-folder-hierarchy-access-folders} like following,
1890 (setq wl-folder-hierarchy-access-folders
1891 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1896 such access group hierarchy is obtained.
1902 -fj.comp.announce:0/0/2
1903 -fj.comp.dev.cdrom:0/0/0
1905 [+]-japan:238/238/1688
1908 -comp.unix.admin:0/0/0
1909 -comp.unix.dos-under-unix:0/0/0
1910 -comp.unix.programmer:0/0/0
1911 [-]-comp.unix.bsd:0/0/23
1912 -comp.unix.bsd.freebsd.announce:0/0/0
1917 If you opened @samp{-} in this example, only the direct children is created
1918 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1919 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1920 is not created until the children access group is opened.
1924 @node Folder Manager, , Selecting Folder, Folder
1925 @section Editing Folders
1926 @cindex Folder Manager
1927 @cindex Folder, Edit
1928 @cindex Folder, Subscribe
1929 @cindex Folder, Unsubscribe
1931 As described before, subscribed folder list is saved in @file{~/.folders} file.
1932 But you don't have to edit @file{~/.folders} directly.
1933 You can append, delete, edit folders from folder mode.
1935 @subsection Usage (Tips)
1937 @subsubsection Append Folder
1939 @kbd{m a} appends new folder to the folder mode.
1940 @kbd{m g} appends new folder group.
1941 To append new folder to this group, firstly open it,
1942 then execute append command in the next line.
1944 @subsubsection Edit Folder
1946 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1947 Thus, you can change folder position as if you were editing a normal file.
1949 @subsubsection Create Multi Folder.
1953 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
1955 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
1957 Type @kbd{m m}, then you can create multi folder.
1960 @subsubsection Delete Nickname, Filter
1962 You can delete nickname or filter by putting ""(NULL) from the minibuffer
1965 @subsubsection Append Folder to Empty Group
1967 To append new folder to the empty folder group
1968 (after you create folder group by typing @kbd{m g}),
1969 firstly open it, then execute append command in the next line.
1970 If it is closed, folder is appended on the same level with
1971 the above folder group. It is difficult to explain by words so try it.
1972 In other words, appended position depends on the
1973 above folder group's open/close status.
1975 @subsubsection Charset of the Folders File.
1977 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
1979 @subsubsection Create Filter
1981 @kbd{m f} adds filter to the folder at the current cursor point.
1982 To create new filter folder and leave the current folder unchanged,
1983 copy it @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}.
1984 Multiple filter can be specified while appending filter.
1985 If you put ""(NULL), filter is deleted.
1987 @subsubsection Sort Folders
1989 Sorting of the folders is executed by the function specified by
1990 @code{wl-fldmgr-sort-func}.
1991 The initial setting is @code{wl-fldmgr-sort-standard},
1992 which sorts alphabetically.
1993 Sorting affects only on the current folder group. It does not
1994 affect on the child groups.
1996 @subsubsection Hiding Folders in the Access Group
1998 Usually, access group displays all children folders, but you can set
1999 some folders hidden. Following operations are only available on access
2002 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2003 (subscribe/unsubscribe) of the folder at current cursor point. Against
2004 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2007 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2008 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2009 argument and if the argument has positive number, the unsubscribe it.
2010 If the prefix argument has negative value, folder becomes visible and if
2011 zero, folder visibility is toggled.
2013 The other commands, @code{wl-fldmgr-subscribe} and
2014 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2017 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2018 executed in the access group, they have a same effect with
2019 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2020 The difference is that cut(-region) commands deletes folders from the
2023 @subsubsection Operations in the Access Group
2025 You can insert and delete folders in the access group like usual folder
2026 group. But insert and delete commands can be only available for the
2027 children folders of the access group and they only sets the subscribe
2028 status. In other words, insertion of the folder means subscribing,
2029 deletion means unsubscribing.
2030 @footnote{In the current implementation,
2031 it is faster to delete region than to unsubscribe region.}
2033 To update the access group when children folders are inserted or deleted
2034 by other way (other than Wanderlust),
2035 open the access group by typing @kbd{C-u @key{RET}}.
2036 @xref{Selecting Folder}.
2038 The order of children folders of access group is saved after
2039 insertion/deletion/sorting.
2040 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2041 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2042 newly created folders are inserted on the top of the access group.
2044 @subsection Key bindings
2045 @cindex Keybind, Folder Mode
2046 @cindex Keybind, Folder Buffer
2048 Key bindings on the folder mode related to folder editing are shown below.
2049 All bindings starts with @kbd{m}, and primary commands are binded to
2050 one stroke key binding.
2054 @kindex m a (Folder)
2055 @findex wl-fldmgr-add
2057 (@code{wl-fldmgr-add})
2062 @kindex m g (Folder)
2063 @findex wl-fldmgr-make-group
2064 Create a folder group.
2065 (@code{wl-fldmgr-make-group})
2068 @kindex m A (Folder)
2069 @findex wl-fldmgr-make-access-group
2070 Create an access group.
2071 (@code{wl-fldmgr-make-access-group})
2074 @kindex m d (Folder)
2075 @findex wl-fldmgr-delete
2076 Delete folder itself and msgdb.
2077 If the folder itself cannot be deleted like NNTP folder,
2078 only msgdb is deleted.
2079 (@code{wl-fldmgr-delete})
2084 @kindex m R (Folder)
2085 @findex wl-fldmgr-rename
2086 Change the name of folder or folder group.
2087 msgdb's path is also changed.
2088 (@code{wl-fldmgr-rename})
2094 @findex wl-fldmgr-make-multi
2095 Create a multi folders in the cutlist (cut, copied folders).
2096 (@code{wl-fldmgr-make-multi})
2101 @kindex m f (Folder)
2102 @findex wl-fldmgr-make-filter
2103 Create a filter folder. (Put a filter on the folder).
2104 (@code{wl-fldmgr-make-filter})
2108 @kindex M-c (Folder)
2109 @kindex m c (Folder)
2110 @findex wl-fldmgr-copy
2111 Copy folder (it is not available on folder group).
2112 (@code{wl-fldmgr-copy})
2116 @kindex M-w (Folder)
2117 @kindex m W (Folder)
2118 @findex wl-fldmgr-copy-region
2119 Copy folders in the specified region.
2120 (@code{wl-fldmgr-copy-region})
2124 @kindex C-k (Folder)
2125 @kindex m k (Folder)
2126 @findex wl-fldmgr-cut
2127 Cut folder. Folder itself is not deleted.
2128 (@code{wl-fldmgr-cut})
2132 @kindex C-w (Folder)
2133 @kindex m C-w (Folder)
2134 @findex wl-fldmgr-cut-region
2135 Cut folders in the specified region.
2136 (@code{wl-fldmgr-cut-region})
2140 @kindex C-y (Folder)
2141 @kindex m y (Folder)
2142 @findex wl-fldmgr-yank
2143 Paste folders that are copied or cut (folders in the cut-list).
2144 (@code{wl-fldmgr-yank})
2147 @kindex m p (Folder)
2148 @findex wl-fldmgr-set-petname
2149 Put nickname on the folder.
2150 (@code{wl-fldmgr-set-petname})
2153 @kindex m q (Folder)
2154 @findex wl-fldmgr-clear-cut-entity-list
2155 Clear the cut-list. (cut, copied folder information is cleared,
2156 you cannot paste after this)
2157 (@code{wl-fldmgr-clear-cut-entity-list})
2160 @kindex m s (Folder)
2161 @findex wl-fldmgr-sort
2162 Sort folders in the current folder group.
2163 (@code{wl-fldmgr-sort})
2166 @kindex m C-s (Folder)
2167 @findex wl-fldmgr-save
2168 Save current folder view to the @file{wl-folders-file}.
2169 (@code{wl-fldmgr-save})
2172 [Following commands are only available on the access groups]
2178 @kindex m u (Folder)
2179 @findex wl-fldmgr-unsubscribe
2180 Set the visibility of folder (subscribe/unsubscribe).
2181 (@code{wl-fldmgr-unsubscribe})
2186 @kindex r u (Folder)
2187 @findex wl-fldmgr-unsubscribe-region
2188 Set the visibility of the folders (subscribe/unsubscribe) in the
2190 (@code{wl-fldmgr-unsubscribe-region})
2195 @kindex m l (Folder)
2196 @findex wl-fldmgr-access-display-normal
2197 List folders that are currently available.
2198 (@code{wl-fldmgr-access-display-normal})
2203 @kindex m L (Folder)
2204 @findex wl-fldmgr-access-display-all
2205 List all folders regardless of the subscription status.
2206 (@code{wl-fldmgr-access-display-all})
2210 @subsection Customize variables
2213 @item wl-interactive-save-folders
2214 @vindex wl-interactive-save-folders
2215 The initial setting is t.
2216 If non-nil and folder view is modified, confirm saving it before
2217 Wanderlust or Emacs exits.
2218 If nil, save without confirmation.
2220 @item wl-fldmgr-make-backup
2221 @vindex wl-fldmgr-make-backup
2222 The initial setting is t.
2223 If non-nil, @file{~/.folders.bak} is created before saving the folder status.
2225 @item wl-fldmgr-sort-func
2226 @vindex wl-fldmgr-sort-func
2227 The initial setting is 'wl-fldmgr-sort-standard.
2228 A function to sort folders.
2229 By default function, folders are sorted alphabetically and
2230 folder group is put on top
2231 (when @code{wl-fldmgr-sort-group-first} is non-nil).
2233 @item wl-fldmgr-sort-group-first
2234 @vindex wl-fldmgr-sort-group-first
2235 The initial setting is t.
2236 If non-nil, @code{wl-fldmgr-sort-standard} precedes folder group.
2237 If nil, it does not care whether it is folder group or not.
2239 @item wl-folder-check-async
2240 @vindex wl-folder-check-async
2241 The initial setting is t.
2242 If non-nil, check folder's unread status asynchronously.
2243 It boosts newsgroup checking.
2245 @item wl-folder-check-fast
2246 @vindex wl-folder-check-fast
2247 The initial setting is nil.
2248 If non-nil, it does not update folder status while checking.
2250 @item wl-folder-notify-deleted
2251 @vindex wl-folder-notify-deleted
2252 The initial setting is nil.
2254 If non-nil, negative value is displayed when the message is deleted.
2255 If 'sync, folder is synchronized when the message is deleted.
2256 If nil, message deletion is ignored.
2259 @subsection Miscellanea
2261 Following is a note for folder editing.
2265 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2266 paste(yank) command pastes the folders on one cut or copy command
2267 (If copy command is executed by region, folders in the region are pasted
2268 by one paste command)
2271 You cannot cut @samp{Desktop} group.
2272 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2275 You cannot copy folder group.
2278 Operations on the access group are only available for the folders
2279 in the same access group.
2282 You cannot create a folder which has same name with the folders already exist.
2285 You cannot insert folders which have same name in one group.
2286 You can insert them in the different groups.
2287 You cannot put same nickname to the different folders.
2291 @node Summary, Message, Folder, Top
2292 @chapter Summary Mode
2294 After you select the folder via folder mode, you enter to the summary
2298 * Usage of Summary Mode:: TIPS.
2299 * Thread Oparations:: Thread oparations.
2300 * Cache:: File cache, Buffer cache, and Prefetch.
2301 * Auto Refile:: Auto refile settings.
2302 * Sticky Summary:: Summary make sticky.
2303 * Key Bindings of Summary:: Key bindings.
2304 * Variables of Summary:: Customize Summary Mode.
2308 @node Usage of Summary Mode, Thread Oparations, Summary, Summary
2309 @section Usage (Tips)
2311 @subsection Summary Content
2313 In the summary mode, messages are displayed like following.
2317 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2318 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2319 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2320 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2327 Message number, Temporal mark, Persistent mark, Date, Sender, Subject
2331 You cannot change this in the current version.
2333 'Message number' is the message's unique number in the folder. In the NNTP
2334 folder, it is article number, in the IMAP folder, it is UID and in the
2335 MH folder, it is the filename of the message.
2337 Temporal and Persistent marks are described later.
2339 'Date' is displayed like 'Month/Day(Week Day)Hour:Minute'.
2340 Default setting displays week day in Japanese, but if you want to
2341 display it in English, set the value of @code{wl-summary-weekday-name-lang}
2344 'Sender's indentation corresponds to the depth of the thread.
2345 Sender name is displayed as nickname if it is defined in the address book.
2346 Set @code{wl-use-petname} as nil, if you want to quit displaying with nickname.
2348 If number is printed at the head of 'sender' part like @samp{+2},
2349 that means the message have 2 follow messages.
2351 'Subject' is the Subject header field of the message. If the message
2352 have same subject with the parent message, it is not displayed. Some
2353 mailing list puts its sequence number in the subject field, but it is
2354 ignored. @code{wl-summary-no-subject-message} is displayed when the
2355 message has empty subject field.
2357 @subsection Temporary Marks
2358 @cindex Mark, Temporary
2360 There are four temporary marks,
2361 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2362 Temporary marks indicates message operations.
2367 You can execute a command on the all messages that have @samp{*} mark,
2368 with the key bindings which begins with @kbd{m}.
2371 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2375 After you type @kbd{o} key, prompt appears to input refile destination.
2376 Your answer is printed in the summary line.
2380 You can put this mark by typing @kbd{O} key.
2381 The difference between this mark and refile mark is,
2382 this mark does not delete the message while latter does.
2385 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2387 @subsection Persistent Marks
2389 There are five persistent marks,
2390 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2392 The persistent mark indicates the message's status and it is saved.
2393 Each persistent mark indicates:
2399 It is unread message.
2401 It is unread but cached message.
2403 It is read but it is not cached.
2405 It is important message. You can put @samp{$} mark by typing @kbd{$}
2406 key (if already exists, the mark is deleted). It is convenient to put
2407 this mark on the messages to remember (If you want to remember to write
2408 a reply for the message, for example) because this mark remains after
2409 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2410 even the message itself is deleted in the actual folder.
2413 If the message is read and cached (or local message),there are no
2417 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2418 cache. Messages with the marks other than these, you can read them in
2419 the offline status even they are in the IMAP folder or netnews folder.
2421 @subsection How To Read
2423 Basically, you can read messages only typing space key again and again.
2425 To update summary status to the newest status (synchronize),
2428 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2429 moves cursor to the next message.
2430 Enter message buffer by typing @kbd{j} key.
2431 To operate multipart, you have to enter to the message buffer.
2435 @node Thread Oparations, Cache, Usage of Summary Mode, Summary
2436 @section Thread Operations
2438 For example, the following line indicates one thread (a context of a topic).
2441 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2445 If you type @kbd{/} on this line, the thread is opened and it changes
2446 the appearance like following.
2450 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2451 388 09/17(Thu)22:34 +-[ Murata san ]
2455 (Message 388 is the replied message to the message 384.)
2456 If you type @kbd{/} key once again, the thread is closed.
2457 With prefix argument, @kbd{/} opens all children threads.
2459 Commands with the key binding that begins with @kbd{t} executes commands
2460 on the messages in the thread.
2463 @node Cache, Auto Refile, Thread Oparations, Summary
2466 @subsection Cache File
2468 The messages which have to access via network (e.x. IMAP, NNTP folder)
2469 are cached as a local file.
2470 The cache file is saved under the directory @file{~/.elmo/cache}.
2472 To expire cache, type following.
2475 M-x elmo-cache-expire-by-size
2479 The command deletes cache files to the specified size by the order of
2482 @subsection Buffer Cache and Prefetching
2484 If the value of @code{elmo-use-buffer-cache} is non-nil,
2485 the messages that are read are kept in the cache buffer.
2486 It is called `buffer cache'.
2487 The number of cache buffer is specified by @code{elmo-buffer-cache-size}.
2489 There are message prefetching mechanism in the Wanderlust that prefetches next
2490 message while you are reading. This function requires that the value of
2491 @code{elmo-use-buffer-cache} is non-nil.
2493 You can control the message prefetching mechanism by these two variables.
2496 @item wl-cache-prefetch-folder-type-list
2497 @vindex wl-cache-prefetch-folder-type-list
2498 The initial setting is '(nntp imap4).
2499 It specifies the folder types in which message prefetching is enabled.
2500 In the initial setting, multi folder that contains localdir and imap4
2501 prefetches only imap4 messages.
2502 This variable precedes the value of @code{wl-cache-prefetch-folder-list}.
2504 If you want to prefetch localdir and localnews also, following setting is needed.
2507 (setq wl-cache-prefetch-folder-type-list
2508 '(nntp imap4 localdir localnews))
2512 @item wl-cache-prefetch-folder-list
2513 @vindex wl-cache-prefetch-folder-list
2514 The initial setting is nil.
2515 A list of regexp of folders to enable message prefetching.
2519 @node Auto Refile, Sticky Summary, Cache, Summary
2520 @section Auto Refile
2521 @vindex elmo-msgdb-extra-fields
2522 @vindex wl-refile-rule-alist
2523 @findex wl-summary-auto-refile
2525 You can refile messages automatically, by typing @kbd{C-o}
2526 (@code{wl-summary-auto-refile}). It decides destination of refile by
2527 the content of the message header information (information in the msgdb).
2529 By default, @samp{From}, @samp{Subject}, @samp{To} and @samp{Cc} is available.
2530 If you want to decide destination by other header fields,
2531 set the variable @code{elmo-msgdb-extra-fields} like following.
2535 (setq elmo-msgdb-extra-fields
2545 By this setting, Wanderlust saves extra fields in the msgdb. You have
2546 to type @kbd{s all} to get extra fields for the messages that are
2547 already exists in the summary.
2549 Then, specify the refile rule. The refile target folder of auto
2550 refiling is decided by the value of @code{wl-refile-rule-alist}.
2551 @code{wl-refile-rule-alist} is a list of a rule:
2555 (@var{field} (@var{regexp} . @var{target})
2556 (@var{regexp} . @var{target})
2561 Each rule means `if @var{field} value matches @var{regexp},
2562 then refile to @var{target} folder'.
2563 The rule matched first is applied.
2565 @var{field} is a string of field name. You can specify a list of field name
2566 string, too. In this case, if one of these fields is matched, then the
2567 rule is fired (i.e. OR condition).
2569 @var{regexp} is a regular expression for field value. @var{target} is a target
2570 folder string. You can specify a rule at @var{target} part, too. In this
2571 case, If the field value of the rule and the current rule is matched,
2572 then the current rule is fired (i.e. AND condition).
2574 In @var{target} part, you can refer matched substring of @var{regexp}.
2575 To refer substring, specify following in @var{target}:
2579 means substitute original matched text.
2582 means substitute what matched the @var{N}th `\(@dots{}\)'.
2583 (@var{N} is a number.)
2586 Following is an example of @code{wl-refile-rule-alist}.
2590 (setq wl-refile-rule-alist
2592 ("^Wanderlust" . "+wl")
2593 ("^Elisp" . "+elisp"))
2595 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2597 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2598 "+from-me-to-you"))))))
2602 After these settings, refile marks are automatically put on the condition
2603 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2605 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2607 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2608 with these persistent marks are not automatically refiled.
2609 It means Wanderlust does not execute auto refile on unread messages by
2610 the default setting.
2611 To execute auto refile on all messages, set following.
2614 (setq wl-summary-auto-refile-skip-marks nil)
2618 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2619 @section Sticky Summary
2620 @cindex Summary, Sticky
2621 @cindex Sticky Summary
2623 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2625 Sticky buffer is created by entering the summary by typing @kbd{C-u g} or
2626 type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2628 The buffer name of the sticky summary becomes like
2629 @samp{Summary:@var{folder-name}}.
2631 You can visit the sticky summary at any time by @kbd{C-x b}
2632 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2633 q}. Other operations in the sticky summary are same as normal summary.
2635 @code{wl-summary-always-sticky-folder-list} specifies the folders that are
2636 automatically sticked.
2639 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2640 @section Key bindings
2641 @cindex Keybind, Summary Mode
2642 @cindex Keybind, Summary Buffer
2644 Key bindings of the summary mode are shown below.
2648 @kindex @key{SPC} (Summary)
2649 @findex wl-summary-read
2650 Proceed reading a message at the current cursor point.
2651 (@code{wl-summary-read})
2655 @findex wl-summary-redisplay
2656 Redisplay a message at the current cursor point.
2657 If this command is called with prefix argument,
2658 Redisplay message regardless of the message cache (message is re-loaded
2660 (@code{wl-summary-redisplay})
2664 @findex wl-summary-display-top
2665 Display the top message in the folder.
2666 (@code{wl-summary-display-top})
2670 @findex wl-summary-display-bottom
2671 Display the bottom message in the folder.
2672 (@code{wl-summary-display-bottom})
2676 @kindex @key{BS} (Summary)
2677 @kindex @key{DEL} (Summary)
2678 Display the previous page of the message at the current cursor point.
2679 @findex wl-summary-prev-page
2680 (@code{wl-summary-prev-page})
2683 @kindex @key{RET} (Summary)
2684 @findex wl-summary-next-line-content
2685 Display the next line of the message at the current cursor point.
2686 Display the message at the current cursor point if it is not displayed yet.
2687 (@code{wl-summary-next-line-content})
2692 @kindex M-@key{RET} (Summary)
2693 @findex wl-summary-prev-line-content
2694 Display the previous line of the message at the current cursor point.
2695 Display the message at the current cursor point if it is not displayed yet.
2696 (@code{wl-summary-prev-line-content})
2700 @findex wl-thread-open-close
2701 Toggle open or close the thread at the current cursor point.
2702 (@code{wl-thread-open-close})
2707 @findex wl-thread-open-all
2708 (@code{wl-thread-open-all})
2713 @findex wl-thread-close-all
2714 (@code{wl-thread-close-all})
2718 @findex wl-summary-goto-folder
2720 (@code{wl-summary-goto-folder})
2724 Mark all messages in the folder as read.
2725 @findex wl-summary-mark-as-read-all
2726 (@code{wl-summary-mark-as-read-all})
2730 @findex wl-summary-reply
2731 Prepare a draft for reply the message at the current cursor point.
2732 (@code{wl-summary-reply})
2736 @findex wl-summary-reply-with-citation
2737 Prepare a draft for reply the message at the current cursor point.
2738 (@code{wl-summary-reply-with-citation})
2742 @findex wl-summary-cancel-message
2743 If the message at current cursor point is your own netnews article,
2745 (@code{wl-summary-cancel-message})
2749 @findex wl-summary-reedit
2750 Prepare a draft for re-editing the message at current cursor point.
2751 If the message at current cursor point is your own netnews article,
2752 a draft for `supersedes message' for the message is prepared.
2753 (@code{wl-summary-reedit})
2756 @kindex M-e (Summary)
2757 @findex wl-summary-resend-bounced-mail
2758 If the message at current cursor point is a bounced message,
2759 a draft for re-sending original message is prepared.
2760 (@code{wl-summary-resend-bounced-mail})
2764 @findex wl-summary-forward
2765 A draft for forwarding the message at current cursor point is prepared.
2766 (@code{wl-summary-forward})
2770 @findex wl-summary-mark-as-important
2771 Put @samp{$} mark on the message at current cursor point.
2772 If already marked as @samp{$}, delete it.
2773 (@code{wl-summary-mark-as-important})
2779 Save the message at current cursor point.
2780 @findex wl-summary-save
2781 (@code{wl-summary-save})
2785 @findex wl-summary-next
2786 Move cursor to the next message.
2787 If message is marked with a temporal mark in
2788 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2789 In the offline mode, cursor is not moved to the messages which are not cached
2791 (@code{wl-summary-next})
2795 @findex wl-summary-prev
2796 Move cursor to the previous message.
2797 If message is marked with a temporal mark in
2798 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2799 In the offline mode, cursor is not moved to the messages which are not cached
2801 (@code{wl-summary-prev})
2805 @findex wl-summary-down
2806 Move cursor to the downward message which is unread or marked
2808 (@code{wl-summary-down})
2812 @findex wl-summary-up
2813 Move cursor to the upward message which is unread or marked
2815 (@code{wl-summary-up})
2819 @findex wl-summary-write
2820 Prepare a new draft.
2821 (@code{wl-summary-write})
2825 @findex wl-summary-write-current-newsgroup
2826 Prepare a new draft.
2827 If the current folder is netnews folder, Newsgroups: field is completed.
2828 (@code{wl-summary-write-current-newsgroup})
2832 @findex wl-summary-redisplay-all-header
2833 Redisplay the message at current cursor point with all header fields.
2834 (@code{wl-summary-redisplay-all-header})
2838 @findex wl-summary-redisplay-no-mime
2839 Redisplay the message at current cursor point without MIME analysis.
2840 (@code{wl-summary-redisplay-no-mime})
2844 @findex wl-summary-burst
2845 If the message at current cursor point has
2846 encapsulates multiple messages using MIME,
2847 de-capsulate and extract them on the current folder.
2848 (@code{wl-summary-burst})
2851 @kindex @@ (Summary)
2852 @findex wl-summary-edit-addresses
2853 Append/change/delete the message's sender information to the address book
2854 @file{~/.addresses} interactively.
2855 If this command is called with prefix argument, arbitrary address can be edited.
2856 (@code{wl-summary-edit-petname})
2860 @findex wl-status-update
2861 Sync up address book status with @file{~/.addresses}'s content.
2862 (@code{wl-status-update})
2866 @findex wl-summary-pipe-message
2867 Pipe current message's content to the external process.
2868 (@code{wl-summary-pipe-message})
2872 @findex wl-summary-print-message
2873 Print out current message's content.
2874 It uses @code{ps-print} module in Emacs 20.x.
2875 If you don't use color printer, you might want to set
2876 @code{wl-ps-print-buffer-func} to @code{ps-print-buffer}.
2879 (setq wl-ps-print-buffer-func 'ps-print-buffer)
2882 (@code{wl-summary-print-message})
2886 @findex wl-summary-exit
2887 Exit current folder.
2888 (@code{wl-summary-exit})
2892 @findex wl-summary-jump-to-current-message
2893 Jump cursor to the currently displayed message's window.
2894 (@code{wl-summary-jump-to-current-message})
2898 Jump cursor to the other message.
2899 @findex wl-summary-jump-to-msg
2900 (@code{wl-summary-jump-to-msg})
2904 Update summary status and
2905 prefetch all messages which have marks included in the
2906 @code{wl-summary-incorporate-marks}.
2907 @findex wl-summary-incorporate
2908 (@code{wl-summary-incorporate})
2911 @kindex M-j (Summary)
2912 @findex wl-summary-jump-to-msg-by-message-id
2913 Jump cursor to the message which have specified Message-Id.
2914 If @code{elmo-use-database} is non-nil, other folder is also searched.
2915 (@code{wl-summary-jump-to-msg-by-message-id})
2919 Jump to parent message.
2920 @findex wl-summary-jump-to-parent-message
2921 (@code{wl-summary-jump-to-parent-message})
2925 @findex wl-summary-mark-as-unread
2926 Mark as unread the message at current cursor point.
2927 (@code{wl-summary-mark-as-unread})
2931 @findex wl-summary-sync
2932 Synchronize summary view after prompting the update range
2933 (all, update, rescan, first, last).
2937 all ...Discard current summary and update all message.
2938 update ...Update the difference between summary and the folder itself.
2939 rescan ...Rescan the msgdb and display again.
2940 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2941 first, last ...Move to the filter folder(partial filter).
2946 (@code{wl-summary-sync})
2950 @findex wl-summary-sort
2952 You can sort by date, from, number and subject.
2953 (@code{wl-summary-sort})
2957 @findex wl-summary-toggle-thread
2958 Toggle the threading.
2959 Threading status is displayed on the modeline.
2960 @samp{@{S@}} means threading is off (Sequence) and
2961 @samp{@{T@}} means threading is on (Thread).
2962 (@code{wl-summary-toggle-thread})
2966 @findex wl-summary-toggle-disp-folder
2967 Toggle displaying of folder window.
2968 (@code{wl-summary-toggle-disp-folder})
2972 Toggle displaying of message window.
2973 @findex wl-summary-toggle-disp-msg
2974 (@code{wl-summary-toggle-disp-msg})
2978 Move to the virtual folder with the condition specified.
2979 If called with prefix argument and current folder is virtual, exit it.
2980 @findex wl-summary-virtual
2981 (@code{wl-summary-virtual})
2984 @kindex @key{TAB} (Summary)
2985 @findex wl-summary-goto-last-displayed-msg
2986 Jump to the message which is displayed last.
2987 (@code{wl-summary-goto-last-displayed-msg})
2991 Put @samp{*} mark on the messages that satisfies the specified condition.
2992 @findex wl-summary-pick
2993 (@code{wl-summary-pick})
2997 @findex wl-summary-mark-as-read
2998 Mark as read the message at the current cursor point.
2999 (@code{wl-summary-mark-as-read})
3003 Prefetch the message at the current cursor point.
3004 With prefix argument, prefetch the message even if it is cached.
3005 @findex wl-summary-prefetch
3006 (@code{wl-summary-prefetch})
3010 Execute @samp{D}, @samp{o} and @samp{O} marks.
3011 @findex wl-summary-exec
3012 (@code{wl-summary-exec})
3016 @findex wl-summary-target-mark-line
3017 Put target mark on the message at the current cursor point.
3018 (@code{wl-summary-target-mark-line})
3022 Put refile mark on the message at the current cursor point.
3023 @findex wl-summary-refile
3024 (@code{wl-summary-refile})
3027 @kindex C-o (Summary)
3028 Execute auto refile.
3029 @findex wl-summary-auto-refile
3030 (@code{wl-summary-auto-refile})
3034 Put copy mark on the message at the current cursor point.
3035 @findex wl-summary-copy
3036 (@code{wl-summary-copy})
3039 @kindex M-o (Summary)
3040 Put refile mark on the message at the current cursor point with the destination
3041 previously specified.
3042 @findex wl-summary-refile-prev-destination
3043 (@code{wl-summary-refile-prev-destination})
3047 @findex wl-summary-delete
3048 Put delete mark on the message at the current cursor point.
3049 (@code{wl-summary-delete})
3053 @findex wl-summary-unmark
3054 Unmark the temporal mark on the message at the current cursor point.
3055 (@code{wl-summary-unmark})
3059 Unmark all the temporal marks.
3060 @findex wl-summary-unmark-all
3061 (@code{wl-summary-unmark-all})
3064 @kindex r R (Summary)
3065 @findex wl-summary-mark-as-read-region
3066 Mark as read messages in the specified region.
3067 (@code{wl-summary-mark-as-read-region})
3070 @kindex r $ (Summary)
3071 @findex wl-summary-mark-as-important-region
3072 Mark as important @samp{$} messages in the specified region.
3073 If @samp{$} already exists, it is deleted.
3074 (@code{wl-summary-mark-as-important-region})
3077 @kindex r ! (Summary)
3078 @findex wl-summary-mark-as-unread-region
3079 Mark as unread messages in the specified region.
3080 (@code{wl-summary-mark-as-unread-region})
3083 @kindex r i (Summary)
3084 @findex wl-summary-prefetch-region
3085 Prefetch messages in the specified region.
3086 (@code{wl-summary-prefetch-region})
3089 @kindex r x (Summary)
3090 @findex wl-summary-exec-region
3091 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3093 (@code{wl-summary-exec-region})
3096 @kindex r * (Summary)
3097 @findex wl-summary-target-mark-region
3098 Put target mark on the messages in the specified region.
3099 (@code{wl-summary-target-mark-region})
3102 @kindex r o (Summary)
3103 @findex wl-summary-refile-region
3104 Put refile mark on the messages in the specified region.
3105 (@code{wl-summary-refile-region})
3108 @kindex r O (Summary)
3109 @findex wl-summary-copy-region
3110 Put copy mark on the messages in the specified region.
3111 (@code{wl-summary-copy-region})
3114 @kindex r d (Summary)
3115 @findex wl-summary-delete-region
3116 Put delete mark on the messages in the specified region.
3117 (@code{wl-summary-delete-region})
3120 @kindex r u (Summary)
3121 @findex wl-summary-unmark-region
3122 Delete temporal mark on the messages in the specified region.
3123 (@code{wl-summary-unmark-region})
3126 @kindex r y (Summary)
3127 Save messages in the specified region.
3128 @findex wl-summary-save-region
3129 (@code{wl-summary-save-region})
3132 @kindex t R (Summary)
3133 @findex wl-thread-mark-as-read
3134 Mark as read messages which are the descendant of the current thread.
3135 With prefix argument, it affects on the all messages in the thread tree.
3136 (@code{wl-thread-mark-as-read})
3139 @kindex t $ (Summary)
3140 @findex wl-thread-mark-as-important
3141 Put important mark @samp{$} on the messages which are the
3142 descendant of the current thread.
3143 If @samp{$} mark exists, it is deleted.
3144 With prefix argument, it affects on the all messages in the thread tree.
3145 (@code{wl-thread-mark-as-important})
3148 @kindex t ! (Summary)
3149 @findex wl-thread-mark-as-unread
3150 Mark as unread messages which are the descendant of the current thread.
3151 With prefix argument, it affects on the all messages in the thread tree.
3152 (@code{wl-thread-mark-as-unread})
3155 @kindex t i (Summary)
3156 @findex wl-thread-prefetch
3157 Prefetch messages which are the descendant of the current thread.
3158 With prefix argument, it affects on the all messages in the thread tree.
3159 (@code{wl-thread-prefetch})
3162 @kindex t x (Summary)
3163 @findex wl-thread-exec
3164 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3165 the descendant of the current thread. With prefix argument, it affects
3166 on the all messages in the thread tree.
3167 (@code{wl-thread-exec})
3170 @kindex t * (Summary)
3171 @findex wl-thread-target-mark
3172 Put target mark @samp{*} on the messages which are the descendant of the
3173 current thread. With prefix argument, it affects on the all messages in
3175 (@code{wl-thread-target-mark})
3178 @kindex t o (Summary)
3179 @findex wl-thread-refile
3180 Put refile mark on the messages which are the descendant of the current thread.
3181 With prefix argument, it affects on the all messages in the thread tree.
3182 (@code{wl-thread-refile})
3185 @kindex t O (Summary)
3186 @findex wl-thread-copy
3187 Put copy mark on the messages which are the descendant of the current thread.
3188 With prefix argument, it affects on the all messages in the thread tree.
3189 (@code{wl-thread-copy})
3192 @kindex t d (Summary)
3193 @findex wl-thread-delete
3194 Put delete mar on the messages which are the descendant of the current thread.
3195 With prefix argument, it affects on the all messages in the thread tree.
3196 (@code{wl-thread-delete})
3199 @kindex t u (Summary)
3200 @findex wl-thread-unmark
3201 Unmark temporal mark on the messages which are the descendant of the
3202 current thread. With prefix argument, it affects on the all messages in
3204 (@code{wl-thread-unmark})
3207 @kindex t y (Summary)
3208 @findex wl-thread-save
3209 Save messages which are the descendant of the current thread.
3210 With prefix argument, it affects on the all messages in the thread tree.
3211 (@code{wl-thread-save})
3214 @kindex m i (Summary)
3215 @findex wl-summary-target-mark-prefetch
3216 Prefetch all messages which have target mark @samp{*}.
3217 (@code{wl-summary-target-mark-prefetch})
3220 @kindex m R (Summary)
3221 @findex wl-summary-target-mark-mark-as-read
3222 Mark as read all messages which have target mark @samp{*}.
3223 (@code{wl-summary-target-mark-mark-as-read})
3226 @kindex m $ (Summary)
3227 @findex wl-summary-target-mark-mark-as-important
3228 Mark as important all messages which have target mark @samp{*}.
3229 If already marked as @samp{$}, it is deleted.
3230 (@code{wl-summary-target-mark-mark-as-important})
3233 @kindex m ! (Summary)
3234 @findex wl-summary-target-mark-mark-as-unread
3235 Mark as unread all messages which have target mark @samp{*}.
3236 (@code{wl-summary-target-mark-mark-as-unread})
3239 @kindex m o (Summary)
3240 @findex wl-summary-target-mark-refile
3241 Put refile mark on the messages which have target mark @samp{*}.
3242 (@code{wl-summary-target-mark-refile})
3245 @kindex m O (Summary)
3246 @findex wl-summary-target-mark-copy
3247 Put copy mark on the messages which have target mark @samp{*}.
3248 (@code{wl-summary-target-mark-copy})
3251 @kindex m d (Summary)
3252 @findex wl-summary-target-mark-delete
3253 Put delete mark on the messages which have target mark @samp{*}.
3254 (@code{wl-summary-target-mark-delete})
3257 @kindex m y (Summary)
3258 @findex wl-summary-target-mark-save
3259 Save messages which have target mark @samp{*}.
3260 (@code{wl-summary-target-mark-save})
3263 @kindex m u (Summary)
3264 Unmark all temporal marks.
3265 (@code{wl-summary-delete-all-temp-marks})
3266 @findex wl-summary-delete-all-temp-marks
3269 @kindex m a (Summary)
3270 Put target mark @samp{*} on the all messages.
3271 (@code{wl-summary-target-mark-all})
3272 @findex wl-summary-target-mark-all
3275 @kindex m t (Summary)
3276 Put target mark @samp{*} on the messages in the current thread.
3277 @findex wl-summary-target-mark-thread
3278 (@code{wl-summary-target-mark-thread})
3281 @kindex m r (Summary)
3282 @findex wl-summary-target-mark-region
3283 Put target mark @samp{*} on the messages in the specified region.
3284 (@code{wl-summary-target-mark-region})
3287 @kindex m A (Summary)
3288 @findex wl-summary-target-mark-reply-with-citation
3289 Prepare a draft which cites all messages which have target mark @samp{*}.
3290 (@code{wl-summary-target-mark-reply-with-citation})
3293 @kindex m f (Summary)
3294 @findex wl-summary-target-mark-forward
3295 Prepare a draft which forwards all messages which have target mark @samp{*}.
3296 (@code{wl-summary-target-mark-forward})
3299 @kindex m U (Summary)
3300 @findex wl-summary-target-mark-uudecode
3301 Uudecode the messages which have target mark @samp{*}.
3302 (@code{wl-summary-target-mark-uudecode})
3305 @kindex m ? (Summary)
3306 @findex wl-summary-target-mark-pick
3307 Pick messages from the @samp{*} marked messages.
3308 That is, @samp{*} marks on the messages are remained
3309 if the specified condition is satisfied.
3310 (@code{wl-summary-target-mark-pick})
3313 @kindex M-t (Summary)
3314 @findex wl-toggle-plugged
3315 Toggle offline/online status of Wanderlust.
3316 (@code{wl-toggle-plugged})
3319 @kindex C-t (Summary)
3320 Start Wanderlust's plug-status manager.
3321 (@code{wl-plugged-change})
3324 @kindex C-c C-o (Summary)
3325 @findex wl-jump-to-draft-buffer
3326 Move to the draft buffer if available. If multiple draft buffer exists,
3327 moved to one after another. If prefix argument is specified, load draft
3328 folder's message to the draft buffer and jump to it.
3329 (@code{wl-jump-to-draft-buffer})
3333 @node Variables of Summary, , Key Bindings of Summary, Summary
3334 @section Customiziable variables
3337 @item wl-summary-move-order
3338 @vindex wl-summary-move-order
3339 The initial setting is 'unread.
3340 Specify cursor moving policy.
3341 If you want to precede new messages, set 'new.
3342 If you want to precede unread messages, set 'unread.
3343 If nil, proceed to next message.
3345 @item wl-auto-select-first
3346 @vindex wl-auto-select-first
3347 The initial setting is nil.
3348 If non-nil, first message is automatically displayed.
3350 @item wl-auto-select-next
3351 @vindex wl-auto-select-next
3352 The initial setting is nil.
3353 If non-nil, jump to next summary automatically.
3354 If 'unread, jump to next unread folder's summary after confirmation.
3355 If 'skip-no-unread, unread folders are automatically skipped.
3357 @item wl-thread-insert-opened
3358 @vindex wl-thread-insert-opened
3359 The initial setting is nil.
3360 If non-nil, thread is inserted as opened.
3362 @item wl-thread-open-reading-thread
3363 @vindex wl-thread-open-reading-thread
3364 The initial setting is t.
3365 If non-nil, reading thread is automatically opened though it is closed thread.
3367 @item wl-summary-exit-next-move
3368 @vindex wl-summary-exit-next-move
3369 The initial setting is t.
3370 If non-nil, move to next folder at summary exit.
3372 @item wl-folder-move-cur-folder
3373 @vindex wl-folder-move-cur-folder
3374 The initial setting is nil.
3375 If non-nil, cursor position on the folder is moved.
3377 @item wl-summary-weekday-name-lang
3378 @vindex wl-summary-weekday-name-lang
3379 The initial setting is "ja".
3380 Specify language of the weekday.
3381 "en" displays English, "fr" displays French, "de" displays Deutsch.
3383 @item wl-summary-fix-timezone
3384 @vindex wl-summary-fix-timezone
3385 The initial setting is @samp{JST}.
3386 Timezone to adjust summary's timezone.
3387 If nil, adjust to UTC.
3389 @item wl-use-petname
3390 @vindex wl-use-petname
3391 The initial setting is t.
3392 If non-nil, sender part displays nickname.
3394 @item wl-break-pages
3395 @vindex wl-break-pages
3396 The initial setting is t.
3397 If non-nil, message is splitted as pages by @samp{^L}.
3399 @item wl-message-window-size
3400 @vindex wl-message-window-size
3401 The initial setting is '(1 . 4).
3402 A cons cell to specify the rate of summary and message window.
3403 car:cdr corresponds summary:message.
3405 @item wl-summary-recenter
3406 @vindex wl-summary-recenter
3407 The initial setting is t.
3408 If non-nil, cursor point is moved to the center of the summary window.
3410 @item wl-summary-indent-length-limit
3411 @vindex wl-summary-indent-length-limit
3412 The initial setting is 46.
3413 Specify the limit of thread indent level.
3414 If nil, max indent level is unlimited.
3416 @item wl-summary-no-from-message
3417 @vindex wl-summary-no-from-message
3418 The initial setting is @samp{nobody@@nowhere?}.
3419 A string which is displayed when there's no From: field in the message.
3421 @item wl-summary-no-subject-message
3422 @vindex wl-summary-no-subject-message
3423 The initial setting is @samp{(WL:No Subject in original.)}.
3424 A string which is displayed when there's no Subject: field in the message.
3426 @item wl-summary-width
3427 @vindex wl-summary-width
3428 The initial setting is 80.
3429 Width of summary line. If nil, summary line's width is as is.
3431 @item wl-use-folder-petname
3432 @vindex wl-use-folder-petname
3433 The initial setting is '(modeline).
3434 A list of display policy (symbol) of folder nickname.
3435 Available symbols are:
3439 Display folder petname on modeline.
3441 Destination folder is notified as nickname if
3442 @code{wl-auto-select-next} is non-nil.
3444 You can input folder name by nickname in the function
3445 @code{wl-summary-read-folder}.
3448 @item wl-summary-move-direction-toggle
3449 @vindex wl-summary-move-direction-toggle
3450 The initial setting is t.
3451 If non-nil, last executed @kbd{p}, @kbd{P}, @kbd{n}, @kbd{N} toggles
3452 the direction of cursor move.
3453 If you want to aware of reading direction, set this to t.
3456 @vindex wl-from-width
3457 The initial setting is 17.
3458 Width of sender part of summary line.
3460 @item wl-summary-divide-thread-when-subject-changed
3461 @vindex wl-summary-divide-thread-when-subject-changed
3462 The initial setting is nil.
3463 If non-nil, thread is splitted if the subject is changed.
3465 @item wl-summary-search-via-nntp
3466 @vindex wl-summary-search-via-nntp
3467 The initial setting is 'confirm.
3468 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed,
3469 call @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and
3470 search message from the NNTP server @code{elmo-default-nntp-server}.
3471 The value of @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
3472 @code{elmo-default-nntp-ssl} are used. If 'confirm, server name can
3473 be specified. You can specify NNTP folder format like
3474 @samp{-:username@@servername:119!}.
3476 @item wl-summary-keep-cursor-command
3477 @vindex wl-summary-keep-cursor-command
3478 The initial setting is
3479 '(wl-summary-goto-folder wl-summary-goto-last-visited-folder).
3480 When you entered to summary by these commands and the target summary
3481 buffer already exists, summary status is not automatically updated and
3482 cursor position is saved.
3484 @item wl-summary-update-confirm-threshold
3485 @vindex wl-summary-update-confirm-threshold
3486 The initial setting is 500.
3487 If updated message number is larger than this value,
3488 confirm whether drop them or not.
3490 @item wl-summary-always-sticky-folder-list
3491 @vindex wl-summary-always-sticky-folder-list
3492 The initial setting is nil.
3493 @code{wl-summary-always-sticky-folder-list} specifies the folders that are
3494 automatically sticked. Each element is regexp of folder name.
3496 @item wl-summary-reserve-mark-list
3497 @vindex wl-summary-reserve-mark-list
3498 The initial setting is '("o" "O" "D").
3499 If a message is already marked as temporal marks in this list,
3500 the message is not marked by any mark command.
3502 @item wl-summary-skip-mark-list
3503 @vindex wl-summary-skip-mark-list
3504 The initial setting is '("D").
3505 If a message is already marked as temporal marks in this list,
3506 the message is skipped at cursor move.
3508 @item wl-fetch-confirm-threshold
3509 @vindex wl-fetch-confirm-threshold
3510 The initial setting is 30000 (bytes).
3511 If displaying message has larger size than this value,
3512 Wanderlust confirms whether fetch the message or not.
3513 If nil, the message is fetched without confirmation.
3515 @item wl-prefetch-threshold
3516 @vindex wl-prefetch-threshold
3517 The initial setting is 30000 (bytes).
3518 If prefetching message has larger size than this value and
3519 @code{wl-prefetch-confirm} is non-nil,
3520 Wanderlust confirms whether prefetch the message or not.
3521 If @code{wl-prefetch-threshold} is nil, the message is prefetched
3522 without confirmation.
3524 @item wl-prefetch-confirm
3525 @vindex wl-prefetch-confirm
3526 The initial setting is t. If non-nil,
3527 Wanderlust confirms whether prefetch the message or not if the
3528 message has larger size than @code{wl-prefetch-threshold}.
3530 @item wl-cache-fetch-threshold
3531 @vindex wl-cache-fetch-threshold
3532 The initial setting is 30000 (bytes).
3533 The messages which have larger size than @code{wl-fetch-confirm-threshold}
3534 are skipped buffer caching mechanism. If nil, any messages are prefetched by
3535 buffer caching mechanism.
3537 @item elmo-imap4-use-cache
3538 @vindex elmo-imap4-use-cache
3539 The initial setting is t.
3540 If non-nil, messages read via IMAP4 are cached.
3542 @item elmo-nntp-use-cache
3543 @vindex elmo-nntp-use-cache
3544 The initial setting is t.
3545 If non-nil, messages read via NNTP are cached.
3547 @item elmo-pop3-use-cache
3548 @vindex elmo-pop3-use-cache
3549 The initial setting is t.
3550 If non-nil, messages read via POP3 are cached.
3554 @node Message, Draft, Summary, Top
3555 @chapter Message Buffer
3557 Message Buffers utilize MIME-View mode of SEMI/tm.
3558 For operational procedures and key bindings, refer to respective
3560 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3562 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3563 brings you back to Summary mode.
3564 @kbd{l} toggles display of Summary mode buffer.
3566 @section Key Bindings
3572 @findex wl-message-toggle-disp-summary
3573 Toggles display of Summary mode buffer.
3574 (@code{wl-message-toggle-disp-summary})
3577 @findex wl-message-refer-article-or-url
3578 @kindex Button-2 (Message)
3579 Assumes Message-ID at the mouse pointer, and shows the corresponding
3581 (@code{wl-message-refer-article-or-url})
3583 @item Button-4 (upward movement of a wheel)
3584 @kindex Button-4 (Message)
3585 @findex wl-message-wheel-down
3586 Scrolls the message backwards. When the top of the message is hit,
3587 moves to the previous message.
3588 (@code{wl-message-wheel-down})
3590 @item Button-5 (downward movement of a wheel)
3591 @kindex Button-5 (Message)
3592 @findex wl-message-wheel-up
3593 Scrolls the message forward. When the bottom of the message is hit,
3594 moves to the next message.
3595 (@code{wl-message-wheel-up})
3598 @section Customizable Variables
3601 @item wl-message-window-size
3602 @vindex wl-message-window-size
3603 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3604 its car and cdr value corresponds to the ratio of Summary and Message
3609 @node Draft, Disconnected Operations, Message, Top
3610 @chapter Draft Buffer
3612 At Summary mode, pressing @kbd{w} and the like creates a new draft
3613 buffer. You can edit and send mail and news articles in this buffer.
3617 Basically it is Emacs-standard mail mode.
3619 @subsection Address Completion
3621 Initially, the cursor is at the To: field. Fill in recipients
3622 addresses. @kbd{@key{TAB}} completes them.
3624 If you want to submit a news article, add Newsgroups: field by
3625 yourself. Field names can be completed by @kbd{@key{TAB}}.
3627 If you save the draft buffer you are editing, it is appended to the
3628 folder specified by @code{wl-draft-folder}.
3630 Using FCC: field, you can specify the folder to which a copy of the
3631 message is saved when it is sent.
3633 @subsection Editing Messages
3635 Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
3636 editing, refer to respective documents.
3637 @xref{MIME-Edit, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3639 @subsection Dynamic Modification of Messages
3640 @vindex wl-draft-config-alist
3641 @c @cindex Change Message
3642 @c @cindex Message, Change Dynamic
3644 You can set @code{wl-draft-config-alist} so that header and body of the
3645 message will automatically modified depending on information of header
3648 The initial setting of @code{wl-draft-config-alist} is nil.
3650 In the example below, the header is modified when
3651 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3652 You can set @code{wl-interactive-send} to non-nil so as to confirm
3653 changes before sending the message.
3657 (setq wl-draft-config-alist
3658 '(((string-match "aaa.ne.jp$" (system-name))
3659 ;; @r{applied if the expression is non-nil}
3660 (wl-smtp-posting-server . "mailserver-B")
3661 (wl-nntp-posting-server . "newsserver-B")
3662 ;; @r{settings of temporary variables}
3664 ("^To: .*user@@aaa.bbb.com"
3665 ;; @r{applied if it matches the header of the draft buffer}
3666 ("Organization" . (format "Go %s" my-webpage)))
3667 ;; @r{you can write elisp expressions here (eval only)}
3668 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3669 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3674 The format of @code{wl-draft-config-alist} is:
3678 '(("regexp of the header" or elisp expression
3679 ("Field" . value(elisp expression))
3680 (variable . value(elisp expression))
3681 (sub-function . value(elisp expression))
3684 ("regexp of the header" or elisp expression
3685 ("Field" . value(elisp expression))
3690 Per default, there are 10 following sub-functions.
3693 'header: Inserts the specified string at the bottom of the header.
3694 'header-file: Inserts the specified file at the bottom of the header.
3695 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3696 'top: Inserts the specified string at the top of the body.
3697 'top-file: Inserts the specified file at the top of the body.
3698 'body: Replaces the body with the specified string.
3699 Specifying nil deletes the entire body string.
3700 'body-file: Replaces the body with the content of the specified file.
3701 'bottom: Inserts the specified string at the bottom of the body.
3702 'bottom-file: Inserts the specified file at the top of the body.
3703 'template: Applies the specified template.
3704 (refer to the next subsection)
3707 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3708 change them or add your own functions. If you read the code, you can
3709 easily find how to write the functions.
3711 At the first of each item, "a regular expression of the header" or an
3712 elisp expression should be specified. In the case of an elisp
3713 expression, the item is applied when the expression is evaluated
3716 Per default, when multiple items match or are evaluated non-nil, all
3717 such items are applied, but if you set a variable
3718 @code{wl-draft-config-matchone} to t, only the first matching one is
3721 At the second of the item, a cons or a list of functions should be
3722 specified. The car part of the cons should be a header field, a
3723 variable, or a sub-function. When a header field is specified, the field
3724 will be modified. If a variable is specified, the value of the variable
3725 will be modified temporarily.
3727 In the cdr part of a cons, not only a variable but also an elisp
3728 expression can be specified as is. If the car part is a header field
3729 and the cdr part is nil, the field will be deleted.
3731 See the next example as well:
3735 (setq wl-draft-config-alist
3737 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3738 ;; @r{applied if it matches the header of the buffer being replied}
3739 (body . " Hello.\n")
3740 (template . "default")
3745 As in the (1) above, if a header regexp is prepended with @code{reply},
3746 it is applied when the draft is prepared by @code{wl-summary-reply} for
3747 example, and when it matches the header being replied. It is ignored
3748 when there is no buffer being replied, like after @code{wl-draft} was
3751 Note that @code{wl-draft-config-alist} is applied only once when
3752 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3753 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3754 aborting transmission, execute @kbd{C-c C-e}
3755 (@code{wl-draft-config-exec}).
3757 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3758 prepared, do the following:
3761 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3764 @subsection Inserting Templates
3766 @cindex Apply Template
3768 Set a variable @code{wl-template-alist}, and type
3769 @kbd{C-c C-j} or @kbd{M-x wl-template-select}
3770 in the draft buffer.
3772 The format of @code{wl-template-alist} is almost the same as
3773 @code{wl-draft-config-alist}.
3777 (setq wl-template-alist
3780 ("Organization" . "~/.wl sample")
3781 (body . "Hello.\n"))
3783 (template . "default") ;; @r{(a)}
3784 ("To" . "jousi@@kaisha.jp")
3785 ("Subject" . "Report")
3786 (body-file . "~/work/report.txt")
3792 As you can see, the only difference is item (template) names such as
3793 @samp{default} and @samp{report}, instead of a regexp of header.
3794 Because definition of each item is the same as
3795 @code{wl-draft-config-alist}, you can call another template, like (a).
3797 Executing the command @code{wl-template-select} results in template
3798 selection, but the result differs depending on variable
3799 @code{wl-template-visible-select}.
3801 If @code{wl-template-visible-select} is t (default), a buffer window is
3802 shown below the draft buffer. You can select a template by @kbd{n} and
3803 @kbd{p} seeing the buffer window.
3805 Press the RETURN key and the template is actually applied to the draft
3806 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3807 adjust the window size by @code{wl-template-buffer-lines}.
3809 If @code{wl-template-visible-select} is nil, you should type the name of
3810 the template in the mini buffer.
3812 As shown in the example in @code{wl-draft-config-alist}, you can select
3813 @samp{default} template by writing:
3816 (template . "default")
3819 @subsection Sending mail by POP-before-SMTP
3820 @cindex POP-before-SMTP
3822 You can send mail by POP-before-SMTP with this single line:
3825 (setq wl-draft-send-mail-func 'wl-draft-send-mail-with-pop-before-smtp)
3829 Configure the following variables if you need.
3832 @item wl-pop-before-smtp-user
3833 The POP user name for POP-before-SMTP authentication.
3834 If unset, @code{elmo-default-pop3-user} is used.
3836 @item wl-pop-before-smtp-server
3837 The POP server name for POP-before-SMTP authentication.
3838 If unset, @code{elmo-default-pop3-server} is used.
3840 @item wl-pop-before-smtp-authenticate-type
3841 The POP authentication method for POP-before-SMTP authentication.
3842 If unset, @code{elmo-default-pop3-authenticate-type} is used.
3844 @item wl-pop-before-smtp-port
3845 The POP port number for POP-before-SMTP authentication.
3846 If unset, @code{elmo-default-pop3-port} is used.
3848 @item wl-pop-before-smtp-ssl
3849 If non-nil, POP connection is established using SSL.
3850 If 'starttls, STARTTLS (RFC2595) connection will be established.
3851 If unset, @code{elmo-default-pop3-ssl} is used.
3854 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
3855 unset, settings for POP folders (@code{elmo-default-pop3-*}) are
3857 Therefore, if SMTP server and POP server are actually the same, and if
3858 POP folder per default (such as @samp{&}) is available, no settings are
3861 Refer to the following URL about POP-before-SMTP.
3865 http://spam.ayamura.org/tools/smPbS.html
3866 http://www.iecc.com/pop-before-smtp.html
3870 @section Key Bindings
3871 @cindex Keybind, Draft Mode
3872 @cindex Keybind, Draft Buffer
3877 @kindex C-c C-y (Draft)
3878 @findex wl-draft-yank-original
3879 Cites the content of the current message buffer.
3880 (@code{wl-draft-yank-original})
3883 @kindex C-c C-p (Draft)
3884 @findex wl-draft-preview-message
3885 Previews the content of the current draft.
3886 This is useful for previewing MIME multi-part messages.
3887 (@code{wl-draft-preview-message})
3890 @kindex C-c C-s (Draft)
3891 @findex wl-draft-send
3892 Sends the content of the current draft. Does not erase the draft buffer.
3893 This is useful for sending multiple messages, which are a little different
3895 (@code{wl-draft-send})
3898 @kindex C-c C-c (Draft)
3899 @findex wl-draft-send-and-exit
3900 Sends the content of the current draft and erases the draft buffer.
3901 (@code{wl-draft-send-and-exit})
3904 @kindex C-x C-s (Draft)
3905 @findex wl-draft-save
3906 Save the current draft.
3907 (@code{wl-draft-save})
3910 @kindex C-c C-k (Draft)
3911 @findex wl-draft-kill
3912 Kills the current draft.
3913 (@code{wl-draft-kill})
3916 @c @kindex C-x k (Draft)
3917 @c @findex wl-draft-mimic-kill-buffer
3918 @c Kills the current draft.
3919 @c (@code{wl-draft-mimic-kill-buffer})
3922 @kindex C-c C-z (Draft)
3923 @findex wl-draft-save-and-exit
3924 Saves the current draft, and erases the draft buffer.
3925 This is useful if you want to suspend editing of the draft.
3926 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
3927 the @samp{+draft} folder.
3928 (@code{wl-draft-save-and-exit})
3931 @kindex C-c C-r (Draft)
3932 @findex wl-caesar-region
3933 Encodes or decodes the specified region in Caesar cipher.
3934 (@code{wl-caesar-region})
3938 @findex wl-toggle-plugged
3939 Toggles off-line/on-line states of Wanderlust.
3940 (@code{wl-toggle-plugged})
3943 @kindex C-c C-o (Draft)
3944 @findex wl-jump-to-draft-buffer
3945 Jumps to the other draft buffer, if exists.
3946 With prefix argument, reads a file (if any) from the draft folder when
3947 there is no such buffer.
3948 (@code{wl-jump-to-draft-buffer})
3951 @kindex C-c C-e (Draft)
3952 @findex wl-draft-config-exec
3953 Applies @code{wl-draft-config-alist}.
3954 (@code{wl-draft-config-exec})
3957 @kindex C-c C-j (Draft)
3958 @findex wl-template-select
3960 (@code{wl-template-select})
3963 @kindex C-c C-a (Draft)
3964 @findex wl-draft-insert-x-face-field
3965 Inserts the content of a file @file{~/.xface} (the value of the variable
3966 @code{wl-x-face-file}) as an X-Face field in the draft buffer.
3968 There should be encoded X-Face strings as a content of a file @file{~/.xface}.
3969 (@code{wl-draft-insert-x-face-field})
3972 @section Customizable Variables
3975 @item wl-subscribed-mailing-list
3976 @vindex wl-subscribed-mailing-list
3977 The initial setting is nil.
3978 Mailing lists to which you subscribe.
3979 If any of these are contained in To or Cc field of a reply draft,
3980 removes your own address from Mail-Followup-To and Cc.
3981 And if any of these are contained in To or Cc field of a message to be
3982 automatically re-filed, the destination folder will be leaned in
3983 connection with the address.
3984 @item wl-insert-mail-followup-to
3985 @vindex wl-insert-mail-followup-to
3986 The initial setting is nil.
3987 If non-nil, Mail-Followup-To field is automatically inserted in the
3990 @item wl-insert-mail-reply-to
3991 @vindex wl-insert-mail-reply-to
3992 The initial setting is nil.
3993 If non-nil, Mail-Reply-To field is automatically inserted in the
3996 @item wl-auto-insert-x-face
3997 @vindex wl-auto-insert-x-face
3998 The initial setting is t.
3999 If non-nil and there is an encoded X-Face string in a file
4000 @file{~/.xface} (the value of the variable @code{wl-x-face-file}),
4001 inserts it as an @samp{X-Face:} field in the draft buffer. If nil, it
4002 is not automatically inserted. Press @kbd{C-c C-a} to insert.
4004 @item wl-insert-message-id
4005 @vindex wl-insert-message-id
4006 The initial setting is t.
4007 If non-nil, @samp{Message-ID:} field is automatically inserted on the
4010 @item wl-local-domain
4011 @vindex wl-local-domain
4012 The initial setting is nil.
4013 If nil, the return value of the function @code{system-name} will be
4014 used as the domain part of @samp{Message-ID:}.
4016 If @code{system-name} does not return FQDN (i.e. the full name of the
4017 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4018 to the string of the local domain name without hostname (like
4019 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4020 @samp{.} @code{wl-local-domain} is used as domain part of the
4023 If your terminal does not have global IP, set the value of
4024 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4025 you use invalid @samp{Message-ID:}.)
4027 Moreover, concatenation of @code{system-name} @samp{.}
4028 @code{wl-local-domain} will be used as an argument to the HELO command
4031 @item wl-message-id-domain
4032 @vindex wl-message-id-domain
4033 The initial setting is nil.
4034 If non-nil, this value is used as a domain part of the Message-ID.
4035 If your terminal does not have global IP, set unique string to this value
4036 (e.x. your e-mail address).
4038 @item wl-message-id-domain
4039 @vindex wl-message-id-domain
4040 The initial setting is nil.
4041 If nil, the return value of the function @code{system-name} will be
4042 used as the domain part of Message-ID.
4043 If @code{system-name} does not return FQDN (i.e. the full name of the
4044 host, like smtp.gohome.org), you @strong{must} set this variable to the
4045 string of the full name of the host. Otherwise, you might be beaten up
4048 @item wl-draft-config-alist
4049 @vindex wl-draft-config-alist
4050 The initial setting is nil.
4051 Modifies the draft message just before the transmission.
4052 The content of @code{wl-draft-config-alist} will be automatically
4053 applied only once on the transmission. If you want to apply it
4054 manually, use @kbd{C-c C-e}. This command can be used many times.
4056 @item wl-template-alist
4057 @vindex wl-template-alist
4058 The initial setting is nil.
4059 This variable specifies the template to be applied in the draft buffer.
4061 @item wl-draft-config-matchone
4062 @vindex wl-draft-config-matchone
4063 The initial setting is nil.
4064 If non-nil, only the first matching item is used when
4065 @code{wl-draft-config-alist} is applied. If nil, all matching items are
4068 @item wl-template-visible-select
4069 @vindex wl-template-visible-select
4070 The initial setting is t.
4071 If non-nil, you can preview the result of the template selection in
4074 @item wl-template-confirm
4075 @vindex wl-template-confirm
4076 The initial setting is nil.
4077 If non-nil, asks for confirmation when you press the enter key to select
4078 template while previewing.
4080 @item wl-template-buffer-lines
4081 @vindex wl-template-buffer-lines
4082 The initial setting is 7.
4083 If @code{wl-template-visible-select} is non-nil, this variable specifies
4084 the size of the preview window.
4086 @item wl-draft-reply-buffer-style
4087 @vindex wl-draft-reply-buffer-style
4088 The initial setting is 'split.
4089 'split or 'full can be specified.
4090 In the case of 'full, the whole frame will be used for a reply draft
4091 buffer when it is prepared.
4093 @item wl-draft-use-frame
4094 @vindex wl-draft-use-frame
4095 The initial setting is nil.
4096 If non-nil, use new frame for the draft.
4100 The initial setting is the value of the variable
4101 @code{user-mail-address}. The value of this variable is inserted as a
4102 @samp{From:} field of the draft when it is prepared.
4104 @item wl-envelope-from
4105 @vindex wl-envelope-from
4106 The initial setting is nil.
4107 The value of this variable is used for envelope from (MAIL FROM).
4108 If nil, the address part of @code{wl-from} is used.
4110 @item wl-user-mail-address-list
4111 @vindex wl-user-mail-address-list
4112 The initial setting is nil.
4113 This is the User's address list. If you have multiple addresses,
4118 The initial setting is nil.
4119 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4120 the draft when it is prepared.
4121 If function is specified, its return value is used.
4125 The initial setting is nil.
4126 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4127 the draft when it is prepared.
4129 @item wl-reply-subject-prefix
4130 @vindex wl-reply-subject-prefix
4131 The initial setting is "Re: ".
4132 In the Subject of the reply draft, this string is prepended to the
4133 Subject of being replied.
4135 @item wl-draft-reply-use-address-with-full-name
4136 @vindex wl-draft-reply-use-address-with-full-name
4137 The initial setting is @code{t}.
4138 If non-nil, insert her full name with address when prepare a draft for
4139 reply a message. If it is @code{nil}, insert her address only.
4141 @item wl-draft-enable-queuing
4142 @vindex wl-draft-enable-queuing
4143 The initial setting is t.
4144 This flag controls off-line transmission. If non-nil, the draft is
4147 @item wl-draft-use-cache
4148 @vindex wl-draft-use-cache
4149 The initial setting is @code{t}.
4150 If non-nil, cache the message which is sent.
4152 @item wl-auto-flush-queue
4153 @vindex wl-auto-flush-queue
4154 The initial setting is t.
4155 This flag controls automatic transmission of the queue when Wanderlust
4156 becomes on-line. If non-nil, the queue is automatically transmitted
4157 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4158 manually, press @kbd{F} in the folder mode.
4160 @item wl-draft-always-delete-myself
4161 @vindex wl-draft-always-delete-myself
4162 If non-nil, always removes your own address from @samp{To:} and
4163 @samp{Cc:} when you are replying to the mail addressed to you.
4165 @item wl-smtp-posting-server
4166 @vindex wl-smtp-posting-server
4167 The initial setting is nil.
4168 This is the SMTP server name for mail transmission.
4170 @item wl-smtp-posting-user
4171 @vindex wl-smtp-posting-user
4172 The initial setting is nil.
4173 This is the user name for SMTP AUTH authentication.
4174 If nil, @code{smtp-authenticate-user} is used.
4176 @item wl-smtp-authenticate-type
4177 @vindex wl-smtp-authenticate-type
4178 The initial setting is nil.
4179 This is the authentication method for SMTP AUTH authentication. If nil,
4180 @code{smtp-authenticate-type} is used. If @code{smtp-authenticate-type}
4181 is still nil, authentication will not be carried out.
4183 @item wl-smtp-connection-type
4184 @vindex wl-smtp-connection-type
4185 The initial setting is nil.
4186 This variable specifies how to establish SMTP connections.
4187 If nil, @code{smtp-connection-type} is used.
4188 If it is 'starttls, STARTTLS (RFC2595) is used.
4190 @item wl-nntp-posting-server
4191 @vindex wl-nntp-posting-server
4192 The initial setting is nil.
4193 This is the NNTP server name used for news submission.
4194 If nil, @code{elmo-default-nntp-server} is used.
4196 @item wl-nntp-posting-user
4197 @vindex wl-nntp-posting-user
4198 The initial setting is nil.
4199 This is the user name for AUTHINFO authentication on news submission.
4200 If nil, @code{elmo-default-nntp-user} is used.
4201 If it is still nil, AUTHINFO authentication will not be carried out.
4203 @item wl-nntp-posting-port
4204 @vindex wl-nntp-posting-port
4205 The initial setting is nil.
4206 This is the port number of the NNTP server used for news submission.
4207 If nil, @code{elmo-default-nntp-server} is used.
4209 @item wl-nntp-posting-ssl
4210 @vindex wl-nntp-posting-ssl
4211 The initial setting is nil.
4212 If nil, @code{elmo-default-nntp-ssl} is evaluated.
4213 If non-nil, SSL is used for news submission.
4214 If 'starttls, STARTTLS (RFC2595) connection will be established.
4216 @item wl-pop-before-smtp-user
4217 @vindex wl-pop-before-smtp-user
4218 The initial setting is nil.
4219 This is the POP user name for POP-before-SMTP.
4220 If it is nil, @code{elmo-default-pop3-user} is used.
4222 @item wl-pop-before-smtp-server
4223 @vindex wl-pop-before-smtp-server
4224 The initial setting is nil.
4225 This is the POP server name for POP-before-SMTP.
4226 If it is nil, @code{elmo-default-pop3-server} is used.
4228 @item wl-pop-before-smtp-authenticate-type
4229 @vindex wl-pop-before-smtp-authenticate-type
4230 The initial setting is nil.
4231 This is the authentication method for POP-before-SMTP authentication.
4232 If it is nil, @code{elmo-default-pop3-authenticate} is used.
4234 @item wl-pop-before-smtp-port
4235 @vindex wl-pop-before-smtp-port
4236 The initial setting is nil.
4237 This is the POP port number for POP-before-SMTP.
4238 If it is nil, @code{elmo-default-pop3-port} is used.
4240 @item wl-pop-before-smtp-ssl
4241 @vindex wl-pop-before-smtp-ssl
4242 The initial setting is nil.
4243 This flag controls the use of SSL for POP-before-SMTP.
4244 If it is nil, @code{elmo-default-pop3-ssl} is used.
4246 @item wl-draft-queue-save-variables
4247 @vindex wl-draft-queue-save-variables
4248 Specifies a list of variable to which queued messages are saved on the
4249 off-line transmission.
4251 @item wl-draft-sendlog
4252 @vindex wl-draft-sendlog
4253 The initial setting is t.
4254 If t, transmission log is written in @file{~/.elmo/sendlog}.
4258 @item drafts are sent by smtp or qmail
4259 @item saved into folders by fcc
4260 @item saved into folders by queuing
4263 (it is written even if the transmission fails).
4264 But transmission by @file{im-wl.el} is not written in the @file{sendlog} and
4265 left to the logging function of imput.
4268 @item wl-draft-sendlog-max-size
4269 @vindex wl-draft-sendlog-max-size
4270 The initial setting is 20000 (in bytes).
4271 If @code{wl-draft-sendlog} is t, the log is rotated when it grows beyond
4272 the size specified by this variable.
4276 The initial setting is nil.
4277 If non-nil, address completion uses LDAP.
4279 @item wl-ldap-server
4280 @vindex wl-ldap-server
4281 The initial setting is localhost.
4282 LDAP server name for address completion.
4285 @vindex wl-ldap-port
4286 The initial setting is nil.
4287 If non-nil, the value is used as port number.
4290 @vindex wl-ldap-base
4291 The initial setting is "c=US".
4292 LDAP search starting point (base) for address completion.
4295 @node Disconnected Operations, Expire and Archive, Draft, Top
4296 @chapter Off-line Management
4297 @cindex Disconnected Operations
4299 Wanderlust has on-line and off-line states.
4302 * Off-line State:: Wanderlust has on-line and off-line states.
4303 * Enable Operations:: Enable Disconeected Oparations.
4304 * Plugged Mode:: Switching On-line/Off-line per Server/Port.
4305 * Off-line State settings:: Invoking Wanderlust in the Off-line State.
4306 * Variables of Plugged Mode:: Customize Plugged Mode.
4310 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4311 @section Off-line State
4313 Wanderlust has on-line and off-line states.
4314 In the off-line state, you cannot access messages via network, unless
4317 @samp{[ON]} in the mode line indicates the on-line state.
4318 @samp{[--]} in the mode line indicates the off-line state.
4319 In folder or summary modes, press @kbd{M-t} to switch between off-
4322 You can invoke Wanderlust in the off-line state by setting
4323 @code{wl-plugged} to nil in @file{~/.wl} or anything appropriate.
4325 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4326 ignores uncached messages.
4329 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4330 @section Enable Disconeected Oparations
4332 Even in the off-line state, provided that relevant messages are cached,
4333 and the variable @code{elmo-enable-disconnected-operation} (described
4334 later) is non-nil, you can following oparations:
4335 @xref{Plugged Mode}, @xref{Off-line State settings}.
4338 * Send Messages off-line:: Transmit Messages.
4339 * Re-file and Copy queue:: Re-file and Copy (IMAP4).
4340 * Creation of Folders:: Create Folders off-line (IMAP4).
4341 * Marking:: Mark (IMAP4).
4342 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP).
4345 As soon as Wanderlust becomes on-line, such operations invoked off-line
4346 are reflected in the servers via network.
4349 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4350 @subsection Transmission of Messages
4352 You can send mail/news messages off-line (if you are using im-wl.el, it
4353 is irrelevant). Messages sent off-line are accumulated in the queue
4354 folder, @samp{+queue}. These messages are transmitted at once when
4355 Wanderlust becomes on-line.
4357 You can visit @samp{+queue} in the off-line state and confirm content
4358 of messages in the queue. You can also remove messages. Removed messages
4359 are not transmitted even in the on-line state.
4362 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4363 @subsection Re-file and Copy (IMAP4)
4365 Re-file and copy operations to IMAP folders invoked during the off-line
4366 state are accumulated in the queue, and reflected in the server side
4367 when Wanderlust becomes on-line. If you visit destination folders after
4368 off-line re-file or copy, it looks as if messages were appended even in
4371 For the safety reasons, messages re-filed off-line are removed from
4372 source folders only if their Message-ID match messages on the servers.
4373 While the queue is processed, messages that failed to be re-filed or
4374 copied to the specified folders are appended to the folder
4378 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4379 @subsection Creation of Folders (IMAP4)
4381 You can create IMAP folders off-line. The creation of folders are
4382 reflected in the servers when Wanderlust becomes on-line. At that time,
4383 if folders failed to be created on the servers for any reasons, messages
4384 re-filed to such folders are appended to the folder @samp{+lost+found}.
4387 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4388 @subsection Marking (IMAP4)
4390 Off-line changes in unread/read and importance mark @samp{$} information
4391 are also reflected in the servers when Wanderlust becomes on-line.
4394 @node Pre-fetching Reservations, , Marking, Enable Operations
4395 @subsection Pre-fetching (IMAP4, NNTP)
4397 You can make reservations for pre-fetching messages in IMAP or NNTP
4398 folders. Reserved messages are marked with @samp{!} but not cached
4399 yet. When Wanderlust becomes on-line, they are pre-fetched from
4402 If the variable @code{elmo-enable-disconnected-operation} is nil, these
4403 off-line operations for IMAP4 and NNTP do not take place, and off-line
4404 re-file, copy or suchlike simply results in error.
4406 Because off-line operations use cache files, it is a bad idea to erase
4407 them by hand; it may cause Wanderlust to malfunction.
4409 If you want to remove caches, be sure to execute
4410 @kbd{M-x elmo-cache-expire-by-size}.
4411 @code{elmo-cache-expire-by-size} does not remove caches for messages
4412 relevant to off-line operations.
4415 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4416 @section Switching On-line/Off-line per Server/Port
4418 @kbd{M-t} described above switches networking states as a whole, but you
4419 can switch on-line/off-line per server/port.
4421 Pressing @kbd{C-t} in the folder or summary modes brings you in
4422 wl-plugged-mode shown below, in which you can change the plugged state
4427 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4430 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4431 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4433 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4434 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4440 The first line indicates status of the following three variables, and
4441 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
4442 column modifies the values of these variables.
4446 "Queuing" @code{wl-draft-enable-queuing}
4447 "AutoFlushQueue" @code{wl-auto-flush-queue}
4448 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4452 where @samp{[ON]} means its value is t, and @samp{[--]} means nil.
4454 The second and after lines indicate on-line/off-line states of servers
4455 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4456 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4457 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4459 "sending queue" means messages accumulated in the folder @samp{+queue}
4460 for off-line transmission, and "dop queue" means off-line operations
4461 when @code{elmo-enable-disconnected-operation} is t.
4462 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4463 @c off-line operations are enabled.
4465 They are displayed if there are any of them. In the example above,
4466 in the sending queue there are two messages (the first and the second
4467 in the queue folder) for smtp to hosta and one (the third) for nntp to
4468 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4471 If you change (wl-plugged) in the second line, the variable
4472 @code{wl-plugged} is changed, so that the mode line indicator and
4473 plugged states of all ports are affected.
4474 If you change plugged states of any servers or ports, (wl-plugged) in the
4475 second line is affected depending on @code{elmo-plugged-condition}
4476 settings and the plugged state of each port.
4479 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4480 @section Invoking Wanderlust in the Off-line State
4482 As described before, if you set @code{wl-plugged} to nil in @file{~/.wl}
4483 or anything appropriate, you can invoke Wanderlust in the off-line
4484 state. You can specify off-line state on a per server or port basis.
4485 Refer to @code{wl-reset-plugged-alist} also.
4487 Usually, when Wanderlust starts up, the plugged state of each port is
4488 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4489 @code{wl-nntp-posting-server} and so on. If you want to change the
4490 plugged state of these ports or to add other ports, configure
4491 @code{wl-make-plugged-hook} with a function.
4495 (add-hook 'wl-make-plugged-hook
4497 (elmo-set-plugged plugged-value(t/nil) server port)
4498 ;; @r{add or change plugged states of the port of the server}
4499 (elmo-set-plugged plugged-value(t/nil) server)
4500 ;; @r{if the port is omitted, all ports are affected}
4501 ;; @r{(you cannot omit the port if you newly add the server)}
4507 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4508 @section Customizable Variables
4513 If this variable is set to nil, Wanderlust starts up in off-line mode from
4516 @item wl-queue-folder
4517 @vindex wl-queue-folder
4518 The initial setting is @samp{+queue}.
4519 This is the folder in which messages in the transmission queue are
4522 @item wl-auto-flush-queue
4523 @vindex wl-auto-flush-queue
4524 The initial setting is t.
4525 This flag controls automatic transmission of the queue when Wanderlust
4526 becomes on-line. If non-nil, the queue is automatically transmitted
4527 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4528 manually, press @kbd{F} in the folder mode.
4530 @item elmo-enable-disconnected-operation
4531 @vindex elmo-enable-disconnected-operation
4532 The initial setting is nil. Controls off-line operations regarding IMAP4.
4533 If non-nil, off-line operations are carried out.
4535 @item elmo-lost+found-folder
4536 @vindex elmo-lost+found-folder
4537 The initial setting is @samp{+lost+found}.
4538 This is the folder to which messages are saved when they fails to be
4539 appended while the off-line re-file/copy queue is processed.
4541 @item elmo-plugged-condition
4542 @vindex elmo-plugged-condition
4543 The initial setting is 'one.
4544 The value of @code{wl-plugged} reflects the return value of the function
4545 @code{elmo-plugged-p} (without arguments).
4546 This variable @code{elmo-plugged-condition} specifies the condition on
4547 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4548 plugged state of each port.
4551 'one : plugged if one or more ports are plugged.
4552 'all : plugged if all ports are plugged.
4553 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4554 states of the ports.
4555 @var{function} : reflects the return value of the @var{function}
4556 functions available per default
4557 'elmo-plug-on-by-servers
4558 : reflects the plugged state of the servers specified by the
4559 variable elmo-plug-on-servers.
4560 'elmo-plug-on-by-exclude-servers
4561 : reflects the plugged state of the servers that are not
4562 in elmo-plug-on-exclude-servers.
4563 elmo-plug-on-exclude-servers defaults to
4566 (system-name)without the domain part)
4572 (setq elmo-plugged-condition 'all)
4574 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4575 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4577 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4578 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4582 @item wl-reset-plugged-alist
4583 @vindex wl-reset-plugged-alist
4584 The initial setting is t. If non-nil, plugged states are initialized on
4585 a per server or port basis when Wanderlust starts up.
4587 If nil, plugged states are retained while Emacs is running.
4588 In other words, they are initialized when Emacs is restarted even if the
4593 @node Expire and Archive, Scoring, Disconnected Operations, Top
4594 @chapter Automatic Expiration and Archiving of Messages
4595 @cindex Expire and Archive
4598 * Expire:: Expiration and Archiving
4599 * Archive:: Archiving All Messages
4603 @node Expire, Archive, Expire and Archive, Expire and Archive
4605 @cindex Expire Message
4607 Expiration means deletion of old messages which have outlasted a
4608 certain period of time.
4610 @code{wl-expire} supports not only simple deletion, but also moving to
4611 specified archiving folders.
4615 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4616 or @kbd{M-e} in the summary mode.
4618 @subsection Configuring @code{wl-expire-alist}
4620 An example configuration of @code{wl-expire-alist} is shown below.
4621 Everything in this @code{wl-expire-alist} makes a great difference in
4622 expiration, so be careful.
4623 I advise you to set @code{wl-expire-use-log} to t, especially in the
4628 (setq wl-expire-alist
4629 '(("^\\+trash$" (date 14) remove)
4631 ("^\\+tmp$" (date 7) trash)
4632 ;; @r{re-file to @code{wl-trash-folder}}
4633 ("^\\+outbox$" (number 300) "$outbox;lha")
4634 ;; @r{re-file to the specific folder}
4636 ;; @r{do not expire}
4637 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4638 ;; @r{archive by message number (retaining numbers)}
4639 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4640 ;; @r{archive by a fixed number (retaining numbers)}
4641 ("^\\+diary$" (date 30) wl-expire-archive-date)
4642 ;; @r{archive by year and month (numbers discarded)}
4647 Items in the list has the format of:
4650 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4654 The folder is examined if it matches @var{regexp-for-folders} from the
4655 beginning of the list. If you invoke expiration on the folder that does
4656 not match any of them, nothing will happen.
4657 And if either the second or the third element of the item is nil,
4658 expiration will not take place.
4660 You can use any one of the following for
4661 @var{specification-of-message-to-be-deleted}:
4664 @item (number @var{n1} [@var{n2}])
4665 deletes messages depending on the number of messages in the folder.
4667 @var{n1} is the number of messages which should survive deletion, for example
4668 if its value is 500, the newest 500 messages survive and the rests are
4671 @var{n2} is the number of messages in the folder on which expiration should
4672 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4673 folders with 510 or more messages are expired.
4674 If you configured automatic expiration, frequently used folders may
4675 expire every time it receive messages, and you may be annoyed with the
4676 long delay in reading mail.
4677 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4678 expiration would not take place until a certain number of messages
4681 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4682 with important/new/unread) are not deleted.
4683 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4684 will expire so as to have 500 messages including such ones.
4685 Otherwise, it will have 500 messages except such ones.
4687 @item (date @var{d1})
4688 deletes messages depending on the dates.
4690 Messages dated @var{d1} or more days ago are deleted, for example if its
4691 value is seven, messages seven days old or more are deleted. Note that
4692 the date is the one in the @samp{Date:} field of the message, not when
4693 the message entered the folder.
4695 Messages with no or invalid @samp{Date:} field does not expire; you
4696 might have to delete them by hand.
4699 You can use any one of the following in the place of @var{destination}:
4702 @item @code{'remove}
4703 deletes the messages instantly.
4706 moves the messages to @code{wl-trash-folder}.
4708 @item @var{string}(folder)
4709 moves the messages to the folder specified with @var{string}.
4711 It would be useful for specifying an archiving folder, but because this
4712 does not move important messages, it might be better to use the
4713 standard functions described below.
4715 @item @var{function}
4716 invokes the specified @var{function}.
4718 To the @var{function}, three arguments are passed: a folder name, a list of
4719 messages to be deleted, and msgdb information of the summary.
4720 You can specify function-specific arguments after the name of the
4722 Note that the list contains messages with marks in
4723 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4726 These are three standard functions; they moves messages to an archive
4727 folder in the specified way. This means old messages can be compressed
4728 and saved in a file, being deleted from the original folder.
4731 @item wl-expire-archive-number1
4732 re-files to archiving folders corresponding to the message numbers of
4733 the messages being deleted.
4734 For example, a message numbered 102 will be re-filed to
4735 @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4736 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4737 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4739 The archiving folders to which messages are re-filed are determined by
4740 the name of the folder as follows
4741 (in this case, archiving folders are handled as if
4742 @code{elmo-archive-treat-file} were non-nil).
4745 @item If the folder type is localdir:
4746 @code{$ArchiveDir/foldername-xxxxx.zip}
4748 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4749 (@file{~/Mail/ml/wl-00100.zip}).
4751 @item The folder type is other than localdir:
4752 @code{$ArchiveDir/foldertype/foldername-xxxxx.zip}
4754 For example, @samp{%#mh/ml/wl} corresponds to
4755 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4758 As you can see, in the case of localdir, the folder type is not included
4759 in the path name, but otherwise it is included.
4760 And you can control the prefix to the archiving folder name by
4761 @code{wl-expire-archive-folder-prefix}.
4762 Refer to @code{wl-expire-archive-folder-prefix} for details.
4764 @item wl-expire-archive-number2
4765 re-files every certain number of messages to archiving folders.
4767 This differs from @samp{wl-expire-archive-number1} in that this re-files
4768 to the folder up to the specified number regardless of message numbers.
4769 The archiving folders to which messages are re-filed are determined in the
4770 same way as @code{wl-expire-archive-number1}.
4772 @item wl-expire-archive-date
4773 re-files messages depending on its date (year and month) to archive
4776 For example, a message dated December 1998 is re-filed to
4777 @code{$folder-199812;zip}.
4778 The name of the archiving folders except the date part are determined in
4779 the same way as @code{wl-expire-archive-number1}.
4782 You can set the first argument to these three standard functions to non-nil
4783 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4784 For example, it can be specified just after the name of the function:
4787 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4790 If you omit the argument, consecutive numbers from 1 are assigned for
4791 each archiving folder.
4794 @subsection Treatment for Important or Unread Messages
4796 If you specify any of 'remove, 'trash, a folder name, or a standard
4797 function, messages with marks in @code{wl-summary-expire-reserve-marks}
4798 (which are called @dfn{reserved messages} thereafter) are retained.
4800 Per default, this variable include the important, new, and unread marks,
4801 so that messages with these marks are not removed.
4802 Note that you cannot include the temporary mark (i.e. temporary marks
4803 are removed anyway), and be sure to process temporary marks before you
4806 @subsection Auto Expiration
4808 The following setup invokes expiration when you move into the summary
4809 mode. There will be no confirmation, so make sure you made no mistake
4810 in regexp and other settings before you set up this.
4814 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4818 In the folder mode, you can invoke expiration per group as well as per
4819 folder. Therefore, if you specify @samp{Desktop} group, all folders
4820 matching @code{wl-expire-alist} expire.
4824 @subsection Treating archive folders.
4825 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
4826 you must set non-nil value to @code{elmo-archive-treat-file}.
4828 @subsection Confirming
4830 If you are to use 'remove, try 'trash at first and see messages move to
4831 @code{wl-trash-folder} as expected, then replace it with 'remove.
4832 It would be dangerous to use 'remove from the beginning.
4834 If you are to use @code{wl-expire-archive-number1} and the like, try to
4835 make a folder of the archiver type ('zip or 'lha) and see if you can
4836 append messages to it.
4837 Even if settings in @code{wl-expire-alist} and @code{elmo-archive} are
4838 correct, messages would not be saved anywhere and disappeared in case
4839 the archiver program fails.
4841 After you make sure you can archive to the folder correctly, you can
4842 invoke expiration and utilize the log.
4844 If you set @code{wl-expire-use-log} to t, @file{~/.elmo/expired-log}
4845 should contain the log, for example:
4849 delete +ml/wl (593 594 595 596 597 598 599)
4850 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
4854 The first column indicates the operation, i.e. delete, copy, or move.
4855 The next is the name of the folder that expired. In the case of copy
4856 and move, the destination folder is recorded after @samp{->}.
4857 The last is the list of message numbers that are actually deleted or
4858 moved (in the case of copy and move, the number is the one in the source
4859 folder, rather than the destination folder).
4861 @subsection Re-filing Reserved Messages
4863 The three standard functions copy reserved messages to the archive
4864 folder, but do not delete them from the source folder. Because
4865 reserved messages and the like always remain, they are recorded in
4866 @file{~/.elmo/expired-alist} so that they are not copied over and over
4867 again. They are not recorded if copied by @code{wl-summary-archive}.
4869 If you enabled logging, usually @samp{move} is recorded for re-filing,
4870 but instead @samp{copy} and @samp{delete} are recorded separately if
4871 reserved messages are involved. This is because it actually copies
4872 messages including reserved, then deletes ones except reserved in that
4875 @section Customizable Variables
4878 @item wl-expire-alist
4879 @vindex wl-expire-alist
4880 The initial setting is nil.
4881 This variable specifies folders and methods to expire. For details,
4882 refer to @code{wl-expire-alist} settings above.
4884 @item wl-summary-expire-reserve-marks
4885 @vindex wl-summary-expire-reserve-marks
4886 The initial setting is the list below.
4890 (list wl-summary-important-mark
4892 wl-summary-unread-mark
4893 wl-summary-unread-uncached-mark
4894 wl-summary-unread-cached-mark)
4898 Messages with these marks are retained in the folder, even after
4900 Only permanent marks can be listed, not temporary marks.
4902 You can list marks one by one as in the default; you can use the
4903 following settings as well:
4907 All messages with permanent marks are retained,
4908 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
4912 All messages are handled as usual ones that are already read, no matter
4913 what marks they have; even important messages are deleted.
4916 @item wl-expire-archive-files
4917 @vindex wl-expire-archive-files
4918 The initial setting is 100.
4919 This variable specifies the number of messages to be retained in one
4922 @item wl-expire-number-with-reserve-marks
4923 @vindex wl-expire-number-with-reserve-marks
4924 The initial setting is nil.
4925 If non-nil, if expiring messages are specified by "number", messages
4926 with @code{wl-summary-expire-reserve-marks} are also retained.
4928 @item wl-expire-archive-get-folder-func
4929 @vindex wl-expire-archive-get-folder-func
4930 The initial setting is 'wl-expire-archive-get-folder.
4932 This variable specifies a function that returns the name of an archiving
4933 folder for standard functions in the place of @var{destination}.
4934 You can use the following three variables for simple modification of
4935 folder names; if you want more complex settings, define your own
4936 function in this variable.
4938 @code{wl-expire-archive-get-folder} can be customized by these
4941 @item @code{wl-expire-archive-folder-name-fmt}
4942 @item @code{wl-expire-archive-folder-type}
4943 @item @code{wl-expire-archive-folder-prefix}
4946 @item wl-expire-archive-folder-name-fmt
4947 @vindex wl-expire-archive-folder-name-fmt
4948 The initial setting is @samp{%s-%%05d;%s}.
4949 This is a @code{format} string for archiving folders used in
4950 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
4951 Note that you must specify the message number by @samp{%%d}, because it
4952 is parsed twice by @code{format}.
4954 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
4957 @item wl-expire-archive-date-folder-name-fmt
4958 @vindex wl-expire-archive-date-folder-name-fmt
4959 The initial setting is @samp{%s-%%04d%%02d;%s}.
4960 This is a @code{format} string for archiving folders used in
4961 @code{wl-expire-archive-date}. Note that you must specify the message
4962 number by @samp{%%d}, because it is parsed twice by @code{format}.
4963 There should be @samp{%%d} twice, one for the year and the other for the
4966 If you modify this, adjust
4967 @code{wl-expire-archive-date-folder-num-regexp} as well.
4969 @item wl-expire-archive-folder-type
4970 @vindex wl-expire-archive-folder-type
4971 The initial setting is 'zip.
4972 This variable specifies an archiver type of the archiving folders.
4974 @item wl-expire-archive-folder-prefix
4975 @vindex wl-expire-archive-folder-prefix
4976 The initial setting is nil.
4977 This variable specifies the prefix (directory structure) to archiving
4979 Exercise extreme caution in using this feature, as it has not been
4981 In the worst case, there is a fear of destructing archiving folders.
4985 There will be no prefix.
4988 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
4989 @samp{$ml/wl-00000;zip;wl}.
4992 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
4995 @samp{$ml/wl-00000;zip;ml/wl}.
4998 @item wl-expire-archive-folder-num-regexp
4999 @vindex wl-expire-archive-folder-num-regexp
5000 The initial setting is @samp{-\\([-0-9]+\\);}.
5001 This variable specifies the regular expression to be used for getting
5002 message numbers from multiple archiving folders specified by
5003 @code{elmo-list-folders}.
5004 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5006 @item wl-expire-archive-date-folder-num-regexp
5007 @vindex wl-expire-archive-date-folder-num-regexp
5008 The initial setting is @samp{-\\([-0-9]+\\);}.
5009 This is the regular expression to be used for getting message numbers
5010 from multiple archiving folders specified by @code{elmo-list-folders}.
5011 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5013 @item wl-expire-delete-oldmsg-confirm
5014 @vindex wl-expire-delete-oldmsg-confirm
5015 The initial setting is t.
5016 If non-nil, messages older than the one with the largest number will be
5017 deleted with confirmation.
5018 If nil, they are deleted without confirmation.
5020 This feature is valid only if non-nil is specified as a argument to the
5021 standard functions so as to retain numbers.
5023 @item wl-expire-use-log
5024 @vindex wl-expire-use-log
5025 The initial setting is nil.
5026 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5027 They are appended but not truncated or rotated automatically; you might
5028 need to remove it manually.
5030 @item wl-expire-add-seen-list
5031 @vindex wl-expire-add-seen-list
5032 The initial setting is t.
5034 If non-nil, when messages are re-filed by expiration, read/unread
5035 information is passed to the destination folder.
5037 However if you do not read the destination folder from Wanderlust,
5038 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5039 want to set this to nil if you are simply saving to some archiving
5040 folders. Even if its value is nil, messages in the archiving folders
5041 are simply treated as unread; it does not affect expiration itself.
5043 @item wl-expire-folder-update-msgdb
5044 @vindex wl-expire-folder-update-msgdb
5045 The initial setting is t.
5046 If t, in the folder mode, expiration is carried out after updating
5047 summary information.
5048 If you specified a list of regular expressions of folder names, summary
5049 information is updated for matching folders only.
5053 @node Archive, , Expire, Expire and Archive
5054 @section Archiving Messages
5056 @subsection Archiving Messages
5057 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5058 folders. If there are the archiving folders already, only new messages
5061 You can use @code{wl-archive-alist} in order to specify how messages are
5062 archived according to their folder names, as in @code{wl-expire-alist}.
5067 (setq wl-archive-alist
5068 '(("^\\+tmp$" wl-archive-date)
5069 ("^\\+outbox$" wl-archive-number2)
5070 (".*" wl-archive-number1)
5075 Each item in the list has the following format:
5078 (@var{folders-regexp} @var{deleting-function})
5081 As you can see, you can only use a function after @var{folders-regexp}.
5082 Per default, there are three functions:
5085 @item @code{wl-archive-number1}
5086 @item @code{wl-archive-number2}
5087 @item @code{wl-archive-date}
5090 As inferred from their names, they work similarly to "expire" versions,
5091 other than the following points:
5094 @item No messages are deleted
5095 @item Message numbers are retained even if invoked without arguments
5098 These functions are good to archive all messages in a folder by their
5099 numbers or by their dates.
5100 These are also useful for backup or confirmation purposes before
5102 If you try to re-file them after they are archived, they are deleted but
5105 Per default, the archiving folders to which messages are copied are
5106 determined automatically by @code{wl-expire-archive-get-folder-func}.
5107 You can copy to a specific folder by invoking with a prefix argument,
5108 i.e. @kbd{C-u M-x wl-summary-archive}.
5110 Note that this feature has not been seriously tested, because you can
5111 simply copy to an archiving folder, for example by
5112 @code{wl-summary-copy-region}.
5114 The archiving folders are determined by the same logic as in
5115 @code{wl-summary-expire}; the following customizable variables are
5119 @item @code{wl-expire-archive-files}
5120 @item @code{wl-expire-archive-get-folder-func}
5121 @item @code{wl-expire-archive-folder-name-fmt}
5122 @item @code{wl-expire-archive-folder-type}
5123 @item @code{wl-expire-archive-folder-prefix}
5124 @item @code{wl-expire-archive-folder-num-regexp}
5127 @subsection Customizable Variables
5130 @item wl-archive-alist
5131 @vindex wl-archive-alist
5132 The initial setting is '((".*" wl-archive-number1)).
5134 This variable specifies a function that copies to archiving folders.
5135 To the function, three arguments are passed: a folder name, a list of
5136 messages in the folder, and msgdb information of the summary.
5137 Needless to say, you can use your own function.
5141 @node Scoring, Customization, Expire and Archive, Top
5142 @chapter Score of the Messages
5144 @c @cindex Kill File
5146 Scoring is the function that associates a score (value) with each
5147 message, and marks as read or deletes from the summary according to it.
5149 You can put target or important marks on essential messages, or read marks
5150 on the ones you do not want to read, for example spam articles.
5152 This scoring function has a capability and a format similar to the one
5153 that Gnus has, although there are some unsupported features and
5154 Wanderlust specifics.
5155 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5158 * Score Commands:: Score Commands
5159 * Score File Format:: Score File Format
5163 @node Score Commands, Score File Format, Scoring, Scoring
5164 @section Score Commands
5165 @cindex Score Commands
5167 @subsection Score File Specification
5169 @code{wl-score-folder-alist} specifies score files or variables in which
5170 scores are defined, corresponding to folder names.
5174 (setq wl-score-folder-alist
5183 If paths to the score files are omitted, the directory specified in the
5184 variable @code{wl-score-files-dir} is assumed.
5186 No matter what you write in @code{wl-score-folder-alist}, the default
5187 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5188 read (it does not have to exist).
5189 Therefore, in the example above, the three score files,
5190 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5191 the folders that matches @samp{^-.*}.
5193 @subsection Scored Messages
5195 Scores are attached to the messages that are specified by
5196 @code{wl-summary-score-marks} temporarily when the summary is updated;
5197 when you exit from the summary, the scores are removed and reverts to
5200 @subsection Creation of Score Files
5202 In the summary buffer, move to an appropriate message and type @kbd{L}.
5203 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5204 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5206 This makes @minus{}1000 are scored for messages with the same Subject as
5207 the string you entered. That is, such a score file is created
5210 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5211 The score file you just made appears.
5212 This buffer is called "score editing buffer" thereafter.
5213 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5214 as you are previously; type @kbd{a}. Then a score entry for "From"
5216 In this way, you can create a score file easily either in the summary
5217 buffer or in the score editing buffer.
5219 By the way, you might be aware the numbers of key strokes are different
5220 between @kbd{s s p} and @kbd{a}.
5221 This is determined by @code{wl-score-header-default-entry}.
5222 This variable specifies the default score entries corresponding to
5224 For example, for "subject" field, a type and a time limit are prompted,
5225 but for "from" field, they are fixed upon automatically as substring and
5226 permanent respectively.
5227 However, score values can be modified by the prefix argument.
5228 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5231 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5232 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5233 erasing contents of the buffer deletes the score file being edited.
5237 @subsubsection Selecting Score Files
5239 You can change score files to which scores are appended by
5240 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5241 @code{wl-score-change-score-file}.
5243 @subsubsection Summing Up the Score
5245 If you add the same entries by @code{wl-summary-increase-score},
5246 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5247 scores for the entry is summed up.
5249 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5250 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5251 @minus{}1200 will be created as a result.
5253 @subsubsection Creating Thread Key
5255 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5256 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5258 @subsubsection Creating Followup Key
5260 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5261 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5262 at the cursor to @samp{References} key.
5263 If @code{wl-score-auto-make-followup-entry} is non-nil,
5264 @samp{Message-ID} of all messages to be followed up within dates
5265 specified by @code{wl-score-expiry-days}.
5267 @subsection Key Bindings
5272 @findex wl-summary-increase-score
5273 Increases the score for the current message.
5274 And the score entry is appended to the score file at the same moment.
5275 You can specify the score value by a prefix argument.
5279 @findex wl-summary-lower-score
5280 Decreases the score for the current message.
5281 And the score entry is appended to the score file at the same moment.
5282 You can specify the score value by a prefix argument.
5285 @kindex h R (Summary)
5286 @findex wl-summary-rescore
5287 Re-applies the scoring.
5288 However, already scored messages are not scored anew.
5291 @kindex h c (Summary)
5292 @findex wl-score-change-score-file
5293 Changes the score file currently selected.
5296 @kindex h e (Summary)
5297 @findex wl-score-edit-current-scores
5298 Edits the score file currently selected.
5299 If there are multiple score files, the previously specified one is
5303 @kindex h f (Summary)
5304 @findex wl-score-edit-file
5305 Edits an arbitrary score file and selects it.
5308 @kindex h F (Summary)
5309 @findex wl-score-flush-cache
5310 Erases caches associated to the score files that are read.
5311 If you modified score files directly (from other than Wanderlust), you
5312 need to re-read them after erasing the cache.
5315 @kindex h m (Summary)
5316 @findex wl-score-set-mark-below
5317 Specifies the criterion for scores to be marked as read.
5318 Messages with scores less than this value are marked as read.
5321 @kindex h x (Summary)
5322 @findex wl-score-set-expunge-below
5323 Specifies the criterion for scores to be deleted from the summary.
5324 Messages with scores less than this value are deleted.
5325 "Deleted" means it is not shown; they are not removed from the summary
5326 information or the folder.
5327 The deleted messages can be shown by rescan-noscore again.
5330 @subsection Key Bindings in the Score Editing Buffer
5334 @kindex C-c C-k (Score Mode)
5335 @findex wl-score-edit-kill
5336 Abandons the file being edited.
5339 @kindex C-c C-c (Score Mode)
5340 @findex wl-score-edit-exit
5341 Saves the file being edited, and quits from the edit mode.
5344 @kindex C-c C-p (Score Mode)
5345 @findex wl-score-pretty-print
5349 @kindex C-c C-d (Score Mode)
5350 @findex wl-score-edit-insert-date
5351 Inserts the number of dates from Dec. 31, 1 B.C.
5352 It is used for creating the third factor of time-limited scores.
5355 @kindex C-c C-s (Score Mode)
5356 @findex wl-score-edit-insert-header
5357 Inserts the header of the message selected in the summary buffer.
5360 @kindex C-c C-e (Score Mode)
5361 @findex wl-score-edit-insert-entry
5362 Inserts the score entry of the message selected in the summary buffer.
5365 @subsection Customizable Variables
5368 @item wl-summary-default-score
5369 @vindex wl-summary-default-score
5370 The initial setting is zero.
5371 This variable specifies the default value of the score.
5372 The score is increased or decreased based upon this value.
5374 @item wl-summary-important-above
5375 @vindex wl-summary-important-above
5376 The initial setting is nil.
5377 Messages with scores larger than this value are attached with the
5378 important mark (@samp{$}).
5379 If nil, no important marks are attached.
5381 @item wl-summary-target-above
5382 @vindex wl-summary-target-above
5383 The initial setting is nil.
5384 Messages with scores larger than this value are attached with the target
5386 If nil, no target marks are attached.
5388 @item wl-summary-mark-below
5389 @vindex wl-summary-mark-below
5390 The initial setting is zero.
5391 Messages with scores smaller than this value are marked as read.
5393 @item wl-summary-expunge-below
5394 @vindex wl-summary-expunge-below
5395 The initial setting is nil.
5396 Messages with scores smaller than this value are deleted from the
5398 If nil, they are not deleted.
5400 @item wl-summary-score-marks
5401 @vindex wl-summary-score-marks
5402 The initial setting is '("N").
5403 Messages with these marks are scored.
5405 @item wl-use-scoring
5406 @vindex wl-use-scoring
5407 The initial setting is t.
5408 If non-nil, scoring is enabled.
5410 @item wl-score-files-dir
5411 @vindex wl-score-files-dir
5412 The initial setting is @file{~/.elmo/}.
5413 The default directory for score files.
5415 @item wl-score-interactive-default-score
5416 @vindex wl-score-interactive-default-score
5417 The initial setting is 1000.
5418 This value is used as a score when a score factor is nil in the score
5420 It is also used in @code{wl-summary-increase-score} and
5421 @code{wl-summary-lower-score}, on condition that the value of
5422 @code{wl-score-header-default-entry} is nil.
5424 @item wl-score-expiry-days
5425 @vindex wl-score-expiry-days
5426 The initial setting is 7.
5427 This is the number of days before time-limited scores are deleted.
5429 @item wl-score-update-entry-dates
5430 @vindex wl-score-update-entry-dates
5431 The initial setting is t.
5432 If non-nil, it enables deletion of time-limited scores.
5434 @item wl-score-header-default-entry
5435 @vindex wl-score-header-default-entry
5436 Specifies the default value for each header field for score entries
5437 created by @code{wl-summary-increase-score},
5438 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5440 @item wl-score-simplify-fuzzy-regexp
5441 @vindex wl-score-simplify-fuzzy-regexp
5442 In the case of a type of a score entry is "fuzzy", this specifies a
5443 regular expression to be deleted from the string.
5444 Because this is usually used for Subject, the default is prefixes that
5445 are attached by mailing list programs.
5447 @item wl-summary-rescore-partial-threshold
5448 @vindex wl-summary-rescore-partial-threshold
5449 The initial setting is 200.
5450 When sync-all or rescan is executed, if there are messages more than
5451 this value, only the last same number of messages as this value are
5454 @item wl-summary-auto-sync-marks
5455 @vindex wl-summary-auto-sync-marks
5456 If non-nil, unread/important marks are synchronized when the summary
5458 Unread marks reflect information on the IMAP4 server.
5459 Important marks reflect information on the IMAP4 server (flagged or
5460 not), and contents of 'mark folder.
5461 The initial setting is t.
5465 @node Score File Format, , Score Commands, Scoring
5466 @section Score File Format
5467 @cindex Score File Format
5469 The format of score files are the same as Gnus, and basically you can
5470 use Gnus score files as they are. But they are not fully compatible
5471 because some keys are not supported and there are Wanderlust specifics.
5472 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5477 ("for sale" -1000 nil s)
5478 ("profit" -1000 nil s))
5480 ("spam@@spamspamspam" -10000 nil s))
5482 ("my@@address" 3001 nil s))
5484 (1000000 -10 nil >))
5494 If the key is a string, it is the name of the header to be matched.
5495 The following keys are available:
5496 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5497 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5498 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5499 @code{Chars} and @code{Lines} mean the size and the number of lines of
5500 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5501 are described later.
5502 The rest corresponds the field of the same name.
5504 Arbitrary numbers of core entries are specified after the key.
5505 Each score entry consists of these five factors:
5509 A factor that matches header. This should be a number in the cases of
5510 "lines" and "chars", otherwise a string.
5513 A score factor. When the first item matches, the score of the message
5514 is increased or decreased by this value.
5517 A time limiting factor. If nil, the score is permanent, and in the case
5518 of a number, the score is deleted if it does not match for days
5519 (@code{wl-score-expiry-days}) from the date specified by this.
5520 The date is since Dec. 31, 1 B.C.
5523 A type factor. This specifies the way the first factor matches.
5524 Available types depend on keys.
5527 @item From, Subject, References, Message-ID
5528 For these keys in string, @code{r} and @code{R} (regexp),
5529 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5530 as well as @code{f} and @code{F} (fuzzy) can be used.
5531 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5534 For these keys, the following five numerical relative operators can be
5535 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5538 This key matches @code{From} header, and scores all follow-ups to the
5540 For example, it would be useful for increasing scores for follow-ups to
5543 You can use the same types as @code{From} except for @code{f}.
5544 And a @samp{Followup} entry is automatically appended to the score file.
5547 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5548 A @samp{Thread} entry is automatically appended for each article that
5549 has @var{x} in the @code{References} header.
5550 You can make sure the whole thread including messages that does not have
5551 all ancestors @code{Message-ID} in @code{References} is scored.
5553 You can use the same types as @code{References} except for @code{f}.
5554 And a @samp{Thread} entry is automatically appended to the score file.
5558 A factor for extension header. This is meaningful only if the key is
5560 This specifies headers to be matched other than standard headers like
5561 @code{Subject} and @code{From}.
5562 Note that you should specify the header in
5563 @code{elmo-msgdb-extra-fields} also.
5564 Therefore it does not work in folders where extension headers cannot be
5569 The sum of these scores @emph{after all factors are applied} becomes the
5570 score of the message.
5572 @cindex Score File Atoms
5574 Messages with a score less than this value is marked as read.
5575 The default is @code{wl-summary-mark-below}.
5578 Messages with a score less than this value is deleted from the summary.
5579 The default is @code{wl-summary-expunge-below}.
5581 @item mark-and-expunge
5582 Both @code{mark} and @code{expunge} are applied,
5583 i.e. messages with a score less than this value is marked as read and
5584 deleted from the summary.
5587 Messages with a score greater than this value is attached with temp
5589 The default is @code{wl-summary-target-above}.
5592 Messages with a score greater than this value is attached with important
5594 The default is @code{wl-summary-important-above}.
5599 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5600 are used, you need to set @code{elmo-msgdb-extra-fields}.
5603 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5606 There are other restrictions as shown below:
5609 @item Because @samp{References} field in the summary information
5610 contains only the last @samp{Message-ID}, @code{references} key matches
5614 Keys that can be seen by folder of types:
5618 chars lines xref extra
5619 localdir,localnews Y E E E
5620 nntp (supporting xover) Y E E N
5626 N: cannot be seen (ignored)
5627 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5632 @node Customization, Mailing List, Scoring, Top
5633 @chapter Customizing Wanderlust
5634 @cindex Customization
5637 * Living with other packages:: Living with other packages
5638 * Highlights:: Highlights
5639 * Biff:: Notify Mail arrival
5640 * Advanced Settings:: Advanced Settings
5641 * Customizable Variables:: Customizable Variables
5646 @node Living with other packages, Highlights, Customization, Customization
5647 @section Living with other packages
5649 Examples with other packages.
5652 * imput:: imput (im-wl.el)
5654 * supercite:: supercite.el
5655 * mu-cite:: mu-cite.el
5656 * x-face-mule:: x-face-mule.el
5657 * dired-dd:: dired-dd.el
5661 @node imput, BBDB, Living with other packages, Living with other packages
5666 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5669 If imput is on the @code{exec-path} at the installation, @file{im-wl.el}
5670 is byte-compiled and installed.
5675 (autoload 'wl-draft-send-with-imput-async "im-wl")
5676 (setq wl-draft-send-func 'wl-draft-send-with-imput-async)
5681 @node BBDB, supercite, imput, Living with other packages
5685 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
5688 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
5689 byte-compiled and installed.
5697 ;; @r{enable pop-ups}
5698 (setq bbdb-use-pop-up t)
5699 ;; @r{auto collection}
5700 (setq bbdb/mail-auto-create-p t)
5701 (setq signature-use-bbdb t)
5702 (setq bbdb-north-american-phone-numbers-p nil)
5703 ;; @r{shows the name of bbdb in the summary} :-)
5704 (setq wl-summary-from-func 'bbdb-wl-from-func)
5705 ;; @r{automatically add mailing list fields}
5706 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
5707 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
5711 @node supercite, mu-cite, BBDB, Living with other packages
5712 @subsection sc.el(supercite), sc-register.el
5716 The same setting as usual mailers should be OK. The following is an
5717 example of settings:
5721 (autoload 'sc-cite-original "sc" nil t)
5722 (setq mail-yank-hooks 'sc-cite-original)
5723 (setq sc-preferred-header-style 1)
5724 (setq sc-electric-references-p nil)
5725 (setq sc-citation-leader "")
5726 (setq sc-load-hook '(lambda () (require 'sc-register)))
5727 (setq sc-preferred-attribution 'registeredname)
5732 @node mu-cite, x-face-mule, supercite, Living with other packages
5733 @subsection mu-cite.el
5736 The same setting as usual mailers should be OK. The following is an
5737 example of settings.
5739 If you use mu-cite version 8.0 or earlier:
5743 (autoload 'mu-cite/cite-original "mu-cite" nil t)
5744 (setq mail-citation-hook 'mu-cite/cite-original)
5748 If you use mu-cite version 8.1 or later:
5752 (autoload 'mu-cite-original "mu-cite" nil t)
5753 (add-hook 'mail-citation-hook (function mu-cite-original))
5757 @node x-face-mule, dired-dd, mu-cite, Living with other packages
5758 @subsection x-face-mule.el
5762 It depends on the version of x-face-mule.
5763 If you use x-face-mule 0.19 or older, do the following:
5767 (setq wl-highlight-x-face-func
5770 (x-face-mule:x-face-decode-message-header))))
5774 If you use x-face-mule 0.20 or later, try the following:
5778 (setq wl-highlight-x-face-func
5781 (x-face-mule-x-face-decode-message-header))))
5782 (require 'x-face-mule)
5786 Use these settings when you use @file{x-face-mule.el} attached to
5787 bitmap-mule 8.0 or later:
5791 (autoload 'x-face-decode-message-header "x-face-mule")
5792 (setq wl-highlight-x-face-func 'x-face-decode-message-header)
5796 If there is an encoded X-Face string in a file @file{~/.xface} (the
5797 value of the variable @code{wl-x-face-file}), it is inserted as a
5798 @samp{X-Face:} field in the draft buffer (if
5799 @code{wl-auto-insert-x-face} is non-nil).
5802 @node dired-dd, , x-face-mule, Living with other packages
5803 @subsection dired-dd(Dired-DragDrop)
5804 @pindex Dired-DragDrop
5806 @cindex Drag and Drop
5808 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
5809 compose multi-part by simple Drag-and-Drop from dired to the draft
5810 buffer being edited in GNU Emacs (this feature is not Wanderlust
5811 specific, but general-purpose for tm/SEMI).
5815 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
5821 ;; @r{Set dired-x variables here.}
5822 ;; @r{To and flo@dots{}}
5824 (progn (require 'dired-dd)
5825 (require 'dired-dd-mime))))))
5830 @node Highlights, Biff, Living with other packages, Customization
5833 @subsection Customizable Variables
5836 @item wl-summary-highlight
5837 @vindex wl-summary-highlight
5838 The initial setting is t.
5839 If non-nil, the summary is highlighted.
5841 @item wl-highlight-max-summary-lines
5842 @vindex wl-highlight-max-summary-lines
5843 The initial setting is 10000.
5844 The summary is not highlighted if it has more lines than this value.
5846 @item wl-summary-highlight-partial-threshold
5847 @vindex wl-summary-highlight-partial-threshold
5848 The initial setting is 1000.
5849 This is a threshold whether the whole summary is highlighted.
5850 If there are more lines of messages in the summary, it is partially
5853 @item wl-summary-partial-highlight-above-lines
5854 @vindex wl-summary-partial-highlight-above-lines
5855 The initial setting is 30.
5856 If there are more lines of messages than
5857 @code{wl-summary-highlight-partial-threshold} in the summary, messages
5858 after the point that is the same number of lines as this value above the
5859 cursor line are highlighted partially.
5860 (If this value is nil, the last same number of lines as the value of
5861 @code{wl-summary-highlight-partial-threshold} are highlighted.)
5863 @item wl-highlight-body-too
5864 @vindex wl-highlight-body-too
5865 The initial setting is t.
5866 If non-nil, bodies of drafts and messages are also highlighted.
5868 @item wl-highlight-message-header-alist
5869 @vindex wl-highlight-message-header-alist
5870 When highlighting headers of drafts and messages, this variable
5871 specifies which faces are allocated to important
5872 (@code{wl-highlight-message-important-header-contents}), secondly
5873 important (@code{wl-highlight-message-important-header-contents2}), and
5874 unimportant (@code{wl-highlight-message-unimportant-header-contents})
5876 Similarly, it can be used for allocating arbitrary faces to arbitrary
5877 regular expressions.
5879 @item wl-highlight-citation-prefix-regexp
5880 @vindex wl-highlight-citation-prefix-regexp
5881 Specifies a regular expression to which quoted lines in bodies of
5882 drafts and messages match.
5883 Bodies matching to this regular expression are highlighted by the faces
5884 specified by (@code{wl-highlight-message-cited-text-*}).
5886 @item wl-highlight-highlight-citation-too
5887 @vindex wl-highlight-highlight-citation-too
5888 The initial setting is nil.
5889 If non-nil, the quoting regular expression itself given by
5890 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
5892 @item wl-highlight-citation-header-regexp
5893 @vindex wl-highlight-citation-header-regexp
5894 Specifies a regular expression that denotes beginning of quotation.
5895 Bodies matching to this regular expression are highlighted by the face
5896 specified by @code{wl-highlight-message-headers}.
5898 @item wl-highlight-max-message-size
5899 @vindex wl-highlight-max-message-size
5900 The initial setting is 10000.
5901 If a message is larger than this value, it will not be highlighted.
5902 With this variable, highlight is suppressed for uuencode or huge digest
5905 @item wl-highlight-signature-separator
5906 @vindex wl-highlight-signature-separator
5907 Specifies regular expressions that denotes the boundary of a signature.
5908 It can be a regular expression, or a list of ones.
5909 Messages after the place that matches this regular expression are
5910 highlighted by the face specified by
5911 @code{wl-highlight-message-signature}.
5913 @item wl-max-signature-size
5914 @vindex wl-max-signature-size
5915 The initial setting is 400.
5916 This is the largest size for a signature to be highlighted.
5918 @item wl-use-highlight-mouse-line
5919 @vindex wl-use-highlight-mouse-line
5920 The initial setting is t.
5921 If non-nil, the line pointed by the mouse is highlighted in the folder
5922 mode, summary mode, and the like.
5925 @subsection Setting Colors and Fonts of the Characters
5927 If you want to change colors or fonts of the characters, you need to
5928 modify faces defined in Wanderlust. Use @code{set-face-font} if you
5929 want to change fonts, and @code{set-face-foreground} for colors, and so
5930 on. You cannot write face settings in @file{.emacs}; write in
5933 For example, if you want to change the color for signatures to yellow,
5937 (set-face-foreground 'wl-highlight-message-signature "yellow")
5943 Faces defined in Wanderlust:
5946 @item wl-highlight-message-headers
5947 The face for field names of message headers.
5949 @item wl-highlight-message-header-contents
5950 The face for field bodies of message headers.
5952 @item wl-highlight-message-important-header-contents
5953 The face for important parts of message headers.
5954 Per default, this face is used for a body of @samp{Subject:} field.
5955 You can change its value by editing
5956 @code{wl-highlight-message-header-alist}.
5958 @item wl-highlight-message-important-header-contents2
5959 The face for secondly important parts of message headers.
5960 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
5961 fields. You can change its value by editing
5962 @code{wl-highlight-message-header-alist}.
5964 @item wl-highlight-message-unimportant-header-contents
5965 The face for unimportant parts of message headers.
5966 Per default, this face is used for bodies of @samp{X-} fields
5967 @samp{User-Agent:} fields. You can change its value by editing
5968 @code{wl-highlight-message-header-alist}.
5970 @item wl-highlight-message-citation-header
5971 The face for headers of quoted messages.
5973 @item wl-highlight-message-cited-text-*
5974 The face for texts of quoted messages.
5975 The last @samp{*} is a single figure so that 10 different colors can be used
5976 according to citation levels.
5978 @item wl-highlight-message-signature
5979 The face for signatures of messages.
5980 The initial settings are khaki for light background colors, and
5981 DarkSlateBlue for dark background colors.
5983 @item wl-highlight-header-separator-face
5984 The face for header separators of draft messages.
5986 @item wl-highlight-summary-important-face
5987 The face for message lines with important marks in the summary.
5989 @item wl-highlight-summary-new-face
5990 The face for message lines with new marks in the summary.
5992 @item wl-highlight-summary-displaying-face
5993 The face for the message line that is currently displayed.
5994 This face is overlaid.
5996 @item wl-highlight-thread-indent-face
5997 The face for the threads that is currently displayed.
5999 @item wl-highlight-summary-unread-face
6000 The face for message lines with unread marks in the summary.
6002 @item wl-highlight-summary-deleted-face
6003 The face for message lines with delete marks in the summary.
6005 @item wl-highlight-summary-refiled-face
6006 The face for message lines with re-file marks in the summary.
6008 @item wl-highlight-refile-destination-face
6009 The face for re-file information part of message lines with re-file
6010 marks in the summary.
6012 @item wl-highlight-summary-copied-face
6013 The face for message lines with copy marks in the summary.
6015 @item wl-highlight-summary-target-face
6016 The face for message lines with target marks @samp{*} in the summary.
6018 @item wl-highlight-summary-thread-top-face
6019 The face for message lines that are on the top of the thread in the
6022 @item wl-highlight-summary-normal-face
6023 The face for message lines that are not on top of the thread in the
6026 @item wl-highlight-folder-unknown-face
6027 The face for folders that are not known to have how many unsync messages
6030 @item wl-highlight-folder-zero-face
6031 The face for folders that have no unsync messages in the folder mode.
6033 @item wl-highlight-folder-few-face
6034 The face for folders that have some unsync messages in the folder mode.
6036 @item wl-highlight-folder-many-face
6037 The face for folders that have many unsync messages in the folder mode.
6038 The boundary between `some' and `many' is specified by the variable
6039 @code{wl-folder-many-unsync-threshold}.
6041 @item wl-highlight-folder-unread-face
6042 The face for folders that have no unsync but unread messages in the
6045 @item wl-highlight-folder-killed-face
6046 The face for folders that are deleted from the access group in the
6049 @item wl-highlight-folder-opened-face
6050 The face for open groups in the folder mode.
6051 It is meaningful when @code{wl-highlight-group-folder-by-numbers} is nil
6054 @item wl-highlight-folder-closed-face
6055 The face for close groups in the folder mode.
6056 It is meaningful when @code{wl-highlight-group-folder-by-numbers} is nil
6059 @item wl-highlight-folder-path-face
6060 The face for the path to the currently selected folder in the folder
6063 @item wl-highlight-logo-face
6064 The face for logo in the demo.
6066 @item wl-highlight-demo-face
6067 The face for strings (for example, a version number) in the demo.
6071 @node Biff, Advanced Settings, Highlights, Customization
6072 @section Notify Mail arrival
6074 Following setting is to notify mail arrival of @samp{%inbox}
6075 by the indicator on the modeline
6078 (setq wl-biff-check-folder-list '("%inbox"))
6081 @subsection Customizable Variables
6083 @item wl-biff-check-folder-list
6084 @vindex wl-biff-check-folder-list
6085 The initial setting is nil.
6086 This is the list of folders to check mail arrival.
6087 If nil, wl doesn't check mail arrival.
6089 @item wl-biff-check-interval
6090 @vindex wl-biff-check-interval
6091 The initial setting is 40 (in seconds).
6092 Check mail arrival in this period.
6096 @node Advanced Settings, Customizable Variables, Biff, Customization
6097 @section Advanced Settings
6100 * Draft for Reply:: Draft for Reply
6101 * Thread Format:: Appearance of Thread
6102 * User-Agent Field:: @samp{User-Agent:} Header Field
6106 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6107 @subsection Draft for Replay
6109 If you want, when you replying to articles in mailing lists, the address
6110 in Reply-To field of the original message to be prepared to To field of
6111 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6116 (setq wl-draft-reply-without-argument-list
6117 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6118 ("Followup-To" . (nil nil ("Followup-To")))
6119 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6120 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6125 (Only if there are both of @samp{X-ML-Name} and @samp{Reply-To} fields in the
6126 original message, @samp{Reply-To} field in the original is copied to @samp{To:}
6129 Moreover, the behavior of @kbd{a} with prefix argument can
6130 be directed by @code{wl-draft-reply-with-argument-list} as well.
6132 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6133 @subsection Appearance of Threads
6137 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6138 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6139 391 09/18(Fri)19:24 +-[ Murata-san ]
6140 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6141 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6142 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6143 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6144 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6145 412 09/22(Tue)09:28 | +-[ Teranishi ]
6146 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6147 416 09/22(Tue)12:38 | +-[ Teranishi ]
6148 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6149 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6153 Settings to make appearance of threads like shown above:
6157 (setq wl-thread-indent-level 2)
6158 (setq wl-thread-have-younger-brother-str "+")
6159 (setq wl-thread-youngest-child-str "+")
6160 (setq wl-thread-vertical-str "|")
6161 (setq wl-thread-horizontal-str "-")
6162 (setq wl-thread-space-str " ")
6166 If you do not want to see branches, do the following:
6170 (setq wl-thread-indent-level 2)
6171 (setq wl-thread-have-younger-brother-str " ")
6172 (setq wl-thread-youngest-child-str " ")
6173 (setq wl-thread-vertical-str " ")
6174 (setq wl-thread-horizontal-str " ")
6175 (setq wl-thread-space-str " ")
6180 @node User-Agent Field, , Thread Format, Advanced Settings
6181 @subsection User-Agent Field
6183 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6184 @samp{User-Agent:} fields, define a function that generate appropriate
6185 strings as you like, and set it to
6186 @code{wl-generate-mailer-string-func}.
6188 If you do not want verbose @samp{User-Agent:} field, do the following:
6192 (setq wl-generate-mailer-string-func
6195 (let ((mime-edit-insert-user-agent-field nil))
6196 (wl-generate-user-agent-string)))))
6200 The following is a example:
6204 (setq wl-generate-mailer-string-func
6207 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6212 @node Customizable Variables, Hooks, Advanced Settings, Customization
6213 @section Customizable Variables
6215 Customizable variables that have not been described yet:
6218 @item wl-default-folder
6219 @vindex wl-default-folder
6220 The initial setting is @samp{%inbox}. This is the default value for moving to
6221 a folder and the like.
6223 @item wl-draft-folder
6224 @vindex wl-draft-folder
6225 The initial setting is @samp{+draft}. It is the folder to which drafts are
6226 saved. It must be a localdir folder.
6228 @item wl-trash-folder
6229 @vindex wl-trash-folder
6230 The initial setting is @samp{+trash}. It is the wastebasket folder.
6231 If you changed this variable, you had better restart Wanderlust.
6233 @item wl-interactive-exit
6234 @vindex wl-interactive-exit
6235 The initial setting is t.
6236 If non-nil, you are asked for confirmation when Wanderlust terminates.
6238 @item wl-interactive-send
6239 @vindex wl-interactive-send
6240 The initial setting is nil.
6241 If non-nil, you are asked for confirmation when mail is sent.
6243 @item wl-folder-sync-range-alist
6244 @vindex wl-folder-sync-range-alist
6245 The initial setting is the list shown below:
6250 ("^\\+draft$\\|^\\+queue$" . "all"))
6254 This is an associative list of regular expressions of folder names and
6255 update range of the summary.
6256 Update range is one of the "all", "update", "rescan", "rescan-noscore", "first"
6257 and "last". If a folder do not match, "update" is used.
6260 @vindex wl-ask-range
6261 The initial setting is t.
6262 If nil, the value of @code{wl-folder-sync-range-alist} is used for
6263 updating the summary when you changed folders.
6265 @item wl-mime-charset
6266 @vindex wl-mime-charset
6267 The initial setting is 'x-ctext.
6268 This is the MIME charset for messages that are not MIME (e.g. without
6269 @samp{Content-Type:}). This value also used as default charset for
6270 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6271 this value as 'iso-2022-jp.)
6273 @item wl-highlight-folder-with-icon
6274 @vindex wl-highlight-folder-with-icon
6275 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6276 on (X)Emacs (t for XEmacs or Emacs 21 with icons).
6278 @item wl-strict-diff-folders
6279 @vindex wl-strict-diff-folders
6280 This is a list of regular expressions of folders.
6281 Unread messages are checked, for example when you press @kbd{s} in
6282 the folder mode, usually in a brief way (rapidly processed but not
6284 The folders matching this variable are seriously checked.
6285 You may want to set this variable so as to match conditional filter
6286 folders for IMAP4 folders.
6287 The initial setting is nil.
6289 @item wl-folder-use-server-diff
6290 @vindex wl-folder-use-server-diff
6291 When unread messages are checked, for example when you press @kbd{s} in
6292 the folder mode, usually (the number of messages on the server) - (the
6293 number of local messages) will be the number of unread messages.
6294 However, if this variable is non-nil, the number of unread messages on
6295 the server is checked. This affects IMAP4 folders only, but IMAP4
6296 folders in mail boxes matching
6297 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6298 the number of unread messages on the server, even if they matches this
6299 variable. The initial setting is t.
6301 @item wl-auto-check-folder-name
6302 @vindex wl-auto-check-folder-name
6303 The initial setting is nil.
6304 If non-nil, the folder with the name of the value is checked for unread
6305 messages at the start.
6306 If it is 'none, no folders are checked.
6307 If it is a list, all folders in the list are checked at the start.
6309 @item wl-auto-uncheck-folder-list
6310 @vindex wl-auto-uncheck-folder-list
6311 The initial setting is '("\\$.*").
6312 Folders with the name matching this variable are not checked for unread
6313 messages at the start, even if they are included in the groups in
6314 @code{wl-auto-check-folder-name}.
6316 @item wl-auto-check-folder-list
6317 @vindex wl-auto-check-folder-list
6318 The initial setting is nil.
6319 Folders with the name matching this variable are always checked for
6320 unread messages at the start, if they are included in the groups in
6321 @code{wl-auto-check-folder-name}.
6322 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6324 @item wl-no-save-folder-list
6325 @vindex wl-no-save-folder-list
6326 The initial setting is '("^/.*$").
6327 This is a list of regular expressions of folders not to be saved.
6329 @item wl-save-folder-list
6330 @vindex wl-save-folder-list
6331 The initial setting is nil.
6332 This is a list of regular expressions of folders to be saved.
6333 This takes precedence over @code{wl-no-save-folder-list}.
6335 @item wl-folder-mime-charset-alist
6336 @vindex wl-folder-mime-charset-alist
6337 The initial setting is the list shown below:
6341 '(("^-alt\\.chinese" . big5)
6342 ("^-relcom\\." . koi8-r)
6344 ("^-han\\." . euc-kr))
6348 This is an associative list of regular expressions of folder names and
6350 If a folder do not match, @code{wl-mime-charset} is used.
6352 @item wl-folder-init-load-access-folders
6353 @vindex wl-folder-init-load-access-folders
6354 The initial setting is nil.
6355 This is a list of access groups to be loaded specifically at the start.
6356 If it is nil, @code{wl-folder-init-no-load-access-folders} is referred.
6358 @item wl-folder-init-no-load-access-folders
6359 @vindex wl-folder-init-no-load-access-folders
6360 The initial setting is nil.
6361 This is a list of access groups not to be loaded specifically at the
6363 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6365 @item wl-delete-folder-alist
6366 @vindex wl-delete-folder-alist
6367 The initial setting is '(("^-" . remove)).
6368 This list determines disposition of messages with delete marks.
6369 Each item in the list is a folder and destination; you can specify any
6370 one of the following in the place of destination:
6373 'remove or 'null : deletes the messages instantly.
6374 string : moves the messages to the specific folder.
6375 'trash or others : moves the messages to `wl-trash-folder'.
6378 @item wl-refile-policy-alist
6379 @vindex wl-refile-policy-alist
6380 The initial setting is '(("^[-=]" . copy) (".*" . move)).
6381 This list determines whether messages with re-file marks are moved or
6382 copied. Each item in the list is a cons cell of a folder and
6383 @code{copy} or @code{move}.
6385 @item wl-x-face-file
6386 @vindex wl-x-face-file
6387 The initial setting is @file{~/.xface}.
6388 The name of the file that contains encoded X-Face strings.
6391 @item wl-demo-display-logo
6392 @vindex wl-demo-display-logo
6393 If non-nil, bitmap image is shown on the opening demo. If you set
6394 @code{xpm} or @code{xbm}, (if possible) display selected image type
6397 @item elmo-use-database
6398 @vindex elmo-use-database
6399 This is meaningful for XEmacs only. The initial setting depends on
6400 XEmacs (t for XEmacs with dbm).
6401 If non-nil, Message-ID is controlled by dbm.
6403 @item elmo-passwd-alist-file-name
6404 @vindex elmo-passwd-alist-file-name
6405 The initial setting is @file{passwd}.
6406 This is the name of the file in which passwords are saved.
6407 @code{elmo-passwd-alist-save} saves current passwords to the file.
6409 @item elmo-nntp-list-folders-use-cache
6410 @vindex elmo-nntp-list-folders-use-cache
6411 The initial setting is 600 (in seconds).
6412 This is period in seconds during which results of @samp{list} and
6413 @samp{list active} in NNTP are cached. If it is nil, they are not
6416 @item elmo-nntp-max-number-precedes-list-active
6417 @vindex elmo-nntp-max-number-precedes-list-active
6418 The initial setting is nil.
6419 If non-nil, the number of article obtained by @samp{list active} in NNTP
6420 are used as the maximum article number of the folder.
6421 Set this to t if you are using for example INN 2.3 as an NNTP server,
6422 and if the number of read messages is not correct.
6424 @item elmo-nntp-default-use-listgroup
6425 @vindex elmo-nntp-default-use-listgroup
6426 The initial setting is t.
6427 If non-nil, @samp{listgroup} is used for checking the total number of
6428 articles. If it is nil, @samp{group} is used. In the latter case, the
6429 processing will be a little faster at the sacrifice of accuracy.
6431 @item elmo-pop3-send-command-synchronously
6432 @vindex elmo-pop3-send-command-synchronously
6433 The initial setting is nil.
6434 If non-nil, POP3 commands are issued synchronously. Some implementation
6435 of POP3 server fails to get summary information without this setting.
6436 You may have to set this variable to t, if the process hangs while
6439 @item elmo-dop-flush-confirm
6440 @vindex elmo-dop-flush-confirm
6441 The initial setting is t.
6442 If non-nil, you are asked for confirmation if accumulated off-line
6443 operations are executed.
6445 @item elmo-display-progress-threshold
6446 @vindex elmo-display-progress-threshold
6447 The initial setting is 20.
6448 Threshold for display of progress gauge. If number of renewal is more than
6449 this value, display progress gauge.
6453 @node Hooks, , Customizable Variables, Customization
6459 @node Mailing List, Addition, Customization, Top
6460 @chapter Wanderlust Mailing List
6465 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6468 Topics related to Wanderlust are discussed in the mailing list.
6469 The latest version is also announced there (in Japanese, sorry).
6471 A guide can be obtained automatically by sending mail to
6472 @t{wl-ctl@@lists.airs.net} with the body
6477 Please send bug reports or patches to the mailing list.
6478 You can post to the mailing list even though you are not a member of it.
6480 If you send a bug report, please attach Backtrace with it.
6481 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to in Japanese.}
6483 I would like to express my thanks to the members of the mailing list for
6484 valuable advice and many pieces of code they contributed.
6487 @node Addition, Index, Mailing List, Top
6488 @chapter Additional Information
6490 @section Brief History
6493 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6494 3/10 Made a msgdb mechanism by elisp.
6495 3/26 IMAP and NNTP can be displayed in threads.
6496 4/13 Began to assemble thread display modules as elmo.
6497 5/01 Finished 0.1.0, initial version with many defects.
6498 6/12 I made a slip of the tongue and said I was writing elisp
6499 mailer supporting IMAP
6500 6/16 0.1.3 was announced at tm-ja, elisp ML.
6501 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6502 7/01 Support for mm-backend (0.3.0).
6503 8/25 multi folder added (0.5.0).
6504 8/28 filter folder added (0.5.1).
6505 9/10 You can open/close threads (0.6.0).
6506 9/11 fldmgr by Murata-san made editing folders easy.
6507 9/18 lha folders added by Okunishi-san (0.6.3).
6508 9/24 Display of branches of threads (0.6.5).
6509 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6510 10/28 Off-line operations (0.7.4).
6511 12/09 Becomes beta version.
6512 12/21 wl-expire by Murata-san.
6513 1999 2/03 auto-refile by Tsumura-san.
6514 4/28 wl-template by Murata-san.
6515 5/18 Released 1.0.0 stable.
6516 7/05 Scoring by Murata-san (2.1.0).
6517 9/26 New plugged system by Murata-san (2.2.2).
6518 12/20 Support Modified UTF7.
6519 2000 3/24 Released 1.1.0 stable.
6520 4/03 CVS development started.
6521 5/07 Thread restoration & Its speed up with Murata-san.
6522 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6523 7/11 killed message feature.
6524 7/18 Use UIDL in POP3.
6525 9/12 biff feature with Satata-san & Yamaoka-san.
6528 See @file{ChangeLog} for details.
6532 According to a dictionary, Wanderlust has the meaning:
6536 n eager longing for or impulse towards travelling in distant lands
6537 [Ger, fr wandern to wander + lust desire, pleasure]
6541 but I had no profound intention. (if farfetched, IMAP @result{} you can
6542 read mail anywhere @result{} desire to wander ?)
6544 Elmo is the abbreviation of @samp{Elisp Library for Message
6545 Orchestration}. At first I meant the red puppet in the Sesame Street,
6546 but you may associate it with Wandering @result{} Drifting @result{}
6547 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6551 Each versions has code names (they are almost jokes).
6552 Currently they are picked up alphabetically from the top 40 hits of
6553 U.S. Billboard magazines in 1980s.
6555 (@uref{http://www.summer.com.br/~pfilho/html/top40/index.html})
6558 @node Index, , Addition, Top
6562 * Concept Index:: Concept Index
6563 * Key Index:: Key Index
6564 * Variable Index:: Variable Index
6565 * Function Index:: Function Index
6568 @node Concept Index, Key Index, Index, Index
6569 @unnumberedsec Concept Index
6572 @node Key Index, Variable Index, Concept Index, Index
6573 @unnumberedsec Key Index
6576 @node Variable Index, Function Index, Key Index, Index
6577 @unnumberedsec Variable Index
6580 @node Function Index, , Variable Index, Index
6581 @unnumberedsec Function Index