1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
11 @dircategory GNU Emacs Lisp
13 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
16 @c permissions text appears in an Info file before the first node.
18 This file documents Wanderlust, Yet another message interface on
21 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
22 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
23 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada},
24 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
26 This edition is for Wanderlust version @value{VERSION}.
28 Permission is granted to make and distribute verbatim copies of this
29 manual provided the copyright notice and this permission notice are
30 preserved on all copies.
33 Permission is granted to process this file through TeX and print the
34 results, provided the printed document carries copying permission notice
35 identical to this one except for the removal of this paragraph (this
36 paragraph not being relevant to the printed manual).
39 Permission is granted to copy and distribute modified versions of this
40 manual under the conditions for verbatim copying, provided that the
41 entire resulting derived work is distributed under the terms of a
42 permission notice identical to this one.
44 Permission is granted to copy and distribute translations of this manual
45 into another language, under the above conditions for modified versions.
51 @title Wanderlust User's Manual
52 @subtitle Yet another message interface on Emacsen
53 @subtitle for Wanderlust version @value{VERSION}
54 @author Yuuichi Teranishi
55 @author Fujikazu Okunishi
56 @author Masahiro Murata
58 @author Kaoru Takahashi
60 @author Masayuki Osada
61 @author Katsumi Yamaoka
63 @author Yoichi Nakayama
66 @vskip 0pt plus 1filll
67 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
68 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
69 @w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
70 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
72 This manual is for Wanderlust version @value{VERSION}.
74 Permission is granted to make and distribute verbatim copies of this
75 manual provided the copyright notice and this permission notice are
76 preserved on all copies.
78 Permission is granted to copy and distribute modified versions of this
79 manual under the conditions for verbatim copying, provided that the
80 entire resulting derived work is distributed under the terms of a
81 permission notice identical to this one.
83 Permission is granted to copy and distribute translations of this manual
84 into another language, under the above conditions for modified versions.
90 @node Top, Introduction, (dir), (dir)
91 @top Wanderlust User's Manual
106 This manual is for Wanderlust @value{VERSION}.
111 * Introduction:: Read this first
112 * Start Me Up:: Invoking Wanderlust
113 * Folders:: How to specify folders
114 * Folder:: Selecting and editing folders
115 * Summary:: Reading and refiling messages
116 * Message:: Saving and playing MIME multipart entities
117 * Draft:: Draft buffer, sending mail and news
118 * Disconnected Operations:: Off-Line management
119 * Expire and Archive:: Automatic expiration and archiving of messages
120 * Scoring:: Score of the messages
121 * Split messages:: Splitting messages
122 * Address Book:: Management of Address Book
123 * Spam Filter:: Spam filtering
124 * Batch Processing:: Invoke commands in batch mode
125 * Customization:: Customizing Wanderlust
126 * Migration:: Switch from older version of Wanderlust
127 * Terminology:: Terminologies
128 * Mailing List:: Wanderlust mailing list
129 * Addition:: Additional Information
134 @node Introduction, Start Me Up, Top, Top
135 @chapter Introduction of Wanderlust
138 Wanderlust is an mail/news management system on Emacsen.
139 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
141 The main features of Wanderlust:
144 @item Pure elisp implementation.
145 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
146 @item Unified access method to messages based on Mew-like Folder Specification.
147 @item Mew-like Key-bind and mark handling.
148 @item Manages unread messages.
149 @item Interactive thread display.
150 @item Folder Mode shows the list of subscribed folders.
151 @item Message Cache, Disconnected Operation.
152 @item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed).
153 @item MIME compliant (by SEMI).
154 @item Transmission of news and mail are unified by Message transmitting draft.
155 @item Graphical list of folders (XEmacs and Emacs 21).
156 @item View a part of message without retrieving the whole message (IMAP4).
157 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
158 @item Virtual Folders.
159 @item Supports compressed folder using common archiving utilities.
160 @item Old articles in folders are automatically removed/archived (Expiration).
161 @item Automatic re-file.
162 @item Template function makes it convenient to send fixed form messages.
168 We confirm Wanderlust works on following Emacsen:
171 @item Mule 2.3 based on Emacs 19.34
172 @item Emacs 20.2 or later
173 @item XEmacs 20.4 or later
174 @item Meadow 1.00 or later
175 @item NTEmacs 20.4 or later
179 IMAP4 connectivity with following imapd are confirmed to work with
183 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
184 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
185 @item Courier-IMAP 1.3.2 or later
186 @item AIR MAIL (AIRC imapd release 2.00)
188 @item Microsoft Exchange Server 5.5
189 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
192 LDAP connectivity with following LDAPd are confirmed to work with
196 @item OpenLDAP 2.0.6 or later
200 @node Start Me Up, Folders, Introduction, Top
201 @chapter Start up Wanderlust
204 The necessary procedure for starting Wanderlust is explained in steps
207 (Of course, you need a mail/news readable environment in advance)
210 * MIME Modules:: Installing the MIME modules
211 * Download:: Download and extract the packages
212 * Install:: Byte-compile and install
213 * Minimal Settings:: @file{.emacs} setup
214 * Folder Definition:: Folder definition
215 * Start Wanderlust:: Starting Wanderlust
216 * Overview:: Basic components of Wanderlust
220 @node MIME Modules, Download, Start Me Up, Start Me Up
221 @section Installing MIME modules
227 You must install SEMI beforehand to use Wanderlust.
229 SEMI can be downloaded from following site:
233 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
237 You need packages named APEL and FLIM to use SEMI.
238 You can download APEL and FLIM from following URLs:
242 APEL: ftp://ftp.m17n.org/pub/mule/apel/
243 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
247 You have to install APEL, FLIM and SEMI in this order. Generally,
248 @samp{make install} will do the job. (In XEmacs 21, @samp{make
251 Refer to the documents of each package for detailed installation
252 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
253 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
257 Recommended combination of APEL, FLIM and SEMI are following:
260 @item APEL 10.6, FLIM 1.14.6 and SEMI 1.14.6
263 You can also use many other FLIM/SEMI variants. Combination of the
264 latest versions should work. For example, the following combination are
268 @item APEL 10.6, SLIM 1.14.9, SEMI 1.14.5
269 @item APEL 10.6, CLIME 1.14.5, EMIKO 1.14.1
272 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
275 @node Download, Install, MIME Modules, Start Me Up
276 @section Download and Extract the Package
279 You can download Wanderlust package from following sites:
283 ftp://ftp.gohome.org/wl/
286 Mirrored ftp/http sites:
290 @c ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
291 http://www.jpl.org/elips/wl/
292 http://www.ring.gr.jp/archives/text/elisp/wl/
293 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
297 Extract the obtained package to your working directory:
302 % tar zxvf wl-@var{version}.tar.gz
303 % cd wl-@var{version}
307 @subsection To use SSL (Secure Socket Layer)
312 SSL (Secure Socket Layer) can be used for
313 SMTP, IMAP, NNTP and POP connections in Wanderlust.
315 There are two ways to use SSL. One is to start SSL negotiation just
316 after the connection establishment (generic way). The other one is to
317 start SSL negotiation by invoking STARTTLS command in the each session.
319 To use the formal SSL (generic SSL), you must set @env{PATH} to the
320 directory that OpenSSL commands are installed.
322 To use the latter SSL(STARTTLS), you must install starttls package in
324 You can download starttls package from the following site.
327 ftp://opaopa.org/pub/elisp/
330 @node Install, Minimal Settings, Download, Start Me Up
331 @section Byte-compile and install
338 @subsection Installation
340 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
341 Set the Emacs's command name to @code{EMACS}.
342 Set package installation directory to @code{LISPDIR}.
343 Then, please execute following commands.
352 Destination directory is auto-probed if you leave @code{LISPDIR}
353 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
355 If you are using an Emacs variant which does not merge specified directory
356 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
357 then you will see the error message:
360 Cannot open load file: mime-setup
364 In this case, either add destination directories of custom, APEL, FLIM
365 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
366 @code{load-path} in @file{WL-CFG} in extracted directory.
368 If you want to handle shimbun folders or to use BBDB, add directory
369 where emacs-w3m or BBDB is installed to @code{load-path}. Then necessary
370 modules will be byte-compiled and installed.
371 @xref{Shimbun Folder}, @xref{BBDB}.
373 @subsection @file{WL-CFG}
375 Contents of the file @file{WL-CFG} is loaded under installation if a file
376 with that name exists in extracted directory. You can use @file{WL-CFG} to
377 configure @code{load-path} to extra packages such as SEMI if needed.
379 If you want to specify the install directory of Wanderlust related
380 files, then set following variables in @file{WL-CFG}
384 A directory to install WL modules.
385 This directory is relative directory from @code{LISPDIR}.
386 WL modules include @file{wl*.el}, @file{wl*.elc} files.
387 @c Modules under the directory @file{util/} are also installed if
388 @c it detected as necessary.
391 A directory to install ELMO modules.
392 This directory is relative directory from @code{LISPDIR}.
393 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
394 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
398 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
400 If you want to install ELMO related files under a sub-directory
401 such as "elmo" then add following to @file{WL-CFG}:
404 (setq ELMO_PREFIX "elmo")
407 @subsection Install as a XEmacs package
408 @cindex XEmacs package
409 @cindex XEmacs package install
410 @cindex Package, XEmacs
411 @cindex Package install, XEmacs
412 @c @cindex install-package
414 It is possible to install Wanderlust as one of packages of XEmacs (21.0
415 or later). Configuration for autoload and icon-path in local
416 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
419 Follow the next example to install Wanderlust as an XEmacs package.
425 % make install-package
429 package directory is auto-probed, if SEMI is installed.
430 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
432 @subsection Run in place
434 If wl and elmo directories are defined in @code{load-path}, then
435 byte-compilation and installation are not necessary to start Wanderlust.
436 For example, if package is extracted in @file{~/work}, Wanderlust can be
437 invoked with following setting in @file{~/.emacs}.
441 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
442 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
448 Manual is described in Info format. Please do following.
457 If you install Wanderlust as a XEmacs package, Info file is already
458 installed too, so there are no need of these commands.
460 Manual directory is automatically detected. Of course, it can be
461 configured by @code{INFODIR} in @file{Makefile}.
463 You can read manual at the following URL:
466 http://www.gohome.org/wl/doc/wl_toc.html
469 @node Minimal Settings, Folder Definition, Install, Start Me Up
470 @section Set up .emacs
471 @cindex Minimal Settings
473 @cindex Configuration
477 The Wanderlust package contains two module groups.
480 @item ELMO (elmo-*.el)
481 These modules show everything as folders. This is the back-end for WL.
483 These modules controls the behavior of main body of Wanderlust.
484 They are also the front-end for ELMO.
487 You can customize the behavior of Wanderlust by changing the value
488 of environmental variables which begins with @code{elmo-} and @code{wl-}.
490 The minimal requirement for settings is as the following.
494 ;; @r{autoload configuration}
495 ;; @r{(Not required if you have installed Wanderlust as XEmacs package)}
496 (autoload 'wl "wl" "Wanderlust" t)
497 (autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
498 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
500 ;; @r{Directory where icons are placed.}
501 ;; @r{Default: the peculiar value to the running version of Emacs.}
502 ;; @r{(Not required if the default value points properly)}
503 (setq wl-icon-directory "~/work/wl/etc")
505 ;; @r{SMTP server for mail posting. Default: @code{nil}}
506 (setq wl-smtp-posting-server "your.smtp.example.com")
507 ;; @r{NNTP server for news posting. Default: @code{nil}}
508 (setq wl-nntp-posting-server "your.nntp.example.com")
512 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
513 file exists). So it is convenient to gather Wanderlust specific settings
514 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
515 because you can't write them in @file{.emacs}
516 (if you write it to @file{.emacs}, you'll get an error).
519 All above described settings except autoload configuration can be written
522 @subsection @code{mail-user-agent}
523 @cindex Default Mailer
524 @cindex Mailer, Default
525 @vindex mail-user-agent
528 If you write following setting in your @file{~/.emacs}, you can
529 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
530 This means it enables you to run Wanderlust as a default mail composer
533 It is effective only when your Emacs can define @code{mail-user-agent}.
534 @xref{Mail Methods, , ,emacs, The Emacs Editor}.
538 (autoload 'wl-user-agent-compose "wl-draft" nil t)
539 (if (boundp 'mail-user-agent)
540 (setq mail-user-agent 'wl-user-agent))
541 (if (fboundp 'define-mail-user-agent)
542 (define-mail-user-agent
544 'wl-user-agent-compose
553 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
554 @section Folder Definition
555 @cindex Folder Definition
558 You can skip this section because it is possible to add/edit the
559 subscribe folders from the buffer for list of folders.
560 @xref{Folder Manager}.
562 Define the folders you want to subscribe in file @file{~/.folders}. The
563 contents written in @file{~/.folders} become the folders which you
564 subscribe to as it is.
566 Format for @file{~/.folders} is very simple. Here is an example:
571 # @r{Lines begin with @samp{#} are comment.}
572 # @r{Empty lines are ignored}
574 # @var{folder name} "@var{folder nickname}"
575 # @r{(nicknames are not necessary)}
580 %#mh/Backup@@my.imap.example.com "Sent"
583 %#mh/spool/wl "Wanderlust ML"
584 %#mh/spool/elips "ELIPS ML"
585 %#mh/spool/apel-ja "APEL Japanese ML"
586 %#mh/spool/xemacs-beta "XEmacs beta"
587 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
588 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
591 # @r{If folder name ends with @samp{/}, that means an `access group',}
592 # @r{all subfolders automatically included in one folder group.}
594 %#mh/expire@@localhost /
595 # @r{All MH folders are included in one folder group.}
600 Each line contains one folder you want to read. The definition of
601 folders will be explained in detail in the next section.
603 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
604 become one folder group. One folder group is treated as a directory
605 which can be opened and closed in folder mode. It is convenient for
606 collecting some folders and putting them in order.
608 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
609 line and you have to write it that way (It is because the parser sucks).
611 There are two types of groups. One is like @samp{Emacsen} from above
612 example which the user chooses his favorite folders as a group.
614 The other one is @dfn{access group} like @samp{+ /} from above example.
615 It collects all sub-folders in the folder to make a group. (Its
616 behavior differs by the type of the folder. For example, @samp{+}
617 followed by @samp{/} makes entire MH sub-directories to one group)
619 This behavior is better understood if you try it and confirmed the
620 function first. You can write and try a small folder definition, so you
621 will know the idea of the folder function before writing the real one.
623 @node Start Wanderlust, Overview, Folder Definition, Start Me Up
624 @section Start Wanderlust
625 @cindex Start Wanderlust
627 If installation and configuration worked well, you can invoke Wanderlust by
628 typing following command in Emacs.
635 After initialization, Folder Mode which shows the list of folders will
636 appear. That means the folders you defined in the @file{~/.folders} are
639 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
640 can skip folder checking.
643 @node Overview, , Start Wanderlust, Start Me Up
647 Basically, you will handle messages in wanderlust while you come and go
648 from/to each of the following buffers. Details of each ones are
649 explained in following chapters.
653 You can see the list of folders. You can select some folder and go into the summary
654 of it. You can subscribe new folder or edit subscription list.
656 You can see the list of messages in the folder. You can select message
657 and view its contents, and reply to some message. You can delete ones or
658 move ones to another folder.
660 You can see the contents of the message. You can save part to disk or
661 open in external programs.
663 You can edit message.
667 @node Folders, Folder, Start Me Up, Top
668 @chapter Wanderlust's folders
671 This chapter describes the folder types which Wanderlust is able to handle.
673 Wanderlust uses ELMO as it's interface, so you can use every folder types
676 As of version @value{VERSION}, 14 types of folders are predefined. These
677 are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP,
678 Shimbun, Namazu, Multi, Filter, Pipe, Internal and File folder types.
681 * IMAP Folder:: @samp{%} -- IMAP folder
682 * NNTP Folder:: @samp{-} -- NNTP folder
683 * MH Folder:: @samp{+} -- MH folder
684 * Maildir Folder:: @samp{.} -- Maildir folder
685 * News Spool Folder:: @samp{=} -- News spool folder
686 * Archive Folder:: @samp{$} -- Archive folder
687 * POP Folder:: @samp{&} -- POP folder
688 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
689 * Namazu Folder:: @samp{[} -- Namazu Folder
690 * Multi Folder:: @samp{*} -- Multi folder
691 * Filter Folder:: @samp{/} -- Filter folder
692 * Pipe Folder:: @samp{|} -- Pipe folder
693 * Internal Folder:: @samp{'} -- Internal folder
694 * File Folder:: -- File folder
698 @node IMAP Folder, NNTP Folder, Folders, Folders
706 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
712 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
716 You can specify @code{login} (encoded password transmission),
717 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
718 authentication) or @code{clear} (or @code{nil}, plain password
719 transmission) as @var{authenticate-type}.
724 @var{username} -> The value of @code{elmo-imap4-default-user}.
725 Initial setting is @env{USER} environment variable or
726 @env{LOGNAME} environment variable or return value of
727 @code{(user-login-name)}.
728 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
729 Initial setting is "auth".
730 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
731 Initial setting is "localhost".
732 @var{port} -> The value of @code{elmo-imap4-default-port}.
733 Initial setting is 143.
736 You can omit the @var{hostname} from folder names if you set
737 @code{elmo-imap4-default-server} as your main IMAP server.
738 For example, you can specify a folder as @samp{foo%imap@@gateway} even
739 if you have to go through a firewall.
743 ;; @r{Example: imap4.exaple.org as main IMAP server}
744 (setq elmo-imap4-default-server "imap4.example.org")
748 SSL (Secure Socket Layer) connection will be used if a folder name ends
749 with @samp{!}. If a folder name ends with @samp{!!}, STARTTLS
750 connection will be established.
752 If the value of @code{elmo-imap4-default-stream-type} is @code{ssl},
753 SSL will be the default connection, i.e. you can omit @samp{!}. If it
754 is is @code{starttls}, STARTTLS will be the default connection. To use
755 normal connection in these cases, add @samp{!direct} at the end of
760 ;; @r{Example: Use SSL connection}
761 (setq elmo-imap4-default-stream-type 'ssl)
765 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
766 authentication method, the password is sent in encoded form. But, if
767 your server is unable to receive an encoded password, authentication
768 will fall back to @code{clear} (that is, sending password in raw format)
769 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
770 authentication will fall back to @code{clear} without confirmation
771 (default value is @code{nil}).
775 ;; @r{Example: password in raw format}
776 (setq elmo-imap4-default-authenticate-type 'clear)
784 %inbox -> IMAP mailbox "inbox"
785 %#mh/inbox -> IMAP mailbox "#mh/inbox"
787 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
788 %inbox:hoge/clear@@server1
789 -> server1's IMAP mailbox "inbox"
790 of user "hoge", with plain password authentication
795 @subsection International mailbox names (Modified UTF7)
796 @cindex Modified UTF7
803 You can use international mailbox names in @var{mailbox} part, if you
804 are using Emacs with UTF-7 support and
805 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
806 value is @code{nil}).
808 Currently, Mule-UCS package is required to use UTF-7.
809 Mule-UCS works on following Emacsen.
812 @item Emacs 20.3 or later
813 @item XEmacs 21.2.37 or later
816 You can obtain Mule-UCS package from following URL.
819 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
822 @node NNTP Folder, MH Folder, IMAP Folder, Folders
833 A folder to access USENET news via NNTP protocol (RFC 977).
834 One newsgroup is treated as a folder.
840 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
846 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
847 Initial setting is @samp{localhost}.
848 @var{username} -> The value of @code{elmo-nntp-default-user}.
849 Initial setting is @code{nil}.
850 @var{port} -> The value of @code{elmo-nntp-default-port}.
851 Initial setting is 119.
854 AUTHINFO is used as authentication method if the @var{username} is
855 non-nil. SSL connection will be used if a folder name ends with @samp{!}.
856 If a folder name ends with @samp{!!}, STARTTLS connection will be
859 If the value of @code{elmo-nntp-default-stream-type} is @code{ssl},
860 SSL will be the default connection, i.e. you can omit @samp{!}. If it
861 is is @code{starttls}, STARTTLS will be the default connection. To use
862 normal connection in these cases, add @samp{!direct} at the end of
869 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
870 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
875 @node MH Folder, Maildir Folder, NNTP Folder, Folders
882 A folder to access MH format mail (1 file is 1 mail).
887 @samp{+} @var{directory-name}
890 Normally, @var{directory-name} is an relative path to the variable
891 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
892 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
893 (this is also true for drive-letters).
895 Message number is used for the name of the message file.
901 +inbox -> @file{~/Mail/inbox}
902 +from/teranisi -> @file{~/Mail/from/teranisi}
903 +~/test -> @file{~/test}
908 @node Maildir Folder, News Spool Folder, MH Folder, Folders
909 @section Maildir Folder
911 @cindex Maildir Folder
915 A folder to access Maildir format (1 file is 1 mail).
920 @samp{.} [@var{directory-name}]
923 Normally, @var{directory-name} is a relative path to the variable
924 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
925 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
926 (this is also true for drive-letters).
928 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
929 Messages are contained in the @file{cur} directory. All message files
930 in the @file{new} directory are moved to @file{cur} directory when you
931 access the folder. All message files contained in the @file{tmp}
932 directory and not accessed for 36 hours are deleted.
934 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
940 . -> @file{~/Maildir}
941 .inbox -> @file{~/Maildir/inbox}
942 .from/teranisi -> @file{~/Maildir/from/teranisi}
943 .~/test -> @file{~/test}
948 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
949 @section News Spool Folder
951 @cindex News spool Folder
954 This folder handles locally saved news articles which are proposed by
955 Mew/IM. You can also read articles directly from a spool-file which is
956 retrieved by an utility like @command{gnspool}.
961 @samp{=} @var{directory-name}
964 @var{directory-name} is a sub-directory to the directory defined by
965 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
966 You can use @samp{.} as directory delimiter as well as @samp{/}.
972 =fj/os/os2 -> @file{~/News/fj/os/os2}
973 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
978 @node Archive Folder, POP Folder, News Spool Folder, Folders
979 @section Archive Folder
981 @cindex Archive Folder
984 This method can handle archive files, which are compressed by utilities
985 such as Info-ZIP or LHA, as one folder.
991 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
995 @var{path-name} is the relative path from
996 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
997 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
998 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
999 also permitted under the environment of ange-ftp, efs.
1001 The actual file name of the archive folder is
1002 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1003 under the @var{path-name}. If a file named @var{path-name} exists, it is
1004 treated as folder. The suffix is automatically decided for
1005 @var{archiver-type}.
1007 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1008 (Initial setting is @code{zip}) is referred.
1010 @var{prefix} specifies the internal directory structure of the archive.
1011 For example, if the ML server is fml, @file{msend.tar.gz} has a
1012 structure like @file{spool/1}, so you have to specify @samp{spool} as
1019 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1020 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1021 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1022 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1023 $ml;zip/ -> Access group consists of archive folders
1024 under @file{~/Mail/ml}
1029 * Archiver:: Supported Archivers
1030 * Archive Tips:: TIPS
1031 * Archive Vars:: Customization
1035 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1036 @subsection Supported Archives
1046 By default, following archives are supported.
1050 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1051 GNU TAR('tgz, 'tar) ;; read-only
1055 If your archiver can include multiple files in one archive, you have a
1056 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1057 of the candidate. TAR is supported read-only because it cannot delete
1058 file in the archive (@code{mv})).
1060 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1061 archiver of Wanderlust because they cannot include multiple
1062 files. Archivers that cannot extract files to standard output are also
1065 @subsection OS specific information about archiver.
1067 Behaviors of the following archivers are confirmed by further experiences.
1068 (@samp{*} mark means recommended archiver).
1071 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1072 LHA OS/2 version Rel.2.06b Feb 18, 1998
1073 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1074 *Zip 2.2 (November 3rd 1997).
1075 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1076 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1077 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1079 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1080 LHa for UNIX V 1.14c
1081 UnZip 5.32 of 3 November 1997
1082 Zip 2.2 (November 3rd 1997)
1083 GNU tar 1.12 (1.11.x is no good)
1084 gzip 1.2.4 (18 Aug 93)
1086 [Win32] Win.98/Meadow
1090 GNU tar 1.11.8 + 1.5(WIN32)
1097 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1098 Hiramatsu version of LHA is only supported.
1099 In Win32, LHa32 is only supported (DOS version is no good).
1101 * Caution about GNU tar
1103 You have to take care about GNU tar's version because many version has
1104 problem on deleting file from archive.
1106 Please test @option{--delete} @option{-f} options work. Otherwise, your
1107 archive will be destroyed. No problem is reported on above versions of
1111 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1113 @cindex Archive Tips
1115 For comfortable migration, usage of @code{wl-summary-archive}
1116 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1117 archive folders created by expiration, you must set non-nil value to
1118 @code{elmo-archive-treat-file}.
1120 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1121 in processing speed. For comfortable use, Emacs20 is recommended.
1122 (If re-search's performance is the problem, 19.3x or later may be okay.)
1124 If many files are included in one archive,
1125 it takes long time to access the archive folder because
1126 archiver starting overhead is increased (especially LHA).
1127 150-200 messages in one archive is recommended.
1129 Of course, following is possible @t{:-)}
1130 (meanings of these variables are described later.)
1134 (setq wl-fcc "$backup")
1135 (setq wl-trash-folder "$trash;lha")
1139 @node Archive Vars, , Archive Tips, Archive Folder
1140 @subsection Variables About Archive Folder
1141 @cindex Archive variables
1144 @item elmo-archive-default-type
1145 @vindex elmo-archive-default-type
1146 The initial setting is @code{zip}.
1147 Set archiver type by symbol.
1149 @item elmo-archive-@var{type}-method-alist
1150 @vindex elmo-archive-TYPE-method-alist
1151 Define archiver @var{type}'s methods.
1152 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1153 Each element of the alist is following.
1157 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1158 (@var{action} . @var{function}) ;; function
1162 Currently available actions are following.
1166 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1167 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1174 actions enclosed with braces are optional (They are used for better
1177 @item elmo-archive-suffix-alist
1178 @vindex elmo-archive-suffix-alist
1179 An alist of archiver-type (symbol) and suffix.
1181 @item elmo-archive-file-regexp-alist
1182 @vindex elmo-archive-file-regexp-alist
1183 An alist of a regexp to get file number from list output of archiver
1184 and archiver-type (symbol).
1186 @item elmo-archive-method-list
1187 @vindex elmo-archive-method-list
1188 A list of elmo-archive-@var{type}-method-alist
1189 (@var{type} is a symbol of archiver-type).
1191 @item elmo-archive-lha-dos-compatible
1192 @vindex elmo-archive-lha-dos-compatible
1193 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1194 DOS (Mr. Yoshizaki original) compatible.
1196 @item elmo-archive-cmdstr-max-length
1197 @vindex elmo-archive-cmdstr-max-length
1198 The initial setting is 8000.
1200 Max length of command line argument for external archiver program.
1201 Emacs does not have a limit of command line byte length, but some OS
1202 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1203 this limit because it calls external archiver program directly (not
1204 called via shell). For example, you cannot delete messages if archiver
1205 program must receive larger bytes of arguments to delete. OS/2 have a
1206 command line argument limit of 8190 bytes, so we defined default as 8000
1209 However, you don't have an influence of command line argument limit
1210 if the archiver has `actions' to receive target file information from
1211 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1215 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1223 A folder to access e-mails via POP3 protocol (RFC 1939).
1229 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1234 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1235 as @var{authenticate-type}.
1237 You can specify @samp{uidl} (use UIDL command for message numbering) or
1238 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1242 @var{username} -> The value of @code{elmo-pop3-default-user}.
1243 Initial setting is @env{USER} environment variable or
1244 @env{LOGNAME} environment variable or return value of
1245 @code{(user-login-name)}.
1246 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1247 Initial setting is @samp{user}.
1248 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1249 If t, use UIDL for numbering. Initial setting is t.
1250 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1251 Initial setting is @samp{localhost}.
1252 @var{port} -> The value of @code{elmo-pop3-default-port}.
1253 Initial setting is 110.
1260 &hoge@@localhost -> access localhost as user @samp{hoge}.
1261 &hoge@@popserver:109 -> access the server "popserver" on port 109
1262 as user @samp{hoge}.
1266 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1267 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1268 @file{utils/sasl/lisp/} or Emacs/W3 package
1269 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1272 If the last character of the folder name is @samp{!}, Wanderlust
1273 connects to the POP server via SSL (Secure Socket Layer). If a folder
1274 name ends with @samp{!!}, STARTTLS connection will be established.
1276 If the value of @code{elmo-pop3-default-stream-type} is @code{ssl},
1277 SSL will be the default connection, i.e. you can omit @samp{!}. If it
1278 is is @code{starttls}, STARTTLS will be the default connection. To use
1279 normal connection in these cases, add @samp{!direct} at the end of
1283 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1284 @section Shimbun Folder
1286 @cindex Shimbun Folder
1287 @cindex Folder, Shimbun
1292 A folder for watching "shimbun" (means "newspaper" in Japanese),
1293 news site and mailing list archives on WWW by using emacs-w3m
1294 (@uref{http://emacs-w3m.namazu.org/}).
1296 You should possess w3m and emacs-w3m to use this.
1302 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1306 Admissible values of @var{module-name} and @var{folder-name} are
1307 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1313 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1314 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1318 @subsection Variables About Shimbun Folder
1321 @item elmo-shimbun-update-overview-folder-list
1322 @vindex elmo-shimbun-update-overview-folder-list
1323 The initial setting is @code{all}. Specify a set of folders to update
1324 overview when messages are fetched. Specify @code{all} to update
1325 overview in all shimbun folders. You can specify a list of regular
1326 expressions of shimbun folder names to restrict affected folders.
1331 (setq elmo-shimbun-update-overview-folder-list
1332 '("^@@airs\\." "^@@namazu\\."))
1335 @kbd{s rescan} is needed after fetching to update summary view.
1339 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1340 @section Namazu Folder
1342 @cindex Namazu Folder
1343 @cindex Folder, Namazu
1344 @cindex Folder, Text Search
1347 A folder to access messages found in namazu-index with some condition.
1348 It uses namazu (@uref{http://www.namazu.org/}) for search.
1354 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1358 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1364 [wanderlust] -> search messages matched with
1365 "wanderlust" from the default index
1366 [semi flim]~/Mail/semi -> search "semi flim" from the index
1367 in the directory "~/Mail/semi"
1373 @subsubsection Enter space to separate keywords
1375 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1377 @subsubsection Alias name for index
1379 You can define an alias name for index.
1384 (setq elmo-nmz-index-alias-alist
1385 '(("cache" . "~/.elmo/cache")
1386 ("docs" . "~/documents")))
1389 Above definition defines two index aliases.
1396 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1397 directory @file{~/.elmo/cache}.
1399 @subsubsection Multiple indices
1401 You can specify a list for @code{elmo-nmz-default-index-path} and
1402 @code{elmo-nmz-index-alias-alist}.
1403 When list is specified, all index contained in the list is used as the
1409 (setq elmo-nmz-index-alias-alist
1410 '(("all" . ("~/.elmo/cache" "~/documents"))
1411 ("cache" . "~/.elmo/cache")))
1414 Using above alias setting, you can specify
1420 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1421 directory @file{~/.elmo/cache} and @file{~/documents}.
1423 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1424 @section Multi Folder
1426 @cindex Multi Folder
1427 @cindex Folder, Multiple
1428 @cindex Folder, Marge
1430 A folder to access virtual folder which collects messages from
1437 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1441 After @samp{*} character, specify multiple folders you want to collect
1442 separated by @samp{,} like
1443 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1449 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1450 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1451 treated as one folder.
1453 *+inbox,-fj.rec.tv,%inbox
1454 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1459 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1460 @section Filter Folder
1462 @cindex Filter Folder
1463 @cindex Folder, Filtering
1464 @cindex Folder, Virtual
1465 @cindex Folder, Conditional
1468 A folder to access virtual folder which collects all messages that
1469 satisfy a condition.
1474 @samp{/} @var{condition} @samp{/} @var{target-folder}
1477 In the @var{condition} part, you can specify following.
1481 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1483 first: @var{number} messages are picked from top of folder.
1484 last: @var{number} messages are picked from bottom of folder.
1490 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1491 /first:20/%inbox -> First 20 messages from %inbox are picked.
1496 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1498 since: only messages arrived since @var{date} are picked.
1499 before: only messages arrived before @var{date} are picked.
1501 You can specify following as @var{date}.
1505 yesterday -> a day before today.
1506 lastweek -> same day of last week.
1507 lastmonth -> same day of last month.
1508 lastyear -> same day of last year.
1509 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1510 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1518 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1520 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1526 Field filter: @samp{@var{field}:@var{value}}
1528 All messages that have @var{field} and its value is @var{value} are picked.
1529 @var{field} and @var{value} are case insensitive.
1535 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1536 and its value includes "teranisi" string are picked.
1537 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1543 Flag filter: @samp{flag:@var{flag-name}}
1545 Pick up messages with flag specified by @var{flag-name}.
1547 You can specify following flag names:
1552 important -> important
1554 digest -> unread or important
1555 any -> unread or important or replied
1559 You can also use flags which you have set as global flag.
1560 @xref{Internal Folder}.
1566 /flag:digest/%inbox -> a folder consist of unread or important
1568 /flag:wl/+ML/Wanderlust -> a folder consist of messages with global flag
1569 wl in +ML/Wanderlust.
1576 A condition starting with @samp{!} indicates a negation.
1577 If you combine conditions by character @samp{|}, it is considered as OR condition.
1578 @samp{&} is considered as AND condition, likewise.
1579 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1581 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1582 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1588 /from:teranisi&!to:teranisi/+inbox
1589 -> In +inbox, messages are picked if the message's
1590 From: field includes "teranisi" and
1591 To: field doesn't include "teranisi".
1593 /tocc:"Yuuichi Teranishi"/+inbox
1594 -> In +inbox, messages are picked if the
1595 message's To: field or Cc: field includes
1596 "Yuuichi Teranishi".
1598 /(from:yt|from:teranisi)&subject:report/+inbox
1599 -> In +inbox, messages are picked if the message's
1600 From: field includes "yt" or "teranisi", and
1601 Subject includes "report".
1607 Tip for string description:
1609 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1610 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1611 should be escaped with @samp{\} in it). You can enclose the string with
1612 @samp{"} even it does not contain these characters.
1618 *%inbox,/from:teranisi/%inbox@@server
1619 -> Messages in %inbox or
1620 message is in the %inbox@@server folder and it's From field
1621 includes "teranisi" are collected.
1623 /last:100//to:teranisi/*+inbox,%inbox
1624 -> Latest 100 messages which is in the +inbox or %inbox folder
1625 and To: field matches "teranisi".
1627 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1628 -> Pick messages which have From: field and it includes "hogehoge"
1629 from latest 20 messages in the %#mh/inbox@@localhost
1630 and To: or Cc: field includes "teranisi".
1633 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1634 @section Pipe Folder
1638 @cindex Download Message
1639 @cindex Incorporate Message
1641 In the pipe folder, messages are automatically transferred from the source
1642 folder to destination folder.
1647 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1650 When you access the pipe folder, messages are automatically transferred
1651 from @var{source-folder} to @var{destination-folder}.
1652 It is convenient if you want to download messages to local disk via POP.
1653 For example, if you specify following
1656 |&username@@popserver|+inbox
1660 and access it, Wanderlust downloads messages from
1661 @samp{&username@@popserver} to @samp{+inbox} automatically.
1663 On the other hand, if you put @samp{|:} instead of second @samp{|},
1664 then messages are copied to the destination folder (not deleted from
1665 source-folder). At the next time you access that folder, copies new
1669 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1672 If you want to copy messages from POP server and view them, specify the
1676 |&username@@popserver|:+inbox
1679 where messages will be kept on the server.
1685 |%inbox|%myinbox -> Download %inbox to %myinbox.
1686 |*&user@@popserver1,&user@@popserver2|+inbox
1687 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1688 |-gnu.emacs.sources|:+sources
1689 -> Copy messages from -gnu.emacs.sources to +sources.
1693 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1695 @node Internal Folder, File Folder, Pipe Folder, Folders
1696 @section Internal folder
1698 @cindex Internal Folder
1699 @cindex Folder, @samp{$} mark
1702 @c @cindex Folder, Null
1704 A folder to access internal messages of Wanderlust.
1710 @samp{'flag} [@samp{/} @var{global-flag}]
1712 @samp{'cache/00} - @samp{'cache/1F}
1716 A folder named @samp{'flag} is a special virtual folder which collects
1717 messages which have @var{global-flag}.
1719 There is @samp{important} flag defined as @var{global-flag} by default.
1720 You can review important messages at once after you put important marks
1721 on the messages in the different folders. If @var{global-flag} is omitted,
1722 it is treated as @samp{important} flag is specified.
1724 In addition, in summary mode, to be described later, you can freely
1725 define global flags and put them on messages.
1726 @xref{Usage of Summary Mode}.
1728 In this folder, if you delete message, @var{global-flag} put on the
1729 message is removed. If you append messages to this folder, the message
1730 will have @var{global-flag}.
1733 A folder named @samp{'sendlog} is a virtual folder which collects
1734 cached messages which are recoded on @file{~/.elmo/sendlog}.
1735 It might be useful when you forgot to add cc for yourself.
1736 To use this, you should set @code{wl-draft-use-cache} to non-nil
1737 so that sent messages are cached.
1740 You can access cached messages fetched via network by accessing
1741 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1742 the name of the subdirectories of the cache directory
1743 (@file{~/.elmo/cache}).
1746 @node File Folder, , Internal Folder, Folders
1747 @section File folder
1750 File Folder gives the view for local file system.
1751 The one File Folder corresponds to the one directory.
1756 @samp{file:} @var{Path-of-the-directory}
1763 file:~/work -> @file{~/work}
1764 file:/etc -> @file{/etc}
1769 @node Folder, Summary, Folders, Top
1770 @chapter Folder mode
1773 After you start Wanderlust, folder mode is appeared firstly.
1774 It contains folder list you subscribed.
1775 You can select and edit folders in this mode.
1778 * Selecting Folder:: Select folder you want to read
1779 * Folder Manager:: Editing folders
1783 @node Selecting Folder, Folder Manager, Folder, Folder
1784 @section Selecting Folder
1785 @cindex Selecting Folder
1787 @subsection Usage (TIPS)
1789 @subsubsection Check new, unread number
1791 Folder mode looks like this.
1792 (In XEmacs, it looks much nicer @t{;-)})
1796 [-]Desktop:14186/35580/67263
1801 [-]Emacsen:0/34/4837
1802 Wanderlust ML:0/0/558
1805 XEmacs Beta:0/29/255
1816 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1820 @kbd{s} key on the folder line updates these numbers.
1821 It changes its color if it has many new messages.
1823 The whole folder mode is a folder group named @samp{Desktop}.
1824 Folder group open/close by return key.
1825 A operation to a folder group is treated as operations on the
1827 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1828 six children folders update its unread number status.
1830 @subsubsection Select Folder
1832 To enter summary mode of the folder, type return (or space) key on
1834 If the variable @code{wl-stay-folder-window} has non-nil value,
1835 summary window appears on the right of the folder mode window.
1837 @subsection Key bindings
1839 Folder mode's key binding (related to selecting folders) is following.
1844 @kindex @key{SPC} (Folder)
1845 @kindex @key{RET} (Folder)
1846 @findex wl-folder-jump-to-current-entity
1847 Enter to the summary mode of the folder at the current cursor point.
1848 With prefix argument, enter the sticky summary.
1849 If the cursor is on the top of folder group line,
1850 the folder group is opened or closed.
1851 When the cursor is on the access group and this command is called
1852 with prefix argument, folder children list is updated to the newest one.
1853 (Children list is updated recursively if the access folder has hierarchical
1855 (@code{wl-folder-jump-to-current-entity})
1858 @kindex M-@key{RET} (Folder)
1859 @findex wl-folder-update-recursive-current-entity
1860 Folder children list of the access group at the current cursor point
1861 is updated to the newest one.
1862 (Children list is updated recursively if the access folder has hierarchical
1864 (@code{wl-folder-update-recursive-current-entity})
1869 Create a new draft message.
1874 @findex wl-folder-write-current-folder
1875 If the current cursor point is on the NNTP folder, create a new draft
1876 message which already has @samp{Newsgroups:} field. If the current
1877 cursor point is on the folder for mailing list (refile destination),
1878 create a new draft message which already has @samp{To:} field with
1879 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1881 (@code{wl-folder-write-current-folder})
1884 @kindex C-c C-o (Folder)
1885 @findex wl-jump-to-draft-buffer
1886 Move to the draft buffer if available. If multiple draft buffer exists,
1887 moved to one after another. If prefix argument is specified, load draft
1888 folder's message to the draft buffer and jump to it.
1889 (@code{wl-jump-to-draft-buffer})
1893 @findex wl-folder-check-current-entity
1894 Update new and unread number information of the folder at the current
1896 (@code{wl-folder-check-current-entity})
1900 @findex wl-folder-sync-current-entity
1901 Update summary information of the folder at the current cursor point.
1902 (@code{wl-folder-sync-current-entity})
1905 @kindex r s (Folder)
1906 @findex wl-folder-check-region
1907 Update new and unread number information of the folders in the currently
1909 (@code{wl-folder-check-region})
1912 @kindex r S (Folder)
1913 @findex wl-folder-sync-region
1914 Update summary information of the folders in the currently selected region.
1915 (@code{wl-folder-sync-region})
1919 @findex wl-status-update
1920 Sync up address book status with @file{~/.addresses}'s content.
1921 (@code{wl-status-update})
1925 @findex wl-folder-prev-unread
1926 Jump cursor to the folder which have unread messages on the upward from
1927 current cursor point.
1928 (@code{wl-folder-prev-unread})
1932 @findex wl-folder-next-unread
1933 Jump cursor to the folder which have unread messages on the downward
1934 from current cursor point.
1935 (@code{wl-folder-next-unread})
1939 @findex wl-folder-prev-entity
1940 Move cursor to the folder on the previous line.
1941 (@code{wl-folder-prev-entity})
1945 @findex wl-folder-next-entity
1946 Move cursor to the folder on the next line.
1947 (@code{wl-folder-next-entity})
1951 @findex wl-folder-jump-folder
1952 Jump to the folder specified by the user input.
1953 (@code{wl-folder-jump-folder})
1957 @findex wl-folder-prefetch-current-entity
1958 Prefetch new messages of the folder at the current cursor point by
1959 @code{wl-summary-incorporate}.
1960 If the cursor is on the folder group, it is executed recursively.
1961 (@code{wl-folder-prefetch-current-entity})
1965 @findex wl-folder-mark-as-read-all-current-entity
1966 Mark all unread messages of the folder at the current cursor point as read.
1967 If the cursor is on the folder group, it is executed recursively.
1968 (@code{wl-folder-mark-as-read-all-current-entity})
1972 @findex wl-folder-goto-first-unread-folder
1973 Enter summary mode of the first unread folder.
1974 (@code{wl-folder-goto-first-unread-folder})
1978 @findex wl-folder-empty-trash
1980 (@code{wl-folder-empty-trash})
1984 @findex wl-folder-flush-queue
1986 (@code{wl-folder-flush-queue})
1990 @findex wl-folder-virtual
1991 Move to the virtual folder (filter folder) with the condition specified.
1992 (@code{wl-folder-virtual})
1996 @findex wl-folder-pick
1997 Search the folders with the condition specified.
1998 (@code{wl-folder-pick})
2002 @findex wl-folder-open-all-unread-folder
2003 All unread folder is opened.
2004 (@code{wl-folder-open-all-unread-folder})
2008 @findex wl-execute-temp-marks
2009 Execute marks in summary buffers. @xref{Sticky Summary}.
2010 (@code{wl-execute-temp-marks})
2014 @findex wl-folder-open-close
2015 Folder group is opened/closed.
2016 (@code{wl-folder-open-close})
2020 @findex wl-folder-open-all
2021 All folder group is opened.
2022 (@code{wl-folder-open-all})
2026 @findex wl-folder-close-all
2027 All folder group is closed.
2028 (@code{wl-folder-close-all})
2038 @findex wl-folder-suspend
2040 (@code{wl-folder-suspend})
2043 @kindex M-s (Folder)
2045 Save current folder status.
2049 @kindex M-t (Folder)
2050 @findex wl-toggle-plugged
2051 Toggle Wanderlust's offline/online status.
2052 (@code{wl-toggle-plugged})
2055 @kindex C-t (Folder)
2056 @findex wl-plugged-change
2057 Start Wanderlust's plug-status manager.
2058 (@code{wl-plugged-change})
2061 @subsection Customize variables
2064 @item wl-folders-file
2065 @vindex wl-folders-file
2066 The initial setting is @file{~/.folders}.
2067 Subscribed folders are described (saved) in this file.
2069 @item wl-folder-info-save
2070 @vindex wl-folder-info-save
2071 The initial setting is @code{t}. If non-nil, unread information is
2072 saved and used in the next Wanderlust session.
2074 @item wl-stay-folder-window
2075 @vindex wl-stay-folder-window
2076 The initial setting is @code{nil}.
2077 If non-nil, summary window is appeared on the right side of the folder buffer.
2079 @item wl-folder-window-width
2080 @vindex wl-folder-window-width
2081 The initial setting is 20.
2082 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
2084 @item wl-folder-use-frame
2085 @vindex wl-folder-use-frame
2086 The initial setting is @code{nil}.
2087 If non-nil, use new frame for the folder window.
2089 @item wl-folder-many-unsync-threshold
2090 @vindex wl-folder-many-unsync-threshold
2091 The initial setting is 70.
2092 If the number of unread messages is more than this value,
2093 folder color is changed.
2095 @item wl-highlight-folder-by-numbers
2096 @vindex wl-highlight-folder-by-numbers
2097 This option controls how to highlight each line in the folder buffer.
2098 The default value is @code{t}, highlighting with various colors based on
2099 the message numbers. If it is @code{nil}, highlighting with various
2100 colors based on the folder status. In addition, if it is a number
2101 (e.g. 1), highlighting will be done based on both the message numbers
2102 and the folder status.
2104 @item wl-folder-desktop-name
2105 @vindex wl-folder-desktop-name
2106 The initial setting is @samp{Desktop}.
2107 The name of top folder group.
2109 @item wl-folder-petname-alist
2110 @vindex wl-folder-petname-alist
2111 The initial setting is @code{nil}.
2112 An alist of folder's realname and its nickname.
2114 @item wl-folder-access-subscribe-alist
2115 @vindex wl-folder-access-subscribe-alist
2116 The initial setting is @code{nil}.
2118 Control automatic subscribing and unsubscribing of the children list
2124 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2128 If @var{subscribe-flag} is non-nil, folders which have name matched to
2129 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2130 already unsubscribed folder is not displayed even when the
2131 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2138 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2139 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2140 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2141 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2145 @item wl-folder-hierarchy-access-folders
2146 @vindex wl-folder-hierarchy-access-folders
2147 A list of regular expressions for access groups which creates children
2148 folder list hierarchically.
2150 For example, if you specify
2151 @code{wl-folder-hierarchy-access-folders} like following,
2155 (setq wl-folder-hierarchy-access-folders
2156 '("^-[^\\.]*$" "^-comp.unix$" "^-comp.unix.bsd$"))
2161 you obtain the access group hierarchy as follows.
2167 -fj.comp.announce:0/0/2
2168 -fj.comp.dev.cdrom:0/0/0
2170 [+]-japan:238/238/1688
2173 -comp.unix.admin:0/0/0
2174 -comp.unix.dos-under-unix:0/0/0
2175 -comp.unix.programmer:0/0/0
2176 [-]-comp.unix.bsd:0/0/23
2177 -comp.unix.bsd.freebsd.announce:0/0/0
2182 If you opened @samp{-} in this example, only the direct children is created
2183 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2184 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2185 is not created until the children access group is opened.
2189 @node Folder Manager, , Selecting Folder, Folder
2190 @section Editing Folders
2191 @cindex Folder Manager
2192 @cindex Folder, Edit
2193 @cindex Folder, Subscribe
2194 @cindex Folder, Unsubscribe
2196 As described before, subscribed folder list is saved in @file{~/.folders} file.
2197 But you don't have to edit @file{~/.folders} directly.
2198 You can append, delete, edit folders from folder mode.
2200 @subsection Usage (Tips)
2202 @subsubsection Append Folder
2204 @kbd{m a} appends new folder to your folder list. If you enter non-existent
2205 folder, it will ask you to create a new one.
2206 @kbd{m g} appends new folder group.
2207 To append new folder to this group, firstly open it,
2208 then execute append command in the next line.
2210 @subsubsection Edit Folder
2212 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2213 Thus, you can change folder position as if you were editing a normal file.
2215 @subsubsection Create Multi Folder.
2219 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2221 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2223 Type @kbd{m m}, then you can create multi folder.
2226 @subsubsection Delete Nickname, Filter
2228 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2229 minibuffer while appending.
2231 @subsubsection Append Folder to Empty Group
2233 To append new folder to the empty folder group
2234 (after you create folder group by typing @kbd{m g}),
2235 firstly open it, then execute append command in the next line.
2236 If it is closed, folder is appended on the same level with
2237 the folder group above. It is difficult to explain by words so try it.
2238 In other words, appended position depends on the
2239 open/close status of the upper one.
2241 @subsubsection Charset of the Folders File.
2243 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2245 @subsubsection Create Filter
2247 @kbd{m f} adds filter to the folder at the current cursor point. To
2248 create new filter folder and leave the current folder unchanged, copy it
2249 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2250 filter can be specified while appending filter. If you put
2251 ``''(@var{NULL}), filter is deleted.
2253 @subsubsection Sort Folders
2255 Sorting of the folders is executed by the function specified by
2256 @code{wl-fldmgr-sort-function}.
2257 The initial setting is @code{wl-fldmgr-sort-standard},
2258 which sorts alphabetically.
2259 Sorting affects only on the current folder group. It does not
2260 affect on the child groups.
2262 @subsubsection Hiding Folders in the Access Group
2264 Usually, access group displays all children folders, but you can set
2265 some folders hidden. Following operations are only available on access
2268 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2269 (subscribe/unsubscribe) of the folder at current cursor point. Against
2270 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2273 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2274 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2275 argument and if the argument has positive number, the unsubscribe it.
2276 If the prefix argument has negative value, folder becomes visible and if
2277 zero, folder visibility is toggled.
2279 The other commands, @code{wl-fldmgr-subscribe} and
2280 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2283 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2284 executed in the access group, they have a same effect with
2285 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2286 The difference is that cut commands deletes folders from the current
2289 @subsubsection Operations in the Access Group
2291 You can insert and delete folders in the access group like usual folder
2292 group. But insert and delete commands can be only available for the
2293 children folders of the access group and they only sets the subscribe
2294 status. In other words, insertion of the folder means subscribing,
2295 deletion means unsubscribing.
2296 @footnote{In the current implementation,
2297 it is faster to delete region than to unsubscribe region.}
2299 To update the access group when children folders are inserted or deleted
2300 by other way (other than Wanderlust),
2301 open the access group by typing @kbd{C-u @key{RET}}.
2302 @xref{Selecting Folder}.
2304 The order of children folders of access group is saved after
2305 insertion/deletion/sorting.
2306 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2307 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2308 newly created folders are inserted on the top of the access group.
2310 @subsection Key bindings
2311 @cindex Keybind, Folder Mode
2312 @cindex Keybind, Folder Buffer
2314 Key bindings on the folder mode related to folder editing are shown below.
2315 All bindings starts with @kbd{m}, and primary commands are binded to
2316 one stroke key binding.
2320 @kindex m a (Folder)
2321 @findex wl-fldmgr-add
2322 Add specified folder to your folder list . If you enter non-existent
2323 folder, create it after confirmation.
2324 (@code{wl-fldmgr-add})
2329 @kindex m g (Folder)
2330 @findex wl-fldmgr-make-group
2331 Create a folder group.
2332 (@code{wl-fldmgr-make-group})
2335 @kindex m A (Folder)
2336 @findex wl-fldmgr-make-access-group
2337 Create an access group.
2338 (@code{wl-fldmgr-make-access-group})
2341 @kindex m d (Folder)
2342 @findex wl-fldmgr-delete
2343 Delete folder itself and msgdb.
2344 If the folder itself cannot be deleted like NNTP folder,
2345 only msgdb is deleted.
2346 (@code{wl-fldmgr-delete})
2351 @kindex m R (Folder)
2352 @findex wl-fldmgr-rename
2353 Change the name of folder or folder group.
2354 msgdb's path is also changed.
2355 (@code{wl-fldmgr-rename})
2361 @findex wl-fldmgr-make-multi
2362 Create a multi folders in the cutlist (cut, copied folders).
2363 (@code{wl-fldmgr-make-multi})
2368 @kindex m f (Folder)
2369 @findex wl-fldmgr-make-filter
2370 Create a filter folder. (Put a filter on the folder).
2371 (@code{wl-fldmgr-make-filter})
2375 @kindex M-c (Folder)
2376 @kindex m c (Folder)
2377 @findex wl-fldmgr-copy
2378 Copy folder (it is not available on folder group).
2379 (@code{wl-fldmgr-copy})
2383 @kindex M-w (Folder)
2384 @kindex m W (Folder)
2385 @findex wl-fldmgr-copy-region
2386 Copy folders in the specified region.
2387 (@code{wl-fldmgr-copy-region})
2391 @kindex C-k (Folder)
2392 @kindex m k (Folder)
2393 @findex wl-fldmgr-cut
2394 Cut folder. Folder itself is not deleted.
2395 (@code{wl-fldmgr-cut})
2399 @kindex C-w (Folder)
2400 @kindex m C-w (Folder)
2401 @findex wl-fldmgr-cut-region
2402 Cut folders in the specified region.
2403 (@code{wl-fldmgr-cut-region})
2407 @kindex C-y (Folder)
2408 @kindex m y (Folder)
2409 @findex wl-fldmgr-yank
2410 Paste folders that are copied or cut (folders in the cut-list).
2411 (@code{wl-fldmgr-yank})
2414 @kindex m p (Folder)
2415 @findex wl-fldmgr-set-petname
2416 Put nickname on the folder.
2417 (@code{wl-fldmgr-set-petname})
2420 @kindex m q (Folder)
2421 @findex wl-fldmgr-clear-cut-entity-list
2422 Clear the cut-list. (cut, copied folder information is cleared,
2423 you cannot paste after this)
2424 (@code{wl-fldmgr-clear-cut-entity-list})
2427 @kindex m s (Folder)
2428 @findex wl-fldmgr-sort
2429 Sort folders in the current folder group.
2430 (@code{wl-fldmgr-sort})
2433 @kindex m C-s (Folder)
2434 @findex wl-fldmgr-save
2435 Save current folder view to the @file{wl-folders-file}.
2436 (@code{wl-fldmgr-save})
2439 [Following commands are only available on the access groups]
2445 @kindex m u (Folder)
2446 @findex wl-fldmgr-unsubscribe
2447 Set the visibility of folder (subscribe/unsubscribe).
2448 (@code{wl-fldmgr-unsubscribe})
2453 @kindex r u (Folder)
2454 @findex wl-fldmgr-unsubscribe-region
2455 Set the visibility of the folders (subscribe/unsubscribe) in the
2457 (@code{wl-fldmgr-unsubscribe-region})
2462 @kindex m l (Folder)
2463 @findex wl-fldmgr-access-display-normal
2464 List folders that are currently available.
2465 (@code{wl-fldmgr-access-display-normal})
2470 @kindex m L (Folder)
2471 @findex wl-fldmgr-access-display-all
2472 List all folders regardless of the subscription status.
2473 (@code{wl-fldmgr-access-display-all})
2477 @subsection Customize variables
2480 @item wl-interactive-save-folders
2481 @vindex wl-interactive-save-folders
2482 The initial setting is @code{t}. If non-nil and folder view is
2483 modified, confirm saving it before Wanderlust or Emacs exits. If
2484 @code{nil}, save without confirmation.
2486 @item wl-fldmgr-make-backup
2487 @vindex wl-fldmgr-make-backup
2488 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2489 created before saving the folder status.
2491 @item wl-fldmgr-sort-function
2492 @vindex wl-fldmgr-sort-function
2493 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2494 sort folders. By default function, folders are sorted alphabetically
2495 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2498 @item wl-fldmgr-sort-group-first
2499 @vindex wl-fldmgr-sort-group-first
2500 The initial setting is @code{t}. If non-nil,
2501 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2502 does not care whether it is folder group or not.
2504 @item wl-folder-check-async
2505 @vindex wl-folder-check-async
2506 The initial setting is @code{t}. If non-nil, check folder's unread
2507 status asynchronously. It boosts newsgroup checking.
2509 @item wl-folder-check-fast
2510 @vindex wl-folder-check-fast
2511 The initial setting is @code{nil}.
2512 If non-nil, it does not update folder status while checking.
2514 @item wl-folder-notify-deleted
2515 @vindex wl-folder-notify-deleted
2516 The initial setting is @code{nil}.
2518 If non-nil, negative value is displayed when the message is deleted. If
2519 @code{sync}, folder is synchronized when the message is deleted. If
2520 @code{nil}, message deletion is ignored.
2522 @item wl-fldmgr-add-complete-with-current-folder-list
2523 @vindex wl-fldmgr-add-complete-with-current-folder-list
2524 The initial setting is @code{nil}.
2525 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2526 candidate for @code{wl-fldmgr-add}.
2529 @subsection Miscellanea
2531 Following is a note for folder editing.
2535 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2536 paste(yank) command pastes the folders on one cut or copy command
2537 (If copy command is executed by region, folders in the region are pasted
2538 by one paste command)
2541 You cannot cut @samp{Desktop} group.
2542 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2545 You cannot copy folder group.
2548 Operations on the access group are only available for the folders
2549 in the same access group.
2552 You cannot create a folder which has same name with the folders already exist.
2555 You cannot insert folders which have same name in one group.
2556 You can insert them in the different groups.
2557 You cannot put same nickname to the different folders.
2561 @node Summary, Message, Folder, Top
2562 @chapter Summary Mode
2564 After you select the folder via folder mode, you enter to the summary
2568 * Usage of Summary Mode:: TIPS
2569 * Thread Operations:: Thread operations
2570 * Cache:: File cache, Buffer cache, and Prefetch
2571 * Auto Refile:: Auto refile settings
2572 * Sticky Summary:: Summary make sticky
2573 * Summary View:: Format of summary lines
2574 * Mark and Action:: Temporary marks and their effect
2575 * Key Bindings of Summary:: Key bindings
2576 * Variables of Summary:: Customize Summary Mode
2580 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2581 @section Usage (Tips)
2583 @subsection Summary Content
2585 In the summary mode, messages are displayed like following.
2589 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2590 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2591 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2592 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2599 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2603 If you want to know how to change the format for this, please refer
2604 the section format of Summary lines.
2605 @xref{Summary View}.
2607 @var{Message number} is the message's unique number in the folder. In
2608 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2609 in the MH folder, it is the filename of the message.
2611 @var{Temporal mark} and @var{Persistent mark} are described later.
2613 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2614 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2615 Japanese, but if you want to display it in English, set the value of
2616 @code{wl-summary-weekday-name-lang} as @samp{en}.
2618 @var{Sender}'s indentation corresponds to the depth of the thread.
2619 Sender name is displayed as nickname if it is defined in the address
2620 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2621 displaying with nickname.
2623 If number is printed at the head of @var{Sender} part like @samp{+2},
2624 that means the message have 2 follow messages.
2626 @var{Subject} is the @samp{Subject:} header field of the message. If
2627 the message have same @samp{Subject:} with the parent message, it is not
2628 displayed. Some mailing list puts its sequence number in the
2629 @samp{Subject:} field, but it is
2630 ignored. @code{wl-summary-no-subject-message} is displayed when the
2631 message has empty subject field.
2633 @subsection Temporary Marks
2634 @cindex Mark, Temporary
2636 There are four temporary marks,
2637 @samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}.
2638 Temporary marks indicates message operations.
2643 You can execute a command on the all messages that have @samp{*} mark,
2644 with the key bindings which begins with @kbd{m}.
2647 The mark to dispose. You can put @samp{d} by typing @kbd{d} key.
2650 The mark to force delete. You can put @samp{D} by typing @kbd{D} key.
2654 After you type @kbd{o} key, prompt appears to input refile destination.
2655 Your answer is printed in the summary line.
2659 You can put this mark by typing @kbd{O} key.
2660 The difference between this mark and refile mark is,
2661 this mark does not delete the message while latter does.
2664 The mark to prefetch reserved.
2665 You can put this mark by typing @kbd{i} key.
2668 The mark to resend reserved.
2669 After you type @kbd{~} key, prompt appears to input address to resend.
2670 Your answer is printed in the summary line.
2673 @kbd{x} key executes action for temporary marks, respectively.
2675 @subsection Persistent Marks
2677 There are five persistent marks, @samp{!}, @samp{N}, @samp{n}, @samp{U},
2678 @samp{u}, @samp{A}, @samp{a} and @samp{$}.
2680 The persistent mark indicates the message's status and it is saved.
2681 Each persistent mark indicates:
2687 It is new message. It differs from @samp{N} that message with @samp{n}
2690 It is unread message.
2692 It is unread message. It differs from @samp{U} that message with @samp{u}
2695 It is message already read. It differs from message without mark that
2696 message with @samp{!} is not cached yet.
2698 It is already replied message.
2700 It is already replied message. It differs from @samp{A} that message
2701 with @samp{u} is already cached.
2703 It is a message with some global flag. It is convenient to put this
2704 mark on the messages to remember (If you want to remember to write a
2705 reply for the message, for example) because this mark remains after
2706 you exited Emacs. Messages with the @samp{$} mark can be reviewed in
2707 the @samp{'flag} folder even the message itself is deleted in the actual
2708 folder. You can put global flag by typing @kbd{$} or @kbd{F} key.
2711 If the message is read and cached (or local message),there are no
2715 @samp{N}, @samp{U}, @samp{!}, @samp{A} indicates that the message have
2716 no cache. Messages with the marks other than these, you can read them
2717 in the offline status even they are in the IMAP folder or netnews
2720 Among messages with persistent marks, ones with marks specified by
2721 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2722 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2724 @subsection How To Read
2726 Basically, you can read messages only typing space key again and again.
2728 To update summary status to the newest status (synchronize),
2731 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2732 moves cursor to the next message.
2733 Enter message buffer by typing @kbd{j} key.
2734 To operate multipart, you have to enter to the message buffer.
2737 @subsection Pack the Message Numbers
2738 You can pack the message numbers in Summary by
2739 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2740 News Spool Folder and Maildir Folder are supported folder types.
2743 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2744 @section Thread Operations
2746 For example, the following line indicates one thread (a context of a topic).
2749 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2753 If you type @kbd{/} on this line, the thread is opened and it changes
2754 the appearance like following.
2758 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2759 388 09/17(Thu)22:34 +-[ Murata san ]
2763 (Message 388 is the replied message to the message 384.)
2764 If you type @kbd{/} key once again, the thread is closed.
2765 With prefix argument, @kbd{/} opens all children threads.
2767 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2770 Commands with the key binding that begins with @kbd{t} executes commands
2771 on the messages in the thread.
2772 @xref{Key Bindings of Summary}.
2774 @subsection reconstruct thread by hand
2776 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2777 (@code{wl-summary-save-current-message}) at the corresponding message,
2778 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2779 message then you have the reconstructed thread.
2782 @node Cache, Auto Refile, Thread Operations, Summary
2785 @subsection Cache File
2787 The messages which have to access via network (e.x. IMAP, NNTP folder)
2788 are cached as a local file so as to save network traffic or to enable
2789 off-line operation. The cache file is saved under the directory
2790 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2791 elmo-cache-expire-by-size}. The command deletes cache files to the
2792 specified size by the order of last accessed time.
2794 @subsection Buffer Cache and Prefetching
2796 The messages that are read are kept in the cache buffer so as to make
2797 the behavior fast when you are to read the message again. It is called
2798 `buffer cache'. The number of cache buffer is specified by
2799 @code{wl-message-buffer-cache-size}.
2801 There are message prefetching mechanism in the Wanderlust that
2802 prefetches next message while you are reading.
2804 You can control the message prefetching mechanism by these two
2808 @item wl-message-buffer-prefetch-folder-type-list
2809 @vindex wl-message-buffer-prefetch-folder-type-list
2810 The initial setting is @code{t}. In this case, prefetch messages in all
2812 If it is a list of folder types, it specifies the folder types in which
2813 message prefetching is enabled.
2814 Following is an example (prefetch messages in nntp and imap4 folders)
2818 (setq wl-message-buffer-prefetch-folder-type-list
2823 In this case, multi folder that contains localdir and imap4 prefetches
2824 only imap4 messages. This variable precedes the value of
2825 @code{wl-message-buffer-prefetch-folder-list}.
2827 @item wl-message-buffer-prefetch-folder-list
2828 @vindex wl-message-buffer-prefetch-folder-list
2829 The initial setting is @code{nil}.
2830 A list of regexp of folders to enable message prefetching.
2832 @item wl-message-buffer-prefetch-depth
2833 @vindex wl-message-buffer-prefetch-depth
2834 The initial setting is 3. The number of messages for automatical prefetch.
2836 @item wl-message-buffer-prefetch-idle-time
2837 @vindex wl-message-buffer-prefetch-idle-time
2838 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2840 @item wl-message-buffer-prefetch-threshold
2841 @vindex wl-message-buffer-prefetch-threshold
2842 The initial setting is 30000 (bytes). If prefetching message has larger
2843 size than this value, Wanderlust does not prefetch automatically.
2844 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2845 the message is not checked for the size.
2847 @item wl-auto-prefetch-first
2848 @vindex wl-auto-prefetch-first
2849 The initial setting is @code{nil}.
2850 If non-nil, first message is automatically prefetched to the buffer
2851 when you enter the folder.
2855 @node Auto Refile, Sticky Summary, Cache, Summary
2856 @section Auto Refile
2857 @vindex elmo-msgdb-extra-fields
2858 @vindex wl-refile-rule-alist
2859 @findex wl-summary-auto-refile
2861 You can refile messages automatically, by typing @kbd{C-o}
2862 (@code{wl-summary-auto-refile}). It decides destination of refile by
2863 the content of the message header information (information in the msgdb).
2865 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2866 available. If you want to decide destination by other header fields,
2867 set the variable @code{elmo-msgdb-extra-fields} like following.
2871 (setq elmo-msgdb-extra-fields
2881 By this setting, Wanderlust saves extra fields in the msgdb. You have
2882 to type @kbd{s all} to get extra fields for the messages that are
2883 already exists in the summary.
2885 Then, specify the refile rule. The refile target folder of auto
2886 refiling is decided by the value of @code{wl-refile-rule-alist}.
2887 @code{wl-refile-rule-alist} is a list of a rule:
2891 (@var{field} (@var{regexp} . @var{target})
2892 (@var{regexp} . @var{target})
2897 Each rule means `if @var{field} value matches @var{regexp},
2898 then refile to @var{target} folder'.
2899 The rule matched first is applied.
2901 @var{field} is a string of field name. You can specify a list of field name
2902 string, too. In this case, if one of these fields is matched, then the
2903 rule is fired (i.e. OR condition).
2905 @var{regexp} is a regular expression for field value. @var{target} is a target
2906 folder string. You can specify a rule at @var{target} part, too. In this
2907 case, If the field value of the rule and the current rule is matched,
2908 then the current rule is fired (i.e. AND condition).
2910 You can refer matched substring of @var{regexp} to specify @var{target} part.
2911 To refer substring, use following keys:
2915 means substitute original matched text.
2918 means substitute what matched the @var{N}th `\(@dots{}\)'.
2919 (@var{N} is a number.)
2922 Following is an example of @code{wl-refile-rule-alist}.
2926 (setq wl-refile-rule-alist
2928 ("^Wanderlust" . "+wl")
2929 ("^Elisp" . "+elisp"))
2931 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2933 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2934 "+from-me-to-you"))))))
2938 After these settings, refile marks are automatically put on the condition
2939 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2941 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2943 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2944 with these persistent marks are not automatically refiled.
2945 It means Wanderlust does not execute auto refile on unread messages by
2946 the default setting.
2947 To execute auto refile on all messages, set following.
2950 (setq wl-summary-auto-refile-skip-marks nil)
2954 @node Sticky Summary, Summary View, Auto Refile, Summary
2955 @section Sticky Summary
2956 @cindex Summary, Sticky
2957 @cindex Sticky Summary
2959 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2961 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2962 @kbd{G} in some suummary sticky summary buffer is created.
2963 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2964 makes current one sticky.
2966 The buffer name of the sticky summary becomes like
2967 @samp{Summary:@var{folder-name}}.
2968 You can visit the sticky summary at any time by @kbd{C-x b}
2969 (@code{switch-to-buffer}), or you can go round summary buffers by
2970 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2971 (@code{wl-summary-next-buffer}) in summary mode.
2973 In sticky summary, the summary buffer is preserved after @kbd{g} or
2974 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2975 another summary by @kbd{C-u g}. Other operations in the sticky summary
2976 are same as normal summary.
2978 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2979 are automatically stuck.
2982 @node Summary View, Mark and Action, Sticky Summary, Summary
2983 @section Format of summary lines
2984 @cindex Format of summary lines
2985 You can alter the format of lines in Summary mode.
2987 Summary line format is specified by @code{wl-summary-line-format}.
2988 You can use control strings defined by
2989 @code{wl-summary-line-format-spec-alist}.
2995 ;; @r{number temporary-mark persistent-mark date branch}
2996 ;; @r{[ (number-of-children) sender ] subject}
2997 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
3001 Where the number set the column number of the field (for negative value,
3004 Major control strings defined by @code{wl-summary-line-format-spec-alist}
3005 are displayed in the following list.
3016 %t branch of the thread
3017 %[ [ (< for re-connected child)
3018 %] ] (> for re-connected child)
3022 %c +number-of-children: (display only for opened thread)
3023 %C [+number-of-children] (display only for opened thread)
3024 %T temporary mark (mandatory)
3025 %P persistent mark (mandatory)
3029 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
3030 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
3031 the constant column. For example, if you specify @samp{%T} or
3032 @samp{%P} after the @samp{%t}, which changes its length by thread
3033 position, marks are not treated correctly.
3035 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
3036 column of the enclosed region is justified to the `number'. Multiple
3037 level @samp{%number(} parenthesis can be defined. It is useful to
3038 justify the column of the multiple control strings. For example, in the
3039 above @code{wl-summary-line-format},
3045 means ``Adjust number-of-children and sender string to the 17 column''.
3047 You can specify the format by each folders with
3048 @code{wl-folder-summary-line-format-alist}. Please set regular
3049 expression for folder names and summary line format as the following
3054 (setq wl-folder-summary-line-format-alist
3055 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
3056 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
3060 @subsection on the format for sender name
3062 The format string @samp{%f} displays the return value of the function specified
3063 by @code{wl-summary-from-function}. If you use the function
3064 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
3065 while displays the recipient names if the folder name matches with
3066 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
3067 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
3069 For example, to display recipient names for the message in @samp{+backup} if
3070 its sender is yourself, set up as follows.
3073 (setq wl-summary-showto-folder-regexp "^\\+backup$")
3077 @node Mark and Action, Key Bindings of Summary, Summary View, Summary
3078 @section Temporary marks and their effect
3079 @cindex Mark and Action
3081 You can define temporary marks and corresponding procedure by
3082 @code{wl-summary-mark-action-list}. Initially, refile (@samp{o}), copy
3083 (@samp{O}), dispose (@samp{d}), delete (@samp{D}), prefetch (@samp{i})
3084 and resend (@samp{~}) are defined.
3086 Each element of @code{wl-summary-mark-action-list} consists of
3089 (@samp{MARK} @samp{SYMBOL}
3090 @samp{ARGUMENT-FUNCTION} @samp{SET-MARK-FUNCTION} @samp{EXEC-FUNCTION}
3091 @samp{FACE} @samp{DOC-STRING})
3094 @samp{MARK} is a temporary mark string, and @samp{SYMBOL} is the name of
3095 the action to be defined. @samp{ARGUMENT-FUNCTION} is a function to
3096 generate argument to be given to @samp{SET-MARK-FUNCTION}, which will be
3097 described next, and it takes arguments:
3100 (@samp{ACTION} @samp{NUMBER})
3103 Where @samp{ACTION} equals to @samp{SYMBOL}, and @samp{NUMBER} is message
3104 number. @samp{SET-MARK-FUNCTION} is a function to be called when the mark
3105 is put. It takes arguments:
3108 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3111 Where @samp{NUMBER} is target message number, @samp{MARK} is a temporary
3112 mark string, and @samp{DATA} is given by @samp{ARGUMENT-FUNCTION}.
3114 @samp{EXEC-FUNCTION} is a function to be called when the action is
3115 executed. Its argument is a list of @samp{MARK-INFO}. Here @samp{MARK-INFO}
3116 means a list consists of
3119 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3122 @samp{FACE} is a face to be used for highlighting.
3125 @node Key Bindings of Summary, Variables of Summary, Mark and Action, Summary
3126 @section Key bindings
3127 @cindex Keybind, Summary Mode
3128 @cindex Keybind, Summary Buffer
3130 Key bindings of the summary mode are shown below.
3134 @kindex @key{SPC} (Summary)
3135 @findex wl-summary-read
3136 Proceed reading a message at the current cursor point.
3137 (@code{wl-summary-read})
3141 @findex wl-summary-redisplay
3142 Redisplay a message at the current cursor point.
3143 If this command is called with prefix argument,
3144 Redisplay message regardless of the message cache (message is re-loaded
3146 (@code{wl-summary-redisplay})
3150 @findex wl-summary-display-top
3151 Display the top message in the folder.
3152 (@code{wl-summary-display-top})
3156 @findex wl-summary-display-bottom
3157 Display the bottom message in the folder.
3158 (@code{wl-summary-display-bottom})
3162 @kindex @key{BS} (Summary)
3163 @kindex @key{DEL} (Summary)
3164 Display the previous page of the message at the current cursor point.
3165 @findex wl-summary-prev-page
3166 (@code{wl-summary-prev-page})
3169 @kindex @key{RET} (Summary)
3170 @findex wl-summary-next-line-content
3171 Display the next line of the message at the current cursor point.
3172 Display the message at the current cursor point if it is not displayed yet.
3173 (@code{wl-summary-next-line-content})
3178 @kindex M-@key{RET} (Summary)
3179 @findex wl-summary-prev-line-content
3180 Display the previous line of the message at the current cursor point.
3181 Display the message at the current cursor point if it is not displayed yet.
3182 (@code{wl-summary-prev-line-content})
3186 @findex wl-thread-open-close
3187 Toggle open or close the thread at the current cursor point.
3188 (@code{wl-thread-open-close})
3193 @findex wl-thread-open-all
3194 (@code{wl-thread-open-all})
3199 @findex wl-thread-close-all
3200 (@code{wl-thread-close-all})
3204 @findex wl-summary-goto-folder
3206 (@code{wl-summary-goto-folder})
3210 Mark all messages in the folder as read.
3211 @findex wl-summary-mark-as-read-all
3212 (@code{wl-summary-mark-as-read-all})
3216 @findex wl-summary-reply
3217 Prepare a draft for reply the message at the current cursor point.
3218 (@code{wl-summary-reply})
3222 @findex wl-summary-reply-with-citation
3223 Prepare a draft for reply the message at the current cursor point.
3224 (@code{wl-summary-reply-with-citation})
3228 @findex wl-summary-cancel-message
3229 If the message at current cursor point is your own netnews article,
3231 (@code{wl-summary-cancel-message})
3235 @findex wl-summary-reedit
3236 Prepare a draft for re-editing the message at current cursor point.
3237 If the message at current cursor point is your own netnews article,
3238 a draft for `supersedes message' for the message is prepared.
3239 (@code{wl-summary-reedit})
3242 @kindex M-E (Summary)
3243 @findex wl-summary-resend-bounced-mail
3244 If the message at current cursor point is a bounced message,
3245 a draft for re-sending original message is prepared.
3246 (@code{wl-summary-resend-bounced-mail})
3250 @findex wl-summary-forward
3251 A draft for forwarding the message at current cursor point is prepared.
3252 (@code{wl-summary-forward})
3256 @findex wl-summary-mark-as-important
3257 Put @samp{important} flag on the message at current cursor point.
3258 If already flagged as @samp{important}, remove the flag. If it is
3259 called with prefix argument, ask global flag to put similarly to @kbd{F}.
3260 (@code{wl-summary-mark-as-important})
3264 @findex wl-summary-set-flags
3265 Put arbitrary global flag entered in the minibuffer. If you use Emacs
3266 21 or later, you can specify multiple flags separated by @samp{,}
3267 simultaneously. If it is called with prefix argument, remove existent
3269 (@code{wl-summary-set-flags})
3275 Save the message at current cursor point.
3276 @findex wl-summary-save
3277 (@code{wl-summary-save})
3281 @findex wl-summary-next
3282 Move cursor to the next message.
3283 If message is marked with a temporal mark in
3284 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3285 In the offline mode, cursor is not moved to the messages which are not cached
3287 (@code{wl-summary-next})
3291 @findex wl-summary-prev
3292 Move cursor to the previous message.
3293 If message is marked with a temporal mark in
3294 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3295 In the offline mode, cursor is not moved to the messages which are not cached
3297 (@code{wl-summary-prev})
3301 @findex wl-summary-down
3302 Move cursor to the downward message which is unread or marked
3304 In the offline mode, cursor is not moved to the messages which are not cached
3306 If there are messages which have target mark @samp{*} in the summary,
3307 cursor is moved to the downward message which have a target mark.
3308 This behavior is changed according to the value of @code{wl-summary-move-order}.
3309 (@code{wl-summary-down})
3313 @findex wl-summary-up
3314 Move cursor to the upward message which is unread or marked
3316 In the offline mode, cursor is not moved to the messages which are not cached
3318 If there are messages which have target mark @samp{*} in the summary,
3319 cursor is moved to the downward message which have a target mark.
3320 This behavior is changed according to the value of @code{wl-summary-move-order}.
3321 (@code{wl-summary-up})
3325 @findex wl-summary-write
3326 Prepare a new draft.
3327 (@code{wl-summary-write})
3331 @findex wl-summary-write-current-folder
3332 Prepare a new draft. If the current folder is NNTP folder,
3333 @samp{Newsgroups:} field is completed. If the current folder is mailing
3334 list folder (refile destination), guess @samp{To:} field and completed
3335 (If @code{wl-subscribed-mailing-list} is valid list)
3336 (@code{wl-summary-write-current-folder})
3340 @findex wl-summary-redisplay-all-header
3341 Redisplay the message at current cursor point with all header fields.
3342 (@code{wl-summary-redisplay-all-header})
3346 @findex wl-summary-redisplay-no-mime
3347 Redisplay the message at current cursor point without MIME analysis.
3348 (@code{wl-summary-redisplay-no-mime})
3352 @findex wl-summary-burst
3353 If the message at current cursor point has
3354 encapsulates multiple messages using MIME,
3355 de-capsulate and extract them on the current folder.
3356 If it is invoked in non-writable folder or it is called with prefix
3357 argument, it asks the destination folder.
3358 (@code{wl-summary-burst})
3361 @kindex @@ (Summary)
3362 @findex wl-summary-edit-addresses
3363 Append/change/delete the message's sender information to the address
3364 book @file{~/.addresses} interactively. If this command is called with
3365 prefix argument, arbitrary address can be edited.
3366 (@code{wl-summary-edit-petname})
3370 @findex wl-status-update
3371 Sync up address book status with @file{~/.addresses}'s content.
3372 (@code{wl-status-update})
3376 @findex wl-summary-pipe-message
3377 Pipe current message's content to the external process.
3378 (@code{wl-summary-pipe-message})
3382 @findex wl-summary-print-message
3383 Print out current message's content.
3384 It uses @code{ps-print} module in Emacs 20.x.
3385 If you don't use color printer, you might want to set
3386 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3389 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3392 (@code{wl-summary-print-message})
3396 @findex wl-summary-exit
3397 Exit current folder.
3398 (@code{wl-summary-exit})
3402 @findex wl-summary-jump-to-current-message
3403 Jump cursor to the currently displayed message's window.
3404 (@code{wl-summary-jump-to-current-message})
3408 Jump cursor to the other message.
3409 @findex wl-summary-jump-to-msg
3410 (@code{wl-summary-jump-to-msg})
3414 Update summary status and
3415 prefetch all messages which have marks included in the
3416 @code{wl-summary-incorporate-marks}.
3417 @findex wl-summary-incorporate
3418 (@code{wl-summary-incorporate})
3421 @kindex M-j (Summary)
3422 @findex wl-summary-jump-to-msg-by-message-id
3423 Jump cursor to the message which have specified @samp{Message-Id:}. If
3424 @code{elmo-use-database} is non-nil, other folder is also searched.
3425 (@code{wl-summary-jump-to-msg-by-message-id})
3429 Jump to parent message.
3430 @findex wl-summary-jump-to-parent-message
3431 (@code{wl-summary-jump-to-parent-message})
3435 @findex wl-summary-mark-as-unread
3436 Mark as unread the message at current cursor point.
3437 (@code{wl-summary-mark-as-unread})
3441 @findex wl-summary-sync
3442 Synchronize summary view after prompting the update range.
3443 You can specify one of the follows.
3447 all Discard present msgdb and retrieve all informations.
3448 Do not retrieve killed messages.
3449 all-entirely Discard present msgdb and retrieve all informations.
3450 Retrieve killed messages, too.
3451 update Update the difference between informations in present
3452 msgdb and in current folder instance.
3453 Do not retrieve killed messages.
3454 update-entirely Update the difference between informations in present
3455 msgdb and in current folder instance.
3456 Retrieve killed messages, too.
3457 rescan Redisplay summary by rescanning present msgdb.
3458 rescan-noscore Redisplay summary by rescanning present msgdb.
3459 Display messages killed by score, too.
3460 cache-status Sync the all marks with the real status of cache.
3463 first:NUM Move to the filter folder(partial filter).
3464 last:NUM Move to the filter folder(partial filter).
3469 (@code{wl-summary-sync})
3473 @findex wl-summary-sort
3475 You can sort by @samp{date}, @samp{from}, @samp{number}, @samp{subject},
3476 @samp{size} and @samp{list-info}.
3477 (@code{wl-summary-sort})
3481 @findex wl-summary-toggle-thread
3482 Toggle the threading. The state will be preserved after exiting
3483 Wanderlust. You can alter default state for newly created summary
3484 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3485 Threading status is displayed on the modeline.
3486 @samp{@{S@}} means threading is off (Sequence) and
3487 @samp{@{T@}} means threading is on (Thread).
3488 (@code{wl-summary-toggle-thread})
3492 @findex wl-summary-toggle-disp-folder
3493 Toggle displaying of folder window.
3494 (@code{wl-summary-toggle-disp-folder})
3498 Toggle displaying of message window.
3499 @findex wl-summary-toggle-disp-msg
3500 (@code{wl-summary-toggle-disp-msg})
3504 Move to the virtual folder (filter folder) with the condition specified.
3505 If called with prefix argument and current folder is virtual, exit it.
3506 @findex wl-summary-virtual
3507 (@code{wl-summary-virtual})
3510 @kindex @key{TAB} (Summary)
3511 @findex wl-summary-goto-last-displayed-msg
3512 Jump to the message which is displayed last.
3513 (@code{wl-summary-goto-last-displayed-msg})
3517 Put @samp{*} mark on the messages that satisfies the specified condition.
3518 @findex wl-summary-pick
3519 (@code{wl-summary-pick})
3523 @findex wl-summary-mark-as-read
3524 Mark as read the message at the current cursor point.
3525 (@code{wl-summary-mark-as-read})
3529 Execute action for all temporary marks in the summary buffer.
3530 @findex wl-summary-exec
3531 (@code{wl-summary-exec})
3535 @findex wl-summary-target-mark-line
3536 Put target mark on the message at the current cursor point.
3537 (@code{wl-summary-target-mark-line}) @xref{Mark and Action}.
3541 Put refile mark on the message at the current cursor point.
3542 @findex wl-summary-refile
3543 (@code{wl-summary-refile}) @xref{Mark and Action}.
3546 @kindex C-o (Summary)
3547 Execute auto refile.
3548 @findex wl-summary-auto-refile
3549 (@code{wl-summary-auto-refile})
3553 Put copy mark on the message at the current cursor point.
3554 @findex wl-summary-copy
3555 (@code{wl-summary-copy}) @xref{Mark and Action}.
3558 @kindex M-o (Summary)
3559 Put refile mark on the message at the current cursor point with the destination
3560 previously specified.
3561 @findex wl-summary-refile-prev-destination
3562 (@code{wl-summary-refile-prev-destination})
3566 @findex wl-summary-dispose
3567 Put disposal mark on the message at the current cursor point.
3568 The result of disposal is controlled by @code{wl-dispose-folder-alist},
3569 refiled to @code{wl-trash-folder} by default.
3570 (@code{wl-summary-dispose}) @xref{Mark and Action}.
3574 @findex wl-summary-delete
3575 Put force deletion mark on the message at the current cursor point.
3576 (@code{wl-summary-delete}) @xref{Mark and Action}.
3580 Put prefetch reservation mark on the message at the current cursor point.
3581 @findex wl-summary-prefetch
3582 (@code{wl-summary-prefetch}) @xref{Mark and Action}.
3586 @findex wl-summary-resend
3587 Put resend reservation mark on the message at the current cursor point.
3588 (@code{wl-summary-resend}) @xref{Mark and Action}.
3592 @findex wl-summary-unmark
3593 Unmark the temporal mark on the message at the current cursor point.
3594 (@code{wl-summary-unmark})
3598 Unmark all the temporal marks.
3599 @findex wl-summary-unmark-all
3600 (@code{wl-summary-unmark-all})
3603 @kindex r R (Summary)
3604 @findex wl-summary-mark-as-read-region
3605 Mark as read messages in the specified region.
3606 (@code{wl-summary-mark-as-read-region})
3609 @kindex r $ (Summary)
3610 @findex wl-summary-mark-as-important-region
3611 Put @samp{important} flag on messages in the specified region.
3612 If already flagged as @samp{important}, remove the flag.
3613 (@code{wl-summary-mark-as-important-region})
3616 @kindex r F (Summary)
3617 @findex wl-summary-set-flags-region
3618 Put arbitrary global flag entered in the minibuffer on messages in
3620 (@code{wl-summary-set-flags-region})
3623 @kindex r ! (Summary)
3624 @findex wl-summary-mark-as-unread-region
3625 Mark as unread messages in the specified region.
3626 (@code{wl-summary-mark-as-unread-region})
3629 @kindex r x (Summary)
3630 @findex wl-summary-exec-region
3631 Execute action for each temporary marks on the messages in the
3633 (@code{wl-summary-exec-region})
3636 @kindex r * (Summary)
3637 @findex wl-summary-target-mark-region
3638 Put target mark on the messages in the specified region.
3639 (@code{wl-summary-target-mark-region}) @xref{Mark and Action}.
3642 @kindex r o (Summary)
3643 @findex wl-summary-refile-region
3644 Put refile mark on the messages in the specified region.
3645 (@code{wl-summary-refile-region}) @xref{Mark and Action}.
3648 @kindex r O (Summary)
3649 @findex wl-summary-copy-region
3650 Put copy mark on the messages in the specified region.
3651 (@code{wl-summary-copy-region}) @xref{Mark and Action}.
3654 @kindex r d (Summary)
3655 @findex wl-summary-dispose-region
3656 Put disposal mark on the messages in the specified region.
3657 (@code{wl-summary-dispose-region}) @xref{Mark and Action}.
3660 @kindex r D (Summary)
3661 @findex wl-summary-delete-region
3662 Put force deletion mark on the messages in the specified region.
3663 (@code{wl-summary-delete-region}) @xref{Mark and Action}.
3666 @kindex r i (Summary)
3667 @findex wl-summary-prefetch-region
3668 Put prefetch reservation mark on messages in the specified region.
3669 (@code{wl-summary-prefetch-region}) @xref{Mark and Action}.
3672 @kindex r u (Summary)
3673 @findex wl-summary-unmark-region
3674 Delete temporal mark on the messages in the specified region.
3675 (@code{wl-summary-unmark-region})
3678 @kindex r y (Summary)
3679 Save messages in the specified region.
3680 @findex wl-summary-save-region
3681 (@code{wl-summary-save-region})
3684 @kindex t R (Summary)
3685 @findex wl-thread-mark-as-read
3686 Mark as read messages which are the descendant of the current thread.
3687 With prefix argument, it affects on the all messages in the thread tree.
3688 (@code{wl-thread-mark-as-read})
3691 @kindex t $ (Summary)
3692 @findex wl-thread-mark-as-important
3693 Put @samp{important} flag on the messages which are the descendant of
3694 the current thread. If already flagged as @samp{important}, remove the
3695 flag. With prefix argument, it affects on the all messages in the
3697 (@code{wl-thread-mark-as-important})
3700 @kindex t F (Summary)
3701 @findex wl-thread-set-flags
3702 Put arbitrary global flag entered in the minibuffer on the messages
3703 which are the descendant of the current thread. With prefix argument,
3704 it affects on the all messages in the thread tree.
3705 (@code{wl-thread-set-flags})
3708 @kindex t ! (Summary)
3709 @findex wl-thread-mark-as-unread
3710 Mark as unread messages which are the descendant of the current thread.
3711 With prefix argument, it affects on the all messages in the thread tree.
3712 (@code{wl-thread-mark-as-unread})
3715 @kindex t x (Summary)
3716 @findex wl-thread-exec
3717 Execute action for temporary marks on the messages which are
3718 the descendant of the current thread. With prefix argument, it affects
3719 on the all messages in the thread tree.
3720 (@code{wl-thread-exec})
3723 @kindex t * (Summary)
3724 @findex wl-thread-target-mark
3725 Put target mark @samp{*} on the messages which are the descendant of the
3726 current thread. With prefix argument, it affects on the all messages in
3728 (@code{wl-thread-target-mark}) @xref{Mark and Action}.
3731 @kindex t o (Summary)
3732 @findex wl-thread-refile
3733 Put refile mark on the messages which are the descendant of the current thread.
3734 With prefix argument, it affects on the all messages in the thread tree.
3735 (@code{wl-thread-refile}) @xref{Mark and Action}.
3738 @kindex t O (Summary)
3739 @findex wl-thread-copy
3740 Put copy mark on the messages which are the descendant of the current thread.
3741 With prefix argument, it affects on the all messages in the thread tree.
3742 (@code{wl-thread-copy}) @xref{Mark and Action}.
3745 @kindex t d (Summary)
3746 @findex wl-thread-dispose
3747 Put disposal mark on the messages which are the descendant of the current thread.
3748 With prefix argument, it affects on the all messages in the thread tree.
3749 (@code{wl-thread-dispose}) @xref{Mark and Action}.
3752 @kindex t D (Summary)
3753 @findex wl-thread-delete
3754 Put force deletion mark on the messages which are the descendant of the
3756 (@code{wl-thread-delete}) @xref{Mark and Action}.
3759 @kindex t i (Summary)
3760 @findex wl-thread-prefetch
3761 Put prefetch reservation mark on messages which are the descendant of
3763 (@code{wl-thread-prefetch}) @xref{Mark and Action}.
3766 @kindex t u (Summary)
3767 @findex wl-thread-unmark
3768 Unmark temporal mark on the messages which are the descendant of the
3769 current thread. With prefix argument, it affects on the all messages in
3771 (@code{wl-thread-unmark})
3774 @kindex t y (Summary)
3775 @findex wl-thread-save
3776 Save messages which are the descendant of the current thread.
3777 With prefix argument, it affects on the all messages in the thread tree.
3778 (@code{wl-thread-save})
3781 @kindex m R (Summary)
3782 @findex wl-summary-target-mark-mark-as-read
3783 Mark as read all messages which have target mark @samp{*}.
3784 (@code{wl-summary-target-mark-mark-as-read})
3787 @kindex m $ (Summary)
3788 @findex wl-summary-target-mark-mark-as-important
3789 Put @samp{important} flag on all messages which have target mark @samp{*}.
3790 If already flagged as @samp{important}, remove the flag.
3791 (@code{wl-summary-target-mark-mark-as-important})
3794 @kindex m F (Summary)
3795 @findex wl-summary-target-mark-set-flags
3796 Put arbitrary global flag entered in the minibuffer on all messages
3797 which have target mark @samp{*}.
3798 (@code{wl-summary-target-mark-set-flags})
3801 @kindex m ! (Summary)
3802 @findex wl-summary-target-mark-mark-as-unread
3803 Mark as unread all messages which have target mark @samp{*}.
3804 (@code{wl-summary-target-mark-mark-as-unread})
3807 @kindex m o (Summary)
3808 @findex wl-summary-target-mark-refile
3809 Put refile mark on the messages which have target mark @samp{*}.
3810 (@code{wl-summary-target-mark-refile}) @xref{Mark and Action}.
3813 @kindex m O (Summary)
3814 @findex wl-summary-target-mark-copy
3815 Put copy mark on the messages which have target mark @samp{*}.
3816 (@code{wl-summary-target-mark-copy}) @xref{Mark and Action}.
3819 @kindex m d (Summary)
3820 @findex wl-summary-target-mark-dispose
3821 Put disposal mark on the messages which have target mark @samp{*}.
3822 (@code{wl-summary-target-mark-dispose}) @xref{Mark and Action}.
3825 @kindex m D (Summary)
3826 @findex wl-summary-target-mark-delete
3827 Put force deletion mark on the messages which have target mark @samp{*}.
3828 (@code{wl-summary-target-mark-delete}) @xref{Mark and Action}.
3831 @kindex m i (Summary)
3832 @findex wl-summary-target-mark-prefetch
3833 Put prefetch reservation mark on messages which have target mark @samp{*}.
3834 (@code{wl-summary-target-mark-prefetch}) @xref{Mark and Action}.
3837 @kindex m y (Summary)
3838 @findex wl-summary-target-mark-save
3839 Save messages which have target mark @samp{*}.
3840 (@code{wl-summary-target-mark-save})
3843 @kindex m u (Summary)
3844 Unmark all temporal marks.
3845 (@code{wl-summary-delete-all-temp-marks})
3846 @findex wl-summary-delete-all-temp-marks
3849 @kindex m a (Summary)
3850 Put target mark @samp{*} on the all messages.
3851 (@code{wl-summary-target-mark-all})
3852 @findex wl-summary-target-mark-all
3855 @kindex m t (Summary)
3856 Put target mark @samp{*} on the messages in the current thread.
3857 @findex wl-summary-target-mark-thread
3858 (@code{wl-summary-target-mark-thread})
3861 @kindex m r (Summary)
3862 @findex wl-summary-target-mark-region
3863 Put target mark @samp{*} on the messages in the specified region.
3864 (@code{wl-summary-target-mark-region})
3867 @kindex m A (Summary)
3868 @findex wl-summary-target-mark-reply-with-citation
3869 Prepare a draft which cites all messages which have target mark @samp{*}.
3870 (@code{wl-summary-target-mark-reply-with-citation})
3873 @kindex m f (Summary)
3874 @findex wl-summary-target-mark-forward
3875 Prepare a draft which forwards all messages which have target mark @samp{*}.
3876 (@code{wl-summary-target-mark-forward})
3879 @kindex m U (Summary)
3880 @findex wl-summary-target-mark-uudecode
3881 Uudecode the messages which have target mark @samp{*}.
3882 (@code{wl-summary-target-mark-uudecode})
3885 @kindex m ? (Summary)
3886 @findex wl-summary-target-mark-pick
3887 Pick messages from the @samp{*} marked messages.
3888 That is, @samp{*} marks on the messages are remained
3889 if the specified condition is satisfied.
3890 (@code{wl-summary-target-mark-pick})
3893 @kindex m # (Summary)
3894 @findex wl-summary-target-mark-print
3895 Print out all messages which have target mark @samp{*}.
3896 (@code{wl-summary-target-mark-print})
3899 @kindex m | (Summary)
3900 @findex wl-summary-target-mark-pipe
3901 Pipe content of each message with target mark @samp{*} to some specified
3903 (@code{wl-summary-target-mark-pipe})
3906 @kindex M-t (Summary)
3907 @findex wl-toggle-plugged
3908 Toggle offline/online status of Wanderlust.
3909 (@code{wl-toggle-plugged})
3912 @kindex C-t (Summary)
3913 Start Wanderlust's plug-status manager.
3914 (@code{wl-plugged-change})
3917 @kindex C-c C-o (Summary)
3918 @findex wl-jump-to-draft-buffer
3919 Move to the draft buffer if available. If multiple draft buffer exists,
3920 moved to one after another. If prefix argument is specified, load draft
3921 folder's message to the draft buffer and jump to it.
3922 (@code{wl-jump-to-draft-buffer})
3925 @kindex M-w (Summary)
3926 @findex wl-summary-save-current-message
3927 Save the message at the current cursor point.
3928 (@code{wl-summary-save-current-message})
3931 @kindex C-y (Summary)
3932 @findex wl-summary-yank-saved-message
3933 Regard the message at the current cursor point as
3934 parent, connect the message saved by
3935 @code{wl-summary-save-current-message}
3937 (@code{wl-summary-yank-saved-message})
3940 @kindex C-x C-s (Summary)
3941 @findex wl-summary-save-status
3942 Save the current summary.
3943 (@code{wl-summary-save-status})
3947 @node Variables of Summary, , Key Bindings of Summary, Summary
3948 @section Customiziable variables
3951 @item wl-summary-move-order
3952 @vindex wl-summary-move-order
3953 The initial setting is @code{unread}. Specify cursor moving policy. If
3954 you want to precede new messages, set @code{new}. If you want to
3955 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3958 @item wl-auto-select-first
3959 @vindex wl-auto-select-first
3960 The initial setting is @code{nil}.
3961 If non-nil, first message is automatically displayed when you enter
3964 @item wl-auto-select-next
3965 @vindex wl-auto-select-next
3966 The initial setting is @code{nil}. This controls behavior when there is
3967 no unread message in current summary.
3970 nil: asks whether you want to go back to folder mode
3971 'unread: asks whether you want to go to next unread folder
3972 If the next one comes to be possessing no unread message
3973 by treatment of cross-posted messages or Scoring, then
3974 asks whether you want to go to next to next folder.
3975 'skip-no-unread: similar as unread
3976 But does not ask before going to next to next folder.
3977 otherwise: asks whether you want to go to next unread folder
3980 It might be useful to set @code{'skip-no-unread} for people who
3981 want to continue reading by just pressing and pressing space key.
3983 @item wl-thread-insert-opened
3984 @vindex wl-thread-insert-opened
3985 The initial setting is @code{nil}.
3986 If non-nil, thread is inserted as opened.
3988 @item wl-thread-open-reading-thread
3989 @vindex wl-thread-open-reading-thread
3990 The initial setting is @code{t}. If non-nil, reading thread is
3991 automatically opened though it is closed thread.
3993 @item wl-summary-exit-next-move
3994 @vindex wl-summary-exit-next-move
3995 The initial setting is @code{t}. If non-nil, move to next folder at
3998 @item wl-folder-move-cur-folder
3999 @vindex wl-folder-move-cur-folder
4000 The initial setting is @code{nil}. If non-nil, cursor position on the
4003 @item wl-summary-weekday-name-lang
4004 @vindex wl-summary-weekday-name-lang
4005 Specify language of the weekday.
4006 @samp{en} displays English, @samp{fr} displays French, @samp{de}
4007 displays Deutsch. You should rescan summary view after changing this value.
4009 @item wl-summary-fix-timezone
4010 @vindex wl-summary-fix-timezone
4011 The initial setting is @code{nil}.
4012 Time zone of the date string in summary mode is adjusted using this value.
4013 If @code{nil}, it is adjust to the default time zone information
4014 (system's default time zone or environment variable @samp{TZ}).
4016 @item wl-use-petname
4017 @vindex wl-use-petname
4018 The initial setting is @code{t}.
4019 If non-nil, sender part displays nickname.
4021 @item wl-break-pages
4022 @vindex wl-break-pages
4023 The initial setting is @code{t}.
4024 If non-nil, message is split as pages by @samp{^L}.
4026 @item wl-message-window-size
4027 @vindex wl-message-window-size
4028 The initial setting is '(1 . 4).
4029 A cons cell to specify the rate of summary and message window.
4030 car:cdr corresponds summary:message.
4032 @item wl-summary-from-function
4033 @vindex wl-summary-from-function
4034 Format function to display sender in summary.
4035 The initial setting is @code{wl-summary-default-from}.
4037 @item wl-summary-no-from-message
4038 @vindex wl-summary-no-from-message
4039 The initial setting is @samp{nobody@@nowhere?}. A string which is
4040 displayed when there's no @samp{From:} field in the message.
4042 @item wl-summary-subject-function
4043 @vindex wl-summary-subject-function
4044 Format function to display subject in summary.
4045 The initial setting is @code{wl-summary-default-subject} and
4046 it will cut the list name part etc. on the top of the subject.
4047 To display subject as it is, set as follows.
4050 (setq wl-summary-subject-function 'identity)
4053 @item wl-summary-no-subject-message
4054 @vindex wl-summary-no-subject-message
4055 The initial setting is @samp{(WL:No Subject in original.)}. A string
4056 which is displayed when there's no @samp{Subject:} field in the message.
4058 @item wl-summary-default-view
4059 @vindex wl-summary-default-view
4060 The initial setting is @code{'thread}.
4061 The default state for newly created summary. You can set either
4062 @code{'thread} for thread view or @code{'sequence} for sequential view.
4064 @item wl-summary-use-frame
4065 @vindex wl-summary-use-frame
4066 The initial setting is @code{nil}.
4067 If non-nil, use new frame for the summary.
4069 @item wl-use-folder-petname
4070 @vindex wl-use-folder-petname
4071 The initial setting is the list shown below:
4080 A list of display policy (symbol) of folder nickname. Available symbols
4085 Display folder petname on modeline.
4087 Destination folder is notified as nickname if
4088 @code{wl-auto-select-next} is non-nil.
4090 You can input folder name by nickname in the function
4091 @code{wl-summary-read-folder}.
4094 @item wl-summary-move-direction-toggle
4095 @vindex wl-summary-move-direction-toggle
4096 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
4097 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
4098 want to aware of reading direction, set this to @code{t}.
4100 @item wl-summary-width
4101 @vindex wl-summary-width
4102 The initial setting is 80.
4103 Width of summary line. If @code{nil}, summary line's width is as is.
4105 @item wl-summary-print-argument-within-window
4106 @vindex wl-summary-print-argument-within-window
4107 The initial setting is @code{nil}.
4108 If non-nil, the action argument is always printed on right side of
4111 @item wl-summary-indent-length-limit
4112 @vindex wl-summary-indent-length-limit
4113 The initial setting is 46.
4114 Specify the limit of thread indent level. @code{nil} means unlimited
4116 If you set this to @code{nil} you should set @code{wl-summary-width}
4119 @item wl-summary-max-thread-depth
4120 @vindex wl-summary-max-thread-depth
4121 The initial setting is 15.
4122 If thread depth of the message is larger than this value,
4123 the thread is divided.
4125 @item wl-summary-recenter
4126 @vindex wl-summary-recenter
4127 The initial setting is t.
4128 If non-nil, cursor point is moved to the center of the summary window.
4130 @item wl-summary-max-thread-depth
4131 @vindex wl-summary-max-thread-depth
4132 The initial setting is 30.
4133 If thread depth is larger than this value, divide it.
4135 @item wl-summary-divide-thread-when-subject-changed
4136 @vindex wl-summary-divide-thread-when-subject-changed
4137 The initial setting is @code{nil}. If non-nil, thread is split if
4138 the subject is changed.
4140 @item wl-summary-search-via-nntp
4141 @vindex wl-summary-search-via-nntp
4142 The initial setting is @code{confirm}.
4144 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
4145 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
4146 from the NNTP server @code{elmo-nntp-default-server}. The value of
4147 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
4148 @code{elmo-nntp-default-stream-type} are used.
4150 If @code{confirm}, server name can be specified. You can specify NNTP
4151 folder format like @samp{-:username@@servername:119!}.
4153 @item wl-summary-keep-cursor-command
4154 @vindex wl-summary-keep-cursor-command
4155 The initial setting is the list shown below:
4159 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
4164 When you entered to summary by these commands and the target summary
4165 buffer already exists, summary status is not automatically updated and
4166 cursor position is saved.
4168 @item elmo-folder-update-threshold
4169 @vindex elmo-folder-update-threshold
4170 The initial setting is 500. If updated message number is larger than
4171 this value, confirm whether drop them or not (in the case where the value
4172 of @code{elmo-folder-update-confirm} is non-nil).
4174 @item elmo-folder-update-confirm
4175 @vindex elmo-folder-update-confirm
4176 The initial setting is @code{t}. If the value is non-nil, do check with
4177 @code{elmo-folder-update-threshold}.
4179 @item wl-summary-always-sticky-folder-list
4180 @vindex wl-summary-always-sticky-folder-list
4181 The initial setting is @code{nil}.
4182 @code{wl-summary-always-sticky-folder-list} specifies the folders that
4183 are automatically stuck. Each element is regexp of folder name.
4185 @item wl-summary-reserve-mark-list
4186 @vindex wl-summary-reserve-mark-list
4187 The initial setting is the list shown below:
4191 ("o" "O" "D" "d" "i")
4196 If a message is already marked as temporal marks in this list, the
4197 message is not marked by any mark command.
4199 @item wl-summary-skip-mark-list
4200 @vindex wl-summary-skip-mark-list
4201 The initial setting is the list shown below:
4210 If a message is already marked as temporal marks in this list, the
4211 message is skipped at cursor move.
4213 @item elmo-message-fetch-threshold
4214 @vindex elmo-message-fetch-threshold
4215 The initial setting is 30000 (bytes). If displaying message has larger
4216 size than this value, Wanderlust confirms whether fetch the message or
4217 not (in the case where the value of @code{elmo-message-fetch-confirm}
4220 @item elmo-message-fetch-confirm
4221 @vindex elmo-message-fetch-confirm
4222 The initial setting is @code{t}. If the value is non-nil, do check with
4223 @code{elmo-message-fetch-threshold}.
4225 @item wl-prefetch-threshold
4226 @vindex wl-prefetch-threshold
4227 The initial setting is 30000 (bytes). If prefetching message has larger
4228 size than this value and @code{wl-prefetch-confirm} is non-nil,
4229 Wanderlust confirms whether prefetch the message or not. If
4230 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
4231 without confirmation.
4233 @item wl-prefetch-confirm
4234 @vindex wl-prefetch-confirm
4235 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4236 prefetch the message or not if the message has larger size than
4237 @code{wl-prefetch-threshold}.
4239 @item elmo-imap4-use-cache
4240 @vindex elmo-imap4-use-cache
4241 The initial setting is @code{t}. If non-nil, messages read via IMAP4
4244 @item elmo-nntp-use-cache
4245 @vindex elmo-nntp-use-cache
4246 The initial setting is @code{t}. If non-nil, messages read via NNTP are
4249 @item elmo-pop3-use-cache
4250 @vindex elmo-pop3-use-cache
4251 The initial setting is @code{t}. If non-nil, messages read via POP3 are
4254 @item elmo-shimbun-use-cache
4255 @vindex elmo-shimbun-use-cache
4256 The initial setting is @code{t}. If non-nil, messages read in Shimbun
4259 @item wl-folder-process-duplicates-alist
4260 @vindex wl-folder-process-duplicates-alist
4261 The initial setting is @code{nil}.
4262 This list determines how to deal with duplicated messages in the same folder.
4263 Each item in the list is regexp of folder name and action; you can specify any
4264 one of the following in the place of action:
4267 @code{nil} : do nothing for duplicated messages.
4268 @code{hide} : hide duplicated messages from the summary.
4269 @code{read} : set duplicated messages as read.
4273 Following is an example (hide duplicated messages in multi folders)
4277 (setq wl-folder-process-duplicates-alist
4278 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4279 ("^\\*.*" . hide) (".*" . read)))
4283 @item wl-summary-flag-alist
4284 @vindex wl-summary-flag-alist
4285 The initial setting is as follows:
4289 ((important "orange"))
4293 Specify the color of message in summary buffer with flag. If multiple
4294 global flags are on one message, the former flag in this list is
4299 @node Message, Draft, Summary, Top
4300 @chapter Message Buffer
4302 Message Buffers utilize MIME-View mode of SEMI. For operational
4303 procedures and key bindings, refer to respective documents.
4304 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4305 You can also see help by @kbd{?} in message buffer.
4307 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4308 brings you back to Summary mode. @kbd{l} toggles display of Summary
4311 @section Key Bindings
4317 @findex wl-message-toggle-disp-summary
4318 Toggles display of Summary buffer.
4319 (@code{wl-message-toggle-disp-summary})
4322 @findex wl-message-refer-article-or-url
4323 @kindex Button-2 (Message)
4324 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4325 corresponding message if found.
4326 (@code{wl-message-refer-article-or-url})
4328 @item Button-4 (upward movement of a wheel)
4329 @kindex Button-4 (Message)
4330 @findex wl-message-wheel-down
4331 Scrolls the message backwards. When the top of the message is hit,
4332 moves to the previous message.
4333 (@code{wl-message-wheel-down})
4335 @item Button-5 (downward movement of a wheel)
4336 @kindex Button-5 (Message)
4337 @findex wl-message-wheel-up
4338 Scrolls the message forward. When the bottom of the message is hit,
4339 moves to the next message.
4340 (@code{wl-message-wheel-up})
4344 @findex wl-message-delete-current-part
4345 Delete the part under cursor. In fact it appends modified message to
4346 the current folder then moves old one to trash folder. Therefore the
4347 message number will be changed.
4348 (@code{wl-message-delete-current-part})
4351 @section Customizable Variables
4354 @item wl-message-window-size
4355 @vindex wl-message-window-size
4356 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4357 its car and cdr value corresponds to the ratio of Summary and Message
4360 @item wl-message-ignored-field-list
4361 @vindex wl-message-ignored-field-list
4362 Initial setting is @code{nil}.
4363 All fields that match this list will be hidden in message buffer.
4364 Each elements are regexp of field-name.
4365 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4367 @item wl-message-visible-field-list
4368 @vindex wl-message-visible-field-list
4369 Initial setting is @code{nil}.
4370 All fields that match this list will be display in message buffer.
4371 Each elements are regexp of field-name. This value precedes
4372 @code{wl-message-ignored-field-list}.
4373 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4375 @item wl-message-sort-field-list
4376 @vindex wl-message-sort-field-list
4378 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4379 Header fields in message buffer are ordered by this value.
4380 Each elements are regexp of field-name.
4382 @item wl-message-truncate-lines
4383 @vindex wl-message-truncate-lines
4384 The initial value is the value of @code{default-truncate-lines}.
4385 If it is non-nil, truncate long lines in message buffer.
4388 @node Draft, Disconnected Operations, Message, Top
4389 @chapter Draft Buffer
4391 At Summary mode, pressing @kbd{w} and the like creates a new draft
4392 buffer. You can edit and send mail and news articles in this buffer.
4394 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4395 with those if possible.
4398 * Usage of Draft Mode:: TIPS
4399 * Key Bindings of Draft:: Key bindings
4400 * Variables of Draft Mode:: Customize Draft Mode
4403 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4406 Basically it is Emacs-standard mail mode.
4410 * Editing Message Body and Sending::
4411 * Dynamical Message Re-arrangement::
4416 @node Editing Header, Editing Message Body and Sending, Usage of Draft Mode, Usage of Draft Mode
4417 @subsection Editing Message Header
4419 You can freely edit header region above @samp{--text follows this line--},
4420 until you invoke the sending operation.
4422 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4423 addresses. @kbd{@key{TAB}} completes them.
4425 You can use following headers to specify recipients. Add some of them
4426 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4429 @item @samp{Newsgroups:}
4430 Specify newsgroups to which you post the news article.
4433 Specify addresses to send a copy (Carbon Copy) of the message.
4436 Following ones are removed from the header contents before sending.
4440 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4443 Specify folders in which a copy of the message is saved.
4446 Specify recipients to send encapsulated copy of the message.
4449 You can add initial headers by following variables.
4455 The initial setting is @code{nil}.
4456 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4457 the draft when it is prepared. If function is specified, its return
4462 The initial setting is @code{nil}.
4463 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4464 the draft when it is prepared.
4467 @node Editing Message Body and Sending, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4468 @subsection Editing Messages and Sending
4470 As a matter of course, editing message body can be performed in the same
4471 way as usual writing. You may write message body under
4472 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4473 @samp{--text follows this line--} intact.)
4475 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4476 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4477 a MIME user interface for GNU Emacs}.
4478 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4480 If you save the draft buffer you are editing, it is appended to the
4481 folder specified by @code{wl-draft-folder}. You can leave draft buffer
4482 after storing it for future editing by @kbd{C-c C-z} (@code{wl-draft-save-and-exit}).
4484 If you have finished editing, you can send message by @kbd{C-c C-c}.
4487 @node Dynamical Message Re-arrangement, Template, Editing Message Body and Sending, Usage of Draft Mode
4488 @subsection Dynamic Modification of Messages
4489 @vindex wl-draft-config-alist
4490 @c @cindex Change Message
4491 @c @cindex Message, Change Dynamic
4493 You can set @code{wl-draft-config-alist} so that header and body of the
4494 message will automatically modified depending on information of header
4497 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4499 In the example below, the header is modified when
4500 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4501 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4502 before sending the message.
4506 (setq wl-draft-config-alist
4507 '(((string-match "aaa\\.example\\.com$" (system-name))
4508 ;; @r{applied if the expression is non-nil}
4509 (wl-smtp-posting-server . "mailserver-B")
4510 (wl-nntp-posting-server . "newsserver-B")
4511 ;; @r{settings of temporary variables}
4513 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4514 ;; @r{applied if it matches the header of the draft buffer}
4515 ("Organization" . (format "Go %s" my-webpage)))
4516 ;; @r{you can write elisp expressions here (eval only)}
4517 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4518 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4523 The format of @code{wl-draft-config-alist} is:
4527 '(("@var{regexp of the header}" or @var{elisp expression}
4528 ("@var{Field}" . value(@var{elisp expression}))
4529 (@var{variable} . value(@var{elisp expression}))
4530 (@var{sub-function} . value(@var{elisp expression}))
4533 ("@var{regexp of the header}" or @var{elisp expression}
4534 ("@var{Field}" . value(@var{elisp expression}))
4539 Per default, there are 13 following sub-functions.
4542 'header: Inserts the specified string at the bottom of the header.
4543 'header-top: Inserts the specified string at the top of the header.
4544 'header-file: Inserts the specified file at the bottom of the header.
4545 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4546 'top: Inserts the specified string at the top of the body.
4547 'top-file: Inserts the specified file at the top of the body.
4548 'body: Replaces the body with the specified string.
4549 Specifying @code{nil} deletes the entire body string.
4550 'body-file: Replaces the body with the content of the specified file.
4551 'bottom: Inserts the specified string at the bottom of the body.
4552 'bottom-file: Inserts the specified file at the top of the body.
4553 'part-top: Inserts the specified string at the top of the current part.
4554 'part-bottom: Inserts the specified string at the bottom of the current part.
4555 'template: Applies the specified template.
4556 (refer to the next subsection)
4559 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4560 change them or add your own functions. If you read the code, you can
4561 easily find how to write the functions.
4563 At the first of each item, @var{a regular expression of the header} or
4564 an @var{elisp expression} should be specified. In the case of an elisp
4565 expression, the item is applied when the expression is evaluated
4568 Per default, when multiple items match or are evaluated non-nil, all
4569 such items are applied, but if you set a variable
4570 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4573 At the second of the item, a cons or a list of functions should be
4574 specified. The car part of the cons should be a header field, a
4575 variable, or a sub-function. When a header field is specified, the
4576 field will be modified. If a variable is specified, the value of the
4577 variable will be modified temporarily.
4579 In the cdr part of a cons, not only a variable but also an elisp
4580 expression can be specified as is. If the car part is a header field
4581 and the cdr part is @code{nil}, the field will be deleted.
4583 See the next example as well:
4587 (setq wl-draft-config-alist
4589 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4590 ;; @r{applied if it matches the header of the buffer being replied}
4591 (body . " Hello.\n")
4592 (template . "default")
4597 As in the (1) above, if a header regexp is prepended with @code{reply},
4598 it is applied when the draft is prepared by @code{wl-summary-reply} for
4599 example, and when it matches the header being replied. It is ignored
4600 when there is no buffer being replied, like after @code{wl-draft} was
4603 If you want to use name of parent folder, you can refer the buffer local
4604 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4605 changes From according to the folder name of the summary in which the draft
4610 (setq wl-draft-config-alist
4611 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4612 (\"From\" . \"user@@domain1\"))
4613 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4614 (\"From\" . \"user@@domain2\"))))
4619 Note that @code{wl-draft-config-alist} is applied only once when
4620 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4621 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4622 aborting transmission, execute @kbd{C-c C-e}
4623 (@code{wl-draft-config-exec}) explicitly.
4625 If you don't want to apply @code{wl-draft-config-alist} when
4626 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4630 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4633 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4634 prepared, do the following:
4637 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4640 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4641 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4645 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4648 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4649 @subsection Inserting Templates
4651 @cindex Apply Template
4653 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4654 @kbd{M-x wl-template-select} in the draft buffer.
4656 The format of @code{wl-template-alist} is almost the same as
4657 @code{wl-draft-config-alist}.
4658 @xref{Dynamical Message Re-arrangement}.
4662 (setq wl-template-alist
4665 ("Organization" . "Example Co.Ltd.")
4666 (body . "Hello.\n"))
4668 (template . "default") ;; @r{(a)}
4669 ("To" . "boss@@example.com")
4670 ("Subject" . "Report")
4671 (body-file . "~/work/report.txt")
4677 As you can see, the only difference is item (template) names such as
4678 @samp{default} and @samp{report}, instead of a regexp of header.
4679 Because definition of each item is the same as
4680 @code{wl-draft-config-alist}, you can call another template, like (a).
4682 Executing the command @code{wl-template-select} results in template
4683 selection, but the result differs depending on variable
4684 @code{wl-template-visible-select}.
4686 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4687 window is shown below the draft buffer. You can select a template by
4688 @kbd{n} and @kbd{p} seeing the buffer window.
4690 Press the @key{RET} key and the template is actually applied to the draft
4691 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4692 adjust the window size by @code{wl-template-buffer-lines}.
4694 If @code{wl-template-visible-select} is @code{nil}, you should type the
4695 name of the template in the mini buffer.
4697 As shown in the example in @code{wl-draft-config-alist}, you can select
4698 @samp{default} template by writing:
4701 (template . "default")
4704 @node POP-before-SMTP, , Template, Usage of Draft Mode
4705 @subsection Sending mail by POP-before-SMTP
4706 @cindex POP-before-SMTP
4708 You can send mail by POP-before-SMTP with this single line:
4711 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4715 Configure the following variables if you need.
4718 @item wl-pop-before-smtp-user
4719 The POP user name for POP-before-SMTP authentication.
4720 If unset, @code{elmo-pop3-default-user} is used.
4722 @item wl-pop-before-smtp-server
4723 The POP server name for POP-before-SMTP authentication.
4724 If unset, @code{elmo-pop3-default-server} is used.
4726 @item wl-pop-before-smtp-authenticate-type
4727 The POP authentication method for POP-before-SMTP authentication.
4728 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4730 @item wl-pop-before-smtp-port
4731 The POP port number for POP-before-SMTP authentication.
4732 If unset, @code{elmo-pop3-default-port} is used.
4734 @item wl-pop-before-smtp-stream-type
4735 If @code{ssl}, POP connection is established using SSL. If
4736 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4737 unset, @code{elmo-pop3-default-stream-type} is used.
4740 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4741 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4743 Therefore, if SMTP server and POP server are actually the same, and if
4744 POP folder per default (such as @samp{&}) is available, no settings are
4747 Refer to the following URL about POP-before-SMTP.
4751 http://spam.ayamura.org/tools/smPbS.html
4752 http://www.iecc.com/pop-before-smtp.html
4757 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4758 @section Key Bindings
4759 @cindex Keybind, Draft Mode
4760 @cindex Keybind, Draft Buffer
4765 @kindex C-c C-y (Draft)
4766 @findex wl-draft-yank-original
4767 Cites the content of the current message buffer (the part under cursor).
4768 If the region is active, cites the region (it affects only if
4769 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4770 (on XEmacs) is Non-nil).
4771 (@code{wl-draft-yank-original})
4774 @kindex C-c C-p (Draft)
4775 @findex wl-draft-preview-message
4776 Previews the content of the current draft.
4777 This is useful for previewing MIME multi-part messages.
4778 (@code{wl-draft-preview-message})
4781 @kindex C-c C-s (Draft)
4782 @findex wl-draft-send
4783 Sends the content of the current draft. Does not erase the draft buffer.
4784 This is useful for sending multiple messages, which are a little different
4786 (@code{wl-draft-send})
4789 @kindex C-c C-c (Draft)
4790 @findex wl-draft-send-and-exit
4791 Sends the content of the current draft and erases the draft buffer.
4792 (@code{wl-draft-send-and-exit})
4795 @kindex C-x C-s (Draft)
4796 @findex wl-draft-save
4797 Save the current draft.
4798 (@code{wl-draft-save})
4801 @kindex C-c C-k (Draft)
4802 @findex wl-draft-kill
4803 Kills the current draft.
4804 (@code{wl-draft-kill})
4807 @kindex C-x k (Draft)
4808 @findex wl-draft-mimic-kill-buffer
4809 Kills the current draft.
4810 (@code{wl-draft-mimic-kill-buffer})
4813 @kindex C-c C-z (Draft)
4814 @findex wl-draft-save-and-exit
4815 Saves the current draft, and erases the draft buffer.
4816 This is useful if you want to suspend editing of the draft.
4817 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4818 the @samp{+draft} folder.
4819 (@code{wl-draft-save-and-exit})
4822 @kindex C-c C-r (Draft)
4823 @findex wl-caesar-region
4824 Encodes or decodes the specified region in Caesar cipher.
4825 (@code{wl-caesar-region})
4829 @findex wl-draft-highlight-and-recenter
4830 Recenter and rehighlight current draft.
4831 (@code{wl-draft-highlight-and-recenter})
4835 @findex wl-toggle-plugged
4836 Toggles off-line/on-line states of Wanderlust.
4837 (@code{wl-toggle-plugged})
4840 @kindex C-c C-o (Draft)
4841 @findex wl-jump-to-draft-buffer
4842 Jumps to the other draft buffer, if exists.
4843 With prefix argument, reads a file (if any) from the draft folder when
4844 there is no such buffer.
4845 (@code{wl-jump-to-draft-buffer})
4848 @kindex C-c C-e (Draft)
4849 @findex wl-draft-config-exec
4850 Applies @code{wl-draft-config-alist}.
4851 (@code{wl-draft-config-exec})
4854 @kindex C-c C-j (Draft)
4855 @findex wl-template-select
4857 (@code{wl-template-select})
4860 @kindex C-c C-a (Draft)
4862 Enter Address Manager.
4863 @xref{Address Manager}.
4867 @kindex C-c C-d (Draft)
4868 @findex wl-draft-elide-region
4869 Elide the text between point and mark (@code{wl-draft-elide-region}).
4870 The text is killed and replaced with the contents of the variable
4871 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4875 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4876 @section Customizable Variables
4880 @item wl-subscribed-mailing-list
4881 @vindex wl-subscribed-mailing-list
4882 The initial setting is @code{nil}. Mailing lists to which you
4883 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4884 field of a reply draft, removes your own address from
4885 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4886 contained in @samp{To:} or @samp{Cc:} field of a message to be
4887 automatically re-filed, the destination folder will be leaned in
4888 connection with the address.
4894 (setq wl-subscribed-mailing-list
4895 '("wl@@lists.airs.net"
4897 "emacs-mime-ja@@m17n.org"))
4901 @item wl-insert-mail-followup-to
4902 @vindex wl-insert-mail-followup-to
4903 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4904 field is automatically inserted in the draft buffer.
4906 @item wl-insert-mail-reply-to
4907 @vindex wl-insert-mail-reply-to
4908 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4909 field is automatically inserted in the draft buffer.
4911 @item wl-auto-insert-x-face
4912 @vindex wl-auto-insert-x-face
4913 The initial setting is @code{t}. If non-nil and there is an encoded
4914 X-Face string in a file @file{~/.xface} (the value of the variable
4915 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4916 draft buffer. If @code{nil}, it is not automatically inserted.
4918 @item wl-insert-message-id
4919 @vindex wl-insert-message-id
4920 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4921 is automatically inserted on the transmission.
4923 @item wl-message-id-use-wl-from
4924 @vindex wl-message-id-use-wl-from
4925 The initial setting is @code{nil}. If non-nil, the value of
4926 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4928 @item wl-local-domain
4929 @vindex wl-local-domain
4930 The initial setting is @code{nil}. If @code{nil}, the return value of
4931 the function @code{system-name} will be used as the domain part of
4934 If @code{system-name} does not return FQDN (i.e. the full name of the
4935 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4936 to the string of the local domain name without hostname (like
4937 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4938 @samp{.} @code{wl-local-domain} is used as domain part of the
4941 If your terminal does not have global IP, set the value of
4942 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4943 you use invalid @samp{Message-ID:}.)
4945 Moreover, concatenation of @code{system-name} @samp{.}
4946 @code{wl-local-domain} will be used as an argument to the HELO command
4949 @item wl-message-id-domain
4950 @vindex wl-message-id-domain
4951 The initial setting is @code{nil}. If non-nil, this value is used as a
4952 domain part of the @samp{Message-ID:}. If your terminal does not have
4953 global IP address, set unique string to this value (e.x. your e-mail
4956 @item wl-unique-id-suffix
4957 @vindex wl-unique-id-suffix
4958 The initial setting is @samp{.wl}. You can specify the string in generated
4959 Message-ID which appear just before @samp{@@}.
4961 @item wl-draft-config-alist
4962 @vindex wl-draft-config-alist
4963 The initial setting is @code{nil}. Modifies the draft message just
4964 before the transmission. The content of @code{wl-draft-config-alist}
4965 will be automatically applied only once on the transmission. If you
4966 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4969 @item wl-template-alist
4970 @vindex wl-template-alist
4971 The initial setting is @code{nil}.
4972 This variable specifies the template to be applied in the draft buffer.
4974 @item wl-draft-config-matchone
4975 @vindex wl-draft-config-matchone
4976 The initial setting is @code{nil}. If non-nil, only the first matching
4977 item is used when @code{wl-draft-config-alist} is applied. If
4978 @code{nil}, all matching items are used.
4980 @item wl-template-visible-select
4981 @vindex wl-template-visible-select
4982 The initial setting is @code{t}.
4983 If non-nil, you can preview the result of the template selection in
4986 @item wl-template-confirm
4987 @vindex wl-template-confirm
4988 The initial setting is @code{nil}.
4989 If non-nil, asks for confirmation when you press the enter key to select
4990 template while previewing.
4992 @item wl-template-buffer-lines
4993 @vindex wl-template-buffer-lines
4994 The initial setting is 7.
4995 If @code{wl-template-visible-select} is non-nil, this variable specifies
4996 the size of the preview window.
4998 @item wl-draft-buffer-style
4999 @vindex wl-draft-buffer-style
5000 The initial setting is @code{full}.
5001 Style of draft buffer window (except for replying and forwarding).
5002 @code{keep} is to use current window,
5003 @code{full} is to use full frame window,
5004 @code{split} is to split current window and use it.
5005 If some function is specified, it is called with the draft buffer
5008 @item wl-draft-reply-buffer-style
5009 @vindex wl-draft-reply-buffer-style
5010 The initial setting is @code{split}.
5011 Style of draft buffer for replying and forwarding.
5012 @code{keep} is to use message buffer window,
5013 @code{full} is to use full frame window,
5014 @code{split} is to split message buffer window and use it.
5015 If some function is specified, it is called with the draft buffer
5018 @item wl-draft-use-frame
5019 @vindex wl-draft-use-frame
5020 The initial setting is @code{nil}.
5021 If non-nil, use new frame for the draft.
5023 @item wl-draft-reply-default-position
5024 @vindex wl-draft-reply-default-position
5025 The initial setting is @code{body}.
5026 Specify initial cursor position on draft buffer for reply.
5027 @code{body} is to move cursor to the top of the message body,
5028 @code{bottom} to the bottom of the message body, and @code{top} to the
5031 @item wl-draft-truncate-lines
5032 @vindex wl-draft-truncate-lines
5033 The initial value is the value of @code{default-truncate-lines}.
5034 If it is non-nil, truncate long lines in draft buffer.
5038 The initial setting is the value of the variable
5039 @code{user-mail-address}. The value of this variable is inserted as a
5040 @samp{From:} field of the draft when it is prepared.
5042 @item wl-envelope-from
5043 @vindex wl-envelope-from
5044 The initial setting is @code{nil}.
5045 The value of this variable is used for envelope from (MAIL FROM).
5046 If @code{nil}, the address part of @code{wl-from} is used.
5048 @item wl-user-mail-address-list
5049 @vindex wl-user-mail-address-list
5050 The initial setting is @code{nil}.
5051 This is the User's address list. If you have multiple addresses,
5054 @item wl-reply-subject-prefix
5055 @vindex wl-reply-subject-prefix
5056 The initial setting is @samp{Re: }.
5057 In the @samp{Subject:} of the reply draft, this string is prepended to
5058 the @samp{Subject:} of being replied. You can specify a function to be
5059 message buffer of the reply target.
5061 @item wl-forward-subject-prefix
5062 @vindex wl-forward-subject-prefix
5063 The initial setting is @samp{Forward: }.
5064 In the @samp{Subject:} of the forwarding draft, this string is prepended
5065 to the @samp{Subject:} of being forwarded. You can specify a function
5066 to be message buffer of the forward target.
5068 @item wl-draft-reply-use-address-with-full-name
5069 @vindex wl-draft-reply-use-address-with-full-name
5070 The initial setting is @code{t}.
5071 If non-nil, insert her full name with address when prepare a draft for
5072 reply a message. If it is @code{nil}, insert her address only.
5074 @item wl-draft-enable-queuing
5075 @vindex wl-draft-enable-queuing
5076 The initial setting is @code{t}.
5077 This flag controls off-line transmission. If non-nil, the draft is
5080 @item wl-draft-use-cache
5081 @vindex wl-draft-use-cache
5082 The initial setting is @code{nil}. If the value is non-nil and
5083 @code{wl-insert-message-id} is nil, cache the message which is sent.
5085 @item wl-fcc-force-as-read
5086 @vindex wl-fcc-force-as-read
5087 The initial setting is @code{nil}. If the value is non-nil,
5088 Mark as read the message saved by @samp{Fcc:}.
5090 @item wl-auto-flush-queue
5091 @vindex wl-auto-flush-queue
5092 The initial setting is t.
5093 This flag controls automatic transmission of the queue when Wanderlust
5094 becomes on-line. If non-nil, the queue is automatically transmitted
5095 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5096 manually, press @kbd{F} in the folder mode.
5098 @item wl-ignored-forwarded-headers
5099 @vindex wl-ignored-forwarded-headers
5100 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
5101 All headers that match this regexp will be deleted when forwarding a message.
5103 @item wl-ignored-resent-headers
5104 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
5105 All headers that match this regexp will be deleted when resending a message.
5107 @item wl-draft-always-delete-myself
5108 @vindex wl-draft-always-delete-myself
5109 If non-nil, always removes your own address from @samp{To:} and
5110 @samp{Cc:} when you are replying to the mail addressed to you.
5112 @item wl-draft-delete-myself-from-bcc-fcc
5113 @vindex wl-draft-delete-myself-from-bcc-fcc
5114 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
5115 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
5117 @item wl-smtp-posting-server
5118 @vindex wl-smtp-posting-server
5119 The initial setting is @code{nil}.
5120 This is the SMTP server name for mail transmission.
5122 @item wl-smtp-posting-port
5123 @vindex wl-smtp-posting-port
5124 The initial setting is @code{nil}.
5125 This is the SMTP port number for mail transmission.
5126 If @code{nil}, default SMTP port number (25) is used.
5128 @item wl-smtp-posting-user
5129 @vindex wl-smtp-posting-user
5130 The initial setting is @code{nil}.
5131 This is the user name for SMTP AUTH authentication.
5133 @item wl-smtp-authenticate-type
5134 @vindex wl-smtp-authenticate-type
5135 The initial setting is @code{nil}.
5136 This string-valued variable specifies the authentication method for SMTP
5137 AUTH authentication. You may specify @code{plain}, @code{cram-md5},
5138 @code{digest-md5}, @code{login}, etc. If @code{nil}, authentication
5139 will not be carried out.
5141 @item wl-smtp-connection-type
5142 @vindex wl-smtp-connection-type
5143 The initial setting is @code{nil}.
5144 This symbol-valued variable specifies how to establish SMTP connections.
5145 If @code{nil}, use default connection type.
5146 If it is @code{starttls}, use STARTTLS (RFC2595).
5147 If it is @code{ssl}, use SSL.
5149 @item wl-nntp-posting-server
5150 @vindex wl-nntp-posting-server
5151 The initial setting is @code{nil}.
5152 This is the NNTP server name used for news submission.
5153 If @code{nil}, @code{elmo-nntp-default-server} is used.
5155 @item wl-nntp-posting-user
5156 @vindex wl-nntp-posting-user
5157 The initial setting is @code{nil}.
5158 This is the user name for AUTHINFO authentication on news submission.
5159 If @code{nil}, @code{elmo-nntp-default-user} is used.
5160 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
5162 @item wl-nntp-posting-port
5163 @vindex wl-nntp-posting-port
5164 The initial setting is @code{nil}.
5165 This is the port number of the NNTP server used for news submission.
5166 If @code{nil}, @code{elmo-nntp-default-server} is used.
5168 @item wl-nntp-posting-stream-type
5169 @vindex wl-nntp-posting-stream-type
5170 The initial setting is @code{nil}.
5171 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If @code{ssl},
5172 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
5173 connection will be established.
5175 @item wl-nntp-posting-function
5176 @vindex wl-nntp-posting-function
5177 The initial setting is @code{elmo-nntp-post}.
5178 This is the function to post NNTP message.
5180 @item wl-nntp-posting-config-alist
5181 @vindex wl-nntp-posting-config-alist
5182 The initial setting is @code{nil}.
5183 The value takes an alist to define NNTP server like following example.
5184 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
5188 (setq wl-nntp-posting-config-alist
5189 '((",?gmane\\." . "news.gmane.org")
5191 ((server . "news-server")
5192 (user . "newsmaster")
5194 (function . elmo-nntp-post)))
5195 (".*" . "default-news-server")))
5199 @item wl-pop-before-smtp-user
5200 @vindex wl-pop-before-smtp-user
5201 The initial setting is @code{nil}.
5202 This is the POP user name for POP-before-SMTP.
5203 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
5205 @item wl-pop-before-smtp-server
5206 @vindex wl-pop-before-smtp-server
5207 The initial setting is @code{nil}.
5208 This is the POP server name for POP-before-SMTP.
5209 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
5211 @item wl-pop-before-smtp-authenticate-type
5212 @vindex wl-pop-before-smtp-authenticate-type
5213 The initial setting is @code{nil}.
5214 This is the authentication method for POP-before-SMTP authentication.
5215 If it is @code{nil}, @code{elmo-pop3-default-authenticate-type} is used.
5217 @item wl-pop-before-smtp-port
5218 @vindex wl-pop-before-smtp-port
5219 The initial setting is @code{nil}.
5220 This is the POP port number for POP-before-SMTP. If it is @code{nil},
5221 @code{elmo-pop3-default-port} is used.
5223 @item wl-pop-before-smtp-stream-type
5224 @vindex wl-pop-before-smtp-stream-type
5225 The initial setting is @code{nil}.
5226 This flag controls the use of SSL for POP-before-SMTP. If it is
5227 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{ssl},
5228 SSL is used. If @code{starttls}, STARTTLS (RFC2595) connection will be
5231 @item wl-draft-queue-save-variables
5232 @vindex wl-draft-queue-save-variables
5233 Specifies a list of variable to which queued messages are saved on the
5234 off-line transmission.
5236 @item wl-draft-sendlog
5237 @vindex wl-draft-sendlog
5238 The initial setting is @code{t}.
5239 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
5243 @item drafts are sent by smtp or qmail
5244 @item saved into folders by fcc
5245 @item saved into folders by queuing
5248 (it is written even if the transmission fails).
5249 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
5250 and left to the logging function of @command{imput}.
5253 @item wl-draft-sendlog-max-size
5254 @vindex wl-draft-sendlog-max-size
5255 The initial setting is 20000 (in bytes).
5256 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
5257 beyond the size specified by this variable.
5261 The initial setting is @code{nil}.
5262 If non-nil, address completion uses LDAP.
5264 @item wl-ldap-server
5265 @vindex wl-ldap-server
5266 The initial setting is @samp{localhost}.
5267 LDAP server name for address completion.
5270 @vindex wl-ldap-port
5271 The initial setting is @code{nil}.
5272 If non-nil, the value is used as port number.
5275 @vindex wl-ldap-base
5276 The initial setting is @samp{c=US}.
5277 LDAP search starting point (base) for address completion.
5279 @item wl-draft-remove-group-list-contents
5280 @vindex wl-draft-remove-group-list-contents
5281 The initial setting is @code{t}.
5282 If non-nil, remove the group-lists' members in the recipients when
5283 sending the message (group-list means the description such as
5284 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5287 @node Disconnected Operations, Expire and Archive, Draft, Top
5288 @chapter Off-line Management
5289 @cindex Disconnected Operations
5291 Wanderlust has on-line and off-line states.
5294 * Off-line State:: Wanderlust has on-line and off-line states
5295 * Enable Operations:: Enable Disconnected Operations
5296 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5297 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5298 * Variables of Plugged Mode:: Customize Plugged Mode
5302 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5303 @section Off-line State
5305 Wanderlust has on-line and off-line states. In the off-line state, you
5306 cannot access messages via network, unless they are cached.
5308 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5309 in the mode line indicates the off-line state. In folder or summary
5310 modes, press @kbd{M-t} to switch between off- and on-line.
5312 You can invoke Wanderlust in the off-line state by setting
5313 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5315 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5316 ignores uncached messages.
5319 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5320 @section Enable Disconeected Operations
5322 Even in the off-line state, provided that relevant messages are cached,
5323 and the variable @code{elmo-enable-disconnected-operation} (described
5324 later) is non-nil, you can following operations:
5325 @xref{Plugged Mode}, @xref{Off-line State settings}.
5328 * Send Messages off-line:: Transmit Messages
5329 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5330 * Creation of Folders:: Create Folders off-line (IMAP4)
5331 * Marking:: Mark (IMAP4)
5332 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
5335 As soon as Wanderlust becomes on-line, such operations invoked off-line
5336 are reflected in the servers via network.
5339 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5340 @subsection Transmission of Messages
5342 You can proceed sending operation for mail/news messages while you are
5343 off-line, then it will be reserved for sending (if you are using
5344 @file{im-wl.el}, it is irrelevant).
5345 Messages reserved for sending while off-line are accumulated in the
5346 queue folder, @samp{+queue}. These messages are transmitted at once when
5347 Wanderlust becomes on-line.
5349 You can visit @samp{+queue} in the off-line state and confirm content of
5350 messages in the queue. You can also remove messages. Removed messages
5351 are not transmitted even in the on-line state.
5354 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5355 @subsection Re-file and Copy (IMAP4)
5357 Re-file and copy operations to IMAP folders invoked during the off-line
5358 state are accumulated in the queue, and reflected in the server side
5359 when Wanderlust becomes on-line. If you visit destination folders after
5360 off-line re-file or copy, it looks as if messages were appended even in
5363 For the safety reasons, messages re-filed off-line are removed from
5364 source folders only if their @samp{Message-ID:} match messages on the
5365 servers. While the queue is processed, messages that failed to be
5366 re-filed or copied to the specified folders are appended to the folder
5370 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5371 @subsection Creation of Folders (IMAP4)
5373 You can create IMAP folders off-line. The creation of folders are
5374 reflected in the servers when Wanderlust becomes on-line. If the creation
5375 of those folders fails at that time for some reasons, messages
5376 to be re-filed into those are appended to the folder @samp{+lost+found}
5380 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5381 @subsection Marking (IMAP4)
5383 Off-line changes in unread/read and importance mark @samp{$} information
5384 are also reflected in the servers when Wanderlust becomes on-line.
5387 @node Pre-fetching Reservations, , Marking, Enable Operations
5388 @subsection Pre-fetching (IMAP4, NNTP)
5390 You can make reservations for pre-fetching messages in IMAP or NNTP
5391 folders. Reserved messages are marked with @samp{!} but not cached
5392 yet. When Wanderlust becomes on-line, they are pre-fetched from
5395 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5396 these off-line operations for IMAP4 and NNTP do not take place, and
5397 off-line re-file, copy or suchlike simply results in error.
5399 Because off-line operations use cache files, it is a bad idea to erase
5400 them by hand; it may cause Wanderlust to malfunction.
5402 If you want to remove caches, be sure to execute @kbd{M-x
5403 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5404 remove caches for messages relevant to off-line operations.
5407 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5408 @section Switching On-line/Off-line per Server/Port
5410 @kbd{M-t} described above switches networking states as a whole, but you
5411 can switch on-line/off-line per server/port.
5413 Pressing @kbd{C-t} in the folder or summary modes brings you in
5414 wl-plugged-mode shown below, in which you can change the plugged state
5419 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5422 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5423 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5425 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5426 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5432 The first line indicates status of the following three variables, and
5433 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5434 column modifies the values of these variables.
5438 "Queuing" @code{wl-draft-enable-queuing}
5439 "AutoFlushQueue" @code{wl-auto-flush-queue}
5440 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5444 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5447 The second and after lines indicate on-line/off-line states of servers
5448 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5449 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5450 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5452 @dfn{sending queue} means messages accumulated in the folder
5453 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5454 off-line operations when @code{elmo-enable-disconnected-operation} is
5456 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5457 @c off-line operations are enabled.
5459 They are displayed if there are any of them. In the example above, in
5460 the sending queue there are two messages (the first and the second in
5461 the queue folder) for smtp to hosta and one (the third) for nntp to
5462 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5465 If you change @samp{(wl-plugged)} in the second line, the variable
5466 @code{wl-plugged} is changed, so that the mode line indicator and
5467 plugged states of all ports are affected. If you change plugged states
5468 of any servers or ports, @samp{(wl-plugged)} in the second line is
5469 affected depending on @code{elmo-plugged-condition} settings and the
5470 plugged state of each port.
5473 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5474 @section Invoking Wanderlust in the Off-line State
5476 As described before, if you set @code{wl-plugged} to @code{nil} in
5477 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5478 off-line state. You can specify off-line state on a per server or port
5479 basis. Refer to @code{wl-reset-plugged-alist} also.
5481 Usually, when Wanderlust starts up, the plugged state of each port is
5482 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5483 @code{wl-nntp-posting-server} and so on. If you want to change the
5484 plugged state of these ports or to add other ports, configure
5485 @code{wl-make-plugged-hook} with a function.
5489 (add-hook 'wl-make-plugged-hook
5491 (elmo-set-plugged plugged-value(t/nil) server port)
5492 ;; @r{add or change plugged states of the port of the server}
5493 (elmo-set-plugged plugged-value(t/nil) server)
5494 ;; @r{if the port is omitted, all ports are affected}
5495 ;; @r{(you cannot omit the port if you newly add the server)}
5501 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5502 @section Customizable Variables
5507 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5508 mode from the beginning.
5510 @item wl-queue-folder
5511 @vindex wl-queue-folder
5512 The initial setting is @samp{+queue}.
5513 This is the folder in which messages in the transmission queue are
5516 @item wl-auto-flush-queue
5517 @vindex wl-auto-flush-queue
5518 The initial setting is @code{t}.
5519 This flag controls automatic transmission of the queue when Wanderlust
5520 becomes on-line. If non-nil, the queue is automatically transmitted
5521 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5522 manually, press @kbd{F} in the folder mode.
5524 @item elmo-enable-disconnected-operation
5525 @vindex elmo-enable-disconnected-operation
5526 The initial setting is @code{t}. Controls off-line operations
5527 regarding IMAP4. If non-nil, off-line operations are carried out.
5529 @item elmo-lost+found-folder
5530 @vindex elmo-lost+found-folder
5531 The initial setting is @samp{+lost+found}.
5532 This is the folder to which messages are saved when they fails to be
5533 appended while the off-line re-file/copy queue is processed.
5535 @item elmo-plugged-condition
5536 @vindex elmo-plugged-condition
5537 The initial setting is @code{one}.
5538 The value of @code{wl-plugged} reflects the return value of the function
5539 @code{elmo-plugged-p} (without arguments).
5540 This variable @code{elmo-plugged-condition} specifies the condition on
5541 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5542 plugged state of each port.
5545 'one : plugged if one or more ports are plugged.
5546 'all : plugged if all ports are plugged.
5547 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5548 states of the ports.
5549 @var{function} : reflects the return value of the @var{function}
5550 functions available per default
5551 'elmo-plug-on-by-servers
5552 : reflects the plugged state of the servers specified by the
5553 variable elmo-plug-on-servers.
5554 'elmo-plug-on-by-exclude-servers
5555 : reflects the plugged state of the servers that are not
5556 in elmo-plug-on-exclude-servers.
5557 elmo-plug-on-exclude-servers defaults to
5560 (system-name)without the domain part)
5566 (setq elmo-plugged-condition 'all)
5568 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5569 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5571 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5572 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5576 @item wl-reset-plugged-alist
5577 @vindex wl-reset-plugged-alist
5578 The initial setting is @code{t}. If non-nil, plugged states are
5579 initialized on a per server or port basis when Wanderlust starts up.
5581 If @code{nil}, plugged states are retained while Emacs is running. In
5582 other words, they are initialized when Emacs is restarted even if the
5583 value is @code{nil}.
5587 @node Expire and Archive, Scoring, Disconnected Operations, Top
5588 @chapter Automatic Expiration and Archiving of Messages
5589 @cindex Expire and Archive
5592 * Expire:: Expiration and Archiving
5593 * Archive:: Archiving All Messages
5597 @node Expire, Archive, Expire and Archive, Expire and Archive
5599 @cindex Expire Message
5601 Expiration means deletion of old messages which have outlasted a
5602 certain period of time.
5604 @code{wl-expire} supports not only simple deletion, but also moving to
5605 specified archiving folders.
5609 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5610 or @kbd{M-e} in the summary mode.
5612 @subsection Configuring @code{wl-expire-alist}
5614 An example configuration of @code{wl-expire-alist} is shown below.
5615 Everything in this @code{wl-expire-alist} makes a great difference in
5616 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5617 to @code{t}, especially in the initial stage.
5621 (setq wl-expire-alist
5622 '(("^\\+trash$" (date 14) remove)
5624 ("^\\+tmp$" (date 7) trash)
5625 ;; @r{re-file to @code{wl-trash-folder}}
5626 ("^\\+outbox$" (number 300) "$outbox;lha")
5627 ;; @r{re-file to the specific folder}
5629 ;; @r{do not expire}
5630 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5631 ;; @r{archive by message number (retaining numbers)}
5632 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5633 ;; @r{archive by a fixed number (retaining numbers)}
5634 ("^\\+diary$" (date 30) wl-expire-archive-date)
5635 ;; @r{archive by year and month (numbers discarded)}
5640 Items in the list has the format of:
5643 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5647 The folder is examined if it matches @var{regexp-for-folders} from the
5648 beginning of the list. If you invoke expiration on the folder that does
5649 not match any of them, nothing will happen. And if either the second or
5650 the third element of the item is @code{nil}, expiration will not take
5653 You can use any one of the following for
5654 @var{specification-of-message-to-be-deleted}:
5657 @item (number @var{n1} [@var{n2}])
5658 deletes messages depending on the number of messages in the folder.
5660 @var{n1} is the number of messages which should survive deletion, for example
5661 if its value is 500, the newest 500 messages survive and the rests are
5664 @var{n2} is the number of messages in the folder on which expiration should
5665 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5666 folders with 510 or more messages are expired.
5667 If you configured automatic expiration, frequently used folders may
5668 expire every time it receive messages, and you may be annoyed with the
5669 long delay in reading mail.
5670 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5671 expiration would not take place until a certain number of messages
5674 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5675 with important/new/unread) are not deleted.
5676 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5677 will expire so as to have 500 messages including such ones.
5678 Otherwise, it will have 500 messages except such ones.
5680 @item (date @var{d1})
5681 deletes messages depending on the dates.
5683 Messages dated @var{d1} or more days ago are deleted, for example if its
5684 value is seven, messages seven days old or more are deleted. Note that
5685 the date is the one in the @samp{Date:} field of the message, not when
5686 the message entered the folder.
5688 Messages with no or invalid @samp{Date:} field does not expire; you
5689 might have to delete them by hand.
5692 You can use any one of the following in the place of @var{destination}:
5696 deletes the messages instantly.
5699 hide the messages from summary (messages are not deleted).
5702 moves the messages to @code{wl-trash-folder}.
5704 @item @var{string}(folder)
5705 moves the messages to the folder specified with @var{string}.
5707 It would be useful for specifying an archiving folder, but because this
5708 does not move important messages, it might be better to use the
5709 standard functions described below.
5711 @item @var{function}
5712 invokes the specified @var{function}.
5714 To the @var{function}, three arguments are passed: a folder name, a list
5715 of messages to be deleted, and msgdb information of the summary. You
5716 can specify function-specific arguments after the name of the
5717 @var{function}. Note that the list contains messages with marks in
5718 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5721 These are four standard functions; three of them move messages to an archive
5722 folder in the specified way. This means old messages can be compressed
5723 and saved in a file, being deleted from the original folder.
5724 The last one divides messages to some MH folders.
5727 @item wl-expire-archive-number1
5728 re-files to archiving folders corresponding to the message numbers of
5729 the messages being deleted. For example, a message numbered 102 will be
5730 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5731 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5732 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5734 The archiving folders to which messages are re-filed are determined by
5735 the name of the folder as follows (in this case, archiving folders are
5736 handled as if @code{elmo-archive-treat-file} were non-nil).
5739 @item If the folder type is localdir:
5740 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5742 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5743 (@file{~/Mail/ml/wl-00100.zip}).
5745 @item The folder type is other than localdir:
5746 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5748 For example, @samp{%#mh/ml/wl} corresponds to
5749 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5752 As you can see, in the case of localdir, the folder type is not included
5753 in the path name, but otherwise it is included.
5754 And you can control the prefix to the archiving folder name by
5755 @code{wl-expire-archive-folder-prefix}.
5756 Refer to @code{wl-expire-archive-folder-prefix} for details.
5758 @item wl-expire-archive-number2
5759 re-files every certain number of messages to archiving folders.
5761 This differs from @samp{wl-expire-archive-number1} in that this re-files
5762 to the folder up to the specified number regardless of message numbers.
5763 The archiving folders to which messages are re-filed are determined in the
5764 same way as @code{wl-expire-archive-number1}.
5766 @item wl-expire-archive-date
5767 re-files messages depending on its date (year and month) to archive
5770 For example, a message dated December 1998 is re-filed to
5771 @code{$folder-199812;zip}. The name of the archiving folders except the
5772 date part are determined in the same way as
5773 @code{wl-expire-archive-number1}.
5776 You can set the first argument to these three standard functions to non-nil
5777 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5778 For example, it can be specified just after the name of the function:
5781 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5784 If you omit the argument, consecutive numbers from 1 are assigned for
5785 each archiving folder.
5787 @item wl-expire-localdir-date
5788 divedes messages depending on its date (year and month) to MH folders
5789 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5793 @subsection Treatment for Important or Unread Messages
5795 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5796 standard function, messages with marks in
5797 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5798 messages} thereafter) are retained.
5800 Per default, this variable include the important, new, and unread marks,
5801 so that messages with these marks are not removed.
5802 Note that you cannot include the temporary mark (i.e. temporary marks
5803 are removed anyway), and be sure to process temporary marks before you
5806 @subsection Auto Expiration
5808 The following setup invokes expiration when you move into the summary
5809 mode. There will be no confirmation, so make sure you made no mistake
5810 in regexp and other settings before you set up this.
5814 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5818 In the folder mode, you can invoke expiration per group as well as per
5819 folder. Therefore, if you specify @samp{Desktop} group, all folders
5820 matching @code{wl-expire-alist} expire.
5824 @subsection Treating archive folders.
5825 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5826 you must set non-nil value to @code{elmo-archive-treat-file}.
5828 @subsection Confirming
5830 If you are to use @code{remove}, try @code{trash} at first and see
5831 messages move to @code{wl-trash-folder} as expected, then replace it
5832 with @code{remove}. It would be dangerous to use @code{remove} from the
5835 If you are to use @code{wl-expire-archive-number1} and the like, try to
5836 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5837 you can append messages to it. Even if settings in
5838 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5839 would not be saved anywhere and disappeared in case the archiver program
5842 After you make sure you can archive to the folder correctly, you can
5843 invoke expiration and utilize the log.
5845 If you set @code{wl-expire-use-log} to @code{t},
5846 @file{~/.elmo/expired-log} should contain the log, for example:
5850 delete +ml/wl (593 594 595 596 597 598 599)
5851 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5855 The first column indicates the operation, i.e. @samp{delete},
5856 @samp{copy}, or @samp{move}. The next is the name of the folder that
5857 expired. In the case of @samp{copy} and @samp{move}, the destination
5858 folder is recorded after @samp{->}. The last is the list of message
5859 numbers that are actually deleted or moved (in the case of @samp{copy}
5860 and @samp{move}, the number is the one in the source folder, rather than
5861 the destination folder).
5863 @subsection Re-filing Reserved Messages
5865 The three standard functions copy reserved messages to the archive
5866 folder, but do not delete them from the source folder. Because
5867 reserved messages and the like always remain, they are recorded in
5868 @file{~/.elmo/expired-alist} so that they are not copied over and over
5869 again. They are not recorded if copied by @code{wl-summary-archive}.
5871 If you enabled logging, usually @samp{move} is recorded for re-filing,
5872 but instead @samp{copy} and @samp{delete} are recorded separately if
5873 reserved messages are involved. This is because it actually copies
5874 messages including reserved, then deletes ones except reserved in that
5877 @section Customizable Variables
5880 @item wl-expire-alist
5881 @vindex wl-expire-alist
5882 The initial setting is @code{nil}.
5883 This variable specifies folders and methods to expire. For details,
5884 refer to @code{wl-expire-alist} settings above.
5886 @item wl-summary-expire-reserve-marks
5887 @vindex wl-summary-expire-reserve-marks
5888 The initial setting is the list below.
5892 (list wl-summary-important-mark
5893 wl-summary-new-uncached-mark
5894 wl-summary-new-cached-mark
5895 wl-summary-unread-mark
5896 wl-summary-unread-uncached-mark
5897 wl-summary-unread-cached-mark)
5901 Messages with these marks are retained in the folder, even after
5903 Only permanent marks can be listed, not temporary marks.
5905 You can list marks one by one as in the default; you can use the
5906 following settings as well:
5910 All messages with permanent marks are retained,
5911 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5915 All messages are handled as usual ones that are already read, no matter
5916 what marks they have; even important messages are deleted.
5919 @item wl-expire-archive-files
5920 @vindex wl-expire-archive-files
5921 The initial setting is 100.
5922 This variable specifies the number of messages to be retained in one
5925 @item wl-expire-number-with-reserve-marks
5926 @vindex wl-expire-number-with-reserve-marks
5927 The initial setting is @code{nil}.
5928 If non-nil, if expiring messages are specified by @code{number},
5929 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5931 @item wl-expire-archive-get-folder-function
5932 @vindex wl-expire-archive-get-folder-function
5933 The initial setting is @code{wl-expire-archive-get-folder}.
5935 This variable specifies a function that returns the name of an archiving
5936 folder for standard functions in the place of @var{destination}.
5937 You can use the following three variables for simple modification of
5938 folder names; if you want more complex settings, define your own
5939 function in this variable.
5941 @code{wl-expire-archive-get-folder} can be customized by these
5944 @item @code{wl-expire-archive-folder-name-fmt}
5945 @item @code{wl-expire-archive-folder-type}
5946 @item @code{wl-expire-archive-folder-prefix}
5949 @item wl-expire-archive-folder-name-fmt
5950 @vindex wl-expire-archive-folder-name-fmt
5951 The initial setting is @samp{%s-%%05d;%s}.
5952 This is a @code{format} string for archiving folders used in
5953 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5954 Note that you must specify the message number by @samp{%%d}, because it
5955 is parsed twice by @code{format}.
5957 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5960 @item wl-expire-archive-date-folder-name-fmt
5961 @vindex wl-expire-archive-date-folder-name-fmt
5962 The initial setting is @samp{%s-%%04d%%02d;%s}.
5963 This is a @code{format} string for archiving folders used in
5964 @code{wl-expire-archive-date}. Note that you must specify the message
5965 number by @samp{%%d}, because it is parsed twice by @code{format}.
5966 There should be @samp{%%d} twice, one for the year and the other for the
5969 If you modify this, adjust
5970 @code{wl-expire-archive-date-folder-num-regexp} as well.
5972 @item wl-expire-archive-folder-type
5973 @vindex wl-expire-archive-folder-type
5974 The initial setting is @code{zip}.
5975 This variable specifies an archiver type of the archiving folders.
5977 @item wl-expire-archive-folder-prefix
5978 @vindex wl-expire-archive-folder-prefix
5979 The initial setting is @code{nil}.
5980 This variable specifies the prefix (directory structure) to archiving
5982 Exercise extreme caution in using this feature, as it has not been
5984 In the worst case, there is a fear of destructing archiving folders.
5988 There will be no prefix.
5991 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5992 @samp{$ml/wl-00000;zip;wl}.
5995 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5998 @samp{$ml/wl-00000;zip;ml/wl}.
6001 @item wl-expire-archive-folder-num-regexp
6002 @vindex wl-expire-archive-folder-num-regexp
6003 The initial setting is @samp{-\\([-0-9]+\\);}.
6004 This variable specifies the regular expression to be used for getting
6005 message numbers from multiple archiving folders specified by
6006 @code{elmo-list-folders}.
6007 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
6009 @item wl-expire-archive-date-folder-num-regexp
6010 @vindex wl-expire-archive-date-folder-num-regexp
6011 The initial setting is @samp{-\\([-0-9]+\\);}.
6012 This is the regular expression to be used for getting message numbers
6013 from multiple archiving folders specified by @code{elmo-list-folders}.
6014 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
6016 @item wl-expire-delete-oldmsg-confirm
6017 @vindex wl-expire-delete-oldmsg-confirm
6018 The initial setting is @code{t}.
6019 If non-nil, messages older than the one with the largest number will be
6020 deleted with confirmation.
6021 If @code{nil}, they are deleted without confirmation.
6023 This feature is valid only if non-nil is specified as a argument to the
6024 standard functions so as to retain numbers.
6026 @item wl-expire-use-log
6027 @vindex wl-expire-use-log
6028 The initial setting is @code{nil}.
6029 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
6030 They are appended but not truncated or rotated automatically; you might
6031 need to remove it manually.
6033 @item wl-expire-add-seen-list
6034 @vindex wl-expire-add-seen-list
6035 The initial setting is @code{t}.
6037 If non-nil, when messages are re-filed by expiration, read/unread
6038 information is passed to the destination folder.
6040 However if you do not read the destination folder from Wanderlust,
6041 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
6042 want to set this to @code{nil} if you are simply saving to some
6043 archiving folders. Even if its value is @code{nil}, messages in the
6044 archiving folders are simply treated as unread; it does not affect
6047 @item wl-expire-folder-update-msgdb
6048 @vindex wl-expire-folder-update-msgdb
6049 The initial setting is @code{t}.
6050 If @code{t}, in the folder mode, expiration is carried out after
6051 updating summary information. If you specified a list of regular
6052 expressions of folder names, summary information is updated for matching
6057 @node Archive, , Expire, Expire and Archive
6058 @section Archiving Messages
6060 @subsection Archiving Messages
6061 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
6062 folders. If there are the archiving folders already, only new messages
6065 You can use @code{wl-archive-alist} in order to specify how messages are
6066 archived according to their folder names, as in @code{wl-expire-alist}.
6071 (setq wl-archive-alist
6072 '(("^\\+tmp$" wl-archive-date)
6073 ("^\\+outbox$" wl-archive-number2)
6074 (".*" wl-archive-number1)))
6078 Each item in the list has the following format:
6081 (@var{folders-regexp} @var{deleting-function})
6084 As you can see, you can only use a function after @var{folders-regexp}.
6085 Per default, there are three functions:
6088 @item @code{wl-archive-number1}
6089 @item @code{wl-archive-number2}
6090 @item @code{wl-archive-date}
6093 As inferred from their names, they work similarly to "expire" versions,
6094 other than the following points:
6097 @item No messages are deleted
6098 @item Message numbers are retained even if invoked without arguments
6101 These functions are good to archive all messages in a folder by their
6102 numbers or by their dates.
6103 These are also useful for backup or confirmation purposes before
6105 If you try to re-file them after they are archived, they are deleted but
6108 Per default, the archiving folders to which messages are copied are
6109 determined automatically by @code{wl-expire-archive-get-folder-function}.
6110 You can copy to a specific folder by invoking with a prefix argument,
6111 i.e. @kbd{C-u M-x wl-summary-archive}.
6113 Note that this feature has not been seriously tested, because you can
6114 simply copy to an archiving folder, for example by
6115 @code{wl-summary-copy-region}.
6117 The archiving folders are determined by the same logic as in
6118 @code{wl-summary-expire}; the following customizable variables are
6122 @item @code{wl-expire-archive-files}
6123 @item @code{wl-expire-archive-get-folder-function}
6124 @item @code{wl-expire-archive-folder-name-fmt}
6125 @item @code{wl-expire-archive-folder-type}
6126 @item @code{wl-expire-archive-folder-prefix}
6127 @item @code{wl-expire-archive-folder-num-regexp}
6130 @subsection Customizable Variables
6133 @item wl-archive-alist
6134 @vindex wl-archive-alist
6135 The initial setting is the list shown below:
6139 ((".*" wl-archive-number1))
6144 This variable specifies a function that copies to archiving folders.
6145 To the function, three arguments are passed: a folder name, a list of
6146 messages in the folder, and msgdb information of the summary.
6147 Needless to say, you can use your own function.
6151 @node Scoring, Split messages, Expire and Archive, Top
6152 @chapter Score of the Messages
6154 @c @cindex Kill File
6156 Scoring is the function that associates a score (value) with each
6157 message, and marks as read or deletes from the summary according to it.
6159 You can put target or important marks on essential messages, or read marks
6160 on the ones you do not want to read, for example spam articles.
6162 This scoring function has a capability and a format similar to the one
6163 that Gnus has, although there are some unsupported features and
6164 Wanderlust specifics.
6165 @xref{Scoring, , ,gnus, The gnus Newsreader}.
6168 * Score Commands:: Score Commands
6169 * Score File Format:: Score File Format
6173 @node Score Commands, Score File Format, Scoring, Scoring
6174 @section Score Commands
6175 @cindex Score Commands
6177 @subsection Score File Specification
6179 @code{wl-score-folder-alist} specifies score files or variables in which
6180 scores are defined, corresponding to folder names.
6184 (setq wl-score-folder-alist
6193 If paths to the score files are omitted, the directory specified in the
6194 variable @code{wl-score-files-directory} is assumed.
6196 No matter what you write in @code{wl-score-folder-alist}, the default
6197 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
6198 read (it does not have to exist).
6199 Therefore, in the example above, the three score files,
6200 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
6201 the folders that matches @samp{^-.*}.
6203 @subsection Scored Messages
6205 Scores are attached to the messages that are specified by
6206 @code{wl-summary-score-marks} temporarily when the summary is updated;
6207 when you exit from the summary, the scores are removed and reverts to
6210 @subsection Creation of Score Files
6212 In the summary buffer, move to an appropriate message and type @kbd{L}.
6213 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
6214 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
6216 This makes @minus{}1000 are scored for messages with the same
6217 @samp{Subject:} as the string you entered. That is, such a score file
6218 is created automatically.
6220 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
6221 The score file you just made appears.
6222 This buffer is called @dfn{score editing buffer} thereafter.
6223 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
6224 as you are previously; type @kbd{a}. Then a score entry for "From"
6226 In this way, you can create a score file easily either in the summary
6227 buffer or in the score editing buffer.
6229 By the way, you might be aware the numbers of key strokes are different
6230 between @kbd{s s p} and @kbd{a}.
6231 This is determined by @code{wl-score-header-default-entry}.
6232 This variable specifies the default score entries corresponding to
6234 For example, for "subject" field, a type and a time limit are prompted,
6235 but for "from" field, they are fixed upon automatically as substring and
6236 permanent respectively.
6237 However, score values can be modified by the prefix argument.
6238 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
6241 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
6242 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
6243 erasing contents of the buffer deletes the score file being edited.
6247 @subsubsection Selecting Score Files
6249 You can change score files to which scores are appended by
6250 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
6251 @code{wl-score-change-score-file}.
6253 @subsubsection Summing Up the Score
6255 If you add the same entries by @code{wl-summary-increase-score},
6256 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
6257 scores for the entry is summed up.
6259 For example, if you create @samp{from} entry with the score of @minus{}1000 by
6260 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
6261 @minus{}1200 will be created as a result.
6263 @subsubsection Creating Thread Key
6265 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
6266 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6268 @subsubsection Creating Followup Key
6270 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6271 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6272 at the cursor to @samp{References} key.
6273 If @code{wl-score-auto-make-followup-entry} is non-nil,
6274 @samp{Message-ID} of all messages to be followed up within dates
6275 specified by @code{wl-score-expiry-days}.
6277 @subsection Key Bindings
6282 @findex wl-summary-increase-score
6283 Increases the score for the current message.
6284 And the score entry is appended to the score file at the same moment.
6285 You can specify the score value by a prefix argument.
6289 @findex wl-summary-lower-score
6290 Decreases the score for the current message.
6291 And the score entry is appended to the score file at the same moment.
6292 You can specify the score value by a prefix argument.
6295 @kindex h R (Summary)
6296 @findex wl-summary-rescore
6297 Re-applies the scoring.
6298 However, already scored messages are not scored anew.
6301 @kindex h c (Summary)
6302 @findex wl-score-change-score-file
6303 Changes the score file currently selected.
6306 @kindex h e (Summary)
6307 @findex wl-score-edit-current-scores
6308 Edits the score file currently selected.
6309 If there are multiple score files, the previously specified one is
6313 @kindex h f (Summary)
6314 @findex wl-score-edit-file
6315 Edits an arbitrary score file and selects it.
6318 @kindex h F (Summary)
6319 @findex wl-score-flush-cache
6320 Erases caches associated to the score files that are read.
6321 If you modified score files directly (from other than Wanderlust), you
6322 need to re-read them after erasing the cache.
6325 @kindex h m (Summary)
6326 @findex wl-score-set-mark-below
6327 Specifies the criterion for scores to be marked as read.
6328 Messages with scores less than this value are marked as read.
6331 @kindex h x (Summary)
6332 @findex wl-score-set-expunge-below
6333 Specifies the criterion for scores to be deleted from the summary.
6334 Messages with scores less than this value are deleted.
6335 "Deleted" means it is not shown; they are not removed from the summary
6336 information or the folder.
6337 The deleted messages can be shown by rescan-noscore again.
6340 @subsection Key Bindings in the Score Editing Buffer
6344 @kindex C-c C-k (Score Mode)
6345 @findex wl-score-edit-kill
6346 Abandons the file being edited.
6349 @kindex C-c C-c (Score Mode)
6350 @findex wl-score-edit-exit
6351 Saves the file being edited, and quits from the edit mode.
6354 @kindex C-c C-p (Score Mode)
6355 @findex wl-score-pretty-print
6359 @kindex C-c C-d (Score Mode)
6360 @findex wl-score-edit-insert-date
6361 Inserts the number of dates from Dec. 31, 1 B.C.
6362 It is used for creating the third factor of time-limited scores.
6365 @kindex C-c C-s (Score Mode)
6366 @findex wl-score-edit-insert-header
6367 Inserts the header of the message selected in the summary buffer.
6370 @kindex C-c C-e (Score Mode)
6371 @findex wl-score-edit-insert-entry
6372 Inserts the score entry of the message selected in the summary buffer.
6375 @subsection Customizable Variables
6378 @item wl-summary-default-score
6379 @vindex wl-summary-default-score
6380 The initial setting is 0 (zero).
6381 This variable specifies the default value of the score.
6382 The score is increased or decreased based upon this value.
6384 @item wl-summary-important-above
6385 @vindex wl-summary-important-above
6386 The initial setting is @code{nil}.
6387 Messages with scores larger than this value are attached with the
6388 important mark (@samp{$}).
6389 If @code{nil}, no important marks are attached.
6391 @item wl-summary-target-above
6392 @vindex wl-summary-target-above
6393 The initial setting is @code{nil}.
6394 Messages with scores larger than this value are attached with the target
6396 If @code{nil}, no target marks are attached.
6398 @item wl-summary-mark-below
6399 @vindex wl-summary-mark-below
6400 The initial setting is 0 (zero).
6401 Messages with scores smaller than this value are marked as read.
6403 @item wl-summary-expunge-below
6404 @vindex wl-summary-expunge-below
6405 The initial setting is @code{nil}.
6406 Messages with scores smaller than this value are deleted from the
6408 If @code{nil}, they are not deleted.
6410 @item wl-summary-score-marks
6411 @vindex wl-summary-score-marks
6412 The initial setting is the list shown below:
6416 (list wl-summary-new-uncached-mark
6417 wl-summary-new-cached-mark)
6422 Messages with these marks are scored.
6424 @item wl-use-scoring
6425 @vindex wl-use-scoring
6426 The initial setting is t.
6427 If non-nil, scoring is enabled.
6429 @item wl-score-files-directory
6430 @vindex wl-score-files-directory
6431 The initial setting is @file{~/.elmo/}.
6432 The default directory for score files.
6434 @item wl-score-interactive-default-score
6435 @vindex wl-score-interactive-default-score
6436 The initial setting is 1000.
6437 This value is used as a score when a score factor is @code{nil} in the
6438 score file. It is also used in @code{wl-summary-increase-score} and
6439 @code{wl-summary-lower-score}, on condition that the value of
6440 @code{wl-score-header-default-entry} is @code{nil}.
6442 @item wl-score-expiry-days
6443 @vindex wl-score-expiry-days
6444 The initial setting is 7.
6445 This is the number of days before time-limited scores are deleted.
6447 @item wl-score-update-entry-dates
6448 @vindex wl-score-update-entry-dates
6449 The initial setting is @code{t}.
6450 If non-nil, it enables deletion of time-limited scores.
6452 @item wl-score-header-default-entry
6453 @vindex wl-score-header-default-entry
6454 Specifies the default value for each header field for score entries
6455 created by @code{wl-summary-increase-score},
6456 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6458 @item wl-score-simplify-fuzzy-regexp
6459 @vindex wl-score-simplify-fuzzy-regexp
6460 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6461 regular expression to be deleted from the string.
6462 Because this is usually used for Subject, the default is prefixes that
6463 are attached by mailing list programs.
6465 @item wl-summary-rescore-partial-threshold
6466 @vindex wl-summary-rescore-partial-threshold
6467 The initial setting is 200.
6468 When sync-all or rescan is executed, if there are messages more than
6469 this value, only the last same number of messages as this value are
6472 @item wl-summary-auto-sync-marks
6473 @vindex wl-summary-auto-sync-marks
6474 If non-nil, unread/important marks are synchronized when the summary
6476 Unread marks reflect information on the IMAP4 server.
6477 Important marks reflect information on the IMAP4 server (flagged or
6478 not), and contents of @samp{'flag} folder.
6479 The initial setting is @code{t}.
6483 @node Score File Format, , Score Commands, Scoring
6484 @section Score File Format
6485 @cindex Score File Format
6487 The format of score files are the same as Gnus, and basically you can
6488 use Gnus score files as they are. But they are not fully compatible
6489 because some keys are not supported and there are Wanderlust specifics.
6490 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6495 ("for sale" -1000 nil s)
6496 ("profit" -1000 nil s))
6498 ("spam@@spamspamspam" -10000 nil s))
6500 ("my@@address" 3001 nil s))
6502 (1000000 -10 nil >))
6512 If the key is a string, it is the name of the header to be matched.
6513 The following keys are available:
6514 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6515 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6516 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6517 @code{Chars} and @code{Lines} mean the size and the number of lines of
6518 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6519 are described later.
6520 The rest corresponds the field of the same name.
6522 Arbitrary numbers of core entries are specified after the key.
6523 Each score entry consists of these five factors:
6527 A factor that matches header. This should be a number in the cases of
6528 @code{lines} and @code{chars}, otherwise a string.
6531 A score factor. When the first item matches, the score of the message
6532 is increased or decreased by this value.
6535 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6536 of a number, the score is deleted if it does not match for days
6537 (@code{wl-score-expiry-days}) from the date specified by this.
6538 The date is since Dec. 31, 1 B.C.
6541 A type factor. This specifies the way the first factor matches.
6542 Available types depend on keys.
6545 @item From, Subject, References, Message-ID
6546 For these keys in string, @code{r} and @code{R} (regexp),
6547 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6548 as well as @code{f} and @code{F} (fuzzy) can be used.
6549 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6552 For these keys, the following five numerical relative operators can be
6553 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6556 This key matches @code{From} header, and scores all follow-ups to the
6558 For example, it would be useful for increasing scores for follow-ups to
6561 You can use the same types as @code{From} except for @code{f}.
6562 And a @samp{Followup} entry is automatically appended to the score file.
6565 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6566 A @samp{Thread} entry is automatically appended for each article that
6567 has @var{x} in the @code{References} header.
6568 You can make sure the whole thread including messages that does not have
6569 all ancestors @code{Message-ID} in @code{References} is scored.
6571 You can use the same types as @code{References} except for @code{f}.
6572 And a @samp{Thread} entry is automatically appended to the score file.
6576 A factor for extension header. This is meaningful only if the key is
6578 This specifies headers to be matched other than standard headers like
6579 @code{Subject} and @code{From}.
6580 Note that you should specify the header in
6581 @code{elmo-msgdb-extra-fields} also.
6582 Therefore it does not work in folders where extension headers cannot be
6587 The sum of these scores @emph{after all factors are applied} becomes the
6588 score of the message.
6590 @cindex Score File Atoms
6592 Messages with a score less than this value is marked as read.
6593 The default is @code{wl-summary-mark-below}.
6596 Messages with a score less than this value is deleted from the summary.
6597 The default is @code{wl-summary-expunge-below}.
6599 @item mark-and-expunge
6600 Both @code{mark} and @code{expunge} are applied,
6601 i.e. messages with a score less than this value is marked as read and
6602 deleted from the summary.
6605 Messages with a score greater than this value is attached with temp
6607 The default is @code{wl-summary-target-above}.
6610 Messages with a score greater than this value is attached with important
6612 The default is @code{wl-summary-important-above}.
6617 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6618 are used, you need to set @code{elmo-msgdb-extra-fields}.
6621 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6624 There are other restrictions as shown below:
6627 @item Because @samp{References} field in the summary information
6628 contains only the last @samp{Message-ID}, @code{references} key matches
6632 Keys that can be seen by folder of types:
6636 chars lines xref extra
6637 localdir,localnews Y E E E
6638 nntp (supporting xover) Y E E N
6644 N: cannot be seen (ignored)
6645 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6650 @node Split messages, Address Book, Scoring, Top
6651 @chapter Message splitting
6652 @cindex Split messages
6654 You can use @code{elmo-split} to split message in folder specified by
6655 the variable @code{elmo-split-folder} a la @command{procmail} according
6656 to some specified rules. To use this feature, set as follows in your
6657 @file{~/.emacs} at first.
6660 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
6663 Set source folder like following.
6666 (setq elmo-split-folder "%inbox")
6669 And specify the rule in the variable @code{elmo-split-rule} (its format
6670 will be is described below).
6671 Then you can invoke @kbd{M-x elmo-split} to split messages according to
6672 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
6673 to do a rehearsal and show result (do not split actually).
6676 We will describe how to specify the rule. First of all, see following
6681 (setq elmo-split-rule
6682 ;; @r{Store messages from spammers into @samp{+junk}}
6683 '(((or (address-equal from "i.am@@spammer")
6684 (address-equal from "dull-work@@dull-boy")
6685 (address-equal from "death-march@@software")
6686 (address-equal from "ares@@aon.at")
6687 (address-equal from "get-money@@richman"))
6689 ;; @r{Store messages from mule mailing list into @samp{%mule}}
6690 ((equal x-ml-name "mule") "%mule")
6691 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
6692 ;; @r{and continue evaluating following rules}
6693 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
6694 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
6695 ((match from "\\(.*\\)@@yahoo\\.com")
6697 ;; @r{Store unmatched mails into @samp{+inbox}}
6702 The basic unit of the rule is a combination like
6705 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
6708 If @samp{CONDITION} is true, @samp{ACTION} is performed.
6709 The 1st element @samp{CONDITION} is a condition represented by a
6710 balanced expression (sexp). Its grammar will be explained below.
6711 The 2nd element @samp{ACTION} is the name of the folder to split
6712 messages into, or a symbol. When the 3rd element @code{continue} is
6713 specified as symbol, evaluating rules is not stopped even when the
6714 condition is satisfied.
6716 The grammar for @samp{CONDITION} is as follows. See example above to
6717 learn how to write the condition practically.
6721 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
6722 (@samp{FIELD-NAME} is a symbol that describes the field name)
6726 True if the field value equals to @samp{VALUE}.
6727 Case of the letters are ignored.
6729 True if the field value matches to VALUE.
6730 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6731 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6732 @item @code{address-equal}
6733 True if one of the addresses in the field equals to
6734 @samp{VALUE}. Case of the letters are ignored.
6735 @item @code{address-match}
6736 True if one of the addresses in the field matches to
6738 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6739 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6743 Functions which accept an integer argument (@samp{SIZE}).
6747 True if the size of the message is less than @samp{SIZE}.
6749 True if the size of the message is greater than @samp{SIZE}.
6753 Functions which accept any number of arguments.
6757 True if one of the argument returns true.
6759 True if all of the arguments return true.
6765 When a symbol is specified, it is evaluated.
6768 You can specify followings as 2nd @samp{ACTION}.
6774 If some string is specified, it will be regarded as the destination
6775 folder, and the message will be appended to it.
6780 If the symbol @samp{delete} is specified, delete the substance of the
6781 message in @code{elmo-split-folder}
6786 If the symbol @samp{noop} is specified, do nothing on the message and
6792 If some function is specified, execute it.
6795 If the message passes all rules, it will be dealed along @samp{ACTION}
6796 specified by @code{elmo-split-default-action}.
6799 @node Address Book, Spam Filter, Split messages, Top
6800 @chapter Address Book
6801 @cindex Address Book
6803 With address book, you can utilize address completion, and you have
6804 summary displayed with nicknames.
6807 * Mail Addresses:: Definition of Address Book
6808 * Address Manager:: Address Manager
6812 @node Mail Addresses, Address Manager, Address Book, Address Book
6813 @section Address book
6814 @cindex Address book Definition
6816 @cindex Alias, Address
6818 The file @file{~/.addresses} is a simple address book for Wanderlust.
6819 Make address file @file{~/.addresses}, and edit to suit your requirement.
6821 The data written in @file{~/.addresses} are used for address completion
6822 under draft editing mode. Furthermore, they are used when showing names
6823 in summary display mode. You can safely skip this section, if you don't
6824 want to customize address completion and summary display.
6825 It is possible to add/change/remove addresses from @file{~/.addresses} in
6826 summary buffer after Wanderlust is invoked. @refill
6828 The format is very simple. Like this. @refill
6833 # @r{Lines begin with @samp{#} are comment.}
6834 # @r{Empty lines are ignored}
6836 # @r{Format of each line:}
6837 # @var{email-address} "@var{nickname} "@var{realname}"
6839 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6840 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6841 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6846 One line defines one persons description.
6848 Actually, in default setup, @var{nickname} is used in summary-mode and
6849 @var{realname} is used in draft preparation mode. This behavior is
6850 better understood if you try it and confirmed the function first. You
6851 can write and try a small definition, so you will know the idea of the
6852 address book before writing a big one.
6854 And, if MH alias file is specified in variable @code{wl-alias-file},
6855 it is used as an address information in the draft preparation mode.
6857 If variable @code{wl-use-ldap} is non-nil (initial setting is
6858 @code{nil}), address completion in draft mode uses LDAP information.
6860 If you use LDAP, you have to set @code{wl-ldap-server},
6861 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6862 not have LDAP feature as built-in feature (Currently only XEmacs can
6863 have built-in LDAP feature), you have to set command exec @env{PATH} to
6864 the program @command{ldapsearch}.
6867 @node Address Manager, , Mail Addresses, Address Book
6868 @section Address Manager
6869 @cindex Address Manager
6871 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6872 the address book and insert address to draft buffer.
6874 @subsection Key Bindings
6878 @kindex t (Address Manager)
6879 @findex wl-addrmgr-set-to
6880 Add @samp{To:} mark.
6883 @kindex c (Address Manager)
6884 @findex wl-addrmgr-set-cc
6885 Add @samp{Cc:} mark.
6888 @kindex b (Address Manager)
6889 @findex wl-addrmgr-set-bcc
6890 Add @samp{Bcc:} mark.
6893 @kindex u (Address Manager)
6894 @findex wl-addrmgr-unmark
6898 @kindex x (Address Manager)
6899 @findex wl-addrmgr-apply
6901 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6902 buffer and quit address manager. When no draft buffer, make new draft
6903 with insert marked addresses.
6905 If no mark, quit address manager.
6909 @kindex q (Address Manager)
6910 @findex wl-addrmgr-quit
6911 Quit address manager.
6914 @kindex a (Address Manager)
6915 @findex wl-addrmgr-add
6919 @kindex d (Address Manager)
6920 @findex wl-addrmgr-delete
6924 @kindex e (Address Manager)
6925 @findex wl-addrmgr-edit
6930 @node Spam Filter, Batch Processing, Address Book, Top
6931 @chapter Spam Filter
6934 @code{wl-spam} provides an frontend to external spam filtering programs.
6935 You can register to or judge spam by the filtering program cooperateing
6936 with messages operations on Wanderlust.
6939 * Usage of Spam Filter:: Usage of Spam Filter
6940 * Spam Filter Processors:: Supported spam filters
6943 @node Usage of Spam Filter, Spam Filter Processors, Spam Filter, Spam Filter
6944 @section Usage of Spam Filter
6946 @subsection Initial Setting
6948 To use @code{wl-spam}, write in @file{~/.wl} as follows:
6952 ;; @r{Use @samp{bogofilter} as spam back end}
6953 ;; @r{Set @samp{scheme} here as the spam filter you will use.}
6954 ;; @r{@xref{Spam Filter Processors}.}
6955 (setq elmo-spam-scheme 'bogofilter)
6960 @subsection spam mark
6962 The spam mark (@samp{s}) will be provided as new temporary mark.
6963 Messages marked by this will be refiled into @code{wl-spam-folder} when
6964 the action is called for execution. Marked messages will be skipped by
6965 summary walking in ordinary way.
6967 The spam mark is be put on by spam judgement described later, or by
6968 invoking @kbd{k m} at any time.
6970 @subsection spam judgment
6972 You can judge spam messages by following ways:
6976 Make judgement on execution of auto-refile.
6978 Insert @code{wl-refile-guess-by-spam} to arbitrary position in
6979 @code{wl-auto-refile-guess-functions} as follows.
6983 (setq wl-auto-refile-guess-functions
6984 '(wl-refile-guess-by-rule
6985 wl-refile-guess-by-spam))
6989 In this example, judge spam if it could not decide refile destination by
6990 @code{wl-refile-rule-alist}.
6993 Make judgement on entering the summary of specified folder.
6995 Specify the value of @code{wl-spam-auto-check-folder-regexp-list}
6996 as the list of regular expressions for folder names to be
6997 automatically judged by spam filter.
7000 (setq wl-spam-auto-check-folder-regexp-list '("\\+inbox"))
7003 In this example, judgement will be processed when you enter summary of
7004 the folder whose name contains @samp{+inbox}.
7007 Make judgement on splitting messages with @code{elmo-split}.
7009 It provides new function @code{spam-p} to be specified as @samp{CONDITION}
7010 in @code{elmo-split-rule}. This function returns true when the message
7012 @xref{Split messages}.
7014 You can also process learning by the result of judgement. (You would
7015 better turn on this feature after learning to some extent)
7021 (setq elmo-split-rule
7022 '(((spam-p) "+spam")
7023 ;; @r{to learn by the judgement, use following instead}
7024 ;((spam-p :register t) "+spam")
7030 @subsection spam learning
7032 @code{wl-spam} automatically learn spam with refiling messages.
7034 At first, @code{wl-spam} classifies the folders controlled by Wanderlust
7035 into following 4 domains by the class of containig messages
7039 Folders containing messages judged as spam.
7040 (The folder specified by @code{wl-spam-folder})
7042 Folders containing messages judged as non-spam.
7044 Folders containing messages not yet judged. Folders without
7045 pre-distribution may belong to this domain e.g. @samp{+inbox}.
7046 (specified by @code{wl-spam-undecided-folder-regexp-list})
7048 Foldes have nothing to do with spam processing e.g.
7049 @code{wl-trash-folder} or @code{wl-draft-folder}. (specified by
7050 @code{wl-spam-ignored-folder-regexp-list})
7053 When you refile messages across different domains, it automatically
7054 learn messages as @samp{spam} or @samp{non-spam} according to domains
7055 it belongs before and after.
7057 To put it concretely, it will learn by following rule:
7060 @item undecide -> spam
7063 learn as spam and cancel previous study as non-spam.
7064 @item undecide -> good
7067 learn as non-spam and cancel previous study as spam.
7070 It do not learn anything in other cases.
7072 @subsection Key Bindings
7073 @cindex Keybind, spam filter
7077 @kindex k m (Summary)
7078 @findex wl-summary-spam
7079 Put spam mark (@samp{s}) on current message.
7082 @kindex k c (Summary)
7083 @findex wl-summary-test-spam
7084 Test current message and put spam mark if judged as spam.
7087 @kindex k C (Summary)
7088 @findex wl-summary-mark-spam
7089 Test messages with the mark in @code{wl-spam-auto-check-marks},
7090 and put spam mark if judged as spam. If it is called with prefix
7091 argument, test all messages regardless of their marks.
7094 @kindex k s (Summary)
7095 @findex wl-summary-register-as-spam
7096 Register current message as spam.
7099 @kindex k S (Summary)
7100 @findex wl-summary-register-as-spam-all
7101 Register all messages in the folder as spam.
7104 @kindex k n (Summary)
7105 @findex wl-summary-register-as-good
7106 Register current message as non-spam.
7109 @kindex k N (Summary)
7110 @findex wl-summary-register-as-good-all
7111 Register all messages in the folder as non-spam.
7114 @kindex m k (Summary)
7115 @findex wl-summary-target-mark-spam
7116 Put spam mark (@samp{s}) on messages with the target mark @samp{*}.
7119 @kindex m s (Summary)
7120 @findex wl-summary-target-mark-register-as-spam
7121 Register messages with the target mark @samp{*} as spam.
7124 @kindex m n (Summary)
7125 @findex wl-summary-target-mark-register-as-good
7126 Register messages with the target mark @samp{*} as non-spam.
7129 @subsection Customizable Variables
7132 @item wl-spam-folder
7133 @vindex wl-spam-folder
7134 Specify the name of destination folder for the spam messages.
7135 The initial setting is @samp{+spam}.
7137 @item wl-spam-undecided-folder-regexp-list
7138 @vindex wl-spam-undecided-folder-regexp-list
7139 Specify the list of regexp of folder names which contain messages
7140 not yet decided as spam or non-spam.
7141 The initial setting is @code{'("inbox")}.
7143 @item wl-spam-ignored-folder-regexp-list
7144 @vindex wl-spam-ignored-folder-regexp-list
7145 The initial setting is as follows.
7149 (list (regexp-opt (list wl-draft-folder
7155 Folders of no effect against spam judgement, specified by the list of
7156 folder name regular expressions.
7158 @item wl-spam-auto-check-folder-regexp-list
7159 @vindex wl-spam-auto-check-folder-regexp-list
7160 Folders to make spam judgement on entering the summary of them,
7161 specified by the list of folder name regular expressions.
7162 The initial setting is @code{nil}.
7164 @item wl-spam-auto-check-marks
7165 @vindex wl-spam-auto-check-marks
7166 The initial setting is the following list:
7170 (list wl-summary-new-uncached-mark
7171 wl-summary-new-cached-mark)
7175 Messages with mark specified by this variable will be processed
7176 by whole-folder judgement including auto test by
7177 @code{wl-spam-auto-check-folder-regexp-list}.
7178 Persistent marks can be used in this method, but temporary marks cannot.
7180 You can specify the list of marks as the initial setting, or you can
7181 specify follwing symbol:
7185 Process all messages regardless of persistent marks.
7190 @node Spam Filter Processors, , Usage of Spam Filter, Spam Filter
7191 @section Supported Spam Filters
7192 @cindex Spam Filter, Bogofilter
7193 @cindex Spam Filter, Spamfilter
7195 Supported spam filtering libraries are following ones.
7198 * bogofilter:: bogofilter
7199 * spamfilter:: spamfilter.el
7200 * bsfilter:: bsfilter
7201 * SpamAssassin:: SpamAssassin
7202 * Regular Expressions Header Matching:: Header regexp
7206 @node bogofilter, spamfilter, Spam Filter Processors, Spam Filter Processors
7207 @subsection bogofilter
7210 bogofilter (@uref{http://bogofilter.sourceforge.net/}) is a spam filter
7211 implemented by C language.
7213 To use spam filter with bogofilter, write following setting in
7214 @file{~/.wl} or somewhere else.
7218 (setq elmo-spam-scheme 'bogofilter)
7222 @subsubsection Customizable Variables
7225 @item elmo-spam-bogofilter-program
7226 @vindex elmo-spam-bogofilter-program
7227 The initial setting is @file{bogofilter}.
7228 Specify the name of executable of bogofilter. If the executable
7229 is not in your environmental variable @env{PATH}, you should
7230 set this by full path.
7232 @item elmo-spam-bogofilter-args
7233 @vindex elmo-spam-bogofilter-args
7234 The initial setting is @code{nil}.
7235 Specify arguments to be supplied for bogofilter executable.
7237 @item elmo-spam-bogofilter-database-directory
7238 @vindex elmo-spam-bogofilter-database-directory
7239 Specify the directory for statistical database to be used.
7240 @code{nil} to use default directory (@file{~/.bogofilter}).
7241 The initial setting is @code{nil}.
7243 @item elmo-spam-bogofilter-max-messages-per-process
7244 @vindex elmo-spam-bogofilter-max-messages-per-process
7245 The initial setting is 30. This variable specifies the number of
7246 messages to be learned by one process.
7248 @item elmo-spam-bogofilter-debug
7249 @vindex elmo-spam-bogofilter-debug
7250 The initial setting is @code{nil}.
7251 If you specify non-nil, the output from @command{bogofilter} is
7252 stored in the buffer named @code{"*Debug ELMO SPAM Bogofilter*"}.
7256 @node spamfilter, bsfilter, bogofilter, Spam Filter Processors
7257 @subsection spamfilter.el
7260 @file{spamfilter.el}
7261 (@uref{http://www.geocities.co.jp/SiliconValley-PaloAlto/7043/}) is a
7262 spam filtering library implemented by Emacs Lisp.
7264 Corresponding modules will be compiled/installed, if you have
7265 @file{spamfilter.el} within @code{load-path} when you are to install wl.
7268 To use @file{spamfilter.el}, write following setting in @file{~/.wl} or
7270 (Of cource, you have to have settings for @file{spamfilter.el} itself)
7274 (setq elmo-spam-scheme 'spamfilter)
7278 @subsubsection Customizable Variables
7281 @item elmo-spam-spamfilter-corpus-filename
7282 @vindex elmo-spam-spamfilter-corpus-filename
7283 The initial setting is @file{~/.elmo/.spamfilter}.
7284 It specifies the name of corpus file.
7287 @node bsfilter, SpamAssassin, spamfilter, Spam Filter Processors
7288 @subsection bsfilter
7291 bsfilter (@uref{http://bsfilter.org/index-e.html}) is a spam filter
7292 implemented by Ruby language.
7294 To use spam filter with bsfilter, write following setting in
7295 @file{~/.wl} or somewhere else.
7299 (setq elmo-spam-scheme 'bsfilter)
7303 @subsubsection Customizable Variables
7306 @item elmo-spam-bsfilter-program
7307 @vindex elmo-spam-bsfilter-program
7308 The initial setting is @file{bsfilter}.
7309 Specify the name of executable of @command{bsfilter}. If the executable
7310 is not in your environmental variable @env{PATH}, you should
7311 set this by full path.
7313 @item elmo-spam-bsfilter-args
7314 @vindex elmo-spam-bsfilter-args
7315 The initial setting is @code{nil}.
7316 Specify arguments to be supplied for bsfilter executable.
7318 @item elmo-spam-bsfilter-database-directory
7319 @vindex elmo-spam-bsfilter-database-directory
7320 Specify the directory for statistical database to be used.
7321 @code{nil} to use default directory (@file{~/.bsfilter}).
7322 The initial setting is @code{nil}.
7324 @item elmo-spam-bsfilter-debug
7325 @vindex elmo-spam-bsfilter-debug
7326 The initial setting is @code{nil}.
7327 If you specify non-nil, the output from @command{bsfilter} is
7328 stored in the buffer named @code{"*Debug ELMO Bsfilter*"}.
7330 @item elmo-spam-bsfilter-shell-program
7331 @vindex elmo-spam-bsfilter-shell-program
7332 The initial setting is @file{ruby}.
7333 Specify the shell to execute @command{bsfilter}. If the shell is not
7334 in your environmental variable @env{PATH}, you should set this by full path.
7336 @item elmo-spam-bsfilter-shell-switch
7337 @vindex elmo-spam-bsfilter-shell-switch
7338 The initial setting is @code{nil}.
7339 Specify options to give to the shell executing @command{bsfilter}.
7341 @item elmo-spam-bsfilter-update-switch
7342 @vindex elmo-spam-bsfilter-update-switch
7343 The initial setting is @code{"--synchronous-auto-update"}.
7344 Specify options to give to @command{bsfilter} for learning messages.
7348 @node SpamAssassin, Regular Expressions Header Matching, bsfilter, Spam Filter Processors
7349 @subsection SpamAssassin
7350 @cindex SpamAssassin
7352 SpamAssassin (@uref{http://spamassassin.org/}) is one of the most
7353 popular spam filtering program implemented on Perl. SpamAssassin
7354 attempts to identify spam using text analysis and several internet-based
7355 realtime blacklists. SpamAssassin also uses a Bayesian learning filter
7356 which enables more accurate spam filtering.
7358 To use @file{SpamAssassin} on Wanderlust, write following setting
7359 in @file{~/.wl} or somewhere else.
7360 (Of course, you have to install SpamAssassin beforehand.)
7364 (setq elmo-spam-scheme 'sa)
7368 @subsubsection Customize Variables
7371 @item elmo-spam-spamassassin-program
7372 @vindex elmo-spam-spamassassin-program
7373 The initial setting is @file{spamassassin}.
7374 Specify the name of executable @command{spamassassin}. If the executable
7375 is not in your environmental variable @env{PATH}, you should
7376 set this by full path.
7378 @item elmo-spam-spamassassin-learn-program
7379 @vindex elmo-spam-spamassassin-learn-program
7380 The initial setting is @file{sa-learn}.
7381 Specify the name of the SpamAssassin's Bayesian filtering learner
7382 program, @command{sa-learn}. If the executable is not in your
7383 environmental variable @env{PATH}, you should set this by full path.
7385 @item elmo-spam-spamassassin-program-arguments
7386 @vindex elmo-spam-spamassassin-program-arguments
7387 The initial setting is @code{'("-e")}.
7388 Specify the arguments to be supplied for @command{spamassassin} executable.
7389 You have to specify the argument to exit the program with an error exit code
7390 when the result is spam. For example, if you want to use @command{spamc}
7391 instead of @command{spamassassin}, you should specify @code{'("-c")}.
7393 @item elmo-spam-spamassassin-learn-program-arguments
7394 @vindex elmo-spam-spamassassin-lern-program-arguments
7395 The initial setting is @code{nil}.
7396 Specify the arguments to be supplied for @command{sa-learn}.
7398 @item elmo-spamassassin-debug
7399 @vindex elmo-spamassassin-debug
7400 The initial setting is @code{nil}.
7401 If you specify @code{t}, the output from @command{spamassassin} is
7402 stored in the buffer named @code{"*Debug ELMO SpamAssassin*"}.
7406 @node Regular Expressions Header Matching, , SpamAssassin, Spam Filter Processors
7407 @subsection Regular Expressions Header Matching
7408 @cindex Regular Expressions Header Matching
7410 Examine if regular expression matches corresponding field in message heaeder,
7411 and decide spam or not. To use this backend, add following setting to @file{~/.wl}.
7415 (setq elmo-spam-scheme 'header)
7419 If you want to check fields not included in the default overview
7420 information, add one into @code{elmo-msgdb-extra-fields}. Then it will
7421 do examination by the overview information and avoid loading whole
7422 message body as far as possible.
7424 @subsubsection Customize Variables
7427 @item elmo-spam-header-good-alist
7428 @vindex elmo-spam-header-good-alist
7429 The initial setting is the following list:
7432 '(("X-Spam-Flag" . "No"))
7435 Specify a list of regular expressions to match with header field name
7436 for making non-spam decision. It takes precedence over
7437 @code{elmo-spam-header-spam-alist}.
7439 @item elmo-spam-header-spam-alist
7440 @vindex elmo-spam-header-spam-alist
7441 The initial setting is the following list:
7444 '(("X-Spam-Flag" . "Yes"))
7447 Specify a list of regular expressions to match with header field name
7448 for making spam decision.
7452 @node Batch Processing, Customization, Spam Filter, Top
7453 @chapter Batch Processing
7454 @cindex Batch Processing
7456 You can request wanderlust to do some job on the command line.
7457 For now, you can invoke prefetching new messages in specified folders.
7459 Specify target folders in @code{wl-batch-prefetch-folder-list} then
7460 invoke as follows to execute prefetching:
7464 % emacs -batch -l wl-batch -f wl-batch-prefetch
7468 @section Customize Variables
7471 @item wl-batch-prefetch-folder-list
7472 @vindex wl-batch-prefetch-folder-list
7473 Target folders of prefetching by @code{wl-batch-prefetch}, specified as
7474 a list of folder names.
7478 @node Customization, Migration, Batch Processing, Top
7479 @chapter Customizing Wanderlust
7480 @cindex Customization
7483 * Living with other packages:: Cooperating with other packages
7484 * Highlights:: Highlights
7485 * Biff:: Notify Mail arrival
7486 * Advanced Settings:: Advanced Settings
7487 * Customizable Variables:: Customizable Variables
7492 @node Living with other packages, Highlights, Customization, Customization
7493 @section Living with other packages
7495 Examples with other packages.
7498 * imput:: imput (im-wl.el)
7499 * BBDB:: The Insidious Big Brother Database
7500 * LSDB:: The Lovely Sister Database
7501 * supercite:: supercite.el
7502 * mu-cite:: mu-cite.el
7503 * X-Face:: x-face,bitmap-mule
7504 * dired-dd:: dired-dd.el
7506 * Addrbook:: Addrbook
7507 * mime-w3m:: mime-w3m.el
7511 @node imput, BBDB, Living with other packages, Living with other packages
7516 Place @file{util/im-wl.el} on the @code{load-path} and do the following
7521 (autoload 'wl-draft-send-with-imput-async "im-wl")
7522 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
7527 @node BBDB, LSDB, imput, Living with other packages
7531 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
7532 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
7533 and do the following settings.
7535 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
7536 byte-compiled and installed.
7544 ;; @r{enable pop-ups}
7545 (setq bbdb-use-pop-up t)
7546 ;; @r{auto collection}
7547 (setq bbdb/mail-auto-create-p t)
7548 ;; @r{exceptional folders against auto collection}
7549 (setq bbdb-wl-ignore-folder-regexp "^@@")
7550 (setq signature-use-bbdb t)
7551 (setq bbdb-north-american-phone-numbers-p nil)
7552 ;; @r{shows the name of bbdb in the summary} :-)
7553 (setq wl-summary-from-function 'bbdb-wl-from-func)
7554 ;; @r{automatically add mailing list fields}
7555 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
7556 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
7560 You can complete address with BBDB by @kbd{M-@key{TAB}}
7564 @node LSDB, supercite, BBDB, Living with other packages
7568 The following is an example setting to use
7569 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
7576 (add-hook 'wl-draft-mode-hook
7578 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
7582 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
7583 (complete address with LSDB).
7586 @node supercite, mu-cite, LSDB, Living with other packages
7587 @subsection sc.el(supercite), sc-register.el
7591 The same setting as usual mailers should be OK. The following is an
7592 example of settings:
7596 (autoload 'sc-cite-original "supercite" nil t)
7597 (add-hook 'mail-citation-hook 'sc-cite-original)
7602 @node mu-cite, X-Face, supercite, Living with other packages
7603 @subsection mu-cite.el
7606 The same setting as usual mailers should be OK. The following is an
7607 example of settings.
7609 If you use mu-cite version 8.0 or earlier:
7613 (autoload 'mu-cite/cite-original "mu-cite" nil t)
7614 (setq mail-citation-hook 'mu-cite/cite-original)
7618 If you use mu-cite version 8.1 or later:
7622 (autoload 'mu-cite-original "mu-cite" nil t)
7623 (add-hook 'mail-citation-hook (function mu-cite-original))
7627 @node X-Face, dired-dd, mu-cite, Living with other packages
7631 If you have installed one of the following, you can decode
7632 @samp{X-Face:} field in message buffer and you will see face image.
7635 * x-face-xmas:: XEmacs case
7636 * x-face-mule:: Emacs case
7639 If there is an encoded X-Face string in a file @file{~/.xface} (the
7640 value of the variable @code{wl-x-face-file}), it is inserted as a
7641 @samp{X-Face:} field in the draft buffer (if
7642 @code{wl-auto-insert-x-face} is non-nil).
7644 @node x-face-xmas, x-face-mule, X-Face, X-Face
7645 @subsubsection x-face-xmas (for XEmacs)
7648 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
7649 1.3.6.13 or later, do the following:
7653 (autoload 'x-face-xmas-wl-display-x-face "x-face")
7654 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
7658 @node x-face-mule, , x-face-xmas, X-Face
7659 @subsubsection x-face-mule (for Emacs)
7663 If you use @file{x-face-mule.el} in bitmap-mule
7664 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
7668 (autoload 'x-face-decode-message-header "x-face-mule")
7669 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7673 @subsubsection x-face-e21 (for Emacs 21.x)
7676 With Emacs 21.x, you can use @file{x-face-e21.el}
7677 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
7678 to display X-Face. In this case, bitmap-mule is not required.
7683 (autoload 'x-face-decode-message-header "x-face-e21")
7684 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7689 @node dired-dd, MHC, X-Face, Living with other packages
7690 @subsection dired-dd(Dired-DragDrop)
7691 @pindex Dired-DragDrop
7693 @cindex Drag and Drop
7695 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
7696 compose multi-part by simple Drag-and-Drop from dired to the draft
7697 buffer being edited in GNU Emacs (this feature is not Wanderlust
7698 specific, but general-purpose for SEMI).
7702 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
7708 ;; @r{Set dired-x variables here.}
7709 ;; @r{To and flo@dots{}}
7711 (progn (require 'dired-dd)
7712 (require 'dired-dd-mime))))))
7716 @node MHC, Addrbook, dired-dd, Living with other packages
7720 Message Harmonized Calendaring system
7721 (@uref{http://www.quickhack.net/mhc/})
7723 By using MHC, you can make a calendar from the messages.
7729 (setq mhc-mailer-package 'wl)
7730 (autoload 'mhc-mode "mhc" nil t)
7731 (add-hook 'wl-summary-mode-hook 'mhc-mode)
7732 (add-hook 'wl-folder-mode-hook 'mhc-mode)
7740 (autoload 'mhc-wl-setup "mhc-wl")
7741 (add-hook 'wl-init-hook 'mhc-wl-setup)
7745 @node Addrbook, mime-w3m, MHC, Living with other packages
7746 @subsection wl-addrbook.el
7750 (@uref{http://www.mew.org/})
7752 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
7753 @code{load-path} and do the following settings.
7757 (require 'wl-addrbook)
7762 @node mime-w3m, , Addrbook, Living with other packages
7763 @subsection mime-w3m.el
7766 You can display html part by using @file{mime-w3m.el}
7767 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
7768 You can find the usage in comment region at the head of @file{mime-w3m.el}.
7771 @node Highlights, Biff, Living with other packages, Customization
7774 @subsection Customizable Variables
7777 @item wl-summary-highlight
7778 @vindex wl-summary-highlight
7779 The initial setting is @code{t}.
7780 If non-nil, the summary is highlighted.
7782 @item wl-highlight-max-summary-lines
7783 @vindex wl-highlight-max-summary-lines
7784 The initial setting is 10000.
7785 The summary is not highlighted if it has more lines than this value.
7787 @item wl-summary-highlight-partial-threshold
7788 @vindex wl-summary-highlight-partial-threshold
7789 The initial setting is 1000.
7790 This is a threshold whether the whole summary is highlighted.
7791 If there are more lines of messages in the summary, it is partially
7794 @item wl-summary-partial-highlight-above-lines
7795 @vindex wl-summary-partial-highlight-above-lines
7796 The initial setting is 30. If there are more lines of messages than
7797 @code{wl-summary-highlight-partial-threshold} in the summary, messages
7798 after the point that is the same number of lines as this value above the
7799 cursor line are highlighted partially. (If this value is @code{nil},
7800 the last same number of lines as the value of
7801 @code{wl-summary-highlight-partial-threshold} are highlighted.)
7803 @item wl-highlight-body-too
7804 @vindex wl-highlight-body-too
7805 The initial setting is @code{t}.
7806 If non-nil, bodies of drafts and messages are also highlighted.
7808 @item wl-highlight-message-header-alist
7809 @vindex wl-highlight-message-header-alist
7810 When highlighting headers of drafts and messages, this variable
7811 specifies which faces are allocated to important
7812 (@code{wl-highlight-message-important-header-contents}), secondly
7813 important (@code{wl-highlight-message-important-header-contents2}), and
7814 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7816 Similarly, it can be used for allocating arbitrary faces to arbitrary
7817 regular expressions.
7819 @item wl-highlight-citation-prefix-regexp
7820 @vindex wl-highlight-citation-prefix-regexp
7821 Specifies a regular expression to which quoted lines in bodies of
7822 drafts and messages match.
7823 Bodies matching to this regular expression are highlighted by the faces
7824 specified by (@code{wl-highlight-message-cited-text-*}).
7826 @item wl-highlight-highlight-citation-too
7827 @vindex wl-highlight-highlight-citation-too
7828 The initial setting is @code{nil}.
7829 If non-nil, the quoting regular expression itself given by
7830 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7832 @item wl-highlight-citation-header-regexp
7833 @vindex wl-highlight-citation-header-regexp
7834 Specifies a regular expression that denotes beginning of quotation.
7835 Bodies matching to this regular expression are highlighted by the face
7836 specified by @code{wl-highlight-message-headers}.
7838 @item wl-highlight-max-header-size
7839 @vindex wl-highlight-max-header-size
7840 The initial setting is @code{nil}. If a header size is larger than this
7841 value, it will not be highlighted. If @code{nil}, always highlighted
7842 (ignore header size).
7844 @item wl-highlight-max-message-size
7845 @vindex wl-highlight-max-message-size
7846 The initial setting is 10000.
7847 If a message is larger than this value, it will not be highlighted.
7848 With this variable, highlight is suppressed for uuencode or huge digest
7851 @item wl-highlight-signature-separator
7852 @vindex wl-highlight-signature-separator
7853 Specifies regular expressions that denotes the boundary of a signature.
7854 It can be a regular expression, or a list of ones.
7855 Messages after the place that matches this regular expression are
7856 highlighted by the face specified by
7857 @code{wl-highlight-message-signature}.
7859 @item wl-max-signature-size
7860 @vindex wl-max-signature-size
7861 The initial setting is 400.
7862 This is the largest size for a signature to be highlighted.
7864 @item wl-use-highlight-mouse-line
7865 @vindex wl-use-highlight-mouse-line
7866 The initial setting is @code{t}.
7867 If non-nil, the line pointed by the mouse is highlighted in the folder
7868 mode, summary mode, and the like.
7871 @subsection Setting Colors and Fonts of the Characters
7873 If you want to change colors or fonts of the characters, you need to
7874 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7875 want to change fonts, and @code{set-face-foreground} for colors, and so
7876 on. You cannot write face settings in @file{.emacs}; write in
7879 For example, if you want to change the color for signatures to yellow,
7883 (set-face-foreground 'wl-highlight-message-signature "yellow")
7889 Faces defined in Wanderlust:
7892 @item wl-highlight-message-headers
7893 The face for field names of message headers.
7895 @item wl-highlight-message-header-contents
7896 The face for field bodies of message headers.
7898 @item wl-highlight-message-important-header-contents
7899 The face for important parts of message headers.
7900 Per default, this face is used for a body of @samp{Subject:} field.
7901 You can change its value by editing
7902 @code{wl-highlight-message-header-alist}.
7904 @item wl-highlight-message-important-header-contents2
7905 The face for secondly important parts of message headers.
7906 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7907 fields. You can change its value by editing
7908 @code{wl-highlight-message-header-alist}.
7910 @item wl-highlight-message-unimportant-header-contents
7911 The face for unimportant parts of message headers.
7912 Per default, this face is used for bodies of @samp{X-} fields
7913 @samp{User-Agent:} fields. You can change its value by editing
7914 @code{wl-highlight-message-header-alist}.
7916 @item wl-highlight-message-citation-header
7917 The face for headers of quoted messages.
7919 @item wl-highlight-message-cited-text-*
7920 The face for texts of quoted messages. The last @samp{*} is a
7921 @var{single figure} so that 10 different colors can be used according to
7924 @item wl-highlight-message-signature
7925 The face for signatures of messages. The initial settings are
7926 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7927 dark background colors.
7929 @item wl-highlight-header-separator-face
7930 The face for header separators of draft messages.
7932 @item wl-highlight-summary-important-face
7933 The face for message lines with important marks in the summary.
7935 @item wl-highlight-summary-new-face
7936 The face for message lines with new marks in the summary.
7938 @item wl-highlight-summary-displaying-face
7939 The face for the message line that is currently displayed.
7940 This face is overlaid.
7942 @item wl-highlight-thread-indent-face
7943 The face for the threads that is currently displayed.
7945 @item wl-highlight-summary-unread-face
7946 The face for message lines with unread marks in the summary.
7948 @item wl-highlight-summary-deleted-face
7949 The face for message lines with delete marks in the summary.
7951 @item wl-highlight-summary-refiled-face
7952 The face for message lines with re-file marks in the summary.
7954 @item wl-highlight-refile-destination-face
7955 The face for re-file information part of message lines with re-file
7956 marks in the summary.
7958 @item wl-highlight-summary-copied-face
7959 The face for message lines with copy marks in the summary.
7961 @item wl-highlight-summary-target-face
7962 The face for message lines with target marks @samp{*} in the summary.
7964 @item wl-highlight-summary-thread-top-face
7965 The face for message lines that are on the top of the thread in the
7968 @item wl-highlight-summary-normal-face
7969 The face for message lines that are not on top of the thread in the
7972 @item wl-highlight-folder-unknown-face
7973 The face for folders that are not known to have how many unsync messages
7976 @item wl-highlight-folder-zero-face
7977 The face for folders that have no unsync messages in the folder mode.
7979 @item wl-highlight-folder-few-face
7980 The face for folders that have some unsync messages in the folder mode.
7982 @item wl-highlight-folder-many-face
7983 The face for folders that have many unsync messages in the folder mode.
7984 The boundary between `some' and `many' is specified by the variable
7985 @code{wl-folder-many-unsync-threshold}.
7987 @item wl-highlight-folder-unread-face
7988 The face for folders that have no unsync but unread messages in the
7991 @item wl-highlight-folder-killed-face
7992 The face for folders that are deleted from the access group in the
7995 @item wl-highlight-folder-opened-face
7996 The face for open groups in the folder mode.
7997 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7998 @code{nil} or a @var{number}.
8000 @item wl-highlight-folder-closed-face
8001 The face for close groups in the folder mode.
8002 It is meaningful when @code{wl-highlight-folder-by-numbers} is
8003 @code{nil} or a @var{number}.
8005 @item wl-highlight-folder-path-face
8006 The face for the path to the currently selected folder in the folder
8009 @item wl-highlight-logo-face
8010 The face for logo in the demo.
8012 @item wl-highlight-demo-face
8013 The face for strings (for example, a version number) in the demo.
8017 @node Biff, Advanced Settings, Highlights, Customization
8018 @section Notify Mail arrival
8021 Following setting is to notify mail arrival of @samp{%inbox}
8022 by the indicator on the modeline
8025 (setq wl-biff-check-folder-list '("%inbox"))
8028 @subsection Customizable Variables
8030 @item wl-biff-check-folder-list
8031 @vindex wl-biff-check-folder-list
8032 The initial setting is @code{nil}.
8033 This is the list of folders to check mail arrival.
8034 If @code{nil}, wl doesn't check mail arrival.
8036 @item wl-biff-check-interval
8037 @vindex wl-biff-check-interval
8038 The initial setting is 40 (in seconds).
8039 Check mail arrival in this period.
8041 @item wl-biff-use-idle-timer
8042 @vindex wl-biff-use-idle-timer
8043 The initial setting is @code{nil}.
8044 If it is @code{nil}, check mail arrival when the time specified by
8045 @code{wl-biff-check-interval} has passed. If it is non-nil, check
8046 mail arrival when idling time exceeds @code{wl-biff-check-interval}.
8048 @item wl-biff-notify-hook
8049 @vindex wl-biff-notify-hook
8050 This hook is run at the arrival of new mail.
8051 To beep with mail arrival(initial setting), set as follows.
8053 (setq wl-biff-notify-hook '(ding))
8055 For silence, set to @code{nil}.
8059 @node Advanced Settings, Customizable Variables, Biff, Customization
8060 @section Advanced Settings
8063 * Draft for Reply:: Draft for Reply
8064 * Thread Format:: Appearance of Thread
8065 * User-Agent Field:: @samp{User-Agent:} Header Field
8069 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
8070 @subsection Draft for Replay
8071 @vindex wl-draft-reply-with-argument-list
8072 @vindex wl-draft-reply-without-argument-list
8074 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
8075 The addressee for the draft is decided by following rules.
8077 For example, you can set as follows:
8081 (setq wl-draft-reply-without-argument-list
8082 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8083 ("Followup-To" . (nil nil ("Followup-To")))
8084 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8085 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
8089 Where each element of the list @code{wl-draft-reply-without-argument-list}
8093 (key . (to-list cc-list newsgroup-list))
8096 and if the field designated by @samp{key} exist in the parent message,
8097 parent's field values designated by @samp{to-list} are copied to @samp{To:}
8098 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
8099 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
8100 the draft respectively.
8105 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8108 Match if the parent has @samp{Mail-Followup-To} field.
8109 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
8110 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
8114 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8117 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
8118 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
8121 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
8124 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
8125 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
8128 These are evaluated in order and first matched one is used.
8130 Moreover, the behavior of @kbd{a} with prefix argument can
8131 be directed by @code{wl-draft-reply-with-argument-list} as well.
8134 By the way, you can use some function (will be evaluated in the parent
8135 message buffer) in the place of @samp{key} or @samp{to-list} etc.
8137 If you want to write a rule for replying to message written by yourself,
8138 specify function @code{wl-draft-self-reply-p} as @samp{key}.
8140 If you only want to reply to mailing lists in
8141 @code{wl-subscribed-mailing-list} if the parent has some of them,
8146 (defun wl-mailing-list-addresses ()
8150 (nth 1 (std11-extract-address-components addr)))
8153 (elmo-multiple-fields-body-list (list "To" "Cc"))
8155 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
8156 (setq list-addrs (cons to list-addrs))))
8157 (nreverse list-addrs)))
8159 (setq wl-draft-reply-with-argument-list
8160 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
8161 ("Reply-To" . (("Reply-To") nil nil))
8162 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
8163 ("From" . (("From") nil nil))))
8168 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
8169 @subsection Appearance of Threads
8173 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
8174 390 09/18(Fri)07:25 +-[ Tsumura-san ]
8175 391 09/18(Fri)19:24 +-[ Murata-san ]
8176 392 09/20(Sun)21:49 +-[ Okunishi-san ]
8177 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
8178 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
8179 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
8180 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
8181 412 09/22(Tue)09:28 | +-[ Teranishi ]
8182 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
8183 416 09/22(Tue)12:38 | +-[ Teranishi ]
8184 395 09/20(Sun)21:49 +-[ Okunishi-san ]
8185 397 09/21(Mon)00:15 +-[ Okunishi-san ]
8189 Settings to make appearance of threads like shown above:
8193 (setq wl-thread-indent-level 2)
8194 (setq wl-thread-have-younger-brother-str "+")
8195 (setq wl-thread-youngest-child-str "+")
8196 (setq wl-thread-vertical-str "|")
8197 (setq wl-thread-horizontal-str "-")
8198 (setq wl-thread-space-str " ")
8202 If you do not want to see branches, do the following:
8206 (setq wl-thread-indent-level 2)
8207 (setq wl-thread-have-younger-brother-str " ")
8208 (setq wl-thread-youngest-child-str " ")
8209 (setq wl-thread-vertical-str " ")
8210 (setq wl-thread-horizontal-str " ")
8211 (setq wl-thread-space-str " ")
8216 @node User-Agent Field, , Thread Format, Advanced Settings
8217 @subsection User-Agent Field
8221 If you are eccentric enough to elaborate @samp{X-Mailer:} or
8222 @samp{User-Agent:} fields, define a function that generate appropriate
8223 strings as you like, and set it to variable
8224 @code{wl-generate-mailer-string-function}.
8226 If you do not want verbose @samp{User-Agent:} field, do the following:
8230 (setq wl-generate-mailer-string-function
8231 'wl-generate-user-agent-string-1)
8235 The following is a example:
8239 (setq wl-generate-mailer-string-function nil)
8240 (setq wl-draft-additional-header-alist
8242 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
8247 @node Customizable Variables, Hooks, Advanced Settings, Customization
8248 @section Customizable Variables
8250 Customizable variables that have not been described yet:
8253 @item wl-default-folder
8254 @vindex wl-default-folder
8255 The initial setting is @samp{%inbox}. This is the default value for moving to
8256 a folder and the like.
8258 @item wl-draft-folder
8259 @vindex wl-draft-folder
8260 The initial setting is @samp{+draft}. It is the folder to which drafts are
8261 saved. It must be a writable folder.
8262 Note that variable settings applied by @code{wl-draft-config-exec} is saved
8263 under @code{elmo-msgdb-directory}. That is to say, if you specified remote
8264 folder as @code{wl-draft-folder}, variable settings which are applied by
8265 @code{wl-draft-config-exec} before saving the draft will not affect on the
8266 draft buffer on another host by invoking @code{wl-summary-reedit}.
8268 @item wl-trash-folder
8269 @vindex wl-trash-folder
8270 The initial setting is @samp{+trash}. It is the wastebasket folder.
8271 If you changed this variable, you had better restart Wanderlust.
8273 @item wl-interactive-exit
8274 @vindex wl-interactive-exit
8275 The initial setting is @code{t}.
8276 If non-nil, you are asked for confirmation when Wanderlust terminates.
8278 @item wl-interactive-send
8279 @vindex wl-interactive-send
8280 The initial setting is @code{t}.
8281 If non-nil, you are asked for confirmation when mail is sent.
8283 @item wl-default-sync-range
8284 @vindex wl-default-sync-range
8285 The initial setting is @samp{update}.
8286 Default update range of the summary. You can specify
8287 @samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
8288 See description of @code{wl-summary-sync} for the meaning of ranges.
8290 @item wl-folder-sync-range-alist
8291 @vindex wl-folder-sync-range-alist
8292 The initial setting is the alist shown below:
8297 ("^\\+draft$\\|^\\+queue$" . "all"))
8302 This is an associative list of regular expressions of folder names and
8303 update range of the summary. Update range is one of the @samp{all},
8304 @samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
8305 match any of them, the value of @code{wl-default-sync-range} is used
8306 (@samp{update} by default).
8307 See description of @code{wl-summary-sync} for the meaning of ranges.
8310 @vindex wl-ask-range
8311 The initial setting is @code{t}.
8312 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
8313 for updating the summary when you changed folders.
8315 @item wl-mime-charset
8316 @vindex wl-mime-charset
8317 The initial setting is @code{x-ctext}.
8318 This is the MIME charset for messages that are not MIME (e.g. without
8319 @samp{Content-Type:}). This value also used as default charset for
8320 summary. (If you want to share Summary on Nemacs and other Emacsen, set
8321 this value as @code{iso-2022-jp}.)
8323 @item wl-highlight-folder-with-icon
8324 @vindex wl-highlight-folder-with-icon
8325 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
8326 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
8328 @item wl-strict-diff-folders
8329 @vindex wl-strict-diff-folders
8330 This is a list of regular expressions of folders.
8331 Unread messages are checked, for example when you press @kbd{s} in
8332 the folder mode, usually in a brief way (rapidly processed but not
8334 The folders matching this variable are seriously checked.
8335 You may want to set this variable so as to match conditional filter
8336 folders for IMAP4 folders.
8337 The initial setting is @code{nil}.
8339 @item wl-folder-use-server-diff
8340 @vindex wl-folder-use-server-diff
8341 When unread messages are checked, for example when you press @kbd{s} in
8342 the folder mode, usually (the number of messages on the server) @minus{}
8343 (the number of local messages) will be the number of unread messages.
8344 However, if this variable is non-nil, the number of unread messages on
8345 the server is checked. This affects IMAP4 folders only, but IMAP4
8346 folders in mail boxes matching
8347 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
8348 the number of unread messages on the server, even if they matches this
8349 variable. The initial setting is @code{t}.
8351 @item wl-auto-check-folder-name
8352 @vindex wl-auto-check-folder-name
8353 The initial setting is @code{nil}.
8354 You can specify a folder or a group which is checked for unread message
8355 at the start. You can also specify a list of folders (groups) to be checked.
8356 If the value is @code{nil}, whole Desktop is checked at the start.
8357 If it is @code{none}, no folders are checked.
8359 @item wl-auto-uncheck-folder-list
8360 @vindex wl-auto-uncheck-folder-list
8361 The initial setting is the list shown below:
8370 You can set a list of regular expressions to specify folders
8371 which are not automatically checked even if they are included
8372 in some groups assigned by @code{wl-auto-check-folder-name}.
8374 @item wl-auto-check-folder-list
8375 @vindex wl-auto-check-folder-list
8376 The initial setting is @code{nil}.
8377 You can set a list of regular expressions to specify exceptions
8378 for @code{wl-auto-uncheck-folder-list}.
8380 @item wl-no-save-folder-list
8381 @vindex wl-no-save-folder-list
8382 The initial setting is the list shown below:
8391 This is a list of regular expressions of folders not to be saved.
8393 @item wl-save-folder-list
8394 @vindex wl-save-folder-list
8395 The initial setting is @code{nil}.
8396 This is a list of regular expressions of folders to be saved.
8397 This takes precedence over @code{wl-no-save-folder-list}.
8399 @item wl-folder-mime-charset-alist
8400 @vindex wl-folder-mime-charset-alist
8401 The initial setting is the alist shown below:
8405 (("^-alt\\.chinese" . big5)
8406 ("^-relcom\\." . koi8-r)
8408 ("^-han\\." . euc-kr))
8413 This is an associative list of regular expressions of folder names and
8415 If a folder do not match, @code{wl-mime-charset} is used.
8417 @item wl-folder-init-load-access-folders
8418 @vindex wl-folder-init-load-access-folders
8419 The initial setting is @code{nil}.
8420 This is a list of access groups to be loaded specifically at the start.
8421 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
8423 @item wl-folder-init-no-load-access-folders
8424 @vindex wl-folder-init-no-load-access-folders
8425 The initial setting is @code{nil}.
8426 This is a list of access groups not to be loaded specifically at the
8428 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
8430 @item wl-dispose-folder-alist
8431 @vindex wl-dispose-folder-alist
8432 The initial setting is the alist shown below:
8442 This list determines disposition of messages with disposal marks.
8443 Each item in the list is a folder and destination; you can specify any
8444 one of the following in the place of destination:
8447 @code{remove} or @code{null} : deletes the messages instantly.
8448 string : moves the messages to the specific folder.
8449 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
8452 @item wl-x-face-file
8453 @vindex wl-x-face-file
8454 The initial setting is @file{~/.xface}.
8455 The name of the file that contains encoded X-Face strings.
8458 @item wl-demo-display-logo
8459 @vindex wl-demo-display-logo
8460 If non-nil, bitmap image is shown on the opening demo. If you set
8461 @code{xpm} or @code{xbm}, (if possible) display selected image type
8464 @item elmo-use-database
8465 @vindex elmo-use-database
8466 This is meaningful for XEmacs only. The initial setting depends on
8467 XEmacs (@code{t} for XEmacs with dbm).
8468 If non-nil, Message-ID is controlled by dbm.
8470 @item elmo-passwd-alist-file-name
8471 @vindex elmo-passwd-alist-file-name
8472 The initial setting is @file{passwd}.
8473 This is the name of the file in which passwords are saved.
8474 @code{elmo-passwd-alist-save} saves current passwords to the file.
8476 @item elmo-nntp-list-folders-use-cache
8477 @vindex elmo-nntp-list-folders-use-cache
8478 The initial setting is 600 (in seconds).
8479 This is period in seconds during which results of @samp{list} and
8480 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
8483 @item elmo-nntp-max-number-precedes-list-active
8484 @vindex elmo-nntp-max-number-precedes-list-active
8485 The initial setting is @code{nil}.
8486 If non-nil, the number of article obtained by @samp{list active} in NNTP
8487 are used as the maximum article number of the folder.
8488 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
8489 and if the number of read messages is not correct.
8491 @item elmo-nntp-default-use-listgroup
8492 @vindex elmo-nntp-default-use-listgroup
8493 The initial setting is @code{t}.
8494 If non-nil, @samp{listgroup} is used for checking the total number of
8495 articles. If it is @code{nil}, @samp{group} is used. In the latter
8496 case, the processing will be a little faster at the sacrifice of
8499 @item elmo-pop3-send-command-synchronously
8500 @vindex elmo-pop3-send-command-synchronously
8501 The initial setting is @code{nil}.
8502 If non-nil, POP3 commands are issued synchronously. Some implementation
8503 of POP3 server fails to get summary information without this setting.
8504 You may have to set this variable to @code{t}, if the process hangs
8505 while looking up POP3.
8507 @item elmo-dop-flush-confirm
8508 @vindex elmo-dop-flush-confirm
8509 The initial setting is @code{t}.
8510 If non-nil, you are asked for confirmation if accumulated off-line
8511 operations are executed.
8513 @item elmo-display-progress-threshold
8514 @vindex elmo-display-progress-threshold
8515 The initial setting is 20.
8516 Threshold for display of progress gauge. If number of renewal is more than
8517 this value, display progress gauge.
8521 @node Hooks, , Customizable Variables, Customization
8527 @node Migration, Terminology, Customization, Top
8528 @chapter Switch from older version of Wanderlust
8531 This chapter explains the important thing for the upgrade,
8532 or migration from the previous version.
8533 It includes the changes of the setup, limitations etc.
8536 * Before 2.12.0:: From prior to the version 2.12.0
8539 @node Before 2.12.0, , Migration, Migration
8540 @section Migration from prior to the version 2.12.0
8542 @subsection The conversion of msgdb
8544 From version 2.12.0 on, the structure of msgdb is changed.
8545 The msgdb for newly created folder will use this new format when created and saved.
8546 But by writing following line, you may use the old format of the msgdb as it was.
8550 (setq elmo-msgdb-default-type 'legacy)
8554 With the default setup,
8555 the old msgdb format will be used as it was.
8556 You may convert the format
8557 by writing following lines in @file{~/.wl} or so.
8561 ;; @r{If the format of msgdb is different from} @code{elmo-msgdb-default-type},
8562 ;; @r{the format will be converted automatically when}
8563 ;; @r{the msgdb is being loaded.}
8564 (setq elmo-msgdb-convert-type 'auto)
8566 ;; @r{Convert msgdb when hitting @kbd{s all} in Summary mode}
8567 (setq elmo-msgdb-convert-type 'sync)
8571 As is explained in above section, you may continue to use the old format.
8572 But you will have following limitations.
8576 You may only use @samp{important} flag. The other flags may not be available.
8579 @subsection Changes from @samp{'mark} folder to @samp{'flag}.
8581 The folder @samp{'mark} will be automatically converted to @samp{'flag}
8582 folder when you first start the new version of Wanderlust.
8583 But there are some restrictions on this type of migrated folder.
8587 @samp{important} flag attached will not be
8588 removed by deleting the associated message in @samp{'flag} folder.
8591 The message won't be deleted by removing
8592 @samp{important} flag in @samp{'flag} folder.
8595 help-echo will not show you the old message.
8599 If you have problem with migrating
8600 from @samp{'mark} folder to the @samp{'flag} folder,
8602 @kbd{M-x elmo-global-mark-upgrade} will transfer the message
8603 from @samp{'mark} folder to the @samp{'flag} folder.
8604 The duplicated message will not be processed,
8605 you may issue that command repeatedly.
8608 @node Terminology, Mailing List, Migration, Top
8609 @chapter Terminology around Wanderlust
8612 Here we explain terminologies used in this manual.
8616 A container in which messages are stored.
8619 A set consists of some folders.
8622 A special group consists of automatically collected folders under
8623 some specified path.
8624 @xref{Folder Definition}.
8626 @item summary buffer
8627 A buffer for displaying list of messages in some folder.
8629 @item sticky summary
8630 Compared with ordinary summary buffer which will be destroyed after
8631 exiting from it, this type of summary will be remain even after exiting
8632 by @kbd{q} or @kbd{g}.
8633 @xref{Sticky Summary}.
8636 To delete or put into the archive expired messages.
8643 To cache messages beforehand in order to read messages after you will be
8644 disconnected from the server.
8648 @node Mailing List, Addition, Terminology, Top
8649 @chapter Wanderlust Mailing List
8653 Topics related to Wanderlust are discussed in following mailing lists.
8654 The latest version is also announced there.
8657 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
8660 In this list Japanese is mainly used for discussion. We also have a list
8661 for discussion in English:
8664 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
8666 (Messages posted to this list are also forwarded to the former one.)
8668 A guide can be obtained automatically by sending mail to
8669 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
8670 the English one) with the body
8676 Please send bug reports or patches to one of those lists. You can post to
8677 the mailing list even though you are not a member of it.
8679 If you send a bug report, please attach Backtrace with it.
8680 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
8683 I would like to express my thanks to the members of the mailing list for
8684 valuable advice and many pieces of code they contributed.
8688 You can read messages posted to the mailing list on the web or in
8691 Read messages posted to @t{<wl@@lists.airs.net>}
8694 @uref{http://lists.airs.net/wl/archive/}
8695 @uref{news://gmane.mail.wanderlust.general.japanese@@news.gmane.org}
8698 Read messages posted to @t{<wl-en@@lists.airs.net>}
8701 @uref{http://lists.airs.net/wl-en/archive/}
8702 @uref{news://gmane.mail.wanderlust.general@@news.gmane.org}
8706 @node Addition, Index, Mailing List, Top
8707 @chapter Additional Information
8709 @section Brief History
8712 1998 3/05 Tried to make a prototype that displays MH messages in threads.
8713 3/10 Made a msgdb mechanism by elisp.
8714 3/26 IMAP and NNTP can be displayed in threads.
8715 4/13 Began to assemble thread display modules as elmo.
8716 5/01 Finished 0.1.0, initial version with many defects.
8717 6/12 I made a slip of the tongue and said I was writing elisp
8718 mailer supporting IMAP
8719 6/16 0.1.3 was announced at tm-ja, elisp ML.
8720 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
8721 7/01 Support for mm-backend (0.3.0).
8722 8/25 multi folder added (0.5.0).
8723 8/28 filter folder added (0.5.1).
8724 9/10 You can open/close threads (0.6.0).
8725 9/11 fldmgr by Murata-san made editing folders easy.
8726 9/18 lha folders added by Okunishi-san (0.6.3).
8727 9/24 Display of branches of threads (0.6.5).
8728 9/28 Compression folder supporting multiple archivers by Okunishi-san.
8729 10/28 Off-line operations (0.7.4).
8730 12/09 Becomes beta version.
8731 12/21 wl-expire by Murata-san.
8732 1999 2/03 auto-refile by Tsumura-san.
8733 4/28 wl-template by Murata-san.
8734 5/18 Released 1.0.0 stable.
8735 7/05 Scoring by Murata-san (2.1.0).
8736 9/26 New plugged system by Murata-san (2.2.2).
8737 12/20 Support Modified UTF7.
8738 2000 3/24 Released 1.1.0 stable.
8739 4/03 CVS development started.
8740 5/07 Thread restoration & Its speed up with Murata-san.
8741 6/12 Address completion with LDAP with Chiba-san & Goto-san.
8742 7/11 killed message feature.
8743 7/18 Use UIDL in POP3.
8744 9/12 biff feature with Satata-san & Yamaoka-san.
8745 10/17 expire-hide by Okada-san.
8746 11/08 Released 2.4.0 stable.
8747 2001 7/04 Released 2.6.0 stable.
8748 8/21 wl-addrmgr by Kitamoto-san.
8749 12/27 Released 2.8.1 stable.
8750 2002 12/11 Released 2.10.0 stable.
8753 See @file{ChangeLog} for details.
8757 According to a dictionary, Wanderlust has the meaning:
8761 n eager longing for or impulse towards travelling in distant lands
8762 [Ger, fr wandern to wander + lust desire, pleasure]
8766 but I had no profound intention. (if farfetched, IMAP @result{} you can
8767 read mail anywhere @result{} desire to wander ?)
8769 Elmo is the abbreviation of @samp{Elisp Library for Message
8770 Orchestration}. At first I meant the red puppet in the Sesame Street,
8771 but you may associate it with Wandering @result{} Drifting @result{}
8772 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
8776 Each versions has code names (they are almost jokes).
8777 Currently they are picked up alphabetically from the top 40 hits of
8778 U.S. Billboard magazines in 1980s.
8780 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
8783 @node Index, , Addition, Top
8787 * Concept Index:: Concept Index
8788 * Key Index:: Key Index
8789 * Variable Index:: Variable Index
8790 * Function Index:: Function Index
8793 @node Concept Index, Key Index, Index, Index
8794 @unnumberedsec Concept Index
8797 @node Key Index, Variable Index, Concept Index, Index
8798 @unnumberedsec Key Index
8801 @node Variable Index, Function Index, Key Index, Index
8802 @unnumberedsec Variable Index
8805 @node Function Index, , Variable Index, Index
8806 @unnumberedsec Function Index