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
620 @code{nil}), 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{!}]
760 You can specify @code{login} (encoded password transmission),
761 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
762 authentication) or @code{plain} (or @code{nil}, plain password
763 transmission) as @var{authenticate-type}. (To use CRAM-MD5 or
764 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 @code{login}, @code{cram-md5} or @code{digest-md5} as
794 authentication method, the password is sent in encoded form. But, if
795 your server is unable to receive an encoded password, authentication
796 will fall back to @code{plain} (that is, sending password in raw format)
797 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
798 authentication will fall back to @code{plain} without confirmation
799 (default value is @code{nil}).
805 %inbox -> IMAP mailbox "inbox"
806 %#mh/inbox -> IMAP mailbox "#mh/inbox"
808 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
809 %inbox:hoge/login@@server1
810 -> server1's IMAP mailbox "inbox"
811 of user "hoge", with plain password authentication
816 @subsection International mailbox names (Modified UTF7)
817 @cindex Modified UTF7
823 You can use international mailbox names in @var{mailbox} part, if you
824 are using Emacs which can treat unicode and
825 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
828 Currently, following Emacsen can treat unicode.
831 @item Emacs 20.3 or later + Mule-UCS
833 If you installed Mule-UCS package, Emacs can treat unicode.
834 You can obtain Mule-UCS package from following URL.
837 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
840 @item XEmacs 21.2.13 or later + ucs-conv package
842 By default, XEmacs 21 cannot treat unicodes, but if you installed
843 ucs-conv package, it can.
844 You can obtain ucs-conv package from following anonymous CVS.
848 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
849 Password: @var{NULL} (Just enter return key)
850 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
854 You also need utf7 conversion programs, @code{u7tou8} and @code{u8tou7}
855 to use international mailbox name in the current XEmacs. These programs
856 are included in the UTF7 package which can be obtained from following
860 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
864 @node NNTP Folder, MH Folder, IMAP Folder, Folders
869 A folder to access USENET news via NNTP protocol (RFC 977).
870 One newsgroup is treated as a folder.
876 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
882 @var{hostname} -> The value of @code{elmo-default-nntp-server}.
883 Initial setting is "localhost".
884 @var{username} -> The value of @code{elmo-default-nntp-user}.
885 Initial setting is nil.
886 @var{port} -> The value of @code{elmo-default-nntp-port}.
887 Initial setting is 119.
890 AUTHINFO is used as authentication method if the @var{username} is non-nil.
891 SSL will be default method if @code{elmo-default-nntp-ssl} is non-nil even
892 if the folder name doesn't end with @samp{!}.
893 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
894 if the value of @code{elmo-default-nntp-ssl} is @code{starttls},
895 STARTTLS will be the default connection.
901 -fj.rec.tv -> Newsgroup `fj.rec.tv'.
902 -fj.rec.tv@@newsserver -> Newsgroup `fj.rec.tv' on newsserver.
906 @node MH Folder, Maildir Folder, NNTP Folder, Folders
912 A folder to access MH format mail (1 file is 1 mail).
917 @samp{+} @var{directory-name}
920 Normally, @var{directory-name} is an relative path to the variable
921 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
922 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
923 (this is also true for drive-letters).
925 Message number is used for the name of the message file.
931 +inbox -> "~/Mail/inbox"
932 +from/teranisi -> "~/Mail/from/teranisi"
937 @node Maildir Folder, News Spool Folder, MH Folder, Folders
938 @section Maildir Folder
939 @cindex Maildir Folder
943 A folder to access to Maildir format (1 file is 1 mail).
948 @samp{.} [@var{directory-name}]
951 Normally, @var{directory-name} is a relative path to the variable
952 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
953 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
954 (this is also true for drive-letters).
956 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
957 Messages are contained in the @file{cur} directory. All
958 message files in the @file{new} directory are moved to @file{cur}
959 directory when you access to the folder. All message files contained in
960 the @file{tmp} directory and not accessed for 36 hours are deleted.
962 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
969 .inbox -> "~/Maildir/inbox"
970 .from/teranisi -> "~/Maildir/from/teranisi"
976 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
977 @section News Spool Folder
978 @cindex News spool Folder
982 This folder handles locally saved news articles which are proposed by Mew/IM.
983 You can also read articles directly from a spool-file which is retrieved
984 by an utility like gnspool.
989 @samp{=} @var{directory-name}
992 @var{directory-name} is a sub-directory to the directory defined by variable
993 @code{elmo-localnews-folder-path} (default is @file{~/News})
994 You can use @samp{.} as directory delimiter as well as @samp{/}.
1000 =fj/os/os2 -> "~/News/fj/os/os2"
1001 =fj.os.bsd.freebsd -> "~/News/fj/os/bsd/freebsd"
1006 @node Archive Folder, POP Folder, News Spool Folder, Folders
1007 @section Archive Folder
1008 @cindex Archive Folder
1012 This method can handle archive files, which are compressed by utilities
1013 such as Info-ZIP or LHA, as one folder.
1019 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1023 @var{path-name} is the relative path from
1024 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1025 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1026 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1027 also permitted under the environment of ange-ftp, efs.
1029 The actual file name of the archive folder is
1030 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1031 under the @var{path-name}. If a file named @var{path-name} exists, it is
1032 treated as folder. The suffix is automatically decided for
1033 @var{archiver-type}.
1035 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1036 (Initial setting is @code{zip}) is referred.
1038 @var{prefix} specifies the internal directory structure of the archive.
1039 For example, if the ML server is fml, @file{msend.tar.gz} has a structure like
1040 @file{spool/1}, so you have to specify @samp{spool} as @var{prefix}.
1046 $teranisi -> "~/Mail/teranisi/elmo-archive.zip"
1047 $bsd/freebsd;lha -> "~/Mail/bsd/freebsd/elmo-archive.lzh"
1048 $/foo@@server:~/bar;zoo -> "~/bar/elmo-archive.zoo" on ftp server
1049 $d:/msend.tar.gz;tgz;spool -> "d:/msend.tar.gz"
1054 * Archiver:: Archivers supported
1055 * Archive Tips:: TIPS
1056 * Archive Vars:: Customization
1060 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1061 @subsection Supported Archives
1071 By default, following archives are supported.
1075 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1076 GNU TAR('tgz, 'tar) ;; read-only
1080 If your archiver can include multiple files in one archive, you have a
1081 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1082 of the candidate. TAR is supported read-only because it cannot delete
1083 file in the archive ('mv)).
1085 gzip, bzip, bzip2 cannot be used as an archiver of Wanderlust because
1086 they cannot include multiple files. Archivers that cannot extract files
1087 to standard output are also not supported.
1089 @subsection OS specific information about archiver.
1091 Behaviors of the following archivers are confirmed by further experiences.
1092 (@samp{*} mark means recommended archiver).
1095 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1096 LHA OS/2 version Rel.2.06b Feb 18, 1998
1097 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1098 *Zip 2.2 (November 3rd 1997).
1099 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1100 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1101 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1103 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1104 LHa for UNIX V 1.14c
1105 UnZip 5.32 of 3 November 1997
1106 Zip 2.2 (November 3rd 1997)
1107 GNU tar 1.12 (1.11.x is no good)
1108 gzip 1.2.4 (18 Aug 93)
1110 [Win32] Win.98/Meadow
1114 GNU tar 1.11.8 + 1.5(WIN32)
1121 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1122 Hiramatsu version of LHA is only supported.
1123 In Win32, LHa32 is only supported (DOS version is no good).
1125 * Caution about GNU tar
1127 You have to take care about GNU tar's version because
1128 many version has problem on deleting file from archive.
1130 Please test @option{--delete} @option{-f} options work. Otherwise, your
1131 archive will be destroyed. No problem is reported on above versions of
1135 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1137 @cindex Archive Tips
1139 For comfortable migration, usage of @code{wl-summary-archive}
1140 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1141 archive folders created by expiration, you must set non-nil value to
1142 @code{elmo-archive-treat-file}.
1144 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1145 in processing speed. For comfortable use, Emacs20 is recommended.
1146 (If re-search's performance is the problem, 19.3x or later may be okay.)
1148 If many files are included in one archive,
1149 it takes long time to access to the archive folder because
1150 archiver starting overhead is increased (especially LHA).
1151 150-200 messages in one archive is recommended.
1153 Of course, following is possible @t{:-)}
1154 (meanings of these variables are described later.)
1158 (setq wl-fcc "$backup")
1159 (setq wl-trash-folder "$trash;lha")
1163 @node Archive Vars, , Archive Tips, Archive Folder
1164 @subsection Variables About Archive Folder
1165 @cindex Archive variables
1168 @item elmo-archive-default-type
1169 @vindex elmo-archive-default-type
1170 The initial setting is @code{zip}.
1171 Set archiver type by symbol.
1173 @item elmo-archive-@var{type}-method-alist
1174 @vindex elmo-archive-TYPE-method-alist
1175 Define archiver @var{type}'s methods.
1176 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1177 Each element of the alist is following.
1181 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1182 (@var{action} . @var{function}) ;; function
1186 Currently available actions are following.
1190 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1191 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1198 actions enclosed with braces are optional (They are used for better
1201 @item elmo-archive-suffix-alist
1202 @vindex elmo-archive-suffix-alist
1203 An alist of archiver-type (symbol) and suffix.
1205 @item elmo-archive-file-regexp-alist
1206 @vindex elmo-archive-file-regexp-alist
1207 An alist of a regexp to get file number from list output of archiver
1208 and archiver-type (symbol).
1210 @item elmo-archive-method-list
1211 @vindex elmo-archive-method-list
1212 A list of elmo-archive-@var{type}-method-alist
1213 (@var{type} is a symbol of archiver-type).
1215 @item elmo-archive-lha-dos-compatible
1216 @vindex elmo-archive-lha-dos-compatible
1217 The initial setting is t on OS/2 and Win32.
1218 If non-nil, LHA is DOS (Mr. Yoshizaki original) compatible.
1220 @item elmo-archive-cmdstr-max-length
1221 @vindex elmo-archive-cmdstr-max-length
1222 The initial setting is 8000.
1224 Max length of command line argument for external archiver program.
1225 Emacs does not have a limit of command line byte length, but some OS
1226 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1227 this limit because it calls external archiver program directly (not
1228 called via shell). For example, you cannot delete messages if archiver
1229 program must receive larger bytes of arguments to delete. OS/2 have a
1230 command line argument limit of 8190 bytes, so we defined default as 8000
1233 However, you don't have an influence of command line argument limit
1234 if the archiver has `actions' to receive target file information from
1235 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1238 @node POP Folder, Multi Folder, Archive Folder, Folders
1246 A folder to access e-mails via POP3 protocol (RFC 1939).
1252 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1257 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1258 as @var{authenticate-type}.
1262 @var{username} -> The value of @code{elmo-default-pop3-user}.
1263 Initial setting is @env{USER} environment variable or
1264 @env{LOGNAME} environment variable or return value of
1265 @code{(user-login-name)}.
1266 @var{authenticate-type} -> The value of @code{elmo-default-pop3-authenticate-type}.
1267 Initial setting is "user".
1268 @var{hostname} -> The value of @code{elmo-default-pop3-server}.
1269 Initial setting is "localhost".
1270 @var{port} -> The value of @code{elmo-default-pop3-port}.
1271 Initial setting is 110.
1278 &hoge@@localhost -> access to localhost as user "hoge".
1279 &hoge@@popserver:109 -> access to the server "popserver" on port 109
1284 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1285 (XEmacs doesn't need @file{md5.el}).
1286 @file{md5.el} is included in @file{utils/sasl/lisp/} or Emacs/W3 package:
1289 http://www.cs.indiana.edu/elisp/w3/docs.html
1292 or LCD archive (GPL2).
1294 If the last character of the folder name is @samp{!}, Wanderlust connects to
1295 the POP server via SSL (Secure Socket Layer). If you set non-nil
1296 value to @code{elmo-default-pop-ssl}, you don't have to put @samp{!} in the
1297 end of the folder name to use SSL.
1298 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
1299 if the value of @code{elmo-default-pop-ssl} is @code{starttls},
1300 STARTTLS will be the default connection.
1302 @node Multi Folder, Filter Folder, POP Folder, Folders
1303 @section Multi Folder
1304 @cindex Multi Folder
1306 @cindex Folder, Multiple
1307 @cindex Folder, Marge
1309 A folder to access to a folder which collects messages from
1310 multiple folders virtually.
1316 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1320 After @samp{*} character, specify multiple folders you want to collect
1321 separated by ',' like
1322 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1328 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1329 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1330 treated as one folder.
1332 *+inbox,-fj.rec.tv,%inbox
1333 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1338 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1339 @section Filter Folder
1340 @cindex Filter Folder
1342 @cindex Folder, Filtering
1343 @cindex Folder, Virtual
1345 A folder to access to a folder which collects all messages that
1346 satisfy a condition virtually.
1351 @samp{/} @var{condition} @samp{/} @var{target-folder}
1354 In the @var{condition} part, you can specify following.
1358 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1360 first: @var{number} messages are picked from top of folder.
1361 last: @var{number} messages are picked from bottom of folder.
1367 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1368 /first:20/%inbox -> First 20 messages from %inbox are picked.
1373 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1375 since: only messages arrived since @var{date} are picked.
1376 before: only messages arrived before @var{date} are picked.
1378 You can specify following as @var{date}.
1382 yesterday -> a day before today.
1383 lastweek -> same day of last week.
1384 lastmonth -> same day of last month.
1385 lastyear -> same day of last year.
1386 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1387 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1395 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1397 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1403 Field filter: @samp{@var{field}:@var{value}}
1405 All messages that have @var{field} and its value is @var{value} are picked.
1406 @var{field} and @var{value} are case insensitive.
1412 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1413 and its value includes "teranisi" string are picked.
1414 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1422 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1423 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1425 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1426 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1432 /from:teranisi&!to:teranisi/+inbox
1433 -> In +inbox, messages are picked if the message's
1434 From: field includes "teranisi" and
1435 To: field doesn't include "teranisi".
1437 /tocc:"Yuuichi Teranishi"/+inbox
1438 -> In +inbox, messages are picked if the
1439 message's To: field or Cc: field includes
1440 "Yuuichi Teranishi".
1442 /(from:yt|from:teranisi)&subject:report/+inbox
1443 -> In +inbox, messages are picked if the message's
1444 From: field includes "yt" or "teranisi", and
1445 Subject includes "report".
1451 Tip for string description:
1453 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1454 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1455 should be escaped with @samp{\} in it). You can enclose the string with
1456 @samp{"} even it does not contain these characters.
1462 *%inbox,/from:teranisi/%inbox@@server
1463 -> Messages in %inbox or
1464 message is in the %inbox@@server folder and it's From field
1465 includes "teranisi" are collected.
1467 /last:100//to:teranisi/*+inbox,%inbox
1468 -> Latest 100 messages which is in the +inbox or %inbox folder
1469 and To: field matches "teranisi".
1471 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1472 -> Pick messages which have From: field and it includes "hogehoge"
1473 from latest 20 messages in the %#mh/inbox@@localhost
1474 and To: or Cc: field includes "teranisi".
1477 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1478 @section Pipe Folder
1482 @cindex Download Message
1483 @cindex Incorporate Message
1485 In the pipe folder, messages are automatically transferred from the source
1486 folder to destination folder.
1491 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1494 When you access to the pipe folder, messages are automatically transferred
1495 from @var{source-folder} to @var{destination-folder}.
1496 It is convenient if you want to download messages to local disk via POP.
1497 For example, if you specify following
1500 |&username@@popserver|+inbox
1503 and access to it, messages are downloaded automatically from
1504 &username@@popserver to @samp{+inbox}.
1510 %inbox|%myinbox -> Download %inbox to %myinbox.
1511 *&user@@popserver1,&user@@popserver2|+inbox
1512 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1516 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1518 @node Internal Folder, , Pipe Folder, Folders
1519 @section Internal folder
1520 @cindex Internal Folder
1522 @cindex Folder, @samp{$} mark
1524 A folder to access to internal messages of Wanderlust.
1536 A folder named @samp{'mark} is a special virtual folder which collects
1537 messages which have important mark @samp{$}.
1539 You can review important messages at once after you put important marks
1540 on the messages in the different folders.
1542 In this folder, if you delete message, important mark @samp{$} put on
1543 the message is removed. If you append messages to this folder, the
1544 message will have @samp{$} mark.
1546 You can access to the cached messages fetched via network by accessing
1547 to the folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1548 the name of the subdirectories of the cache directory
1549 (@file{~/.elmo/cache}).
1552 @node Folder, Summary, Folders, Top
1553 @chapter Folder mode
1556 After you start Wanderlust, folder mode is appeared firstly.
1557 It contains folder list you subscribed.
1558 You can select and edit folders in this mode.
1561 * Selecting Folder:: Select folder you want to read.
1562 * Folder Manager:: Editing folders.
1566 @node Selecting Folder, Folder Manager, Folder, Folder
1567 @section Selecting Folder
1568 @cindex Selecting Folder
1570 @subsection Usage (TIPS)
1572 @subsubsection Check new, unread number
1574 Folder mode looks like this.
1575 (In XEmacs, it looks much nicer @t{;-)})
1579 [-]Desktop:14186/35580/67263
1584 [-]Emacsen:0/34/4837
1585 Wanderlust ML:0/0/558
1588 XEmacs Beta:0/29/255
1599 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1603 @kbd{s} key on the folder line updates these numbers.
1604 It changes its color if it has many new messages.
1606 The whole folder mode is a folder group named @samp{Desktop}.
1607 Folder group open/close by return key.
1608 A operation to a folder group is treated as operations on the
1610 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1611 six children folders update its unread number status.
1613 @subsubsection Select Folder
1615 To enter summary mode of the folder, type return (or space) key on
1617 If the variable @code{wl-stay-folder-window} has non-nil value,
1618 summary window appears on the right of the folder mode window.
1620 @subsection Key bindings
1622 Folder mode's key binding (related to selecting folders) is following.
1627 @kindex @key{SPC} (Folder)
1628 @kindex @key{RET} (Folder)
1629 @findex wl-folder-jump-to-current-entity
1630 Enter to the summary mode of the folder at the current cursor point.
1631 If the cursor is on the top of folder group line,
1632 the folder group is opened or closed.
1633 When the cursor is on the access group and this command is called
1634 with prefix argument, folder children list is updated to the newest one.
1635 (Children list is updated recursively if the access folder has hierarchical
1637 (@code{wl-folder-jump-to-current-entity})
1640 @kindex M-@key{RET} (Folder)
1641 @findex wl-folder-update-recursive-current-entity
1642 Folder children list of the access group at the current cursor point
1643 is updated to the newest one.
1644 (Children list is updated recursively if the access folder has hierarchical
1646 (@code{wl-folder-update-recursive-current-entity})
1651 Create a new draft message.
1656 @findex wl-folder-write-current-newsgroup
1657 If the current cursor point is on the NNTP folder,
1658 create a new draft message which already has newsgroups field.
1659 (@code{wl-folder-write-current-newsgroup})
1662 @kindex C-c C-o (Folder)
1663 @findex wl-jump-to-draft-buffer
1664 Move to the draft buffer if available. If multiple draft buffer exists,
1665 moved to one after another. If prefix argument is specified, load draft
1666 folder's message to the draft buffer and jump to it.
1667 (@code{wl-jump-to-draft-buffer})
1671 @findex wl-folder-check-current-entity
1672 Update new and unread number information of the folder at the current
1674 (@code{wl-folder-check-current-entity})
1678 @findex wl-folder-sync-current-entity
1679 Update summary information of the folder at the current cursor point.
1680 (@code{wl-folder-sync-current-entity})
1683 @kindex r s (Folder)
1684 @findex wl-folder-check-region
1685 Update new and unread number information of the folders in the currently
1687 (@code{wl-folder-check-region})
1690 @kindex r S (Folder)
1691 @findex wl-folder-sync-region
1692 Update summary information of the folders in the currently selected region.
1693 (@code{wl-folder-sync-region})
1697 @findex wl-status-update
1698 Sync up address book status with @file{~/.addresses}'s content.
1699 (@code{wl-status-update})
1703 @findex wl-folder-prev-unread
1704 Jump cursor to the folder which have unread messages on the upward from
1705 current cursor point.
1706 (@code{wl-folder-prev-unread})
1710 Jump cursor to the folder which have unread messages on the downward
1711 from current cursor point.
1712 (@code{wl-folder-next-unread})
1716 Move cursor to the folder on the previous line.
1717 (@code{wl-folder-prev-entity})
1721 Move cursor to the folder on the next line.
1722 (@code{wl-folder-next-entity})
1726 Jump to the folder specified by the user input.
1727 (@code{wl-folder-jump-folder})
1731 @findex wl-folder-prefetch-current-entity
1732 Prefetch new messages of the folder at the current cursor point by
1733 @code{wl-summary-incorporate}.
1734 If the cursor is on the folder group, it is executed recursively.
1735 (@code{wl-folder-prefetch-current-entity})
1739 @findex wl-folder-mark-as-read-all-current-entity
1740 Mark all unread messages of the folder at the current cursor point as read.
1741 If the cursor is on the folder group, it is executed recursively.
1742 (@code{wl-folder-mark-as-read-all-current-entity})
1746 @findex wl-folder-goto-first-unread-folder
1747 Enter summary mode of the first unread folder.
1748 (@code{wl-folder-goto-first-unread-folder})
1752 @findex wl-folder-empty-trash
1754 (@code{wl-folder-empty-trash})
1758 @findex wl-folder-open-all-unread-folder
1759 All unread folder is opened.
1760 (@code{wl-folder-open-all-unread-folder})
1764 @findex wl-folder-open-close
1765 Folder group is opened/closed.
1766 (@code{wl-thread-open-close})
1770 All folder group is opened.
1771 (@code{wl-folder-open-all})
1775 All folder group is closed.
1776 (@code{wl-folder-close-all})
1786 (@code{wl-folder-suspend})
1789 @kindex M-s (Folder)
1790 Save current folder status.
1794 @kindex M-t (Folder)
1795 Toggle Wanderlust's offline/online status.
1796 (@code{wl-toggle-plugged})
1799 @kindex C-t (Folder)
1800 Start Wanderlust's plug-status manager.
1801 (@code{wl-plugged-change})
1804 @subsection Customize variables
1807 @item wl-folders-file
1808 @vindex wl-folders-file
1809 The initial setting is @file{~/.folders}.
1810 Subscribed folders are described (saved) in this file.
1812 @item wl-folder-info-save
1813 @vindex wl-folder-info-save
1814 The initial setting is @code{t}. If non-nil, unread information is
1815 saved and used in the next Wanderlust session.
1817 @item wl-stay-folder-window
1818 @vindex wl-stay-folder-window
1819 The initial setting is @code{nil}.
1820 If non-nil, summary window is appeared on the right side of the folder buffer.
1822 @item wl-folder-window-width
1823 @vindex wl-folder-window-width
1824 The initial setting is 20.
1825 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1827 @item wl-folder-many-unsync-threshold
1828 @vindex wl-folder-many-unsync-threshold
1829 The initial setting is 70.
1830 If the number of unread messages is more than this value,
1831 folder color is changed.
1833 @item wl-highlight-folder-by-numbers
1834 @vindex wl-highlight-folder-by-numbers
1835 This option controls how to highlight each line in the folder buffer.
1836 The default value is @code{t}, highlighting with various colors based on
1837 the message numbers. If it is @code{nil}, highlighting with various
1838 colors based on the folder status. In addition, if it is a number
1839 (e.g. 1), highlighting will be done based on both the message numbers
1840 and the folder status.
1842 @item wl-folder-desktop-name
1843 @vindex wl-folder-desktop-name
1844 The initial setting is @samp{Desktop}.
1845 The name of top folder group.
1847 @item wl-folder-petname-alist
1848 @vindex wl-folder-petname-alist
1849 The initial setting is @code{nil}.
1850 An alist of folder's realname and its nickname.
1852 @item wl-folder-access-subscribe-alist
1853 @vindex wl-folder-access-subscribe-alist
1854 The initial setting is @code{nil}.
1856 Control automatic subscribing and unsubscribing of the children list
1862 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1866 If @var{subscribe-flag} is non-nil, folders which have name matched to
1867 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1868 already unsubscribed folder is not displayed even when the
1869 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1876 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1877 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1878 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1879 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1883 @item wl-folder-hierarchy-access-folders
1884 @vindex wl-folder-hierarchy-access-folders
1885 The initial setting is the list shown below:
1894 A list of access groups which creates children folder list hierarchically.
1896 For example, if you specify
1897 @code{wl-folder-hierarchy-access-folders} like following,
1901 (setq wl-folder-hierarchy-access-folders
1902 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1907 such access group hierarchy is obtained.
1913 -fj.comp.announce:0/0/2
1914 -fj.comp.dev.cdrom:0/0/0
1916 [+]-japan:238/238/1688
1919 -comp.unix.admin:0/0/0
1920 -comp.unix.dos-under-unix:0/0/0
1921 -comp.unix.programmer:0/0/0
1922 [-]-comp.unix.bsd:0/0/23
1923 -comp.unix.bsd.freebsd.announce:0/0/0
1928 If you opened @samp{-} in this example, only the direct children is created
1929 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1930 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1931 is not created until the children access group is opened.
1935 @node Folder Manager, , Selecting Folder, Folder
1936 @section Editing Folders
1937 @cindex Folder Manager
1938 @cindex Folder, Edit
1939 @cindex Folder, Subscribe
1940 @cindex Folder, Unsubscribe
1942 As described before, subscribed folder list is saved in @file{~/.folders} file.
1943 But you don't have to edit @file{~/.folders} directly.
1944 You can append, delete, edit folders from folder mode.
1946 @subsection Usage (Tips)
1948 @subsubsection Append Folder
1950 @kbd{m a} appends new folder to the folder mode.
1951 @kbd{m g} appends new folder group.
1952 To append new folder to this group, firstly open it,
1953 then execute append command in the next line.
1955 @subsubsection Edit Folder
1957 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1958 Thus, you can change folder position as if you were editing a normal file.
1960 @subsubsection Create Multi Folder.
1964 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
1966 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
1968 Type @kbd{m m}, then you can create multi folder.
1971 @subsubsection Delete Nickname, Filter
1973 You can delete nickname or filter by putting ``''(@var{NULL}) from the
1974 minibuffer while appending.
1976 @subsubsection Append Folder to Empty Group
1978 To append new folder to the empty folder group
1979 (after you create folder group by typing @kbd{m g}),
1980 firstly open it, then execute append command in the next line.
1981 If it is closed, folder is appended on the same level with
1982 the above folder group. It is difficult to explain by words so try it.
1983 In other words, appended position depends on the
1984 above folder group's open/close status.
1986 @subsubsection Charset of the Folders File.
1988 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
1990 @subsubsection Create Filter
1992 @kbd{m f} adds filter to the folder at the current cursor point. To
1993 create new filter folder and leave the current folder unchanged, copy it
1994 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
1995 filter can be specified while appending filter. If you put
1996 ``''(@var{NULL}), filter is deleted.
1998 @subsubsection Sort Folders
2000 Sorting of the folders is executed by the function specified by
2001 @code{wl-fldmgr-sort-func}.
2002 The initial setting is @code{wl-fldmgr-sort-standard},
2003 which sorts alphabetically.
2004 Sorting affects only on the current folder group. It does not
2005 affect on the child groups.
2007 @subsubsection Hiding Folders in the Access Group
2009 Usually, access group displays all children folders, but you can set
2010 some folders hidden. Following operations are only available on access
2013 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2014 (subscribe/unsubscribe) of the folder at current cursor point. Against
2015 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2018 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2019 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2020 argument and if the argument has positive number, the unsubscribe it.
2021 If the prefix argument has negative value, folder becomes visible and if
2022 zero, folder visibility is toggled.
2024 The other commands, @code{wl-fldmgr-subscribe} and
2025 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2028 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2029 executed in the access group, they have a same effect with
2030 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2031 The difference is that cut(-region) commands deletes folders from the
2034 @subsubsection Operations in the Access Group
2036 You can insert and delete folders in the access group like usual folder
2037 group. But insert and delete commands can be only available for the
2038 children folders of the access group and they only sets the subscribe
2039 status. In other words, insertion of the folder means subscribing,
2040 deletion means unsubscribing.
2041 @footnote{In the current implementation,
2042 it is faster to delete region than to unsubscribe region.}
2044 To update the access group when children folders are inserted or deleted
2045 by other way (other than Wanderlust),
2046 open the access group by typing @kbd{C-u @key{RET}}.
2047 @xref{Selecting Folder}.
2049 The order of children folders of access group is saved after
2050 insertion/deletion/sorting.
2051 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2052 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2053 newly created folders are inserted on the top of the access group.
2055 @subsection Key bindings
2056 @cindex Keybind, Folder Mode
2057 @cindex Keybind, Folder Buffer
2059 Key bindings on the folder mode related to folder editing are shown below.
2060 All bindings starts with @kbd{m}, and primary commands are binded to
2061 one stroke key binding.
2065 @kindex m a (Folder)
2066 @findex wl-fldmgr-add
2068 (@code{wl-fldmgr-add})
2073 @kindex m g (Folder)
2074 @findex wl-fldmgr-make-group
2075 Create a folder group.
2076 (@code{wl-fldmgr-make-group})
2079 @kindex m A (Folder)
2080 @findex wl-fldmgr-make-access-group
2081 Create an access group.
2082 (@code{wl-fldmgr-make-access-group})
2085 @kindex m d (Folder)
2086 @findex wl-fldmgr-delete
2087 Delete folder itself and msgdb.
2088 If the folder itself cannot be deleted like NNTP folder,
2089 only msgdb is deleted.
2090 (@code{wl-fldmgr-delete})
2095 @kindex m R (Folder)
2096 @findex wl-fldmgr-rename
2097 Change the name of folder or folder group.
2098 msgdb's path is also changed.
2099 (@code{wl-fldmgr-rename})
2105 @findex wl-fldmgr-make-multi
2106 Create a multi folders in the cutlist (cut, copied folders).
2107 (@code{wl-fldmgr-make-multi})
2112 @kindex m f (Folder)
2113 @findex wl-fldmgr-make-filter
2114 Create a filter folder. (Put a filter on the folder).
2115 (@code{wl-fldmgr-make-filter})
2119 @kindex M-c (Folder)
2120 @kindex m c (Folder)
2121 @findex wl-fldmgr-copy
2122 Copy folder (it is not available on folder group).
2123 (@code{wl-fldmgr-copy})
2127 @kindex M-w (Folder)
2128 @kindex m W (Folder)
2129 @findex wl-fldmgr-copy-region
2130 Copy folders in the specified region.
2131 (@code{wl-fldmgr-copy-region})
2135 @kindex C-k (Folder)
2136 @kindex m k (Folder)
2137 @findex wl-fldmgr-cut
2138 Cut folder. Folder itself is not deleted.
2139 (@code{wl-fldmgr-cut})
2143 @kindex C-w (Folder)
2144 @kindex m C-w (Folder)
2145 @findex wl-fldmgr-cut-region
2146 Cut folders in the specified region.
2147 (@code{wl-fldmgr-cut-region})
2151 @kindex C-y (Folder)
2152 @kindex m y (Folder)
2153 @findex wl-fldmgr-yank
2154 Paste folders that are copied or cut (folders in the cut-list).
2155 (@code{wl-fldmgr-yank})
2158 @kindex m p (Folder)
2159 @findex wl-fldmgr-set-petname
2160 Put nickname on the folder.
2161 (@code{wl-fldmgr-set-petname})
2164 @kindex m q (Folder)
2165 @findex wl-fldmgr-clear-cut-entity-list
2166 Clear the cut-list. (cut, copied folder information is cleared,
2167 you cannot paste after this)
2168 (@code{wl-fldmgr-clear-cut-entity-list})
2171 @kindex m s (Folder)
2172 @findex wl-fldmgr-sort
2173 Sort folders in the current folder group.
2174 (@code{wl-fldmgr-sort})
2177 @kindex m C-s (Folder)
2178 @findex wl-fldmgr-save
2179 Save current folder view to the @file{wl-folders-file}.
2180 (@code{wl-fldmgr-save})
2183 [Following commands are only available on the access groups]
2189 @kindex m u (Folder)
2190 @findex wl-fldmgr-unsubscribe
2191 Set the visibility of folder (subscribe/unsubscribe).
2192 (@code{wl-fldmgr-unsubscribe})
2197 @kindex r u (Folder)
2198 @findex wl-fldmgr-unsubscribe-region
2199 Set the visibility of the folders (subscribe/unsubscribe) in the
2201 (@code{wl-fldmgr-unsubscribe-region})
2206 @kindex m l (Folder)
2207 @findex wl-fldmgr-access-display-normal
2208 List folders that are currently available.
2209 (@code{wl-fldmgr-access-display-normal})
2214 @kindex m L (Folder)
2215 @findex wl-fldmgr-access-display-all
2216 List all folders regardless of the subscription status.
2217 (@code{wl-fldmgr-access-display-all})
2221 @subsection Customize variables
2224 @item wl-interactive-save-folders
2225 @vindex wl-interactive-save-folders
2226 The initial setting is @code{t}. If non-nil and folder view is
2227 modified, confirm saving it before Wanderlust or Emacs exits. If
2228 @code{nil}, save without confirmation.
2230 @item wl-fldmgr-make-backup
2231 @vindex wl-fldmgr-make-backup
2232 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2233 created before saving the folder status.
2235 @item wl-fldmgr-sort-func
2236 @vindex wl-fldmgr-sort-func
2237 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2238 sort folders. By default function, folders are sorted alphabetically
2239 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2242 @item wl-fldmgr-sort-group-first
2243 @vindex wl-fldmgr-sort-group-first
2244 The initial setting is @code{t}. If non-nil,
2245 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2246 does not care whether it is folder group or not.
2248 @item wl-folder-check-async
2249 @vindex wl-folder-check-async
2250 The initial setting is @code{t}. If non-nil, check folder's unread
2251 status asynchronously. It boosts newsgroup checking.
2253 @item wl-folder-check-fast
2254 @vindex wl-folder-check-fast
2255 The initial setting is @code{nil}.
2256 If non-nil, it does not update folder status while checking.
2258 @item wl-folder-notify-deleted
2259 @vindex wl-folder-notify-deleted
2260 The initial setting is @code{nil}.
2262 If non-nil, negative value is displayed when the message is deleted. If
2263 @code{sync}, folder is synchronized when the message is deleted. If
2264 @code{nil}, message deletion is ignored.
2267 @subsection Miscellanea
2269 Following is a note for folder editing.
2273 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2274 paste(yank) command pastes the folders on one cut or copy command
2275 (If copy command is executed by region, folders in the region are pasted
2276 by one paste command)
2279 You cannot cut @samp{Desktop} group.
2280 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2283 You cannot copy folder group.
2286 Operations on the access group are only available for the folders
2287 in the same access group.
2290 You cannot create a folder which has same name with the folders already exist.
2293 You cannot insert folders which have same name in one group.
2294 You can insert them in the different groups.
2295 You cannot put same nickname to the different folders.
2299 @node Summary, Message, Folder, Top
2300 @chapter Summary Mode
2302 After you select the folder via folder mode, you enter to the summary
2306 * Usage of Summary Mode:: TIPS.
2307 * Thread Oparations:: Thread oparations.
2308 * Cache:: File cache, Buffer cache, and Prefetch.
2309 * Auto Refile:: Auto refile settings.
2310 * Sticky Summary:: Summary make sticky.
2311 * Key Bindings of Summary:: Key bindings.
2312 * Variables of Summary:: Customize Summary Mode.
2316 @node Usage of Summary Mode, Thread Oparations, Summary, Summary
2317 @section Usage (Tips)
2319 @subsection Summary Content
2321 In the summary mode, messages are displayed like following.
2325 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2326 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2327 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2328 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2335 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2339 You cannot change this in the current version.
2341 @var{Message number} is the message's unique number in the folder. In
2342 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2343 in the MH folder, it is the filename of the message.
2345 @var{Temporal mark} and @var{Persistent mark} are described later.
2347 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2348 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2349 Japanese, but if you want to display it in English, set the value of
2350 @code{wl-summary-weekday-name-lang} as @samp{en}.
2352 @var{Sender}'s indentation corresponds to the depth of the thread.
2353 Sender name is displayed as nickname if it is defined in the address
2354 book. Set @code{wl-use-petname} as @samp{nil}, if you want to quit
2355 displaying with nickname.
2357 If number is printed at the head of @var{Sender} part like @samp{+2},
2358 that means the message have 2 follow messages.
2360 @var{Subject} is the @samp{Subject:} header field of the message. If
2361 the message have same @samp{Subject:} with the parent message, it is not
2362 displayed. Some mailing list puts its sequence number in the
2363 @samp{Subject:} field, but it is
2364 ignored. @code{wl-summary-no-subject-message} is displayed when the
2365 message has empty subject field.
2367 @subsection Temporary Marks
2368 @cindex Mark, Temporary
2370 There are four temporary marks,
2371 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2372 Temporary marks indicates message operations.
2377 You can execute a command on the all messages that have @samp{*} mark,
2378 with the key bindings which begins with @kbd{m}.
2381 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2385 After you type @kbd{o} key, prompt appears to input refile destination.
2386 Your answer is printed in the summary line.
2390 You can put this mark by typing @kbd{O} key.
2391 The difference between this mark and refile mark is,
2392 this mark does not delete the message while latter does.
2395 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2397 @subsection Persistent Marks
2399 There are five persistent marks,
2400 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2402 The persistent mark indicates the message's status and it is saved.
2403 Each persistent mark indicates:
2409 It is unread message.
2411 It is unread but cached message.
2413 It is read but it is not cached.
2415 It is important message. You can put @samp{$} mark by typing @kbd{$}
2416 key (if already exists, the mark is deleted). It is convenient to put
2417 this mark on the messages to remember (If you want to remember to write
2418 a reply for the message, for example) because this mark remains after
2419 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2420 even the message itself is deleted in the actual folder.
2423 If the message is read and cached (or local message),there are no
2427 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2428 cache. Messages with the marks other than these, you can read them in
2429 the offline status even they are in the IMAP folder or netnews folder.
2431 @subsection How To Read
2433 Basically, you can read messages only typing space key again and again.
2435 To update summary status to the newest status (synchronize),
2438 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2439 moves cursor to the next message.
2440 Enter message buffer by typing @kbd{j} key.
2441 To operate multipart, you have to enter to the message buffer.
2445 @node Thread Oparations, Cache, Usage of Summary Mode, Summary
2446 @section Thread Operations
2448 For example, the following line indicates one thread (a context of a topic).
2451 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2455 If you type @kbd{/} on this line, the thread is opened and it changes
2456 the appearance like following.
2460 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2461 388 09/17(Thu)22:34 +-[ Murata san ]
2465 (Message 388 is the replied message to the message 384.)
2466 If you type @kbd{/} key once again, the thread is closed.
2467 With prefix argument, @kbd{/} opens all children threads.
2469 Commands with the key binding that begins with @kbd{t} executes commands
2470 on the messages in the thread.
2473 @node Cache, Auto Refile, Thread Oparations, Summary
2476 @subsection Cache File
2478 The messages which have to access via network (e.x. IMAP, NNTP folder)
2479 are cached as a local file. The cache file is saved under the directory
2480 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2481 elmo-cache-expire-by-size}. The command deletes cache files to the
2482 specified size by the order of last accessed time.
2484 @subsection Buffer Cache and Prefetching
2486 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2487 that are read are kept in the cache buffer. It is called `buffer
2488 cache'. The number of cache buffer is specified by
2489 @code{elmo-buffer-cache-size}.
2491 There are message prefetching mechanism in the Wanderlust that
2492 prefetches next message while you are reading. This function requires
2493 that the value of @code{elmo-use-buffer-cache} is non-nil.
2495 You can control the message prefetching mechanism by these two
2499 @item wl-cache-prefetch-folder-type-list
2500 @vindex wl-cache-prefetch-folder-type-list
2501 The initial setting is the list shown below:
2509 It specifies the folder types in which message prefetching is enabled.
2510 In the initial setting, multi folder that contains localdir and imap4
2511 prefetches only imap4 messages. This variable precedes the value of
2512 @code{wl-cache-prefetch-folder-list}.
2514 If you want to prefetch localdir and localnews also, following setting
2519 (setq wl-cache-prefetch-folder-type-list
2520 '(nntp imap4 localdir localnews))
2524 @item wl-cache-prefetch-folder-list
2525 @vindex wl-cache-prefetch-folder-list
2526 The initial setting is @code{nil}.
2527 A list of regexp of folders to enable message prefetching.
2531 @node Auto Refile, Sticky Summary, Cache, Summary
2532 @section Auto Refile
2533 @vindex elmo-msgdb-extra-fields
2534 @vindex wl-refile-rule-alist
2535 @findex wl-summary-auto-refile
2537 You can refile messages automatically, by typing @kbd{C-o}
2538 (@code{wl-summary-auto-refile}). It decides destination of refile by
2539 the content of the message header information (information in the msgdb).
2541 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2542 available. If you want to decide destination by other header fields,
2543 set the variable @code{elmo-msgdb-extra-fields} like following.
2547 (setq elmo-msgdb-extra-fields
2557 By this setting, Wanderlust saves extra fields in the msgdb. You have
2558 to type @kbd{s all} to get extra fields for the messages that are
2559 already exists in the summary.
2561 Then, specify the refile rule. The refile target folder of auto
2562 refiling is decided by the value of @code{wl-refile-rule-alist}.
2563 @code{wl-refile-rule-alist} is a list of a rule:
2567 (@var{field} (@var{regexp} . @var{target})
2568 (@var{regexp} . @var{target})
2573 Each rule means `if @var{field} value matches @var{regexp},
2574 then refile to @var{target} folder'.
2575 The rule matched first is applied.
2577 @var{field} is a string of field name. You can specify a list of field name
2578 string, too. In this case, if one of these fields is matched, then the
2579 rule is fired (i.e. OR condition).
2581 @var{regexp} is a regular expression for field value. @var{target} is a target
2582 folder string. You can specify a rule at @var{target} part, too. In this
2583 case, If the field value of the rule and the current rule is matched,
2584 then the current rule is fired (i.e. AND condition).
2586 In @var{target} part, you can refer matched substring of @var{regexp}.
2587 To refer substring, specify following in @var{target}:
2591 means substitute original matched text.
2594 means substitute what matched the @var{N}th `\(@dots{}\)'.
2595 (@var{N} is a number.)
2598 Following is an example of @code{wl-refile-rule-alist}.
2602 (setq wl-refile-rule-alist
2604 ("^Wanderlust" . "+wl")
2605 ("^Elisp" . "+elisp"))
2607 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2609 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2610 "+from-me-to-you"))))))
2614 After these settings, refile marks are automatically put on the condition
2615 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2617 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2619 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2620 with these persistent marks are not automatically refiled.
2621 It means Wanderlust does not execute auto refile on unread messages by
2622 the default setting.
2623 To execute auto refile on all messages, set following.
2626 (setq wl-summary-auto-refile-skip-marks nil)
2630 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2631 @section Sticky Summary
2632 @cindex Summary, Sticky
2633 @cindex Sticky Summary
2635 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2637 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2638 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2640 The buffer name of the sticky summary becomes like
2641 @samp{Summary:@var{folder-name}}.
2643 You can visit the sticky summary at any time by @kbd{C-x b}
2644 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2645 q}. Other operations in the sticky summary are same as normal summary.
2647 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2648 are automatically sticked.
2651 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2652 @section Key bindings
2653 @cindex Keybind, Summary Mode
2654 @cindex Keybind, Summary Buffer
2656 Key bindings of the summary mode are shown below.
2660 @kindex @key{SPC} (Summary)
2661 @findex wl-summary-read
2662 Proceed reading a message at the current cursor point.
2663 (@code{wl-summary-read})
2667 @findex wl-summary-redisplay
2668 Redisplay a message at the current cursor point.
2669 If this command is called with prefix argument,
2670 Redisplay message regardless of the message cache (message is re-loaded
2672 (@code{wl-summary-redisplay})
2676 @findex wl-summary-display-top
2677 Display the top message in the folder.
2678 (@code{wl-summary-display-top})
2682 @findex wl-summary-display-bottom
2683 Display the bottom message in the folder.
2684 (@code{wl-summary-display-bottom})
2688 @kindex @key{BS} (Summary)
2689 @kindex @key{DEL} (Summary)
2690 Display the previous page of the message at the current cursor point.
2691 @findex wl-summary-prev-page
2692 (@code{wl-summary-prev-page})
2695 @kindex @key{RET} (Summary)
2696 @findex wl-summary-next-line-content
2697 Display the next line of the message at the current cursor point.
2698 Display the message at the current cursor point if it is not displayed yet.
2699 (@code{wl-summary-next-line-content})
2704 @kindex M-@key{RET} (Summary)
2705 @findex wl-summary-prev-line-content
2706 Display the previous line of the message at the current cursor point.
2707 Display the message at the current cursor point if it is not displayed yet.
2708 (@code{wl-summary-prev-line-content})
2712 @findex wl-thread-open-close
2713 Toggle open or close the thread at the current cursor point.
2714 (@code{wl-thread-open-close})
2719 @findex wl-thread-open-all
2720 (@code{wl-thread-open-all})
2725 @findex wl-thread-close-all
2726 (@code{wl-thread-close-all})
2730 @findex wl-summary-goto-folder
2732 (@code{wl-summary-goto-folder})
2736 Mark all messages in the folder as read.
2737 @findex wl-summary-mark-as-read-all
2738 (@code{wl-summary-mark-as-read-all})
2742 @findex wl-summary-reply
2743 Prepare a draft for reply the message at the current cursor point.
2744 (@code{wl-summary-reply})
2748 @findex wl-summary-reply-with-citation
2749 Prepare a draft for reply the message at the current cursor point.
2750 (@code{wl-summary-reply-with-citation})
2754 @findex wl-summary-cancel-message
2755 If the message at current cursor point is your own netnews article,
2757 (@code{wl-summary-cancel-message})
2761 @findex wl-summary-reedit
2762 Prepare a draft for re-editing the message at current cursor point.
2763 If the message at current cursor point is your own netnews article,
2764 a draft for `supersedes message' for the message is prepared.
2765 (@code{wl-summary-reedit})
2768 @kindex M-e (Summary)
2769 @findex wl-summary-resend-bounced-mail
2770 If the message at current cursor point is a bounced message,
2771 a draft for re-sending original message is prepared.
2772 (@code{wl-summary-resend-bounced-mail})
2776 @findex wl-summary-forward
2777 A draft for forwarding the message at current cursor point is prepared.
2778 (@code{wl-summary-forward})
2782 @findex wl-summary-mark-as-important
2783 Put @samp{$} mark on the message at current cursor point.
2784 If already marked as @samp{$}, delete it.
2785 (@code{wl-summary-mark-as-important})
2791 Save the message at current cursor point.
2792 @findex wl-summary-save
2793 (@code{wl-summary-save})
2797 @findex wl-summary-next
2798 Move cursor to the next message.
2799 If message is marked with a temporal mark in
2800 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2801 In the offline mode, cursor is not moved to the messages which are not cached
2803 (@code{wl-summary-next})
2807 @findex wl-summary-prev
2808 Move cursor to the previous message.
2809 If message is marked with a temporal mark in
2810 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2811 In the offline mode, cursor is not moved to the messages which are not cached
2813 (@code{wl-summary-prev})
2817 @findex wl-summary-down
2818 Move cursor to the downward message which is unread or marked
2820 (@code{wl-summary-down})
2824 @findex wl-summary-up
2825 Move cursor to the upward message which is unread or marked
2827 (@code{wl-summary-up})
2831 @findex wl-summary-write
2832 Prepare a new draft.
2833 (@code{wl-summary-write})
2837 @findex wl-summary-write-current-newsgroup
2838 Prepare a new draft. If the current folder is netnews folder,
2839 @samp{Newsgroups:} field is completed.
2840 (@code{wl-summary-write-current-newsgroup})
2844 @findex wl-summary-redisplay-all-header
2845 Redisplay the message at current cursor point with all header fields.
2846 (@code{wl-summary-redisplay-all-header})
2850 @findex wl-summary-redisplay-no-mime
2851 Redisplay the message at current cursor point without MIME analysis.
2852 (@code{wl-summary-redisplay-no-mime})
2856 @findex wl-summary-burst
2857 If the message at current cursor point has
2858 encapsulates multiple messages using MIME,
2859 de-capsulate and extract them on the current folder.
2860 (@code{wl-summary-burst})
2863 @kindex @@ (Summary)
2864 @findex wl-summary-edit-addresses
2865 Append/change/delete the message's sender information to the address
2866 book @file{~/.addresses} interactively. If this command is called with
2867 prefix argument, arbitrary address can be edited.
2868 (@code{wl-summary-edit-petname})
2872 @findex wl-status-update
2873 Sync up address book status with @file{~/.addresses}'s content.
2874 (@code{wl-status-update})
2878 @findex wl-summary-pipe-message
2879 Pipe current message's content to the external process.
2880 (@code{wl-summary-pipe-message})
2884 @findex wl-summary-print-message
2885 Print out current message's content.
2886 It uses @code{ps-print} module in Emacs 20.x.
2887 If you don't use color printer, you might want to set
2888 @code{wl-ps-print-buffer-func} to @code{ps-print-buffer}.
2891 (setq wl-ps-print-buffer-func 'ps-print-buffer)
2894 (@code{wl-summary-print-message})
2898 @findex wl-summary-exit
2899 Exit current folder.
2900 (@code{wl-summary-exit})
2904 @findex wl-summary-jump-to-current-message
2905 Jump cursor to the currently displayed message's window.
2906 (@code{wl-summary-jump-to-current-message})
2910 Jump cursor to the other message.
2911 @findex wl-summary-jump-to-msg
2912 (@code{wl-summary-jump-to-msg})
2916 Update summary status and
2917 prefetch all messages which have marks included in the
2918 @code{wl-summary-incorporate-marks}.
2919 @findex wl-summary-incorporate
2920 (@code{wl-summary-incorporate})
2923 @kindex M-j (Summary)
2924 @findex wl-summary-jump-to-msg-by-message-id
2925 Jump cursor to the message which have specified @samp{Message-Id:}. If
2926 @code{elmo-use-database} is non-nil, other folder is also searched.
2927 (@code{wl-summary-jump-to-msg-by-message-id})
2931 Jump to parent message.
2932 @findex wl-summary-jump-to-parent-message
2933 (@code{wl-summary-jump-to-parent-message})
2937 @findex wl-summary-mark-as-unread
2938 Mark as unread the message at current cursor point.
2939 (@code{wl-summary-mark-as-unread})
2943 @findex wl-summary-sync
2944 Synchronize summary view after prompting the update range
2945 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
2949 all ...Discard current summary and update all message.
2950 update ...Update the difference between summary and the folder itself.
2951 rescan ...Rescan the msgdb and display again.
2952 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2953 first, last ...Move to the filter folder(partial filter).
2958 (@code{wl-summary-sync})
2962 @findex wl-summary-sort
2964 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
2965 (@code{wl-summary-sort})
2969 @findex wl-summary-toggle-thread
2970 Toggle the threading.
2971 Threading status is displayed on the modeline.
2972 @samp{@{S@}} means threading is off (Sequence) and
2973 @samp{@{T@}} means threading is on (Thread).
2974 (@code{wl-summary-toggle-thread})
2978 @findex wl-summary-toggle-disp-folder
2979 Toggle displaying of folder window.
2980 (@code{wl-summary-toggle-disp-folder})
2984 Toggle displaying of message window.
2985 @findex wl-summary-toggle-disp-msg
2986 (@code{wl-summary-toggle-disp-msg})
2990 Move to the virtual folder with the condition specified.
2991 If called with prefix argument and current folder is virtual, exit it.
2992 @findex wl-summary-virtual
2993 (@code{wl-summary-virtual})
2996 @kindex @key{TAB} (Summary)
2997 @findex wl-summary-goto-last-displayed-msg
2998 Jump to the message which is displayed last.
2999 (@code{wl-summary-goto-last-displayed-msg})
3003 Put @samp{*} mark on the messages that satisfies the specified condition.
3004 @findex wl-summary-pick
3005 (@code{wl-summary-pick})
3009 @findex wl-summary-mark-as-read
3010 Mark as read the message at the current cursor point.
3011 (@code{wl-summary-mark-as-read})
3015 Prefetch the message at the current cursor point.
3016 With prefix argument, prefetch the message even if it is cached.
3017 @findex wl-summary-prefetch
3018 (@code{wl-summary-prefetch})
3022 Execute @samp{D}, @samp{o} and @samp{O} marks.
3023 @findex wl-summary-exec
3024 (@code{wl-summary-exec})
3028 @findex wl-summary-target-mark-line
3029 Put target mark on the message at the current cursor point.
3030 (@code{wl-summary-target-mark-line})
3034 Put refile mark on the message at the current cursor point.
3035 @findex wl-summary-refile
3036 (@code{wl-summary-refile})
3039 @kindex C-o (Summary)
3040 Execute auto refile.
3041 @findex wl-summary-auto-refile
3042 (@code{wl-summary-auto-refile})
3046 Put copy mark on the message at the current cursor point.
3047 @findex wl-summary-copy
3048 (@code{wl-summary-copy})
3051 @kindex M-o (Summary)
3052 Put refile mark on the message at the current cursor point with the destination
3053 previously specified.
3054 @findex wl-summary-refile-prev-destination
3055 (@code{wl-summary-refile-prev-destination})
3059 @findex wl-summary-delete
3060 Put delete mark on the message at the current cursor point.
3061 (@code{wl-summary-delete})
3065 @findex wl-summary-unmark
3066 Unmark the temporal mark on the message at the current cursor point.
3067 (@code{wl-summary-unmark})
3071 Unmark all the temporal marks.
3072 @findex wl-summary-unmark-all
3073 (@code{wl-summary-unmark-all})
3076 @kindex r R (Summary)
3077 @findex wl-summary-mark-as-read-region
3078 Mark as read messages in the specified region.
3079 (@code{wl-summary-mark-as-read-region})
3082 @kindex r $ (Summary)
3083 @findex wl-summary-mark-as-important-region
3084 Mark as important @samp{$} messages in the specified region.
3085 If @samp{$} already exists, it is deleted.
3086 (@code{wl-summary-mark-as-important-region})
3089 @kindex r ! (Summary)
3090 @findex wl-summary-mark-as-unread-region
3091 Mark as unread messages in the specified region.
3092 (@code{wl-summary-mark-as-unread-region})
3095 @kindex r i (Summary)
3096 @findex wl-summary-prefetch-region
3097 Prefetch messages in the specified region.
3098 (@code{wl-summary-prefetch-region})
3101 @kindex r x (Summary)
3102 @findex wl-summary-exec-region
3103 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3105 (@code{wl-summary-exec-region})
3108 @kindex r * (Summary)
3109 @findex wl-summary-target-mark-region
3110 Put target mark on the messages in the specified region.
3111 (@code{wl-summary-target-mark-region})
3114 @kindex r o (Summary)
3115 @findex wl-summary-refile-region
3116 Put refile mark on the messages in the specified region.
3117 (@code{wl-summary-refile-region})
3120 @kindex r O (Summary)
3121 @findex wl-summary-copy-region
3122 Put copy mark on the messages in the specified region.
3123 (@code{wl-summary-copy-region})
3126 @kindex r d (Summary)
3127 @findex wl-summary-delete-region
3128 Put delete mark on the messages in the specified region.
3129 (@code{wl-summary-delete-region})
3132 @kindex r u (Summary)
3133 @findex wl-summary-unmark-region
3134 Delete temporal mark on the messages in the specified region.
3135 (@code{wl-summary-unmark-region})
3138 @kindex r y (Summary)
3139 Save messages in the specified region.
3140 @findex wl-summary-save-region
3141 (@code{wl-summary-save-region})
3144 @kindex t R (Summary)
3145 @findex wl-thread-mark-as-read
3146 Mark as read messages which are the descendant of the current thread.
3147 With prefix argument, it affects on the all messages in the thread tree.
3148 (@code{wl-thread-mark-as-read})
3151 @kindex t $ (Summary)
3152 @findex wl-thread-mark-as-important
3153 Put important mark @samp{$} on the messages which are the
3154 descendant of the current thread.
3155 If @samp{$} mark exists, it is deleted.
3156 With prefix argument, it affects on the all messages in the thread tree.
3157 (@code{wl-thread-mark-as-important})
3160 @kindex t ! (Summary)
3161 @findex wl-thread-mark-as-unread
3162 Mark as unread messages which are the descendant of the current thread.
3163 With prefix argument, it affects on the all messages in the thread tree.
3164 (@code{wl-thread-mark-as-unread})
3167 @kindex t i (Summary)
3168 @findex wl-thread-prefetch
3169 Prefetch messages which are the descendant of the current thread.
3170 With prefix argument, it affects on the all messages in the thread tree.
3171 (@code{wl-thread-prefetch})
3174 @kindex t x (Summary)
3175 @findex wl-thread-exec
3176 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3177 the descendant of the current thread. With prefix argument, it affects
3178 on the all messages in the thread tree.
3179 (@code{wl-thread-exec})
3182 @kindex t * (Summary)
3183 @findex wl-thread-target-mark
3184 Put target mark @samp{*} on the messages which are the descendant of the
3185 current thread. With prefix argument, it affects on the all messages in
3187 (@code{wl-thread-target-mark})
3190 @kindex t o (Summary)
3191 @findex wl-thread-refile
3192 Put refile mark on the messages which are the descendant of the current thread.
3193 With prefix argument, it affects on the all messages in the thread tree.
3194 (@code{wl-thread-refile})
3197 @kindex t O (Summary)
3198 @findex wl-thread-copy
3199 Put copy mark on the messages which are the descendant of the current thread.
3200 With prefix argument, it affects on the all messages in the thread tree.
3201 (@code{wl-thread-copy})
3204 @kindex t d (Summary)
3205 @findex wl-thread-delete
3206 Put delete mar on the messages which are the descendant of the current thread.
3207 With prefix argument, it affects on the all messages in the thread tree.
3208 (@code{wl-thread-delete})
3211 @kindex t u (Summary)
3212 @findex wl-thread-unmark
3213 Unmark temporal mark on the messages which are the descendant of the
3214 current thread. With prefix argument, it affects on the all messages in
3216 (@code{wl-thread-unmark})
3219 @kindex t y (Summary)
3220 @findex wl-thread-save
3221 Save messages which are the descendant of the current thread.
3222 With prefix argument, it affects on the all messages in the thread tree.
3223 (@code{wl-thread-save})
3226 @kindex m i (Summary)
3227 @findex wl-summary-target-mark-prefetch
3228 Prefetch all messages which have target mark @samp{*}.
3229 (@code{wl-summary-target-mark-prefetch})
3232 @kindex m R (Summary)
3233 @findex wl-summary-target-mark-mark-as-read
3234 Mark as read all messages which have target mark @samp{*}.
3235 (@code{wl-summary-target-mark-mark-as-read})
3238 @kindex m $ (Summary)
3239 @findex wl-summary-target-mark-mark-as-important
3240 Mark as important all messages which have target mark @samp{*}.
3241 If already marked as @samp{$}, it is deleted.
3242 (@code{wl-summary-target-mark-mark-as-important})
3245 @kindex m ! (Summary)
3246 @findex wl-summary-target-mark-mark-as-unread
3247 Mark as unread all messages which have target mark @samp{*}.
3248 (@code{wl-summary-target-mark-mark-as-unread})
3251 @kindex m o (Summary)
3252 @findex wl-summary-target-mark-refile
3253 Put refile mark on the messages which have target mark @samp{*}.
3254 (@code{wl-summary-target-mark-refile})
3257 @kindex m O (Summary)
3258 @findex wl-summary-target-mark-copy
3259 Put copy mark on the messages which have target mark @samp{*}.
3260 (@code{wl-summary-target-mark-copy})
3263 @kindex m d (Summary)
3264 @findex wl-summary-target-mark-delete
3265 Put delete mark on the messages which have target mark @samp{*}.
3266 (@code{wl-summary-target-mark-delete})
3269 @kindex m y (Summary)
3270 @findex wl-summary-target-mark-save
3271 Save messages which have target mark @samp{*}.
3272 (@code{wl-summary-target-mark-save})
3275 @kindex m u (Summary)
3276 Unmark all temporal marks.
3277 (@code{wl-summary-delete-all-temp-marks})
3278 @findex wl-summary-delete-all-temp-marks
3281 @kindex m a (Summary)
3282 Put target mark @samp{*} on the all messages.
3283 (@code{wl-summary-target-mark-all})
3284 @findex wl-summary-target-mark-all
3287 @kindex m t (Summary)
3288 Put target mark @samp{*} on the messages in the current thread.
3289 @findex wl-summary-target-mark-thread
3290 (@code{wl-summary-target-mark-thread})
3293 @kindex m r (Summary)
3294 @findex wl-summary-target-mark-region
3295 Put target mark @samp{*} on the messages in the specified region.
3296 (@code{wl-summary-target-mark-region})
3299 @kindex m A (Summary)
3300 @findex wl-summary-target-mark-reply-with-citation
3301 Prepare a draft which cites all messages which have target mark @samp{*}.
3302 (@code{wl-summary-target-mark-reply-with-citation})
3305 @kindex m f (Summary)
3306 @findex wl-summary-target-mark-forward
3307 Prepare a draft which forwards all messages which have target mark @samp{*}.
3308 (@code{wl-summary-target-mark-forward})
3311 @kindex m U (Summary)
3312 @findex wl-summary-target-mark-uudecode
3313 Uudecode the messages which have target mark @samp{*}.
3314 (@code{wl-summary-target-mark-uudecode})
3317 @kindex m ? (Summary)
3318 @findex wl-summary-target-mark-pick
3319 Pick messages from the @samp{*} marked messages.
3320 That is, @samp{*} marks on the messages are remained
3321 if the specified condition is satisfied.
3322 (@code{wl-summary-target-mark-pick})
3325 @kindex M-t (Summary)
3326 @findex wl-toggle-plugged
3327 Toggle offline/online status of Wanderlust.
3328 (@code{wl-toggle-plugged})
3331 @kindex C-t (Summary)
3332 Start Wanderlust's plug-status manager.
3333 (@code{wl-plugged-change})
3336 @kindex C-c C-o (Summary)
3337 @findex wl-jump-to-draft-buffer
3338 Move to the draft buffer if available. If multiple draft buffer exists,
3339 moved to one after another. If prefix argument is specified, load draft
3340 folder's message to the draft buffer and jump to it.
3341 (@code{wl-jump-to-draft-buffer})
3345 @node Variables of Summary, , Key Bindings of Summary, Summary
3346 @section Customiziable variables
3349 @item wl-summary-move-order
3350 @vindex wl-summary-move-order
3351 The initial setting is @code{unread}. Specify cursor moving policy. If
3352 you want to precede new messages, set @code{new}. If you want to
3353 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3356 @item wl-auto-select-first
3357 @vindex wl-auto-select-first
3358 The initial setting is @code{nil}.
3359 If non-nil, first message is automatically displayed.
3361 @item wl-auto-select-next
3362 @vindex wl-auto-select-next
3363 The initial setting is @code{nil}. If non-nil, jump to next summary
3364 automatically. If @code{unread}, jump to next unread folder's summary
3365 after confirmation. If @code{skip-no-unread}, unread folders are
3366 automatically skipped.
3368 @item wl-thread-insert-opened
3369 @vindex wl-thread-insert-opened
3370 The initial setting is @code{nil}.
3371 If non-nil, thread is inserted as opened.
3373 @item wl-thread-open-reading-thread
3374 @vindex wl-thread-open-reading-thread
3375 The initial setting is @code{t}. If non-nil, reading thread is
3376 automatically opened though it is closed thread.
3378 @item wl-summary-exit-next-move
3379 @vindex wl-summary-exit-next-move
3380 The initial setting is @code{t}. If non-nil, move to next folder at
3383 @item wl-folder-move-cur-folder
3384 @vindex wl-folder-move-cur-folder
3385 The initial setting is @code{nil}. If non-nil, cursor position on the
3388 @item wl-summary-weekday-name-lang
3389 @vindex wl-summary-weekday-name-lang
3390 The initial setting is @samp{ja}. Specify language of the weekday.
3391 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3394 @item wl-summary-fix-timezone
3395 @vindex wl-summary-fix-timezone
3396 The initial setting is @samp{JST}. Timezone to adjust summary's
3397 timezone. If @code{nil}, adjust to GMT.
3399 @item wl-use-petname
3400 @vindex wl-use-petname
3401 The initial setting is @code{t}.
3402 If non-nil, sender part displays nickname.
3404 @item wl-break-pages
3405 @vindex wl-break-pages
3406 The initial setting is @code{t}.
3407 If non-nil, message is splitted as pages by @samp{^L}.
3409 @item wl-message-window-size
3410 @vindex wl-message-window-size
3411 The initial setting is '(1 . 4).
3412 A cons cell to specify the rate of summary and message window.
3413 car:cdr corresponds summary:message.
3415 @item wl-summary-recenter
3416 @vindex wl-summary-recenter
3417 The initial setting is t.
3418 If non-nil, cursor point is moved to the center of the summary window.
3420 @item wl-summary-indent-length-limit
3421 @vindex wl-summary-indent-length-limit
3422 The initial setting is 46.
3423 Specify the limit of thread indent level.
3424 If nil, max indent level is unlimited.
3426 @item wl-summary-no-from-message
3427 @vindex wl-summary-no-from-message
3428 The initial setting is @samp{nobody@@nowhere?}. A string which is
3429 displayed when there's no @samp{From:} field in the message.
3431 @item wl-summary-no-subject-message
3432 @vindex wl-summary-no-subject-message
3433 The initial setting is @samp{(WL:No Subject in original.)}. A string
3434 which is displayed when there's no @samp{Subject:} field in the message.
3436 @item wl-summary-width
3437 @vindex wl-summary-width
3438 The initial setting is 80.
3439 Width of summary line. If @code{nil}, summary line's width is as is.
3441 @item wl-use-folder-petname
3442 @vindex wl-use-folder-petname
3443 The initial setting is the list shown below:
3452 A list of display policy (symbol) of folder nickname. Available symbols
3457 Display folder petname on modeline.
3459 Destination folder is notified as nickname if
3460 @code{wl-auto-select-next} is non-nil.
3462 You can input folder name by nickname in the function
3463 @code{wl-summary-read-folder}.
3466 @item wl-summary-move-direction-toggle
3467 @vindex wl-summary-move-direction-toggle
3468 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3469 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3470 want to aware of reading direction, set this to @code{t}.
3473 @vindex wl-from-width
3474 The initial setting is 17.
3475 Width of sender part of summary line.
3477 @item wl-summary-divide-thread-when-subject-changed
3478 @vindex wl-summary-divide-thread-when-subject-changed
3479 The initial setting is @code{nil}. If non-nil, thread is splitted if
3480 the subject is changed.
3482 @item wl-summary-search-via-nntp
3483 @vindex wl-summary-search-via-nntp
3484 The initial setting is @code{confirm}.
3486 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3487 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3488 from the NNTP server @code{elmo-default-nntp-server}. The value of
3489 @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
3490 @code{elmo-default-nntp-ssl} are used.
3492 If @code{confirm}, server name can be specified. You can specify NNTP
3493 folder format like @samp{-:username@@servername:119!}.
3495 @item wl-summary-keep-cursor-command
3496 @vindex wl-summary-keep-cursor-command
3497 The initial setting is the list shown below:
3501 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3506 When you entered to summary by these commands and the target summary
3507 buffer already exists, summary status is not automatically updated and
3508 cursor position is saved.
3510 @item wl-summary-update-confirm-threshold
3511 @vindex wl-summary-update-confirm-threshold
3512 The initial setting is 500. If updated message number is larger than
3513 this value, confirm whether drop them or not.
3515 @item wl-summary-always-sticky-folder-list
3516 @vindex wl-summary-always-sticky-folder-list
3517 The initial setting is @code{nil}.
3518 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3519 are automatically sticked. Each element is regexp of folder name.
3521 @item wl-summary-reserve-mark-list
3522 @vindex wl-summary-reserve-mark-list
3523 The initial setting is the list shown below:
3532 If a message is already marked as temporal marks in this list, the
3533 message is not marked by any mark command.
3535 @item wl-summary-skip-mark-list
3536 @vindex wl-summary-skip-mark-list
3537 The initial setting is the list shown below:
3546 If a message is already marked as temporal marks in this list, the
3547 message is skipped at cursor move.
3549 @item wl-fetch-confirm-threshold
3550 @vindex wl-fetch-confirm-threshold
3551 The initial setting is 30000 (bytes). If displaying message has larger
3552 size than this value, Wanderlust confirms whether fetch the message or
3553 not. If @code{nil}, the message is fetched without confirmation.
3555 @item wl-prefetch-threshold
3556 @vindex wl-prefetch-threshold
3557 The initial setting is 30000 (bytes). If prefetching message has larger
3558 size than this value and @code{wl-prefetch-confirm} is non-nil,
3559 Wanderlust confirms whether prefetch the message or not. If
3560 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3561 without confirmation.
3563 @item wl-prefetch-confirm
3564 @vindex wl-prefetch-confirm
3565 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3566 prefetch the message or not if the message has larger size than
3567 @code{wl-prefetch-threshold}.
3569 @item wl-cache-fetch-threshold
3570 @vindex wl-cache-fetch-threshold
3571 The initial setting is 30000 (bytes). The messages which have larger
3572 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3573 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3576 @item elmo-imap4-use-cache
3577 @vindex elmo-imap4-use-cache
3578 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3581 @item elmo-nntp-use-cache
3582 @vindex elmo-nntp-use-cache
3583 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3586 @item elmo-pop3-use-cache
3587 @vindex elmo-pop3-use-cache
3588 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3593 @node Message, Draft, Summary, Top
3594 @chapter Message Buffer
3596 Message Buffers utilize MIME-View mode of SEMI/tm. For operational
3597 procedures and key bindings, refer to respective documents.
3598 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3600 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3601 brings you back to Summary mode. @kbd{l} toggles display of Summary
3604 @section Key Bindings
3610 @findex wl-message-toggle-disp-summary
3611 Toggles display of Summary mode buffer.
3612 (@code{wl-message-toggle-disp-summary})
3615 @findex wl-message-refer-article-or-url
3616 @kindex Button-2 (Message)
3617 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3618 corresponding message if found.
3619 (@code{wl-message-refer-article-or-url})
3621 @item Button-4 (upward movement of a wheel)
3622 @kindex Button-4 (Message)
3623 @findex wl-message-wheel-down
3624 Scrolls the message backwards. When the top of the message is hit,
3625 moves to the previous message.
3626 (@code{wl-message-wheel-down})
3628 @item Button-5 (downward movement of a wheel)
3629 @kindex Button-5 (Message)
3630 @findex wl-message-wheel-up
3631 Scrolls the message forward. When the bottom of the message is hit,
3632 moves to the next message.
3633 (@code{wl-message-wheel-up})
3636 @section Customizable Variables
3639 @item wl-message-window-size
3640 @vindex wl-message-window-size
3641 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3642 its car and cdr value corresponds to the ratio of Summary and Message
3647 @node Draft, Disconnected Operations, Message, Top
3648 @chapter Draft Buffer
3650 At Summary mode, pressing @kbd{w} and the like creates a new draft
3651 buffer. You can edit and send mail and news articles in this buffer.
3655 Basically it is Emacs-standard mail mode.
3657 @subsection Address Completion
3659 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3660 addresses. @kbd{@key{TAB}} completes them.
3662 If you want to submit a news article, add @samp{Newsgroups:} field by
3663 yourself. Field names can be completed by @kbd{@key{TAB}}.
3665 If you save the draft buffer you are editing, it is appended to the
3666 folder specified by @code{wl-draft-folder}.
3668 Using @samp{FCC:} field, you can specify the folder to which a copy of
3669 the message is saved when it is sent.
3671 @subsection Editing Messages
3673 Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
3674 editing, refer to respective documents.
3675 @xref{MIME-Edit, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3677 @subsection Dynamic Modification of Messages
3678 @vindex wl-draft-config-alist
3679 @c @cindex Change Message
3680 @c @cindex Message, Change Dynamic
3682 You can set @code{wl-draft-config-alist} so that header and body of the
3683 message will automatically modified depending on information of header
3686 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3688 In the example below, the header is modified when
3689 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3690 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3691 before sending the message.
3695 (setq wl-draft-config-alist
3696 '(((string-match "aaa.ne.jp$" (system-name))
3697 ;; @r{applied if the expression is non-nil}
3698 (wl-smtp-posting-server . "mailserver-B")
3699 (wl-nntp-posting-server . "newsserver-B")
3700 ;; @r{settings of temporary variables}
3702 ("^To: .*user@@aaa.bbb.com"
3703 ;; @r{applied if it matches the header of the draft buffer}
3704 ("Organization" . (format "Go %s" my-webpage)))
3705 ;; @r{you can write elisp expressions here (eval only)}
3706 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3707 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3712 The format of @code{wl-draft-config-alist} is:
3716 '(("@var{regexp of the header}" or elisp expression
3717 ("@var{Field}" . value(elisp expression))
3718 (@var{variable} . value(elisp expression))
3719 (@var{sub-function} . value(elisp expression))
3722 ("@var{regexp of the header}" or elisp expression
3723 ("@var{Field}" . value(elisp expression))
3728 Per default, there are 10 following sub-functions.
3731 'header: Inserts the specified string at the bottom of the header.
3732 'header-file: Inserts the specified file at the bottom of the header.
3733 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3734 'top: Inserts the specified string at the top of the body.
3735 'top-file: Inserts the specified file at the top of the body.
3736 'body: Replaces the body with the specified string.
3737 Specifying nil deletes the entire body string.
3738 'body-file: Replaces the body with the content of the specified file.
3739 'bottom: Inserts the specified string at the bottom of the body.
3740 'bottom-file: Inserts the specified file at the top of the body.
3741 'template: Applies the specified template.
3742 (refer to the next subsection)
3745 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3746 change them or add your own functions. If you read the code, you can
3747 easily find how to write the functions.
3749 At the first of each item, @var{a regular expression of the header} or
3750 an elisp expression should be specified. In the case of an elisp
3751 expression, the item is applied when the expression is evaluated
3754 Per default, when multiple items match or are evaluated non-nil, all
3755 such items are applied, but if you set a variable
3756 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3759 At the second of the item, a cons or a list of functions should be
3760 specified. The car part of the cons should be a header field, a
3761 variable, or a sub-function. When a header field is specified, the
3762 field will be modified. If a variable is specified, the value of the
3763 variable will be modified temporarily.
3765 In the cdr part of a cons, not only a variable but also an elisp
3766 expression can be specified as is. If the car part is a header field
3767 and the cdr part is @code{nil}, the field will be deleted.
3769 See the next example as well:
3773 (setq wl-draft-config-alist
3775 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3776 ;; @r{applied if it matches the header of the buffer being replied}
3777 (body . " Hello.\n")
3778 (template . "default")
3783 As in the (1) above, if a header regexp is prepended with @code{reply},
3784 it is applied when the draft is prepared by @code{wl-summary-reply} for
3785 example, and when it matches the header being replied. It is ignored
3786 when there is no buffer being replied, like after @code{wl-draft} was
3789 Note that @code{wl-draft-config-alist} is applied only once when
3790 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3791 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3792 aborting transmission, execute @kbd{C-c C-e}
3793 (@code{wl-draft-config-exec}).
3795 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3796 prepared, do the following:
3799 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3802 @subsection Inserting Templates
3804 @cindex Apply Template
3806 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3807 @kbd{M-x wl-template-select} in the draft buffer.
3809 The format of @code{wl-template-alist} is almost the same as
3810 @code{wl-draft-config-alist}.
3814 (setq wl-template-alist
3817 ("Organization" . "~/.wl sample")
3818 (body . "Hello.\n"))
3820 (template . "default") ;; @r{(a)}
3821 ("To" . "jousi@@kaisha.jp")
3822 ("Subject" . "Report")
3823 (body-file . "~/work/report.txt")
3829 As you can see, the only difference is item (template) names such as
3830 @samp{default} and @samp{report}, instead of a regexp of header.
3831 Because definition of each item is the same as
3832 @code{wl-draft-config-alist}, you can call another template, like (a).
3834 Executing the command @code{wl-template-select} results in template
3835 selection, but the result differs depending on variable
3836 @code{wl-template-visible-select}.
3838 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3839 window is shown below the draft buffer. You can select a template by
3840 @kbd{n} and @kbd{p} seeing the buffer window.
3842 Press the @key{RET} key and the template is actually applied to the draft
3843 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3844 adjust the window size by @code{wl-template-buffer-lines}.
3846 If @code{wl-template-visible-select} is @code{nil}, you should type the
3847 name of the template in the mini buffer.
3849 As shown in the example in @code{wl-draft-config-alist}, you can select
3850 @samp{default} template by writing:
3853 (template . "default")
3856 @subsection Sending mail by POP-before-SMTP
3857 @cindex POP-before-SMTP
3859 You can send mail by POP-before-SMTP with this single line:
3862 (setq wl-draft-send-mail-func 'wl-draft-send-mail-with-pop-before-smtp)
3866 Configure the following variables if you need.
3869 @item wl-pop-before-smtp-user
3870 The POP user name for POP-before-SMTP authentication.
3871 If unset, @code{elmo-default-pop3-user} is used.
3873 @item wl-pop-before-smtp-server
3874 The POP server name for POP-before-SMTP authentication.
3875 If unset, @code{elmo-default-pop3-server} is used.
3877 @item wl-pop-before-smtp-authenticate-type
3878 The POP authentication method for POP-before-SMTP authentication.
3879 If unset, @code{elmo-default-pop3-authenticate-type} is used.
3881 @item wl-pop-before-smtp-port
3882 The POP port number for POP-before-SMTP authentication.
3883 If unset, @code{elmo-default-pop3-port} is used.
3885 @item wl-pop-before-smtp-ssl
3886 If non-nil, POP connection is established using SSL. If
3887 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
3888 unset, @code{elmo-default-pop3-ssl} is used.
3891 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
3892 unset, settings for POP folders (@code{elmo-default-pop3-*}) are
3894 Therefore, if SMTP server and POP server are actually the same, and if
3895 POP folder per default (such as @samp{&}) is available, no settings are
3898 Refer to the following URL about POP-before-SMTP.
3902 http://spam.ayamura.org/tools/smPbS.html
3903 http://www.iecc.com/pop-before-smtp.html
3907 @section Key Bindings
3908 @cindex Keybind, Draft Mode
3909 @cindex Keybind, Draft Buffer
3914 @kindex C-c C-y (Draft)
3915 @findex wl-draft-yank-original
3916 Cites the content of the current message buffer.
3917 (@code{wl-draft-yank-original})
3920 @kindex C-c C-p (Draft)
3921 @findex wl-draft-preview-message
3922 Previews the content of the current draft.
3923 This is useful for previewing MIME multi-part messages.
3924 (@code{wl-draft-preview-message})
3927 @kindex C-c C-s (Draft)
3928 @findex wl-draft-send
3929 Sends the content of the current draft. Does not erase the draft buffer.
3930 This is useful for sending multiple messages, which are a little different
3932 (@code{wl-draft-send})
3935 @kindex C-c C-c (Draft)
3936 @findex wl-draft-send-and-exit
3937 Sends the content of the current draft and erases the draft buffer.
3938 (@code{wl-draft-send-and-exit})
3941 @kindex C-x C-s (Draft)
3942 @findex wl-draft-save
3943 Save the current draft.
3944 (@code{wl-draft-save})
3947 @kindex C-c C-k (Draft)
3948 @findex wl-draft-kill
3949 Kills the current draft.
3950 (@code{wl-draft-kill})
3953 @kindex C-x k (Draft)
3954 @findex wl-draft-mimic-kill-buffer
3955 Kills the current draft.
3956 (@code{wl-draft-mimic-kill-buffer})
3959 @kindex C-c C-z (Draft)
3960 @findex wl-draft-save-and-exit
3961 Saves the current draft, and erases the draft buffer.
3962 This is useful if you want to suspend editing of the draft.
3963 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
3964 the @samp{+draft} folder.
3965 (@code{wl-draft-save-and-exit})
3968 @kindex C-c C-r (Draft)
3969 @findex wl-caesar-region
3970 Encodes or decodes the specified region in Caesar cipher.
3971 (@code{wl-caesar-region})
3975 @findex wl-toggle-plugged
3976 Toggles off-line/on-line states of Wanderlust.
3977 (@code{wl-toggle-plugged})
3980 @kindex C-c C-o (Draft)
3981 @findex wl-jump-to-draft-buffer
3982 Jumps to the other draft buffer, if exists.
3983 With prefix argument, reads a file (if any) from the draft folder when
3984 there is no such buffer.
3985 (@code{wl-jump-to-draft-buffer})
3988 @kindex C-c C-e (Draft)
3989 @findex wl-draft-config-exec
3990 Applies @code{wl-draft-config-alist}.
3991 (@code{wl-draft-config-exec})
3994 @kindex C-c C-j (Draft)
3995 @findex wl-template-select
3997 (@code{wl-template-select})
4000 @kindex C-c C-a (Draft)
4001 @findex wl-draft-insert-x-face-field
4002 Inserts the content of a file @file{~/.xface} (the value of the variable
4003 @code{wl-x-face-file}) as an @samp{X-Face:} field in the draft buffer.
4005 There should be encoded X-Face strings as a content of a file @file{~/.xface}.
4006 (@code{wl-draft-insert-x-face-field})
4009 @section Customizable Variables
4012 @item wl-subscribed-mailing-list
4013 @vindex wl-subscribed-mailing-list
4014 The initial setting is @code{nil}. Mailing lists to which you
4015 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4016 field of a reply draft, removes your own address from
4017 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4018 contained in @samp{To:} or @samp{Cc:} field of a message to be
4019 automatically re-filed, the destination folder will be leaned in
4020 connection with the address.
4022 @item wl-insert-mail-followup-to
4023 @vindex wl-insert-mail-followup-to
4024 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4025 field is automatically inserted in the draft buffer.
4027 @item wl-insert-mail-reply-to
4028 @vindex wl-insert-mail-reply-to
4029 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4030 field is automatically inserted in the draft buffer.
4032 @item wl-auto-insert-x-face
4033 @vindex wl-auto-insert-x-face
4034 The initial setting is @code{t}. If non-nil and there is an encoded
4035 X-Face string in a file @file{~/.xface} (the value of the variable
4036 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4037 draft buffer. If @code{nil}, it is not automatically inserted. Press
4038 @kbd{C-c C-a} to insert.
4040 @item wl-insert-message-id
4041 @vindex wl-insert-message-id
4042 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4043 is automatically inserted on the transmission.
4045 @item wl-local-domain
4046 @vindex wl-local-domain
4047 The initial setting is @code{nil}. If @code{nil}, the return value of
4048 the function @code{system-name} will be used as the domain part of
4051 If @code{system-name} does not return FQDN (i.e. the full name of the
4052 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4053 to the string of the local domain name without hostname (like
4054 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4055 @samp{.} @code{wl-local-domain} is used as domain part of the
4058 If your terminal does not have global IP, set the value of
4059 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4060 you use invalid @samp{Message-ID:}.)
4062 Moreover, concatenation of @code{system-name} @samp{.}
4063 @code{wl-local-domain} will be used as an argument to the HELO command
4066 @item wl-message-id-domain
4067 @vindex wl-message-id-domain
4068 The initial setting is @code{nil}. If non-nil, this value is used as a
4069 domain part of the @samp{Message-ID:}. If your terminal does not have
4070 global IP, set unique string to this value (e.x. your e-mail address).
4072 @item wl-message-id-domain
4073 @vindex wl-message-id-domain
4074 The initial setting is @code{nil}. If @code{nil}, the return value of
4075 the function @code{system-name} will be used as the domain part of
4076 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4077 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4078 @strong{must} set this variable to the string of the full name of the
4079 host. Otherwise, you might be beaten up on the Net News.
4081 @item wl-draft-config-alist
4082 @vindex wl-draft-config-alist
4083 The initial setting is @code{nil}. Modifies the draft message just
4084 before the transmission. The content of @code{wl-draft-config-alist}
4085 will be automatically applied only once on the transmission. If you
4086 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4089 @item wl-template-alist
4090 @vindex wl-template-alist
4091 The initial setting is @code{nil}.
4092 This variable specifies the template to be applied in the draft buffer.
4094 @item wl-draft-config-matchone
4095 @vindex wl-draft-config-matchone
4096 The initial setting is @code{nil}. If non-nil, only the first matching
4097 item is used when @code{wl-draft-config-alist} is applied. If
4098 @code{nil}, all matching items are used.
4100 @item wl-template-visible-select
4101 @vindex wl-template-visible-select
4102 The initial setting is @code{t}.
4103 If non-nil, you can preview the result of the template selection in
4106 @item wl-template-confirm
4107 @vindex wl-template-confirm
4108 The initial setting is @code{nil}.
4109 If non-nil, asks for confirmation when you press the enter key to select
4110 template while previewing.
4112 @item wl-template-buffer-lines
4113 @vindex wl-template-buffer-lines
4114 The initial setting is 7.
4115 If @code{wl-template-visible-select} is non-nil, this variable specifies
4116 the size of the preview window.
4118 @item wl-draft-reply-buffer-style
4119 @vindex wl-draft-reply-buffer-style
4120 The initial setting is @code{split}. @code{split} or @code{full} can be
4121 specified. In the case of @code{full}, the whole frame will be used for
4122 a reply draft buffer when it is prepared.
4124 @item wl-draft-use-frame
4125 @vindex wl-draft-use-frame
4126 The initial setting is @code{nil}.
4127 If non-nil, use new frame for the draft.
4131 The initial setting is the value of the variable
4132 @code{user-mail-address}. The value of this variable is inserted as a
4133 @samp{From:} field of the draft when it is prepared.
4135 @item wl-envelope-from
4136 @vindex wl-envelope-from
4137 The initial setting is @code{nil}.
4138 The value of this variable is used for envelope from (MAIL FROM).
4139 If @code{nil}, the address part of @code{wl-from} is used.
4141 @item wl-user-mail-address-list
4142 @vindex wl-user-mail-address-list
4143 The initial setting is @code{nil}.
4144 This is the User's address list. If you have multiple addresses,
4149 The initial setting is @code{nil}.
4150 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4151 the draft when it is prepared. If function is specified, its return
4156 The initial setting is @code{nil}.
4157 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4158 the draft when it is prepared.
4160 @item wl-reply-subject-prefix
4161 @vindex wl-reply-subject-prefix
4162 The initial setting is @samp{Re: }.
4163 In the @samp{Subject:} of the reply draft, this string is prepended to
4164 the @samp{Subject:} of being replied.
4166 @item wl-draft-reply-use-address-with-full-name
4167 @vindex wl-draft-reply-use-address-with-full-name
4168 The initial setting is @code{t}.
4169 If non-nil, insert her full name with address when prepare a draft for
4170 reply a message. If it is @code{nil}, insert her address only.
4172 @item wl-draft-enable-queuing
4173 @vindex wl-draft-enable-queuing
4174 The initial setting is @code{t}.
4175 This flag controls off-line transmission. If non-nil, the draft is
4178 @item wl-draft-use-cache
4179 @vindex wl-draft-use-cache
4180 The initial setting is @code{t}.
4181 If non-nil, cache the message which is sent.
4183 @item wl-auto-flush-queue
4184 @vindex wl-auto-flush-queue
4185 The initial setting is t.
4186 This flag controls automatic transmission of the queue when Wanderlust
4187 becomes on-line. If non-nil, the queue is automatically transmitted
4188 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4189 manually, press @kbd{F} in the folder mode.
4191 @item wl-draft-always-delete-myself
4192 @vindex wl-draft-always-delete-myself
4193 If non-nil, always removes your own address from @samp{To:} and
4194 @samp{Cc:} when you are replying to the mail addressed to you.
4196 @item wl-smtp-posting-server
4197 @vindex wl-smtp-posting-server
4198 The initial setting is @code{nil}.
4199 This is the SMTP server name for mail transmission.
4201 @item wl-smtp-posting-user
4202 @vindex wl-smtp-posting-user
4203 The initial setting is @code{nil}.
4204 This is the user name for SMTP AUTH authentication. If @code{nil},
4205 @code{smtp-authenticate-user} is used.
4207 @item wl-smtp-authenticate-type
4208 @vindex wl-smtp-authenticate-type
4209 The initial setting is @code{nil}.
4210 This is the authentication method for SMTP AUTH authentication. If
4211 @code{nil}, @code{smtp-authenticate-type} is used. If
4212 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4215 @item wl-smtp-connection-type
4216 @vindex wl-smtp-connection-type
4217 The initial setting is @code{nil}.
4218 This variable specifies how to establish SMTP connections.
4219 If @code{nil}, @code{smtp-connection-type} is used.
4220 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4222 @item wl-nntp-posting-server
4223 @vindex wl-nntp-posting-server
4224 The initial setting is @code{nil}.
4225 This is the NNTP server name used for news submission.
4226 If @code{nil}, @code{elmo-default-nntp-server} is used.
4228 @item wl-nntp-posting-user
4229 @vindex wl-nntp-posting-user
4230 The initial setting is @code{nil}.
4231 This is the user name for AUTHINFO authentication on news submission.
4232 If @code{nil}, @code{elmo-default-nntp-user} is used.
4233 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4235 @item wl-nntp-posting-port
4236 @vindex wl-nntp-posting-port
4237 The initial setting is @code{nil}.
4238 This is the port number of the NNTP server used for news submission.
4239 If @code{nil}, @code{elmo-default-nntp-server} is used.
4241 @item wl-nntp-posting-ssl
4242 @vindex wl-nntp-posting-ssl
4243 The initial setting is @code{nil}.
4244 If @code{nil}, @code{elmo-default-nntp-ssl} is evaluated. If non-nil,
4245 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4246 connection will be established.
4248 @item wl-pop-before-smtp-user
4249 @vindex wl-pop-before-smtp-user
4250 The initial setting is @code{nil}.
4251 This is the POP user name for POP-before-SMTP.
4252 If it is @code{nil}, @code{elmo-default-pop3-user} is used.
4254 @item wl-pop-before-smtp-server
4255 @vindex wl-pop-before-smtp-server
4256 The initial setting is @code{nil}.
4257 This is the POP server name for POP-before-SMTP.
4258 If it is @code{nil}, @code{elmo-default-pop3-server} is used.
4260 @item wl-pop-before-smtp-authenticate-type
4261 @vindex wl-pop-before-smtp-authenticate-type
4262 The initial setting is @code{nil}.
4263 This is the authentication method for POP-before-SMTP authentication.
4264 If it is @code{nil}, @code{elmo-default-pop3-authenticate} is used.
4266 @item wl-pop-before-smtp-port
4267 @vindex wl-pop-before-smtp-port
4268 The initial setting is @code{nil}.
4269 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4270 @code{elmo-default-pop3-port} is used.
4272 @item wl-pop-before-smtp-ssl
4273 @vindex wl-pop-before-smtp-ssl
4274 The initial setting is @code{nil}.
4275 This flag controls the use of SSL for POP-before-SMTP. If it is
4276 @code{nil}, @code{elmo-default-pop3-ssl} is used. If @code{starttls},
4277 STARTTLS (RFC2595) connection will be established.
4279 @item wl-draft-queue-save-variables
4280 @vindex wl-draft-queue-save-variables
4281 Specifies a list of variable to which queued messages are saved on the
4282 off-line transmission.
4284 @item wl-draft-sendlog
4285 @vindex wl-draft-sendlog
4286 The initial setting is @code{t}.
4287 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4291 @item drafts are sent by smtp or qmail
4292 @item saved into folders by fcc
4293 @item saved into folders by queuing
4296 (it is written even if the transmission fails).
4297 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4298 and left to the logging function of imput.
4301 @item wl-draft-sendlog-max-size
4302 @vindex wl-draft-sendlog-max-size
4303 The initial setting is 20000 (in bytes).
4304 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4305 beyond the size specified by this variable.
4309 The initial setting is @code{nil}.
4310 If non-nil, address completion uses LDAP.
4312 @item wl-ldap-server
4313 @vindex wl-ldap-server
4314 The initial setting is @samp{localhost}.
4315 LDAP server name for address completion.
4318 @vindex wl-ldap-port
4319 The initial setting is @code{nil}.
4320 If non-nil, the value is used as port number.
4323 @vindex wl-ldap-base
4324 The initial setting is @samp{c=US}.
4325 LDAP search starting point (base) for address completion.
4328 @node Disconnected Operations, Expire and Archive, Draft, Top
4329 @chapter Off-line Management
4330 @cindex Disconnected Operations
4332 Wanderlust has on-line and off-line states.
4335 * Off-line State:: Wanderlust has on-line and off-line states.
4336 * Enable Operations:: Enable Disconeected Oparations.
4337 * Plugged Mode:: Switching On-line/Off-line per Server/Port.
4338 * Off-line State settings:: Invoking Wanderlust in the Off-line State.
4339 * Variables of Plugged Mode:: Customize Plugged Mode.
4343 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4344 @section Off-line State
4346 Wanderlust has on-line and off-line states. In the off-line state, you
4347 cannot access messages via network, unless they are cached.
4349 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4350 in the mode line indicates the off-line state. In folder or summary
4351 modes, press @kbd{M-t} to switch between off- and on-line.
4353 You can invoke Wanderlust in the off-line state by setting
4354 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4356 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4357 ignores uncached messages.
4360 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4361 @section Enable Disconeected Oparations
4363 Even in the off-line state, provided that relevant messages are cached,
4364 and the variable @code{elmo-enable-disconnected-operation} (described
4365 later) is non-nil, you can following oparations:
4366 @xref{Plugged Mode}, @xref{Off-line State settings}.
4369 * Send Messages off-line:: Transmit Messages.
4370 * Re-file and Copy queue:: Re-file and Copy (IMAP4).
4371 * Creation of Folders:: Create Folders off-line (IMAP4).
4372 * Marking:: Mark (IMAP4).
4373 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP).
4376 As soon as Wanderlust becomes on-line, such operations invoked off-line
4377 are reflected in the servers via network.
4380 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4381 @subsection Transmission of Messages
4383 You can send mail/news messages off-line (if you are using
4384 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4385 accumulated in the queue folder, @samp{+queue}. These messages are
4386 transmitted at once when Wanderlust becomes on-line.
4388 You can visit @samp{+queue} in the off-line state and confirm content of
4389 messages in the queue. You can also remove messages. Removed messages
4390 are not transmitted even in the on-line state.
4393 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4394 @subsection Re-file and Copy (IMAP4)
4396 Re-file and copy operations to IMAP folders invoked during the off-line
4397 state are accumulated in the queue, and reflected in the server side
4398 when Wanderlust becomes on-line. If you visit destination folders after
4399 off-line re-file or copy, it looks as if messages were appended even in
4402 For the safety reasons, messages re-filed off-line are removed from
4403 source folders only if their @samp{Message-ID:} match messages on the
4404 servers. While the queue is processed, messages that failed to be
4405 re-filed or copied to the specified folders are appended to the folder
4409 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4410 @subsection Creation of Folders (IMAP4)
4412 You can create IMAP folders off-line. The creation of folders are
4413 reflected in the servers when Wanderlust becomes on-line. At that time,
4414 if folders failed to be created on the servers for any reasons, messages
4415 re-filed to such folders are appended to the folder @samp{+lost+found}.
4418 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4419 @subsection Marking (IMAP4)
4421 Off-line changes in unread/read and importance mark @samp{$} information
4422 are also reflected in the servers when Wanderlust becomes on-line.
4425 @node Pre-fetching Reservations, , Marking, Enable Operations
4426 @subsection Pre-fetching (IMAP4, NNTP)
4428 You can make reservations for pre-fetching messages in IMAP or NNTP
4429 folders. Reserved messages are marked with @samp{!} but not cached
4430 yet. When Wanderlust becomes on-line, they are pre-fetched from
4433 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4434 these off-line operations for IMAP4 and NNTP do not take place, and
4435 off-line re-file, copy or suchlike simply results in error.
4437 Because off-line operations use cache files, it is a bad idea to erase
4438 them by hand; it may cause Wanderlust to malfunction.
4440 If you want to remove caches, be sure to execute @kbd{M-x
4441 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4442 remove caches for messages relevant to off-line operations.
4445 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4446 @section Switching On-line/Off-line per Server/Port
4448 @kbd{M-t} described above switches networking states as a whole, but you
4449 can switch on-line/off-line per server/port.
4451 Pressing @kbd{C-t} in the folder or summary modes brings you in
4452 wl-plugged-mode shown below, in which you can change the plugged state
4457 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4460 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4461 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4463 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4464 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4470 The first line indicates status of the following three variables, and
4471 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
4472 column modifies the values of these variables.
4476 "Queuing" @code{wl-draft-enable-queuing}
4477 "AutoFlushQueue" @code{wl-auto-flush-queue}
4478 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4482 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4485 The second and after lines indicate on-line/off-line states of servers
4486 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4487 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4488 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4490 @dfn{sending queue} means messages accumulated in the folder
4491 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4492 off-line operations when @code{elmo-enable-disconnected-operation} is
4494 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4495 @c off-line operations are enabled.
4497 They are displayed if there are any of them. In the example above, in
4498 the sending queue there are two messages (the first and the second in
4499 the queue folder) for smtp to hosta and one (the third) for nntp to
4500 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4503 If you change @samp{(wl-plugged)} in the second line, the variable
4504 @code{wl-plugged} is changed, so that the mode line indicator and
4505 plugged states of all ports are affected. If you change plugged states
4506 of any servers or ports, @samp{(wl-plugged)} in the second line is
4507 affected depending on @code{elmo-plugged-condition} settings and the
4508 plugged state of each port.
4511 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4512 @section Invoking Wanderlust in the Off-line State
4514 As described before, if you set @code{wl-plugged} to @code{nil} in
4515 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4516 off-line state. You can specify off-line state on a per server or port
4517 basis. Refer to @code{wl-reset-plugged-alist} also.
4519 Usually, when Wanderlust starts up, the plugged state of each port is
4520 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4521 @code{wl-nntp-posting-server} and so on. If you want to change the
4522 plugged state of these ports or to add other ports, configure
4523 @code{wl-make-plugged-hook} with a function.
4527 (add-hook 'wl-make-plugged-hook
4529 (elmo-set-plugged plugged-value(t/nil) server port)
4530 ;; @r{add or change plugged states of the port of the server}
4531 (elmo-set-plugged plugged-value(t/nil) server)
4532 ;; @r{if the port is omitted, all ports are affected}
4533 ;; @r{(you cannot omit the port if you newly add the server)}
4539 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4540 @section Customizable Variables
4545 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4546 mode from the beginning.
4548 @item wl-queue-folder
4549 @vindex wl-queue-folder
4550 The initial setting is @samp{+queue}.
4551 This is the folder in which messages in the transmission queue are
4554 @item wl-auto-flush-queue
4555 @vindex wl-auto-flush-queue
4556 The initial setting is @code{t}.
4557 This flag controls automatic transmission of the queue when Wanderlust
4558 becomes on-line. If non-nil, the queue is automatically transmitted
4559 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4560 manually, press @kbd{F} in the folder mode.
4562 @item elmo-enable-disconnected-operation
4563 @vindex elmo-enable-disconnected-operation
4564 The initial setting is @code{nil}. Controls off-line operations
4565 regarding IMAP4. If non-nil, off-line operations are carried out.
4567 @item elmo-lost+found-folder
4568 @vindex elmo-lost+found-folder
4569 The initial setting is @samp{+lost+found}.
4570 This is the folder to which messages are saved when they fails to be
4571 appended while the off-line re-file/copy queue is processed.
4573 @item elmo-plugged-condition
4574 @vindex elmo-plugged-condition
4575 The initial setting is @code{one}.
4576 The value of @code{wl-plugged} reflects the return value of the function
4577 @code{elmo-plugged-p} (without arguments).
4578 This variable @code{elmo-plugged-condition} specifies the condition on
4579 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4580 plugged state of each port.
4583 'one : plugged if one or more ports are plugged.
4584 'all : plugged if all ports are plugged.
4585 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4586 states of the ports.
4587 @var{function} : reflects the return value of the @var{function}
4588 functions available per default
4589 'elmo-plug-on-by-servers
4590 : reflects the plugged state of the servers specified by the
4591 variable elmo-plug-on-servers.
4592 'elmo-plug-on-by-exclude-servers
4593 : reflects the plugged state of the servers that are not
4594 in elmo-plug-on-exclude-servers.
4595 elmo-plug-on-exclude-servers defaults to
4598 (system-name)without the domain part)
4604 (setq elmo-plugged-condition 'all)
4606 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4607 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4609 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4610 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4614 @item wl-reset-plugged-alist
4615 @vindex wl-reset-plugged-alist
4616 The initial setting is @code{t}. If non-nil, plugged states are
4617 initialized on a per server or port basis when Wanderlust starts up.
4619 If @code{nil}, plugged states are retained while Emacs is running. In
4620 other words, they are initialized when Emacs is restarted even if the
4621 value is @code{nil}.
4625 @node Expire and Archive, Scoring, Disconnected Operations, Top
4626 @chapter Automatic Expiration and Archiving of Messages
4627 @cindex Expire and Archive
4630 * Expire:: Expiration and Archiving
4631 * Archive:: Archiving All Messages
4635 @node Expire, Archive, Expire and Archive, Expire and Archive
4637 @cindex Expire Message
4639 Expiration means deletion of old messages which have outlasted a
4640 certain period of time.
4642 @code{wl-expire} supports not only simple deletion, but also moving to
4643 specified archiving folders.
4647 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4648 or @kbd{M-e} in the summary mode.
4650 @subsection Configuring @code{wl-expire-alist}
4652 An example configuration of @code{wl-expire-alist} is shown below.
4653 Everything in this @code{wl-expire-alist} makes a great difference in
4654 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4655 to @code{t}, especially in the initial stage.
4659 (setq wl-expire-alist
4660 '(("^\\+trash$" (date 14) remove)
4662 ("^\\+tmp$" (date 7) trash)
4663 ;; @r{re-file to @code{wl-trash-folder}}
4664 ("^\\+outbox$" (number 300) "$outbox;lha")
4665 ;; @r{re-file to the specific folder}
4667 ;; @r{do not expire}
4668 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4669 ;; @r{archive by message number (retaining numbers)}
4670 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4671 ;; @r{archive by a fixed number (retaining numbers)}
4672 ("^\\+diary$" (date 30) wl-expire-archive-date)
4673 ;; @r{archive by year and month (numbers discarded)}
4678 Items in the list has the format of:
4681 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4685 The folder is examined if it matches @var{regexp-for-folders} from the
4686 beginning of the list. If you invoke expiration on the folder that does
4687 not match any of them, nothing will happen. And if either the second or
4688 the third element of the item is @code{nil}, expiration will not take
4691 You can use any one of the following for
4692 @var{specification-of-message-to-be-deleted}:
4695 @item (number @var{n1} [@var{n2}])
4696 deletes messages depending on the number of messages in the folder.
4698 @var{n1} is the number of messages which should survive deletion, for example
4699 if its value is 500, the newest 500 messages survive and the rests are
4702 @var{n2} is the number of messages in the folder on which expiration should
4703 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4704 folders with 510 or more messages are expired.
4705 If you configured automatic expiration, frequently used folders may
4706 expire every time it receive messages, and you may be annoyed with the
4707 long delay in reading mail.
4708 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4709 expiration would not take place until a certain number of messages
4712 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4713 with important/new/unread) are not deleted.
4714 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4715 will expire so as to have 500 messages including such ones.
4716 Otherwise, it will have 500 messages except such ones.
4718 @item (date @var{d1})
4719 deletes messages depending on the dates.
4721 Messages dated @var{d1} or more days ago are deleted, for example if its
4722 value is seven, messages seven days old or more are deleted. Note that
4723 the date is the one in the @samp{Date:} field of the message, not when
4724 the message entered the folder.
4726 Messages with no or invalid @samp{Date:} field does not expire; you
4727 might have to delete them by hand.
4730 You can use any one of the following in the place of @var{destination}:
4734 deletes the messages instantly.
4737 moves the messages to @code{wl-trash-folder}.
4739 @item @var{string}(folder)
4740 moves the messages to the folder specified with @var{string}.
4742 It would be useful for specifying an archiving folder, but because this
4743 does not move important messages, it might be better to use the
4744 standard functions described below.
4746 @item @var{function}
4747 invokes the specified @var{function}.
4749 To the @var{function}, three arguments are passed: a folder name, a list
4750 of messages to be deleted, and msgdb information of the summary. You
4751 can specify function-specific arguments after the name of the
4752 @var{function}. Note that the list contains messages with marks in
4753 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4756 These are three standard functions; they moves messages to an archive
4757 folder in the specified way. This means old messages can be compressed
4758 and saved in a file, being deleted from the original folder.
4761 @item wl-expire-archive-number1
4762 re-files to archiving folders corresponding to the message numbers of
4763 the messages being deleted. For example, a message numbered 102 will be
4764 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4765 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4766 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4768 The archiving folders to which messages are re-filed are determined by
4769 the name of the folder as follows (in this case, archiving folders are
4770 handled as if @code{elmo-archive-treat-file} were non-nil).
4773 @item If the folder type is localdir:
4774 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4776 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4777 (@file{~/Mail/ml/wl-00100.zip}).
4779 @item The folder type is other than localdir:
4780 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4782 For example, @samp{%#mh/ml/wl} corresponds to
4783 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4786 As you can see, in the case of localdir, the folder type is not included
4787 in the path name, but otherwise it is included.
4788 And you can control the prefix to the archiving folder name by
4789 @code{wl-expire-archive-folder-prefix}.
4790 Refer to @code{wl-expire-archive-folder-prefix} for details.
4792 @item wl-expire-archive-number2
4793 re-files every certain number of messages to archiving folders.
4795 This differs from @samp{wl-expire-archive-number1} in that this re-files
4796 to the folder up to the specified number regardless of message numbers.
4797 The archiving folders to which messages are re-filed are determined in the
4798 same way as @code{wl-expire-archive-number1}.
4800 @item wl-expire-archive-date
4801 re-files messages depending on its date (year and month) to archive
4804 For example, a message dated December 1998 is re-filed to
4805 @code{$folder-199812;zip}. The name of the archiving folders except the
4806 date part are determined in the same way as
4807 @code{wl-expire-archive-number1}.
4810 You can set the first argument to these three standard functions to non-nil
4811 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4812 For example, it can be specified just after the name of the function:
4815 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4818 If you omit the argument, consecutive numbers from 1 are assigned for
4819 each archiving folder.
4822 @subsection Treatment for Important or Unread Messages
4824 If you specify any of @code{remove}, @code{trash}, a folder name, or a
4825 standard function, messages with marks in
4826 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
4827 messages} thereafter) are retained.
4829 Per default, this variable include the important, new, and unread marks,
4830 so that messages with these marks are not removed.
4831 Note that you cannot include the temporary mark (i.e. temporary marks
4832 are removed anyway), and be sure to process temporary marks before you
4835 @subsection Auto Expiration
4837 The following setup invokes expiration when you move into the summary
4838 mode. There will be no confirmation, so make sure you made no mistake
4839 in regexp and other settings before you set up this.
4843 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4847 In the folder mode, you can invoke expiration per group as well as per
4848 folder. Therefore, if you specify @samp{Desktop} group, all folders
4849 matching @code{wl-expire-alist} expire.
4853 @subsection Treating archive folders.
4854 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
4855 you must set non-nil value to @code{elmo-archive-treat-file}.
4857 @subsection Confirming
4859 If you are to use @code{remove}, try @code{trash} at first and see
4860 messages move to @code{wl-trash-folder} as expected, then replace it
4861 with @code{remove}. It would be dangerous to use @code{remove} from the
4864 If you are to use @code{wl-expire-archive-number1} and the like, try to
4865 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
4866 you can append messages to it. Even if settings in
4867 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
4868 would not be saved anywhere and disappeared in case the archiver program
4871 After you make sure you can archive to the folder correctly, you can
4872 invoke expiration and utilize the log.
4874 If you set @code{wl-expire-use-log} to @code{t},
4875 @file{~/.elmo/expired-log} should contain the log, for example:
4879 delete +ml/wl (593 594 595 596 597 598 599)
4880 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
4884 The first column indicates the operation, i.e. @samp{delete},
4885 @samp{copy}, or @samp{move}. The next is the name of the folder that
4886 expired. In the case of @samp{copy} and @samp{move}, the destination
4887 folder is recorded after @samp{->}. The last is the list of message
4888 numbers that are actually deleted or moved (in the case of @samp{copy}
4889 and @samp{move}, the number is the one in the source folder, rather than
4890 the destination folder).
4892 @subsection Re-filing Reserved Messages
4894 The three standard functions copy reserved messages to the archive
4895 folder, but do not delete them from the source folder. Because
4896 reserved messages and the like always remain, they are recorded in
4897 @file{~/.elmo/expired-alist} so that they are not copied over and over
4898 again. They are not recorded if copied by @code{wl-summary-archive}.
4900 If you enabled logging, usually @samp{move} is recorded for re-filing,
4901 but instead @samp{copy} and @samp{delete} are recorded separately if
4902 reserved messages are involved. This is because it actually copies
4903 messages including reserved, then deletes ones except reserved in that
4906 @section Customizable Variables
4909 @item wl-expire-alist
4910 @vindex wl-expire-alist
4911 The initial setting is @code{nil}.
4912 This variable specifies folders and methods to expire. For details,
4913 refer to @code{wl-expire-alist} settings above.
4915 @item wl-summary-expire-reserve-marks
4916 @vindex wl-summary-expire-reserve-marks
4917 The initial setting is the list below.
4921 (list wl-summary-important-mark
4923 wl-summary-unread-mark
4924 wl-summary-unread-uncached-mark
4925 wl-summary-unread-cached-mark)
4929 Messages with these marks are retained in the folder, even after
4931 Only permanent marks can be listed, not temporary marks.
4933 You can list marks one by one as in the default; you can use the
4934 following settings as well:
4938 All messages with permanent marks are retained,
4939 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
4943 All messages are handled as usual ones that are already read, no matter
4944 what marks they have; even important messages are deleted.
4947 @item wl-expire-archive-files
4948 @vindex wl-expire-archive-files
4949 The initial setting is 100.
4950 This variable specifies the number of messages to be retained in one
4953 @item wl-expire-number-with-reserve-marks
4954 @vindex wl-expire-number-with-reserve-marks
4955 The initial setting is @code{nil}.
4956 If non-nil, if expiring messages are specified by @code{number},
4957 messages with @code{wl-summary-expire-reserve-marks} are also retained.
4959 @item wl-expire-archive-get-folder-func
4960 @vindex wl-expire-archive-get-folder-func
4961 The initial setting is @code{wl-expire-archive-get-folder}.
4963 This variable specifies a function that returns the name of an archiving
4964 folder for standard functions in the place of @var{destination}.
4965 You can use the following three variables for simple modification of
4966 folder names; if you want more complex settings, define your own
4967 function in this variable.
4969 @code{wl-expire-archive-get-folder} can be customized by these
4972 @item @code{wl-expire-archive-folder-name-fmt}
4973 @item @code{wl-expire-archive-folder-type}
4974 @item @code{wl-expire-archive-folder-prefix}
4977 @item wl-expire-archive-folder-name-fmt
4978 @vindex wl-expire-archive-folder-name-fmt
4979 The initial setting is @samp{%s-%%05d;%s}.
4980 This is a @code{format} string for archiving folders used in
4981 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
4982 Note that you must specify the message number by @samp{%%d}, because it
4983 is parsed twice by @code{format}.
4985 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
4988 @item wl-expire-archive-date-folder-name-fmt
4989 @vindex wl-expire-archive-date-folder-name-fmt
4990 The initial setting is @samp{%s-%%04d%%02d;%s}.
4991 This is a @code{format} string for archiving folders used in
4992 @code{wl-expire-archive-date}. Note that you must specify the message
4993 number by @samp{%%d}, because it is parsed twice by @code{format}.
4994 There should be @samp{%%d} twice, one for the year and the other for the
4997 If you modify this, adjust
4998 @code{wl-expire-archive-date-folder-num-regexp} as well.
5000 @item wl-expire-archive-folder-type
5001 @vindex wl-expire-archive-folder-type
5002 The initial setting is @code{zip}.
5003 This variable specifies an archiver type of the archiving folders.
5005 @item wl-expire-archive-folder-prefix
5006 @vindex wl-expire-archive-folder-prefix
5007 The initial setting is @code{nil}.
5008 This variable specifies the prefix (directory structure) to archiving
5010 Exercise extreme caution in using this feature, as it has not been
5012 In the worst case, there is a fear of destructing archiving folders.
5016 There will be no prefix.
5019 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5020 @samp{$ml/wl-00000;zip;wl}.
5023 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5026 @samp{$ml/wl-00000;zip;ml/wl}.
5029 @item wl-expire-archive-folder-num-regexp
5030 @vindex wl-expire-archive-folder-num-regexp
5031 The initial setting is @samp{-\\([-0-9]+\\);}.
5032 This variable specifies the regular expression to be used for getting
5033 message numbers from multiple archiving folders specified by
5034 @code{elmo-list-folders}.
5035 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5037 @item wl-expire-archive-date-folder-num-regexp
5038 @vindex wl-expire-archive-date-folder-num-regexp
5039 The initial setting is @samp{-\\([-0-9]+\\);}.
5040 This is the regular expression to be used for getting message numbers
5041 from multiple archiving folders specified by @code{elmo-list-folders}.
5042 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5044 @item wl-expire-delete-oldmsg-confirm
5045 @vindex wl-expire-delete-oldmsg-confirm
5046 The initial setting is @code{t}.
5047 If non-nil, messages older than the one with the largest number will be
5048 deleted with confirmation.
5049 If @code{nil}, they are deleted without confirmation.
5051 This feature is valid only if non-nil is specified as a argument to the
5052 standard functions so as to retain numbers.
5054 @item wl-expire-use-log
5055 @vindex wl-expire-use-log
5056 The initial setting is @code{nil}.
5057 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5058 They are appended but not truncated or rotated automatically; you might
5059 need to remove it manually.
5061 @item wl-expire-add-seen-list
5062 @vindex wl-expire-add-seen-list
5063 The initial setting is @code{t}.
5065 If non-nil, when messages are re-filed by expiration, read/unread
5066 information is passed to the destination folder.
5068 However if you do not read the destination folder from Wanderlust,
5069 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5070 want to set this to @code{nil} if you are simply saving to some
5071 archiving folders. Even if its value is @code{nil}, messages in the
5072 archiving folders are simply treated as unread; it does not affect
5075 @item wl-expire-folder-update-msgdb
5076 @vindex wl-expire-folder-update-msgdb
5077 The initial setting is @code{t}.
5078 If @code{t}, in the folder mode, expiration is carried out after
5079 updating summary information. If you specified a list of regular
5080 expressions of folder names, summary information is updated for matching
5085 @node Archive, , Expire, Expire and Archive
5086 @section Archiving Messages
5088 @subsection Archiving Messages
5089 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5090 folders. If there are the archiving folders already, only new messages
5093 You can use @code{wl-archive-alist} in order to specify how messages are
5094 archived according to their folder names, as in @code{wl-expire-alist}.
5099 (setq wl-archive-alist
5100 '(("^\\+tmp$" wl-archive-date)
5101 ("^\\+outbox$" wl-archive-number2)
5102 (".*" wl-archive-number1)))
5106 Each item in the list has the following format:
5109 (@var{folders-regexp} @var{deleting-function})
5112 As you can see, you can only use a function after @var{folders-regexp}.
5113 Per default, there are three functions:
5116 @item @code{wl-archive-number1}
5117 @item @code{wl-archive-number2}
5118 @item @code{wl-archive-date}
5121 As inferred from their names, they work similarly to "expire" versions,
5122 other than the following points:
5125 @item No messages are deleted
5126 @item Message numbers are retained even if invoked without arguments
5129 These functions are good to archive all messages in a folder by their
5130 numbers or by their dates.
5131 These are also useful for backup or confirmation purposes before
5133 If you try to re-file them after they are archived, they are deleted but
5136 Per default, the archiving folders to which messages are copied are
5137 determined automatically by @code{wl-expire-archive-get-folder-func}.
5138 You can copy to a specific folder by invoking with a prefix argument,
5139 i.e. @kbd{C-u M-x wl-summary-archive}.
5141 Note that this feature has not been seriously tested, because you can
5142 simply copy to an archiving folder, for example by
5143 @code{wl-summary-copy-region}.
5145 The archiving folders are determined by the same logic as in
5146 @code{wl-summary-expire}; the following customizable variables are
5150 @item @code{wl-expire-archive-files}
5151 @item @code{wl-expire-archive-get-folder-func}
5152 @item @code{wl-expire-archive-folder-name-fmt}
5153 @item @code{wl-expire-archive-folder-type}
5154 @item @code{wl-expire-archive-folder-prefix}
5155 @item @code{wl-expire-archive-folder-num-regexp}
5158 @subsection Customizable Variables
5161 @item wl-archive-alist
5162 @vindex wl-archive-alist
5163 The initial setting is the list shown below:
5167 ((".*" wl-archive-number1))
5172 This variable specifies a function that copies to archiving folders.
5173 To the function, three arguments are passed: a folder name, a list of
5174 messages in the folder, and msgdb information of the summary.
5175 Needless to say, you can use your own function.
5179 @node Scoring, Customization, Expire and Archive, Top
5180 @chapter Score of the Messages
5182 @c @cindex Kill File
5184 Scoring is the function that associates a score (value) with each
5185 message, and marks as read or deletes from the summary according to it.
5187 You can put target or important marks on essential messages, or read marks
5188 on the ones you do not want to read, for example spam articles.
5190 This scoring function has a capability and a format similar to the one
5191 that Gnus has, although there are some unsupported features and
5192 Wanderlust specifics.
5193 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5196 * Score Commands:: Score Commands
5197 * Score File Format:: Score File Format
5201 @node Score Commands, Score File Format, Scoring, Scoring
5202 @section Score Commands
5203 @cindex Score Commands
5205 @subsection Score File Specification
5207 @code{wl-score-folder-alist} specifies score files or variables in which
5208 scores are defined, corresponding to folder names.
5212 (setq wl-score-folder-alist
5221 If paths to the score files are omitted, the directory specified in the
5222 variable @code{wl-score-files-dir} is assumed.
5224 No matter what you write in @code{wl-score-folder-alist}, the default
5225 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5226 read (it does not have to exist).
5227 Therefore, in the example above, the three score files,
5228 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5229 the folders that matches @samp{^-.*}.
5231 @subsection Scored Messages
5233 Scores are attached to the messages that are specified by
5234 @code{wl-summary-score-marks} temporarily when the summary is updated;
5235 when you exit from the summary, the scores are removed and reverts to
5238 @subsection Creation of Score Files
5240 In the summary buffer, move to an appropriate message and type @kbd{L}.
5241 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5242 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5244 This makes @minus{}1000 are scored for messages with the same
5245 @samp{Subject:} as the string you entered. That is, such a score file
5246 is created automatically.
5248 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5249 The score file you just made appears.
5250 This buffer is called @dfn{score editing buffer} thereafter.
5251 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5252 as you are previously; type @kbd{a}. Then a score entry for "From"
5254 In this way, you can create a score file easily either in the summary
5255 buffer or in the score editing buffer.
5257 By the way, you might be aware the numbers of key strokes are different
5258 between @kbd{s s p} and @kbd{a}.
5259 This is determined by @code{wl-score-header-default-entry}.
5260 This variable specifies the default score entries corresponding to
5262 For example, for "subject" field, a type and a time limit are prompted,
5263 but for "from" field, they are fixed upon automatically as substring and
5264 permanent respectively.
5265 However, score values can be modified by the prefix argument.
5266 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5269 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5270 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5271 erasing contents of the buffer deletes the score file being edited.
5275 @subsubsection Selecting Score Files
5277 You can change score files to which scores are appended by
5278 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5279 @code{wl-score-change-score-file}.
5281 @subsubsection Summing Up the Score
5283 If you add the same entries by @code{wl-summary-increase-score},
5284 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5285 scores for the entry is summed up.
5287 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5288 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5289 @minus{}1200 will be created as a result.
5291 @subsubsection Creating Thread Key
5293 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5294 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5296 @subsubsection Creating Followup Key
5298 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5299 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5300 at the cursor to @samp{References} key.
5301 If @code{wl-score-auto-make-followup-entry} is non-nil,
5302 @samp{Message-ID} of all messages to be followed up within dates
5303 specified by @code{wl-score-expiry-days}.
5305 @subsection Key Bindings
5310 @findex wl-summary-increase-score
5311 Increases the score for the current message.
5312 And the score entry is appended to the score file at the same moment.
5313 You can specify the score value by a prefix argument.
5317 @findex wl-summary-lower-score
5318 Decreases the score for the current message.
5319 And the score entry is appended to the score file at the same moment.
5320 You can specify the score value by a prefix argument.
5323 @kindex h R (Summary)
5324 @findex wl-summary-rescore
5325 Re-applies the scoring.
5326 However, already scored messages are not scored anew.
5329 @kindex h c (Summary)
5330 @findex wl-score-change-score-file
5331 Changes the score file currently selected.
5334 @kindex h e (Summary)
5335 @findex wl-score-edit-current-scores
5336 Edits the score file currently selected.
5337 If there are multiple score files, the previously specified one is
5341 @kindex h f (Summary)
5342 @findex wl-score-edit-file
5343 Edits an arbitrary score file and selects it.
5346 @kindex h F (Summary)
5347 @findex wl-score-flush-cache
5348 Erases caches associated to the score files that are read.
5349 If you modified score files directly (from other than Wanderlust), you
5350 need to re-read them after erasing the cache.
5353 @kindex h m (Summary)
5354 @findex wl-score-set-mark-below
5355 Specifies the criterion for scores to be marked as read.
5356 Messages with scores less than this value are marked as read.
5359 @kindex h x (Summary)
5360 @findex wl-score-set-expunge-below
5361 Specifies the criterion for scores to be deleted from the summary.
5362 Messages with scores less than this value are deleted.
5363 "Deleted" means it is not shown; they are not removed from the summary
5364 information or the folder.
5365 The deleted messages can be shown by rescan-noscore again.
5368 @subsection Key Bindings in the Score Editing Buffer
5372 @kindex C-c C-k (Score Mode)
5373 @findex wl-score-edit-kill
5374 Abandons the file being edited.
5377 @kindex C-c C-c (Score Mode)
5378 @findex wl-score-edit-exit
5379 Saves the file being edited, and quits from the edit mode.
5382 @kindex C-c C-p (Score Mode)
5383 @findex wl-score-pretty-print
5387 @kindex C-c C-d (Score Mode)
5388 @findex wl-score-edit-insert-date
5389 Inserts the number of dates from Dec. 31, 1 B.C.
5390 It is used for creating the third factor of time-limited scores.
5393 @kindex C-c C-s (Score Mode)
5394 @findex wl-score-edit-insert-header
5395 Inserts the header of the message selected in the summary buffer.
5398 @kindex C-c C-e (Score Mode)
5399 @findex wl-score-edit-insert-entry
5400 Inserts the score entry of the message selected in the summary buffer.
5403 @subsection Customizable Variables
5406 @item wl-summary-default-score
5407 @vindex wl-summary-default-score
5408 The initial setting is 0 (zero).
5409 This variable specifies the default value of the score.
5410 The score is increased or decreased based upon this value.
5412 @item wl-summary-important-above
5413 @vindex wl-summary-important-above
5414 The initial setting is @code{nil}.
5415 Messages with scores larger than this value are attached with the
5416 important mark (@samp{$}).
5417 If @code{nil}, no important marks are attached.
5419 @item wl-summary-target-above
5420 @vindex wl-summary-target-above
5421 The initial setting is @code{nil}.
5422 Messages with scores larger than this value are attached with the target
5424 If @code{nil}, no target marks are attached.
5426 @item wl-summary-mark-below
5427 @vindex wl-summary-mark-below
5428 The initial setting is 0 (zero).
5429 Messages with scores smaller than this value are marked as read.
5431 @item wl-summary-expunge-below
5432 @vindex wl-summary-expunge-below
5433 The initial setting is @code{nil}.
5434 Messages with scores smaller than this value are deleted from the
5436 If @code{nil}, they are not deleted.
5438 @item wl-summary-score-marks
5439 @vindex wl-summary-score-marks
5440 The initial setting is the list shown below:
5444 (list wl-summary-new-mark)
5449 Messages with these marks are scored.
5451 @item wl-use-scoring
5452 @vindex wl-use-scoring
5453 The initial setting is t.
5454 If non-nil, scoring is enabled.
5456 @item wl-score-files-dir
5457 @vindex wl-score-files-dir
5458 The initial setting is @file{~/.elmo/}.
5459 The default directory for score files.
5461 @item wl-score-interactive-default-score
5462 @vindex wl-score-interactive-default-score
5463 The initial setting is 1000.
5464 This value is used as a score when a score factor is @code{nil} in the
5465 score file. It is also used in @code{wl-summary-increase-score} and
5466 @code{wl-summary-lower-score}, on condition that the value of
5467 @code{wl-score-header-default-entry} is @code{nil}.
5469 @item wl-score-expiry-days
5470 @vindex wl-score-expiry-days
5471 The initial setting is 7.
5472 This is the number of days before time-limited scores are deleted.
5474 @item wl-score-update-entry-dates
5475 @vindex wl-score-update-entry-dates
5476 The initial setting is @code{t}.
5477 If non-nil, it enables deletion of time-limited scores.
5479 @item wl-score-header-default-entry
5480 @vindex wl-score-header-default-entry
5481 Specifies the default value for each header field for score entries
5482 created by @code{wl-summary-increase-score},
5483 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5485 @item wl-score-simplify-fuzzy-regexp
5486 @vindex wl-score-simplify-fuzzy-regexp
5487 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5488 regular expression to be deleted from the string.
5489 Because this is usually used for Subject, the default is prefixes that
5490 are attached by mailing list programs.
5492 @item wl-summary-rescore-partial-threshold
5493 @vindex wl-summary-rescore-partial-threshold
5494 The initial setting is 200.
5495 When sync-all or rescan is executed, if there are messages more than
5496 this value, only the last same number of messages as this value are
5499 @item wl-summary-auto-sync-marks
5500 @vindex wl-summary-auto-sync-marks
5501 If non-nil, unread/important marks are synchronized when the summary
5503 Unread marks reflect information on the IMAP4 server.
5504 Important marks reflect information on the IMAP4 server (flagged or
5505 not), and contents of @samp{'mark} folder.
5506 The initial setting is @code{t}.
5510 @node Score File Format, , Score Commands, Scoring
5511 @section Score File Format
5512 @cindex Score File Format
5514 The format of score files are the same as Gnus, and basically you can
5515 use Gnus score files as they are. But they are not fully compatible
5516 because some keys are not supported and there are Wanderlust specifics.
5517 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5522 ("for sale" -1000 nil s)
5523 ("profit" -1000 nil s))
5525 ("spam@@spamspamspam" -10000 nil s))
5527 ("my@@address" 3001 nil s))
5529 (1000000 -10 nil >))
5539 If the key is a string, it is the name of the header to be matched.
5540 The following keys are available:
5541 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5542 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5543 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5544 @code{Chars} and @code{Lines} mean the size and the number of lines of
5545 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5546 are described later.
5547 The rest corresponds the field of the same name.
5549 Arbitrary numbers of core entries are specified after the key.
5550 Each score entry consists of these five factors:
5554 A factor that matches header. This should be a number in the cases of
5555 @code{lines} and @code{chars}, otherwise a string.
5558 A score factor. When the first item matches, the score of the message
5559 is increased or decreased by this value.
5562 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5563 of a number, the score is deleted if it does not match for days
5564 (@code{wl-score-expiry-days}) from the date specified by this.
5565 The date is since Dec. 31, 1 B.C.
5568 A type factor. This specifies the way the first factor matches.
5569 Available types depend on keys.
5572 @item From, Subject, References, Message-ID
5573 For these keys in string, @code{r} and @code{R} (regexp),
5574 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5575 as well as @code{f} and @code{F} (fuzzy) can be used.
5576 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5579 For these keys, the following five numerical relative operators can be
5580 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5583 This key matches @code{From} header, and scores all follow-ups to the
5585 For example, it would be useful for increasing scores for follow-ups to
5588 You can use the same types as @code{From} except for @code{f}.
5589 And a @samp{Followup} entry is automatically appended to the score file.
5592 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5593 A @samp{Thread} entry is automatically appended for each article that
5594 has @var{x} in the @code{References} header.
5595 You can make sure the whole thread including messages that does not have
5596 all ancestors @code{Message-ID} in @code{References} is scored.
5598 You can use the same types as @code{References} except for @code{f}.
5599 And a @samp{Thread} entry is automatically appended to the score file.
5603 A factor for extension header. This is meaningful only if the key is
5605 This specifies headers to be matched other than standard headers like
5606 @code{Subject} and @code{From}.
5607 Note that you should specify the header in
5608 @code{elmo-msgdb-extra-fields} also.
5609 Therefore it does not work in folders where extension headers cannot be
5614 The sum of these scores @emph{after all factors are applied} becomes the
5615 score of the message.
5617 @cindex Score File Atoms
5619 Messages with a score less than this value is marked as read.
5620 The default is @code{wl-summary-mark-below}.
5623 Messages with a score less than this value is deleted from the summary.
5624 The default is @code{wl-summary-expunge-below}.
5626 @item mark-and-expunge
5627 Both @code{mark} and @code{expunge} are applied,
5628 i.e. messages with a score less than this value is marked as read and
5629 deleted from the summary.
5632 Messages with a score greater than this value is attached with temp
5634 The default is @code{wl-summary-target-above}.
5637 Messages with a score greater than this value is attached with important
5639 The default is @code{wl-summary-important-above}.
5644 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5645 are used, you need to set @code{elmo-msgdb-extra-fields}.
5648 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5651 There are other restrictions as shown below:
5654 @item Because @samp{References} field in the summary information
5655 contains only the last @samp{Message-ID}, @code{references} key matches
5659 Keys that can be seen by folder of types:
5663 chars lines xref extra
5664 localdir,localnews Y E E E
5665 nntp (supporting xover) Y E E N
5671 N: cannot be seen (ignored)
5672 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5677 @node Customization, Mailing List, Scoring, Top
5678 @chapter Customizing Wanderlust
5679 @cindex Customization
5682 * Living with other packages:: Living with other packages
5683 * Highlights:: Highlights
5684 * Biff:: Notify Mail arrival
5685 * Advanced Settings:: Advanced Settings
5686 * Customizable Variables:: Customizable Variables
5691 @node Living with other packages, Highlights, Customization, Customization
5692 @section Living with other packages
5694 Examples with other packages.
5697 * imput:: imput (im-wl.el)
5699 * supercite:: supercite.el
5700 * mu-cite:: mu-cite.el
5701 * x-face-mule:: x-face-mule.el
5702 * dired-dd:: dired-dd.el
5706 @node imput, BBDB, Living with other packages, Living with other packages
5711 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5714 If imput is on the @code{exec-path} at the installation, @file{im-wl.el}
5715 is byte-compiled and installed.
5720 (autoload 'wl-draft-send-with-imput-async "im-wl")
5721 (setq wl-draft-send-func 'wl-draft-send-with-imput-async)
5726 @node BBDB, supercite, imput, Living with other packages
5730 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
5733 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
5734 byte-compiled and installed.
5742 ;; @r{enable pop-ups}
5743 (setq bbdb-use-pop-up t)
5744 ;; @r{auto collection}
5745 (setq bbdb/mail-auto-create-p t)
5746 (setq signature-use-bbdb t)
5747 (setq bbdb-north-american-phone-numbers-p nil)
5748 ;; @r{shows the name of bbdb in the summary} :-)
5749 (setq wl-summary-from-func 'bbdb-wl-from-func)
5750 ;; @r{automatically add mailing list fields}
5751 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
5752 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
5756 @node supercite, mu-cite, BBDB, Living with other packages
5757 @subsection sc.el(supercite), sc-register.el
5761 The same setting as usual mailers should be OK. The following is an
5762 example of settings:
5766 (autoload 'sc-cite-original "sc" nil t)
5767 (setq mail-yank-hooks 'sc-cite-original)
5768 (setq sc-preferred-header-style 1)
5769 (setq sc-electric-references-p nil)
5770 (setq sc-citation-leader "")
5771 (setq sc-load-hook '(lambda () (require 'sc-register)))
5772 (setq sc-preferred-attribution 'registeredname)
5777 @node mu-cite, x-face-mule, supercite, Living with other packages
5778 @subsection mu-cite.el
5781 The same setting as usual mailers should be OK. The following is an
5782 example of settings.
5784 If you use mu-cite version 8.0 or earlier:
5788 (autoload 'mu-cite/cite-original "mu-cite" nil t)
5789 (setq mail-citation-hook 'mu-cite/cite-original)
5793 If you use mu-cite version 8.1 or later:
5797 (autoload 'mu-cite-original "mu-cite" nil t)
5798 (add-hook 'mail-citation-hook (function mu-cite-original))
5802 @node x-face-mule, dired-dd, mu-cite, Living with other packages
5803 @subsection x-face-mule.el
5807 It depends on the version of x-face-mule.
5808 If you use x-face-mule 0.19 or older, do the following:
5812 (setq wl-highlight-x-face-func
5815 (x-face-mule:x-face-decode-message-header))))
5819 If you use x-face-mule 0.20 or later, try the following:
5823 (setq wl-highlight-x-face-func
5826 (x-face-mule-x-face-decode-message-header))))
5827 (require 'x-face-mule)
5831 Use these settings when you use @file{x-face-mule.el} attached to
5832 bitmap-mule 8.0 or later:
5836 (autoload 'x-face-decode-message-header "x-face-mule")
5837 (setq wl-highlight-x-face-func 'x-face-decode-message-header)
5841 If there is an encoded X-Face string in a file @file{~/.xface} (the
5842 value of the variable @code{wl-x-face-file}), it is inserted as a
5843 @samp{X-Face:} field in the draft buffer (if
5844 @code{wl-auto-insert-x-face} is non-nil).
5847 @node dired-dd, , x-face-mule, Living with other packages
5848 @subsection dired-dd(Dired-DragDrop)
5849 @pindex Dired-DragDrop
5851 @cindex Drag and Drop
5853 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
5854 compose multi-part by simple Drag-and-Drop from dired to the draft
5855 buffer being edited in GNU Emacs (this feature is not Wanderlust
5856 specific, but general-purpose for tm/SEMI).
5860 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
5866 ;; @r{Set dired-x variables here.}
5867 ;; @r{To and flo@dots{}}
5869 (progn (require 'dired-dd)
5870 (require 'dired-dd-mime))))))
5875 @node Highlights, Biff, Living with other packages, Customization
5878 @subsection Customizable Variables
5881 @item wl-summary-highlight
5882 @vindex wl-summary-highlight
5883 The initial setting is @code{t}.
5884 If non-nil, the summary is highlighted.
5886 @item wl-highlight-max-summary-lines
5887 @vindex wl-highlight-max-summary-lines
5888 The initial setting is 10000.
5889 The summary is not highlighted if it has more lines than this value.
5891 @item wl-summary-highlight-partial-threshold
5892 @vindex wl-summary-highlight-partial-threshold
5893 The initial setting is 1000.
5894 This is a threshold whether the whole summary is highlighted.
5895 If there are more lines of messages in the summary, it is partially
5898 @item wl-summary-partial-highlight-above-lines
5899 @vindex wl-summary-partial-highlight-above-lines
5900 The initial setting is 30.
5901 If there are more lines of messages than
5902 @code{wl-summary-highlight-partial-threshold} in the summary, messages
5903 after the point that is the same number of lines as this value above the
5904 cursor line are highlighted partially.
5905 (If this value is nil, the last same number of lines as the value of
5906 @code{wl-summary-highlight-partial-threshold} are highlighted.)
5908 @item wl-highlight-body-too
5909 @vindex wl-highlight-body-too
5910 The initial setting is @code{t}.
5911 If non-nil, bodies of drafts and messages are also highlighted.
5913 @item wl-highlight-message-header-alist
5914 @vindex wl-highlight-message-header-alist
5915 When highlighting headers of drafts and messages, this variable
5916 specifies which faces are allocated to important
5917 (@code{wl-highlight-message-important-header-contents}), secondly
5918 important (@code{wl-highlight-message-important-header-contents2}), and
5919 unimportant (@code{wl-highlight-message-unimportant-header-contents})
5921 Similarly, it can be used for allocating arbitrary faces to arbitrary
5922 regular expressions.
5924 @item wl-highlight-citation-prefix-regexp
5925 @vindex wl-highlight-citation-prefix-regexp
5926 Specifies a regular expression to which quoted lines in bodies of
5927 drafts and messages match.
5928 Bodies matching to this regular expression are highlighted by the faces
5929 specified by (@code{wl-highlight-message-cited-text-*}).
5931 @item wl-highlight-highlight-citation-too
5932 @vindex wl-highlight-highlight-citation-too
5933 The initial setting is @code{nil}.
5934 If non-nil, the quoting regular expression itself given by
5935 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
5937 @item wl-highlight-citation-header-regexp
5938 @vindex wl-highlight-citation-header-regexp
5939 Specifies a regular expression that denotes beginning of quotation.
5940 Bodies matching to this regular expression are highlighted by the face
5941 specified by @code{wl-highlight-message-headers}.
5943 @item wl-highlight-max-message-size
5944 @vindex wl-highlight-max-message-size
5945 The initial setting is 10000.
5946 If a message is larger than this value, it will not be highlighted.
5947 With this variable, highlight is suppressed for uuencode or huge digest
5950 @item wl-highlight-signature-separator
5951 @vindex wl-highlight-signature-separator
5952 Specifies regular expressions that denotes the boundary of a signature.
5953 It can be a regular expression, or a list of ones.
5954 Messages after the place that matches this regular expression are
5955 highlighted by the face specified by
5956 @code{wl-highlight-message-signature}.
5958 @item wl-max-signature-size
5959 @vindex wl-max-signature-size
5960 The initial setting is 400.
5961 This is the largest size for a signature to be highlighted.
5963 @item wl-use-highlight-mouse-line
5964 @vindex wl-use-highlight-mouse-line
5965 The initial setting is @code{t}.
5966 If non-nil, the line pointed by the mouse is highlighted in the folder
5967 mode, summary mode, and the like.
5970 @subsection Setting Colors and Fonts of the Characters
5972 If you want to change colors or fonts of the characters, you need to
5973 modify faces defined in Wanderlust. Use @code{set-face-font} if you
5974 want to change fonts, and @code{set-face-foreground} for colors, and so
5975 on. You cannot write face settings in @file{.emacs}; write in
5978 For example, if you want to change the color for signatures to yellow,
5982 (set-face-foreground 'wl-highlight-message-signature "yellow")
5988 Faces defined in Wanderlust:
5991 @item wl-highlight-message-headers
5992 The face for field names of message headers.
5994 @item wl-highlight-message-header-contents
5995 The face for field bodies of message headers.
5997 @item wl-highlight-message-important-header-contents
5998 The face for important parts of message headers.
5999 Per default, this face is used for a body of @samp{Subject:} field.
6000 You can change its value by editing
6001 @code{wl-highlight-message-header-alist}.
6003 @item wl-highlight-message-important-header-contents2
6004 The face for secondly important parts of message headers.
6005 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6006 fields. You can change its value by editing
6007 @code{wl-highlight-message-header-alist}.
6009 @item wl-highlight-message-unimportant-header-contents
6010 The face for unimportant parts of message headers.
6011 Per default, this face is used for bodies of @samp{X-} fields
6012 @samp{User-Agent:} fields. You can change its value by editing
6013 @code{wl-highlight-message-header-alist}.
6015 @item wl-highlight-message-citation-header
6016 The face for headers of quoted messages.
6018 @item wl-highlight-message-cited-text-*
6019 The face for texts of quoted messages.
6020 The last @samp{*} is a single figure so that 10 different colors can be used
6021 according to citation levels.
6023 @item wl-highlight-message-signature
6024 The face for signatures of messages.
6025 The initial settings are khaki for light background colors, and
6026 DarkSlateBlue for dark background colors.
6028 @item wl-highlight-header-separator-face
6029 The face for header separators of draft messages.
6031 @item wl-highlight-summary-important-face
6032 The face for message lines with important marks in the summary.
6034 @item wl-highlight-summary-new-face
6035 The face for message lines with new marks in the summary.
6037 @item wl-highlight-summary-displaying-face
6038 The face for the message line that is currently displayed.
6039 This face is overlaid.
6041 @item wl-highlight-thread-indent-face
6042 The face for the threads that is currently displayed.
6044 @item wl-highlight-summary-unread-face
6045 The face for message lines with unread marks in the summary.
6047 @item wl-highlight-summary-deleted-face
6048 The face for message lines with delete marks in the summary.
6050 @item wl-highlight-summary-refiled-face
6051 The face for message lines with re-file marks in the summary.
6053 @item wl-highlight-refile-destination-face
6054 The face for re-file information part of message lines with re-file
6055 marks in the summary.
6057 @item wl-highlight-summary-copied-face
6058 The face for message lines with copy marks in the summary.
6060 @item wl-highlight-summary-target-face
6061 The face for message lines with target marks @samp{*} in the summary.
6063 @item wl-highlight-summary-thread-top-face
6064 The face for message lines that are on the top of the thread in the
6067 @item wl-highlight-summary-normal-face
6068 The face for message lines that are not on top of the thread in the
6071 @item wl-highlight-folder-unknown-face
6072 The face for folders that are not known to have how many unsync messages
6075 @item wl-highlight-folder-zero-face
6076 The face for folders that have no unsync messages in the folder mode.
6078 @item wl-highlight-folder-few-face
6079 The face for folders that have some unsync messages in the folder mode.
6081 @item wl-highlight-folder-many-face
6082 The face for folders that have many unsync messages in the folder mode.
6083 The boundary between `some' and `many' is specified by the variable
6084 @code{wl-folder-many-unsync-threshold}.
6086 @item wl-highlight-folder-unread-face
6087 The face for folders that have no unsync but unread messages in the
6090 @item wl-highlight-folder-killed-face
6091 The face for folders that are deleted from the access group in the
6094 @item wl-highlight-folder-opened-face
6095 The face for open groups in the folder mode.
6096 It is meaningful when @code{wl-highlight-group-folder-by-numbers} is
6097 @code{nil} or a number.
6099 @item wl-highlight-folder-closed-face
6100 The face for close groups in the folder mode.
6101 It is meaningful when @code{wl-highlight-group-folder-by-numbers} is
6102 @code{nil} or a number.
6104 @item wl-highlight-folder-path-face
6105 The face for the path to the currently selected folder in the folder
6108 @item wl-highlight-logo-face
6109 The face for logo in the demo.
6111 @item wl-highlight-demo-face
6112 The face for strings (for example, a version number) in the demo.
6116 @node Biff, Advanced Settings, Highlights, Customization
6117 @section Notify Mail arrival
6119 Following setting is to notify mail arrival of @samp{%inbox}
6120 by the indicator on the modeline
6123 (setq wl-biff-check-folder-list '("%inbox"))
6126 @subsection Customizable Variables
6128 @item wl-biff-check-folder-list
6129 @vindex wl-biff-check-folder-list
6130 The initial setting is @code{nil}.
6131 This is the list of folders to check mail arrival.
6132 If @code{nil}, wl doesn't check mail arrival.
6134 @item wl-biff-check-interval
6135 @vindex wl-biff-check-interval
6136 The initial setting is 40 (in seconds).
6137 Check mail arrival in this period.
6141 @node Advanced Settings, Customizable Variables, Biff, Customization
6142 @section Advanced Settings
6145 * Draft for Reply:: Draft for Reply
6146 * Thread Format:: Appearance of Thread
6147 * User-Agent Field:: @samp{User-Agent:} Header Field
6151 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6152 @subsection Draft for Replay
6154 If you want, when you replying to articles in mailing lists, the address
6155 in Reply-To field of the original message to be prepared to To field of
6156 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6161 (setq wl-draft-reply-without-argument-list
6162 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6163 ("Followup-To" . (nil nil ("Followup-To")))
6164 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6165 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6170 (Only if there are both of @samp{X-ML-Name} and @samp{Reply-To} fields in the
6171 original message, @samp{Reply-To} field in the original is copied to @samp{To:}
6174 Moreover, the behavior of @kbd{a} with prefix argument can
6175 be directed by @code{wl-draft-reply-with-argument-list} as well.
6177 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6178 @subsection Appearance of Threads
6182 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6183 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6184 391 09/18(Fri)19:24 +-[ Murata-san ]
6185 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6186 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6187 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6188 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6189 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6190 412 09/22(Tue)09:28 | +-[ Teranishi ]
6191 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6192 416 09/22(Tue)12:38 | +-[ Teranishi ]
6193 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6194 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6198 Settings to make appearance of threads like shown above:
6202 (setq wl-thread-indent-level 2)
6203 (setq wl-thread-have-younger-brother-str "+")
6204 (setq wl-thread-youngest-child-str "+")
6205 (setq wl-thread-vertical-str "|")
6206 (setq wl-thread-horizontal-str "-")
6207 (setq wl-thread-space-str " ")
6211 If you do not want to see branches, do the following:
6215 (setq wl-thread-indent-level 2)
6216 (setq wl-thread-have-younger-brother-str " ")
6217 (setq wl-thread-youngest-child-str " ")
6218 (setq wl-thread-vertical-str " ")
6219 (setq wl-thread-horizontal-str " ")
6220 (setq wl-thread-space-str " ")
6225 @node User-Agent Field, , Thread Format, Advanced Settings
6226 @subsection User-Agent Field
6228 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6229 @samp{User-Agent:} fields, define a function that generate appropriate
6230 strings as you like, and set it to
6231 @code{wl-generate-mailer-string-func}.
6233 If you do not want verbose @samp{User-Agent:} field, do the following:
6237 (setq wl-generate-mailer-string-func
6240 (let ((mime-edit-insert-user-agent-field nil))
6241 (wl-generate-user-agent-string)))))
6245 The following is a example:
6249 (setq wl-generate-mailer-string-func
6252 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6257 @node Customizable Variables, Hooks, Advanced Settings, Customization
6258 @section Customizable Variables
6260 Customizable variables that have not been described yet:
6263 @item wl-default-folder
6264 @vindex wl-default-folder
6265 The initial setting is @samp{%inbox}. This is the default value for moving to
6266 a folder and the like.
6268 @item wl-draft-folder
6269 @vindex wl-draft-folder
6270 The initial setting is @samp{+draft}. It is the folder to which drafts are
6271 saved. It must be a localdir folder.
6273 @item wl-trash-folder
6274 @vindex wl-trash-folder
6275 The initial setting is @samp{+trash}. It is the wastebasket folder.
6276 If you changed this variable, you had better restart Wanderlust.
6278 @item wl-interactive-exit
6279 @vindex wl-interactive-exit
6280 The initial setting is @code{t}.
6281 If non-nil, you are asked for confirmation when Wanderlust terminates.
6283 @item wl-interactive-send
6284 @vindex wl-interactive-send
6285 The initial setting is @code{nil}.
6286 If non-nil, you are asked for confirmation when mail is sent.
6288 @item wl-folder-sync-range-alist
6289 @vindex wl-folder-sync-range-alist
6290 The initial setting is the list shown below:
6295 ("^\\+draft$\\|^\\+queue$" . "all"))
6299 This is an associative list of regular expressions of folder names and
6300 update range of the summary. Update range is one of the @samp{all},
6301 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6302 @samp{last}. If a folder do not match, @samp{update} is used.
6305 @vindex wl-ask-range
6306 The initial setting is @code{t}.
6307 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6308 for updating the summary when you changed folders.
6310 @item wl-mime-charset
6311 @vindex wl-mime-charset
6312 The initial setting is @code{x-ctext}.
6313 This is the MIME charset for messages that are not MIME (e.g. without
6314 @samp{Content-Type:}). This value also used as default charset for
6315 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6316 this value as @code{iso-2022-jp}.)
6318 @item wl-highlight-folder-with-icon
6319 @vindex wl-highlight-folder-with-icon
6320 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6321 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6323 @item wl-strict-diff-folders
6324 @vindex wl-strict-diff-folders
6325 This is a list of regular expressions of folders.
6326 Unread messages are checked, for example when you press @kbd{s} in
6327 the folder mode, usually in a brief way (rapidly processed but not
6329 The folders matching this variable are seriously checked.
6330 You may want to set this variable so as to match conditional filter
6331 folders for IMAP4 folders.
6332 The initial setting is @code{nil}.
6334 @item wl-folder-use-server-diff
6335 @vindex wl-folder-use-server-diff
6336 When unread messages are checked, for example when you press @kbd{s} in
6337 the folder mode, usually (the number of messages on the server) @minus{}
6338 (the number of local messages) will be the number of unread messages.
6339 However, if this variable is non-nil, the number of unread messages on
6340 the server is checked. This affects IMAP4 folders only, but IMAP4
6341 folders in mail boxes matching
6342 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6343 the number of unread messages on the server, even if they matches this
6344 variable. The initial setting is @code{t}.
6346 @item wl-auto-check-folder-name
6347 @vindex wl-auto-check-folder-name
6348 The initial setting is @code{nil}.
6349 If non-nil, the folder with the name of the value is checked for unread
6350 messages at the start.
6351 If it is @code{none}, no folders are checked.
6352 If it is a list, all folders in the list are checked at the start.
6354 @item wl-auto-uncheck-folder-list
6355 @vindex wl-auto-uncheck-folder-list
6356 The initial setting is the list shown below:
6365 Folders with the name matching this variable are not checked for unread
6366 messages at the start, even if they are included in the groups in
6367 @code{wl-auto-check-folder-name}.
6369 @item wl-auto-check-folder-list
6370 @vindex wl-auto-check-folder-list
6371 The initial setting is @code{nil}.
6372 Folders with the name matching this variable are always checked for
6373 unread messages at the start, if they are included in the groups in
6374 @code{wl-auto-check-folder-name}.
6375 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6377 @item wl-no-save-folder-list
6378 @vindex wl-no-save-folder-list
6379 The initial setting is the list shown below:
6388 This is a list of regular expressions of folders not to be saved.
6390 @item wl-save-folder-list
6391 @vindex wl-save-folder-list
6392 The initial setting is @code{nil}.
6393 This is a list of regular expressions of folders to be saved.
6394 This takes precedence over @code{wl-no-save-folder-list}.
6396 @item wl-folder-mime-charset-alist
6397 @vindex wl-folder-mime-charset-alist
6398 The initial setting is the list shown below:
6402 (("^-alt\\.chinese" . big5)
6403 ("^-relcom\\." . koi8-r)
6405 ("^-han\\." . euc-kr))
6410 This is an associative list of regular expressions of folder names and
6412 If a folder do not match, @code{wl-mime-charset} is used.
6414 @item wl-folder-init-load-access-folders
6415 @vindex wl-folder-init-load-access-folders
6416 The initial setting is @code{nil}.
6417 This is a list of access groups to be loaded specifically at the start.
6418 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6420 @item wl-folder-init-no-load-access-folders
6421 @vindex wl-folder-init-no-load-access-folders
6422 The initial setting is @code{nil}.
6423 This is a list of access groups not to be loaded specifically at the
6425 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6427 @item wl-delete-folder-alist
6428 @vindex wl-delete-folder-alist
6429 The initial setting is the list shown below:
6438 This list determines disposition of messages with delete marks.
6439 Each item in the list is a folder and destination; you can specify any
6440 one of the following in the place of destination:
6443 'remove or 'null : deletes the messages instantly.
6444 string : moves the messages to the specific folder.
6445 'trash or others : moves the messages to `wl-trash-folder'.
6448 @item wl-refile-policy-alist
6449 @vindex wl-refile-policy-alist
6450 The initial setting is the list shown below:
6460 This list determines whether messages with re-file marks are moved or
6461 copied. Each item in the list is a cons cell of a folder and
6462 @code{copy} or @code{move}.
6464 @item wl-x-face-file
6465 @vindex wl-x-face-file
6466 The initial setting is @file{~/.xface}.
6467 The name of the file that contains encoded X-Face strings.
6470 @item wl-demo-display-logo
6471 @vindex wl-demo-display-logo
6472 If non-nil, bitmap image is shown on the opening demo. If you set
6473 @code{xpm} or @code{xbm}, (if possible) display selected image type
6476 @item elmo-use-database
6477 @vindex elmo-use-database
6478 This is meaningful for XEmacs only. The initial setting depends on
6479 XEmacs (@code{t} for XEmacs with dbm).
6480 If non-nil, Message-ID is controlled by dbm.
6482 @item elmo-passwd-alist-file-name
6483 @vindex elmo-passwd-alist-file-name
6484 The initial setting is @file{passwd}.
6485 This is the name of the file in which passwords are saved.
6486 @code{elmo-passwd-alist-save} saves current passwords to the file.
6488 @item elmo-nntp-list-folders-use-cache
6489 @vindex elmo-nntp-list-folders-use-cache
6490 The initial setting is 600 (in seconds).
6491 This is period in seconds during which results of @samp{list} and
6492 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6495 @item elmo-nntp-max-number-precedes-list-active
6496 @vindex elmo-nntp-max-number-precedes-list-active
6497 The initial setting is @code{nil}.
6498 If non-nil, the number of article obtained by @samp{list active} in NNTP
6499 are used as the maximum article number of the folder.
6500 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6501 and if the number of read messages is not correct.
6503 @item elmo-nntp-default-use-listgroup
6504 @vindex elmo-nntp-default-use-listgroup
6505 The initial setting is @code{t}.
6506 If non-nil, @samp{listgroup} is used for checking the total number of
6507 articles. If it is @code{nil}, @samp{group} is used. In the latter
6508 case, the processing will be a little faster at the sacrifice of
6511 @item elmo-pop3-send-command-synchronously
6512 @vindex elmo-pop3-send-command-synchronously
6513 The initial setting is @code{nil}.
6514 If non-nil, POP3 commands are issued synchronously. Some implementation
6515 of POP3 server fails to get summary information without this setting.
6516 You may have to set this variable to @code{t}, if the process hangs
6517 while looking up POP3.
6519 @item elmo-dop-flush-confirm
6520 @vindex elmo-dop-flush-confirm
6521 The initial setting is @code{t}.
6522 If non-nil, you are asked for confirmation if accumulated off-line
6523 operations are executed.
6525 @item elmo-display-progress-threshold
6526 @vindex elmo-display-progress-threshold
6527 The initial setting is 20.
6528 Threshold for display of progress gauge. If number of renewal is more than
6529 this value, display progress gauge.
6533 @node Hooks, , Customizable Variables, Customization
6539 @node Mailing List, Addition, Customization, Top
6540 @chapter Wanderlust Mailing List
6545 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6548 Topics related to Wanderlust are discussed in the mailing list.
6549 The latest version is also announced there (in Japanese, sorry).
6551 A guide can be obtained automatically by sending mail to
6552 @t{wl-ctl@@lists.airs.net} with the body
6557 Please send bug reports or patches to the mailing list.
6558 You can post to the mailing list even though you are not a member of it.
6560 If you send a bug report, please attach Backtrace with it.
6561 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to in Japanese.}
6563 I would like to express my thanks to the members of the mailing list for
6564 valuable advice and many pieces of code they contributed.
6567 @node Addition, Index, Mailing List, Top
6568 @chapter Additional Information
6570 @section Brief History
6573 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6574 3/10 Made a msgdb mechanism by elisp.
6575 3/26 IMAP and NNTP can be displayed in threads.
6576 4/13 Began to assemble thread display modules as elmo.
6577 5/01 Finished 0.1.0, initial version with many defects.
6578 6/12 I made a slip of the tongue and said I was writing elisp
6579 mailer supporting IMAP
6580 6/16 0.1.3 was announced at tm-ja, elisp ML.
6581 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6582 7/01 Support for mm-backend (0.3.0).
6583 8/25 multi folder added (0.5.0).
6584 8/28 filter folder added (0.5.1).
6585 9/10 You can open/close threads (0.6.0).
6586 9/11 fldmgr by Murata-san made editing folders easy.
6587 9/18 lha folders added by Okunishi-san (0.6.3).
6588 9/24 Display of branches of threads (0.6.5).
6589 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6590 10/28 Off-line operations (0.7.4).
6591 12/09 Becomes beta version.
6592 12/21 wl-expire by Murata-san.
6593 1999 2/03 auto-refile by Tsumura-san.
6594 4/28 wl-template by Murata-san.
6595 5/18 Released 1.0.0 stable.
6596 7/05 Scoring by Murata-san (2.1.0).
6597 9/26 New plugged system by Murata-san (2.2.2).
6598 12/20 Support Modified UTF7.
6599 2000 3/24 Released 1.1.0 stable.
6600 4/03 CVS development started.
6601 5/07 Thread restoration & Its speed up with Murata-san.
6602 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6603 7/11 killed message feature.
6604 7/18 Use UIDL in POP3.
6605 9/12 biff feature with Satata-san & Yamaoka-san.
6608 See @file{ChangeLog} for details.
6612 According to a dictionary, Wanderlust has the meaning:
6616 n eager longing for or impulse towards travelling in distant lands
6617 [Ger, fr wandern to wander + lust desire, pleasure]
6621 but I had no profound intention. (if farfetched, IMAP @result{} you can
6622 read mail anywhere @result{} desire to wander ?)
6624 Elmo is the abbreviation of @samp{Elisp Library for Message
6625 Orchestration}. At first I meant the red puppet in the Sesame Street,
6626 but you may associate it with Wandering @result{} Drifting @result{}
6627 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6631 Each versions has code names (they are almost jokes).
6632 Currently they are picked up alphabetically from the top 40 hits of
6633 U.S. Billboard magazines in 1980s.
6635 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
6638 @node Index, , Addition, Top
6642 * Concept Index:: Concept Index
6643 * Key Index:: Key Index
6644 * Variable Index:: Variable Index
6645 * Function Index:: Function Index
6648 @node Concept Index, Key Index, Index, Index
6649 @unnumberedsec Concept Index
6652 @node Key Index, Variable Index, Concept Index, Index
6653 @unnumberedsec Key Index
6656 @node Variable Index, Function Index, Key Index, Index
6657 @unnumberedsec Variable Index
6660 @node Function Index, , Variable Index, Index
6661 @unnumberedsec Function Index