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
1751 @node Folder, Summary, Folders, Top
1752 @chapter Folder mode
1755 After you start Wanderlust, folder mode is appeared firstly.
1756 It contains folder list you subscribed.
1757 You can select and edit folders in this mode.
1760 * Selecting Folder:: Select folder you want to read
1761 * Folder Manager:: Editing folders
1765 @node Selecting Folder, Folder Manager, Folder, Folder
1766 @section Selecting Folder
1767 @cindex Selecting Folder
1769 @subsection Usage (TIPS)
1771 @subsubsection Check new, unread number
1773 Folder mode looks like this.
1774 (In XEmacs, it looks much nicer @t{;-)})
1778 [-]Desktop:14186/35580/67263
1783 [-]Emacsen:0/34/4837
1784 Wanderlust ML:0/0/558
1787 XEmacs Beta:0/29/255
1798 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1802 @kbd{s} key on the folder line updates these numbers.
1803 It changes its color if it has many new messages.
1805 The whole folder mode is a folder group named @samp{Desktop}.
1806 Folder group open/close by return key.
1807 A operation to a folder group is treated as operations on the
1809 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1810 six children folders update its unread number status.
1812 @subsubsection Select Folder
1814 To enter summary mode of the folder, type return (or space) key on
1816 If the variable @code{wl-stay-folder-window} has non-nil value,
1817 summary window appears on the right of the folder mode window.
1819 @subsection Key bindings
1821 Folder mode's key binding (related to selecting folders) is following.
1826 @kindex @key{SPC} (Folder)
1827 @kindex @key{RET} (Folder)
1828 @findex wl-folder-jump-to-current-entity
1829 Enter to the summary mode of the folder at the current cursor point.
1830 With prefix argument, enter the sticky summary.
1831 If the cursor is on the top of folder group line,
1832 the folder group is opened or closed.
1833 When the cursor is on the access group and this command is called
1834 with prefix argument, folder children list is updated to the newest one.
1835 (Children list is updated recursively if the access folder has hierarchical
1837 (@code{wl-folder-jump-to-current-entity})
1840 @kindex M-@key{RET} (Folder)
1841 @findex wl-folder-update-recursive-current-entity
1842 Folder children list of the access group at the current cursor point
1843 is updated to the newest one.
1844 (Children list is updated recursively if the access folder has hierarchical
1846 (@code{wl-folder-update-recursive-current-entity})
1851 Create a new draft message.
1856 @findex wl-folder-write-current-folder
1857 If the current cursor point is on the NNTP folder, create a new draft
1858 message which already has @samp{Newsgroups:} field. If the current
1859 cursor point is on the folder for mailing list (refile destination),
1860 create a new draft message which already has @samp{To:} field with
1861 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1863 (@code{wl-folder-write-current-folder})
1866 @kindex C-c C-o (Folder)
1867 @findex wl-jump-to-draft-buffer
1868 Move to the draft buffer if available. If multiple draft buffer exists,
1869 moved to one after another. If prefix argument is specified, load draft
1870 folder's message to the draft buffer and jump to it.
1871 (@code{wl-jump-to-draft-buffer})
1875 @findex wl-folder-check-current-entity
1876 Update new and unread number information of the folder at the current
1878 (@code{wl-folder-check-current-entity})
1882 @findex wl-folder-sync-current-entity
1883 Update summary information of the folder at the current cursor point.
1884 (@code{wl-folder-sync-current-entity})
1887 @kindex r s (Folder)
1888 @findex wl-folder-check-region
1889 Update new and unread number information of the folders in the currently
1891 (@code{wl-folder-check-region})
1894 @kindex r S (Folder)
1895 @findex wl-folder-sync-region
1896 Update summary information of the folders in the currently selected region.
1897 (@code{wl-folder-sync-region})
1901 @findex wl-status-update
1902 Sync up address book status with @file{~/.addresses}'s content.
1903 (@code{wl-status-update})
1907 @findex wl-folder-prev-unread
1908 Jump cursor to the folder which have unread messages on the upward from
1909 current cursor point.
1910 (@code{wl-folder-prev-unread})
1914 @findex wl-folder-next-unread
1915 Jump cursor to the folder which have unread messages on the downward
1916 from current cursor point.
1917 (@code{wl-folder-next-unread})
1921 @findex wl-folder-prev-entity
1922 Move cursor to the folder on the previous line.
1923 (@code{wl-folder-prev-entity})
1927 @findex wl-folder-next-entity
1928 Move cursor to the folder on the next line.
1929 (@code{wl-folder-next-entity})
1933 @findex wl-folder-jump-folder
1934 Jump to the folder specified by the user input.
1935 (@code{wl-folder-jump-folder})
1939 @findex wl-folder-prefetch-current-entity
1940 Prefetch new messages of the folder at the current cursor point by
1941 @code{wl-summary-incorporate}.
1942 If the cursor is on the folder group, it is executed recursively.
1943 (@code{wl-folder-prefetch-current-entity})
1947 @findex wl-folder-mark-as-read-all-current-entity
1948 Mark all unread messages of the folder at the current cursor point as read.
1949 If the cursor is on the folder group, it is executed recursively.
1950 (@code{wl-folder-mark-as-read-all-current-entity})
1954 @findex wl-folder-goto-first-unread-folder
1955 Enter summary mode of the first unread folder.
1956 (@code{wl-folder-goto-first-unread-folder})
1960 @findex wl-folder-empty-trash
1962 (@code{wl-folder-empty-trash})
1966 @findex wl-folder-flush-queue
1968 (@code{wl-folder-flush-queue})
1972 @findex wl-folder-virtual
1973 Move to the virtual folder (filter folder) with the condition specified.
1974 (@code{wl-folder-virtual})
1978 @findex wl-folder-pick
1979 Search the folders with the condition specified.
1980 (@code{wl-folder-pick})
1984 @findex wl-folder-open-all-unread-folder
1985 All unread folder is opened.
1986 (@code{wl-folder-open-all-unread-folder})
1990 @findex wl-execute-temp-marks
1991 Execute marks in summary buffers. @xref{Sticky Summary}.
1992 (@code{wl-execute-temp-marks})
1996 @findex wl-folder-open-close
1997 Folder group is opened/closed.
1998 (@code{wl-folder-open-close})
2002 @findex wl-folder-open-all
2003 All folder group is opened.
2004 (@code{wl-folder-open-all})
2008 @findex wl-folder-close-all
2009 All folder group is closed.
2010 (@code{wl-folder-close-all})
2020 @findex wl-folder-suspend
2022 (@code{wl-folder-suspend})
2025 @kindex M-s (Folder)
2027 Save current folder status.
2031 @kindex M-t (Folder)
2032 @findex wl-toggle-plugged
2033 Toggle Wanderlust's offline/online status.
2034 (@code{wl-toggle-plugged})
2037 @kindex C-t (Folder)
2038 @findex wl-plugged-change
2039 Start Wanderlust's plug-status manager.
2040 (@code{wl-plugged-change})
2043 @subsection Customize variables
2046 @item wl-folders-file
2047 @vindex wl-folders-file
2048 The initial setting is @file{~/.folders}.
2049 Subscribed folders are described (saved) in this file.
2051 @item wl-folder-info-save
2052 @vindex wl-folder-info-save
2053 The initial setting is @code{t}. If non-nil, unread information is
2054 saved and used in the next Wanderlust session.
2056 @item wl-stay-folder-window
2057 @vindex wl-stay-folder-window
2058 The initial setting is @code{nil}.
2059 If non-nil, summary window is appeared on the right side of the folder buffer.
2061 @item wl-folder-window-width
2062 @vindex wl-folder-window-width
2063 The initial setting is 20.
2064 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
2066 @item wl-folder-use-frame
2067 @vindex wl-folder-use-frame
2068 The initial setting is @code{nil}.
2069 If non-nil, use new frame for the folder window.
2071 @item wl-folder-many-unsync-threshold
2072 @vindex wl-folder-many-unsync-threshold
2073 The initial setting is 70.
2074 If the number of unread messages is more than this value,
2075 folder color is changed.
2077 @item wl-highlight-folder-by-numbers
2078 @vindex wl-highlight-folder-by-numbers
2079 This option controls how to highlight each line in the folder buffer.
2080 The default value is @code{t}, highlighting with various colors based on
2081 the message numbers. If it is @code{nil}, highlighting with various
2082 colors based on the folder status. In addition, if it is a number
2083 (e.g. 1), highlighting will be done based on both the message numbers
2084 and the folder status.
2086 @item wl-folder-desktop-name
2087 @vindex wl-folder-desktop-name
2088 The initial setting is @samp{Desktop}.
2089 The name of top folder group.
2091 @item wl-folder-petname-alist
2092 @vindex wl-folder-petname-alist
2093 The initial setting is @code{nil}.
2094 An alist of folder's realname and its nickname.
2096 @item wl-folder-access-subscribe-alist
2097 @vindex wl-folder-access-subscribe-alist
2098 The initial setting is @code{nil}.
2100 Control automatic subscribing and unsubscribing of the children list
2106 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2110 If @var{subscribe-flag} is non-nil, folders which have name matched to
2111 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2112 already unsubscribed folder is not displayed even when the
2113 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2120 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2121 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2122 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2123 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2127 @item wl-folder-hierarchy-access-folders
2128 @vindex wl-folder-hierarchy-access-folders
2129 A list of regular expressions for access groups which creates children
2130 folder list hierarchically.
2132 For example, if you specify
2133 @code{wl-folder-hierarchy-access-folders} like following,
2137 (setq wl-folder-hierarchy-access-folders
2138 '("^-[^\\.]*$" "^-comp.unix$" "^-comp.unix.bsd$"))
2143 you obtain the access group hierarchy as follows.
2149 -fj.comp.announce:0/0/2
2150 -fj.comp.dev.cdrom:0/0/0
2152 [+]-japan:238/238/1688
2155 -comp.unix.admin:0/0/0
2156 -comp.unix.dos-under-unix:0/0/0
2157 -comp.unix.programmer:0/0/0
2158 [-]-comp.unix.bsd:0/0/23
2159 -comp.unix.bsd.freebsd.announce:0/0/0
2164 If you opened @samp{-} in this example, only the direct children is created
2165 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2166 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2167 is not created until the children access group is opened.
2171 @node Folder Manager, , Selecting Folder, Folder
2172 @section Editing Folders
2173 @cindex Folder Manager
2174 @cindex Folder, Edit
2175 @cindex Folder, Subscribe
2176 @cindex Folder, Unsubscribe
2178 As described before, subscribed folder list is saved in @file{~/.folders} file.
2179 But you don't have to edit @file{~/.folders} directly.
2180 You can append, delete, edit folders from folder mode.
2182 @subsection Usage (Tips)
2184 @subsubsection Append Folder
2186 @kbd{m a} appends new folder to your folder list. If you enter non-existent
2187 folder, it will ask you to create a new one.
2188 @kbd{m g} appends new folder group.
2189 To append new folder to this group, firstly open it,
2190 then execute append command in the next line.
2192 @subsubsection Edit Folder
2194 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2195 Thus, you can change folder position as if you were editing a normal file.
2197 @subsubsection Create Multi Folder.
2201 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2203 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2205 Type @kbd{m m}, then you can create multi folder.
2208 @subsubsection Delete Nickname, Filter
2210 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2211 minibuffer while appending.
2213 @subsubsection Append Folder to Empty Group
2215 To append new folder to the empty folder group
2216 (after you create folder group by typing @kbd{m g}),
2217 firstly open it, then execute append command in the next line.
2218 If it is closed, folder is appended on the same level with
2219 the folder group above. It is difficult to explain by words so try it.
2220 In other words, appended position depends on the
2221 open/close status of the upper one.
2223 @subsubsection Charset of the Folders File.
2225 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2227 @subsubsection Create Filter
2229 @kbd{m f} adds filter to the folder at the current cursor point. To
2230 create new filter folder and leave the current folder unchanged, copy it
2231 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2232 filter can be specified while appending filter. If you put
2233 ``''(@var{NULL}), filter is deleted.
2235 @subsubsection Sort Folders
2237 Sorting of the folders is executed by the function specified by
2238 @code{wl-fldmgr-sort-function}.
2239 The initial setting is @code{wl-fldmgr-sort-standard},
2240 which sorts alphabetically.
2241 Sorting affects only on the current folder group. It does not
2242 affect on the child groups.
2244 @subsubsection Hiding Folders in the Access Group
2246 Usually, access group displays all children folders, but you can set
2247 some folders hidden. Following operations are only available on access
2250 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2251 (subscribe/unsubscribe) of the folder at current cursor point. Against
2252 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2255 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2256 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2257 argument and if the argument has positive number, the unsubscribe it.
2258 If the prefix argument has negative value, folder becomes visible and if
2259 zero, folder visibility is toggled.
2261 The other commands, @code{wl-fldmgr-subscribe} and
2262 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2265 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2266 executed in the access group, they have a same effect with
2267 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2268 The difference is that cut commands deletes folders from the current
2271 @subsubsection Operations in the Access Group
2273 You can insert and delete folders in the access group like usual folder
2274 group. But insert and delete commands can be only available for the
2275 children folders of the access group and they only sets the subscribe
2276 status. In other words, insertion of the folder means subscribing,
2277 deletion means unsubscribing.
2278 @footnote{In the current implementation,
2279 it is faster to delete region than to unsubscribe region.}
2281 To update the access group when children folders are inserted or deleted
2282 by other way (other than Wanderlust),
2283 open the access group by typing @kbd{C-u @key{RET}}.
2284 @xref{Selecting Folder}.
2286 The order of children folders of access group is saved after
2287 insertion/deletion/sorting.
2288 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2289 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2290 newly created folders are inserted on the top of the access group.
2292 @subsection Key bindings
2293 @cindex Keybind, Folder Mode
2294 @cindex Keybind, Folder Buffer
2296 Key bindings on the folder mode related to folder editing are shown below.
2297 All bindings starts with @kbd{m}, and primary commands are binded to
2298 one stroke key binding.
2302 @kindex m a (Folder)
2303 @findex wl-fldmgr-add
2304 Add specified folder to your folder list . If you enter non-existent
2305 folder, create it after confirmation.
2306 (@code{wl-fldmgr-add})
2311 @kindex m g (Folder)
2312 @findex wl-fldmgr-make-group
2313 Create a folder group.
2314 (@code{wl-fldmgr-make-group})
2317 @kindex m A (Folder)
2318 @findex wl-fldmgr-make-access-group
2319 Create an access group.
2320 (@code{wl-fldmgr-make-access-group})
2323 @kindex m d (Folder)
2324 @findex wl-fldmgr-delete
2325 Delete folder itself and msgdb.
2326 If the folder itself cannot be deleted like NNTP folder,
2327 only msgdb is deleted.
2328 (@code{wl-fldmgr-delete})
2333 @kindex m R (Folder)
2334 @findex wl-fldmgr-rename
2335 Change the name of folder or folder group.
2336 msgdb's path is also changed.
2337 (@code{wl-fldmgr-rename})
2343 @findex wl-fldmgr-make-multi
2344 Create a multi folders in the cutlist (cut, copied folders).
2345 (@code{wl-fldmgr-make-multi})
2350 @kindex m f (Folder)
2351 @findex wl-fldmgr-make-filter
2352 Create a filter folder. (Put a filter on the folder).
2353 (@code{wl-fldmgr-make-filter})
2357 @kindex M-c (Folder)
2358 @kindex m c (Folder)
2359 @findex wl-fldmgr-copy
2360 Copy folder (it is not available on folder group).
2361 (@code{wl-fldmgr-copy})
2365 @kindex M-w (Folder)
2366 @kindex m W (Folder)
2367 @findex wl-fldmgr-copy-region
2368 Copy folders in the specified region.
2369 (@code{wl-fldmgr-copy-region})
2373 @kindex C-k (Folder)
2374 @kindex m k (Folder)
2375 @findex wl-fldmgr-cut
2376 Cut folder. Folder itself is not deleted.
2377 (@code{wl-fldmgr-cut})
2381 @kindex C-w (Folder)
2382 @kindex m C-w (Folder)
2383 @findex wl-fldmgr-cut-region
2384 Cut folders in the specified region.
2385 (@code{wl-fldmgr-cut-region})
2389 @kindex C-y (Folder)
2390 @kindex m y (Folder)
2391 @findex wl-fldmgr-yank
2392 Paste folders that are copied or cut (folders in the cut-list).
2393 (@code{wl-fldmgr-yank})
2396 @kindex m p (Folder)
2397 @findex wl-fldmgr-set-petname
2398 Put nickname on the folder.
2399 (@code{wl-fldmgr-set-petname})
2402 @kindex m q (Folder)
2403 @findex wl-fldmgr-clear-cut-entity-list
2404 Clear the cut-list. (cut, copied folder information is cleared,
2405 you cannot paste after this)
2406 (@code{wl-fldmgr-clear-cut-entity-list})
2409 @kindex m s (Folder)
2410 @findex wl-fldmgr-sort
2411 Sort folders in the current folder group.
2412 (@code{wl-fldmgr-sort})
2415 @kindex m C-s (Folder)
2416 @findex wl-fldmgr-save
2417 Save current folder view to the @file{wl-folders-file}.
2418 (@code{wl-fldmgr-save})
2421 [Following commands are only available on the access groups]
2427 @kindex m u (Folder)
2428 @findex wl-fldmgr-unsubscribe
2429 Set the visibility of folder (subscribe/unsubscribe).
2430 (@code{wl-fldmgr-unsubscribe})
2435 @kindex r u (Folder)
2436 @findex wl-fldmgr-unsubscribe-region
2437 Set the visibility of the folders (subscribe/unsubscribe) in the
2439 (@code{wl-fldmgr-unsubscribe-region})
2444 @kindex m l (Folder)
2445 @findex wl-fldmgr-access-display-normal
2446 List folders that are currently available.
2447 (@code{wl-fldmgr-access-display-normal})
2452 @kindex m L (Folder)
2453 @findex wl-fldmgr-access-display-all
2454 List all folders regardless of the subscription status.
2455 (@code{wl-fldmgr-access-display-all})
2459 @subsection Customize variables
2462 @item wl-interactive-save-folders
2463 @vindex wl-interactive-save-folders
2464 The initial setting is @code{t}. If non-nil and folder view is
2465 modified, confirm saving it before Wanderlust or Emacs exits. If
2466 @code{nil}, save without confirmation.
2468 @item wl-fldmgr-make-backup
2469 @vindex wl-fldmgr-make-backup
2470 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2471 created before saving the folder status.
2473 @item wl-fldmgr-sort-function
2474 @vindex wl-fldmgr-sort-function
2475 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2476 sort folders. By default function, folders are sorted alphabetically
2477 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2480 @item wl-fldmgr-sort-group-first
2481 @vindex wl-fldmgr-sort-group-first
2482 The initial setting is @code{t}. If non-nil,
2483 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2484 does not care whether it is folder group or not.
2486 @item wl-folder-check-async
2487 @vindex wl-folder-check-async
2488 The initial setting is @code{t}. If non-nil, check folder's unread
2489 status asynchronously. It boosts newsgroup checking.
2491 @item wl-folder-check-fast
2492 @vindex wl-folder-check-fast
2493 The initial setting is @code{nil}.
2494 If non-nil, it does not update folder status while checking.
2496 @item wl-folder-notify-deleted
2497 @vindex wl-folder-notify-deleted
2498 The initial setting is @code{nil}.
2500 If non-nil, negative value is displayed when the message is deleted. If
2501 @code{sync}, folder is synchronized when the message is deleted. If
2502 @code{nil}, message deletion is ignored.
2504 @item wl-fldmgr-add-complete-with-current-folder-list
2505 @vindex wl-fldmgr-add-complete-with-current-folder-list
2506 The initial setting is @code{nil}.
2507 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2508 candidate for @code{wl-fldmgr-add}.
2511 @subsection Miscellanea
2513 Following is a note for folder editing.
2517 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2518 paste(yank) command pastes the folders on one cut or copy command
2519 (If copy command is executed by region, folders in the region are pasted
2520 by one paste command)
2523 You cannot cut @samp{Desktop} group.
2524 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2527 You cannot copy folder group.
2530 Operations on the access group are only available for the folders
2531 in the same access group.
2534 You cannot create a folder which has same name with the folders already exist.
2537 You cannot insert folders which have same name in one group.
2538 You can insert them in the different groups.
2539 You cannot put same nickname to the different folders.
2543 @node Summary, Message, Folder, Top
2544 @chapter Summary Mode
2546 After you select the folder via folder mode, you enter to the summary
2550 * Usage of Summary Mode:: TIPS
2551 * Thread Operations:: Thread operations
2552 * Cache:: File cache, Buffer cache, and Prefetch
2553 * Auto Refile:: Auto refile settings
2554 * Sticky Summary:: Summary make sticky
2555 * Summary View:: Format of summary lines
2556 * Mark and Action:: Temporary marks and their effect
2557 * Key Bindings of Summary:: Key bindings
2558 * Variables of Summary:: Customize Summary Mode
2562 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2563 @section Usage (Tips)
2565 @subsection Summary Content
2567 In the summary mode, messages are displayed like following.
2571 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2572 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2573 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2574 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2581 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2585 If you want to know how to change the format for this, please refer
2586 the section format of Summary lines.
2587 @xref{Summary View}.
2589 @var{Message number} is the message's unique number in the folder. In
2590 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2591 in the MH folder, it is the filename of the message.
2593 @var{Temporal mark} and @var{Persistent mark} are described later.
2595 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2596 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2597 Japanese, but if you want to display it in English, set the value of
2598 @code{wl-summary-weekday-name-lang} as @samp{en}.
2600 @var{Sender}'s indentation corresponds to the depth of the thread.
2601 Sender name is displayed as nickname if it is defined in the address
2602 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2603 displaying with nickname.
2605 If number is printed at the head of @var{Sender} part like @samp{+2},
2606 that means the message have 2 follow messages.
2608 @var{Subject} is the @samp{Subject:} header field of the message. If
2609 the message have same @samp{Subject:} with the parent message, it is not
2610 displayed. Some mailing list puts its sequence number in the
2611 @samp{Subject:} field, but it is
2612 ignored. @code{wl-summary-no-subject-message} is displayed when the
2613 message has empty subject field.
2615 @subsection Temporary Marks
2616 @cindex Mark, Temporary
2618 There are four temporary marks,
2619 @samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}.
2620 Temporary marks indicates message operations.
2625 You can execute a command on the all messages that have @samp{*} mark,
2626 with the key bindings which begins with @kbd{m}.
2629 The mark to dispose. You can put @samp{d} by typing @kbd{d} key.
2632 The mark to force delete. You can put @samp{D} by typing @kbd{D} key.
2636 After you type @kbd{o} key, prompt appears to input refile destination.
2637 Your answer is printed in the summary line.
2641 You can put this mark by typing @kbd{O} key.
2642 The difference between this mark and refile mark is,
2643 this mark does not delete the message while latter does.
2646 The mark to prefetch reserved.
2647 You can put this mark by typing @kbd{i} key.
2650 The mark to resend reserved.
2651 After you type @kbd{~} key, prompt appears to input address to resend.
2652 Your answer is printed in the summary line.
2655 @kbd{x} key executes action for temporary marks, respectively.
2657 @subsection Persistent Marks
2659 There are five persistent marks, @samp{N}, @samp{?}, @samp{U}, @samp{!},
2660 @samp{u}, @samp{A}, @samp{&} and @samp{$}.
2662 The persistent mark indicates the message's status and it is saved.
2663 Each persistent mark indicates:
2669 It is new but cached message.
2671 It is unread message.
2673 It is unread but cached message.
2675 It is read but it is not cached.
2677 It is already replied message.
2679 It is already replied but cached message.
2681 It is a message with some global flag. It is convenient to put this
2682 mark on the messages to remember (If you want to remember to write a
2683 reply for the message, for example) because this mark remains after
2684 you exited Emacs. Messages with the @samp{$} mark can be reviewed in
2685 the @samp{'flag} folder even the message itself is deleted in the actual
2686 folder. You can put global flag by typing @kbd{$} or @kbd{F} key.
2689 If the message is read and cached (or local message),there are no
2693 @samp{N}, @samp{U}, @samp{u}, @samp{A} indicates that the message have
2694 no cache. Messages with the marks other than these, you can read them
2695 in the offline status even they are in the IMAP folder or netnews
2698 Among messages with persistent marks, ones with marks specified by
2699 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2700 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2702 @subsection How To Read
2704 Basically, you can read messages only typing space key again and again.
2706 To update summary status to the newest status (synchronize),
2709 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2710 moves cursor to the next message.
2711 Enter message buffer by typing @kbd{j} key.
2712 To operate multipart, you have to enter to the message buffer.
2715 @subsection Pack the Message Numbers
2716 You can pack the message numbers in Summary by
2717 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2718 News Spool Folder and Maildir Folder are supported folder types.
2721 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2722 @section Thread Operations
2724 For example, the following line indicates one thread (a context of a topic).
2727 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2731 If you type @kbd{/} on this line, the thread is opened and it changes
2732 the appearance like following.
2736 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2737 388 09/17(Thu)22:34 +-[ Murata san ]
2741 (Message 388 is the replied message to the message 384.)
2742 If you type @kbd{/} key once again, the thread is closed.
2743 With prefix argument, @kbd{/} opens all children threads.
2745 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2748 Commands with the key binding that begins with @kbd{t} executes commands
2749 on the messages in the thread.
2750 @xref{Key Bindings of Summary}.
2752 @subsection reconstruct thread by hand
2754 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2755 (@code{wl-summary-save-current-message}) at the corresponding message,
2756 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2757 message then you have the reconstructed thread.
2760 @node Cache, Auto Refile, Thread Operations, Summary
2763 @subsection Cache File
2765 The messages which have to access via network (e.x. IMAP, NNTP folder)
2766 are cached as a local file so as to save network traffic or to enable
2767 off-line operation. The cache file is saved under the directory
2768 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2769 elmo-cache-expire-by-size}. The command deletes cache files to the
2770 specified size by the order of last accessed time.
2772 @subsection Buffer Cache and Prefetching
2774 The messages that are read are kept in the cache buffer so as to make
2775 the behavior fast when you are to read the message again. It is called
2776 `buffer cache'. The number of cache buffer is specified by
2777 @code{wl-message-buffer-cache-size}.
2779 There are message prefetching mechanism in the Wanderlust that
2780 prefetches next message while you are reading.
2782 You can control the message prefetching mechanism by these two
2786 @item wl-message-buffer-prefetch-folder-type-list
2787 @vindex wl-message-buffer-prefetch-folder-type-list
2788 The initial setting is @code{t}. In this case, prefetch messages in all
2790 If it is a list of folder types, it specifies the folder types in which
2791 message prefetching is enabled.
2792 Following is an example (prefetch messages in nntp and imap4 folders)
2796 (setq wl-message-buffer-prefetch-folder-type-list
2801 In this case, multi folder that contains localdir and imap4 prefetches
2802 only imap4 messages. This variable precedes the value of
2803 @code{wl-message-buffer-prefetch-folder-list}.
2805 @item wl-message-buffer-prefetch-folder-list
2806 @vindex wl-message-buffer-prefetch-folder-list
2807 The initial setting is @code{nil}.
2808 A list of regexp of folders to enable message prefetching.
2810 @item wl-message-buffer-prefetch-depth
2811 @vindex wl-message-buffer-prefetch-depth
2812 The initial setting is 3. The number of messages for automatical prefetch.
2814 @item wl-message-buffer-prefetch-idle-time
2815 @vindex wl-message-buffer-prefetch-idle-time
2816 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2818 @item wl-message-buffer-prefetch-threshold
2819 @vindex wl-message-buffer-prefetch-threshold
2820 The initial setting is 30000 (bytes). If prefetching message has larger
2821 size than this value, Wanderlust does not prefetch automatically.
2822 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2823 the message is not checked for the size.
2825 @item wl-auto-prefetch-first
2826 @vindex wl-auto-prefetch-first
2827 The initial setting is @code{nil}.
2828 If non-nil, first message is automatically prefetched to the buffer
2829 when you enter the folder.
2833 @node Auto Refile, Sticky Summary, Cache, Summary
2834 @section Auto Refile
2835 @vindex elmo-msgdb-extra-fields
2836 @vindex wl-refile-rule-alist
2837 @findex wl-summary-auto-refile
2839 You can refile messages automatically, by typing @kbd{C-o}
2840 (@code{wl-summary-auto-refile}). It decides destination of refile by
2841 the content of the message header information (information in the msgdb).
2843 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2844 available. If you want to decide destination by other header fields,
2845 set the variable @code{elmo-msgdb-extra-fields} like following.
2849 (setq elmo-msgdb-extra-fields
2859 By this setting, Wanderlust saves extra fields in the msgdb. You have
2860 to type @kbd{s all} to get extra fields for the messages that are
2861 already exists in the summary.
2863 Then, specify the refile rule. The refile target folder of auto
2864 refiling is decided by the value of @code{wl-refile-rule-alist}.
2865 @code{wl-refile-rule-alist} is a list of a rule:
2869 (@var{field} (@var{regexp} . @var{target})
2870 (@var{regexp} . @var{target})
2875 Each rule means `if @var{field} value matches @var{regexp},
2876 then refile to @var{target} folder'.
2877 The rule matched first is applied.
2879 @var{field} is a string of field name. You can specify a list of field name
2880 string, too. In this case, if one of these fields is matched, then the
2881 rule is fired (i.e. OR condition).
2883 @var{regexp} is a regular expression for field value. @var{target} is a target
2884 folder string. You can specify a rule at @var{target} part, too. In this
2885 case, If the field value of the rule and the current rule is matched,
2886 then the current rule is fired (i.e. AND condition).
2888 You can refer matched substring of @var{regexp} to specify @var{target} part.
2889 To refer substring, use following keys:
2893 means substitute original matched text.
2896 means substitute what matched the @var{N}th `\(@dots{}\)'.
2897 (@var{N} is a number.)
2900 Following is an example of @code{wl-refile-rule-alist}.
2904 (setq wl-refile-rule-alist
2906 ("^Wanderlust" . "+wl")
2907 ("^Elisp" . "+elisp"))
2909 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2911 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2912 "+from-me-to-you"))))))
2916 After these settings, refile marks are automatically put on the condition
2917 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2919 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2921 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2922 with these persistent marks are not automatically refiled.
2923 It means Wanderlust does not execute auto refile on unread messages by
2924 the default setting.
2925 To execute auto refile on all messages, set following.
2928 (setq wl-summary-auto-refile-skip-marks nil)
2932 @node Sticky Summary, Summary View, Auto Refile, Summary
2933 @section Sticky Summary
2934 @cindex Summary, Sticky
2935 @cindex Sticky Summary
2937 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2939 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2940 @kbd{G} in some suummary sticky summary buffer is created.
2941 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2942 makes current one sticky.
2944 The buffer name of the sticky summary becomes like
2945 @samp{Summary:@var{folder-name}}.
2946 You can visit the sticky summary at any time by @kbd{C-x b}
2947 (@code{switch-to-buffer}), or you can go round summary buffers by
2948 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2949 (@code{wl-summary-next-buffer}) in summary mode.
2951 In sticky summary, the summary buffer is preserved after @kbd{g} or
2952 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2953 another summary by @kbd{C-u g}. Other operations in the sticky summary
2954 are same as normal summary.
2956 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2957 are automatically stuck.
2960 @node Summary View, Mark and Action, Sticky Summary, Summary
2961 @section Format of summary lines
2962 @cindex Format of summary lines
2963 You can alter the format of lines in Summary mode.
2965 Summary line format is specified by @code{wl-summary-line-format}.
2966 You can use control strings defined by
2967 @code{wl-summary-line-format-spec-alist}.
2973 ;; @r{number temporary-mark persistent-mark date branch}
2974 ;; @r{[ (number-of-children) sender ] subject}
2975 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
2979 Where the number set the column number of the field (for negative value,
2982 Major control strings defined by @code{wl-summary-line-format-spec-alist}
2983 are displayed in the following list.
2994 %t branch of the thread
2995 %[ [ (< for re-connected child)
2996 %] ] (> for re-connected child)
3000 %c +number-of-children: (display only for opened thread)
3001 %C [+number-of-children] (display only for opened thread)
3002 %T temporary mark (mandatory)
3003 %P persistent mark (mandatory)
3007 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
3008 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
3009 the constant column. For example, if you specify @samp{%T} or
3010 @samp{%P} after the @samp{%t}, which changes its length by thread
3011 position, marks are not treated correctly.
3013 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
3014 column of the enclosed region is justified to the `number'. Multiple
3015 level @samp{%number(} parenthesis can be defined. It is useful to
3016 justify the column of the multiple control strings. For example, in the
3017 above @code{wl-summary-line-format},
3023 means ``Adjust number-of-children and sender string to the 17 column''.
3025 You can specify the format by each folders with
3026 @code{wl-folder-summary-line-format-alist}. Please set regular
3027 expression for folder names and summary line format as the following
3032 (setq wl-folder-summary-line-format-alist
3033 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
3034 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
3038 @subsection on the format for sender name
3040 The format string @samp{%f} displays the return value of the function specified
3041 by @code{wl-summary-from-function}. If you use the function
3042 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
3043 while displays the recipient names if the folder name matches with
3044 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
3045 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
3047 For example, to display recipient names for the message in @samp{+backup} if
3048 its sender is yourself, set up as follows.
3051 (setq wl-summary-showto-folder-regexp "^\\+backup$")
3055 @node Mark and Action, Key Bindings of Summary, Summary View, Summary
3056 @section Temporary marks and their effect
3057 @cindex Mark and Action
3059 You can define temporary marks and corresponding procedure by
3060 @code{wl-summary-mark-action-list}. Initially, refile (@samp{o}), copy
3061 (@samp{O}), dispose (@samp{d}), delete (@samp{D}), prefetch (@samp{i})
3062 and resend (@samp{~}) are defined.
3064 Each element of @code{wl-summary-mark-action-list} consists of
3067 (@samp{MARK} @samp{SYMBOL}
3068 @samp{ARGUMENT-FUNCTION} @samp{SET-MARK-FUNCTION} @samp{EXEC-FUNCTION}
3069 @samp{FACE} @samp{DOC-STRING})
3072 @samp{MARK} is a temporary mark string, and @samp{SYMBOL} is the name of
3073 the action to be defined. @samp{ARGUMENT-FUNCTION} is a function to
3074 generate argument to be given to @samp{SET-MARK-FUNCTION}, which will be
3075 described next, and it takes arguments:
3078 (@samp{ACTION} @samp{NUMBER})
3081 Where @samp{ACTION} equals to @samp{SYMBOL}, and @samp{NUMBER} is message
3082 number. @samp{SET-MARK-FUNCTION} is a function to be called when the mark
3083 is put. It takes arguments:
3086 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3089 Where @samp{NUMBER} is target message number, @samp{MARK} is a temporary
3090 mark string, and @samp{DATA} is given by @samp{ARGUMENT-FUNCTION}.
3092 @samp{EXEC-FUNCTION} is a function to be called when the action is
3093 executed. Its argument is a list of @samp{MARK-INFO}. Here @samp{MARK-INFO}
3094 means a list consists of
3097 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3100 @samp{FACE} is a face to be used for highlighting.
3103 @node Key Bindings of Summary, Variables of Summary, Mark and Action, Summary
3104 @section Key bindings
3105 @cindex Keybind, Summary Mode
3106 @cindex Keybind, Summary Buffer
3108 Key bindings of the summary mode are shown below.
3112 @kindex @key{SPC} (Summary)
3113 @findex wl-summary-read
3114 Proceed reading a message at the current cursor point.
3115 (@code{wl-summary-read})
3119 @findex wl-summary-redisplay
3120 Redisplay a message at the current cursor point.
3121 If this command is called with prefix argument,
3122 Redisplay message regardless of the message cache (message is re-loaded
3124 (@code{wl-summary-redisplay})
3128 @findex wl-summary-display-top
3129 Display the top message in the folder.
3130 (@code{wl-summary-display-top})
3134 @findex wl-summary-display-bottom
3135 Display the bottom message in the folder.
3136 (@code{wl-summary-display-bottom})
3140 @kindex @key{BS} (Summary)
3141 @kindex @key{DEL} (Summary)
3142 Display the previous page of the message at the current cursor point.
3143 @findex wl-summary-prev-page
3144 (@code{wl-summary-prev-page})
3147 @kindex @key{RET} (Summary)
3148 @findex wl-summary-next-line-content
3149 Display the next line of the message at the current cursor point.
3150 Display the message at the current cursor point if it is not displayed yet.
3151 (@code{wl-summary-next-line-content})
3156 @kindex M-@key{RET} (Summary)
3157 @findex wl-summary-prev-line-content
3158 Display the previous line of the message at the current cursor point.
3159 Display the message at the current cursor point if it is not displayed yet.
3160 (@code{wl-summary-prev-line-content})
3164 @findex wl-thread-open-close
3165 Toggle open or close the thread at the current cursor point.
3166 (@code{wl-thread-open-close})
3171 @findex wl-thread-open-all
3172 (@code{wl-thread-open-all})
3177 @findex wl-thread-close-all
3178 (@code{wl-thread-close-all})
3182 @findex wl-summary-goto-folder
3184 (@code{wl-summary-goto-folder})
3188 Mark all messages in the folder as read.
3189 @findex wl-summary-mark-as-read-all
3190 (@code{wl-summary-mark-as-read-all})
3194 @findex wl-summary-reply
3195 Prepare a draft for reply the message at the current cursor point.
3196 (@code{wl-summary-reply})
3200 @findex wl-summary-reply-with-citation
3201 Prepare a draft for reply the message at the current cursor point.
3202 (@code{wl-summary-reply-with-citation})
3206 @findex wl-summary-cancel-message
3207 If the message at current cursor point is your own netnews article,
3209 (@code{wl-summary-cancel-message})
3213 @findex wl-summary-reedit
3214 Prepare a draft for re-editing the message at current cursor point.
3215 If the message at current cursor point is your own netnews article,
3216 a draft for `supersedes message' for the message is prepared.
3217 (@code{wl-summary-reedit})
3220 @kindex M-E (Summary)
3221 @findex wl-summary-resend-bounced-mail
3222 If the message at current cursor point is a bounced message,
3223 a draft for re-sending original message is prepared.
3224 (@code{wl-summary-resend-bounced-mail})
3228 @findex wl-summary-forward
3229 A draft for forwarding the message at current cursor point is prepared.
3230 (@code{wl-summary-forward})
3234 @findex wl-summary-mark-as-important
3235 Put @samp{important} flag on the message at current cursor point.
3236 If already flagged as @samp{important}, remove the flag. If it is
3237 called with prefix argument, ask global flag to put similarly to @kbd{F}.
3238 (@code{wl-summary-mark-as-important})
3242 @findex wl-summary-set-flags
3243 Put arbitrary global flag entered in the minibuffer. If you use Emacs
3244 21 or later, you can specify multiple flags separated by @samp{,}
3245 simultaneously. If it is called with prefix argument, remove existent
3247 (@code{wl-summary-set-flags})
3253 Save the message at current cursor point.
3254 @findex wl-summary-save
3255 (@code{wl-summary-save})
3259 @findex wl-summary-next
3260 Move cursor to the next message.
3261 If message is marked with a temporal mark in
3262 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3263 In the offline mode, cursor is not moved to the messages which are not cached
3265 (@code{wl-summary-next})
3269 @findex wl-summary-prev
3270 Move cursor to the previous message.
3271 If message is marked with a temporal mark in
3272 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3273 In the offline mode, cursor is not moved to the messages which are not cached
3275 (@code{wl-summary-prev})
3279 @findex wl-summary-down
3280 Move cursor to the downward message which is unread or marked
3282 In the offline mode, cursor is not moved to the messages which are not cached
3284 If there are messages which have target mark @samp{*} in the summary,
3285 cursor is moved to the downward message which have a target mark.
3286 This behavior is changed according to the value of @code{wl-summary-move-order}.
3287 (@code{wl-summary-down})
3291 @findex wl-summary-up
3292 Move cursor to the upward message which is unread or marked
3294 In the offline mode, cursor is not moved to the messages which are not cached
3296 If there are messages which have target mark @samp{*} in the summary,
3297 cursor is moved to the downward message which have a target mark.
3298 This behavior is changed according to the value of @code{wl-summary-move-order}.
3299 (@code{wl-summary-up})
3303 @findex wl-summary-write
3304 Prepare a new draft.
3305 (@code{wl-summary-write})
3309 @findex wl-summary-write-current-folder
3310 Prepare a new draft. If the current folder is NNTP folder,
3311 @samp{Newsgroups:} field is completed. If the current folder is mailing
3312 list folder (refile destination), guess @samp{To:} field and completed
3313 (If @code{wl-subscribed-mailing-list} is valid list)
3314 (@code{wl-summary-write-current-folder})
3318 @findex wl-summary-redisplay-all-header
3319 Redisplay the message at current cursor point with all header fields.
3320 (@code{wl-summary-redisplay-all-header})
3324 @findex wl-summary-redisplay-no-mime
3325 Redisplay the message at current cursor point without MIME analysis.
3326 (@code{wl-summary-redisplay-no-mime})
3330 @findex wl-summary-burst
3331 If the message at current cursor point has
3332 encapsulates multiple messages using MIME,
3333 de-capsulate and extract them on the current folder.
3334 If it is invoked in non-writable folder or it is called with prefix
3335 argument, it asks the destination folder.
3336 (@code{wl-summary-burst})
3339 @kindex @@ (Summary)
3340 @findex wl-summary-edit-addresses
3341 Append/change/delete the message's sender information to the address
3342 book @file{~/.addresses} interactively. If this command is called with
3343 prefix argument, arbitrary address can be edited.
3344 (@code{wl-summary-edit-petname})
3348 @findex wl-status-update
3349 Sync up address book status with @file{~/.addresses}'s content.
3350 (@code{wl-status-update})
3354 @findex wl-summary-pipe-message
3355 Pipe current message's content to the external process.
3356 (@code{wl-summary-pipe-message})
3360 @findex wl-summary-print-message
3361 Print out current message's content.
3362 It uses @code{ps-print} module in Emacs 20.x.
3363 If you don't use color printer, you might want to set
3364 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3367 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3370 (@code{wl-summary-print-message})
3374 @findex wl-summary-exit
3375 Exit current folder.
3376 (@code{wl-summary-exit})
3380 @findex wl-summary-jump-to-current-message
3381 Jump cursor to the currently displayed message's window.
3382 (@code{wl-summary-jump-to-current-message})
3386 Jump cursor to the other message.
3387 @findex wl-summary-jump-to-msg
3388 (@code{wl-summary-jump-to-msg})
3392 Update summary status and
3393 prefetch all messages which have marks included in the
3394 @code{wl-summary-incorporate-marks}.
3395 @findex wl-summary-incorporate
3396 (@code{wl-summary-incorporate})
3399 @kindex M-j (Summary)
3400 @findex wl-summary-jump-to-msg-by-message-id
3401 Jump cursor to the message which have specified @samp{Message-Id:}. If
3402 @code{elmo-use-database} is non-nil, other folder is also searched.
3403 (@code{wl-summary-jump-to-msg-by-message-id})
3407 Jump to parent message.
3408 @findex wl-summary-jump-to-parent-message
3409 (@code{wl-summary-jump-to-parent-message})
3413 @findex wl-summary-mark-as-unread
3414 Mark as unread the message at current cursor point.
3415 (@code{wl-summary-mark-as-unread})
3419 @findex wl-summary-sync
3420 Synchronize summary view after prompting the update range.
3421 You can specify one of the follows.
3425 all Discard present msgdb and retrieve all informations.
3426 Do not retrieve killed messages.
3427 all-entirely Discard present msgdb and retrieve all informations.
3428 Retrieve killed messages, too.
3429 update Update the difference between informations in present
3430 msgdb and in current folder instance.
3431 Do not retrieve killed messages.
3432 update-entirely Update the difference between informations in present
3433 msgdb and in current folder instance.
3434 Retrieve killed messages, too.
3435 rescan Redisplay summary by rescanning present msgdb.
3436 rescan-noscore Redisplay summary by rescanning present msgdb.
3437 Display messages killed by score, too.
3438 cache-status Sync the all marks with the real status of cache.
3441 first:NUM Move to the filter folder(partial filter).
3442 last:NUM Move to the filter folder(partial filter).
3447 (@code{wl-summary-sync})
3451 @findex wl-summary-sort
3453 You can sort by @samp{date}, @samp{from}, @samp{number}, @samp{subject},
3454 @samp{size} and @samp{list-info}.
3455 (@code{wl-summary-sort})
3459 @findex wl-summary-toggle-thread
3460 Toggle the threading. The state will be preserved after exiting
3461 Wanderlust. You can alter default state for newly created summary
3462 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3463 Threading status is displayed on the modeline.
3464 @samp{@{S@}} means threading is off (Sequence) and
3465 @samp{@{T@}} means threading is on (Thread).
3466 (@code{wl-summary-toggle-thread})
3470 @findex wl-summary-toggle-disp-folder
3471 Toggle displaying of folder window.
3472 (@code{wl-summary-toggle-disp-folder})
3476 Toggle displaying of message window.
3477 @findex wl-summary-toggle-disp-msg
3478 (@code{wl-summary-toggle-disp-msg})
3482 Move to the virtual folder (filter folder) with the condition specified.
3483 If called with prefix argument and current folder is virtual, exit it.
3484 @findex wl-summary-virtual
3485 (@code{wl-summary-virtual})
3488 @kindex @key{TAB} (Summary)
3489 @findex wl-summary-goto-last-displayed-msg
3490 Jump to the message which is displayed last.
3491 (@code{wl-summary-goto-last-displayed-msg})
3495 Put @samp{*} mark on the messages that satisfies the specified condition.
3496 @findex wl-summary-pick
3497 (@code{wl-summary-pick})
3501 @findex wl-summary-mark-as-read
3502 Mark as read the message at the current cursor point.
3503 (@code{wl-summary-mark-as-read})
3507 Execute action for all temporary marks in the summary buffer.
3508 @findex wl-summary-exec
3509 (@code{wl-summary-exec})
3513 @findex wl-summary-target-mark-line
3514 Put target mark on the message at the current cursor point.
3515 (@code{wl-summary-target-mark-line}) @xref{Mark and Action}.
3519 Put refile mark on the message at the current cursor point.
3520 @findex wl-summary-refile
3521 (@code{wl-summary-refile}) @xref{Mark and Action}.
3524 @kindex C-o (Summary)
3525 Execute auto refile.
3526 @findex wl-summary-auto-refile
3527 (@code{wl-summary-auto-refile})
3531 Put copy mark on the message at the current cursor point.
3532 @findex wl-summary-copy
3533 (@code{wl-summary-copy}) @xref{Mark and Action}.
3536 @kindex M-o (Summary)
3537 Put refile mark on the message at the current cursor point with the destination
3538 previously specified.
3539 @findex wl-summary-refile-prev-destination
3540 (@code{wl-summary-refile-prev-destination})
3544 @findex wl-summary-dispose
3545 Put disposal mark on the message at the current cursor point.
3546 The result of disposal is controlled by @code{wl-dispose-folder-alist},
3547 refiled to @code{wl-trash-folder} by default.
3548 (@code{wl-summary-dispose}) @xref{Mark and Action}.
3552 @findex wl-summary-delete
3553 Put force deletion mark on the message at the current cursor point.
3554 (@code{wl-summary-delete}) @xref{Mark and Action}.
3558 Put prefetch reservation mark on the message at the current cursor point.
3559 @findex wl-summary-prefetch
3560 (@code{wl-summary-prefetch}) @xref{Mark and Action}.
3564 @findex wl-summary-resend
3565 Put resend reservation mark on the message at the current cursor point.
3566 (@code{wl-summary-resend}) @xref{Mark and Action}.
3570 @findex wl-summary-unmark
3571 Unmark the temporal mark on the message at the current cursor point.
3572 (@code{wl-summary-unmark})
3576 Unmark all the temporal marks.
3577 @findex wl-summary-unmark-all
3578 (@code{wl-summary-unmark-all})
3581 @kindex r R (Summary)
3582 @findex wl-summary-mark-as-read-region
3583 Mark as read messages in the specified region.
3584 (@code{wl-summary-mark-as-read-region})
3587 @kindex r $ (Summary)
3588 @findex wl-summary-mark-as-important-region
3589 Put @samp{important} flag on messages in the specified region.
3590 If already flagged as @samp{important}, remove the flag.
3591 (@code{wl-summary-mark-as-important-region})
3594 @kindex r F (Summary)
3595 @findex wl-summary-set-flags-region
3596 Put arbitrary global flag entered in the minibuffer on messages in
3598 (@code{wl-summary-set-flags-region})
3601 @kindex r ! (Summary)
3602 @findex wl-summary-mark-as-unread-region
3603 Mark as unread messages in the specified region.
3604 (@code{wl-summary-mark-as-unread-region})
3607 @kindex r x (Summary)
3608 @findex wl-summary-exec-region
3609 Execute action for each temporary marks on the messages in the
3611 (@code{wl-summary-exec-region})
3614 @kindex r * (Summary)
3615 @findex wl-summary-target-mark-region
3616 Put target mark on the messages in the specified region.
3617 (@code{wl-summary-target-mark-region}) @xref{Mark and Action}.
3620 @kindex r o (Summary)
3621 @findex wl-summary-refile-region
3622 Put refile mark on the messages in the specified region.
3623 (@code{wl-summary-refile-region}) @xref{Mark and Action}.
3626 @kindex r O (Summary)
3627 @findex wl-summary-copy-region
3628 Put copy mark on the messages in the specified region.
3629 (@code{wl-summary-copy-region}) @xref{Mark and Action}.
3632 @kindex r d (Summary)
3633 @findex wl-summary-dispose-region
3634 Put disposal mark on the messages in the specified region.
3635 (@code{wl-summary-dispose-region}) @xref{Mark and Action}.
3638 @kindex r D (Summary)
3639 @findex wl-summary-delete-region
3640 Put force deletion mark on the messages in the specified region.
3641 (@code{wl-summary-delete-region}) @xref{Mark and Action}.
3644 @kindex r i (Summary)
3645 @findex wl-summary-prefetch-region
3646 Put prefetch reservation mark on messages in the specified region.
3647 (@code{wl-summary-prefetch-region}) @xref{Mark and Action}.
3650 @kindex r u (Summary)
3651 @findex wl-summary-unmark-region
3652 Delete temporal mark on the messages in the specified region.
3653 (@code{wl-summary-unmark-region})
3656 @kindex r y (Summary)
3657 Save messages in the specified region.
3658 @findex wl-summary-save-region
3659 (@code{wl-summary-save-region})
3662 @kindex t R (Summary)
3663 @findex wl-thread-mark-as-read
3664 Mark as read messages which are the descendant of the current thread.
3665 With prefix argument, it affects on the all messages in the thread tree.
3666 (@code{wl-thread-mark-as-read})
3669 @kindex t $ (Summary)
3670 @findex wl-thread-mark-as-important
3671 Put @samp{important} flag on the messages which are the descendant of
3672 the current thread. If already flagged as @samp{important}, remove the
3673 flag. With prefix argument, it affects on the all messages in the
3675 (@code{wl-thread-mark-as-important})
3678 @kindex t F (Summary)
3679 @findex wl-thread-set-flags
3680 Put arbitrary global flag entered in the minibuffer on the messages
3681 which are the descendant of the current thread. With prefix argument,
3682 it affects on the all messages in the thread tree.
3683 (@code{wl-thread-set-flags})
3686 @kindex t ! (Summary)
3687 @findex wl-thread-mark-as-unread
3688 Mark as unread messages which are the descendant of the current thread.
3689 With prefix argument, it affects on the all messages in the thread tree.
3690 (@code{wl-thread-mark-as-unread})
3693 @kindex t x (Summary)
3694 @findex wl-thread-exec
3695 Execute action for temporary marks on the messages which are
3696 the descendant of the current thread. With prefix argument, it affects
3697 on the all messages in the thread tree.
3698 (@code{wl-thread-exec})
3701 @kindex t * (Summary)
3702 @findex wl-thread-target-mark
3703 Put target mark @samp{*} on the messages which are the descendant of the
3704 current thread. With prefix argument, it affects on the all messages in
3706 (@code{wl-thread-target-mark}) @xref{Mark and Action}.
3709 @kindex t o (Summary)
3710 @findex wl-thread-refile
3711 Put refile mark on the messages which are the descendant of the current thread.
3712 With prefix argument, it affects on the all messages in the thread tree.
3713 (@code{wl-thread-refile}) @xref{Mark and Action}.
3716 @kindex t O (Summary)
3717 @findex wl-thread-copy
3718 Put copy mark on the messages which are the descendant of the current thread.
3719 With prefix argument, it affects on the all messages in the thread tree.
3720 (@code{wl-thread-copy}) @xref{Mark and Action}.
3723 @kindex t d (Summary)
3724 @findex wl-thread-dispose
3725 Put disposal mark on the messages which are the descendant of the current thread.
3726 With prefix argument, it affects on the all messages in the thread tree.
3727 (@code{wl-thread-dispose}) @xref{Mark and Action}.
3730 @kindex t D (Summary)
3731 @findex wl-thread-delete
3732 Put force deletion mark on the messages which are the descendant of the
3734 (@code{wl-thread-delete}) @xref{Mark and Action}.
3737 @kindex t i (Summary)
3738 @findex wl-thread-prefetch
3739 Put prefetch reservation mark on messages which are the descendant of
3741 (@code{wl-thread-prefetch}) @xref{Mark and Action}.
3744 @kindex t u (Summary)
3745 @findex wl-thread-unmark
3746 Unmark temporal mark on the messages which are the descendant of the
3747 current thread. With prefix argument, it affects on the all messages in
3749 (@code{wl-thread-unmark})
3752 @kindex t y (Summary)
3753 @findex wl-thread-save
3754 Save messages which are the descendant of the current thread.
3755 With prefix argument, it affects on the all messages in the thread tree.
3756 (@code{wl-thread-save})
3759 @kindex m R (Summary)
3760 @findex wl-summary-target-mark-mark-as-read
3761 Mark as read all messages which have target mark @samp{*}.
3762 (@code{wl-summary-target-mark-mark-as-read})
3765 @kindex m $ (Summary)
3766 @findex wl-summary-target-mark-mark-as-important
3767 Put @samp{important} flag on all messages which have target mark @samp{*}.
3768 If already flagged as @samp{important}, remove the flag.
3769 (@code{wl-summary-target-mark-mark-as-important})
3772 @kindex m F (Summary)
3773 @findex wl-summary-target-mark-set-flags
3774 Put arbitrary global flag entered in the minibuffer on all messages
3775 which have target mark @samp{*}.
3776 (@code{wl-summary-target-mark-set-flags})
3779 @kindex m ! (Summary)
3780 @findex wl-summary-target-mark-mark-as-unread
3781 Mark as unread all messages which have target mark @samp{*}.
3782 (@code{wl-summary-target-mark-mark-as-unread})
3785 @kindex m o (Summary)
3786 @findex wl-summary-target-mark-refile
3787 Put refile mark on the messages which have target mark @samp{*}.
3788 (@code{wl-summary-target-mark-refile}) @xref{Mark and Action}.
3791 @kindex m O (Summary)
3792 @findex wl-summary-target-mark-copy
3793 Put copy mark on the messages which have target mark @samp{*}.
3794 (@code{wl-summary-target-mark-copy}) @xref{Mark and Action}.
3797 @kindex m d (Summary)
3798 @findex wl-summary-target-mark-dispose
3799 Put disposal mark on the messages which have target mark @samp{*}.
3800 (@code{wl-summary-target-mark-dispose}) @xref{Mark and Action}.
3803 @kindex m D (Summary)
3804 @findex wl-summary-target-mark-delete
3805 Put force deletion mark on the messages which have target mark @samp{*}.
3806 (@code{wl-summary-target-mark-delete}) @xref{Mark and Action}.
3809 @kindex m i (Summary)
3810 @findex wl-summary-target-mark-prefetch
3811 Put prefetch reservation mark on messages which have target mark @samp{*}.
3812 (@code{wl-summary-target-mark-prefetch}) @xref{Mark and Action}.
3815 @kindex m y (Summary)
3816 @findex wl-summary-target-mark-save
3817 Save messages which have target mark @samp{*}.
3818 (@code{wl-summary-target-mark-save})
3821 @kindex m u (Summary)
3822 Unmark all temporal marks.
3823 (@code{wl-summary-delete-all-temp-marks})
3824 @findex wl-summary-delete-all-temp-marks
3827 @kindex m a (Summary)
3828 Put target mark @samp{*} on the all messages.
3829 (@code{wl-summary-target-mark-all})
3830 @findex wl-summary-target-mark-all
3833 @kindex m t (Summary)
3834 Put target mark @samp{*} on the messages in the current thread.
3835 @findex wl-summary-target-mark-thread
3836 (@code{wl-summary-target-mark-thread})
3839 @kindex m r (Summary)
3840 @findex wl-summary-target-mark-region
3841 Put target mark @samp{*} on the messages in the specified region.
3842 (@code{wl-summary-target-mark-region})
3845 @kindex m A (Summary)
3846 @findex wl-summary-target-mark-reply-with-citation
3847 Prepare a draft which cites all messages which have target mark @samp{*}.
3848 (@code{wl-summary-target-mark-reply-with-citation})
3851 @kindex m f (Summary)
3852 @findex wl-summary-target-mark-forward
3853 Prepare a draft which forwards all messages which have target mark @samp{*}.
3854 (@code{wl-summary-target-mark-forward})
3857 @kindex m U (Summary)
3858 @findex wl-summary-target-mark-uudecode
3859 Uudecode the messages which have target mark @samp{*}.
3860 (@code{wl-summary-target-mark-uudecode})
3863 @kindex m ? (Summary)
3864 @findex wl-summary-target-mark-pick
3865 Pick messages from the @samp{*} marked messages.
3866 That is, @samp{*} marks on the messages are remained
3867 if the specified condition is satisfied.
3868 (@code{wl-summary-target-mark-pick})
3871 @kindex m # (Summary)
3872 @findex wl-summary-target-mark-print
3873 Print out all messages which have target mark @samp{*}.
3874 (@code{wl-summary-target-mark-print})
3877 @kindex m | (Summary)
3878 @findex wl-summary-target-mark-pipe
3879 Pipe content of each message with target mark @samp{*} to some specified
3881 (@code{wl-summary-target-mark-pipe})
3884 @kindex M-t (Summary)
3885 @findex wl-toggle-plugged
3886 Toggle offline/online status of Wanderlust.
3887 (@code{wl-toggle-plugged})
3890 @kindex C-t (Summary)
3891 Start Wanderlust's plug-status manager.
3892 (@code{wl-plugged-change})
3895 @kindex C-c C-o (Summary)
3896 @findex wl-jump-to-draft-buffer
3897 Move to the draft buffer if available. If multiple draft buffer exists,
3898 moved to one after another. If prefix argument is specified, load draft
3899 folder's message to the draft buffer and jump to it.
3900 (@code{wl-jump-to-draft-buffer})
3903 @kindex M-w (Summary)
3904 @findex wl-summary-save-current-message
3905 Save the message at the current cursor point.
3906 (@code{wl-summary-save-current-message})
3909 @kindex C-y (Summary)
3910 @findex wl-summary-yank-saved-message
3911 Regard the message at the current cursor point as
3912 parent, connect the message saved by
3913 @code{wl-summary-save-current-message}
3915 (@code{wl-summary-yank-saved-message})
3918 @kindex C-x C-s (Summary)
3919 @findex wl-summary-save-status
3920 Save the current summary.
3921 (@code{wl-summary-save-status})
3925 @node Variables of Summary, , Key Bindings of Summary, Summary
3926 @section Customiziable variables
3929 @item wl-summary-move-order
3930 @vindex wl-summary-move-order
3931 The initial setting is @code{unread}. Specify cursor moving policy. If
3932 you want to precede new messages, set @code{new}. If you want to
3933 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3936 @item wl-auto-select-first
3937 @vindex wl-auto-select-first
3938 The initial setting is @code{nil}.
3939 If non-nil, first message is automatically displayed when you enter
3942 @item wl-auto-select-next
3943 @vindex wl-auto-select-next
3944 The initial setting is @code{nil}. This controls behavior when there is
3945 no unread message in current summary.
3948 nil: asks whether you want to go back to folder mode
3949 'unread: asks whether you want to go to next unread folder
3950 If the next one comes to be possessing no unread message
3951 by treatment of cross-posted messages or Scoring, then
3952 asks whether you want to go to next to next folder.
3953 'skip-no-unread: similar as unread
3954 But does not ask before going to next to next folder.
3955 otherwise: asks whether you want to go to next unread folder
3958 It might be useful to set @code{'skip-no-unread} for people who
3959 want to continue reading by just pressing and pressing space key.
3961 @item wl-thread-insert-opened
3962 @vindex wl-thread-insert-opened
3963 The initial setting is @code{nil}.
3964 If non-nil, thread is inserted as opened.
3966 @item wl-thread-open-reading-thread
3967 @vindex wl-thread-open-reading-thread
3968 The initial setting is @code{t}. If non-nil, reading thread is
3969 automatically opened though it is closed thread.
3971 @item wl-summary-exit-next-move
3972 @vindex wl-summary-exit-next-move
3973 The initial setting is @code{t}. If non-nil, move to next folder at
3976 @item wl-folder-move-cur-folder
3977 @vindex wl-folder-move-cur-folder
3978 The initial setting is @code{nil}. If non-nil, cursor position on the
3981 @item wl-summary-weekday-name-lang
3982 @vindex wl-summary-weekday-name-lang
3983 Specify language of the weekday.
3984 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3985 displays Deutsch. You should rescan summary view after changing this value.
3987 @item wl-summary-fix-timezone
3988 @vindex wl-summary-fix-timezone
3989 The initial setting is @code{nil}.
3990 Time zone of the date string in summary mode is adjusted using this value.
3991 If @code{nil}, it is adjust to the default time zone information
3992 (system's default time zone or environment variable @samp{TZ}).
3994 @item wl-use-petname
3995 @vindex wl-use-petname
3996 The initial setting is @code{t}.
3997 If non-nil, sender part displays nickname.
3999 @item wl-break-pages
4000 @vindex wl-break-pages
4001 The initial setting is @code{t}.
4002 If non-nil, message is split as pages by @samp{^L}.
4004 @item wl-message-window-size
4005 @vindex wl-message-window-size
4006 The initial setting is '(1 . 4).
4007 A cons cell to specify the rate of summary and message window.
4008 car:cdr corresponds summary:message.
4010 @item wl-summary-from-function
4011 @vindex wl-summary-from-function
4012 Format function to display sender in summary.
4013 The initial setting is @code{wl-summary-default-from}.
4015 @item wl-summary-no-from-message
4016 @vindex wl-summary-no-from-message
4017 The initial setting is @samp{nobody@@nowhere?}. A string which is
4018 displayed when there's no @samp{From:} field in the message.
4020 @item wl-summary-subject-function
4021 @vindex wl-summary-subject-function
4022 Format function to display subject in summary.
4023 The initial setting is @code{wl-summary-default-subject} and
4024 it will cut the list name part etc. on the top of the subject.
4025 To display subject as it is, set as follows.
4028 (setq wl-summary-subject-function 'identity)
4031 @item wl-summary-no-subject-message
4032 @vindex wl-summary-no-subject-message
4033 The initial setting is @samp{(WL:No Subject in original.)}. A string
4034 which is displayed when there's no @samp{Subject:} field in the message.
4036 @item wl-summary-default-view
4037 @vindex wl-summary-default-view
4038 The initial setting is @code{'thread}.
4039 The default state for newly created summary. You can set either
4040 @code{'thread} for thread view or @code{'sequence} for sequential view.
4042 @item wl-summary-use-frame
4043 @vindex wl-summary-use-frame
4044 The initial setting is @code{nil}.
4045 If non-nil, use new frame for the summary.
4047 @item wl-use-folder-petname
4048 @vindex wl-use-folder-petname
4049 The initial setting is the list shown below:
4058 A list of display policy (symbol) of folder nickname. Available symbols
4063 Display folder petname on modeline.
4065 Destination folder is notified as nickname if
4066 @code{wl-auto-select-next} is non-nil.
4068 You can input folder name by nickname in the function
4069 @code{wl-summary-read-folder}.
4072 @item wl-summary-move-direction-toggle
4073 @vindex wl-summary-move-direction-toggle
4074 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
4075 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
4076 want to aware of reading direction, set this to @code{t}.
4078 @item wl-summary-width
4079 @vindex wl-summary-width
4080 The initial setting is 80.
4081 Width of summary line. If @code{nil}, summary line's width is as is.
4083 @item wl-summary-print-argument-within-window
4084 @vindex wl-summary-print-argument-within-window
4085 The initial setting is @code{nil}.
4086 If non-nil, the action argument is always printed on right side of
4089 @item wl-summary-indent-length-limit
4090 @vindex wl-summary-indent-length-limit
4091 The initial setting is 46.
4092 Specify the limit of thread indent level. @code{nil} means unlimited
4094 If you set this to @code{nil} you should set @code{wl-summary-width}
4097 @item wl-summary-max-thread-depth
4098 @vindex wl-summary-max-thread-depth
4099 The initial setting is 15.
4100 If thread depth of the message is larger than this value,
4101 the thread is divided.
4103 @item wl-summary-recenter
4104 @vindex wl-summary-recenter
4105 The initial setting is t.
4106 If non-nil, cursor point is moved to the center of the summary window.
4108 @item wl-summary-divide-thread-when-subject-changed
4109 @vindex wl-summary-divide-thread-when-subject-changed
4110 The initial setting is @code{nil}. If non-nil, thread is split if
4111 the subject is changed.
4113 @item wl-summary-search-via-nntp
4114 @vindex wl-summary-search-via-nntp
4115 The initial setting is @code{confirm}.
4117 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
4118 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
4119 from the NNTP server @code{elmo-nntp-default-server}. The value of
4120 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
4121 @code{elmo-nntp-default-stream-type} are used.
4123 If @code{confirm}, server name can be specified. You can specify NNTP
4124 folder format like @samp{-:username@@servername:119!}.
4126 @item wl-summary-keep-cursor-command
4127 @vindex wl-summary-keep-cursor-command
4128 The initial setting is the list shown below:
4132 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
4137 When you entered to summary by these commands and the target summary
4138 buffer already exists, summary status is not automatically updated and
4139 cursor position is saved.
4141 @item elmo-folder-update-threshold
4142 @vindex elmo-folder-update-threshold
4143 The initial setting is 500. If updated message number is larger than
4144 this value, confirm whether drop them or not (in the case where the value
4145 of @code{elmo-folder-update-confirm} is non-nil).
4147 @item elmo-folder-update-confirm
4148 @vindex elmo-folder-update-confirm
4149 The initial setting is @code{t}. If the value is non-nil, do check with
4150 @code{elmo-folder-update-threshold}.
4152 @item wl-summary-always-sticky-folder-list
4153 @vindex wl-summary-always-sticky-folder-list
4154 The initial setting is @code{nil}.
4155 @code{wl-summary-always-sticky-folder-list} specifies the folders that
4156 are automatically stuck. Each element is regexp of folder name.
4158 @item wl-summary-reserve-mark-list
4159 @vindex wl-summary-reserve-mark-list
4160 The initial setting is the list shown below:
4164 ("o" "O" "D" "d" "i")
4169 If a message is already marked as temporal marks in this list, the
4170 message is not marked by any mark command.
4172 @item wl-summary-skip-mark-list
4173 @vindex wl-summary-skip-mark-list
4174 The initial setting is the list shown below:
4183 If a message is already marked as temporal marks in this list, the
4184 message is skipped at cursor move.
4186 @item elmo-message-fetch-threshold
4187 @vindex elmo-message-fetch-threshold
4188 The initial setting is 30000 (bytes). If displaying message has larger
4189 size than this value, Wanderlust confirms whether fetch the message or
4190 not (in the case where the value of @code{elmo-message-fetch-confirm}
4193 @item elmo-message-fetch-confirm
4194 @vindex elmo-message-fetch-confirm
4195 The initial setting is @code{t}. If the value is non-nil, do check with
4196 @code{elmo-message-fetch-threshold}.
4198 @item wl-prefetch-threshold
4199 @vindex wl-prefetch-threshold
4200 The initial setting is 30000 (bytes). If prefetching message has larger
4201 size than this value and @code{wl-prefetch-confirm} is non-nil,
4202 Wanderlust confirms whether prefetch the message or not. If
4203 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
4204 without confirmation.
4206 @item wl-prefetch-confirm
4207 @vindex wl-prefetch-confirm
4208 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4209 prefetch the message or not if the message has larger size than
4210 @code{wl-prefetch-threshold}.
4212 @item elmo-imap4-use-cache
4213 @vindex elmo-imap4-use-cache
4214 The initial setting is @code{t}. If non-nil, messages read via IMAP4
4217 @item elmo-nntp-use-cache
4218 @vindex elmo-nntp-use-cache
4219 The initial setting is @code{t}. If non-nil, messages read via NNTP are
4222 @item elmo-pop3-use-cache
4223 @vindex elmo-pop3-use-cache
4224 The initial setting is @code{t}. If non-nil, messages read via POP3 are
4227 @item elmo-shimbun-use-cache
4228 @vindex elmo-shimbun-use-cache
4229 The initial setting is @code{t}. If non-nil, messages read in Shimbun
4232 @item wl-folder-process-duplicates-alist
4233 @vindex wl-folder-process-duplicates-alist
4234 The initial setting is @code{nil}.
4235 This list determines how to deal with duplicated messages in the same folder.
4236 Each item in the list is regexp of folder name and action; you can specify any
4237 one of the following in the place of action:
4240 @code{nil} : do nothing for duplicated messages.
4241 @code{hide} : hide duplicated messages from the summary.
4242 @code{read} : set duplicated messages as read.
4246 Following is an example (hide duplicated messages in multi folders)
4250 (setq wl-folder-process-duplicates-alist
4251 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4252 ("^\\*.*" . hide) (".*" . read)))
4256 @item wl-summary-flag-alist
4257 @vindex wl-summary-flag-alist
4258 The initial setting is as follows:
4262 ((important "orange"))
4266 Specify the color of message in summary buffer with flag. If multiple
4267 global flags are on one message, the former flag in this list is
4272 @node Message, Draft, Summary, Top
4273 @chapter Message Buffer
4275 Message Buffers utilize MIME-View mode of SEMI. For operational
4276 procedures and key bindings, refer to respective documents.
4277 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4278 You can also see help by @kbd{?} in message buffer.
4280 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4281 brings you back to Summary mode. @kbd{l} toggles display of Summary
4284 @section Key Bindings
4290 @findex wl-message-toggle-disp-summary
4291 Toggles display of Summary buffer.
4292 (@code{wl-message-toggle-disp-summary})
4295 @findex wl-message-refer-article-or-url
4296 @kindex Button-2 (Message)
4297 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4298 corresponding message if found.
4299 (@code{wl-message-refer-article-or-url})
4301 @item Button-4 (upward movement of a wheel)
4302 @kindex Button-4 (Message)
4303 @findex wl-message-wheel-down
4304 Scrolls the message backwards. When the top of the message is hit,
4305 moves to the previous message.
4306 (@code{wl-message-wheel-down})
4308 @item Button-5 (downward movement of a wheel)
4309 @kindex Button-5 (Message)
4310 @findex wl-message-wheel-up
4311 Scrolls the message forward. When the bottom of the message is hit,
4312 moves to the next message.
4313 (@code{wl-message-wheel-up})
4317 @findex wl-message-delete-current-part
4318 Delete the part under cursor. In fact it appends modified message to
4319 the current folder then moves old one to trash folder. Therefore the
4320 message number will be changed.
4321 (@code{wl-message-delete-current-part})
4324 @section Customizable Variables
4327 @item wl-message-window-size
4328 @vindex wl-message-window-size
4329 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4330 its car and cdr value corresponds to the ratio of Summary and Message
4333 @item wl-message-ignored-field-list
4334 @vindex wl-message-ignored-field-list
4335 Initial setting is @code{nil}.
4336 All fields that match this list will be hidden in message buffer.
4337 Each elements are regexp of field-name.
4338 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4340 @item wl-message-visible-field-list
4341 @vindex wl-message-visible-field-list
4342 Initial setting is @code{nil}.
4343 All fields that match this list will be display in message buffer.
4344 Each elements are regexp of field-name. This value precedes
4345 @code{wl-message-ignored-field-list}.
4346 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4348 @item wl-message-sort-field-list
4349 @vindex wl-message-sort-field-list
4351 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4352 Header fields in message buffer are ordered by this value.
4353 Each elements are regexp of field-name.
4355 @item wl-message-truncate-lines
4356 @vindex wl-message-truncate-lines
4357 The initial value is the value of @code{default-truncate-lines}.
4358 If it is non-nil, truncate long lines in message buffer.
4361 @node Draft, Disconnected Operations, Message, Top
4362 @chapter Draft Buffer
4364 At Summary mode, pressing @kbd{w} and the like creates a new draft
4365 buffer. You can edit and send mail and news articles in this buffer.
4367 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4368 with those if possible.
4371 * Usage of Draft Mode:: TIPS
4372 * Key Bindings of Draft:: Key bindings
4373 * Variables of Draft Mode:: Customize Draft Mode
4376 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4379 Basically it is Emacs-standard mail mode.
4383 * Editing Message Body::
4384 * Dynamical Message Re-arrangement::
4389 @node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
4390 @subsection Editing Message Header
4392 You can freely edit header region above @samp{--text follows this line--},
4393 until you invoke the sending operation.
4395 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4396 addresses. @kbd{@key{TAB}} completes them.
4398 You can use following headers to specify recipients. Add some of them
4399 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4402 @item @samp{Newsgroups:}
4403 Specify newsgroups to which you post the news article.
4406 Specify addresses to send a copy (Carbon Copy) of the message.
4409 Following ones are removed from the header contents before sending.
4413 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4416 Specify folders in which a copy of the message is saved.
4419 Specify recipients to send encapsulated copy of the message.
4422 You can add initial headers by following variables.
4428 The initial setting is @code{nil}.
4429 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4430 the draft when it is prepared. If function is specified, its return
4435 The initial setting is @code{nil}.
4436 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4437 the draft when it is prepared.
4440 @node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4441 @subsection Editing Messages
4443 As a matter of course, editing message body can be performed in the same
4444 way as usual writing. You may write message body under
4445 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4446 @samp{--text follows this line--} intact.)
4448 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4449 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4450 a MIME user interface for GNU Emacs}.
4451 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4453 If you save the draft buffer you are editing, it is appended to the
4454 folder specified by @code{wl-draft-folder}.
4456 @node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
4457 @subsection Dynamic Modification of Messages
4458 @vindex wl-draft-config-alist
4459 @c @cindex Change Message
4460 @c @cindex Message, Change Dynamic
4462 You can set @code{wl-draft-config-alist} so that header and body of the
4463 message will automatically modified depending on information of header
4466 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4468 In the example below, the header is modified when
4469 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4470 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4471 before sending the message.
4475 (setq wl-draft-config-alist
4476 '(((string-match "aaa\\.example\\.com$" (system-name))
4477 ;; @r{applied if the expression is non-nil}
4478 (wl-smtp-posting-server . "mailserver-B")
4479 (wl-nntp-posting-server . "newsserver-B")
4480 ;; @r{settings of temporary variables}
4482 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4483 ;; @r{applied if it matches the header of the draft buffer}
4484 ("Organization" . (format "Go %s" my-webpage)))
4485 ;; @r{you can write elisp expressions here (eval only)}
4486 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4487 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4492 The format of @code{wl-draft-config-alist} is:
4496 '(("@var{regexp of the header}" or @var{elisp expression}
4497 ("@var{Field}" . value(@var{elisp expression}))
4498 (@var{variable} . value(@var{elisp expression}))
4499 (@var{sub-function} . value(@var{elisp expression}))
4502 ("@var{regexp of the header}" or @var{elisp expression}
4503 ("@var{Field}" . value(@var{elisp expression}))
4508 Per default, there are 13 following sub-functions.
4511 'header: Inserts the specified string at the bottom of the header.
4512 'header-top: Inserts the specified string at the top of the header.
4513 'header-file: Inserts the specified file at the bottom of the header.
4514 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4515 'top: Inserts the specified string at the top of the body.
4516 'top-file: Inserts the specified file at the top of the body.
4517 'body: Replaces the body with the specified string.
4518 Specifying @code{nil} deletes the entire body string.
4519 'body-file: Replaces the body with the content of the specified file.
4520 'bottom: Inserts the specified string at the bottom of the body.
4521 'bottom-file: Inserts the specified file at the top of the body.
4522 'part-top: Inserts the specified string at the top of the current part.
4523 'part-bottom: Inserts the specified string at the bottom of the current part.
4524 'template: Applies the specified template.
4525 (refer to the next subsection)
4528 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4529 change them or add your own functions. If you read the code, you can
4530 easily find how to write the functions.
4532 At the first of each item, @var{a regular expression of the header} or
4533 an @var{elisp expression} should be specified. In the case of an elisp
4534 expression, the item is applied when the expression is evaluated
4537 Per default, when multiple items match or are evaluated non-nil, all
4538 such items are applied, but if you set a variable
4539 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4542 At the second of the item, a cons or a list of functions should be
4543 specified. The car part of the cons should be a header field, a
4544 variable, or a sub-function. When a header field is specified, the
4545 field will be modified. If a variable is specified, the value of the
4546 variable will be modified temporarily.
4548 In the cdr part of a cons, not only a variable but also an elisp
4549 expression can be specified as is. If the car part is a header field
4550 and the cdr part is @code{nil}, the field will be deleted.
4552 See the next example as well:
4556 (setq wl-draft-config-alist
4558 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4559 ;; @r{applied if it matches the header of the buffer being replied}
4560 (body . " Hello.\n")
4561 (template . "default")
4566 As in the (1) above, if a header regexp is prepended with @code{reply},
4567 it is applied when the draft is prepared by @code{wl-summary-reply} for
4568 example, and when it matches the header being replied. It is ignored
4569 when there is no buffer being replied, like after @code{wl-draft} was
4572 If you want to use name of parent folder, you can refer the buffer local
4573 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4574 changes From according to the folder name of the summary in which the draft
4579 (setq wl-draft-config-alist
4580 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4581 (\"From\" . \"user@@domain1\"))
4582 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4583 (\"From\" . \"user@@domain2\"))))
4588 Note that @code{wl-draft-config-alist} is applied only once when
4589 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4590 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4591 aborting transmission, execute @kbd{C-c C-e}
4592 (@code{wl-draft-config-exec}) explicitly.
4594 If you don't want to apply @code{wl-draft-config-alist} when
4595 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4599 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4602 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4603 prepared, do the following:
4606 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4609 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4610 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4614 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4617 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4618 @subsection Inserting Templates
4620 @cindex Apply Template
4622 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4623 @kbd{M-x wl-template-select} in the draft buffer.
4625 The format of @code{wl-template-alist} is almost the same as
4626 @code{wl-draft-config-alist}.
4627 @xref{Dynamical Message Re-arrangement}.
4631 (setq wl-template-alist
4634 ("Organization" . "Example Co.Ltd.")
4635 (body . "Hello.\n"))
4637 (template . "default") ;; @r{(a)}
4638 ("To" . "boss@@example.com")
4639 ("Subject" . "Report")
4640 (body-file . "~/work/report.txt")
4646 As you can see, the only difference is item (template) names such as
4647 @samp{default} and @samp{report}, instead of a regexp of header.
4648 Because definition of each item is the same as
4649 @code{wl-draft-config-alist}, you can call another template, like (a).
4651 Executing the command @code{wl-template-select} results in template
4652 selection, but the result differs depending on variable
4653 @code{wl-template-visible-select}.
4655 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4656 window is shown below the draft buffer. You can select a template by
4657 @kbd{n} and @kbd{p} seeing the buffer window.
4659 Press the @key{RET} key and the template is actually applied to the draft
4660 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4661 adjust the window size by @code{wl-template-buffer-lines}.
4663 If @code{wl-template-visible-select} is @code{nil}, you should type the
4664 name of the template in the mini buffer.
4666 As shown in the example in @code{wl-draft-config-alist}, you can select
4667 @samp{default} template by writing:
4670 (template . "default")
4673 @node POP-before-SMTP, , Template, Usage of Draft Mode
4674 @subsection Sending mail by POP-before-SMTP
4675 @cindex POP-before-SMTP
4677 You can send mail by POP-before-SMTP with this single line:
4680 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4684 Configure the following variables if you need.
4687 @item wl-pop-before-smtp-user
4688 The POP user name for POP-before-SMTP authentication.
4689 If unset, @code{elmo-pop3-default-user} is used.
4691 @item wl-pop-before-smtp-server
4692 The POP server name for POP-before-SMTP authentication.
4693 If unset, @code{elmo-pop3-default-server} is used.
4695 @item wl-pop-before-smtp-authenticate-type
4696 The POP authentication method for POP-before-SMTP authentication.
4697 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4699 @item wl-pop-before-smtp-port
4700 The POP port number for POP-before-SMTP authentication.
4701 If unset, @code{elmo-pop3-default-port} is used.
4703 @item wl-pop-before-smtp-stream-type
4704 If @code{ssl}, POP connection is established using SSL. If
4705 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4706 unset, @code{elmo-pop3-default-stream-type} is used.
4709 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4710 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4712 Therefore, if SMTP server and POP server are actually the same, and if
4713 POP folder per default (such as @samp{&}) is available, no settings are
4716 Refer to the following URL about POP-before-SMTP.
4720 http://spam.ayamura.org/tools/smPbS.html
4721 http://www.iecc.com/pop-before-smtp.html
4726 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4727 @section Key Bindings
4728 @cindex Keybind, Draft Mode
4729 @cindex Keybind, Draft Buffer
4734 @kindex C-c C-y (Draft)
4735 @findex wl-draft-yank-original
4736 Cites the content of the current message buffer (the part under cursor).
4737 If the region is active, cites the region (it affects only if
4738 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4739 (on XEmacs) is Non-nil).
4740 (@code{wl-draft-yank-original})
4743 @kindex C-c C-p (Draft)
4744 @findex wl-draft-preview-message
4745 Previews the content of the current draft.
4746 This is useful for previewing MIME multi-part messages.
4747 (@code{wl-draft-preview-message})
4750 @kindex C-c C-s (Draft)
4751 @findex wl-draft-send
4752 Sends the content of the current draft. Does not erase the draft buffer.
4753 This is useful for sending multiple messages, which are a little different
4755 (@code{wl-draft-send})
4758 @kindex C-c C-c (Draft)
4759 @findex wl-draft-send-and-exit
4760 Sends the content of the current draft and erases the draft buffer.
4761 (@code{wl-draft-send-and-exit})
4764 @kindex C-x C-s (Draft)
4765 @findex wl-draft-save
4766 Save the current draft.
4767 (@code{wl-draft-save})
4770 @kindex C-c C-k (Draft)
4771 @findex wl-draft-kill
4772 Kills the current draft.
4773 (@code{wl-draft-kill})
4776 @kindex C-x k (Draft)
4777 @findex wl-draft-mimic-kill-buffer
4778 Kills the current draft.
4779 (@code{wl-draft-mimic-kill-buffer})
4782 @kindex C-c C-z (Draft)
4783 @findex wl-draft-save-and-exit
4784 Saves the current draft, and erases the draft buffer.
4785 This is useful if you want to suspend editing of the draft.
4786 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4787 the @samp{+draft} folder.
4788 (@code{wl-draft-save-and-exit})
4791 @kindex C-c C-r (Draft)
4792 @findex wl-caesar-region
4793 Encodes or decodes the specified region in Caesar cipher.
4794 (@code{wl-caesar-region})
4798 @findex wl-draft-highlight-and-recenter
4799 Recenter and rehighlight current draft.
4800 (@code{wl-draft-highlight-and-recenter})
4804 @findex wl-toggle-plugged
4805 Toggles off-line/on-line states of Wanderlust.
4806 (@code{wl-toggle-plugged})
4809 @kindex C-c C-o (Draft)
4810 @findex wl-jump-to-draft-buffer
4811 Jumps to the other draft buffer, if exists.
4812 With prefix argument, reads a file (if any) from the draft folder when
4813 there is no such buffer.
4814 (@code{wl-jump-to-draft-buffer})
4817 @kindex C-c C-e (Draft)
4818 @findex wl-draft-config-exec
4819 Applies @code{wl-draft-config-alist}.
4820 (@code{wl-draft-config-exec})
4823 @kindex C-c C-j (Draft)
4824 @findex wl-template-select
4826 (@code{wl-template-select})
4829 @kindex C-c C-a (Draft)
4831 Enter Address Manager.
4832 @xref{Address Manager}.
4836 @kindex C-c C-d (Draft)
4837 @findex wl-draft-elide-region
4838 Elide the text between point and mark (@code{wl-draft-elide-region}).
4839 The text is killed and replaced with the contents of the variable
4840 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4844 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4845 @section Customizable Variables
4849 @item wl-subscribed-mailing-list
4850 @vindex wl-subscribed-mailing-list
4851 The initial setting is @code{nil}. Mailing lists to which you
4852 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4853 field of a reply draft, removes your own address from
4854 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4855 contained in @samp{To:} or @samp{Cc:} field of a message to be
4856 automatically re-filed, the destination folder will be leaned in
4857 connection with the address.
4863 (setq wl-subscribed-mailing-list
4864 '("wl@@lists.airs.net"
4866 "emacs-mime-ja@@m17n.org"))
4870 @item wl-insert-mail-followup-to
4871 @vindex wl-insert-mail-followup-to
4872 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4873 field is automatically inserted in the draft buffer.
4875 @item wl-insert-mail-reply-to
4876 @vindex wl-insert-mail-reply-to
4877 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4878 field is automatically inserted in the draft buffer.
4880 @item wl-auto-insert-x-face
4881 @vindex wl-auto-insert-x-face
4882 The initial setting is @code{t}. If non-nil and there is an encoded
4883 X-Face string in a file @file{~/.xface} (the value of the variable
4884 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4885 draft buffer. If @code{nil}, it is not automatically inserted.
4887 @item wl-insert-message-id
4888 @vindex wl-insert-message-id
4889 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4890 is automatically inserted on the transmission.
4892 @item wl-message-id-use-wl-from
4893 @vindex wl-message-id-use-wl-from
4894 The initial setting is @code{nil}. If non-nil, the value of
4895 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4897 @item wl-local-domain
4898 @vindex wl-local-domain
4899 The initial setting is @code{nil}. If @code{nil}, the return value of
4900 the function @code{system-name} will be used as the domain part of
4903 If @code{system-name} does not return FQDN (i.e. the full name of the
4904 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4905 to the string of the local domain name without hostname (like
4906 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4907 @samp{.} @code{wl-local-domain} is used as domain part of the
4910 If your terminal does not have global IP, set the value of
4911 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4912 you use invalid @samp{Message-ID:}.)
4914 Moreover, concatenation of @code{system-name} @samp{.}
4915 @code{wl-local-domain} will be used as an argument to the HELO command
4918 @item wl-message-id-domain
4919 @vindex wl-message-id-domain
4920 The initial setting is @code{nil}. If non-nil, this value is used as a
4921 domain part of the @samp{Message-ID:}. If your terminal does not have
4922 global IP address, set unique string to this value (e.x. your e-mail
4925 @item wl-unique-id-suffix
4926 @vindex wl-unique-id-suffix
4927 The initial setting is @samp{.wl}. You can specify the string in generated
4928 Message-ID which appear just before @samp{@@}.
4930 @item wl-draft-config-alist
4931 @vindex wl-draft-config-alist
4932 The initial setting is @code{nil}. Modifies the draft message just
4933 before the transmission. The content of @code{wl-draft-config-alist}
4934 will be automatically applied only once on the transmission. If you
4935 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4938 @item wl-template-alist
4939 @vindex wl-template-alist
4940 The initial setting is @code{nil}.
4941 This variable specifies the template to be applied in the draft buffer.
4943 @item wl-draft-config-matchone
4944 @vindex wl-draft-config-matchone
4945 The initial setting is @code{nil}. If non-nil, only the first matching
4946 item is used when @code{wl-draft-config-alist} is applied. If
4947 @code{nil}, all matching items are used.
4949 @item wl-template-visible-select
4950 @vindex wl-template-visible-select
4951 The initial setting is @code{t}.
4952 If non-nil, you can preview the result of the template selection in
4955 @item wl-template-confirm
4956 @vindex wl-template-confirm
4957 The initial setting is @code{nil}.
4958 If non-nil, asks for confirmation when you press the enter key to select
4959 template while previewing.
4961 @item wl-template-buffer-lines
4962 @vindex wl-template-buffer-lines
4963 The initial setting is 7.
4964 If @code{wl-template-visible-select} is non-nil, this variable specifies
4965 the size of the preview window.
4967 @item wl-draft-buffer-style
4968 @vindex wl-draft-buffer-style
4969 The initial setting is @code{full}.
4970 Style of draft buffer window (except for replying and forwarding).
4971 @code{keep} is to use current window,
4972 @code{full} is to use full frame window,
4973 @code{split} is to split current window and use it.
4974 If some function is specified, it is called with the draft buffer
4977 @item wl-draft-reply-buffer-style
4978 @vindex wl-draft-reply-buffer-style
4979 The initial setting is @code{split}.
4980 Style of draft buffer for replying and forwarding.
4981 @code{keep} is to use message buffer window,
4982 @code{full} is to use full frame window,
4983 @code{split} is to split message buffer window and use it.
4984 If some function is specified, it is called with the draft buffer
4987 @item wl-draft-use-frame
4988 @vindex wl-draft-use-frame
4989 The initial setting is @code{nil}.
4990 If non-nil, use new frame for the draft.
4992 @item wl-draft-truncate-lines
4993 @vindex wl-draft-truncate-lines
4994 The initial value is the value of @code{default-truncate-lines}.
4995 If it is non-nil, truncate long lines in draft buffer.
4999 The initial setting is the value of the variable
5000 @code{user-mail-address}. The value of this variable is inserted as a
5001 @samp{From:} field of the draft when it is prepared.
5003 @item wl-envelope-from
5004 @vindex wl-envelope-from
5005 The initial setting is @code{nil}.
5006 The value of this variable is used for envelope from (MAIL FROM).
5007 If @code{nil}, the address part of @code{wl-from} is used.
5009 @item wl-user-mail-address-list
5010 @vindex wl-user-mail-address-list
5011 The initial setting is @code{nil}.
5012 This is the User's address list. If you have multiple addresses,
5015 @item wl-reply-subject-prefix
5016 @vindex wl-reply-subject-prefix
5017 The initial setting is @samp{Re: }.
5018 In the @samp{Subject:} of the reply draft, this string is prepended to
5019 the @samp{Subject:} of being replied. You can specify a function to be
5020 message buffer of the reply target.
5022 @item wl-forward-subject-prefix
5023 @vindex wl-forward-subject-prefix
5024 The initial setting is @samp{Forward: }.
5025 In the @samp{Subject:} of the forwarding draft, this string is prepended
5026 to the @samp{Subject:} of being forwarded. You can specify a function
5027 to be message buffer of the forward target.
5029 @item wl-draft-reply-use-address-with-full-name
5030 @vindex wl-draft-reply-use-address-with-full-name
5031 The initial setting is @code{t}.
5032 If non-nil, insert her full name with address when prepare a draft for
5033 reply a message. If it is @code{nil}, insert her address only.
5035 @item wl-draft-enable-queuing
5036 @vindex wl-draft-enable-queuing
5037 The initial setting is @code{t}.
5038 This flag controls off-line transmission. If non-nil, the draft is
5041 @item wl-draft-use-cache
5042 @vindex wl-draft-use-cache
5043 The initial setting is @code{nil}. If the value is non-nil and
5044 @code{wl-insert-message-id} is nil, cache the message which is sent.
5046 @item wl-fcc-force-as-read
5047 @vindex wl-fcc-force-as-read
5048 The initial setting is @code{nil}. If the value is non-nil,
5049 Mark as read the message saved by @samp{Fcc:}.
5051 @item wl-auto-flush-queue
5052 @vindex wl-auto-flush-queue
5053 The initial setting is t.
5054 This flag controls automatic transmission of the queue when Wanderlust
5055 becomes on-line. If non-nil, the queue is automatically transmitted
5056 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5057 manually, press @kbd{F} in the folder mode.
5059 @item wl-ignored-forwarded-headers
5060 @vindex wl-ignored-forwarded-headers
5061 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
5062 All headers that match this regexp will be deleted when forwarding a message.
5064 @item wl-ignored-resent-headers
5065 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
5066 All headers that match this regexp will be deleted when resending a message.
5068 @item wl-draft-always-delete-myself
5069 @vindex wl-draft-always-delete-myself
5070 If non-nil, always removes your own address from @samp{To:} and
5071 @samp{Cc:} when you are replying to the mail addressed to you.
5073 @item wl-draft-delete-myself-from-bcc-fcc
5074 @vindex wl-draft-delete-myself-from-bcc-fcc
5075 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
5076 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
5078 @item wl-smtp-posting-server
5079 @vindex wl-smtp-posting-server
5080 The initial setting is @code{nil}.
5081 This is the SMTP server name for mail transmission.
5083 @item wl-smtp-posting-port
5084 @vindex wl-smtp-posting-port
5085 The initial setting is @code{nil}.
5086 This is the SMTP port number for mail transmission.
5087 If @code{nil}, default SMTP port number (25) is used.
5089 @item wl-smtp-posting-user
5090 @vindex wl-smtp-posting-user
5091 The initial setting is @code{nil}.
5092 This is the user name for SMTP AUTH authentication.
5094 @item wl-smtp-authenticate-type
5095 @vindex wl-smtp-authenticate-type
5096 The initial setting is @code{nil}.
5097 This string-valued variable specifies the authentication method for SMTP
5098 AUTH authentication. You may specify @code{plain}, @code{cram-md5},
5099 @code{digest-md5}, @code{login}, etc. If @code{nil}, authentication
5100 will not be carried out.
5102 @item wl-smtp-connection-type
5103 @vindex wl-smtp-connection-type
5104 The initial setting is @code{nil}.
5105 This symbol-valued variable specifies how to establish SMTP connections.
5106 If @code{nil}, use default connection type.
5107 If it is @code{starttls}, use STARTTLS (RFC2595).
5108 If it is @code{ssl}, use SSL.
5110 @item wl-nntp-posting-server
5111 @vindex wl-nntp-posting-server
5112 The initial setting is @code{nil}.
5113 This is the NNTP server name used for news submission.
5114 If @code{nil}, @code{elmo-nntp-default-server} is used.
5116 @item wl-nntp-posting-user
5117 @vindex wl-nntp-posting-user
5118 The initial setting is @code{nil}.
5119 This is the user name for AUTHINFO authentication on news submission.
5120 If @code{nil}, @code{elmo-nntp-default-user} is used.
5121 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
5123 @item wl-nntp-posting-port
5124 @vindex wl-nntp-posting-port
5125 The initial setting is @code{nil}.
5126 This is the port number of the NNTP server used for news submission.
5127 If @code{nil}, @code{elmo-nntp-default-server} is used.
5129 @item wl-nntp-posting-stream-type
5130 @vindex wl-nntp-posting-stream-type
5131 The initial setting is @code{nil}.
5132 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If @code{ssl},
5133 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
5134 connection will be established.
5136 @item wl-nntp-posting-function
5137 @vindex wl-nntp-posting-function
5138 The initial setting is @code{elmo-nntp-post}.
5139 This is the function to post NNTP message.
5141 @item wl-nntp-posting-config-alist
5142 @vindex wl-nntp-posting-config-alist
5143 The initial setting is @code{nil}.
5144 The value takes an alist to define NNTP server like following example.
5145 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
5149 (setq wl-nntp-posting-config-alist
5150 '((",?gmane\\." . "news.gmane.org")
5152 ((server . "news-server")
5153 (user . "newsmaster")
5155 (function . elmo-nntp-post)))
5156 (".*" . "default-news-server")))
5160 @item wl-pop-before-smtp-user
5161 @vindex wl-pop-before-smtp-user
5162 The initial setting is @code{nil}.
5163 This is the POP user name for POP-before-SMTP.
5164 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
5166 @item wl-pop-before-smtp-server
5167 @vindex wl-pop-before-smtp-server
5168 The initial setting is @code{nil}.
5169 This is the POP server name for POP-before-SMTP.
5170 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
5172 @item wl-pop-before-smtp-authenticate-type
5173 @vindex wl-pop-before-smtp-authenticate-type
5174 The initial setting is @code{nil}.
5175 This is the authentication method for POP-before-SMTP authentication.
5176 If it is @code{nil}, @code{elmo-pop3-default-authenticate-type} is used.
5178 @item wl-pop-before-smtp-port
5179 @vindex wl-pop-before-smtp-port
5180 The initial setting is @code{nil}.
5181 This is the POP port number for POP-before-SMTP. If it is @code{nil},
5182 @code{elmo-pop3-default-port} is used.
5184 @item wl-pop-before-smtp-stream-type
5185 @vindex wl-pop-before-smtp-stream-type
5186 The initial setting is @code{nil}.
5187 This flag controls the use of SSL for POP-before-SMTP. If it is
5188 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{ssl},
5189 SSL is used. If @code{starttls}, STARTTLS (RFC2595) connection will be
5192 @item wl-draft-queue-save-variables
5193 @vindex wl-draft-queue-save-variables
5194 Specifies a list of variable to which queued messages are saved on the
5195 off-line transmission.
5197 @item wl-draft-sendlog
5198 @vindex wl-draft-sendlog
5199 The initial setting is @code{t}.
5200 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
5204 @item drafts are sent by smtp or qmail
5205 @item saved into folders by fcc
5206 @item saved into folders by queuing
5209 (it is written even if the transmission fails).
5210 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
5211 and left to the logging function of @command{imput}.
5214 @item wl-draft-sendlog-max-size
5215 @vindex wl-draft-sendlog-max-size
5216 The initial setting is 20000 (in bytes).
5217 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
5218 beyond the size specified by this variable.
5222 The initial setting is @code{nil}.
5223 If non-nil, address completion uses LDAP.
5225 @item wl-ldap-server
5226 @vindex wl-ldap-server
5227 The initial setting is @samp{localhost}.
5228 LDAP server name for address completion.
5231 @vindex wl-ldap-port
5232 The initial setting is @code{nil}.
5233 If non-nil, the value is used as port number.
5236 @vindex wl-ldap-base
5237 The initial setting is @samp{c=US}.
5238 LDAP search starting point (base) for address completion.
5240 @item wl-draft-remove-group-list-contents
5241 @vindex wl-draft-remove-group-list-contents
5242 The initial setting is @code{t}.
5243 If non-nil, remove the group-lists' members in the recipients when
5244 sending the message (group-list means the description such as
5245 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5248 @node Disconnected Operations, Expire and Archive, Draft, Top
5249 @chapter Off-line Management
5250 @cindex Disconnected Operations
5252 Wanderlust has on-line and off-line states.
5255 * Off-line State:: Wanderlust has on-line and off-line states
5256 * Enable Operations:: Enable Disconnected Operations
5257 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5258 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5259 * Variables of Plugged Mode:: Customize Plugged Mode
5263 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5264 @section Off-line State
5266 Wanderlust has on-line and off-line states. In the off-line state, you
5267 cannot access messages via network, unless they are cached.
5269 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5270 in the mode line indicates the off-line state. In folder or summary
5271 modes, press @kbd{M-t} to switch between off- and on-line.
5273 You can invoke Wanderlust in the off-line state by setting
5274 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5276 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5277 ignores uncached messages.
5280 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5281 @section Enable Disconeected Operations
5283 Even in the off-line state, provided that relevant messages are cached,
5284 and the variable @code{elmo-enable-disconnected-operation} (described
5285 later) is non-nil, you can following operations:
5286 @xref{Plugged Mode}, @xref{Off-line State settings}.
5289 * Send Messages off-line:: Transmit Messages
5290 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5291 * Creation of Folders:: Create Folders off-line (IMAP4)
5292 * Marking:: Mark (IMAP4)
5293 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
5296 As soon as Wanderlust becomes on-line, such operations invoked off-line
5297 are reflected in the servers via network.
5300 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5301 @subsection Transmission of Messages
5303 You can proceed sending operation for mail/news messages while you are
5304 off-line, then it will be reserved for sending (if you are using
5305 @file{im-wl.el}, it is irrelevant).
5306 Messages reserved for sending while off-line are accumulated in the
5307 queue folder, @samp{+queue}. These messages are transmitted at once when
5308 Wanderlust becomes on-line.
5310 You can visit @samp{+queue} in the off-line state and confirm content of
5311 messages in the queue. You can also remove messages. Removed messages
5312 are not transmitted even in the on-line state.
5315 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5316 @subsection Re-file and Copy (IMAP4)
5318 Re-file and copy operations to IMAP folders invoked during the off-line
5319 state are accumulated in the queue, and reflected in the server side
5320 when Wanderlust becomes on-line. If you visit destination folders after
5321 off-line re-file or copy, it looks as if messages were appended even in
5324 For the safety reasons, messages re-filed off-line are removed from
5325 source folders only if their @samp{Message-ID:} match messages on the
5326 servers. While the queue is processed, messages that failed to be
5327 re-filed or copied to the specified folders are appended to the folder
5331 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5332 @subsection Creation of Folders (IMAP4)
5334 You can create IMAP folders off-line. The creation of folders are
5335 reflected in the servers when Wanderlust becomes on-line. If the creation
5336 of those folders fails at that time for some reasons, messages
5337 to be re-filed into those are appended to the folder @samp{+lost+found}
5341 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5342 @subsection Marking (IMAP4)
5344 Off-line changes in unread/read and importance mark @samp{$} information
5345 are also reflected in the servers when Wanderlust becomes on-line.
5348 @node Pre-fetching Reservations, , Marking, Enable Operations
5349 @subsection Pre-fetching (IMAP4, NNTP)
5351 You can make reservations for pre-fetching messages in IMAP or NNTP
5352 folders. Reserved messages are marked with @samp{!} but not cached
5353 yet. When Wanderlust becomes on-line, they are pre-fetched from
5356 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5357 these off-line operations for IMAP4 and NNTP do not take place, and
5358 off-line re-file, copy or suchlike simply results in error.
5360 Because off-line operations use cache files, it is a bad idea to erase
5361 them by hand; it may cause Wanderlust to malfunction.
5363 If you want to remove caches, be sure to execute @kbd{M-x
5364 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5365 remove caches for messages relevant to off-line operations.
5368 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5369 @section Switching On-line/Off-line per Server/Port
5371 @kbd{M-t} described above switches networking states as a whole, but you
5372 can switch on-line/off-line per server/port.
5374 Pressing @kbd{C-t} in the folder or summary modes brings you in
5375 wl-plugged-mode shown below, in which you can change the plugged state
5380 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5383 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5384 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5386 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5387 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5393 The first line indicates status of the following three variables, and
5394 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5395 column modifies the values of these variables.
5399 "Queuing" @code{wl-draft-enable-queuing}
5400 "AutoFlushQueue" @code{wl-auto-flush-queue}
5401 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5405 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5408 The second and after lines indicate on-line/off-line states of servers
5409 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5410 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5411 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5413 @dfn{sending queue} means messages accumulated in the folder
5414 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5415 off-line operations when @code{elmo-enable-disconnected-operation} is
5417 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5418 @c off-line operations are enabled.
5420 They are displayed if there are any of them. In the example above, in
5421 the sending queue there are two messages (the first and the second in
5422 the queue folder) for smtp to hosta and one (the third) for nntp to
5423 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5426 If you change @samp{(wl-plugged)} in the second line, the variable
5427 @code{wl-plugged} is changed, so that the mode line indicator and
5428 plugged states of all ports are affected. If you change plugged states
5429 of any servers or ports, @samp{(wl-plugged)} in the second line is
5430 affected depending on @code{elmo-plugged-condition} settings and the
5431 plugged state of each port.
5434 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5435 @section Invoking Wanderlust in the Off-line State
5437 As described before, if you set @code{wl-plugged} to @code{nil} in
5438 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5439 off-line state. You can specify off-line state on a per server or port
5440 basis. Refer to @code{wl-reset-plugged-alist} also.
5442 Usually, when Wanderlust starts up, the plugged state of each port is
5443 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5444 @code{wl-nntp-posting-server} and so on. If you want to change the
5445 plugged state of these ports or to add other ports, configure
5446 @code{wl-make-plugged-hook} with a function.
5450 (add-hook 'wl-make-plugged-hook
5452 (elmo-set-plugged plugged-value(t/nil) server port)
5453 ;; @r{add or change plugged states of the port of the server}
5454 (elmo-set-plugged plugged-value(t/nil) server)
5455 ;; @r{if the port is omitted, all ports are affected}
5456 ;; @r{(you cannot omit the port if you newly add the server)}
5462 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5463 @section Customizable Variables
5468 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5469 mode from the beginning.
5471 @item wl-queue-folder
5472 @vindex wl-queue-folder
5473 The initial setting is @samp{+queue}.
5474 This is the folder in which messages in the transmission queue are
5477 @item wl-auto-flush-queue
5478 @vindex wl-auto-flush-queue
5479 The initial setting is @code{t}.
5480 This flag controls automatic transmission of the queue when Wanderlust
5481 becomes on-line. If non-nil, the queue is automatically transmitted
5482 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5483 manually, press @kbd{F} in the folder mode.
5485 @item elmo-enable-disconnected-operation
5486 @vindex elmo-enable-disconnected-operation
5487 The initial setting is @code{t}. Controls off-line operations
5488 regarding IMAP4. If non-nil, off-line operations are carried out.
5490 @item elmo-lost+found-folder
5491 @vindex elmo-lost+found-folder
5492 The initial setting is @samp{+lost+found}.
5493 This is the folder to which messages are saved when they fails to be
5494 appended while the off-line re-file/copy queue is processed.
5496 @item elmo-plugged-condition
5497 @vindex elmo-plugged-condition
5498 The initial setting is @code{one}.
5499 The value of @code{wl-plugged} reflects the return value of the function
5500 @code{elmo-plugged-p} (without arguments).
5501 This variable @code{elmo-plugged-condition} specifies the condition on
5502 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5503 plugged state of each port.
5506 'one : plugged if one or more ports are plugged.
5507 'all : plugged if all ports are plugged.
5508 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5509 states of the ports.
5510 @var{function} : reflects the return value of the @var{function}
5511 functions available per default
5512 'elmo-plug-on-by-servers
5513 : reflects the plugged state of the servers specified by the
5514 variable elmo-plug-on-servers.
5515 'elmo-plug-on-by-exclude-servers
5516 : reflects the plugged state of the servers that are not
5517 in elmo-plug-on-exclude-servers.
5518 elmo-plug-on-exclude-servers defaults to
5521 (system-name)without the domain part)
5527 (setq elmo-plugged-condition 'all)
5529 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5530 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5532 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5533 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5537 @item wl-reset-plugged-alist
5538 @vindex wl-reset-plugged-alist
5539 The initial setting is @code{t}. If non-nil, plugged states are
5540 initialized on a per server or port basis when Wanderlust starts up.
5542 If @code{nil}, plugged states are retained while Emacs is running. In
5543 other words, they are initialized when Emacs is restarted even if the
5544 value is @code{nil}.
5548 @node Expire and Archive, Scoring, Disconnected Operations, Top
5549 @chapter Automatic Expiration and Archiving of Messages
5550 @cindex Expire and Archive
5553 * Expire:: Expiration and Archiving
5554 * Archive:: Archiving All Messages
5558 @node Expire, Archive, Expire and Archive, Expire and Archive
5560 @cindex Expire Message
5562 Expiration means deletion of old messages which have outlasted a
5563 certain period of time.
5565 @code{wl-expire} supports not only simple deletion, but also moving to
5566 specified archiving folders.
5570 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5571 or @kbd{M-e} in the summary mode.
5573 @subsection Configuring @code{wl-expire-alist}
5575 An example configuration of @code{wl-expire-alist} is shown below.
5576 Everything in this @code{wl-expire-alist} makes a great difference in
5577 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5578 to @code{t}, especially in the initial stage.
5582 (setq wl-expire-alist
5583 '(("^\\+trash$" (date 14) remove)
5585 ("^\\+tmp$" (date 7) trash)
5586 ;; @r{re-file to @code{wl-trash-folder}}
5587 ("^\\+outbox$" (number 300) "$outbox;lha")
5588 ;; @r{re-file to the specific folder}
5590 ;; @r{do not expire}
5591 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5592 ;; @r{archive by message number (retaining numbers)}
5593 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5594 ;; @r{archive by a fixed number (retaining numbers)}
5595 ("^\\+diary$" (date 30) wl-expire-archive-date)
5596 ;; @r{archive by year and month (numbers discarded)}
5601 Items in the list has the format of:
5604 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5608 The folder is examined if it matches @var{regexp-for-folders} from the
5609 beginning of the list. If you invoke expiration on the folder that does
5610 not match any of them, nothing will happen. And if either the second or
5611 the third element of the item is @code{nil}, expiration will not take
5614 You can use any one of the following for
5615 @var{specification-of-message-to-be-deleted}:
5618 @item (number @var{n1} [@var{n2}])
5619 deletes messages depending on the number of messages in the folder.
5621 @var{n1} is the number of messages which should survive deletion, for example
5622 if its value is 500, the newest 500 messages survive and the rests are
5625 @var{n2} is the number of messages in the folder on which expiration should
5626 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5627 folders with 510 or more messages are expired.
5628 If you configured automatic expiration, frequently used folders may
5629 expire every time it receive messages, and you may be annoyed with the
5630 long delay in reading mail.
5631 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5632 expiration would not take place until a certain number of messages
5635 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5636 with important/new/unread) are not deleted.
5637 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5638 will expire so as to have 500 messages including such ones.
5639 Otherwise, it will have 500 messages except such ones.
5641 @item (date @var{d1})
5642 deletes messages depending on the dates.
5644 Messages dated @var{d1} or more days ago are deleted, for example if its
5645 value is seven, messages seven days old or more are deleted. Note that
5646 the date is the one in the @samp{Date:} field of the message, not when
5647 the message entered the folder.
5649 Messages with no or invalid @samp{Date:} field does not expire; you
5650 might have to delete them by hand.
5653 You can use any one of the following in the place of @var{destination}:
5657 deletes the messages instantly.
5660 hide the messages from summary (messages are not deleted).
5663 moves the messages to @code{wl-trash-folder}.
5665 @item @var{string}(folder)
5666 moves the messages to the folder specified with @var{string}.
5668 It would be useful for specifying an archiving folder, but because this
5669 does not move important messages, it might be better to use the
5670 standard functions described below.
5672 @item @var{function}
5673 invokes the specified @var{function}.
5675 To the @var{function}, three arguments are passed: a folder name, a list
5676 of messages to be deleted, and msgdb information of the summary. You
5677 can specify function-specific arguments after the name of the
5678 @var{function}. Note that the list contains messages with marks in
5679 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5682 These are four standard functions; three of them move messages to an archive
5683 folder in the specified way. This means old messages can be compressed
5684 and saved in a file, being deleted from the original folder.
5685 The last one divides messages to some MH folders.
5688 @item wl-expire-archive-number1
5689 re-files to archiving folders corresponding to the message numbers of
5690 the messages being deleted. For example, a message numbered 102 will be
5691 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5692 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5693 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5695 The archiving folders to which messages are re-filed are determined by
5696 the name of the folder as follows (in this case, archiving folders are
5697 handled as if @code{elmo-archive-treat-file} were non-nil).
5700 @item If the folder type is localdir:
5701 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5703 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5704 (@file{~/Mail/ml/wl-00100.zip}).
5706 @item The folder type is other than localdir:
5707 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5709 For example, @samp{%#mh/ml/wl} corresponds to
5710 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5713 As you can see, in the case of localdir, the folder type is not included
5714 in the path name, but otherwise it is included.
5715 And you can control the prefix to the archiving folder name by
5716 @code{wl-expire-archive-folder-prefix}.
5717 Refer to @code{wl-expire-archive-folder-prefix} for details.
5719 @item wl-expire-archive-number2
5720 re-files every certain number of messages to archiving folders.
5722 This differs from @samp{wl-expire-archive-number1} in that this re-files
5723 to the folder up to the specified number regardless of message numbers.
5724 The archiving folders to which messages are re-filed are determined in the
5725 same way as @code{wl-expire-archive-number1}.
5727 @item wl-expire-archive-date
5728 re-files messages depending on its date (year and month) to archive
5731 For example, a message dated December 1998 is re-filed to
5732 @code{$folder-199812;zip}. The name of the archiving folders except the
5733 date part are determined in the same way as
5734 @code{wl-expire-archive-number1}.
5737 You can set the first argument to these three standard functions to non-nil
5738 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5739 For example, it can be specified just after the name of the function:
5742 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5745 If you omit the argument, consecutive numbers from 1 are assigned for
5746 each archiving folder.
5748 @item wl-expire-localdir-date
5749 divedes messages depending on its date (year and month) to MH folders
5750 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5754 @subsection Treatment for Important or Unread Messages
5756 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5757 standard function, messages with marks in
5758 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5759 messages} thereafter) are retained.
5761 Per default, this variable include the important, new, and unread marks,
5762 so that messages with these marks are not removed.
5763 Note that you cannot include the temporary mark (i.e. temporary marks
5764 are removed anyway), and be sure to process temporary marks before you
5767 @subsection Auto Expiration
5769 The following setup invokes expiration when you move into the summary
5770 mode. There will be no confirmation, so make sure you made no mistake
5771 in regexp and other settings before you set up this.
5775 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5779 In the folder mode, you can invoke expiration per group as well as per
5780 folder. Therefore, if you specify @samp{Desktop} group, all folders
5781 matching @code{wl-expire-alist} expire.
5785 @subsection Treating archive folders.
5786 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5787 you must set non-nil value to @code{elmo-archive-treat-file}.
5789 @subsection Confirming
5791 If you are to use @code{remove}, try @code{trash} at first and see
5792 messages move to @code{wl-trash-folder} as expected, then replace it
5793 with @code{remove}. It would be dangerous to use @code{remove} from the
5796 If you are to use @code{wl-expire-archive-number1} and the like, try to
5797 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5798 you can append messages to it. Even if settings in
5799 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5800 would not be saved anywhere and disappeared in case the archiver program
5803 After you make sure you can archive to the folder correctly, you can
5804 invoke expiration and utilize the log.
5806 If you set @code{wl-expire-use-log} to @code{t},
5807 @file{~/.elmo/expired-log} should contain the log, for example:
5811 delete +ml/wl (593 594 595 596 597 598 599)
5812 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5816 The first column indicates the operation, i.e. @samp{delete},
5817 @samp{copy}, or @samp{move}. The next is the name of the folder that
5818 expired. In the case of @samp{copy} and @samp{move}, the destination
5819 folder is recorded after @samp{->}. The last is the list of message
5820 numbers that are actually deleted or moved (in the case of @samp{copy}
5821 and @samp{move}, the number is the one in the source folder, rather than
5822 the destination folder).
5824 @subsection Re-filing Reserved Messages
5826 The three standard functions copy reserved messages to the archive
5827 folder, but do not delete them from the source folder. Because
5828 reserved messages and the like always remain, they are recorded in
5829 @file{~/.elmo/expired-alist} so that they are not copied over and over
5830 again. They are not recorded if copied by @code{wl-summary-archive}.
5832 If you enabled logging, usually @samp{move} is recorded for re-filing,
5833 but instead @samp{copy} and @samp{delete} are recorded separately if
5834 reserved messages are involved. This is because it actually copies
5835 messages including reserved, then deletes ones except reserved in that
5838 @section Customizable Variables
5841 @item wl-expire-alist
5842 @vindex wl-expire-alist
5843 The initial setting is @code{nil}.
5844 This variable specifies folders and methods to expire. For details,
5845 refer to @code{wl-expire-alist} settings above.
5847 @item wl-summary-expire-reserve-marks
5848 @vindex wl-summary-expire-reserve-marks
5849 The initial setting is the list below.
5853 (list wl-summary-important-mark
5854 wl-summary-new-uncached-mark
5855 wl-summary-new-cached-mark
5856 wl-summary-unread-mark
5857 wl-summary-unread-uncached-mark
5858 wl-summary-unread-cached-mark)
5862 Messages with these marks are retained in the folder, even after
5864 Only permanent marks can be listed, not temporary marks.
5866 You can list marks one by one as in the default; you can use the
5867 following settings as well:
5871 All messages with permanent marks are retained,
5872 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5876 All messages are handled as usual ones that are already read, no matter
5877 what marks they have; even important messages are deleted.
5880 @item wl-expire-archive-files
5881 @vindex wl-expire-archive-files
5882 The initial setting is 100.
5883 This variable specifies the number of messages to be retained in one
5886 @item wl-expire-number-with-reserve-marks
5887 @vindex wl-expire-number-with-reserve-marks
5888 The initial setting is @code{nil}.
5889 If non-nil, if expiring messages are specified by @code{number},
5890 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5892 @item wl-expire-archive-get-folder-function
5893 @vindex wl-expire-archive-get-folder-function
5894 The initial setting is @code{wl-expire-archive-get-folder}.
5896 This variable specifies a function that returns the name of an archiving
5897 folder for standard functions in the place of @var{destination}.
5898 You can use the following three variables for simple modification of
5899 folder names; if you want more complex settings, define your own
5900 function in this variable.
5902 @code{wl-expire-archive-get-folder} can be customized by these
5905 @item @code{wl-expire-archive-folder-name-fmt}
5906 @item @code{wl-expire-archive-folder-type}
5907 @item @code{wl-expire-archive-folder-prefix}
5910 @item wl-expire-archive-folder-name-fmt
5911 @vindex wl-expire-archive-folder-name-fmt
5912 The initial setting is @samp{%s-%%05d;%s}.
5913 This is a @code{format} string for archiving folders used in
5914 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5915 Note that you must specify the message number by @samp{%%d}, because it
5916 is parsed twice by @code{format}.
5918 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5921 @item wl-expire-archive-date-folder-name-fmt
5922 @vindex wl-expire-archive-date-folder-name-fmt
5923 The initial setting is @samp{%s-%%04d%%02d;%s}.
5924 This is a @code{format} string for archiving folders used in
5925 @code{wl-expire-archive-date}. Note that you must specify the message
5926 number by @samp{%%d}, because it is parsed twice by @code{format}.
5927 There should be @samp{%%d} twice, one for the year and the other for the
5930 If you modify this, adjust
5931 @code{wl-expire-archive-date-folder-num-regexp} as well.
5933 @item wl-expire-archive-folder-type
5934 @vindex wl-expire-archive-folder-type
5935 The initial setting is @code{zip}.
5936 This variable specifies an archiver type of the archiving folders.
5938 @item wl-expire-archive-folder-prefix
5939 @vindex wl-expire-archive-folder-prefix
5940 The initial setting is @code{nil}.
5941 This variable specifies the prefix (directory structure) to archiving
5943 Exercise extreme caution in using this feature, as it has not been
5945 In the worst case, there is a fear of destructing archiving folders.
5949 There will be no prefix.
5952 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5953 @samp{$ml/wl-00000;zip;wl}.
5956 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5959 @samp{$ml/wl-00000;zip;ml/wl}.
5962 @item wl-expire-archive-folder-num-regexp
5963 @vindex wl-expire-archive-folder-num-regexp
5964 The initial setting is @samp{-\\([-0-9]+\\);}.
5965 This variable specifies the regular expression to be used for getting
5966 message numbers from multiple archiving folders specified by
5967 @code{elmo-list-folders}.
5968 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5970 @item wl-expire-archive-date-folder-num-regexp
5971 @vindex wl-expire-archive-date-folder-num-regexp
5972 The initial setting is @samp{-\\([-0-9]+\\);}.
5973 This is the regular expression to be used for getting message numbers
5974 from multiple archiving folders specified by @code{elmo-list-folders}.
5975 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5977 @item wl-expire-delete-oldmsg-confirm
5978 @vindex wl-expire-delete-oldmsg-confirm
5979 The initial setting is @code{t}.
5980 If non-nil, messages older than the one with the largest number will be
5981 deleted with confirmation.
5982 If @code{nil}, they are deleted without confirmation.
5984 This feature is valid only if non-nil is specified as a argument to the
5985 standard functions so as to retain numbers.
5987 @item wl-expire-use-log
5988 @vindex wl-expire-use-log
5989 The initial setting is @code{nil}.
5990 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5991 They are appended but not truncated or rotated automatically; you might
5992 need to remove it manually.
5994 @item wl-expire-add-seen-list
5995 @vindex wl-expire-add-seen-list
5996 The initial setting is @code{t}.
5998 If non-nil, when messages are re-filed by expiration, read/unread
5999 information is passed to the destination folder.
6001 However if you do not read the destination folder from Wanderlust,
6002 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
6003 want to set this to @code{nil} if you are simply saving to some
6004 archiving folders. Even if its value is @code{nil}, messages in the
6005 archiving folders are simply treated as unread; it does not affect
6008 @item wl-expire-folder-update-msgdb
6009 @vindex wl-expire-folder-update-msgdb
6010 The initial setting is @code{t}.
6011 If @code{t}, in the folder mode, expiration is carried out after
6012 updating summary information. If you specified a list of regular
6013 expressions of folder names, summary information is updated for matching
6018 @node Archive, , Expire, Expire and Archive
6019 @section Archiving Messages
6021 @subsection Archiving Messages
6022 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
6023 folders. If there are the archiving folders already, only new messages
6026 You can use @code{wl-archive-alist} in order to specify how messages are
6027 archived according to their folder names, as in @code{wl-expire-alist}.
6032 (setq wl-archive-alist
6033 '(("^\\+tmp$" wl-archive-date)
6034 ("^\\+outbox$" wl-archive-number2)
6035 (".*" wl-archive-number1)))
6039 Each item in the list has the following format:
6042 (@var{folders-regexp} @var{deleting-function})
6045 As you can see, you can only use a function after @var{folders-regexp}.
6046 Per default, there are three functions:
6049 @item @code{wl-archive-number1}
6050 @item @code{wl-archive-number2}
6051 @item @code{wl-archive-date}
6054 As inferred from their names, they work similarly to "expire" versions,
6055 other than the following points:
6058 @item No messages are deleted
6059 @item Message numbers are retained even if invoked without arguments
6062 These functions are good to archive all messages in a folder by their
6063 numbers or by their dates.
6064 These are also useful for backup or confirmation purposes before
6066 If you try to re-file them after they are archived, they are deleted but
6069 Per default, the archiving folders to which messages are copied are
6070 determined automatically by @code{wl-expire-archive-get-folder-function}.
6071 You can copy to a specific folder by invoking with a prefix argument,
6072 i.e. @kbd{C-u M-x wl-summary-archive}.
6074 Note that this feature has not been seriously tested, because you can
6075 simply copy to an archiving folder, for example by
6076 @code{wl-summary-copy-region}.
6078 The archiving folders are determined by the same logic as in
6079 @code{wl-summary-expire}; the following customizable variables are
6083 @item @code{wl-expire-archive-files}
6084 @item @code{wl-expire-archive-get-folder-function}
6085 @item @code{wl-expire-archive-folder-name-fmt}
6086 @item @code{wl-expire-archive-folder-type}
6087 @item @code{wl-expire-archive-folder-prefix}
6088 @item @code{wl-expire-archive-folder-num-regexp}
6091 @subsection Customizable Variables
6094 @item wl-archive-alist
6095 @vindex wl-archive-alist
6096 The initial setting is the list shown below:
6100 ((".*" wl-archive-number1))
6105 This variable specifies a function that copies to archiving folders.
6106 To the function, three arguments are passed: a folder name, a list of
6107 messages in the folder, and msgdb information of the summary.
6108 Needless to say, you can use your own function.
6112 @node Scoring, Split messages, Expire and Archive, Top
6113 @chapter Score of the Messages
6115 @c @cindex Kill File
6117 Scoring is the function that associates a score (value) with each
6118 message, and marks as read or deletes from the summary according to it.
6120 You can put target or important marks on essential messages, or read marks
6121 on the ones you do not want to read, for example spam articles.
6123 This scoring function has a capability and a format similar to the one
6124 that Gnus has, although there are some unsupported features and
6125 Wanderlust specifics.
6126 @xref{Scoring, , ,gnus, The gnus Newsreader}.
6129 * Score Commands:: Score Commands
6130 * Score File Format:: Score File Format
6134 @node Score Commands, Score File Format, Scoring, Scoring
6135 @section Score Commands
6136 @cindex Score Commands
6138 @subsection Score File Specification
6140 @code{wl-score-folder-alist} specifies score files or variables in which
6141 scores are defined, corresponding to folder names.
6145 (setq wl-score-folder-alist
6154 If paths to the score files are omitted, the directory specified in the
6155 variable @code{wl-score-files-directory} is assumed.
6157 No matter what you write in @code{wl-score-folder-alist}, the default
6158 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
6159 read (it does not have to exist).
6160 Therefore, in the example above, the three score files,
6161 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
6162 the folders that matches @samp{^-.*}.
6164 @subsection Scored Messages
6166 Scores are attached to the messages that are specified by
6167 @code{wl-summary-score-marks} temporarily when the summary is updated;
6168 when you exit from the summary, the scores are removed and reverts to
6171 @subsection Creation of Score Files
6173 In the summary buffer, move to an appropriate message and type @kbd{L}.
6174 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
6175 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
6177 This makes @minus{}1000 are scored for messages with the same
6178 @samp{Subject:} as the string you entered. That is, such a score file
6179 is created automatically.
6181 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
6182 The score file you just made appears.
6183 This buffer is called @dfn{score editing buffer} thereafter.
6184 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
6185 as you are previously; type @kbd{a}. Then a score entry for "From"
6187 In this way, you can create a score file easily either in the summary
6188 buffer or in the score editing buffer.
6190 By the way, you might be aware the numbers of key strokes are different
6191 between @kbd{s s p} and @kbd{a}.
6192 This is determined by @code{wl-score-header-default-entry}.
6193 This variable specifies the default score entries corresponding to
6195 For example, for "subject" field, a type and a time limit are prompted,
6196 but for "from" field, they are fixed upon automatically as substring and
6197 permanent respectively.
6198 However, score values can be modified by the prefix argument.
6199 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
6202 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
6203 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
6204 erasing contents of the buffer deletes the score file being edited.
6208 @subsubsection Selecting Score Files
6210 You can change score files to which scores are appended by
6211 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
6212 @code{wl-score-change-score-file}.
6214 @subsubsection Summing Up the Score
6216 If you add the same entries by @code{wl-summary-increase-score},
6217 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
6218 scores for the entry is summed up.
6220 For example, if you create @samp{from} entry with the score of @minus{}1000 by
6221 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
6222 @minus{}1200 will be created as a result.
6224 @subsubsection Creating Thread Key
6226 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
6227 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6229 @subsubsection Creating Followup Key
6231 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6232 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6233 at the cursor to @samp{References} key.
6234 If @code{wl-score-auto-make-followup-entry} is non-nil,
6235 @samp{Message-ID} of all messages to be followed up within dates
6236 specified by @code{wl-score-expiry-days}.
6238 @subsection Key Bindings
6243 @findex wl-summary-increase-score
6244 Increases the score for the current message.
6245 And the score entry is appended to the score file at the same moment.
6246 You can specify the score value by a prefix argument.
6250 @findex wl-summary-lower-score
6251 Decreases the score for the current message.
6252 And the score entry is appended to the score file at the same moment.
6253 You can specify the score value by a prefix argument.
6256 @kindex h R (Summary)
6257 @findex wl-summary-rescore
6258 Re-applies the scoring.
6259 However, already scored messages are not scored anew.
6262 @kindex h c (Summary)
6263 @findex wl-score-change-score-file
6264 Changes the score file currently selected.
6267 @kindex h e (Summary)
6268 @findex wl-score-edit-current-scores
6269 Edits the score file currently selected.
6270 If there are multiple score files, the previously specified one is
6274 @kindex h f (Summary)
6275 @findex wl-score-edit-file
6276 Edits an arbitrary score file and selects it.
6279 @kindex h F (Summary)
6280 @findex wl-score-flush-cache
6281 Erases caches associated to the score files that are read.
6282 If you modified score files directly (from other than Wanderlust), you
6283 need to re-read them after erasing the cache.
6286 @kindex h m (Summary)
6287 @findex wl-score-set-mark-below
6288 Specifies the criterion for scores to be marked as read.
6289 Messages with scores less than this value are marked as read.
6292 @kindex h x (Summary)
6293 @findex wl-score-set-expunge-below
6294 Specifies the criterion for scores to be deleted from the summary.
6295 Messages with scores less than this value are deleted.
6296 "Deleted" means it is not shown; they are not removed from the summary
6297 information or the folder.
6298 The deleted messages can be shown by rescan-noscore again.
6301 @subsection Key Bindings in the Score Editing Buffer
6305 @kindex C-c C-k (Score Mode)
6306 @findex wl-score-edit-kill
6307 Abandons the file being edited.
6310 @kindex C-c C-c (Score Mode)
6311 @findex wl-score-edit-exit
6312 Saves the file being edited, and quits from the edit mode.
6315 @kindex C-c C-p (Score Mode)
6316 @findex wl-score-pretty-print
6320 @kindex C-c C-d (Score Mode)
6321 @findex wl-score-edit-insert-date
6322 Inserts the number of dates from Dec. 31, 1 B.C.
6323 It is used for creating the third factor of time-limited scores.
6326 @kindex C-c C-s (Score Mode)
6327 @findex wl-score-edit-insert-header
6328 Inserts the header of the message selected in the summary buffer.
6331 @kindex C-c C-e (Score Mode)
6332 @findex wl-score-edit-insert-entry
6333 Inserts the score entry of the message selected in the summary buffer.
6336 @subsection Customizable Variables
6339 @item wl-summary-default-score
6340 @vindex wl-summary-default-score
6341 The initial setting is 0 (zero).
6342 This variable specifies the default value of the score.
6343 The score is increased or decreased based upon this value.
6345 @item wl-summary-important-above
6346 @vindex wl-summary-important-above
6347 The initial setting is @code{nil}.
6348 Messages with scores larger than this value are attached with the
6349 important mark (@samp{$}).
6350 If @code{nil}, no important marks are attached.
6352 @item wl-summary-target-above
6353 @vindex wl-summary-target-above
6354 The initial setting is @code{nil}.
6355 Messages with scores larger than this value are attached with the target
6357 If @code{nil}, no target marks are attached.
6359 @item wl-summary-mark-below
6360 @vindex wl-summary-mark-below
6361 The initial setting is 0 (zero).
6362 Messages with scores smaller than this value are marked as read.
6364 @item wl-summary-expunge-below
6365 @vindex wl-summary-expunge-below
6366 The initial setting is @code{nil}.
6367 Messages with scores smaller than this value are deleted from the
6369 If @code{nil}, they are not deleted.
6371 @item wl-summary-score-marks
6372 @vindex wl-summary-score-marks
6373 The initial setting is the list shown below:
6377 (list wl-summary-new-uncached-mark
6378 wl-summary-new-cached-mark)
6383 Messages with these marks are scored.
6385 @item wl-use-scoring
6386 @vindex wl-use-scoring
6387 The initial setting is t.
6388 If non-nil, scoring is enabled.
6390 @item wl-score-files-directory
6391 @vindex wl-score-files-directory
6392 The initial setting is @file{~/.elmo/}.
6393 The default directory for score files.
6395 @item wl-score-interactive-default-score
6396 @vindex wl-score-interactive-default-score
6397 The initial setting is 1000.
6398 This value is used as a score when a score factor is @code{nil} in the
6399 score file. It is also used in @code{wl-summary-increase-score} and
6400 @code{wl-summary-lower-score}, on condition that the value of
6401 @code{wl-score-header-default-entry} is @code{nil}.
6403 @item wl-score-expiry-days
6404 @vindex wl-score-expiry-days
6405 The initial setting is 7.
6406 This is the number of days before time-limited scores are deleted.
6408 @item wl-score-update-entry-dates
6409 @vindex wl-score-update-entry-dates
6410 The initial setting is @code{t}.
6411 If non-nil, it enables deletion of time-limited scores.
6413 @item wl-score-header-default-entry
6414 @vindex wl-score-header-default-entry
6415 Specifies the default value for each header field for score entries
6416 created by @code{wl-summary-increase-score},
6417 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6419 @item wl-score-simplify-fuzzy-regexp
6420 @vindex wl-score-simplify-fuzzy-regexp
6421 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6422 regular expression to be deleted from the string.
6423 Because this is usually used for Subject, the default is prefixes that
6424 are attached by mailing list programs.
6426 @item wl-summary-rescore-partial-threshold
6427 @vindex wl-summary-rescore-partial-threshold
6428 The initial setting is 200.
6429 When sync-all or rescan is executed, if there are messages more than
6430 this value, only the last same number of messages as this value are
6433 @item wl-summary-auto-sync-marks
6434 @vindex wl-summary-auto-sync-marks
6435 If non-nil, unread/important marks are synchronized when the summary
6437 Unread marks reflect information on the IMAP4 server.
6438 Important marks reflect information on the IMAP4 server (flagged or
6439 not), and contents of @samp{'mark} folder.
6440 The initial setting is @code{t}.
6444 @node Score File Format, , Score Commands, Scoring
6445 @section Score File Format
6446 @cindex Score File Format
6448 The format of score files are the same as Gnus, and basically you can
6449 use Gnus score files as they are. But they are not fully compatible
6450 because some keys are not supported and there are Wanderlust specifics.
6451 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6456 ("for sale" -1000 nil s)
6457 ("profit" -1000 nil s))
6459 ("spam@@spamspamspam" -10000 nil s))
6461 ("my@@address" 3001 nil s))
6463 (1000000 -10 nil >))
6473 If the key is a string, it is the name of the header to be matched.
6474 The following keys are available:
6475 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6476 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6477 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6478 @code{Chars} and @code{Lines} mean the size and the number of lines of
6479 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6480 are described later.
6481 The rest corresponds the field of the same name.
6483 Arbitrary numbers of core entries are specified after the key.
6484 Each score entry consists of these five factors:
6488 A factor that matches header. This should be a number in the cases of
6489 @code{lines} and @code{chars}, otherwise a string.
6492 A score factor. When the first item matches, the score of the message
6493 is increased or decreased by this value.
6496 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6497 of a number, the score is deleted if it does not match for days
6498 (@code{wl-score-expiry-days}) from the date specified by this.
6499 The date is since Dec. 31, 1 B.C.
6502 A type factor. This specifies the way the first factor matches.
6503 Available types depend on keys.
6506 @item From, Subject, References, Message-ID
6507 For these keys in string, @code{r} and @code{R} (regexp),
6508 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6509 as well as @code{f} and @code{F} (fuzzy) can be used.
6510 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6513 For these keys, the following five numerical relative operators can be
6514 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6517 This key matches @code{From} header, and scores all follow-ups to the
6519 For example, it would be useful for increasing scores for follow-ups to
6522 You can use the same types as @code{From} except for @code{f}.
6523 And a @samp{Followup} entry is automatically appended to the score file.
6526 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6527 A @samp{Thread} entry is automatically appended for each article that
6528 has @var{x} in the @code{References} header.
6529 You can make sure the whole thread including messages that does not have
6530 all ancestors @code{Message-ID} in @code{References} is scored.
6532 You can use the same types as @code{References} except for @code{f}.
6533 And a @samp{Thread} entry is automatically appended to the score file.
6537 A factor for extension header. This is meaningful only if the key is
6539 This specifies headers to be matched other than standard headers like
6540 @code{Subject} and @code{From}.
6541 Note that you should specify the header in
6542 @code{elmo-msgdb-extra-fields} also.
6543 Therefore it does not work in folders where extension headers cannot be
6548 The sum of these scores @emph{after all factors are applied} becomes the
6549 score of the message.
6551 @cindex Score File Atoms
6553 Messages with a score less than this value is marked as read.
6554 The default is @code{wl-summary-mark-below}.
6557 Messages with a score less than this value is deleted from the summary.
6558 The default is @code{wl-summary-expunge-below}.
6560 @item mark-and-expunge
6561 Both @code{mark} and @code{expunge} are applied,
6562 i.e. messages with a score less than this value is marked as read and
6563 deleted from the summary.
6566 Messages with a score greater than this value is attached with temp
6568 The default is @code{wl-summary-target-above}.
6571 Messages with a score greater than this value is attached with important
6573 The default is @code{wl-summary-important-above}.
6578 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6579 are used, you need to set @code{elmo-msgdb-extra-fields}.
6582 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6585 There are other restrictions as shown below:
6588 @item Because @samp{References} field in the summary information
6589 contains only the last @samp{Message-ID}, @code{references} key matches
6593 Keys that can be seen by folder of types:
6597 chars lines xref extra
6598 localdir,localnews Y E E E
6599 nntp (supporting xover) Y E E N
6605 N: cannot be seen (ignored)
6606 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6611 @node Split messages, Address Book, Scoring, Top
6612 @chapter Message splitting
6613 @cindex Split messages
6615 You can use @code{elmo-split} to split message in folder specified by
6616 the variable @code{elmo-split-folder} a la @command{procmail} according
6617 to some specified rules. To use this feature, set as follows in your
6618 @file{~/.emacs} at first.
6621 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
6624 Set source folder like following.
6627 (setq elmo-split-folder "%inbox")
6630 And specify the rule in the variable @code{elmo-split-rule} (its format
6631 will be is described below).
6632 Then you can invoke @kbd{M-x elmo-split} to split messages according to
6633 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
6634 to do a rehearsal and show result (do not split actually).
6637 We will describe how to specify the rule. First of all, see following
6642 (setq elmo-split-rule
6643 ;; @r{Store messages from spammers into @samp{+junk}}
6644 '(((or (address-equal from "i.am@@spammer")
6645 (address-equal from "dull-work@@dull-boy")
6646 (address-equal from "death-march@@software")
6647 (address-equal from "ares@@aon.at")
6648 (address-equal from "get-money@@richman"))
6650 ;; @r{Store messages from mule mailing list into @samp{%mule}}
6651 ((equal x-ml-name "mule") "%mule")
6652 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
6653 ;; @r{and continue evaluating following rules}
6654 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
6655 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
6656 ((match from "\\(.*\\)@@yahoo\\.com")
6658 ;; @r{Store unmatched mails into @samp{+inbox}}
6663 The basic unit of the rule is a combination like
6666 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
6669 If @samp{CONDITION} is true, @samp{ACTION} is performed.
6670 The 1st element @samp{CONDITION} is a condition represented by a
6671 balanced expression (sexp). Its grammar will be explained below.
6672 The 2nd element @samp{ACTION} is the name of the folder to split
6673 messages into, or a symbol. When the 3rd element @code{continue} is
6674 specified as symbol, evaluating rules is not stopped even when the
6675 condition is satisfied.
6677 The grammar for @samp{CONDITION} is as follows. See example above to
6678 learn how to write the condition practically.
6682 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
6683 (@samp{FIELD-NAME} is a symbol that describes the field name)
6687 True if the field value equals to @samp{VALUE}.
6688 Case of the letters are ignored.
6690 True if the field value matches to VALUE.
6691 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6692 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6693 @item @code{address-equal}
6694 True if one of the addresses in the field equals to
6695 @samp{VALUE}. Case of the letters are ignored.
6696 @item @code{address-match}
6697 True if one of the addresses in the field matches to
6699 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6700 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6704 Functions which accept an integer argument (@samp{SIZE}).
6708 True if the size of the message is less than @samp{SIZE}.
6710 True if the size of the message is greater than @samp{SIZE}.
6714 Functions which accept any number of arguments.
6718 True if one of the argument returns true.
6720 True if all of the arguments return true.
6726 When a symbol is specified, it is evaluated.
6729 You can specify followings as 2nd @samp{ACTION}.
6735 If some string is specified, it will be regarded as the destination
6736 folder, and the message will be appended to it.
6741 If the symbol @samp{delete} is specified, delete the substance of the
6742 message in @code{elmo-split-folder}
6747 If the symbol @samp{noop} is specified, do nothing on the message and
6753 If some function is specified, execute it.
6756 If the message passes all rules, it will be dealed along @samp{ACTION}
6757 specified by @code{elmo-split-default-action}.
6760 @node Address Book, Spam Filter, Split messages, Top
6761 @chapter Address Book
6762 @cindex Address Book
6764 With address book, you can utilize address completion, and you have
6765 summary displayed with nicknames.
6768 * Mail Addresses:: Definition of Address Book
6769 * Address Manager:: Address Manager
6773 @node Mail Addresses, Address Manager, Address Book, Address Book
6774 @section Address book
6775 @cindex Address book Definition
6777 @cindex Alias, Address
6779 The file @file{~/.addresses} is a simple address book for Wanderlust.
6780 Make address file @file{~/.addresses}, and edit to suit your requirement.
6782 The data written in @file{~/.addresses} are used for address completion
6783 under draft editing mode. Furthermore, they are used when showing names
6784 in summary display mode. You can safely skip this section, if you don't
6785 want to customize address completion and summary display.
6786 It is possible to add/change/remove addresses from @file{~/.addresses} in
6787 summary buffer after Wanderlust is invoked. @refill
6789 The format is very simple. Like this. @refill
6794 # @r{Lines begin with @samp{#} are comment.}
6795 # @r{Empty lines are ignored}
6797 # @r{Format of each line:}
6798 # @var{email-address} "@var{nickname} "@var{realname}"
6800 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6801 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6802 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6807 One line defines one persons description.
6809 Actually, in default setup, @var{nickname} is used in summary-mode and
6810 @var{realname} is used in draft preparation mode. This behavior is
6811 better understood if you try it and confirmed the function first. You
6812 can write and try a small definition, so you will know the idea of the
6813 address book before writing a big one.
6815 And, if MH alias file is specified in variable @code{wl-alias-file},
6816 it is used as an address information in the draft preparation mode.
6818 If variable @code{wl-use-ldap} is non-nil (initial setting is
6819 @code{nil}), address completion in draft mode uses LDAP information.
6821 If you use LDAP, you have to set @code{wl-ldap-server},
6822 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6823 not have LDAP feature as built-in feature (Currently only XEmacs can
6824 have built-in LDAP feature), you have to set command exec @env{PATH} to
6825 the program @command{ldapsearch}.
6828 @node Address Manager, , Mail Addresses, Address Book
6829 @section Address Manager
6830 @cindex Address Manager
6832 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6833 the address book and insert address to draft buffer.
6835 @subsection Key Bindings
6839 @kindex t (Address Manager)
6840 @findex wl-addrmgr-set-to
6841 Add @samp{To:} mark.
6844 @kindex c (Address Manager)
6845 @findex wl-addrmgr-set-cc
6846 Add @samp{Cc:} mark.
6849 @kindex b (Address Manager)
6850 @findex wl-addrmgr-set-bcc
6851 Add @samp{Bcc:} mark.
6854 @kindex u (Address Manager)
6855 @findex wl-addrmgr-unmark
6859 @kindex x (Address Manager)
6860 @findex wl-addrmgr-apply
6862 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6863 buffer and quit address manager. When no draft buffer, make new draft
6864 with insert marked addresses.
6866 If no mark, quit address manager.
6870 @kindex q (Address Manager)
6871 @findex wl-addrmgr-quit
6872 Quit address manager.
6875 @kindex a (Address Manager)
6876 @findex wl-addrmgr-add
6880 @kindex d (Address Manager)
6881 @findex wl-addrmgr-delete
6885 @kindex e (Address Manager)
6886 @findex wl-addrmgr-edit
6891 @node Spam Filter, Batch Processing, Address Book, Top
6892 @chapter Spam Filter
6895 @code{wl-spam} provides an frontend to external spam filtering programs.
6896 You can register to or judge spam by the filtering program cooperateing
6897 with messages operations on Wanderlust.
6900 * Usage of Spam Filter:: Usage of Spam Filter
6901 * Spam Filter Processors:: Supported spam filters
6904 @node Usage of Spam Filter, Spam Filter Processors, Spam Filter, Spam Filter
6905 @section Usage of Spam Filter
6907 @subsection Initial Setting
6909 To use @code{wl-spam}, write in @file{~/.wl} as follows:
6913 ;; @r{Use @samp{bogofilter} as spam back end}
6914 ;; @r{Set @samp{scheme} here as the spam filter you will use.}
6915 ;; @r{@xref{Spam Filter Processors}.}
6916 (setq elmo-spam-scheme 'bogofilter)
6921 @subsection spam mark
6923 The spam mark (@samp{s}) will be provided as new temporary mark.
6924 Messages marked by this will be refiled into @code{wl-spam-folder} when
6925 the action is called for execution. Marked messages will be skipped by
6926 summary walking in ordinary way.
6928 The spam mark is be put on by spam judgement described later, or by
6929 invoking @kbd{k m} at any time.
6931 @subsection spam judgment
6933 You can judge spam messages by following ways:
6937 Make judgement on execution of auto-refile.
6939 Insert @code{wl-refile-guess-by-spam} to arbitrary position in
6940 @code{wl-auto-refile-guess-functions} as follows.
6944 (setq wl-auto-refile-guess-functions
6945 '(wl-refile-guess-by-rule
6946 wl-refile-guess-by-spam))
6950 In this example, judge spam if it could not decide refile destination by
6951 @code{wl-refile-rule-alist}.
6954 Make judgement on entering the summary of specified folder.
6956 Specify the value of @code{wl-spam-auto-check-folder-regexp-list}
6957 as the list of regular expressions for folder names to be
6958 automatically judged by spam filter.
6961 (setq wl-spam-auto-check-folder-regexp-list '("\\+inbox"))
6964 In this example, judgement will be processed when you enter summary of
6965 the folder whose name contains @samp{+inbox}.
6968 Make judgement on splitting messages with @code{elmo-split}.
6970 It provides new function @code{spam-p} to be specified as @samp{CONDITION}
6971 in @code{elmo-split-rule}. This function returns true when the message
6973 @xref{Split messages}.
6975 You can also process learning by the result of judgement. (You would
6976 better turn on this feature after learning to some extent)
6982 (setq elmo-split-rule
6983 '(((spam-p) "+spam")
6984 ;; @r{to learn by the judgement, use following instead}
6985 ;((spam-p :register t) "+spam")
6991 @subsection spam learning
6993 @code{wl-spam} automatically learn spam with refiling messages.
6995 At first, @code{wl-spam} classifies the folders controlled by Wanderlust
6996 into following 4 domains by the class of containig messages
7000 Folders containing messages judged as spam.
7001 (The folder specified by @code{wl-spam-folder})
7003 Folders containing messages judged as non-spam.
7005 Folders containing messages not yet judged. Folders without
7006 pre-distribution may belong to this domain e.g. @samp{+inbox}.
7007 (specified by @code{wl-spam-undecided-folder-regexp-list})
7009 Foldes have nothing to do with spam processing e.g.
7010 @code{wl-trash-folder} or @code{wl-draft-folder}. (specified by
7011 @code{wl-spam-ignored-folder-regexp-list})
7014 When you refile messages across different domains, it automatically
7015 learn messages as @samp{spam} or @samp{non-spam} according to domains
7016 it belongs before and after.
7018 To put it concretely, it will learn by following rule:
7021 @item undecide -> spam
7024 learn as spam and cancel previous study as non-spam.
7025 @item undecide -> good
7028 learn as non-spam and cancel previous study as spam.
7031 It do not learn anything in other cases.
7033 @subsection Key Bindings
7034 @cindex Keybind, spam filter
7038 @kindex k m (Summary)
7039 @findex wl-summary-spam
7040 Put spam mark (@samp{s}) on current message.
7043 @kindex k c (Summary)
7044 @findex wl-summary-test-spam
7045 Test current message and put spam mark if judged as spam.
7048 @kindex k C (Summary)
7049 @findex wl-summary-mark-spam
7050 Test messages with the mark in @code{wl-spam-auto-check-marks},
7051 and put spam mark if judged as spam. If it is called with prefix
7052 argument, test all messages regardless of their marks.
7055 @kindex k s (Summary)
7056 @findex wl-summary-register-as-spam
7057 Register current message as spam.
7060 @kindex k S (Summary)
7061 @findex wl-summary-register-as-spam-all
7062 Register all messages in the folder as spam.
7065 @kindex k n (Summary)
7066 @findex wl-summary-register-as-good
7067 Register current message as non-spam.
7070 @kindex k N (Summary)
7071 @findex wl-summary-register-as-good-all
7072 Register all messages in the folder as non-spam.
7075 @kindex m k (Summary)
7076 @findex wl-summary-target-mark-spam
7077 Put spam mark (@samp{s}) on messages with the target mark @samp{*}.
7080 @kindex m s (Summary)
7081 @findex wl-summary-target-mark-register-as-spam
7082 Register messages with the target mark @samp{*} as spam.
7085 @kindex m n (Summary)
7086 @findex wl-summary-target-mark-register-as-good
7087 Register messages with the target mark @samp{*} as non-spam.
7090 @subsection Customizable Variables
7093 @item wl-spam-folder
7094 @vindex wl-spam-folder
7095 Specify the name of destination folder for the spam messages.
7096 The initial setting is @samp{+spam}.
7098 @item wl-spam-undecided-folder-regexp-list
7099 @vindex wl-spam-undecided-folder-regexp-list
7100 Specify the list of regexp of folder names which contain messages
7101 not yet decided as spam or non-spam.
7102 The initial setting is @code{'("inbox")}.
7104 @item wl-spam-ignored-folder-regexp-list
7105 @vindex wl-spam-ignored-folder-regexp-list
7106 The initial setting is as follows.
7110 (list (regexp-opt (list wl-draft-folder
7116 Folders of no effect against spam judgement, specified by the list of
7117 folder name regular expressions.
7119 @item wl-spam-auto-check-folder-regexp-list
7120 @vindex wl-spam-auto-check-folder-regexp-list
7121 Folders to make spam judgement on entering the summary of them,
7122 specified by the list of folder name regular expressions.
7123 The initial setting is @code{nil}.
7125 @item wl-spam-auto-check-marks
7126 @vindex wl-spam-auto-check-marks
7127 The initial setting is the following list:
7131 (list wl-summary-new-uncached-mark
7132 wl-summary-new-cached-mark)
7136 Messages with mark specified by this variable will be processed
7137 by whole-folder judgement including auto test by
7138 @code{wl-spam-auto-check-folder-regexp-list}.
7139 Persistent marks can be used in this method, but temporary marks cannot.
7141 You can specify the list of marks as the initial setting, or you can
7142 specify follwing symbol:
7146 Process all messages regardless of persistent marks.
7151 @node Spam Filter Processors, , Usage of Spam Filter, Spam Filter
7152 @section Supported Spam Filters
7153 @cindex Spam Filter, Bogofilter
7154 @cindex Spam Filter, Spamfilter
7156 Supported spam filtering libraries are following ones.
7159 * bogofilter:: bogofilter
7160 * spamfilter:: spamfilter.el
7161 * bsfilter:: bsfilter
7162 * SpamAssassin:: SpamAssassin
7163 * Regular Expressions Header Matching:: Header regexp
7167 @node bogofilter, spamfilter, Spam Filter Processors, Spam Filter Processors
7168 @subsection bogofilter
7171 bogofilter (@uref{http://bogofilter.sourceforge.net/}) is a spam filter
7172 implemented by C language.
7174 To use spam filter with bogofilter, write following setting in
7175 @file{~/.wl} or somewhere else.
7179 (setq elmo-spam-scheme 'bogofilter)
7183 @subsubsection Customizable Variables
7186 @item elmo-spam-bogofilter-program
7187 @vindex elmo-spam-bogofilter-program
7188 The initial setting is @file{bogofilter}.
7189 Specify the name of executable of bogofilter. If the executable
7190 is not in your environmental variable @env{PATH}, you should
7191 set this by full path.
7193 @item elmo-spam-bogofilter-args
7194 @vindex elmo-spam-bogofilter-args
7195 The initial setting is @code{nil}.
7196 Specify arguments to be supplied for bogofilter executable.
7198 @item elmo-spam-bogofilter-database-directory
7199 @vindex elmo-spam-bogofilter-database-directory
7200 Specify the directory for statistical database to be used.
7201 @code{nil} to use default directory (@file{~/.bogofilter}).
7202 The initial setting is @code{nil}.
7204 @item elmo-spam-bogofilter-max-messages-per-process
7205 @vindex elmo-spam-bogofilter-max-messages-per-process
7206 The initial setting is 30. This variable specifies the number of
7207 messages to be learned by one process.
7209 @item elmo-spam-bogofilter-debug
7210 @vindex elmo-spam-bogofilter-debug
7211 The initial setting is @code{nil}.
7212 If you specify non-nil, the output from @command{bogofilter} is
7213 stored in the buffer named @code{"*Debug ELMO SPAM Bogofilter*"}.
7217 @node spamfilter, bsfilter, bogofilter, Spam Filter Processors
7218 @subsection spamfilter.el
7221 @file{spamfilter.el}
7222 (@uref{http://www.geocities.co.jp/SiliconValley-PaloAlto/7043/}) is a
7223 spam filtering library implemented by Emacs Lisp.
7225 Corresponding modules will be compiled/installed, if you have
7226 @file{spamfilter.el} within @code{load-path} when you are to install wl.
7229 To use @file{spamfilter.el}, write following setting in @file{~/.wl} or
7231 (Of cource, you have to have settings for @file{spamfilter.el} itself)
7235 (setq elmo-spam-scheme 'spamfilter)
7239 @subsubsection Customizable Variables
7242 @item elmo-spam-spamfilter-corpus-filename
7243 @vindex elmo-spam-spamfilter-corpus-filename
7244 The initial setting is @file{~/.elmo/.spamfilter}.
7245 It specifies the name of corpus file.
7248 @node bsfilter, SpamAssassin, spamfilter, Spam Filter Processors
7249 @subsection bsfilter
7252 bsfilter (@uref{http://bsfilter.org/index-e.html}) is a spam filter
7253 implemented by Ruby language.
7255 To use spam filter with bsfilter, write following setting in
7256 @file{~/.wl} or somewhere else.
7260 (setq elmo-spam-scheme 'bsfilter)
7264 @subsubsection Customizable Variables
7267 @item elmo-spam-bsfilter-program
7268 @vindex elmo-spam-bsfilter-program
7269 The initial setting is @file{bsfilter}.
7270 Specify the name of executable of @command{bsfilter}. If the executable
7271 is not in your environmental variable @env{PATH}, you should
7272 set this by full path.
7274 @item elmo-spam-bsfilter-args
7275 @vindex elmo-spam-bsfilter-args
7276 The initial setting is @code{nil}.
7277 Specify arguments to be supplied for bsfilter executable.
7279 @item elmo-spam-bsfilter-database-directory
7280 @vindex elmo-spam-bsfilter-database-directory
7281 Specify the directory for statistical database to be used.
7282 @code{nil} to use default directory (@file{~/.bsfilter}).
7283 The initial setting is @code{nil}.
7285 @item elmo-spam-bsfilter-debug
7286 @vindex elmo-spam-bsfilter-debug
7287 The initial setting is @code{nil}.
7288 If you specify non-nil, the output from @command{bsfilter} is
7289 stored in the buffer named @code{"*Debug ELMO Bsfilter*"}.
7291 @item elmo-spam-bsfilter-shell-program
7292 @vindex elmo-spam-bsfilter-shell-program
7293 The initial setting is @file{ruby}.
7294 Specify the shell to execute @command{bsfilter}. If the shell is not
7295 in your environmental variable @env{PATH}, you should set this by full path.
7297 @item elmo-spam-bsfilter-shell-switch
7298 @vindex elmo-spam-bsfilter-shell-switch
7299 The initial setting is @code{nil}.
7300 Specify options to give to the shell executing @command{bsfilter}.
7302 @item elmo-spam-bsfilter-update-switch
7303 @vindex elmo-spam-bsfilter-update-switch
7304 The initial setting is @code{"--synchronous-auto-update"}.
7305 Specify options to give to @command{bsfilter} for learning messages.
7309 @node SpamAssassin, Regular Expressions Header Matching, bsfilter, Spam Filter Processors
7310 @subsection SpamAssassin
7311 @cindex SpamAssassin
7313 SpamAssassin (@uref{http://spamassassin.org/}) is one of the most
7314 popular spam filtering program implemented on Perl. SpamAssassin
7315 attempts to identify spam using text analysis and several internet-based
7316 realtime blacklists. SpamAssassin also uses a Bayesian learning filter
7317 which enables more accurate spam filtering.
7319 To use @file{SpamAssassin} on Wanderlust, write following setting
7320 in @file{~/.wl} or somewhere else.
7321 (Of course, you have to install SpamAssassin beforehand.)
7325 (setq elmo-spam-scheme 'sa)
7329 @subsubsection Customize Variables
7332 @item elmo-spam-spamassassin-program
7333 @vindex elmo-spam-spamassassin-program
7334 The initial setting is @file{spamassassin}.
7335 Specify the name of executable @command{spamassassin}. If the executable
7336 is not in your environmental variable @env{PATH}, you should
7337 set this by full path.
7339 @item elmo-spam-spamassassin-learn-program
7340 @vindex elmo-spam-spamassassin-learn-program
7341 The initial setting is @file{sa-learn}.
7342 Specify the name of the SpamAssassin's Bayesian filtering learner
7343 program, @command{sa-learn}. If the executable is not in your
7344 environmental variable @env{PATH}, you should set this by full path.
7346 @item elmo-spam-spamassassin-program-arguments
7347 @vindex elmo-spam-spamassassin-program-arguments
7348 The initial setting is @code{'("-e")}.
7349 Specify the arguments to be supplied for @command{spamassassin} executable.
7350 You have to specify the argument to exit the program with an error exit code
7351 when the result is spam. For example, if you want to use @command{spamc}
7352 instead of @command{spamassassin}, you should specify @code{'("-c")}.
7354 @item elmo-spam-spamassassin-learn-program-arguments
7355 @vindex elmo-spam-spamassassin-lern-program-arguments
7356 The initial setting is @code{nil}.
7357 Specify the arguments to be supplied for @command{sa-learn}.
7359 @item elmo-spamassassin-debug
7360 @vindex elmo-spamassassin-debug
7361 The initial setting is @code{nil}.
7362 If you specify @code{t}, the output from @command{spamassassin} is
7363 stored in the buffer named @code{"*Debug ELMO SpamAssassin*"}.
7367 @node Regular Expressions Header Matching, , SpamAssassin, Spam Filter Processors
7368 @subsection Regular Expressions Header Matching
7369 @cindex Regular Expressions Header Matching
7371 Examine if regular expression matches corresponding field in message heaeder,
7372 and decide spam or not. To use this backend, add following setting to @file{~/.wl}.
7376 (setq elmo-spam-scheme 'header)
7380 If you want to check fields not included in the default overview
7381 information, add one into @code{elmo-msgdb-extra-fields}. Then it will
7382 do examination by the overview information and avoid loading whole
7383 message body as far as possible.
7385 @subsubsection Customize Variables
7388 @item elmo-spam-header-good-alist
7389 @vindex elmo-spam-header-good-alist
7390 The initial setting is the following list:
7393 '(("X-Spam-Flag" . "No"))
7396 Specify a list of regular expressions to match with header field name
7397 for making non-spam decision. It takes precedence over
7398 @code{elmo-spam-header-spam-alist}.
7400 @item elmo-spam-header-spam-alist
7401 @vindex elmo-spam-header-spam-alist
7402 The initial setting is the following list:
7405 '(("X-Spam-Flag" . "Yes"))
7408 Specify a list of regular expressions to match with header field name
7409 for making spam decision.
7413 @node Batch Processing, Customization, Spam Filter, Top
7414 @chapter Batch Processing
7415 @cindex Batch Processing
7417 You can request wanderlust to do some job on the command line.
7418 For now, you can invoke prefetching new messages in specified folders.
7420 Specify target folders in @code{wl-batch-prefetch-folder-list} then
7421 invoke as follows to execute prefetching:
7425 % emacs -batch -l wl-batch -f wl-batch-prefetch
7429 @section Customize Variables
7432 @item wl-batch-prefetch-folder-list
7433 @vindex wl-batch-prefetch-folder-list
7434 Target folders of prefetching by @code{wl-batch-prefetch}, specified as
7435 a list of folder names.
7439 @node Customization, Migration, Batch Processing, Top
7440 @chapter Customizing Wanderlust
7441 @cindex Customization
7444 * Living with other packages:: Cooperating with other packages
7445 * Highlights:: Highlights
7446 * Biff:: Notify Mail arrival
7447 * Advanced Settings:: Advanced Settings
7448 * Customizable Variables:: Customizable Variables
7453 @node Living with other packages, Highlights, Customization, Customization
7454 @section Living with other packages
7456 Examples with other packages.
7459 * imput:: imput (im-wl.el)
7460 * BBDB:: The Insidious Big Brother Database
7461 * LSDB:: The Lovely Sister Database
7462 * supercite:: supercite.el
7463 * mu-cite:: mu-cite.el
7464 * X-Face:: x-face,bitmap-mule
7465 * dired-dd:: dired-dd.el
7467 * Addrbook:: Addrbook
7468 * mime-w3m:: mime-w3m.el
7472 @node imput, BBDB, Living with other packages, Living with other packages
7477 Place @file{util/im-wl.el} on the @code{load-path} and do the following
7482 (autoload 'wl-draft-send-with-imput-async "im-wl")
7483 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
7488 @node BBDB, LSDB, imput, Living with other packages
7492 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
7493 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
7494 and do the following settings.
7496 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
7497 byte-compiled and installed.
7505 ;; @r{enable pop-ups}
7506 (setq bbdb-use-pop-up t)
7507 ;; @r{auto collection}
7508 (setq bbdb/mail-auto-create-p t)
7509 ;; @r{exceptional folders against auto collection}
7510 (setq bbdb-wl-ignore-folder-regexp "^@@")
7511 (setq signature-use-bbdb t)
7512 (setq bbdb-north-american-phone-numbers-p nil)
7513 ;; @r{shows the name of bbdb in the summary} :-)
7514 (setq wl-summary-from-function 'bbdb-wl-from-func)
7515 ;; @r{automatically add mailing list fields}
7516 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
7517 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
7521 You can complete address with BBDB by @kbd{M-@key{TAB}}
7525 @node LSDB, supercite, BBDB, Living with other packages
7529 The following is an example setting to use
7530 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
7537 (add-hook 'wl-draft-mode-hook
7539 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
7543 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
7544 (complete address with LSDB).
7547 @node supercite, mu-cite, LSDB, Living with other packages
7548 @subsection sc.el(supercite), sc-register.el
7552 The same setting as usual mailers should be OK. The following is an
7553 example of settings:
7557 (autoload 'sc-cite-original "supercite" nil t)
7558 (add-hook 'mail-citation-hook 'sc-cite-original)
7563 @node mu-cite, X-Face, supercite, Living with other packages
7564 @subsection mu-cite.el
7567 The same setting as usual mailers should be OK. The following is an
7568 example of settings.
7570 If you use mu-cite version 8.0 or earlier:
7574 (autoload 'mu-cite/cite-original "mu-cite" nil t)
7575 (setq mail-citation-hook 'mu-cite/cite-original)
7579 If you use mu-cite version 8.1 or later:
7583 (autoload 'mu-cite-original "mu-cite" nil t)
7584 (add-hook 'mail-citation-hook (function mu-cite-original))
7588 @node X-Face, dired-dd, mu-cite, Living with other packages
7592 If you have installed one of the following, you can decode
7593 @samp{X-Face:} field in message buffer and you will see face image.
7596 * x-face-xmas:: XEmacs case
7597 * x-face-mule:: Emacs case
7600 If there is an encoded X-Face string in a file @file{~/.xface} (the
7601 value of the variable @code{wl-x-face-file}), it is inserted as a
7602 @samp{X-Face:} field in the draft buffer (if
7603 @code{wl-auto-insert-x-face} is non-nil).
7605 @node x-face-xmas, x-face-mule, X-Face, X-Face
7606 @subsubsection x-face-xmas (for XEmacs)
7609 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
7610 1.3.6.13 or later, do the following:
7614 (autoload 'x-face-xmas-wl-display-x-face "x-face")
7615 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
7619 @node x-face-mule, , x-face-xmas, X-Face
7620 @subsubsection x-face-mule (for Emacs)
7624 If you use @file{x-face-mule.el} in bitmap-mule
7625 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
7629 (autoload 'x-face-decode-message-header "x-face-mule")
7630 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7634 @subsubsection x-face-e21 (for Emacs 21.x)
7637 With Emacs 21.x, you can use @file{x-face-e21.el}
7638 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
7639 to display X-Face. In this case, bitmap-mule is not required.
7644 (autoload 'x-face-decode-message-header "x-face-e21")
7645 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7650 @node dired-dd, MHC, X-Face, Living with other packages
7651 @subsection dired-dd(Dired-DragDrop)
7652 @pindex Dired-DragDrop
7654 @cindex Drag and Drop
7656 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
7657 compose multi-part by simple Drag-and-Drop from dired to the draft
7658 buffer being edited in GNU Emacs (this feature is not Wanderlust
7659 specific, but general-purpose for SEMI).
7663 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
7669 ;; @r{Set dired-x variables here.}
7670 ;; @r{To and flo@dots{}}
7672 (progn (require 'dired-dd)
7673 (require 'dired-dd-mime))))))
7677 @node MHC, Addrbook, dired-dd, Living with other packages
7681 Message Harmonized Calendaring system
7682 (@uref{http://www.quickhack.net/mhc/})
7684 By using MHC, you can make a calendar from the messages.
7690 (setq mhc-mailer-package 'wl)
7691 (autoload 'mhc-mode "mhc" nil t)
7692 (add-hook 'wl-summary-mode-hook 'mhc-mode)
7693 (add-hook 'wl-folder-mode-hook 'mhc-mode)
7701 (autoload 'mhc-wl-setup "mhc-wl")
7702 (add-hook 'wl-init-hook 'mhc-wl-setup)
7706 @node Addrbook, mime-w3m, MHC, Living with other packages
7707 @subsection wl-addrbook.el
7711 (@uref{http://www.mew.org/})
7713 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
7714 @code{load-path} and do the following settings.
7718 (require 'wl-addrbook)
7723 @node mime-w3m, , Addrbook, Living with other packages
7724 @subsection mime-w3m.el
7727 You can display html part by using @file{mime-w3m.el}
7728 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
7729 You can find the usage in comment region at the head of @file{mime-w3m.el}.
7732 @node Highlights, Biff, Living with other packages, Customization
7735 @subsection Customizable Variables
7738 @item wl-summary-highlight
7739 @vindex wl-summary-highlight
7740 The initial setting is @code{t}.
7741 If non-nil, the summary is highlighted.
7743 @item wl-highlight-max-summary-lines
7744 @vindex wl-highlight-max-summary-lines
7745 The initial setting is 10000.
7746 The summary is not highlighted if it has more lines than this value.
7748 @item wl-summary-highlight-partial-threshold
7749 @vindex wl-summary-highlight-partial-threshold
7750 The initial setting is 1000.
7751 This is a threshold whether the whole summary is highlighted.
7752 If there are more lines of messages in the summary, it is partially
7755 @item wl-summary-partial-highlight-above-lines
7756 @vindex wl-summary-partial-highlight-above-lines
7757 The initial setting is 30. If there are more lines of messages than
7758 @code{wl-summary-highlight-partial-threshold} in the summary, messages
7759 after the point that is the same number of lines as this value above the
7760 cursor line are highlighted partially. (If this value is @code{nil},
7761 the last same number of lines as the value of
7762 @code{wl-summary-highlight-partial-threshold} are highlighted.)
7764 @item wl-highlight-body-too
7765 @vindex wl-highlight-body-too
7766 The initial setting is @code{t}.
7767 If non-nil, bodies of drafts and messages are also highlighted.
7769 @item wl-highlight-message-header-alist
7770 @vindex wl-highlight-message-header-alist
7771 When highlighting headers of drafts and messages, this variable
7772 specifies which faces are allocated to important
7773 (@code{wl-highlight-message-important-header-contents}), secondly
7774 important (@code{wl-highlight-message-important-header-contents2}), and
7775 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7777 Similarly, it can be used for allocating arbitrary faces to arbitrary
7778 regular expressions.
7780 @item wl-highlight-citation-prefix-regexp
7781 @vindex wl-highlight-citation-prefix-regexp
7782 Specifies a regular expression to which quoted lines in bodies of
7783 drafts and messages match.
7784 Bodies matching to this regular expression are highlighted by the faces
7785 specified by (@code{wl-highlight-message-cited-text-*}).
7787 @item wl-highlight-highlight-citation-too
7788 @vindex wl-highlight-highlight-citation-too
7789 The initial setting is @code{nil}.
7790 If non-nil, the quoting regular expression itself given by
7791 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7793 @item wl-highlight-citation-header-regexp
7794 @vindex wl-highlight-citation-header-regexp
7795 Specifies a regular expression that denotes beginning of quotation.
7796 Bodies matching to this regular expression are highlighted by the face
7797 specified by @code{wl-highlight-message-headers}.
7799 @item wl-highlight-max-header-size
7800 @vindex wl-highlight-max-header-size
7801 The initial setting is @code{nil}. If a header size is larger than this
7802 value, it will not be highlighted. If @code{nil}, always highlighted
7803 (ignore header size).
7805 @item wl-highlight-max-message-size
7806 @vindex wl-highlight-max-message-size
7807 The initial setting is 10000.
7808 If a message is larger than this value, it will not be highlighted.
7809 With this variable, highlight is suppressed for uuencode or huge digest
7812 @item wl-highlight-signature-separator
7813 @vindex wl-highlight-signature-separator
7814 Specifies regular expressions that denotes the boundary of a signature.
7815 It can be a regular expression, or a list of ones.
7816 Messages after the place that matches this regular expression are
7817 highlighted by the face specified by
7818 @code{wl-highlight-message-signature}.
7820 @item wl-max-signature-size
7821 @vindex wl-max-signature-size
7822 The initial setting is 400.
7823 This is the largest size for a signature to be highlighted.
7825 @item wl-use-highlight-mouse-line
7826 @vindex wl-use-highlight-mouse-line
7827 The initial setting is @code{t}.
7828 If non-nil, the line pointed by the mouse is highlighted in the folder
7829 mode, summary mode, and the like.
7832 @subsection Setting Colors and Fonts of the Characters
7834 If you want to change colors or fonts of the characters, you need to
7835 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7836 want to change fonts, and @code{set-face-foreground} for colors, and so
7837 on. You cannot write face settings in @file{.emacs}; write in
7840 For example, if you want to change the color for signatures to yellow,
7844 (set-face-foreground 'wl-highlight-message-signature "yellow")
7850 Faces defined in Wanderlust:
7853 @item wl-highlight-message-headers
7854 The face for field names of message headers.
7856 @item wl-highlight-message-header-contents
7857 The face for field bodies of message headers.
7859 @item wl-highlight-message-important-header-contents
7860 The face for important parts of message headers.
7861 Per default, this face is used for a body of @samp{Subject:} field.
7862 You can change its value by editing
7863 @code{wl-highlight-message-header-alist}.
7865 @item wl-highlight-message-important-header-contents2
7866 The face for secondly important parts of message headers.
7867 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7868 fields. You can change its value by editing
7869 @code{wl-highlight-message-header-alist}.
7871 @item wl-highlight-message-unimportant-header-contents
7872 The face for unimportant parts of message headers.
7873 Per default, this face is used for bodies of @samp{X-} fields
7874 @samp{User-Agent:} fields. You can change its value by editing
7875 @code{wl-highlight-message-header-alist}.
7877 @item wl-highlight-message-citation-header
7878 The face for headers of quoted messages.
7880 @item wl-highlight-message-cited-text-*
7881 The face for texts of quoted messages. The last @samp{*} is a
7882 @var{single figure} so that 10 different colors can be used according to
7885 @item wl-highlight-message-signature
7886 The face for signatures of messages. The initial settings are
7887 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7888 dark background colors.
7890 @item wl-highlight-header-separator-face
7891 The face for header separators of draft messages.
7893 @item wl-highlight-summary-important-face
7894 The face for message lines with important marks in the summary.
7896 @item wl-highlight-summary-new-face
7897 The face for message lines with new marks in the summary.
7899 @item wl-highlight-summary-displaying-face
7900 The face for the message line that is currently displayed.
7901 This face is overlaid.
7903 @item wl-highlight-thread-indent-face
7904 The face for the threads that is currently displayed.
7906 @item wl-highlight-summary-unread-face
7907 The face for message lines with unread marks in the summary.
7909 @item wl-highlight-summary-deleted-face
7910 The face for message lines with delete marks in the summary.
7912 @item wl-highlight-summary-refiled-face
7913 The face for message lines with re-file marks in the summary.
7915 @item wl-highlight-refile-destination-face
7916 The face for re-file information part of message lines with re-file
7917 marks in the summary.
7919 @item wl-highlight-summary-copied-face
7920 The face for message lines with copy marks in the summary.
7922 @item wl-highlight-summary-target-face
7923 The face for message lines with target marks @samp{*} in the summary.
7925 @item wl-highlight-summary-thread-top-face
7926 The face for message lines that are on the top of the thread in the
7929 @item wl-highlight-summary-normal-face
7930 The face for message lines that are not on top of the thread in the
7933 @item wl-highlight-folder-unknown-face
7934 The face for folders that are not known to have how many unsync messages
7937 @item wl-highlight-folder-zero-face
7938 The face for folders that have no unsync messages in the folder mode.
7940 @item wl-highlight-folder-few-face
7941 The face for folders that have some unsync messages in the folder mode.
7943 @item wl-highlight-folder-many-face
7944 The face for folders that have many unsync messages in the folder mode.
7945 The boundary between `some' and `many' is specified by the variable
7946 @code{wl-folder-many-unsync-threshold}.
7948 @item wl-highlight-folder-unread-face
7949 The face for folders that have no unsync but unread messages in the
7952 @item wl-highlight-folder-killed-face
7953 The face for folders that are deleted from the access group in the
7956 @item wl-highlight-folder-opened-face
7957 The face for open groups in the folder mode.
7958 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7959 @code{nil} or a @var{number}.
7961 @item wl-highlight-folder-closed-face
7962 The face for close groups in the folder mode.
7963 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7964 @code{nil} or a @var{number}.
7966 @item wl-highlight-folder-path-face
7967 The face for the path to the currently selected folder in the folder
7970 @item wl-highlight-logo-face
7971 The face for logo in the demo.
7973 @item wl-highlight-demo-face
7974 The face for strings (for example, a version number) in the demo.
7978 @node Biff, Advanced Settings, Highlights, Customization
7979 @section Notify Mail arrival
7982 Following setting is to notify mail arrival of @samp{%inbox}
7983 by the indicator on the modeline
7986 (setq wl-biff-check-folder-list '("%inbox"))
7989 @subsection Customizable Variables
7991 @item wl-biff-check-folder-list
7992 @vindex wl-biff-check-folder-list
7993 The initial setting is @code{nil}.
7994 This is the list of folders to check mail arrival.
7995 If @code{nil}, wl doesn't check mail arrival.
7997 @item wl-biff-check-interval
7998 @vindex wl-biff-check-interval
7999 The initial setting is 40 (in seconds).
8000 Check mail arrival in this period.
8002 @item wl-biff-notify-hook
8003 @vindex wl-biff-notify-hook
8004 This hook is run at the arrival of new mail.
8005 To beep with mail arrival(initial setting), set as follows.
8007 (setq wl-biff-notify-hook '(ding))
8009 For silence, set to @code{nil}.
8013 @node Advanced Settings, Customizable Variables, Biff, Customization
8014 @section Advanced Settings
8017 * Draft for Reply:: Draft for Reply
8018 * Thread Format:: Appearance of Thread
8019 * User-Agent Field:: @samp{User-Agent:} Header Field
8023 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
8024 @subsection Draft for Replay
8025 @vindex wl-draft-reply-with-argument-list
8026 @vindex wl-draft-reply-without-argument-list
8028 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
8029 The addressee for the draft is decided by following rules.
8031 For example, you can set as follows:
8035 (setq wl-draft-reply-without-argument-list
8036 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8037 ("Followup-To" . (nil nil ("Followup-To")))
8038 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8039 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
8043 Where each element of the list @code{wl-draft-reply-without-argument-list}
8047 (key . (to-list cc-list newsgroup-list))
8050 and if the field designated by @samp{key} exist in the parent message,
8051 parent's field values designated by @samp{to-list} are copied to @samp{To:}
8052 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
8053 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
8054 the draft respectively.
8059 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8062 Match if the parent has @samp{Mail-Followup-To} field.
8063 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
8064 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
8068 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8071 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
8072 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
8075 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
8078 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
8079 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
8082 These are evaluated in order and first matched one is used.
8084 Moreover, the behavior of @kbd{a} with prefix argument can
8085 be directed by @code{wl-draft-reply-with-argument-list} as well.
8088 By the way, you can use some function (will be evaluated in the parent
8089 message buffer) in the place of @samp{key} or @samp{to-list} etc.
8091 If you want to write a rule for replying to message written by yourself,
8092 specify function @code{wl-draft-self-reply-p} as @samp{key}.
8094 If you only want to reply to mailing lists in
8095 @code{wl-subscribed-mailing-list} if the parent has some of them,
8100 (defun wl-mailing-list-addresses ()
8104 (nth 1 (std11-extract-address-components addr)))
8107 (elmo-multiple-fields-body-list (list "To" "Cc"))
8109 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
8110 (setq list-addrs (cons to list-addrs))))
8111 (nreverse list-addrs)))
8113 (setq wl-draft-reply-with-argument-list
8114 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
8115 ("Reply-To" . (("Reply-To") nil nil))
8116 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
8117 ("From" . (("From") nil nil))))
8122 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
8123 @subsection Appearance of Threads
8127 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
8128 390 09/18(Fri)07:25 +-[ Tsumura-san ]
8129 391 09/18(Fri)19:24 +-[ Murata-san ]
8130 392 09/20(Sun)21:49 +-[ Okunishi-san ]
8131 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
8132 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
8133 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
8134 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
8135 412 09/22(Tue)09:28 | +-[ Teranishi ]
8136 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
8137 416 09/22(Tue)12:38 | +-[ Teranishi ]
8138 395 09/20(Sun)21:49 +-[ Okunishi-san ]
8139 397 09/21(Mon)00:15 +-[ Okunishi-san ]
8143 Settings to make appearance of threads like shown above:
8147 (setq wl-thread-indent-level 2)
8148 (setq wl-thread-have-younger-brother-str "+")
8149 (setq wl-thread-youngest-child-str "+")
8150 (setq wl-thread-vertical-str "|")
8151 (setq wl-thread-horizontal-str "-")
8152 (setq wl-thread-space-str " ")
8156 If you do not want to see branches, do the following:
8160 (setq wl-thread-indent-level 2)
8161 (setq wl-thread-have-younger-brother-str " ")
8162 (setq wl-thread-youngest-child-str " ")
8163 (setq wl-thread-vertical-str " ")
8164 (setq wl-thread-horizontal-str " ")
8165 (setq wl-thread-space-str " ")
8170 @node User-Agent Field, , Thread Format, Advanced Settings
8171 @subsection User-Agent Field
8175 If you are eccentric enough to elaborate @samp{X-Mailer:} or
8176 @samp{User-Agent:} fields, define a function that generate appropriate
8177 strings as you like, and set it to variable
8178 @code{wl-generate-mailer-string-function}.
8180 If you do not want verbose @samp{User-Agent:} field, do the following:
8184 (setq wl-generate-mailer-string-function
8185 'wl-generate-user-agent-string-1)
8189 The following is a example:
8193 (setq wl-generate-mailer-string-function nil)
8194 (setq wl-draft-additional-header-alist
8196 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
8201 @node Customizable Variables, Hooks, Advanced Settings, Customization
8202 @section Customizable Variables
8204 Customizable variables that have not been described yet:
8207 @item wl-default-folder
8208 @vindex wl-default-folder
8209 The initial setting is @samp{%inbox}. This is the default value for moving to
8210 a folder and the like.
8212 @item wl-draft-folder
8213 @vindex wl-draft-folder
8214 The initial setting is @samp{+draft}. It is the folder to which drafts are
8215 saved. It must be a writable folder.
8216 Note that variable settings applied by @code{wl-draft-config-exec} is saved
8217 under @code{elmo-msgdb-directory}. That is to say, if you specified remote
8218 folder as @code{wl-draft-folder}, variable settings which are applied by
8219 @code{wl-draft-config-exec} before saving the draft will not affect on the
8220 draft buffer on another host by invoking @code{wl-summary-reedit}.
8222 @item wl-trash-folder
8223 @vindex wl-trash-folder
8224 The initial setting is @samp{+trash}. It is the wastebasket folder.
8225 If you changed this variable, you had better restart Wanderlust.
8227 @item wl-interactive-exit
8228 @vindex wl-interactive-exit
8229 The initial setting is @code{t}.
8230 If non-nil, you are asked for confirmation when Wanderlust terminates.
8232 @item wl-interactive-send
8233 @vindex wl-interactive-send
8234 The initial setting is @code{t}.
8235 If non-nil, you are asked for confirmation when mail is sent.
8237 @item wl-default-sync-range
8238 @vindex wl-default-sync-range
8239 The initial setting is @samp{update}.
8240 Default update range of the summary. You can specify
8241 @samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
8242 See description of @code{wl-summary-sync} for the meaning of ranges.
8244 @item wl-folder-sync-range-alist
8245 @vindex wl-folder-sync-range-alist
8246 The initial setting is the alist shown below:
8251 ("^\\+draft$\\|^\\+queue$" . "all"))
8256 This is an associative list of regular expressions of folder names and
8257 update range of the summary. Update range is one of the @samp{all},
8258 @samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
8259 match any of them, the value of @code{wl-default-sync-range} is used
8260 (@samp{update} by default).
8261 See description of @code{wl-summary-sync} for the meaning of ranges.
8264 @vindex wl-ask-range
8265 The initial setting is @code{t}.
8266 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
8267 for updating the summary when you changed folders.
8269 @item wl-mime-charset
8270 @vindex wl-mime-charset
8271 The initial setting is @code{x-ctext}.
8272 This is the MIME charset for messages that are not MIME (e.g. without
8273 @samp{Content-Type:}). This value also used as default charset for
8274 summary. (If you want to share Summary on Nemacs and other Emacsen, set
8275 this value as @code{iso-2022-jp}.)
8277 @item wl-highlight-folder-with-icon
8278 @vindex wl-highlight-folder-with-icon
8279 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
8280 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
8282 @item wl-strict-diff-folders
8283 @vindex wl-strict-diff-folders
8284 This is a list of regular expressions of folders.
8285 Unread messages are checked, for example when you press @kbd{s} in
8286 the folder mode, usually in a brief way (rapidly processed but not
8288 The folders matching this variable are seriously checked.
8289 You may want to set this variable so as to match conditional filter
8290 folders for IMAP4 folders.
8291 The initial setting is @code{nil}.
8293 @item wl-folder-use-server-diff
8294 @vindex wl-folder-use-server-diff
8295 When unread messages are checked, for example when you press @kbd{s} in
8296 the folder mode, usually (the number of messages on the server) @minus{}
8297 (the number of local messages) will be the number of unread messages.
8298 However, if this variable is non-nil, the number of unread messages on
8299 the server is checked. This affects IMAP4 folders only, but IMAP4
8300 folders in mail boxes matching
8301 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
8302 the number of unread messages on the server, even if they matches this
8303 variable. The initial setting is @code{t}.
8305 @item wl-auto-check-folder-name
8306 @vindex wl-auto-check-folder-name
8307 The initial setting is @code{nil}.
8308 You can specify a folder or a group which is checked for unread message
8309 at the start. You can also specify a list of folders (groups) to be checked.
8310 If the value is @code{nil}, whole Desktop is checked at the start.
8311 If it is @code{none}, no folders are checked.
8313 @item wl-auto-uncheck-folder-list
8314 @vindex wl-auto-uncheck-folder-list
8315 The initial setting is the list shown below:
8324 You can set a list of regular expressions to specify folders
8325 which are not automatically checked even if they are included
8326 in some groups assigned by @code{wl-auto-check-folder-name}.
8328 @item wl-auto-check-folder-list
8329 @vindex wl-auto-check-folder-list
8330 The initial setting is @code{nil}.
8331 You can set a list of regular expressions to specify exceptions
8332 for @code{wl-auto-uncheck-folder-list}.
8334 @item wl-no-save-folder-list
8335 @vindex wl-no-save-folder-list
8336 The initial setting is the list shown below:
8345 This is a list of regular expressions of folders not to be saved.
8347 @item wl-save-folder-list
8348 @vindex wl-save-folder-list
8349 The initial setting is @code{nil}.
8350 This is a list of regular expressions of folders to be saved.
8351 This takes precedence over @code{wl-no-save-folder-list}.
8353 @item wl-folder-mime-charset-alist
8354 @vindex wl-folder-mime-charset-alist
8355 The initial setting is the alist shown below:
8359 (("^-alt\\.chinese" . big5)
8360 ("^-relcom\\." . koi8-r)
8362 ("^-han\\." . euc-kr))
8367 This is an associative list of regular expressions of folder names and
8369 If a folder do not match, @code{wl-mime-charset} is used.
8371 @item wl-folder-init-load-access-folders
8372 @vindex wl-folder-init-load-access-folders
8373 The initial setting is @code{nil}.
8374 This is a list of access groups to be loaded specifically at the start.
8375 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
8377 @item wl-folder-init-no-load-access-folders
8378 @vindex wl-folder-init-no-load-access-folders
8379 The initial setting is @code{nil}.
8380 This is a list of access groups not to be loaded specifically at the
8382 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
8384 @item wl-dispose-folder-alist
8385 @vindex wl-dispose-folder-alist
8386 The initial setting is the alist shown below:
8396 This list determines disposition of messages with disposal marks.
8397 Each item in the list is a folder and destination; you can specify any
8398 one of the following in the place of destination:
8401 @code{remove} or @code{null} : deletes the messages instantly.
8402 string : moves the messages to the specific folder.
8403 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
8406 @item wl-x-face-file
8407 @vindex wl-x-face-file
8408 The initial setting is @file{~/.xface}.
8409 The name of the file that contains encoded X-Face strings.
8412 @item wl-demo-display-logo
8413 @vindex wl-demo-display-logo
8414 If non-nil, bitmap image is shown on the opening demo. If you set
8415 @code{xpm} or @code{xbm}, (if possible) display selected image type
8418 @item elmo-use-database
8419 @vindex elmo-use-database
8420 This is meaningful for XEmacs only. The initial setting depends on
8421 XEmacs (@code{t} for XEmacs with dbm).
8422 If non-nil, Message-ID is controlled by dbm.
8424 @item elmo-passwd-alist-file-name
8425 @vindex elmo-passwd-alist-file-name
8426 The initial setting is @file{passwd}.
8427 This is the name of the file in which passwords are saved.
8428 @code{elmo-passwd-alist-save} saves current passwords to the file.
8430 @item elmo-nntp-list-folders-use-cache
8431 @vindex elmo-nntp-list-folders-use-cache
8432 The initial setting is 600 (in seconds).
8433 This is period in seconds during which results of @samp{list} and
8434 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
8437 @item elmo-nntp-max-number-precedes-list-active
8438 @vindex elmo-nntp-max-number-precedes-list-active
8439 The initial setting is @code{nil}.
8440 If non-nil, the number of article obtained by @samp{list active} in NNTP
8441 are used as the maximum article number of the folder.
8442 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
8443 and if the number of read messages is not correct.
8445 @item elmo-nntp-default-use-listgroup
8446 @vindex elmo-nntp-default-use-listgroup
8447 The initial setting is @code{t}.
8448 If non-nil, @samp{listgroup} is used for checking the total number of
8449 articles. If it is @code{nil}, @samp{group} is used. In the latter
8450 case, the processing will be a little faster at the sacrifice of
8453 @item elmo-pop3-send-command-synchronously
8454 @vindex elmo-pop3-send-command-synchronously
8455 The initial setting is @code{nil}.
8456 If non-nil, POP3 commands are issued synchronously. Some implementation
8457 of POP3 server fails to get summary information without this setting.
8458 You may have to set this variable to @code{t}, if the process hangs
8459 while looking up POP3.
8461 @item elmo-dop-flush-confirm
8462 @vindex elmo-dop-flush-confirm
8463 The initial setting is @code{t}.
8464 If non-nil, you are asked for confirmation if accumulated off-line
8465 operations are executed.
8467 @item elmo-display-progress-threshold
8468 @vindex elmo-display-progress-threshold
8469 The initial setting is 20.
8470 Threshold for display of progress gauge. If number of renewal is more than
8471 this value, display progress gauge.
8475 @node Hooks, , Customizable Variables, Customization
8481 @node Migration, Terminology, Customization, Top
8482 @chapter Switch from older version of Wanderlust
8485 @node Terminology, Mailing List, Migration, Top
8486 @chapter Terminology around Wanderlust
8489 Here we explain terminologies used in this manual.
8493 A container in which messages are stored.
8496 A set consists of some folders.
8499 A special group consists of automatically collected folders under
8500 some specified path.
8501 @xref{Folder Definition}.
8503 @item summary buffer
8504 A buffer for displaying list of messages in some folder.
8506 @item sticky summary
8507 Compared with ordinary summary buffer which will be destroyed after
8508 exiting from it, this type of summary will be remain even after exiting
8509 by @kbd{q} or @kbd{g}.
8510 @xref{Sticky Summary}.
8513 To delete or put into the archive expired messages.
8520 To cache messages beforehand in order to read messages after you will be
8521 disconnected from the server.
8525 @node Mailing List, Addition, Terminology, Top
8526 @chapter Wanderlust Mailing List
8530 Topics related to Wanderlust are discussed in following mailing lists.
8531 The latest version is also announced there.
8534 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
8537 In this list Japanese is mainly used for discussion. We also have a list
8538 for discussion in English:
8541 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
8543 (Messages posted to this list are also forwarded to the former one.)
8545 A guide can be obtained automatically by sending mail to
8546 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
8547 the English one) with the body
8553 Please send bug reports or patches to one of those lists. You can post to
8554 the mailing list even though you are not a member of it.
8556 If you send a bug report, please attach Backtrace with it.
8557 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
8560 I would like to express my thanks to the members of the mailing list for
8561 valuable advice and many pieces of code they contributed.
8565 You can read messages posted to the mailing list on the web or in
8568 Read messages posted to @t{<wl@@lists.airs.net>}
8571 @uref{http://lists.airs.net/wl/archive/}
8572 @uref{news://gmane.mail.wanderlust.general.japanese@@news.gmane.org}
8575 Read messages posted to @t{<wl-en@@lists.airs.net>}
8578 @uref{http://lists.airs.net/wl-en/archive/}
8579 @uref{news://gmane.mail.wanderlust.general@@news.gmane.org}
8583 @node Addition, Index, Mailing List, Top
8584 @chapter Additional Information
8586 @section Brief History
8589 1998 3/05 Tried to make a prototype that displays MH messages in threads.
8590 3/10 Made a msgdb mechanism by elisp.
8591 3/26 IMAP and NNTP can be displayed in threads.
8592 4/13 Began to assemble thread display modules as elmo.
8593 5/01 Finished 0.1.0, initial version with many defects.
8594 6/12 I made a slip of the tongue and said I was writing elisp
8595 mailer supporting IMAP
8596 6/16 0.1.3 was announced at tm-ja, elisp ML.
8597 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
8598 7/01 Support for mm-backend (0.3.0).
8599 8/25 multi folder added (0.5.0).
8600 8/28 filter folder added (0.5.1).
8601 9/10 You can open/close threads (0.6.0).
8602 9/11 fldmgr by Murata-san made editing folders easy.
8603 9/18 lha folders added by Okunishi-san (0.6.3).
8604 9/24 Display of branches of threads (0.6.5).
8605 9/28 Compression folder supporting multiple archivers by Okunishi-san.
8606 10/28 Off-line operations (0.7.4).
8607 12/09 Becomes beta version.
8608 12/21 wl-expire by Murata-san.
8609 1999 2/03 auto-refile by Tsumura-san.
8610 4/28 wl-template by Murata-san.
8611 5/18 Released 1.0.0 stable.
8612 7/05 Scoring by Murata-san (2.1.0).
8613 9/26 New plugged system by Murata-san (2.2.2).
8614 12/20 Support Modified UTF7.
8615 2000 3/24 Released 1.1.0 stable.
8616 4/03 CVS development started.
8617 5/07 Thread restoration & Its speed up with Murata-san.
8618 6/12 Address completion with LDAP with Chiba-san & Goto-san.
8619 7/11 killed message feature.
8620 7/18 Use UIDL in POP3.
8621 9/12 biff feature with Satata-san & Yamaoka-san.
8622 10/17 expire-hide by Okada-san.
8623 11/08 Released 2.4.0 stable.
8624 2001 7/04 Released 2.6.0 stable.
8625 8/21 wl-addrmgr by Kitamoto-san.
8626 12/27 Released 2.8.1 stable.
8627 2002 12/11 Released 2.10.0 stable.
8630 See @file{ChangeLog} for details.
8634 According to a dictionary, Wanderlust has the meaning:
8638 n eager longing for or impulse towards travelling in distant lands
8639 [Ger, fr wandern to wander + lust desire, pleasure]
8643 but I had no profound intention. (if farfetched, IMAP @result{} you can
8644 read mail anywhere @result{} desire to wander ?)
8646 Elmo is the abbreviation of @samp{Elisp Library for Message
8647 Orchestration}. At first I meant the red puppet in the Sesame Street,
8648 but you may associate it with Wandering @result{} Drifting @result{}
8649 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
8653 Each versions has code names (they are almost jokes).
8654 Currently they are picked up alphabetically from the top 40 hits of
8655 U.S. Billboard magazines in 1980s.
8657 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
8660 @node Index, , Addition, Top
8664 * Concept Index:: Concept Index
8665 * Key Index:: Key Index
8666 * Variable Index:: Variable Index
8667 * Function Index:: Function Index
8670 @node Concept Index, Key Index, Index, Index
8671 @unnumberedsec Concept Index
8674 @node Key Index, Variable Index, Concept Index, Index
8675 @unnumberedsec Key Index
8678 @node Variable Index, Function Index, Key Index, Index
8679 @unnumberedsec Variable Index
8682 @node Function Index, , Variable Index, Index
8683 @unnumberedsec Function Index