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 * Customization:: Customizing Wanderlust
124 * Terminology:: Terminologies
125 * Mailing List:: Wanderlust mailing list
126 * Addition:: Additional Information
131 @node Introduction, Start Me Up, Top, Top
132 @chapter Introduction of Wanderlust
135 Wanderlust is an mail/news management system on Emacsen.
136 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
138 The main features of Wanderlust:
141 @item Pure elisp implementation.
142 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
143 @item Unified access method to messages based on Mew-like Folder Specification.
144 @item Mew-like Key-bind and mark handling.
145 @item Manages unread messages.
146 @item Interactive thread display.
147 @item Folder Mode shows the list of subscribed folders.
148 @item Message Cache, Disconnected Operation (Read Only).
149 @item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed).
150 @item MIME compliant (by SEMI).
151 @item Transmission of news and mail are unified by Message transmitting draft.
152 @item Graphical list of folders (XEmacs and Emacs 21).
153 @item View a part of message without retrieving the whole message (IMAP4).
154 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
155 @item Virtual Folders.
156 @item Supports compressed folder using common archiving utilities.
157 @item Old articles in folders are automatically removed/archived (Expiration).
158 @item Automatic re-file.
159 @item Template function makes it convenient to send fixed form messages.
165 We confirm Wanderlust works on following Emacsen:
168 @item Mule 2.3 based on Emacs 19.34
169 @item Emacs 20.2 or later
170 @item XEmacs 20.4 or later
171 @item Meadow 1.00 or later
172 @item NTEmacs 20.4 or later
176 IMAP4 connectivity with following imapd are confirmed to work with
180 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
181 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
182 @item Courier-IMAP 1.3.2 or later
183 @item AIR MAIL (AIRC imapd release 2.00)
185 @item Microsoft Exchange Server 5.5
186 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
189 LDAP connectivity with following LDAPd are confirmed to work with
193 @item OpenLDAP 2.0.6 or later
197 @node Start Me Up, Folders, Introduction, Top
198 @chapter Start up Wanderlust
201 The necessary procedure for starting Wanderlust is explained in steps
204 (Of course, you need a mail/news readable environment in advance)
207 * MIME Modules:: Installing the MIME modules
208 * Download:: Download and extract the packages
209 * Install:: Byte-compile and install
210 * Minimal Settings:: @file{.emacs} setup
211 * Folder Definition:: Folder definition
212 * Start Wanderlust:: Starting Wanderlust
213 * Overview:: Basic components of Wanderlust
217 @node MIME Modules, Download, Start Me Up, Start Me Up
218 @section Installing MIME modules
224 You must install SEMI beforehand to use Wanderlust.
226 SEMI can be downloaded from following site:
230 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
234 You need packages named APEL and FLIM to use SEMI.
235 You can download APEL and FLIM from following URLs:
239 APEL: ftp://ftp.m17n.org/pub/mule/apel/
240 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
244 You have to install APEL, FLIM and SEMI in this order. Generally,
245 @samp{make install} will do the job. (In XEmacs 21, @samp{make
248 Refer to the documents of each package for detailed installation
249 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
250 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
254 Recommended combination of APEL, FLIM and SEMI are following:
257 @item APEL 10.5, FLIM 1.14.5 and SEMI 1.14.5
260 You can also use many other FLIM/SEMI variants. Combination of the
261 latest versions should work. For example, the following combination are
265 @item APEL 10.5, SLIM 1.14.9, SEMI 1.14.5
266 @item APEL 10.5, CLIME 1.14.5, EMIKO 1.14.1
269 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
272 @node Download, Install, MIME Modules, Start Me Up
273 @section Download and Extract the Package
276 You can download Wanderlust package from following sites:
280 ftp://ftp.gohome.org/wl/
283 Mirrored ftp/http sites:
287 @c ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
288 http://www.jpl.org/elips/wl/
289 http://www.ring.gr.jp/archives/text/elisp/wl/
290 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
294 Extract the obtained package to your working directory:
299 % tar zxvf wl-@var{version}.tar.gz
300 % cd wl-@var{version}
304 @subsection To use SSL (Secure Socket Layer)
309 SSL (Secure Socket Layer) can be used for
310 SMTP, IMAP, NNTP and POP connections in Wanderlust.
312 There are two ways to use SSL. One is to start SSL negotiation just
313 after the connection establishment (generic way). The other one is to
314 start SSL negotiation by invoking STARTTLS command in the each session.
316 To use the formal SSL (generic SSL), you must set @env{PATH} to the
317 directory that OpenSSL commands are installed.
319 To use the latter SSL(STARTTLS), you must install starttls package in
321 You can download starttls package from the following site.
324 ftp://opaopa.org/pub/elisp/
327 @node Install, Minimal Settings, Download, Start Me Up
328 @section Byte-compile and install
335 @subsection Installation
337 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
338 Set the Emacs's command name to @code{EMACS}.
339 Set package installation directory to @code{LISPDIR}.
340 Then, please execute following commands.
349 Destination directory is auto-probed if you leave @code{LISPDIR}
350 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
352 If you are using an Emacs variant which does not merge specified directory
353 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
354 then you will see the error message:
357 Cannot open load file: mime-setup
361 In this case, either add destination directories of custom, APEL, FLIM
362 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
363 @code{load-path} in @file{WL-CFG} in extracted directory.
365 If you want to handle shimbun folders or to use BBDB, add directory
366 where emacs-w3m or BBDB is installed to @code{load-path}. Then necessary
367 modules will be byte-compiled and installed.
368 @xref{Shimbun Folder}, @xref{BBDB}.
370 @subsection @file{WL-CFG}
372 Contents of the file @file{WL-CFG} is loaded under installation if a file
373 with that name exists in extracted directory. You can use @file{WL-CFG} to
374 configure @code{load-path} to extra packages such as SEMI if needed.
376 If you want to specify the install directory of Wanderlust related
377 files, then set following variables in @file{WL-CFG}
381 A directory to install WL modules.
382 This directory is relative directory from @code{LISPDIR}.
383 WL modules include @file{wl*.el}, @file{wl*.elc} files.
384 @c Modules under the directory @file{util/} are also installed if
385 @c it detected as necessary.
388 A directory to install ELMO modules.
389 This directory is relative directory from @code{LISPDIR}.
390 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
391 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
395 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
397 If you want to install ELMO related files under a sub-directory
398 such as "elmo" then add following to @file{WL-CFG}:
401 (setq ELMO_PREFIX "elmo")
404 @subsection Install as a XEmacs package
405 @cindex XEmacs package
406 @cindex XEmacs package install
407 @cindex Package, XEmacs
408 @cindex Package install, XEmacs
409 @c @cindex install-package
411 It is possible to install Wanderlust as one of packages of XEmacs (21.0
412 or later). Configuration for autoload and icon-path in local
413 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
416 Follow the next example to install Wanderlust as an XEmacs package.
422 % make install-package
426 package directory is auto-probed, if SEMI is installed.
427 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
429 @subsection Run in place
431 If wl and elmo directories are defined in @code{load-path}, then
432 byte-compilation and installation are not necessary to start Wanderlust.
433 For example, if package is extracted in @file{~/work}, Wanderlust can be
434 invoked with following setting in @file{~/.emacs}.
438 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
439 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
445 Manual is described in Info format. Please do following.
454 If you install Wanderlust as a XEmacs package, Info file is already
455 installed too, so there are no need of these commands.
457 Manual directory is automatically detected. Of course, it can be
458 configured by @code{INFODIR} in @file{Makefile}.
460 You can read manual at the following URL:
463 http://www.gohome.org/wl/doc/wl_toc.html
466 @node Minimal Settings, Folder Definition, Install, Start Me Up
467 @section Set up .emacs
468 @cindex Minimal Settings
470 @cindex Configuration
474 The Wanderlust package contains two module groups.
477 @item ELMO (elmo-*.el)
478 These modules show everything as folders. This is the back-end for WL.
480 These modules controls the behavior of main body of Wanderlust.
481 They are also the front-end for ELMO.
484 You can customize the behavior of Wanderlust by changing the value
485 of environmental variables which begins with @code{elmo-} and @code{wl-}.
487 The minimal requirement for settings is as the following.
491 ;; @r{autoload configuration}
492 ;; @r{(Not required if you have installed Wanderlust as XEmacs package)}
493 (autoload 'wl "wl" "Wanderlust" t)
494 (autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
495 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
497 ;; @r{Directory where icons are placed.}
498 ;; @r{Default: the peculiar value to the running version of Emacs.}
499 ;; @r{(Not required if the default value points properly)}
500 (setq wl-icon-directory "~/work/wl/etc")
502 ;; @r{SMTP server for mail posting. Default: @code{nil}}
503 (setq wl-smtp-posting-server "your.smtp.example.com")
504 ;; @r{NNTP server for news posting. Default: @code{nil}}
505 (setq wl-nntp-posting-server "your.nntp.example.com")
509 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
510 file exists). So it is convenient to gather Wanderlust specific settings
511 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
512 because you can't write them in @file{.emacs}
513 (if you write it to @file{.emacs}, you'll get an error).
516 All above described settings except autoload configuration can be written
519 @subsection @code{mail-user-agent}
520 @cindex Default Mailer
521 @cindex Mailer, Default
522 @vindex mail-user-agent
525 If you write following setting in your @file{~/.emacs}, you can
526 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
527 This means it enables you to run Wanderlust as a default mail composer
530 It is effective only when your Emacs can define @code{mail-user-agent}.
531 @xref{Mail Methods, , ,emacs, The Emacs Editor}.
535 (autoload 'wl-user-agent-compose "wl-draft" nil t)
536 (if (boundp 'mail-user-agent)
537 (setq mail-user-agent 'wl-user-agent))
538 (if (fboundp 'define-mail-user-agent)
539 (define-mail-user-agent
541 'wl-user-agent-compose
550 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
551 @section Folder Definition
552 @cindex Folder Definition
555 You can skip this section because it is possible to add/edit the
556 subscribe folders from the buffer for list of folders.
557 @xref{Folder Manager}.
559 Define the folders you want to subscribe in file @file{~/.folders}. The
560 contents written in @file{~/.folders} become the folders which you
561 subscribe to as it is.
563 Format for @file{~/.folders} is very simple. Here is an example:
568 # @r{Lines begin with @samp{#} are comment.}
569 # @r{Empty lines are ignored}
571 # @var{folder name} "@var{folder nickname}"
572 # @r{(nicknames are not necessary)}
577 %#mh/Backup@@my.imap.example.com "Sent"
580 %#mh/spool/wl "Wanderlust ML"
581 %#mh/spool/elips "ELIPS ML"
582 %#mh/spool/apel-ja "APEL Japanese ML"
583 %#mh/spool/xemacs-beta "XEmacs beta"
584 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
585 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
588 # @r{If folder name ends with @samp{/}, that means an `access group',}
589 # @r{all subfolders automatically included in one folder group.}
591 %#mh/expire@@localhost /
592 # @r{All MH folders are included in one folder group.}
597 Each line contains one folder you want to read. The definition of
598 folders will be explained in detail in the next section.
600 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
601 become one folder group. One folder group is treated as a directory
602 which can be opened and closed in folder mode. It is convenient for
603 collecting some folders and putting them in order.
605 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
606 line and you have to write it that way (It is because the parser sucks).
608 There are two types of groups. One is like @samp{Emacsen} from above
609 example which the user chooses his favorite folders as a group.
611 The other one is @dfn{access group} like @samp{+ /} from above example.
612 It collects all sub-folders in the folder to make a group. (Its
613 behavior differs by the type of the folder. For example, @samp{+}
614 followed by @samp{/} makes entire MH sub-directories to one group)
616 This behavior is better understood if you try it and confirmed the
617 function first. You can write and try a small folder definition, so you
618 will know the idea of the folder function before writing the real one.
620 @node Start Wanderlust, Overview, Folder Definition, Start Me Up
621 @section Start Wanderlust
622 @cindex Start Wanderlust
624 If installation and configuration worked well, you can invoke Wanderlust by
625 typing following command in Emacs.
632 After initialization, Folder Mode which shows the list of folders will
633 appear. That means the folders you defined in the @file{~/.folders} are
636 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
637 can skip folder checking.
640 @node Overview, , Start Wanderlust, Start Me Up
644 Basically, you will handle messages in wanderlust while you come and go
645 from/to each of the following buffers. Details of each ones are
646 explained in following chapters.
650 You can see the list of folders. You can select some folder and go into the summary
651 of it. You can subscribe new folder or edit subscription list.
653 You can see the list of messages in the folder. You can select message
654 and view its contents, and reply to some message. You can delete ones or
655 move ones to another folder.
657 You can see the contents of the message. You can save part to disk or
658 open in external programs.
660 You can edit message.
664 @node Folders, Folder, Start Me Up, Top
665 @chapter Wanderlust's folders
668 This chapter describes the folder types which Wanderlust is able to handle.
670 Wanderlust uses ELMO as it's interface, so you can use every folder types
673 As of version @value{VERSION}, 11 types of folders are predefined. These are
674 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
675 Pipe and Internal folder types.
678 * IMAP Folder:: @samp{%} -- IMAP folder
679 * NNTP Folder:: @samp{-} -- NNTP folder
680 * MH Folder:: @samp{+} -- MH folder
681 * Maildir Folder:: @samp{.} -- Maildir folder
682 * News Spool Folder:: @samp{=} -- News spool folder
683 * Archive Folder:: @samp{$} -- Archive folder
684 * POP Folder:: @samp{&} -- POP folder
685 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
686 * Namazu Folder:: @samp{[} -- Namazu Folder
687 * Multi Folder:: @samp{*} -- Multi folder
688 * Filter Folder:: @samp{/} -- Filter folder
689 * Pipe Folder:: @samp{|} -- Pipe folder
690 * Internal Folder:: @samp{'} -- Internal folder
694 @node IMAP Folder, NNTP Folder, Folders, Folders
702 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
708 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
712 You can specify @code{login} (encoded password transmission),
713 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
714 authentication) or @code{clear} (or @code{nil}, plain password
715 transmission) as @var{authenticate-type}.
720 @var{username} -> The value of @code{elmo-imap4-default-user}.
721 Initial setting is @env{USER} environment variable or
722 @env{LOGNAME} environment variable or return value of
723 @code{(user-login-name)}.
724 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
725 Initial setting is "auth".
726 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
727 Initial setting is "localhost".
728 @var{port} -> The value of @code{elmo-imap4-default-port}.
729 Initial setting is 143.
732 You can omit the @var{hostname} from folder names if you set
733 @code{elmo-imap4-default-server} as your main IMAP server.
734 For example, you can specify a folder as @samp{foo%imap@@gateway} even
735 if you have to go through a firewall.
739 ;; @r{Example: imap4.exaple.org as main IMAP server}
740 (setq elmo-imap4-default-server "imap4.example.org")
744 SSL (Secure Socket Layer) connection will be used if a folder name ends
745 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
746 is @code{ssl}, SSL will be the default connection. If a folder name
747 ends with @samp{!!}, STARTTLS connection will be established. If the
748 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
749 STARTTLS will be the default connection.
753 ;; @r{Example: Use SSL connection}
754 (setq elmo-imap4-default-stream-type 'ssl)
758 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
759 authentication method, the password is sent in encoded form. But, if
760 your server is unable to receive an encoded password, authentication
761 will fall back to @code{clear} (that is, sending password in raw format)
762 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
763 authentication will fall back to @code{clear} without confirmation
764 (default value is @code{nil}).
768 ;; @r{Example: password in raw format}
769 (setq elmo-imap4-default-authenticate-type 'clear)
777 %inbox -> IMAP mailbox "inbox"
778 %#mh/inbox -> IMAP mailbox "#mh/inbox"
780 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
781 %inbox:hoge/clear@@server1
782 -> server1's IMAP mailbox "inbox"
783 of user "hoge", with plain password authentication
788 @subsection International mailbox names (Modified UTF7)
789 @cindex Modified UTF7
796 You can use international mailbox names in @var{mailbox} part, if you
797 are using Emacs with UTF-7 support and
798 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
799 value is @code{nil}).
801 Currently, Mule-UCS package is required to use UTF-7.
802 Mule-UCS works on following Emacsen.
805 @item Emacs 20.3 or later
806 @item XEmacs 21.2.37 or later
809 You can obtain Mule-UCS package from following URL.
812 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
815 @node NNTP Folder, MH Folder, IMAP Folder, Folders
826 A folder to access USENET news via NNTP protocol (RFC 977).
827 One newsgroup is treated as a folder.
833 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
839 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
840 Initial setting is @samp{localhost}.
841 @var{username} -> The value of @code{elmo-nntp-default-user}.
842 Initial setting is @code{nil}.
843 @var{port} -> The value of @code{elmo-nntp-default-port}.
844 Initial setting is 119.
847 AUTHINFO is used as authentication method if the @var{username} is
848 non-nil. SSL will be default method if
849 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
850 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
851 STARTTLS connection will be established. if the value of
852 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
853 be the default connection.
859 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
860 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
865 @node MH Folder, Maildir Folder, NNTP Folder, Folders
872 A folder to access MH format mail (1 file is 1 mail).
877 @samp{+} @var{directory-name}
880 Normally, @var{directory-name} is an relative path to the variable
881 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
882 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
883 (this is also true for drive-letters).
885 Message number is used for the name of the message file.
891 +inbox -> @file{~/Mail/inbox}
892 +from/teranisi -> @file{~/Mail/from/teranisi}
893 +~/test -> @file{~/test}
898 @node Maildir Folder, News Spool Folder, MH Folder, Folders
899 @section Maildir Folder
901 @cindex Maildir Folder
905 A folder to access Maildir format (1 file is 1 mail).
910 @samp{.} [@var{directory-name}]
913 Normally, @var{directory-name} is a relative path to the variable
914 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
915 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
916 (this is also true for drive-letters).
918 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
919 Messages are contained in the @file{cur} directory. All message files
920 in the @file{new} directory are moved to @file{cur} directory when you
921 access the folder. All message files contained in the @file{tmp}
922 directory and not accessed for 36 hours are deleted.
924 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
930 . -> @file{~/Maildir}
931 .inbox -> @file{~/Maildir/inbox}
932 .from/teranisi -> @file{~/Maildir/from/teranisi}
933 .~/test -> @file{~/test}
938 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
939 @section News Spool Folder
941 @cindex News spool Folder
944 This folder handles locally saved news articles which are proposed by
945 Mew/IM. You can also read articles directly from a spool-file which is
946 retrieved by an utility like @command{gnspool}.
951 @samp{=} @var{directory-name}
954 @var{directory-name} is a sub-directory to the directory defined by
955 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
956 You can use @samp{.} as directory delimiter as well as @samp{/}.
962 =fj/os/os2 -> @file{~/News/fj/os/os2}
963 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
968 @node Archive Folder, POP Folder, News Spool Folder, Folders
969 @section Archive Folder
971 @cindex Archive Folder
974 This method can handle archive files, which are compressed by utilities
975 such as Info-ZIP or LHA, as one folder.
981 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
985 @var{path-name} is the relative path from
986 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
987 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
988 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
989 also permitted under the environment of ange-ftp, efs.
991 The actual file name of the archive folder is
992 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
993 under the @var{path-name}. If a file named @var{path-name} exists, it is
994 treated as folder. The suffix is automatically decided for
997 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
998 (Initial setting is @code{zip}) is referred.
1000 @var{prefix} specifies the internal directory structure of the archive.
1001 For example, if the ML server is fml, @file{msend.tar.gz} has a
1002 structure like @file{spool/1}, so you have to specify @samp{spool} as
1009 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1010 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1011 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1012 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1013 $ml;zip/ -> Access group consists of archive folders
1014 under @file{~/Mail/ml}
1019 * Archiver:: Supported Archivers
1020 * Archive Tips:: TIPS
1021 * Archive Vars:: Customization
1025 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1026 @subsection Supported Archives
1036 By default, following archives are supported.
1040 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1041 GNU TAR('tgz, 'tar) ;; read-only
1045 If your archiver can include multiple files in one archive, you have a
1046 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1047 of the candidate. TAR is supported read-only because it cannot delete
1048 file in the archive (@code{mv})).
1050 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1051 archiver of Wanderlust because they cannot include multiple
1052 files. Archivers that cannot extract files to standard output are also
1055 @subsection OS specific information about archiver.
1057 Behaviors of the following archivers are confirmed by further experiences.
1058 (@samp{*} mark means recommended archiver).
1061 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1062 LHA OS/2 version Rel.2.06b Feb 18, 1998
1063 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1064 *Zip 2.2 (November 3rd 1997).
1065 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1066 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1067 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1069 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1070 LHa for UNIX V 1.14c
1071 UnZip 5.32 of 3 November 1997
1072 Zip 2.2 (November 3rd 1997)
1073 GNU tar 1.12 (1.11.x is no good)
1074 gzip 1.2.4 (18 Aug 93)
1076 [Win32] Win.98/Meadow
1080 GNU tar 1.11.8 + 1.5(WIN32)
1087 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1088 Hiramatsu version of LHA is only supported.
1089 In Win32, LHa32 is only supported (DOS version is no good).
1091 * Caution about GNU tar
1093 You have to take care about GNU tar's version because many version has
1094 problem on deleting file from archive.
1096 Please test @option{--delete} @option{-f} options work. Otherwise, your
1097 archive will be destroyed. No problem is reported on above versions of
1101 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1103 @cindex Archive Tips
1105 For comfortable migration, usage of @code{wl-summary-archive}
1106 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1107 archive folders created by expiration, you must set non-nil value to
1108 @code{elmo-archive-treat-file}.
1110 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1111 in processing speed. For comfortable use, Emacs20 is recommended.
1112 (If re-search's performance is the problem, 19.3x or later may be okay.)
1114 If many files are included in one archive,
1115 it takes long time to access the archive folder because
1116 archiver starting overhead is increased (especially LHA).
1117 150-200 messages in one archive is recommended.
1119 Of course, following is possible @t{:-)}
1120 (meanings of these variables are described later.)
1124 (setq wl-fcc "$backup")
1125 (setq wl-trash-folder "$trash;lha")
1129 @node Archive Vars, , Archive Tips, Archive Folder
1130 @subsection Variables About Archive Folder
1131 @cindex Archive variables
1134 @item elmo-archive-default-type
1135 @vindex elmo-archive-default-type
1136 The initial setting is @code{zip}.
1137 Set archiver type by symbol.
1139 @item elmo-archive-@var{type}-method-alist
1140 @vindex elmo-archive-TYPE-method-alist
1141 Define archiver @var{type}'s methods.
1142 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1143 Each element of the alist is following.
1147 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1148 (@var{action} . @var{function}) ;; function
1152 Currently available actions are following.
1156 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1157 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1164 actions enclosed with braces are optional (They are used for better
1167 @item elmo-archive-suffix-alist
1168 @vindex elmo-archive-suffix-alist
1169 An alist of archiver-type (symbol) and suffix.
1171 @item elmo-archive-file-regexp-alist
1172 @vindex elmo-archive-file-regexp-alist
1173 An alist of a regexp to get file number from list output of archiver
1174 and archiver-type (symbol).
1176 @item elmo-archive-method-list
1177 @vindex elmo-archive-method-list
1178 A list of elmo-archive-@var{type}-method-alist
1179 (@var{type} is a symbol of archiver-type).
1181 @item elmo-archive-lha-dos-compatible
1182 @vindex elmo-archive-lha-dos-compatible
1183 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1184 DOS (Mr. Yoshizaki original) compatible.
1186 @item elmo-archive-cmdstr-max-length
1187 @vindex elmo-archive-cmdstr-max-length
1188 The initial setting is 8000.
1190 Max length of command line argument for external archiver program.
1191 Emacs does not have a limit of command line byte length, but some OS
1192 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1193 this limit because it calls external archiver program directly (not
1194 called via shell). For example, you cannot delete messages if archiver
1195 program must receive larger bytes of arguments to delete. OS/2 have a
1196 command line argument limit of 8190 bytes, so we defined default as 8000
1199 However, you don't have an influence of command line argument limit
1200 if the archiver has `actions' to receive target file information from
1201 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1205 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1213 A folder to access e-mails via POP3 protocol (RFC 1939).
1219 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1224 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1225 as @var{authenticate-type}.
1227 You can specify @samp{uidl} (use UIDL command for message numbering) or
1228 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1232 @var{username} -> The value of @code{elmo-pop3-default-user}.
1233 Initial setting is @env{USER} environment variable or
1234 @env{LOGNAME} environment variable or return value of
1235 @code{(user-login-name)}.
1236 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1237 Initial setting is @samp{user}.
1238 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1239 If t, use UIDL for numbering. Initial setting is t.
1240 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1241 Initial setting is @samp{localhost}.
1242 @var{port} -> The value of @code{elmo-pop3-default-port}.
1243 Initial setting is 110.
1250 &hoge@@localhost -> access localhost as user @samp{hoge}.
1251 &hoge@@popserver:109 -> access the server "popserver" on port 109
1252 as user @samp{hoge}.
1256 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1257 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1258 @file{utils/sasl/lisp/} or Emacs/W3 package
1259 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1262 If the last character of the folder name is @samp{!}, Wanderlust
1263 connects to the POP server via SSL (Secure Socket Layer). If you set
1264 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1265 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1266 with @samp{!!}, STARTTLS connection will be established. if the value
1267 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1271 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1272 @section Shimbun Folder
1274 @cindex Shimbun Folder
1275 @cindex Folder, Shimbun
1280 A folder for watching "shimbun" (means "newspaper" in Japanese),
1281 news site and mailing list archives on WWW by using emacs-w3m
1282 (@uref{http://emacs-w3m.namazu.org/}).
1284 You should possess w3m and emacs-w3m to use this.
1290 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1294 Admissible values of @var{module-name} and @var{folder-name} are
1295 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1301 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1302 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1306 @subsection Variables About Shimbun Folder
1309 @item elmo-shimbun-update-overview-folder-list
1310 @vindex elmo-shimbun-update-overview-folder-list
1311 The initial setting is @code{nil}. You can specify a list of regular
1312 expressions of shimbun folder names. The overview of matched shimbun
1313 folder is updated when messages are fetched.
1314 You should @kbd{s rescan} after fetching to update summary.
1318 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1319 @section Namazu Folder
1321 @cindex Namazu Folder
1322 @cindex Folder, Namazu
1323 @cindex Folder, Text Search
1326 A folder to access messages found in namazu-index with some condition.
1327 It uses namazu (@uref{http://www.namazu.org/}) for search.
1333 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1337 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1343 [wanderlust] -> search messages matched with
1344 "wanderlust" from the default index
1345 [semi flim]~/Mail/semi -> search "semi flim" from the index
1346 in the directory "~/Mail/semi"
1352 @subsubsection Enter space to separate keywords
1354 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1356 @subsubsection Alias name for index
1358 You can define an alias name for index.
1363 (setq elmo-nmz-index-alias-alist
1364 '(("cache" . "~/.elmo/cache")
1365 ("docs" . "~/documents")))
1368 Above definition defines two index aliases.
1375 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1376 directory @file{~/.elmo/cache}.
1378 @subsubsection Multiple indices
1380 You can specify a list for @code{elmo-nmz-default-index-path} and
1381 @code{elmo-nmz-index-alias-alist}.
1382 When list is specified, all index contained in the list is used as the
1388 (setq elmo-nmz-index-alias-alist
1389 '(("all" . ("~/.elmo/cache" "~/documents"))
1390 ("cache" . "~/.elmo/cache")))
1393 Using above alias setting, you can specify
1399 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1400 directory @file{~/.elmo/cache} and @file{~/documents}.
1402 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1403 @section Multi Folder
1405 @cindex Multi Folder
1406 @cindex Folder, Multiple
1407 @cindex Folder, Marge
1409 A folder to access virtual folder which collects messages from
1416 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1420 After @samp{*} character, specify multiple folders you want to collect
1421 separated by @samp{,} like
1422 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1428 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1429 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1430 treated as one folder.
1432 *+inbox,-fj.rec.tv,%inbox
1433 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1438 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1439 @section Filter Folder
1441 @cindex Filter Folder
1442 @cindex Folder, Filtering
1443 @cindex Folder, Virtual
1444 @cindex Folder, Conditional
1446 A folder to access virtual folder which collects all messages that
1447 satisfy a condition.
1452 @samp{/} @var{condition} @samp{/} @var{target-folder}
1455 In the @var{condition} part, you can specify following.
1459 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1461 first: @var{number} messages are picked from top of folder.
1462 last: @var{number} messages are picked from bottom of folder.
1468 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1469 /first:20/%inbox -> First 20 messages from %inbox are picked.
1474 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1476 since: only messages arrived since @var{date} are picked.
1477 before: only messages arrived before @var{date} are picked.
1479 You can specify following as @var{date}.
1483 yesterday -> a day before today.
1484 lastweek -> same day of last week.
1485 lastmonth -> same day of last month.
1486 lastyear -> same day of last year.
1487 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1488 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1496 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1498 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1504 Field filter: @samp{@var{field}:@var{value}}
1506 All messages that have @var{field} and its value is @var{value} are picked.
1507 @var{field} and @var{value} are case insensitive.
1513 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1514 and its value includes "teranisi" string are picked.
1515 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1523 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1524 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1526 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1527 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1533 /from:teranisi&!to:teranisi/+inbox
1534 -> In +inbox, messages are picked if the message's
1535 From: field includes "teranisi" and
1536 To: field doesn't include "teranisi".
1538 /tocc:"Yuuichi Teranishi"/+inbox
1539 -> In +inbox, messages are picked if the
1540 message's To: field or Cc: field includes
1541 "Yuuichi Teranishi".
1543 /(from:yt|from:teranisi)&subject:report/+inbox
1544 -> In +inbox, messages are picked if the message's
1545 From: field includes "yt" or "teranisi", and
1546 Subject includes "report".
1552 Tip for string description:
1554 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1555 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1556 should be escaped with @samp{\} in it). You can enclose the string with
1557 @samp{"} even it does not contain these characters.
1563 *%inbox,/from:teranisi/%inbox@@server
1564 -> Messages in %inbox or
1565 message is in the %inbox@@server folder and it's From field
1566 includes "teranisi" are collected.
1568 /last:100//to:teranisi/*+inbox,%inbox
1569 -> Latest 100 messages which is in the +inbox or %inbox folder
1570 and To: field matches "teranisi".
1572 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1573 -> Pick messages which have From: field and it includes "hogehoge"
1574 from latest 20 messages in the %#mh/inbox@@localhost
1575 and To: or Cc: field includes "teranisi".
1578 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1579 @section Pipe Folder
1583 @cindex Download Message
1584 @cindex Incorporate Message
1586 In the pipe folder, messages are automatically transferred from the source
1587 folder to destination folder.
1592 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1595 When you access the pipe folder, messages are automatically transferred
1596 from @var{source-folder} to @var{destination-folder}.
1597 It is convenient if you want to download messages to local disk via POP.
1598 For example, if you specify following
1601 |&username@@popserver|+inbox
1605 and access it, Wanderlust downloads messages from
1606 @samp{&username@@popserver} to @samp{+inbox} automatically.
1608 On the other hand, if you put @samp{|:} instead of second @samp{|},
1609 then messages are copied to the destination folder (not deleted from
1610 source-folder). At the next time you access that folder, copies new
1614 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1617 If you want to copy messages from POP server and view them, specify the
1621 |&username@@popserver|:+inbox
1624 where messages will be kept on the server.
1630 |%inbox|%myinbox -> Download %inbox to %myinbox.
1631 |*&user@@popserver1,&user@@popserver2|+inbox
1632 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1633 |-gnu.emacs.sources|:+sources
1634 -> Copy messages from -gnu.emacs.sources to +sources.
1638 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1640 @node Internal Folder, , Pipe Folder, Folders
1641 @section Internal folder
1643 @cindex Internal Folder
1644 @cindex Folder, @samp{$} mark
1646 @c @cindex Folder, Null
1648 A folder to access internal messages of Wanderlust.
1660 A folder named @samp{'mark} is a special virtual folder which collects
1661 messages which have important mark @samp{$}.
1663 You can review important messages at once after you put important marks
1664 on the messages in the different folders.
1666 In this folder, if you delete message, important mark @samp{$} put on
1667 the message is removed. If you append messages to this folder, the
1668 message will have @samp{$} mark.
1670 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1671 folder. If you want IMAP folder's message remove from @samp{'mark}
1672 folder, remove important mark at IMAP Folder.)
1675 A folder named @samp{'sendlog} is a virtual folder which collects
1676 cached messages which are recoded on @file{~/.elmo/sendlog}.
1677 It might be useful when you forgot to add cc for yourself.
1678 To use this, you should set @code{wl-draft-use-cache} to non-nil
1679 so that sent messages are cached.
1682 You can access cached messages fetched via network by accessing
1683 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1684 the name of the subdirectories of the cache directory
1685 (@file{~/.elmo/cache}).
1688 @node Folder, Summary, Folders, Top
1689 @chapter Folder mode
1692 After you start Wanderlust, folder mode is appeared firstly.
1693 It contains folder list you subscribed.
1694 You can select and edit folders in this mode.
1697 * Selecting Folder:: Select folder you want to read
1698 * Folder Manager:: Editing folders
1702 @node Selecting Folder, Folder Manager, Folder, Folder
1703 @section Selecting Folder
1704 @cindex Selecting Folder
1706 @subsection Usage (TIPS)
1708 @subsubsection Check new, unread number
1710 Folder mode looks like this.
1711 (In XEmacs, it looks much nicer @t{;-)})
1715 [-]Desktop:14186/35580/67263
1720 [-]Emacsen:0/34/4837
1721 Wanderlust ML:0/0/558
1724 XEmacs Beta:0/29/255
1735 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1739 @kbd{s} key on the folder line updates these numbers.
1740 It changes its color if it has many new messages.
1742 The whole folder mode is a folder group named @samp{Desktop}.
1743 Folder group open/close by return key.
1744 A operation to a folder group is treated as operations on the
1746 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1747 six children folders update its unread number status.
1749 @subsubsection Select Folder
1751 To enter summary mode of the folder, type return (or space) key on
1753 If the variable @code{wl-stay-folder-window} has non-nil value,
1754 summary window appears on the right of the folder mode window.
1756 @subsection Key bindings
1758 Folder mode's key binding (related to selecting folders) is following.
1763 @kindex @key{SPC} (Folder)
1764 @kindex @key{RET} (Folder)
1765 @findex wl-folder-jump-to-current-entity
1766 Enter to the summary mode of the folder at the current cursor point.
1767 With prefix argument, enter the sticky summary.
1768 If the cursor is on the top of folder group line,
1769 the folder group is opened or closed.
1770 When the cursor is on the access group and this command is called
1771 with prefix argument, folder children list is updated to the newest one.
1772 (Children list is updated recursively if the access folder has hierarchical
1774 (@code{wl-folder-jump-to-current-entity})
1777 @kindex M-@key{RET} (Folder)
1778 @findex wl-folder-update-recursive-current-entity
1779 Folder children list of the access group at the current cursor point
1780 is updated to the newest one.
1781 (Children list is updated recursively if the access folder has hierarchical
1783 (@code{wl-folder-update-recursive-current-entity})
1788 Create a new draft message.
1793 @findex wl-folder-write-current-folder
1794 If the current cursor point is on the NNTP folder, create a new draft
1795 message which already has @samp{Newsgroups:} field. If the current
1796 cursor point is on the folder for mailing list (refile destination),
1797 create a new draft message which already has @samp{To:} field with
1798 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1800 (@code{wl-folder-write-current-folder})
1803 @kindex C-c C-o (Folder)
1804 @findex wl-jump-to-draft-buffer
1805 Move to the draft buffer if available. If multiple draft buffer exists,
1806 moved to one after another. If prefix argument is specified, load draft
1807 folder's message to the draft buffer and jump to it.
1808 (@code{wl-jump-to-draft-buffer})
1812 @findex wl-folder-check-current-entity
1813 Update new and unread number information of the folder at the current
1815 (@code{wl-folder-check-current-entity})
1819 @findex wl-folder-sync-current-entity
1820 Update summary information of the folder at the current cursor point.
1821 (@code{wl-folder-sync-current-entity})
1824 @kindex r s (Folder)
1825 @findex wl-folder-check-region
1826 Update new and unread number information of the folders in the currently
1828 (@code{wl-folder-check-region})
1831 @kindex r S (Folder)
1832 @findex wl-folder-sync-region
1833 Update summary information of the folders in the currently selected region.
1834 (@code{wl-folder-sync-region})
1838 @findex wl-status-update
1839 Sync up address book status with @file{~/.addresses}'s content.
1840 (@code{wl-status-update})
1844 @findex wl-folder-prev-unread
1845 Jump cursor to the folder which have unread messages on the upward from
1846 current cursor point.
1847 (@code{wl-folder-prev-unread})
1851 Jump cursor to the folder which have unread messages on the downward
1852 from current cursor point.
1853 (@code{wl-folder-next-unread})
1857 Move cursor to the folder on the previous line.
1858 (@code{wl-folder-prev-entity})
1862 Move cursor to the folder on the next line.
1863 (@code{wl-folder-next-entity})
1867 Jump to the folder specified by the user input.
1868 (@code{wl-folder-jump-folder})
1872 @findex wl-folder-prefetch-current-entity
1873 Prefetch new messages of the folder at the current cursor point by
1874 @code{wl-summary-incorporate}.
1875 If the cursor is on the folder group, it is executed recursively.
1876 (@code{wl-folder-prefetch-current-entity})
1880 @findex wl-folder-mark-as-read-all-current-entity
1881 Mark all unread messages of the folder at the current cursor point as read.
1882 If the cursor is on the folder group, it is executed recursively.
1883 (@code{wl-folder-mark-as-read-all-current-entity})
1887 @findex wl-folder-goto-first-unread-folder
1888 Enter summary mode of the first unread folder.
1889 (@code{wl-folder-goto-first-unread-folder})
1893 @findex wl-folder-empty-trash
1895 (@code{wl-folder-empty-trash})
1899 @findex wl-folder-flush-queue
1901 (@code{wl-folder-flush-queue})
1905 @findex wl-folder-virtual
1906 Move to the virtual folder (filter folder) with the condition specified.
1907 (@code{wl-folder-virtual})
1911 @findex wl-folder-pick
1912 Search the folders with the condition specified.
1913 (@code{wl-folder-pick})
1917 @findex wl-folder-open-all-unread-folder
1918 All unread folder is opened.
1919 (@code{wl-folder-open-all-unread-folder})
1923 @findex wl-folder-open-close
1924 Folder group is opened/closed.
1925 (@code{wl-thread-open-close})
1929 All folder group is opened.
1930 (@code{wl-folder-open-all})
1934 All folder group is closed.
1935 (@code{wl-folder-close-all})
1945 (@code{wl-folder-suspend})
1948 @kindex M-s (Folder)
1949 Save current folder status.
1953 @kindex M-t (Folder)
1954 Toggle Wanderlust's offline/online status.
1955 (@code{wl-toggle-plugged})
1958 @kindex C-t (Folder)
1959 Start Wanderlust's plug-status manager.
1960 (@code{wl-plugged-change})
1963 @subsection Customize variables
1966 @item wl-folders-file
1967 @vindex wl-folders-file
1968 The initial setting is @file{~/.folders}.
1969 Subscribed folders are described (saved) in this file.
1971 @item wl-folder-info-save
1972 @vindex wl-folder-info-save
1973 The initial setting is @code{t}. If non-nil, unread information is
1974 saved and used in the next Wanderlust session.
1976 @item wl-stay-folder-window
1977 @vindex wl-stay-folder-window
1978 The initial setting is @code{nil}.
1979 If non-nil, summary window is appeared on the right side of the folder buffer.
1981 @item wl-folder-window-width
1982 @vindex wl-folder-window-width
1983 The initial setting is 20.
1984 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1986 @item wl-folder-use-frame
1987 @vindex wl-folder-use-frame
1988 The initial setting is @code{nil}.
1989 If non-nil, use new frame for the folder window.
1991 @item wl-folder-many-unsync-threshold
1992 @vindex wl-folder-many-unsync-threshold
1993 The initial setting is 70.
1994 If the number of unread messages is more than this value,
1995 folder color is changed.
1997 @item wl-highlight-folder-by-numbers
1998 @vindex wl-highlight-folder-by-numbers
1999 This option controls how to highlight each line in the folder buffer.
2000 The default value is @code{t}, highlighting with various colors based on
2001 the message numbers. If it is @code{nil}, highlighting with various
2002 colors based on the folder status. In addition, if it is a number
2003 (e.g. 1), highlighting will be done based on both the message numbers
2004 and the folder status.
2006 @item wl-folder-desktop-name
2007 @vindex wl-folder-desktop-name
2008 The initial setting is @samp{Desktop}.
2009 The name of top folder group.
2011 @item wl-folder-petname-alist
2012 @vindex wl-folder-petname-alist
2013 The initial setting is @code{nil}.
2014 An alist of folder's realname and its nickname.
2016 @item wl-folder-access-subscribe-alist
2017 @vindex wl-folder-access-subscribe-alist
2018 The initial setting is @code{nil}.
2020 Control automatic subscribing and unsubscribing of the children list
2026 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2030 If @var{subscribe-flag} is non-nil, folders which have name matched to
2031 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2032 already unsubscribed folder is not displayed even when the
2033 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2040 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2041 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2042 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2043 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2047 @item wl-folder-hierarchy-access-folders
2048 @vindex wl-folder-hierarchy-access-folders
2049 The initial setting is the list shown below:
2058 A list of regular expressions for access groups which creates children
2059 folder list hierarchically.
2061 For example, if you specify
2062 @code{wl-folder-hierarchy-access-folders} like following,
2066 (setq wl-folder-hierarchy-access-folders
2067 '("^-$" "^-alt$" "^-japan$" "^-comp$" "^-comp.unix$"))
2072 you obtain the access group hierarchy as follows.
2078 -fj.comp.announce:0/0/2
2079 -fj.comp.dev.cdrom:0/0/0
2081 [+]-japan:238/238/1688
2084 -comp.unix.admin:0/0/0
2085 -comp.unix.dos-under-unix:0/0/0
2086 -comp.unix.programmer:0/0/0
2087 [-]-comp.unix.bsd:0/0/23
2088 -comp.unix.bsd.freebsd.announce:0/0/0
2093 If you opened @samp{-} in this example, only the direct children is created
2094 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2095 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2096 is not created until the children access group is opened.
2100 @node Folder Manager, , Selecting Folder, Folder
2101 @section Editing Folders
2102 @cindex Folder Manager
2103 @cindex Folder, Edit
2104 @cindex Folder, Subscribe
2105 @cindex Folder, Unsubscribe
2107 As described before, subscribed folder list is saved in @file{~/.folders} file.
2108 But you don't have to edit @file{~/.folders} directly.
2109 You can append, delete, edit folders from folder mode.
2111 @subsection Usage (Tips)
2113 @subsubsection Append Folder
2115 @kbd{m a} appends new folder to the folder mode.
2116 @kbd{m g} appends new folder group.
2117 To append new folder to this group, firstly open it,
2118 then execute append command in the next line.
2120 @subsubsection Edit Folder
2122 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2123 Thus, you can change folder position as if you were editing a normal file.
2125 @subsubsection Create Multi Folder.
2129 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2131 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2133 Type @kbd{m m}, then you can create multi folder.
2136 @subsubsection Delete Nickname, Filter
2138 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2139 minibuffer while appending.
2141 @subsubsection Append Folder to Empty Group
2143 To append new folder to the empty folder group
2144 (after you create folder group by typing @kbd{m g}),
2145 firstly open it, then execute append command in the next line.
2146 If it is closed, folder is appended on the same level with
2147 the folder group above. It is difficult to explain by words so try it.
2148 In other words, appended position depends on the
2149 open/close status of the upper one.
2151 @subsubsection Charset of the Folders File.
2153 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2155 @subsubsection Create Filter
2157 @kbd{m f} adds filter to the folder at the current cursor point. To
2158 create new filter folder and leave the current folder unchanged, copy it
2159 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2160 filter can be specified while appending filter. If you put
2161 ``''(@var{NULL}), filter is deleted.
2163 @subsubsection Sort Folders
2165 Sorting of the folders is executed by the function specified by
2166 @code{wl-fldmgr-sort-function}.
2167 The initial setting is @code{wl-fldmgr-sort-standard},
2168 which sorts alphabetically.
2169 Sorting affects only on the current folder group. It does not
2170 affect on the child groups.
2172 @subsubsection Hiding Folders in the Access Group
2174 Usually, access group displays all children folders, but you can set
2175 some folders hidden. Following operations are only available on access
2178 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2179 (subscribe/unsubscribe) of the folder at current cursor point. Against
2180 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2183 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2184 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2185 argument and if the argument has positive number, the unsubscribe it.
2186 If the prefix argument has negative value, folder becomes visible and if
2187 zero, folder visibility is toggled.
2189 The other commands, @code{wl-fldmgr-subscribe} and
2190 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2193 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2194 executed in the access group, they have a same effect with
2195 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2196 The difference is that cut commands deletes folders from the current
2199 @subsubsection Operations in the Access Group
2201 You can insert and delete folders in the access group like usual folder
2202 group. But insert and delete commands can be only available for the
2203 children folders of the access group and they only sets the subscribe
2204 status. In other words, insertion of the folder means subscribing,
2205 deletion means unsubscribing.
2206 @footnote{In the current implementation,
2207 it is faster to delete region than to unsubscribe region.}
2209 To update the access group when children folders are inserted or deleted
2210 by other way (other than Wanderlust),
2211 open the access group by typing @kbd{C-u @key{RET}}.
2212 @xref{Selecting Folder}.
2214 The order of children folders of access group is saved after
2215 insertion/deletion/sorting.
2216 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2217 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2218 newly created folders are inserted on the top of the access group.
2220 @subsection Key bindings
2221 @cindex Keybind, Folder Mode
2222 @cindex Keybind, Folder Buffer
2224 Key bindings on the folder mode related to folder editing are shown below.
2225 All bindings starts with @kbd{m}, and primary commands are binded to
2226 one stroke key binding.
2230 @kindex m a (Folder)
2231 @findex wl-fldmgr-add
2233 (@code{wl-fldmgr-add})
2238 @kindex m g (Folder)
2239 @findex wl-fldmgr-make-group
2240 Create a folder group.
2241 (@code{wl-fldmgr-make-group})
2244 @kindex m A (Folder)
2245 @findex wl-fldmgr-make-access-group
2246 Create an access group.
2247 (@code{wl-fldmgr-make-access-group})
2250 @kindex m d (Folder)
2251 @findex wl-fldmgr-delete
2252 Delete folder itself and msgdb.
2253 If the folder itself cannot be deleted like NNTP folder,
2254 only msgdb is deleted.
2255 (@code{wl-fldmgr-delete})
2260 @kindex m R (Folder)
2261 @findex wl-fldmgr-rename
2262 Change the name of folder or folder group.
2263 msgdb's path is also changed.
2264 (@code{wl-fldmgr-rename})
2270 @findex wl-fldmgr-make-multi
2271 Create a multi folders in the cutlist (cut, copied folders).
2272 (@code{wl-fldmgr-make-multi})
2277 @kindex m f (Folder)
2278 @findex wl-fldmgr-make-filter
2279 Create a filter folder. (Put a filter on the folder).
2280 (@code{wl-fldmgr-make-filter})
2284 @kindex M-c (Folder)
2285 @kindex m c (Folder)
2286 @findex wl-fldmgr-copy
2287 Copy folder (it is not available on folder group).
2288 (@code{wl-fldmgr-copy})
2292 @kindex M-w (Folder)
2293 @kindex m W (Folder)
2294 @findex wl-fldmgr-copy-region
2295 Copy folders in the specified region.
2296 (@code{wl-fldmgr-copy-region})
2300 @kindex C-k (Folder)
2301 @kindex m k (Folder)
2302 @findex wl-fldmgr-cut
2303 Cut folder. Folder itself is not deleted.
2304 (@code{wl-fldmgr-cut})
2308 @kindex C-w (Folder)
2309 @kindex m C-w (Folder)
2310 @findex wl-fldmgr-cut-region
2311 Cut folders in the specified region.
2312 (@code{wl-fldmgr-cut-region})
2316 @kindex C-y (Folder)
2317 @kindex m y (Folder)
2318 @findex wl-fldmgr-yank
2319 Paste folders that are copied or cut (folders in the cut-list).
2320 (@code{wl-fldmgr-yank})
2323 @kindex m p (Folder)
2324 @findex wl-fldmgr-set-petname
2325 Put nickname on the folder.
2326 (@code{wl-fldmgr-set-petname})
2329 @kindex m q (Folder)
2330 @findex wl-fldmgr-clear-cut-entity-list
2331 Clear the cut-list. (cut, copied folder information is cleared,
2332 you cannot paste after this)
2333 (@code{wl-fldmgr-clear-cut-entity-list})
2336 @kindex m s (Folder)
2337 @findex wl-fldmgr-sort
2338 Sort folders in the current folder group.
2339 (@code{wl-fldmgr-sort})
2342 @kindex m C-s (Folder)
2343 @findex wl-fldmgr-save
2344 Save current folder view to the @file{wl-folders-file}.
2345 (@code{wl-fldmgr-save})
2348 [Following commands are only available on the access groups]
2354 @kindex m u (Folder)
2355 @findex wl-fldmgr-unsubscribe
2356 Set the visibility of folder (subscribe/unsubscribe).
2357 (@code{wl-fldmgr-unsubscribe})
2362 @kindex r u (Folder)
2363 @findex wl-fldmgr-unsubscribe-region
2364 Set the visibility of the folders (subscribe/unsubscribe) in the
2366 (@code{wl-fldmgr-unsubscribe-region})
2371 @kindex m l (Folder)
2372 @findex wl-fldmgr-access-display-normal
2373 List folders that are currently available.
2374 (@code{wl-fldmgr-access-display-normal})
2379 @kindex m L (Folder)
2380 @findex wl-fldmgr-access-display-all
2381 List all folders regardless of the subscription status.
2382 (@code{wl-fldmgr-access-display-all})
2386 @subsection Customize variables
2389 @item wl-interactive-save-folders
2390 @vindex wl-interactive-save-folders
2391 The initial setting is @code{t}. If non-nil and folder view is
2392 modified, confirm saving it before Wanderlust or Emacs exits. If
2393 @code{nil}, save without confirmation.
2395 @item wl-fldmgr-make-backup
2396 @vindex wl-fldmgr-make-backup
2397 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2398 created before saving the folder status.
2400 @item wl-fldmgr-sort-function
2401 @vindex wl-fldmgr-sort-function
2402 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2403 sort folders. By default function, folders are sorted alphabetically
2404 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2407 @item wl-fldmgr-sort-group-first
2408 @vindex wl-fldmgr-sort-group-first
2409 The initial setting is @code{t}. If non-nil,
2410 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2411 does not care whether it is folder group or not.
2413 @item wl-folder-check-async
2414 @vindex wl-folder-check-async
2415 The initial setting is @code{t}. If non-nil, check folder's unread
2416 status asynchronously. It boosts newsgroup checking.
2418 @item wl-folder-check-fast
2419 @vindex wl-folder-check-fast
2420 The initial setting is @code{nil}.
2421 If non-nil, it does not update folder status while checking.
2423 @item wl-folder-notify-deleted
2424 @vindex wl-folder-notify-deleted
2425 The initial setting is @code{nil}.
2427 If non-nil, negative value is displayed when the message is deleted. If
2428 @code{sync}, folder is synchronized when the message is deleted. If
2429 @code{nil}, message deletion is ignored.
2431 @item wl-fldmgr-add-complete-with-current-folder-list
2432 @vindex wl-fldmgr-add-complete-with-current-folder-list
2433 The initial setting is @code{nil}.
2434 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2435 candidate for @code{wl-fldmgr-add}.
2438 @subsection Miscellanea
2440 Following is a note for folder editing.
2444 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2445 paste(yank) command pastes the folders on one cut or copy command
2446 (If copy command is executed by region, folders in the region are pasted
2447 by one paste command)
2450 You cannot cut @samp{Desktop} group.
2451 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2454 You cannot copy folder group.
2457 Operations on the access group are only available for the folders
2458 in the same access group.
2461 You cannot create a folder which has same name with the folders already exist.
2464 You cannot insert folders which have same name in one group.
2465 You can insert them in the different groups.
2466 You cannot put same nickname to the different folders.
2470 @node Summary, Message, Folder, Top
2471 @chapter Summary Mode
2473 After you select the folder via folder mode, you enter to the summary
2477 * Usage of Summary Mode:: TIPS
2478 * Thread Operations:: Thread operations
2479 * Cache:: File cache, Buffer cache, and Prefetch
2480 * Auto Refile:: Auto refile settings
2481 * Sticky Summary:: Summary make sticky
2482 * Summary View:: Format of summary lines
2483 * Key Bindings of Summary:: Key bindings
2484 * Variables of Summary:: Customize Summary Mode
2488 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2489 @section Usage (Tips)
2491 @subsection Summary Content
2493 In the summary mode, messages are displayed like following.
2497 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2498 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2499 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2500 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2507 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2511 If you want to know how to change the format for this, please refer
2512 the section format of Summary lines.
2513 @xref{Summary View}.
2515 @var{Message number} is the message's unique number in the folder. In
2516 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2517 in the MH folder, it is the filename of the message.
2519 @var{Temporal mark} and @var{Persistent mark} are described later.
2521 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2522 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2523 Japanese, but if you want to display it in English, set the value of
2524 @code{wl-summary-weekday-name-lang} as @samp{en}.
2526 @var{Sender}'s indentation corresponds to the depth of the thread.
2527 Sender name is displayed as nickname if it is defined in the address
2528 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2529 displaying with nickname.
2531 If number is printed at the head of @var{Sender} part like @samp{+2},
2532 that means the message have 2 follow messages.
2534 @var{Subject} is the @samp{Subject:} header field of the message. If
2535 the message have same @samp{Subject:} with the parent message, it is not
2536 displayed. Some mailing list puts its sequence number in the
2537 @samp{Subject:} field, but it is
2538 ignored. @code{wl-summary-no-subject-message} is displayed when the
2539 message has empty subject field.
2541 @subsection Temporary Marks
2542 @cindex Mark, Temporary
2544 There are four temporary marks,
2545 @samp{*}, @samp{d}, @samp{o} and @samp{O}.
2546 Temporary marks indicates message operations.
2551 You can execute a command on the all messages that have @samp{*} mark,
2552 with the key bindings which begins with @kbd{m}.
2555 The mark to dispose. You can put @samp{d} by typing @kbd{d} key.
2559 After you type @kbd{o} key, prompt appears to input refile destination.
2560 Your answer is printed in the summary line.
2564 You can put this mark by typing @kbd{O} key.
2565 The difference between this mark and refile mark is,
2566 this mark does not delete the message while latter does.
2569 @kbd{x} key executes action for temporary marks, respectively.
2571 @subsection Persistent Marks
2573 There are five persistent marks,
2574 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2576 The persistent mark indicates the message's status and it is saved.
2577 Each persistent mark indicates:
2583 It is unread message.
2585 It is unread but cached message.
2587 It is read but it is not cached.
2589 It is important message. You can put @samp{$} mark by typing @kbd{$}
2590 key (if already exists, the mark is deleted). It is convenient to put
2591 this mark on the messages to remember (If you want to remember to write
2592 a reply for the message, for example) because this mark remains after
2593 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2594 @samp{'mark} folder even the message itself is deleted in the actual folder.
2597 If the message is read and cached (or local message),there are no
2601 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2602 cache. Messages with the marks other than these, you can read them in
2603 the offline status even they are in the IMAP folder or netnews folder.
2605 Among messages with persistent marks, ones with marks specified by
2606 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2607 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2609 @subsection How To Read
2611 Basically, you can read messages only typing space key again and again.
2613 To update summary status to the newest status (synchronize),
2616 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2617 moves cursor to the next message.
2618 Enter message buffer by typing @kbd{j} key.
2619 To operate multipart, you have to enter to the message buffer.
2622 @subsection Pack the Message Numbers
2623 You can pack the message numbers in Summary by
2624 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2625 News Spool Folder and Maildir Folder are supported folder types.
2628 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2629 @section Thread Operations
2631 For example, the following line indicates one thread (a context of a topic).
2634 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2638 If you type @kbd{/} on this line, the thread is opened and it changes
2639 the appearance like following.
2643 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2644 388 09/17(Thu)22:34 +-[ Murata san ]
2648 (Message 388 is the replied message to the message 384.)
2649 If you type @kbd{/} key once again, the thread is closed.
2650 With prefix argument, @kbd{/} opens all children threads.
2652 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2655 Commands with the key binding that begins with @kbd{t} executes commands
2656 on the messages in the thread.
2657 @xref{Key Bindings of Summary}.
2659 @subsection reconstruct thread by hand
2661 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2662 (@code{wl-summary-save-current-message}) at the corresponding message,
2663 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2664 message then you have the reconstructed thread.
2667 @node Cache, Auto Refile, Thread Operations, Summary
2670 @subsection Cache File
2672 The messages which have to access via network (e.x. IMAP, NNTP folder)
2673 are cached as a local file so as to save network traffic or to enable
2674 off-line operation. The cache file is saved under the directory
2675 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2676 elmo-cache-expire-by-size}. The command deletes cache files to the
2677 specified size by the order of last accessed time.
2679 @subsection Buffer Cache and Prefetching
2681 The messages that are read are kept in the cache buffer so as to make
2682 the behavior fast when you are to read the message again. It is called
2683 `buffer cache'. The number of cache buffer is specified by
2684 @code{wl-message-buffer-cache-size}.
2686 There are message prefetching mechanism in the Wanderlust that
2687 prefetches next message while you are reading.
2689 You can control the message prefetching mechanism by these two
2693 @item wl-message-buffer-prefetch-folder-type-list
2694 @vindex wl-message-buffer-prefetch-folder-type-list
2695 The initial setting is @code{t}. In this case, prefetch messages in all
2697 If it is a list of folder types, it specifies the folder types in which
2698 message prefetching is enabled.
2699 Following is an example (prefetch messages in nntp and imap4 folders)
2703 (setq wl-message-buffer-prefetch-folder-type-list
2708 In this case, multi folder that contains localdir and imap4 prefetches
2709 only imap4 messages. This variable precedes the value of
2710 @code{wl-message-buffer-prefetch-folder-list}.
2712 @item wl-message-buffer-prefetch-folder-list
2713 @vindex wl-message-buffer-prefetch-folder-list
2714 The initial setting is @code{nil}.
2715 A list of regexp of folders to enable message prefetching.
2717 @item wl-message-buffer-prefetch-depth
2718 @vindex wl-message-buffer-prefetch-depth
2719 The initial setting is 3. The number of messages for automatical prefetch.
2721 @item wl-message-buffer-prefetch-idle-time
2722 @vindex wl-message-buffer-prefetch-idle-time
2723 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2725 @item wl-message-buffer-prefetch-threshold
2726 @vindex wl-message-buffer-prefetch-threshold
2727 The initial setting is 30000 (bytes). If prefetching message has larger
2728 size than this value, Wanderlust does not prefetch automatically.
2729 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2730 the message is not checked for the size.
2732 @item wl-auto-prefetch-first
2733 @vindex wl-auto-prefetch-first
2734 The initial setting is @code{nil}.
2735 If non-nil, first message is automatically prefetched to the buffer
2736 when you enter the folder.
2740 @node Auto Refile, Sticky Summary, Cache, Summary
2741 @section Auto Refile
2742 @vindex elmo-msgdb-extra-fields
2743 @vindex wl-refile-rule-alist
2744 @findex wl-summary-auto-refile
2746 You can refile messages automatically, by typing @kbd{C-o}
2747 (@code{wl-summary-auto-refile}). It decides destination of refile by
2748 the content of the message header information (information in the msgdb).
2750 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2751 available. If you want to decide destination by other header fields,
2752 set the variable @code{elmo-msgdb-extra-fields} like following.
2756 (setq elmo-msgdb-extra-fields
2766 By this setting, Wanderlust saves extra fields in the msgdb. You have
2767 to type @kbd{s all} to get extra fields for the messages that are
2768 already exists in the summary.
2770 Then, specify the refile rule. The refile target folder of auto
2771 refiling is decided by the value of @code{wl-refile-rule-alist}.
2772 @code{wl-refile-rule-alist} is a list of a rule:
2776 (@var{field} (@var{regexp} . @var{target})
2777 (@var{regexp} . @var{target})
2782 Each rule means `if @var{field} value matches @var{regexp},
2783 then refile to @var{target} folder'.
2784 The rule matched first is applied.
2786 @var{field} is a string of field name. You can specify a list of field name
2787 string, too. In this case, if one of these fields is matched, then the
2788 rule is fired (i.e. OR condition).
2790 @var{regexp} is a regular expression for field value. @var{target} is a target
2791 folder string. You can specify a rule at @var{target} part, too. In this
2792 case, If the field value of the rule and the current rule is matched,
2793 then the current rule is fired (i.e. AND condition).
2795 You can refer matched substring of @var{regexp} to specify @var{target} part.
2796 To refer substring, use following keys:
2800 means substitute original matched text.
2803 means substitute what matched the @var{N}th `\(@dots{}\)'.
2804 (@var{N} is a number.)
2807 Following is an example of @code{wl-refile-rule-alist}.
2811 (setq wl-refile-rule-alist
2813 ("^Wanderlust" . "+wl")
2814 ("^Elisp" . "+elisp"))
2816 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2818 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2819 "+from-me-to-you"))))))
2823 After these settings, refile marks are automatically put on the condition
2824 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2826 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2828 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2829 with these persistent marks are not automatically refiled.
2830 It means Wanderlust does not execute auto refile on unread messages by
2831 the default setting.
2832 To execute auto refile on all messages, set following.
2835 (setq wl-summary-auto-refile-skip-marks nil)
2839 @node Sticky Summary, Summary View, Auto Refile, Summary
2840 @section Sticky Summary
2841 @cindex Summary, Sticky
2842 @cindex Sticky Summary
2844 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2846 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2847 @kbd{G} in some suummary sticky summary buffer is created.
2848 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2849 makes current one sticky.
2851 The buffer name of the sticky summary becomes like
2852 @samp{Summary:@var{folder-name}}.
2853 You can visit the sticky summary at any time by @kbd{C-x b}
2854 (@code{switch-to-buffer}), or you can go round summary buffers by
2855 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2856 (@code{wl-summary-next-buffer}) in summary mode.
2858 In sticky summary, the summary buffer is preserved after @kbd{g} or
2859 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2860 another summary by @kbd{C-u g}. Other operations in the sticky summary
2861 are same as normal summary.
2863 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2864 are automatically stuck.
2867 @node Summary View, Key Bindings of Summary, Sticky Summary, Summary
2868 @section Format of summary lines
2869 @cindex Format of summary lines
2870 You can alter the format of lines in Summary mode.
2872 Summary line format is specified by @code{wl-summary-line-format}.
2873 You can use control strings defined by
2874 @code{wl-summary-line-format-spec-alist}.
2880 ;; @r{number temporary-mark persistent-mark date branch}
2881 ;; @r{[ (number-of-children) sender ] subject}
2882 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
2886 Where the number set the column number of the field (for negative value,
2889 Major control strings defined by @code{wl-summary-line-format-spec-alist}
2890 are displayed in the following list.
2901 %t branch of the thread
2902 %[ [ (< for re-connected child)
2903 %] ] (> for re-connected child)
2907 %c +number-of-children: (display only for opened thread)
2908 %C [+number-of-children] (display only for opened thread)
2909 %T temporary mark (mandatory)
2910 %P persistent mark (mandatory)
2914 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
2915 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
2916 the constant column. For example, if you specify @samp{%T} or
2917 @samp{%P} after the @samp{%t}, which changes its length by thread
2918 position, marks are not treated correctly.
2920 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
2921 column of the enclosed region is justified to the `number'. Multiple
2922 level @samp{%number(} parenthesis can be defined. It is useful to
2923 justify the column of the multiple control strings. For example, in the
2924 above @code{wl-summary-line-format},
2930 means ``Adjust number-of-children and sender string to the 17 column''.
2932 You can specify the format by each folders with
2933 @code{wl-folder-summary-line-format-alist}. Please set regular
2934 expression for folder names and summary line format as the following
2939 (setq wl-folder-summary-line-format-alist
2940 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
2941 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
2945 @subsection on the format for sender name
2947 The format string @samp{%f} displays the return value of the function specified
2948 by @code{wl-summary-from-function}. If you use the function
2949 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
2950 while displays the recipient names if the folder name matches with
2951 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
2952 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
2954 For example, to display recipient names for the message in @samp{+backup} if
2955 its sender is yourself, set up as follows.
2958 (setq wl-summary-showto-folder-regexp "^\\+backup$")
2962 @node Key Bindings of Summary, Variables of Summary, Summary View, Summary
2963 @section Key bindings
2964 @cindex Keybind, Summary Mode
2965 @cindex Keybind, Summary Buffer
2967 Key bindings of the summary mode are shown below.
2971 @kindex @key{SPC} (Summary)
2972 @findex wl-summary-read
2973 Proceed reading a message at the current cursor point.
2974 (@code{wl-summary-read})
2978 @findex wl-summary-redisplay
2979 Redisplay a message at the current cursor point.
2980 If this command is called with prefix argument,
2981 Redisplay message regardless of the message cache (message is re-loaded
2983 (@code{wl-summary-redisplay})
2987 @findex wl-summary-display-top
2988 Display the top message in the folder.
2989 (@code{wl-summary-display-top})
2993 @findex wl-summary-display-bottom
2994 Display the bottom message in the folder.
2995 (@code{wl-summary-display-bottom})
2999 @kindex @key{BS} (Summary)
3000 @kindex @key{DEL} (Summary)
3001 Display the previous page of the message at the current cursor point.
3002 @findex wl-summary-prev-page
3003 (@code{wl-summary-prev-page})
3006 @kindex @key{RET} (Summary)
3007 @findex wl-summary-next-line-content
3008 Display the next line of the message at the current cursor point.
3009 Display the message at the current cursor point if it is not displayed yet.
3010 (@code{wl-summary-next-line-content})
3015 @kindex M-@key{RET} (Summary)
3016 @findex wl-summary-prev-line-content
3017 Display the previous line of the message at the current cursor point.
3018 Display the message at the current cursor point if it is not displayed yet.
3019 (@code{wl-summary-prev-line-content})
3023 @findex wl-thread-open-close
3024 Toggle open or close the thread at the current cursor point.
3025 (@code{wl-thread-open-close})
3030 @findex wl-thread-open-all
3031 (@code{wl-thread-open-all})
3036 @findex wl-thread-close-all
3037 (@code{wl-thread-close-all})
3041 @findex wl-summary-goto-folder
3043 (@code{wl-summary-goto-folder})
3047 Mark all messages in the folder as read.
3048 @findex wl-summary-mark-as-read-all
3049 (@code{wl-summary-mark-as-read-all})
3053 @findex wl-summary-reply
3054 Prepare a draft for reply the message at the current cursor point.
3055 (@code{wl-summary-reply})
3059 @findex wl-summary-reply-with-citation
3060 Prepare a draft for reply the message at the current cursor point.
3061 (@code{wl-summary-reply-with-citation})
3065 @findex wl-summary-cancel-message
3066 If the message at current cursor point is your own netnews article,
3068 (@code{wl-summary-cancel-message})
3072 @findex wl-summary-reedit
3073 Prepare a draft for re-editing the message at current cursor point.
3074 If the message at current cursor point is your own netnews article,
3075 a draft for `supersedes message' for the message is prepared.
3076 (@code{wl-summary-reedit})
3079 @kindex M-E (Summary)
3080 @findex wl-summary-resend-bounced-mail
3081 If the message at current cursor point is a bounced message,
3082 a draft for re-sending original message is prepared.
3083 (@code{wl-summary-resend-bounced-mail})
3087 @findex wl-summary-forward
3088 A draft for forwarding the message at current cursor point is prepared.
3089 (@code{wl-summary-forward})
3093 @findex wl-summary-mark-as-important
3094 Put @samp{$} mark on the message at current cursor point.
3095 If already marked as @samp{$}, remove the mark.
3096 (@code{wl-summary-mark-as-important})
3102 Save the message at current cursor point.
3103 @findex wl-summary-save
3104 (@code{wl-summary-save})
3108 @findex wl-summary-next
3109 Move cursor to the next message.
3110 If message is marked with a temporal mark in
3111 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3112 In the offline mode, cursor is not moved to the messages which are not cached
3114 (@code{wl-summary-next})
3118 @findex wl-summary-prev
3119 Move cursor to the previous message.
3120 If message is marked with a temporal mark in
3121 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3122 In the offline mode, cursor is not moved to the messages which are not cached
3124 (@code{wl-summary-prev})
3128 @findex wl-summary-down
3129 Move cursor to the downward message which is unread or marked
3131 In the offline mode, cursor is not moved to the messages which are not cached
3133 If there are messages which have target mark @samp{*} in the summary,
3134 cursor is moved to the downward message which have a target mark.
3135 This behavior is changed according to the value of @code{wl-summary-move-order}.
3136 (@code{wl-summary-down})
3140 @findex wl-summary-up
3141 Move cursor to the upward message which is unread or marked
3143 In the offline mode, cursor is not moved to the messages which are not cached
3145 If there are messages which have target mark @samp{*} in the summary,
3146 cursor is moved to the downward message which have a target mark.
3147 This behavior is changed according to the value of @code{wl-summary-move-order}.
3148 (@code{wl-summary-up})
3152 @findex wl-summary-write
3153 Prepare a new draft.
3154 (@code{wl-summary-write})
3158 @findex wl-summary-write-current-folder
3159 Prepare a new draft. If the current folder is NNTP folder,
3160 @samp{Newsgroups:} field is completed. If the current folder is mailing
3161 list folder (refile destination), guess @samp{To:} field and completed
3162 (If @code{wl-subscribed-mailing-list} is valid list)
3163 (@code{wl-summary-write-current-folder})
3167 @findex wl-summary-redisplay-all-header
3168 Redisplay the message at current cursor point with all header fields.
3169 (@code{wl-summary-redisplay-all-header})
3173 @findex wl-summary-redisplay-no-mime
3174 Redisplay the message at current cursor point without MIME analysis.
3175 (@code{wl-summary-redisplay-no-mime})
3179 @findex wl-summary-burst
3180 If the message at current cursor point has
3181 encapsulates multiple messages using MIME,
3182 de-capsulate and extract them on the current folder.
3183 If it is invoked in non-writable folder or it is called with prefix
3184 argument, it asks the destination folder.
3185 (@code{wl-summary-burst})
3188 @kindex @@ (Summary)
3189 @findex wl-summary-edit-addresses
3190 Append/change/delete the message's sender information to the address
3191 book @file{~/.addresses} interactively. If this command is called with
3192 prefix argument, arbitrary address can be edited.
3193 (@code{wl-summary-edit-petname})
3197 @findex wl-status-update
3198 Sync up address book status with @file{~/.addresses}'s content.
3199 (@code{wl-status-update})
3203 @findex wl-summary-pipe-message
3204 Pipe current message's content to the external process.
3205 (@code{wl-summary-pipe-message})
3209 @findex wl-summary-print-message
3210 Print out current message's content.
3211 It uses @code{ps-print} module in Emacs 20.x.
3212 If you don't use color printer, you might want to set
3213 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3216 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3219 (@code{wl-summary-print-message})
3223 @findex wl-summary-exit
3224 Exit current folder.
3225 (@code{wl-summary-exit})
3229 @findex wl-summary-jump-to-current-message
3230 Jump cursor to the currently displayed message's window.
3231 (@code{wl-summary-jump-to-current-message})
3235 Jump cursor to the other message.
3236 @findex wl-summary-jump-to-msg
3237 (@code{wl-summary-jump-to-msg})
3241 Update summary status and
3242 prefetch all messages which have marks included in the
3243 @code{wl-summary-incorporate-marks}.
3244 @findex wl-summary-incorporate
3245 (@code{wl-summary-incorporate})
3248 @kindex M-j (Summary)
3249 @findex wl-summary-jump-to-msg-by-message-id
3250 Jump cursor to the message which have specified @samp{Message-Id:}. If
3251 @code{elmo-use-database} is non-nil, other folder is also searched.
3252 (@code{wl-summary-jump-to-msg-by-message-id})
3256 Jump to parent message.
3257 @findex wl-summary-jump-to-parent-message
3258 (@code{wl-summary-jump-to-parent-message})
3262 @findex wl-summary-mark-as-unread
3263 Mark as unread the message at current cursor point.
3264 (@code{wl-summary-mark-as-unread})
3268 @findex wl-summary-sync
3269 Synchronize summary view after prompting the update range.
3270 You can specify one of the follows.
3274 all Discard present msgdb and retrieve all informations.
3275 Do not retrieve killed messages.
3276 all-entirely Discard present msgdb and retrieve all informations.
3277 Retrieve killed messages, too.
3278 update Update the difference between informations in present
3279 msgdb and in current folder instance.
3280 Do not retrieve killed messages.
3281 update-entirely Update the difference between informations in present
3282 msgdb and in current folder instance.
3283 Retrieve killed messages, too.
3284 rescan Redisplay summary by rescanning present msgdb.
3285 rescan-noscore Redisplay summary by rescanning present msgdb.
3286 Display messages killed by score, too.
3287 cache-status Sync the all marks with the real status of cache.
3290 first:NUM Move to the filter folder(partial filter).
3291 last:NUM Move to the filter folder(partial filter).
3296 (@code{wl-summary-sync})
3300 @findex wl-summary-sort
3302 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3303 (@code{wl-summary-sort})
3307 @findex wl-summary-toggle-thread
3308 Toggle the threading. The state will be preserved after exiting
3309 Wanderlust. You can alter default state for newly created summary
3310 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3311 Threading status is displayed on the modeline.
3312 @samp{@{S@}} means threading is off (Sequence) and
3313 @samp{@{T@}} means threading is on (Thread).
3314 (@code{wl-summary-toggle-thread})
3318 @findex wl-summary-toggle-disp-folder
3319 Toggle displaying of folder window.
3320 (@code{wl-summary-toggle-disp-folder})
3324 Toggle displaying of message window.
3325 @findex wl-summary-toggle-disp-msg
3326 (@code{wl-summary-toggle-disp-msg})
3330 Move to the virtual folder (filter folder) with the condition specified.
3331 If called with prefix argument and current folder is virtual, exit it.
3332 @findex wl-summary-virtual
3333 (@code{wl-summary-virtual})
3336 @kindex @key{TAB} (Summary)
3337 @findex wl-summary-goto-last-displayed-msg
3338 Jump to the message which is displayed last.
3339 (@code{wl-summary-goto-last-displayed-msg})
3343 Put @samp{*} mark on the messages that satisfies the specified condition.
3344 @findex wl-summary-pick
3345 (@code{wl-summary-pick})
3349 @findex wl-summary-mark-as-read
3350 Mark as read the message at the current cursor point.
3351 (@code{wl-summary-mark-as-read})
3355 Execute action for all temporary marks in the summary buffer.
3356 @findex wl-summary-exec
3357 (@code{wl-summary-exec})
3361 @findex wl-summary-target-mark-line
3362 Put target mark on the message at the current cursor point.
3363 (@code{wl-summary-target-mark-line})
3367 Put refile mark on the message at the current cursor point.
3368 @findex wl-summary-refile
3369 (@code{wl-summary-refile})
3372 @kindex C-o (Summary)
3373 Execute auto refile.
3374 @findex wl-summary-auto-refile
3375 (@code{wl-summary-auto-refile})
3379 Put copy mark on the message at the current cursor point.
3380 @findex wl-summary-copy
3381 (@code{wl-summary-copy})
3384 @kindex M-o (Summary)
3385 Put refile mark on the message at the current cursor point with the destination
3386 previously specified.
3387 @findex wl-summary-refile-prev-destination
3388 (@code{wl-summary-refile-prev-destination})
3392 @findex wl-summary-dispose
3393 Put disposal mark on the message at the current cursor point.
3394 The result of disposal is controlled by @code{wl-dispose-folder-alist},
3395 refiled to @code{wl-trash-folder} by default.
3396 (@code{wl-summary-dispose})
3400 @findex wl-summary-delete
3401 Put force deletion mark on the message at the current cursor point.
3402 (@code{wl-summary-delete})
3406 Put prefetch reservation mark on the message at the current cursor point.
3407 @findex wl-summary-prefetch
3408 (@code{wl-summary-prefetch})
3412 @findex wl-summary-resend
3413 Put resend reservation mark on the message at the current cursor point.
3414 (@code{wl-summary-resend})
3418 @findex wl-summary-unmark
3419 Unmark the temporal mark on the message at the current cursor point.
3420 (@code{wl-summary-unmark})
3424 Unmark all the temporal marks.
3425 @findex wl-summary-unmark-all
3426 (@code{wl-summary-unmark-all})
3429 @kindex r R (Summary)
3430 @findex wl-summary-mark-as-read-region
3431 Mark as read messages in the specified region.
3432 (@code{wl-summary-mark-as-read-region})
3435 @kindex r $ (Summary)
3436 @findex wl-summary-mark-as-important-region
3437 Mark as important @samp{$} messages in the specified region.
3438 If @samp{$} mark already exists, remove the mark.
3439 (@code{wl-summary-mark-as-important-region})
3442 @kindex r ! (Summary)
3443 @findex wl-summary-mark-as-unread-region
3444 Mark as unread messages in the specified region.
3445 (@code{wl-summary-mark-as-unread-region})
3448 @kindex r x (Summary)
3449 @findex wl-summary-exec-region
3450 Execute action for each temporary marks on the messages in the
3452 (@code{wl-summary-exec-region})
3455 @kindex r * (Summary)
3456 @findex wl-summary-target-mark-region
3457 Put target mark on the messages in the specified region.
3458 (@code{wl-summary-target-mark-region})
3461 @kindex r o (Summary)
3462 @findex wl-summary-refile-region
3463 Put refile mark on the messages in the specified region.
3464 (@code{wl-summary-refile-region})
3467 @kindex r O (Summary)
3468 @findex wl-summary-copy-region
3469 Put copy mark on the messages in the specified region.
3470 (@code{wl-summary-copy-region})
3473 @kindex r d (Summary)
3474 @findex wl-summary-dispose-region
3475 Put disposal mark on the messages in the specified region.
3476 (@code{wl-summary-dispose-region})
3479 @kindex r i (Summary)
3480 @findex wl-summary-prefetch-region
3481 Put prefetch reservation mark on messages in the specified region.
3482 (@code{wl-summary-prefetch-region})
3485 @kindex r u (Summary)
3486 @findex wl-summary-unmark-region
3487 Delete temporal mark on the messages in the specified region.
3488 (@code{wl-summary-unmark-region})
3491 @kindex r y (Summary)
3492 Save messages in the specified region.
3493 @findex wl-summary-save-region
3494 (@code{wl-summary-save-region})
3497 @kindex t R (Summary)
3498 @findex wl-thread-mark-as-read
3499 Mark as read messages which are the descendant of the current thread.
3500 With prefix argument, it affects on the all messages in the thread tree.
3501 (@code{wl-thread-mark-as-read})
3504 @kindex t $ (Summary)
3505 @findex wl-thread-mark-as-important
3506 Put important mark @samp{$} on the messages which are the
3507 descendant of the current thread.
3508 If @samp{$} mark exists, remove the mark.
3509 With prefix argument, it affects on the all messages in the thread tree.
3510 (@code{wl-thread-mark-as-important})
3513 @kindex t ! (Summary)
3514 @findex wl-thread-mark-as-unread
3515 Mark as unread messages which are the descendant of the current thread.
3516 With prefix argument, it affects on the all messages in the thread tree.
3517 (@code{wl-thread-mark-as-unread})
3520 @kindex t x (Summary)
3521 @findex wl-thread-exec
3522 Execute action for temporary marks on the messages which are
3523 the descendant of the current thread. With prefix argument, it affects
3524 on the all messages in the thread tree.
3525 (@code{wl-thread-exec})
3528 @kindex t * (Summary)
3529 @findex wl-thread-target-mark
3530 Put target mark @samp{*} on the messages which are the descendant of the
3531 current thread. With prefix argument, it affects on the all messages in
3533 (@code{wl-thread-target-mark})
3536 @kindex t o (Summary)
3537 @findex wl-thread-refile
3538 Put refile mark on the messages which are the descendant of the current thread.
3539 With prefix argument, it affects on the all messages in the thread tree.
3540 (@code{wl-thread-refile})
3543 @kindex t O (Summary)
3544 @findex wl-thread-copy
3545 Put copy mark on the messages which are the descendant of the current thread.
3546 With prefix argument, it affects on the all messages in the thread tree.
3547 (@code{wl-thread-copy})
3550 @kindex t d (Summary)
3551 @findex wl-thread-dispose
3552 Put disposal mark on the messages which are the descendant of the current thread.
3553 With prefix argument, it affects on the all messages in the thread tree.
3554 (@code{wl-thread-dispose})
3557 @kindex t i (Summary)
3558 @findex wl-thread-prefetch
3559 Put prefetch reservation mark on messages which are the descendant of
3561 (@code{wl-thread-prefetch})
3564 @kindex t u (Summary)
3565 @findex wl-thread-unmark
3566 Unmark temporal mark on the messages which are the descendant of the
3567 current thread. With prefix argument, it affects on the all messages in
3569 (@code{wl-thread-unmark})
3572 @kindex t y (Summary)
3573 @findex wl-thread-save
3574 Save messages which are the descendant of the current thread.
3575 With prefix argument, it affects on the all messages in the thread tree.
3576 (@code{wl-thread-save})
3579 @kindex m R (Summary)
3580 @findex wl-summary-target-mark-mark-as-read
3581 Mark as read all messages which have target mark @samp{*}.
3582 (@code{wl-summary-target-mark-mark-as-read})
3585 @kindex m $ (Summary)
3586 @findex wl-summary-target-mark-mark-as-important
3587 Mark as important all messages which have target mark @samp{*}.
3588 If already marked as @samp{$}, remove the mark.
3589 (@code{wl-summary-target-mark-mark-as-important})
3592 @kindex m ! (Summary)
3593 @findex wl-summary-target-mark-mark-as-unread
3594 Mark as unread all messages which have target mark @samp{*}.
3595 (@code{wl-summary-target-mark-mark-as-unread})
3598 @kindex m o (Summary)
3599 @findex wl-summary-target-mark-refile
3600 Put refile mark on the messages which have target mark @samp{*}.
3601 (@code{wl-summary-target-mark-refile})
3604 @kindex m O (Summary)
3605 @findex wl-summary-target-mark-copy
3606 Put copy mark on the messages which have target mark @samp{*}.
3607 (@code{wl-summary-target-mark-copy})
3610 @kindex m d (Summary)
3611 @findex wl-summary-target-mark-dispose
3612 Put disposal mark on the messages which have target mark @samp{*}.
3613 (@code{wl-summary-target-mark-dispose})
3616 @kindex m i (Summary)
3617 @findex wl-summary-target-mark-prefetch
3618 Put prefetch reservation mark on messages which have target mark @samp{*}.
3619 (@code{wl-summary-target-mark-prefetch})
3622 @kindex m y (Summary)
3623 @findex wl-summary-target-mark-save
3624 Save messages which have target mark @samp{*}.
3625 (@code{wl-summary-target-mark-save})
3628 @kindex m u (Summary)
3629 Unmark all temporal marks.
3630 (@code{wl-summary-delete-all-temp-marks})
3631 @findex wl-summary-delete-all-temp-marks
3634 @kindex m a (Summary)
3635 Put target mark @samp{*} on the all messages.
3636 (@code{wl-summary-target-mark-all})
3637 @findex wl-summary-target-mark-all
3640 @kindex m t (Summary)
3641 Put target mark @samp{*} on the messages in the current thread.
3642 @findex wl-summary-target-mark-thread
3643 (@code{wl-summary-target-mark-thread})
3646 @kindex m r (Summary)
3647 @findex wl-summary-target-mark-region
3648 Put target mark @samp{*} on the messages in the specified region.
3649 (@code{wl-summary-target-mark-region})
3652 @kindex m A (Summary)
3653 @findex wl-summary-target-mark-reply-with-citation
3654 Prepare a draft which cites all messages which have target mark @samp{*}.
3655 (@code{wl-summary-target-mark-reply-with-citation})
3658 @kindex m f (Summary)
3659 @findex wl-summary-target-mark-forward
3660 Prepare a draft which forwards all messages which have target mark @samp{*}.
3661 (@code{wl-summary-target-mark-forward})
3664 @kindex m U (Summary)
3665 @findex wl-summary-target-mark-uudecode
3666 Uudecode the messages which have target mark @samp{*}.
3667 (@code{wl-summary-target-mark-uudecode})
3670 @kindex m ? (Summary)
3671 @findex wl-summary-target-mark-pick
3672 Pick messages from the @samp{*} marked messages.
3673 That is, @samp{*} marks on the messages are remained
3674 if the specified condition is satisfied.
3675 (@code{wl-summary-target-mark-pick})
3678 @kindex m # (Summary)
3679 @findex wl-summary-target-mark-print
3680 Print out all messages which have target mark @samp{*}.
3681 (@code{wl-summary-target-mark-print})
3684 @kindex m | (Summary)
3685 @findex wl-summary-target-mark-pipe
3686 Pipe content of each message with target mark @samp{*} to some specified
3688 (@code{wl-summary-target-mark-pipe})
3691 @kindex M-t (Summary)
3692 @findex wl-toggle-plugged
3693 Toggle offline/online status of Wanderlust.
3694 (@code{wl-toggle-plugged})
3697 @kindex C-t (Summary)
3698 Start Wanderlust's plug-status manager.
3699 (@code{wl-plugged-change})
3702 @kindex C-c C-o (Summary)
3703 @findex wl-jump-to-draft-buffer
3704 Move to the draft buffer if available. If multiple draft buffer exists,
3705 moved to one after another. If prefix argument is specified, load draft
3706 folder's message to the draft buffer and jump to it.
3707 (@code{wl-jump-to-draft-buffer})
3710 @kindex M-w (Summary)
3711 @findex wl-summary-save-current-message
3712 Save the message at the current cursor point.
3713 (@code{wl-summary-save-current-message})
3716 @kindex C-y (Summary)
3717 @findex wl-summary-yank-saved-message
3718 Regard the message at the current cursor point as
3719 parent, connect the message saved by
3720 @code{wl-summary-save-current-message}
3722 (@code{wl-summary-yank-saved-message})
3725 @kindex C-x C-s (Summary)
3726 @findex wl-summary-save-status
3727 Save the current summary.
3728 (@code{wl-summary-save-status})
3732 @node Variables of Summary, , Key Bindings of Summary, Summary
3733 @section Customiziable variables
3736 @item wl-summary-move-order
3737 @vindex wl-summary-move-order
3738 The initial setting is @code{unread}. Specify cursor moving policy. If
3739 you want to precede new messages, set @code{new}. If you want to
3740 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3743 @item wl-auto-select-first
3744 @vindex wl-auto-select-first
3745 The initial setting is @code{nil}.
3746 If non-nil, first message is automatically displayed when you enter
3749 @item wl-auto-select-next
3750 @vindex wl-auto-select-next
3751 The initial setting is @code{nil}. This controls behavior when there is
3752 no unread message in current summary.
3755 nil: asks whether you want to go back to folder mode
3756 'unread: asks whether you want to go to next unread folder
3757 If the next one comes to be possessing no unread message
3758 by treatment of cross-posted messages or Scoring, then
3759 asks whether you want to go to next to next folder.
3760 'skip-no-unread: similar as unread
3761 But does not ask before going to next to next folder.
3762 otherwise: asks whether you want to go to next unread folder
3765 It might be useful to set @code{'skip-no-unread} for people who
3766 want to continue reading by just pressing and pressing space key.
3768 @item wl-thread-insert-opened
3769 @vindex wl-thread-insert-opened
3770 The initial setting is @code{nil}.
3771 If non-nil, thread is inserted as opened.
3773 @item wl-thread-open-reading-thread
3774 @vindex wl-thread-open-reading-thread
3775 The initial setting is @code{t}. If non-nil, reading thread is
3776 automatically opened though it is closed thread.
3778 @item wl-summary-exit-next-move
3779 @vindex wl-summary-exit-next-move
3780 The initial setting is @code{t}. If non-nil, move to next folder at
3783 @item wl-folder-move-cur-folder
3784 @vindex wl-folder-move-cur-folder
3785 The initial setting is @code{nil}. If non-nil, cursor position on the
3788 @item wl-summary-weekday-name-lang
3789 @vindex wl-summary-weekday-name-lang
3790 Specify language of the weekday.
3791 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3792 displays Deutsch. You should rescan summary view after changing this value.
3794 @item wl-summary-fix-timezone
3795 @vindex wl-summary-fix-timezone
3796 The initial setting is @code{nil}.
3797 Time zone of the date string in summary mode is adjusted using this value.
3798 If @code{nil}, it is adjust to the default time zone information
3799 (system's default time zone or environment variable @samp{TZ}).
3801 @item wl-use-petname
3802 @vindex wl-use-petname
3803 The initial setting is @code{t}.
3804 If non-nil, sender part displays nickname.
3806 @item wl-break-pages
3807 @vindex wl-break-pages
3808 The initial setting is @code{t}.
3809 If non-nil, message is split as pages by @samp{^L}.
3811 @item wl-message-window-size
3812 @vindex wl-message-window-size
3813 The initial setting is '(1 . 4).
3814 A cons cell to specify the rate of summary and message window.
3815 car:cdr corresponds summary:message.
3817 @item wl-summary-from-function
3818 @vindex wl-summary-from-function
3819 Format function to display sender in summary.
3820 The initial setting is @code{wl-summary-default-from}.
3822 @item wl-summary-no-from-message
3823 @vindex wl-summary-no-from-message
3824 The initial setting is @samp{nobody@@nowhere?}. A string which is
3825 displayed when there's no @samp{From:} field in the message.
3827 @item wl-summary-subject-function
3828 @vindex wl-summary-subject-function
3829 Format function to display subject in summary.
3830 The initial setting is @code{wl-summary-default-subject} and
3831 it will cut the list name part etc. on the top of the subject.
3832 To display subject as it is, set as follows.
3835 (setq wl-summary-subject-function 'identity)
3838 @item wl-summary-no-subject-message
3839 @vindex wl-summary-no-subject-message
3840 The initial setting is @samp{(WL:No Subject in original.)}. A string
3841 which is displayed when there's no @samp{Subject:} field in the message.
3843 @item wl-summary-default-view
3844 @vindex wl-summary-default-view
3845 The initial setting is @code{'thread}.
3846 The default state for newly created summary. You can set either
3847 @code{'thread} for thread view or @code{'sequence} for sequential view.
3849 @item wl-summary-use-frame
3850 @vindex wl-summary-use-frame
3851 The initial setting is @code{nil}.
3852 If non-nil, use new frame for the summary.
3854 @item wl-use-folder-petname
3855 @vindex wl-use-folder-petname
3856 The initial setting is the list shown below:
3865 A list of display policy (symbol) of folder nickname. Available symbols
3870 Display folder petname on modeline.
3872 Destination folder is notified as nickname if
3873 @code{wl-auto-select-next} is non-nil.
3875 You can input folder name by nickname in the function
3876 @code{wl-summary-read-folder}.
3879 @item wl-summary-move-direction-toggle
3880 @vindex wl-summary-move-direction-toggle
3881 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3882 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3883 want to aware of reading direction, set this to @code{t}.
3885 @item wl-summary-width
3886 @vindex wl-summary-width
3887 The initial setting is 80.
3888 Width of summary line. If @code{nil}, summary line's width is as is.
3890 @item wl-summary-from-width
3891 @vindex wl-summary-from-width
3892 The initial setting is 17.
3893 Width of sender part of summary line.
3895 @item wl-summary-indent-length-limit
3896 @vindex wl-summary-indent-length-limit
3897 The initial setting is 46.
3898 Specify the limit of thread indent level. @code{nil} means unlimited
3900 If you set this to @code{nil} you should set @code{wl-summary-width}
3903 @item wl-summary-max-thread-depth
3904 @vindex wl-summary-max-thread-depth
3905 The initial setting is 15.
3906 If thread depth of the message is larger than this value,
3907 the thread is divided.
3909 @item wl-summary-recenter
3910 @vindex wl-summary-recenter
3911 The initial setting is t.
3912 If non-nil, cursor point is moved to the center of the summary window.
3914 @item wl-summary-divide-thread-when-subject-changed
3915 @vindex wl-summary-divide-thread-when-subject-changed
3916 The initial setting is @code{nil}. If non-nil, thread is split if
3917 the subject is changed.
3919 @item wl-summary-search-via-nntp
3920 @vindex wl-summary-search-via-nntp
3921 The initial setting is @code{confirm}.
3923 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3924 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3925 from the NNTP server @code{elmo-nntp-default-server}. The value of
3926 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3927 @code{elmo-nntp-default-stream-type} are used.
3929 If @code{confirm}, server name can be specified. You can specify NNTP
3930 folder format like @samp{-:username@@servername:119!}.
3932 @item wl-summary-keep-cursor-command
3933 @vindex wl-summary-keep-cursor-command
3934 The initial setting is the list shown below:
3938 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3943 When you entered to summary by these commands and the target summary
3944 buffer already exists, summary status is not automatically updated and
3945 cursor position is saved.
3947 @item elmo-folder-update-threshold
3948 @vindex elmo-folder-update-threshold
3949 The initial setting is 500. If updated message number is larger than
3950 this value, confirm whether drop them or not (in the case where the value
3951 of @code{elmo-folder-update-confirm} is non-nil).
3953 @item elmo-folder-update-confirm
3954 @vindex elmo-folder-update-confirm
3955 The initial setting is @code{t}. If the value is non-nil, do check with
3956 @code{elmo-folder-update-threshold}.
3958 @item wl-summary-always-sticky-folder-list
3959 @vindex wl-summary-always-sticky-folder-list
3960 The initial setting is @code{nil}.
3961 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3962 are automatically stuck. Each element is regexp of folder name.
3964 @item wl-summary-reserve-mark-list
3965 @vindex wl-summary-reserve-mark-list
3966 The initial setting is the list shown below:
3975 If a message is already marked as temporal marks in this list, the
3976 message is not marked by any mark command.
3978 @item wl-summary-skip-mark-list
3979 @vindex wl-summary-skip-mark-list
3980 The initial setting is the list shown below:
3989 If a message is already marked as temporal marks in this list, the
3990 message is skipped at cursor move.
3992 @item elmo-message-fetch-threshold
3993 @vindex elmo-message-fetch-threshold
3994 The initial setting is 30000 (bytes). If displaying message has larger
3995 size than this value, Wanderlust confirms whether fetch the message or
3996 not (in the case where the value of @code{elmo-message-fetch-confirm}
3999 @item elmo-message-fetch-confirm
4000 @vindex elmo-message-fetch-confirm
4001 The initial setting is @code{t}. If the value is non-nil, do check with
4002 @code{elmo-message-fetch-threshold}.
4004 @item wl-prefetch-threshold
4005 @vindex wl-prefetch-threshold
4006 The initial setting is 30000 (bytes). If prefetching message has larger
4007 size than this value and @code{wl-prefetch-confirm} is non-nil,
4008 Wanderlust confirms whether prefetch the message or not. If
4009 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
4010 without confirmation.
4012 @item wl-prefetch-confirm
4013 @vindex wl-prefetch-confirm
4014 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4015 prefetch the message or not if the message has larger size than
4016 @code{wl-prefetch-threshold}.
4018 @item elmo-imap4-use-cache
4019 @vindex elmo-imap4-use-cache
4020 The initial setting is @code{t}. If non-nil, messages read via IMAP4
4023 @item elmo-nntp-use-cache
4024 @vindex elmo-nntp-use-cache
4025 The initial setting is @code{t}. If non-nil, messages read via NNTP are
4028 @item elmo-pop3-use-cache
4029 @vindex elmo-pop3-use-cache
4030 The initial setting is @code{t}. If non-nil, messages read via POP3 are
4033 @item elmo-shimbun-use-cache
4034 @vindex elmo-shimbun-use-cache
4035 The initial setting is @code{t}. If non-nil, messages read in Shimbun
4038 @item wl-folder-process-duplicates-alist
4039 @vindex wl-folder-process-duplicates-alist
4040 The initial setting is @code{nil}.
4041 This list determines how to deal with duplicated messages in the same folder.
4042 Each item in the list is regexp of folder name and action; you can specify any
4043 one of the following in the place of action:
4046 @code{nil} : do nothing for duplicated messages.
4047 @code{hide} : hide duplicated messages from the summary.
4048 @code{read} : set duplicated messages as read.
4052 Following is an example (hide duplicated messages in multi folders)
4056 (setq wl-folder-process-duplicates-alist
4057 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4058 ("^\\*.*" . hide) (".*" . read)))
4064 @node Message, Draft, Summary, Top
4065 @chapter Message Buffer
4067 Message Buffers utilize MIME-View mode of SEMI. For operational
4068 procedures and key bindings, refer to respective documents.
4069 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4070 You can also see help by @kbd{?} in message buffer.
4072 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4073 brings you back to Summary mode. @kbd{l} toggles display of Summary
4076 @section Key Bindings
4082 @findex wl-message-toggle-disp-summary
4083 Toggles display of Summary buffer.
4084 (@code{wl-message-toggle-disp-summary})
4087 @findex wl-message-refer-article-or-url
4088 @kindex Button-2 (Message)
4089 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4090 corresponding message if found.
4091 (@code{wl-message-refer-article-or-url})
4093 @item Button-4 (upward movement of a wheel)
4094 @kindex Button-4 (Message)
4095 @findex wl-message-wheel-down
4096 Scrolls the message backwards. When the top of the message is hit,
4097 moves to the previous message.
4098 (@code{wl-message-wheel-down})
4100 @item Button-5 (downward movement of a wheel)
4101 @kindex Button-5 (Message)
4102 @findex wl-message-wheel-up
4103 Scrolls the message forward. When the bottom of the message is hit,
4104 moves to the next message.
4105 (@code{wl-message-wheel-up})
4109 @findex wl-message-delete-current-part
4110 Delete the part under cursor. In fact it appends modified message to
4111 the current folder then moves old one to trash folder. Therefore the
4112 message number will be changed.
4113 (@code{wl-message-delete-current-part})
4116 @section Customizable Variables
4119 @item wl-message-window-size
4120 @vindex wl-message-window-size
4121 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4122 its car and cdr value corresponds to the ratio of Summary and Message
4125 @item wl-message-ignored-field-list
4126 @vindex wl-message-ignored-field-list
4127 (SEMI only) Initial setting is @code{nil}.
4128 All fields that match this list will be hidden in message buffer.
4129 Each elements are regexp of field-name.
4130 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4132 @item wl-message-visible-field-list
4133 @vindex wl-message-visible-field-list
4134 (SEMI only) Initial setting is @code{nil}.
4135 All fields that match this list will be display in message buffer.
4136 Each elements are regexp of field-name. This value precedes
4137 @code{wl-message-ignored-field-list}.
4138 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4140 @item wl-message-sort-field-list
4141 @vindex wl-message-sort-field-list
4142 (SEMI only) Initial setting is
4143 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4144 Header fields in message buffer are ordered by this value.
4145 Each elements are regexp of field-name.
4147 @item wl-message-truncate-lines
4148 @vindex wl-message-truncate-lines
4149 The initial value is the value of @code{default-truncate-lines}.
4150 If it is non-nil, truncate long lines in message buffer.
4153 @node Draft, Disconnected Operations, Message, Top
4154 @chapter Draft Buffer
4156 At Summary mode, pressing @kbd{w} and the like creates a new draft
4157 buffer. You can edit and send mail and news articles in this buffer.
4159 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4160 with those if possible.
4163 * Usage of Draft Mode:: TIPS
4164 * Key Bindings of Draft:: Key bindings
4165 * Variables of Draft Mode:: Customize Draft Mode
4168 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4171 Basically it is Emacs-standard mail mode.
4175 * Editing Message Body::
4176 * Dynamical Message Re-arrangement::
4181 @node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
4182 @subsection Editing Message Header
4184 You can freely edit header region above @samp{--text follows this line--},
4185 until you invoke the sending operation.
4187 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4188 addresses. @kbd{@key{TAB}} completes them.
4190 You can use following headers to specify recipients. Add some of them
4191 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4194 @item @samp{Newsgroups:}
4195 Specify newsgroups to which you post the news article.
4198 Specify addresses to send a copy (Carbon Copy) of the message.
4201 Following ones are removed from the header contents before sending.
4205 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4208 Specify folders in which a copy of the message is saved.
4211 Specify recipients to send encapsulated copy of the message.
4214 You can add initial headers by following variables.
4220 The initial setting is @code{nil}.
4221 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4222 the draft when it is prepared. If function is specified, its return
4227 The initial setting is @code{nil}.
4228 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4229 the draft when it is prepared.
4232 @node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4233 @subsection Editing Messages
4235 As a matter of course, editing message body can be performed in the same
4236 way as usual writing. You may write message body under
4237 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4238 @samp{--text follows this line--} intact.)
4240 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4241 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4242 a MIME user interface for GNU Emacs}.
4243 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4245 If you save the draft buffer you are editing, it is appended to the
4246 folder specified by @code{wl-draft-folder}.
4248 @node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
4249 @subsection Dynamic Modification of Messages
4250 @vindex wl-draft-config-alist
4251 @c @cindex Change Message
4252 @c @cindex Message, Change Dynamic
4254 You can set @code{wl-draft-config-alist} so that header and body of the
4255 message will automatically modified depending on information of header
4258 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4260 In the example below, the header is modified when
4261 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4262 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4263 before sending the message.
4267 (setq wl-draft-config-alist
4268 '(((string-match "aaa\\.example\\.com$" (system-name))
4269 ;; @r{applied if the expression is non-nil}
4270 (wl-smtp-posting-server . "mailserver-B")
4271 (wl-nntp-posting-server . "newsserver-B")
4272 ;; @r{settings of temporary variables}
4274 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4275 ;; @r{applied if it matches the header of the draft buffer}
4276 ("Organization" . (format "Go %s" my-webpage)))
4277 ;; @r{you can write elisp expressions here (eval only)}
4278 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4279 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4284 The format of @code{wl-draft-config-alist} is:
4288 '(("@var{regexp of the header}" or @var{elisp expression}
4289 ("@var{Field}" . value(@var{elisp expression}))
4290 (@var{variable} . value(@var{elisp expression}))
4291 (@var{sub-function} . value(@var{elisp expression}))
4294 ("@var{regexp of the header}" or @var{elisp expression}
4295 ("@var{Field}" . value(@var{elisp expression}))
4300 Per default, there are 10 following sub-functions.
4303 'header: Inserts the specified string at the bottom of the header.
4304 'header-top: Inserts the specified string at the top of the header.
4305 'header-file: Inserts the specified file at the bottom of the header.
4306 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4307 'top: Inserts the specified string at the top of the body.
4308 'top-file: Inserts the specified file at the top of the body.
4309 'body: Replaces the body with the specified string.
4310 Specifying @code{nil} deletes the entire body string.
4311 'body-file: Replaces the body with the content of the specified file.
4312 'bottom: Inserts the specified string at the bottom of the body.
4313 'bottom-file: Inserts the specified file at the top of the body.
4314 'part-top: Inserts the specified string at the top of the current part.
4315 'part-bottom: Inserts the specified string at the bottom of the current part.
4316 'template: Applies the specified template.
4317 (refer to the next subsection)
4320 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4321 change them or add your own functions. If you read the code, you can
4322 easily find how to write the functions.
4324 At the first of each item, @var{a regular expression of the header} or
4325 an @var{elisp expression} should be specified. In the case of an elisp
4326 expression, the item is applied when the expression is evaluated
4329 Per default, when multiple items match or are evaluated non-nil, all
4330 such items are applied, but if you set a variable
4331 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4334 At the second of the item, a cons or a list of functions should be
4335 specified. The car part of the cons should be a header field, a
4336 variable, or a sub-function. When a header field is specified, the
4337 field will be modified. If a variable is specified, the value of the
4338 variable will be modified temporarily.
4340 In the cdr part of a cons, not only a variable but also an elisp
4341 expression can be specified as is. If the car part is a header field
4342 and the cdr part is @code{nil}, the field will be deleted.
4344 See the next example as well:
4348 (setq wl-draft-config-alist
4350 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4351 ;; @r{applied if it matches the header of the buffer being replied}
4352 (body . " Hello.\n")
4353 (template . "default")
4358 As in the (1) above, if a header regexp is prepended with @code{reply},
4359 it is applied when the draft is prepared by @code{wl-summary-reply} for
4360 example, and when it matches the header being replied. It is ignored
4361 when there is no buffer being replied, like after @code{wl-draft} was
4364 If you want to use name of parent folder, you can refer the buffer local
4365 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4366 changes From according to the folder name of the summary in which the draft
4371 (setq wl-draft-config-alist
4372 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4373 (\"From\" . \"user@@domain1\"))
4374 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4375 (\"From\" . \"user@@domain2\"))))
4380 Note that @code{wl-draft-config-alist} is applied only once when
4381 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4382 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4383 aborting transmission, execute @kbd{C-c C-e}
4384 (@code{wl-draft-config-exec}) explicitly.
4386 If you don't want to apply @code{wl-draft-config-alist} when
4387 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4391 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4394 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4395 prepared, do the following:
4398 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4401 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4402 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4406 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4409 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4410 @subsection Inserting Templates
4412 @cindex Apply Template
4414 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4415 @kbd{M-x wl-template-select} in the draft buffer.
4417 The format of @code{wl-template-alist} is almost the same as
4418 @code{wl-draft-config-alist}.
4422 (setq wl-template-alist
4425 ("Organization" . "Example Co.Ltd.")
4426 (body . "Hello.\n"))
4428 (template . "default") ;; @r{(a)}
4429 ("To" . "boss@@example.com")
4430 ("Subject" . "Report")
4431 (body-file . "~/work/report.txt")
4437 As you can see, the only difference is item (template) names such as
4438 @samp{default} and @samp{report}, instead of a regexp of header.
4439 Because definition of each item is the same as
4440 @code{wl-draft-config-alist}, you can call another template, like (a).
4442 Executing the command @code{wl-template-select} results in template
4443 selection, but the result differs depending on variable
4444 @code{wl-template-visible-select}.
4446 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4447 window is shown below the draft buffer. You can select a template by
4448 @kbd{n} and @kbd{p} seeing the buffer window.
4450 Press the @key{RET} key and the template is actually applied to the draft
4451 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4452 adjust the window size by @code{wl-template-buffer-lines}.
4454 If @code{wl-template-visible-select} is @code{nil}, you should type the
4455 name of the template in the mini buffer.
4457 As shown in the example in @code{wl-draft-config-alist}, you can select
4458 @samp{default} template by writing:
4461 (template . "default")
4464 @node POP-before-SMTP, , Template, Usage of Draft Mode
4465 @subsection Sending mail by POP-before-SMTP
4466 @cindex POP-before-SMTP
4468 You can send mail by POP-before-SMTP with this single line:
4471 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4475 Configure the following variables if you need.
4478 @item wl-pop-before-smtp-user
4479 The POP user name for POP-before-SMTP authentication.
4480 If unset, @code{elmo-pop3-default-user} is used.
4482 @item wl-pop-before-smtp-server
4483 The POP server name for POP-before-SMTP authentication.
4484 If unset, @code{elmo-pop3-default-server} is used.
4486 @item wl-pop-before-smtp-authenticate-type
4487 The POP authentication method for POP-before-SMTP authentication.
4488 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4490 @item wl-pop-before-smtp-port
4491 The POP port number for POP-before-SMTP authentication.
4492 If unset, @code{elmo-pop3-default-port} is used.
4494 @item wl-pop-before-smtp-stream-type
4495 If non-nil, POP connection is established using SSL. If
4496 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4497 unset, @code{elmo-pop3-default-stream-type} is used.
4500 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4501 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4503 Therefore, if SMTP server and POP server are actually the same, and if
4504 POP folder per default (such as @samp{&}) is available, no settings are
4507 Refer to the following URL about POP-before-SMTP.
4511 http://spam.ayamura.org/tools/smPbS.html
4512 http://www.iecc.com/pop-before-smtp.html
4517 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4518 @section Key Bindings
4519 @cindex Keybind, Draft Mode
4520 @cindex Keybind, Draft Buffer
4525 @kindex C-c C-y (Draft)
4526 @findex wl-draft-yank-original
4527 Cites the content of the current message buffer (the part under cursor).
4528 If the region is active, cites the region (it affects only if
4529 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4530 (on XEmacs) is Non-nil).
4531 (@code{wl-draft-yank-original})
4534 @kindex C-c C-p (Draft)
4535 @findex wl-draft-preview-message
4536 Previews the content of the current draft.
4537 This is useful for previewing MIME multi-part messages.
4538 (@code{wl-draft-preview-message})
4541 @kindex C-c C-s (Draft)
4542 @findex wl-draft-send
4543 Sends the content of the current draft. Does not erase the draft buffer.
4544 This is useful for sending multiple messages, which are a little different
4546 (@code{wl-draft-send})
4549 @kindex C-c C-c (Draft)
4550 @findex wl-draft-send-and-exit
4551 Sends the content of the current draft and erases the draft buffer.
4552 (@code{wl-draft-send-and-exit})
4555 @kindex C-x C-s (Draft)
4556 @findex wl-draft-save
4557 Save the current draft.
4558 (@code{wl-draft-save})
4561 @kindex C-c C-k (Draft)
4562 @findex wl-draft-kill
4563 Kills the current draft.
4564 (@code{wl-draft-kill})
4567 @kindex C-x k (Draft)
4568 @findex wl-draft-mimic-kill-buffer
4569 Kills the current draft.
4570 (@code{wl-draft-mimic-kill-buffer})
4573 @kindex C-c C-z (Draft)
4574 @findex wl-draft-save-and-exit
4575 Saves the current draft, and erases the draft buffer.
4576 This is useful if you want to suspend editing of the draft.
4577 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4578 the @samp{+draft} folder.
4579 (@code{wl-draft-save-and-exit})
4582 @kindex C-c C-r (Draft)
4583 @findex wl-caesar-region
4584 Encodes or decodes the specified region in Caesar cipher.
4585 (@code{wl-caesar-region})
4589 @findex wl-draft-highlight-and-recenter
4590 Recenter and rehighlight current draft.
4591 (@code{wl-draft-highlight-and-recenter})
4595 @findex wl-toggle-plugged
4596 Toggles off-line/on-line states of Wanderlust.
4597 (@code{wl-toggle-plugged})
4600 @kindex C-c C-o (Draft)
4601 @findex wl-jump-to-draft-buffer
4602 Jumps to the other draft buffer, if exists.
4603 With prefix argument, reads a file (if any) from the draft folder when
4604 there is no such buffer.
4605 (@code{wl-jump-to-draft-buffer})
4608 @kindex C-c C-e (Draft)
4609 @findex wl-draft-config-exec
4610 Applies @code{wl-draft-config-alist}.
4611 (@code{wl-draft-config-exec})
4614 @kindex C-c C-j (Draft)
4615 @findex wl-template-select
4617 (@code{wl-template-select})
4620 @kindex C-c C-a (Draft)
4622 Enter Address Manager.
4623 @xref{Address Manager}.
4627 @kindex C-c C-d (Draft)
4628 @findex wl-draft-elide-region
4629 Elide the text between point and mark (@code{wl-draft-elide-region}).
4630 The text is killed and replaced with the contents of the variable
4631 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4635 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4636 @section Customizable Variables
4639 @item wl-subscribed-mailing-list
4640 @vindex wl-subscribed-mailing-list
4641 The initial setting is @code{nil}. Mailing lists to which you
4642 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4643 field of a reply draft, removes your own address from
4644 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4645 contained in @samp{To:} or @samp{Cc:} field of a message to be
4646 automatically re-filed, the destination folder will be leaned in
4647 connection with the address.
4653 (setq wl-subscribed-mailing-list
4654 '("wl@@lists.airs.net"
4656 "emacs-mime-ja@@m17n.org"))
4660 @item wl-insert-mail-followup-to
4661 @vindex wl-insert-mail-followup-to
4662 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4663 field is automatically inserted in the draft buffer.
4665 @item wl-insert-mail-reply-to
4666 @vindex wl-insert-mail-reply-to
4667 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4668 field is automatically inserted in the draft buffer.
4670 @item wl-auto-insert-x-face
4671 @vindex wl-auto-insert-x-face
4672 The initial setting is @code{t}. If non-nil and there is an encoded
4673 X-Face string in a file @file{~/.xface} (the value of the variable
4674 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4675 draft buffer. If @code{nil}, it is not automatically inserted.
4677 @item wl-insert-message-id
4678 @vindex wl-insert-message-id
4679 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4680 is automatically inserted on the transmission.
4682 @item wl-message-id-use-wl-from
4683 @vindex wl-message-id-use-wl-from
4684 The initial setting is @code{nil}. If non-nil, the value of
4685 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4687 @item wl-local-domain
4688 @vindex wl-local-domain
4689 The initial setting is @code{nil}. If @code{nil}, the return value of
4690 the function @code{system-name} will be used as the domain part of
4693 If @code{system-name} does not return FQDN (i.e. the full name of the
4694 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4695 to the string of the local domain name without hostname (like
4696 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4697 @samp{.} @code{wl-local-domain} is used as domain part of the
4700 If your terminal does not have global IP, set the value of
4701 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4702 you use invalid @samp{Message-ID:}.)
4704 Moreover, concatenation of @code{system-name} @samp{.}
4705 @code{wl-local-domain} will be used as an argument to the HELO command
4708 @item wl-message-id-domain
4709 @vindex wl-message-id-domain
4710 The initial setting is @code{nil}. If non-nil, this value is used as a
4711 domain part of the @samp{Message-ID:}. If your terminal does not have
4712 global IP address, set unique string to this value (e.x. your e-mail
4715 @item wl-unique-id-suffix
4716 @vindex wl-unique-id-suffix
4717 The initial setting is @samp{.wl}. You can specify the string in generated
4718 Message-ID which appear just before @samp{@@}.
4720 @item wl-draft-config-alist
4721 @vindex wl-draft-config-alist
4722 The initial setting is @code{nil}. Modifies the draft message just
4723 before the transmission. The content of @code{wl-draft-config-alist}
4724 will be automatically applied only once on the transmission. If you
4725 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4728 @item wl-template-alist
4729 @vindex wl-template-alist
4730 The initial setting is @code{nil}.
4731 This variable specifies the template to be applied in the draft buffer.
4733 @item wl-draft-config-matchone
4734 @vindex wl-draft-config-matchone
4735 The initial setting is @code{nil}. If non-nil, only the first matching
4736 item is used when @code{wl-draft-config-alist} is applied. If
4737 @code{nil}, all matching items are used.
4739 @item wl-template-visible-select
4740 @vindex wl-template-visible-select
4741 The initial setting is @code{t}.
4742 If non-nil, you can preview the result of the template selection in
4745 @item wl-template-confirm
4746 @vindex wl-template-confirm
4747 The initial setting is @code{nil}.
4748 If non-nil, asks for confirmation when you press the enter key to select
4749 template while previewing.
4751 @item wl-template-buffer-lines
4752 @vindex wl-template-buffer-lines
4753 The initial setting is 7.
4754 If @code{wl-template-visible-select} is non-nil, this variable specifies
4755 the size of the preview window.
4757 @item wl-draft-buffer-style
4758 @vindex wl-draft-buffer-style
4759 The initial setting is @code{full}.
4760 Style of draft buffer window (except for replying and forwarding).
4761 @code{keep} is to use current window,
4762 @code{full} is to use full frame window,
4763 @code{split} is to split current window and use it.
4764 If some function is specified, it is called with the draft buffer
4767 @item wl-draft-reply-buffer-style
4768 @vindex wl-draft-reply-buffer-style
4769 The initial setting is @code{split}.
4770 Style of draft buffer for replying and forwarding.
4771 @code{keep} is to use message buffer window,
4772 @code{full} is to use full frame window,
4773 @code{split} is to split message buffer window and use it.
4774 If some function is specified, it is called with the draft buffer
4777 @item wl-draft-use-frame
4778 @vindex wl-draft-use-frame
4779 The initial setting is @code{nil}.
4780 If non-nil, use new frame for the draft.
4782 @item wl-draft-truncate-lines
4783 @vindex wl-draft-truncate-lines
4784 The initial value is the value of @code{default-truncate-lines}.
4785 If it is non-nil, truncate long lines in draft buffer.
4789 The initial setting is the value of the variable
4790 @code{user-mail-address}. The value of this variable is inserted as a
4791 @samp{From:} field of the draft when it is prepared.
4793 @item wl-envelope-from
4794 @vindex wl-envelope-from
4795 The initial setting is @code{nil}.
4796 The value of this variable is used for envelope from (MAIL FROM).
4797 If @code{nil}, the address part of @code{wl-from} is used.
4799 @item wl-user-mail-address-list
4800 @vindex wl-user-mail-address-list
4801 The initial setting is @code{nil}.
4802 This is the User's address list. If you have multiple addresses,
4805 @item wl-reply-subject-prefix
4806 @vindex wl-reply-subject-prefix
4807 The initial setting is @samp{Re: }.
4808 In the @samp{Subject:} of the reply draft, this string is prepended to
4809 the @samp{Subject:} of being replied.
4811 @item wl-forward-subject-prefix
4812 @vindex wl-forward-subject-prefix
4813 The initial setting is @samp{Forward: }.
4814 In the @samp{Subject:} of the forwarding draft, this string is prepended
4815 to the @samp{Subject:} of being forwarded.
4817 @item wl-draft-reply-use-address-with-full-name
4818 @vindex wl-draft-reply-use-address-with-full-name
4819 The initial setting is @code{t}.
4820 If non-nil, insert her full name with address when prepare a draft for
4821 reply a message. If it is @code{nil}, insert her address only.
4823 @item wl-draft-enable-queuing
4824 @vindex wl-draft-enable-queuing
4825 The initial setting is @code{t}.
4826 This flag controls off-line transmission. If non-nil, the draft is
4829 @item wl-draft-use-cache
4830 @vindex wl-draft-use-cache
4831 The initial setting is @code{nil}. If the value is non-nil and
4832 @code{wl-insert-message-id} is nil, cache the message which is sent.
4834 @item wl-fcc-force-as-read
4835 @vindex wl-fcc-force-as-read
4836 The initial setting is @code{nil}. If the value is non-nil,
4837 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4839 @item wl-auto-flush-queue
4840 @vindex wl-auto-flush-queue
4841 The initial setting is t.
4842 This flag controls automatic transmission of the queue when Wanderlust
4843 becomes on-line. If non-nil, the queue is automatically transmitted
4844 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4845 manually, press @kbd{F} in the folder mode.
4847 @item wl-ignored-forwarded-headers
4848 @vindex wl-ignored-forwarded-headers
4849 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4850 All headers that match this regexp will be deleted when forwarding a message.
4852 @item wl-ignored-resent-headers
4853 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4854 All headers that match this regexp will be deleted when resending a message.
4856 @item wl-draft-always-delete-myself
4857 @vindex wl-draft-always-delete-myself
4858 If non-nil, always removes your own address from @samp{To:} and
4859 @samp{Cc:} when you are replying to the mail addressed to you.
4861 @item wl-draft-delete-myself-from-bcc-fcc
4862 @vindex wl-draft-delete-myself-from-bcc-fcc
4863 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4864 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
4866 @item wl-smtp-posting-server
4867 @vindex wl-smtp-posting-server
4868 The initial setting is @code{nil}.
4869 This is the SMTP server name for mail transmission.
4871 @item wl-smtp-posting-port
4872 @vindex wl-smtp-posting-port
4873 The initial setting is @code{nil}.
4874 This is the SMTP port number for mail transmission.
4875 If @code{nil}, default SMTP port number (25) is used.
4877 @item wl-smtp-posting-user
4878 @vindex wl-smtp-posting-user
4879 The initial setting is @code{nil}.
4880 This is the user name for SMTP AUTH authentication. If @code{nil},
4881 @code{smtp-authenticate-user} is used.
4883 @item wl-smtp-authenticate-type
4884 @vindex wl-smtp-authenticate-type
4885 The initial setting is @code{nil}.
4886 This is the authentication method for SMTP AUTH authentication. If
4887 @code{nil}, @code{smtp-authenticate-type} is used. If
4888 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4891 @item wl-smtp-connection-type
4892 @vindex wl-smtp-connection-type
4893 The initial setting is @code{nil}.
4894 This variable specifies how to establish SMTP connections.
4895 If @code{nil}, @code{smtp-connection-type} is used.
4896 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4898 @item wl-nntp-posting-server
4899 @vindex wl-nntp-posting-server
4900 The initial setting is @code{nil}.
4901 This is the NNTP server name used for news submission.
4902 If @code{nil}, @code{elmo-nntp-default-server} is used.
4904 @item wl-nntp-posting-user
4905 @vindex wl-nntp-posting-user
4906 The initial setting is @code{nil}.
4907 This is the user name for AUTHINFO authentication on news submission.
4908 If @code{nil}, @code{elmo-nntp-default-user} is used.
4909 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4911 @item wl-nntp-posting-port
4912 @vindex wl-nntp-posting-port
4913 The initial setting is @code{nil}.
4914 This is the port number of the NNTP server used for news submission.
4915 If @code{nil}, @code{elmo-nntp-default-server} is used.
4917 @item wl-nntp-posting-stream-type
4918 @vindex wl-nntp-posting-stream-type
4919 The initial setting is @code{nil}.
4920 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4921 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4922 connection will be established.
4924 @item wl-nntp-posting-function
4925 @vindex wl-nntp-posting-function
4926 The initial setting is @code{elmo-nntp-post}.
4927 This is the function to post NNTP message.
4929 @item wl-nntp-posting-config-alist
4930 @vindex wl-nntp-posting-config-alist
4931 The initial setting is @code{nil}.
4932 The value takes an alist to define NNTP server like following example.
4933 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
4937 (setq wl-nntp-posting-config-alist
4938 '((",?gmane\\." . "news.gmane.org")
4940 ((server . "news-server")
4941 (user . "newsmaster")
4943 (function . elmo-nntp-post)))
4944 (".*" . "default-news-server")))
4948 @item wl-pop-before-smtp-user
4949 @vindex wl-pop-before-smtp-user
4950 The initial setting is @code{nil}.
4951 This is the POP user name for POP-before-SMTP.
4952 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4954 @item wl-pop-before-smtp-server
4955 @vindex wl-pop-before-smtp-server
4956 The initial setting is @code{nil}.
4957 This is the POP server name for POP-before-SMTP.
4958 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4960 @item wl-pop-before-smtp-authenticate-type
4961 @vindex wl-pop-before-smtp-authenticate-type
4962 The initial setting is @code{nil}.
4963 This is the authentication method for POP-before-SMTP authentication.
4964 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4966 @item wl-pop-before-smtp-port
4967 @vindex wl-pop-before-smtp-port
4968 The initial setting is @code{nil}.
4969 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4970 @code{elmo-pop3-default-port} is used.
4972 @item wl-pop-before-smtp-stream-type
4973 @vindex wl-pop-before-smtp-stream-type
4974 The initial setting is @code{nil}.
4975 This flag controls the use of SSL for POP-before-SMTP. If it is
4976 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4977 STARTTLS (RFC2595) connection will be established.
4979 @item wl-draft-queue-save-variables
4980 @vindex wl-draft-queue-save-variables
4981 Specifies a list of variable to which queued messages are saved on the
4982 off-line transmission.
4984 @item wl-draft-sendlog
4985 @vindex wl-draft-sendlog
4986 The initial setting is @code{t}.
4987 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4991 @item drafts are sent by smtp or qmail
4992 @item saved into folders by fcc
4993 @item saved into folders by queuing
4996 (it is written even if the transmission fails).
4997 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4998 and left to the logging function of @command{imput}.
5001 @item wl-draft-sendlog-max-size
5002 @vindex wl-draft-sendlog-max-size
5003 The initial setting is 20000 (in bytes).
5004 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
5005 beyond the size specified by this variable.
5009 The initial setting is @code{nil}.
5010 If non-nil, address completion uses LDAP.
5012 @item wl-ldap-server
5013 @vindex wl-ldap-server
5014 The initial setting is @samp{localhost}.
5015 LDAP server name for address completion.
5018 @vindex wl-ldap-port
5019 The initial setting is @code{nil}.
5020 If non-nil, the value is used as port number.
5023 @vindex wl-ldap-base
5024 The initial setting is @samp{c=US}.
5025 LDAP search starting point (base) for address completion.
5027 @item wl-draft-remove-group-list-contents
5028 @vindex wl-draft-remove-group-list-contents
5029 The initial setting is @code{t}.
5030 If non-nil, remove the group-lists' members in the recipients when
5031 sending the message (group-list means the description such as
5032 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5035 @node Disconnected Operations, Expire and Archive, Draft, Top
5036 @chapter Off-line Management
5037 @cindex Disconnected Operations
5039 Wanderlust has on-line and off-line states.
5042 * Off-line State:: Wanderlust has on-line and off-line states
5043 * Enable Operations:: Enable Disconnected Operations
5044 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5045 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5046 * Variables of Plugged Mode:: Customize Plugged Mode
5050 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5051 @section Off-line State
5053 Wanderlust has on-line and off-line states. In the off-line state, you
5054 cannot access messages via network, unless they are cached.
5056 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5057 in the mode line indicates the off-line state. In folder or summary
5058 modes, press @kbd{M-t} to switch between off- and on-line.
5060 You can invoke Wanderlust in the off-line state by setting
5061 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5063 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5064 ignores uncached messages.
5067 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5068 @section Enable Disconeected Operations
5070 Even in the off-line state, provided that relevant messages are cached,
5071 and the variable @code{elmo-enable-disconnected-operation} (described
5072 later) is non-nil, you can following operations:
5073 @xref{Plugged Mode}, @xref{Off-line State settings}.
5076 * Send Messages off-line:: Transmit Messages
5077 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5078 * Creation of Folders:: Create Folders off-line (IMAP4)
5079 * Marking:: Mark (IMAP4)
5080 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
5083 As soon as Wanderlust becomes on-line, such operations invoked off-line
5084 are reflected in the servers via network.
5087 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5088 @subsection Transmission of Messages
5090 You can proceed sending operation for mail/news messages while you are
5091 off-line, then it will be reserved for sending (if you are using
5092 @file{im-wl.el}, it is irrelevant).
5093 Messages reserved for sending while off-line are accumulated in the
5094 queue folder, @samp{+queue}. These messages are transmitted at once when
5095 Wanderlust becomes on-line.
5097 You can visit @samp{+queue} in the off-line state and confirm content of
5098 messages in the queue. You can also remove messages. Removed messages
5099 are not transmitted even in the on-line state.
5102 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5103 @subsection Re-file and Copy (IMAP4)
5105 Re-file and copy operations to IMAP folders invoked during the off-line
5106 state are accumulated in the queue, and reflected in the server side
5107 when Wanderlust becomes on-line. If you visit destination folders after
5108 off-line re-file or copy, it looks as if messages were appended even in
5111 For the safety reasons, messages re-filed off-line are removed from
5112 source folders only if their @samp{Message-ID:} match messages on the
5113 servers. While the queue is processed, messages that failed to be
5114 re-filed or copied to the specified folders are appended to the folder
5118 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5119 @subsection Creation of Folders (IMAP4)
5121 You can create IMAP folders off-line. The creation of folders are
5122 reflected in the servers when Wanderlust becomes on-line. If the creation
5123 of those folders fails at that time for some reasons, messages
5124 to be re-filed into those are appended to the folder @samp{+lost+found}
5128 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5129 @subsection Marking (IMAP4)
5131 Off-line changes in unread/read and importance mark @samp{$} information
5132 are also reflected in the servers when Wanderlust becomes on-line.
5135 @node Pre-fetching Reservations, , Marking, Enable Operations
5136 @subsection Pre-fetching (IMAP4, NNTP)
5138 You can make reservations for pre-fetching messages in IMAP or NNTP
5139 folders. Reserved messages are marked with @samp{!} but not cached
5140 yet. When Wanderlust becomes on-line, they are pre-fetched from
5143 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5144 these off-line operations for IMAP4 and NNTP do not take place, and
5145 off-line re-file, copy or suchlike simply results in error.
5147 Because off-line operations use cache files, it is a bad idea to erase
5148 them by hand; it may cause Wanderlust to malfunction.
5150 If you want to remove caches, be sure to execute @kbd{M-x
5151 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5152 remove caches for messages relevant to off-line operations.
5155 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5156 @section Switching On-line/Off-line per Server/Port
5158 @kbd{M-t} described above switches networking states as a whole, but you
5159 can switch on-line/off-line per server/port.
5161 Pressing @kbd{C-t} in the folder or summary modes brings you in
5162 wl-plugged-mode shown below, in which you can change the plugged state
5167 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5170 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5171 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5173 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5174 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5180 The first line indicates status of the following three variables, and
5181 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5182 column modifies the values of these variables.
5186 "Queuing" @code{wl-draft-enable-queuing}
5187 "AutoFlushQueue" @code{wl-auto-flush-queue}
5188 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5192 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5195 The second and after lines indicate on-line/off-line states of servers
5196 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5197 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5198 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5200 @dfn{sending queue} means messages accumulated in the folder
5201 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5202 off-line operations when @code{elmo-enable-disconnected-operation} is
5204 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5205 @c off-line operations are enabled.
5207 They are displayed if there are any of them. In the example above, in
5208 the sending queue there are two messages (the first and the second in
5209 the queue folder) for smtp to hosta and one (the third) for nntp to
5210 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5213 If you change @samp{(wl-plugged)} in the second line, the variable
5214 @code{wl-plugged} is changed, so that the mode line indicator and
5215 plugged states of all ports are affected. If you change plugged states
5216 of any servers or ports, @samp{(wl-plugged)} in the second line is
5217 affected depending on @code{elmo-plugged-condition} settings and the
5218 plugged state of each port.
5221 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5222 @section Invoking Wanderlust in the Off-line State
5224 As described before, if you set @code{wl-plugged} to @code{nil} in
5225 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5226 off-line state. You can specify off-line state on a per server or port
5227 basis. Refer to @code{wl-reset-plugged-alist} also.
5229 Usually, when Wanderlust starts up, the plugged state of each port is
5230 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5231 @code{wl-nntp-posting-server} and so on. If you want to change the
5232 plugged state of these ports or to add other ports, configure
5233 @code{wl-make-plugged-hook} with a function.
5237 (add-hook 'wl-make-plugged-hook
5239 (elmo-set-plugged plugged-value(t/nil) server port)
5240 ;; @r{add or change plugged states of the port of the server}
5241 (elmo-set-plugged plugged-value(t/nil) server)
5242 ;; @r{if the port is omitted, all ports are affected}
5243 ;; @r{(you cannot omit the port if you newly add the server)}
5249 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5250 @section Customizable Variables
5255 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5256 mode from the beginning.
5258 @item wl-queue-folder
5259 @vindex wl-queue-folder
5260 The initial setting is @samp{+queue}.
5261 This is the folder in which messages in the transmission queue are
5264 @item wl-auto-flush-queue
5265 @vindex wl-auto-flush-queue
5266 The initial setting is @code{t}.
5267 This flag controls automatic transmission of the queue when Wanderlust
5268 becomes on-line. If non-nil, the queue is automatically transmitted
5269 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5270 manually, press @kbd{F} in the folder mode.
5272 @item elmo-enable-disconnected-operation
5273 @vindex elmo-enable-disconnected-operation
5274 The initial setting is @code{t}. Controls off-line operations
5275 regarding IMAP4. If non-nil, off-line operations are carried out.
5277 @item elmo-lost+found-folder
5278 @vindex elmo-lost+found-folder
5279 The initial setting is @samp{+lost+found}.
5280 This is the folder to which messages are saved when they fails to be
5281 appended while the off-line re-file/copy queue is processed.
5283 @item elmo-plugged-condition
5284 @vindex elmo-plugged-condition
5285 The initial setting is @code{one}.
5286 The value of @code{wl-plugged} reflects the return value of the function
5287 @code{elmo-plugged-p} (without arguments).
5288 This variable @code{elmo-plugged-condition} specifies the condition on
5289 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5290 plugged state of each port.
5293 'one : plugged if one or more ports are plugged.
5294 'all : plugged if all ports are plugged.
5295 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5296 states of the ports.
5297 @var{function} : reflects the return value of the @var{function}
5298 functions available per default
5299 'elmo-plug-on-by-servers
5300 : reflects the plugged state of the servers specified by the
5301 variable elmo-plug-on-servers.
5302 'elmo-plug-on-by-exclude-servers
5303 : reflects the plugged state of the servers that are not
5304 in elmo-plug-on-exclude-servers.
5305 elmo-plug-on-exclude-servers defaults to
5308 (system-name)without the domain part)
5314 (setq elmo-plugged-condition 'all)
5316 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5317 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5319 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5320 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5324 @item wl-reset-plugged-alist
5325 @vindex wl-reset-plugged-alist
5326 The initial setting is @code{t}. If non-nil, plugged states are
5327 initialized on a per server or port basis when Wanderlust starts up.
5329 If @code{nil}, plugged states are retained while Emacs is running. In
5330 other words, they are initialized when Emacs is restarted even if the
5331 value is @code{nil}.
5335 @node Expire and Archive, Scoring, Disconnected Operations, Top
5336 @chapter Automatic Expiration and Archiving of Messages
5337 @cindex Expire and Archive
5340 * Expire:: Expiration and Archiving
5341 * Archive:: Archiving All Messages
5345 @node Expire, Archive, Expire and Archive, Expire and Archive
5347 @cindex Expire Message
5349 Expiration means deletion of old messages which have outlasted a
5350 certain period of time.
5352 @code{wl-expire} supports not only simple deletion, but also moving to
5353 specified archiving folders.
5357 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5358 or @kbd{M-e} in the summary mode.
5360 @subsection Configuring @code{wl-expire-alist}
5362 An example configuration of @code{wl-expire-alist} is shown below.
5363 Everything in this @code{wl-expire-alist} makes a great difference in
5364 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5365 to @code{t}, especially in the initial stage.
5369 (setq wl-expire-alist
5370 '(("^\\+trash$" (date 14) remove)
5372 ("^\\+tmp$" (date 7) trash)
5373 ;; @r{re-file to @code{wl-trash-folder}}
5374 ("^\\+outbox$" (number 300) "$outbox;lha")
5375 ;; @r{re-file to the specific folder}
5377 ;; @r{do not expire}
5378 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5379 ;; @r{archive by message number (retaining numbers)}
5380 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5381 ;; @r{archive by a fixed number (retaining numbers)}
5382 ("^\\+diary$" (date 30) wl-expire-archive-date)
5383 ;; @r{archive by year and month (numbers discarded)}
5388 Items in the list has the format of:
5391 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5395 The folder is examined if it matches @var{regexp-for-folders} from the
5396 beginning of the list. If you invoke expiration on the folder that does
5397 not match any of them, nothing will happen. And if either the second or
5398 the third element of the item is @code{nil}, expiration will not take
5401 You can use any one of the following for
5402 @var{specification-of-message-to-be-deleted}:
5405 @item (number @var{n1} [@var{n2}])
5406 deletes messages depending on the number of messages in the folder.
5408 @var{n1} is the number of messages which should survive deletion, for example
5409 if its value is 500, the newest 500 messages survive and the rests are
5412 @var{n2} is the number of messages in the folder on which expiration should
5413 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5414 folders with 510 or more messages are expired.
5415 If you configured automatic expiration, frequently used folders may
5416 expire every time it receive messages, and you may be annoyed with the
5417 long delay in reading mail.
5418 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5419 expiration would not take place until a certain number of messages
5422 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5423 with important/new/unread) are not deleted.
5424 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5425 will expire so as to have 500 messages including such ones.
5426 Otherwise, it will have 500 messages except such ones.
5428 @item (date @var{d1})
5429 deletes messages depending on the dates.
5431 Messages dated @var{d1} or more days ago are deleted, for example if its
5432 value is seven, messages seven days old or more are deleted. Note that
5433 the date is the one in the @samp{Date:} field of the message, not when
5434 the message entered the folder.
5436 Messages with no or invalid @samp{Date:} field does not expire; you
5437 might have to delete them by hand.
5440 You can use any one of the following in the place of @var{destination}:
5444 deletes the messages instantly.
5447 hide the messages from summary (messages are not deleted).
5450 moves the messages to @code{wl-trash-folder}.
5452 @item @var{string}(folder)
5453 moves the messages to the folder specified with @var{string}.
5455 It would be useful for specifying an archiving folder, but because this
5456 does not move important messages, it might be better to use the
5457 standard functions described below.
5459 @item @var{function}
5460 invokes the specified @var{function}.
5462 To the @var{function}, three arguments are passed: a folder name, a list
5463 of messages to be deleted, and msgdb information of the summary. You
5464 can specify function-specific arguments after the name of the
5465 @var{function}. Note that the list contains messages with marks in
5466 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5469 These are four standard functions; three of them move messages to an archive
5470 folder in the specified way. This means old messages can be compressed
5471 and saved in a file, being deleted from the original folder.
5472 The last one divides messages to some MH folders.
5475 @item wl-expire-archive-number1
5476 re-files to archiving folders corresponding to the message numbers of
5477 the messages being deleted. For example, a message numbered 102 will be
5478 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5479 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5480 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5482 The archiving folders to which messages are re-filed are determined by
5483 the name of the folder as follows (in this case, archiving folders are
5484 handled as if @code{elmo-archive-treat-file} were non-nil).
5487 @item If the folder type is localdir:
5488 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5490 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5491 (@file{~/Mail/ml/wl-00100.zip}).
5493 @item The folder type is other than localdir:
5494 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5496 For example, @samp{%#mh/ml/wl} corresponds to
5497 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5500 As you can see, in the case of localdir, the folder type is not included
5501 in the path name, but otherwise it is included.
5502 And you can control the prefix to the archiving folder name by
5503 @code{wl-expire-archive-folder-prefix}.
5504 Refer to @code{wl-expire-archive-folder-prefix} for details.
5506 @item wl-expire-archive-number2
5507 re-files every certain number of messages to archiving folders.
5509 This differs from @samp{wl-expire-archive-number1} in that this re-files
5510 to the folder up to the specified number regardless of message numbers.
5511 The archiving folders to which messages are re-filed are determined in the
5512 same way as @code{wl-expire-archive-number1}.
5514 @item wl-expire-archive-date
5515 re-files messages depending on its date (year and month) to archive
5518 For example, a message dated December 1998 is re-filed to
5519 @code{$folder-199812;zip}. The name of the archiving folders except the
5520 date part are determined in the same way as
5521 @code{wl-expire-archive-number1}.
5524 You can set the first argument to these three standard functions to non-nil
5525 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5526 For example, it can be specified just after the name of the function:
5529 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5532 If you omit the argument, consecutive numbers from 1 are assigned for
5533 each archiving folder.
5535 @item wl-expire-localdir-date
5536 divedes messages depending on its date (year and month) to MH folders
5537 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5541 @subsection Treatment for Important or Unread Messages
5543 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5544 standard function, messages with marks in
5545 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5546 messages} thereafter) are retained.
5548 Per default, this variable include the important, new, and unread marks,
5549 so that messages with these marks are not removed.
5550 Note that you cannot include the temporary mark (i.e. temporary marks
5551 are removed anyway), and be sure to process temporary marks before you
5554 @subsection Auto Expiration
5556 The following setup invokes expiration when you move into the summary
5557 mode. There will be no confirmation, so make sure you made no mistake
5558 in regexp and other settings before you set up this.
5562 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5566 In the folder mode, you can invoke expiration per group as well as per
5567 folder. Therefore, if you specify @samp{Desktop} group, all folders
5568 matching @code{wl-expire-alist} expire.
5572 @subsection Treating archive folders.
5573 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5574 you must set non-nil value to @code{elmo-archive-treat-file}.
5576 @subsection Confirming
5578 If you are to use @code{remove}, try @code{trash} at first and see
5579 messages move to @code{wl-trash-folder} as expected, then replace it
5580 with @code{remove}. It would be dangerous to use @code{remove} from the
5583 If you are to use @code{wl-expire-archive-number1} and the like, try to
5584 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5585 you can append messages to it. Even if settings in
5586 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5587 would not be saved anywhere and disappeared in case the archiver program
5590 After you make sure you can archive to the folder correctly, you can
5591 invoke expiration and utilize the log.
5593 If you set @code{wl-expire-use-log} to @code{t},
5594 @file{~/.elmo/expired-log} should contain the log, for example:
5598 delete +ml/wl (593 594 595 596 597 598 599)
5599 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5603 The first column indicates the operation, i.e. @samp{delete},
5604 @samp{copy}, or @samp{move}. The next is the name of the folder that
5605 expired. In the case of @samp{copy} and @samp{move}, the destination
5606 folder is recorded after @samp{->}. The last is the list of message
5607 numbers that are actually deleted or moved (in the case of @samp{copy}
5608 and @samp{move}, the number is the one in the source folder, rather than
5609 the destination folder).
5611 @subsection Re-filing Reserved Messages
5613 The three standard functions copy reserved messages to the archive
5614 folder, but do not delete them from the source folder. Because
5615 reserved messages and the like always remain, they are recorded in
5616 @file{~/.elmo/expired-alist} so that they are not copied over and over
5617 again. They are not recorded if copied by @code{wl-summary-archive}.
5619 If you enabled logging, usually @samp{move} is recorded for re-filing,
5620 but instead @samp{copy} and @samp{delete} are recorded separately if
5621 reserved messages are involved. This is because it actually copies
5622 messages including reserved, then deletes ones except reserved in that
5625 @section Customizable Variables
5628 @item wl-expire-alist
5629 @vindex wl-expire-alist
5630 The initial setting is @code{nil}.
5631 This variable specifies folders and methods to expire. For details,
5632 refer to @code{wl-expire-alist} settings above.
5634 @item wl-summary-expire-reserve-marks
5635 @vindex wl-summary-expire-reserve-marks
5636 The initial setting is the list below.
5640 (list wl-summary-important-mark
5642 wl-summary-unread-mark
5643 wl-summary-unread-uncached-mark
5644 wl-summary-unread-cached-mark)
5648 Messages with these marks are retained in the folder, even after
5650 Only permanent marks can be listed, not temporary marks.
5652 You can list marks one by one as in the default; you can use the
5653 following settings as well:
5657 All messages with permanent marks are retained,
5658 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5662 All messages are handled as usual ones that are already read, no matter
5663 what marks they have; even important messages are deleted.
5666 @item wl-expire-archive-files
5667 @vindex wl-expire-archive-files
5668 The initial setting is 100.
5669 This variable specifies the number of messages to be retained in one
5672 @item wl-expire-number-with-reserve-marks
5673 @vindex wl-expire-number-with-reserve-marks
5674 The initial setting is @code{nil}.
5675 If non-nil, if expiring messages are specified by @code{number},
5676 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5678 @item wl-expire-archive-get-folder-function
5679 @vindex wl-expire-archive-get-folder-function
5680 The initial setting is @code{wl-expire-archive-get-folder}.
5682 This variable specifies a function that returns the name of an archiving
5683 folder for standard functions in the place of @var{destination}.
5684 You can use the following three variables for simple modification of
5685 folder names; if you want more complex settings, define your own
5686 function in this variable.
5688 @code{wl-expire-archive-get-folder} can be customized by these
5691 @item @code{wl-expire-archive-folder-name-fmt}
5692 @item @code{wl-expire-archive-folder-type}
5693 @item @code{wl-expire-archive-folder-prefix}
5696 @item wl-expire-archive-folder-name-fmt
5697 @vindex wl-expire-archive-folder-name-fmt
5698 The initial setting is @samp{%s-%%05d;%s}.
5699 This is a @code{format} string for archiving folders used in
5700 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5701 Note that you must specify the message number by @samp{%%d}, because it
5702 is parsed twice by @code{format}.
5704 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5707 @item wl-expire-archive-date-folder-name-fmt
5708 @vindex wl-expire-archive-date-folder-name-fmt
5709 The initial setting is @samp{%s-%%04d%%02d;%s}.
5710 This is a @code{format} string for archiving folders used in
5711 @code{wl-expire-archive-date}. Note that you must specify the message
5712 number by @samp{%%d}, because it is parsed twice by @code{format}.
5713 There should be @samp{%%d} twice, one for the year and the other for the
5716 If you modify this, adjust
5717 @code{wl-expire-archive-date-folder-num-regexp} as well.
5719 @item wl-expire-archive-folder-type
5720 @vindex wl-expire-archive-folder-type
5721 The initial setting is @code{zip}.
5722 This variable specifies an archiver type of the archiving folders.
5724 @item wl-expire-archive-folder-prefix
5725 @vindex wl-expire-archive-folder-prefix
5726 The initial setting is @code{nil}.
5727 This variable specifies the prefix (directory structure) to archiving
5729 Exercise extreme caution in using this feature, as it has not been
5731 In the worst case, there is a fear of destructing archiving folders.
5735 There will be no prefix.
5738 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5739 @samp{$ml/wl-00000;zip;wl}.
5742 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5745 @samp{$ml/wl-00000;zip;ml/wl}.
5748 @item wl-expire-archive-folder-num-regexp
5749 @vindex wl-expire-archive-folder-num-regexp
5750 The initial setting is @samp{-\\([-0-9]+\\);}.
5751 This variable specifies the regular expression to be used for getting
5752 message numbers from multiple archiving folders specified by
5753 @code{elmo-list-folders}.
5754 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5756 @item wl-expire-archive-date-folder-num-regexp
5757 @vindex wl-expire-archive-date-folder-num-regexp
5758 The initial setting is @samp{-\\([-0-9]+\\);}.
5759 This is the regular expression to be used for getting message numbers
5760 from multiple archiving folders specified by @code{elmo-list-folders}.
5761 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5763 @item wl-expire-delete-oldmsg-confirm
5764 @vindex wl-expire-delete-oldmsg-confirm
5765 The initial setting is @code{t}.
5766 If non-nil, messages older than the one with the largest number will be
5767 deleted with confirmation.
5768 If @code{nil}, they are deleted without confirmation.
5770 This feature is valid only if non-nil is specified as a argument to the
5771 standard functions so as to retain numbers.
5773 @item wl-expire-use-log
5774 @vindex wl-expire-use-log
5775 The initial setting is @code{nil}.
5776 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5777 They are appended but not truncated or rotated automatically; you might
5778 need to remove it manually.
5780 @item wl-expire-add-seen-list
5781 @vindex wl-expire-add-seen-list
5782 The initial setting is @code{t}.
5784 If non-nil, when messages are re-filed by expiration, read/unread
5785 information is passed to the destination folder.
5787 However if you do not read the destination folder from Wanderlust,
5788 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5789 want to set this to @code{nil} if you are simply saving to some
5790 archiving folders. Even if its value is @code{nil}, messages in the
5791 archiving folders are simply treated as unread; it does not affect
5794 @item wl-expire-folder-update-msgdb
5795 @vindex wl-expire-folder-update-msgdb
5796 The initial setting is @code{t}.
5797 If @code{t}, in the folder mode, expiration is carried out after
5798 updating summary information. If you specified a list of regular
5799 expressions of folder names, summary information is updated for matching
5804 @node Archive, , Expire, Expire and Archive
5805 @section Archiving Messages
5807 @subsection Archiving Messages
5808 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5809 folders. If there are the archiving folders already, only new messages
5812 You can use @code{wl-archive-alist} in order to specify how messages are
5813 archived according to their folder names, as in @code{wl-expire-alist}.
5818 (setq wl-archive-alist
5819 '(("^\\+tmp$" wl-archive-date)
5820 ("^\\+outbox$" wl-archive-number2)
5821 (".*" wl-archive-number1)))
5825 Each item in the list has the following format:
5828 (@var{folders-regexp} @var{deleting-function})
5831 As you can see, you can only use a function after @var{folders-regexp}.
5832 Per default, there are three functions:
5835 @item @code{wl-archive-number1}
5836 @item @code{wl-archive-number2}
5837 @item @code{wl-archive-date}
5840 As inferred from their names, they work similarly to "expire" versions,
5841 other than the following points:
5844 @item No messages are deleted
5845 @item Message numbers are retained even if invoked without arguments
5848 These functions are good to archive all messages in a folder by their
5849 numbers or by their dates.
5850 These are also useful for backup or confirmation purposes before
5852 If you try to re-file them after they are archived, they are deleted but
5855 Per default, the archiving folders to which messages are copied are
5856 determined automatically by @code{wl-expire-archive-get-folder-function}.
5857 You can copy to a specific folder by invoking with a prefix argument,
5858 i.e. @kbd{C-u M-x wl-summary-archive}.
5860 Note that this feature has not been seriously tested, because you can
5861 simply copy to an archiving folder, for example by
5862 @code{wl-summary-copy-region}.
5864 The archiving folders are determined by the same logic as in
5865 @code{wl-summary-expire}; the following customizable variables are
5869 @item @code{wl-expire-archive-files}
5870 @item @code{wl-expire-archive-get-folder-function}
5871 @item @code{wl-expire-archive-folder-name-fmt}
5872 @item @code{wl-expire-archive-folder-type}
5873 @item @code{wl-expire-archive-folder-prefix}
5874 @item @code{wl-expire-archive-folder-num-regexp}
5877 @subsection Customizable Variables
5880 @item wl-archive-alist
5881 @vindex wl-archive-alist
5882 The initial setting is the list shown below:
5886 ((".*" wl-archive-number1))
5891 This variable specifies a function that copies to archiving folders.
5892 To the function, three arguments are passed: a folder name, a list of
5893 messages in the folder, and msgdb information of the summary.
5894 Needless to say, you can use your own function.
5898 @node Scoring, Split messages, Expire and Archive, Top
5899 @chapter Score of the Messages
5901 @c @cindex Kill File
5903 Scoring is the function that associates a score (value) with each
5904 message, and marks as read or deletes from the summary according to it.
5906 You can put target or important marks on essential messages, or read marks
5907 on the ones you do not want to read, for example spam articles.
5909 This scoring function has a capability and a format similar to the one
5910 that Gnus has, although there are some unsupported features and
5911 Wanderlust specifics.
5912 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5915 * Score Commands:: Score Commands
5916 * Score File Format:: Score File Format
5920 @node Score Commands, Score File Format, Scoring, Scoring
5921 @section Score Commands
5922 @cindex Score Commands
5924 @subsection Score File Specification
5926 @code{wl-score-folder-alist} specifies score files or variables in which
5927 scores are defined, corresponding to folder names.
5931 (setq wl-score-folder-alist
5940 If paths to the score files are omitted, the directory specified in the
5941 variable @code{wl-score-files-directory} is assumed.
5943 No matter what you write in @code{wl-score-folder-alist}, the default
5944 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5945 read (it does not have to exist).
5946 Therefore, in the example above, the three score files,
5947 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5948 the folders that matches @samp{^-.*}.
5950 @subsection Scored Messages
5952 Scores are attached to the messages that are specified by
5953 @code{wl-summary-score-marks} temporarily when the summary is updated;
5954 when you exit from the summary, the scores are removed and reverts to
5957 @subsection Creation of Score Files
5959 In the summary buffer, move to an appropriate message and type @kbd{L}.
5960 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5961 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5963 This makes @minus{}1000 are scored for messages with the same
5964 @samp{Subject:} as the string you entered. That is, such a score file
5965 is created automatically.
5967 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5968 The score file you just made appears.
5969 This buffer is called @dfn{score editing buffer} thereafter.
5970 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5971 as you are previously; type @kbd{a}. Then a score entry for "From"
5973 In this way, you can create a score file easily either in the summary
5974 buffer or in the score editing buffer.
5976 By the way, you might be aware the numbers of key strokes are different
5977 between @kbd{s s p} and @kbd{a}.
5978 This is determined by @code{wl-score-header-default-entry}.
5979 This variable specifies the default score entries corresponding to
5981 For example, for "subject" field, a type and a time limit are prompted,
5982 but for "from" field, they are fixed upon automatically as substring and
5983 permanent respectively.
5984 However, score values can be modified by the prefix argument.
5985 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5988 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5989 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5990 erasing contents of the buffer deletes the score file being edited.
5994 @subsubsection Selecting Score Files
5996 You can change score files to which scores are appended by
5997 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5998 @code{wl-score-change-score-file}.
6000 @subsubsection Summing Up the Score
6002 If you add the same entries by @code{wl-summary-increase-score},
6003 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
6004 scores for the entry is summed up.
6006 For example, if you create @samp{from} entry with the score of @minus{}1000 by
6007 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
6008 @minus{}1200 will be created as a result.
6010 @subsubsection Creating Thread Key
6012 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
6013 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6015 @subsubsection Creating Followup Key
6017 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6018 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6019 at the cursor to @samp{References} key.
6020 If @code{wl-score-auto-make-followup-entry} is non-nil,
6021 @samp{Message-ID} of all messages to be followed up within dates
6022 specified by @code{wl-score-expiry-days}.
6024 @subsection Key Bindings
6029 @findex wl-summary-increase-score
6030 Increases the score for the current message.
6031 And the score entry is appended to the score file at the same moment.
6032 You can specify the score value by a prefix argument.
6036 @findex wl-summary-lower-score
6037 Decreases the score for the current message.
6038 And the score entry is appended to the score file at the same moment.
6039 You can specify the score value by a prefix argument.
6042 @kindex h R (Summary)
6043 @findex wl-summary-rescore
6044 Re-applies the scoring.
6045 However, already scored messages are not scored anew.
6048 @kindex h c (Summary)
6049 @findex wl-score-change-score-file
6050 Changes the score file currently selected.
6053 @kindex h e (Summary)
6054 @findex wl-score-edit-current-scores
6055 Edits the score file currently selected.
6056 If there are multiple score files, the previously specified one is
6060 @kindex h f (Summary)
6061 @findex wl-score-edit-file
6062 Edits an arbitrary score file and selects it.
6065 @kindex h F (Summary)
6066 @findex wl-score-flush-cache
6067 Erases caches associated to the score files that are read.
6068 If you modified score files directly (from other than Wanderlust), you
6069 need to re-read them after erasing the cache.
6072 @kindex h m (Summary)
6073 @findex wl-score-set-mark-below
6074 Specifies the criterion for scores to be marked as read.
6075 Messages with scores less than this value are marked as read.
6078 @kindex h x (Summary)
6079 @findex wl-score-set-expunge-below
6080 Specifies the criterion for scores to be deleted from the summary.
6081 Messages with scores less than this value are deleted.
6082 "Deleted" means it is not shown; they are not removed from the summary
6083 information or the folder.
6084 The deleted messages can be shown by rescan-noscore again.
6087 @subsection Key Bindings in the Score Editing Buffer
6091 @kindex C-c C-k (Score Mode)
6092 @findex wl-score-edit-kill
6093 Abandons the file being edited.
6096 @kindex C-c C-c (Score Mode)
6097 @findex wl-score-edit-exit
6098 Saves the file being edited, and quits from the edit mode.
6101 @kindex C-c C-p (Score Mode)
6102 @findex wl-score-pretty-print
6106 @kindex C-c C-d (Score Mode)
6107 @findex wl-score-edit-insert-date
6108 Inserts the number of dates from Dec. 31, 1 B.C.
6109 It is used for creating the third factor of time-limited scores.
6112 @kindex C-c C-s (Score Mode)
6113 @findex wl-score-edit-insert-header
6114 Inserts the header of the message selected in the summary buffer.
6117 @kindex C-c C-e (Score Mode)
6118 @findex wl-score-edit-insert-entry
6119 Inserts the score entry of the message selected in the summary buffer.
6122 @subsection Customizable Variables
6125 @item wl-summary-default-score
6126 @vindex wl-summary-default-score
6127 The initial setting is 0 (zero).
6128 This variable specifies the default value of the score.
6129 The score is increased or decreased based upon this value.
6131 @item wl-summary-important-above
6132 @vindex wl-summary-important-above
6133 The initial setting is @code{nil}.
6134 Messages with scores larger than this value are attached with the
6135 important mark (@samp{$}).
6136 If @code{nil}, no important marks are attached.
6138 @item wl-summary-target-above
6139 @vindex wl-summary-target-above
6140 The initial setting is @code{nil}.
6141 Messages with scores larger than this value are attached with the target
6143 If @code{nil}, no target marks are attached.
6145 @item wl-summary-mark-below
6146 @vindex wl-summary-mark-below
6147 The initial setting is 0 (zero).
6148 Messages with scores smaller than this value are marked as read.
6150 @item wl-summary-expunge-below
6151 @vindex wl-summary-expunge-below
6152 The initial setting is @code{nil}.
6153 Messages with scores smaller than this value are deleted from the
6155 If @code{nil}, they are not deleted.
6157 @item wl-summary-score-marks
6158 @vindex wl-summary-score-marks
6159 The initial setting is the list shown below:
6163 (list wl-summary-new-mark)
6168 Messages with these marks are scored.
6170 @item wl-use-scoring
6171 @vindex wl-use-scoring
6172 The initial setting is t.
6173 If non-nil, scoring is enabled.
6175 @item wl-score-files-directory
6176 @vindex wl-score-files-directory
6177 The initial setting is @file{~/.elmo/}.
6178 The default directory for score files.
6180 @item wl-score-interactive-default-score
6181 @vindex wl-score-interactive-default-score
6182 The initial setting is 1000.
6183 This value is used as a score when a score factor is @code{nil} in the
6184 score file. It is also used in @code{wl-summary-increase-score} and
6185 @code{wl-summary-lower-score}, on condition that the value of
6186 @code{wl-score-header-default-entry} is @code{nil}.
6188 @item wl-score-expiry-days
6189 @vindex wl-score-expiry-days
6190 The initial setting is 7.
6191 This is the number of days before time-limited scores are deleted.
6193 @item wl-score-update-entry-dates
6194 @vindex wl-score-update-entry-dates
6195 The initial setting is @code{t}.
6196 If non-nil, it enables deletion of time-limited scores.
6198 @item wl-score-header-default-entry
6199 @vindex wl-score-header-default-entry
6200 Specifies the default value for each header field for score entries
6201 created by @code{wl-summary-increase-score},
6202 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6204 @item wl-score-simplify-fuzzy-regexp
6205 @vindex wl-score-simplify-fuzzy-regexp
6206 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6207 regular expression to be deleted from the string.
6208 Because this is usually used for Subject, the default is prefixes that
6209 are attached by mailing list programs.
6211 @item wl-summary-rescore-partial-threshold
6212 @vindex wl-summary-rescore-partial-threshold
6213 The initial setting is 200.
6214 When sync-all or rescan is executed, if there are messages more than
6215 this value, only the last same number of messages as this value are
6218 @item wl-summary-auto-sync-marks
6219 @vindex wl-summary-auto-sync-marks
6220 If non-nil, unread/important marks are synchronized when the summary
6222 Unread marks reflect information on the IMAP4 server.
6223 Important marks reflect information on the IMAP4 server (flagged or
6224 not), and contents of @samp{'mark} folder.
6225 The initial setting is @code{t}.
6229 @node Score File Format, , Score Commands, Scoring
6230 @section Score File Format
6231 @cindex Score File Format
6233 The format of score files are the same as Gnus, and basically you can
6234 use Gnus score files as they are. But they are not fully compatible
6235 because some keys are not supported and there are Wanderlust specifics.
6236 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6241 ("for sale" -1000 nil s)
6242 ("profit" -1000 nil s))
6244 ("spam@@spamspamspam" -10000 nil s))
6246 ("my@@address" 3001 nil s))
6248 (1000000 -10 nil >))
6258 If the key is a string, it is the name of the header to be matched.
6259 The following keys are available:
6260 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6261 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6262 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6263 @code{Chars} and @code{Lines} mean the size and the number of lines of
6264 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6265 are described later.
6266 The rest corresponds the field of the same name.
6268 Arbitrary numbers of core entries are specified after the key.
6269 Each score entry consists of these five factors:
6273 A factor that matches header. This should be a number in the cases of
6274 @code{lines} and @code{chars}, otherwise a string.
6277 A score factor. When the first item matches, the score of the message
6278 is increased or decreased by this value.
6281 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6282 of a number, the score is deleted if it does not match for days
6283 (@code{wl-score-expiry-days}) from the date specified by this.
6284 The date is since Dec. 31, 1 B.C.
6287 A type factor. This specifies the way the first factor matches.
6288 Available types depend on keys.
6291 @item From, Subject, References, Message-ID
6292 For these keys in string, @code{r} and @code{R} (regexp),
6293 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6294 as well as @code{f} and @code{F} (fuzzy) can be used.
6295 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6298 For these keys, the following five numerical relative operators can be
6299 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6302 This key matches @code{From} header, and scores all follow-ups to the
6304 For example, it would be useful for increasing scores for follow-ups to
6307 You can use the same types as @code{From} except for @code{f}.
6308 And a @samp{Followup} entry is automatically appended to the score file.
6311 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6312 A @samp{Thread} entry is automatically appended for each article that
6313 has @var{x} in the @code{References} header.
6314 You can make sure the whole thread including messages that does not have
6315 all ancestors @code{Message-ID} in @code{References} is scored.
6317 You can use the same types as @code{References} except for @code{f}.
6318 And a @samp{Thread} entry is automatically appended to the score file.
6322 A factor for extension header. This is meaningful only if the key is
6324 This specifies headers to be matched other than standard headers like
6325 @code{Subject} and @code{From}.
6326 Note that you should specify the header in
6327 @code{elmo-msgdb-extra-fields} also.
6328 Therefore it does not work in folders where extension headers cannot be
6333 The sum of these scores @emph{after all factors are applied} becomes the
6334 score of the message.
6336 @cindex Score File Atoms
6338 Messages with a score less than this value is marked as read.
6339 The default is @code{wl-summary-mark-below}.
6342 Messages with a score less than this value is deleted from the summary.
6343 The default is @code{wl-summary-expunge-below}.
6345 @item mark-and-expunge
6346 Both @code{mark} and @code{expunge} are applied,
6347 i.e. messages with a score less than this value is marked as read and
6348 deleted from the summary.
6351 Messages with a score greater than this value is attached with temp
6353 The default is @code{wl-summary-target-above}.
6356 Messages with a score greater than this value is attached with important
6358 The default is @code{wl-summary-important-above}.
6363 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6364 are used, you need to set @code{elmo-msgdb-extra-fields}.
6367 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6370 There are other restrictions as shown below:
6373 @item Because @samp{References} field in the summary information
6374 contains only the last @samp{Message-ID}, @code{references} key matches
6378 Keys that can be seen by folder of types:
6382 chars lines xref extra
6383 localdir,localnews Y E E E
6384 nntp (supporting xover) Y E E N
6390 N: cannot be seen (ignored)
6391 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6396 @node Split messages, Address Book, Scoring, Top
6397 @chapter Message splitting
6398 @cindex Split messages
6400 You can use @code{elmo-split} to split message in folder specified by
6401 the variable @code{elmo-split-folder} a la @command{procmail} according
6402 to some specified rules. To use this feature, set as follows in your
6403 @file{~/.emacs} at first.
6406 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
6409 Set source folder like following.
6412 (setq elmo-split-folder "%inbox")
6415 And specify the rule in the variable @code{elmo-split-rule} (its format
6416 will be is described below).
6417 Then you can invoke @kbd{M-x elmo-split} to split messages according to
6418 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
6419 to do a rehearsal and show result (do not split actually).
6422 We will describe how to specify the rule. First of all, see following
6427 (setq elmo-split-rule
6428 ;; @r{Store messages from spammers into @samp{+junk}}
6429 '(((or (address-equal from "i.am@@spammer")
6430 (address-equal from "dull-work@@dull-boy")
6431 (address-equal from "death-march@@software")
6432 (address-equal from "ares@@aon.at")
6433 (address-equal from "get-money@@richman"))
6435 ;; @r{Store messages from mule mailing list into @samp{%mule}}
6436 ((equal x-ml-name "mule") "%mule")
6437 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
6438 ;; @r{and continue evaluating following rules}
6439 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
6440 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
6441 ((match from "\\(.*\\)@@yahoo\\.com")
6443 ;; @r{Store unmatched mails into @samp{+inbox}}
6448 The basic unit of the rule is a combination like
6451 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
6454 If @samp{CONDITION} is true, @samp{ACTION} is performed.
6455 The 1st element @samp{CONDITION} is a condition represented by a
6456 balanced expression (sexp). Its grammar will be explained below.
6457 The 2nd element @samp{ACTION} is the name of the folder to split
6458 messages into, or a symbol. When the 3rd element @code{continue} is
6459 specified as symbol, evaluating rules is not stopped even when the
6460 condition is satisfied.
6462 The grammar for @samp{CONDITION} is as follows. See example above to
6463 learn how to write the condition practically.
6467 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
6468 (@samp{FIELD-NAME} is a symbol that describes the field name)
6472 True if the field value equals to @samp{VALUE}.
6473 Case of the letters are ignored.
6475 True if the field value matches to VALUE.
6476 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6477 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6478 @item @code{address-equal}
6479 True if one of the addresses in the field equals to
6480 @samp{VALUE}. Case of the letters are ignored.
6481 @item @code{address-match}
6482 True if one of the addresses in the field matches to
6484 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6485 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6489 Functions which accept an integer argument (@samp{SIZE}).
6493 True if the size of the message is less than @samp{SIZE}.
6495 True if the size of the message is greater than @samp{SIZE}.
6499 Functions which accept any number of arguments.
6503 True if one of the argument returns true.
6505 True if all of the arguments return true.
6511 When a symbol is specified, it is evaluated.
6514 You can specify followings as 2nd @samp{ACTION}.
6520 If some string is specified, it will be regarded as the destination
6521 folder, and the message will be appended to it.
6526 If the symbol @samp{delete} is specified, delete the substance of the
6527 message in @code{elmo-split-folder}
6532 If the symbol @samp{noop} is specified, do nothing on the message and
6538 If some function is specified, execute it.
6541 If the message passes all rules, it will be dealed along @samp{ACTION}
6542 specified by @code{elmo-split-default-action}.
6545 @node Address Book, Customization, Split messages, Top
6546 @chapter Address Book
6547 @cindex Address Book
6549 With address book, you can utilize address completion, and you have
6550 summary displayed with nicknames.
6553 * Mail Addresses:: Definition of Address Book
6554 * Address Manager:: Address Manager
6558 @node Mail Addresses, Address Manager, Address Book, Address Book
6559 @section Address book
6560 @cindex Address book Definition
6562 @cindex Alias, Address
6564 The file @file{~/.addresses} is a simple address book for Wanderlust.
6565 Make address file @file{~/.addresses}, and edit to suit your requirement.
6567 The data written in @file{~/.addresses} are used for address completion
6568 under draft editing mode. Furthermore, they are used when showing names
6569 in summary display mode. You can safely skip this section, if you don't
6570 want to customize address completion and summary display.
6571 It is possible to add/change/remove addresses from @file{~/.addresses} in
6572 summary buffer after Wanderlust is invoked. @refill
6574 The format is very simple. Like this. @refill
6579 # @r{Lines begin with @samp{#} are comment.}
6580 # @r{Empty lines are ignored}
6582 # @r{Format of each line:}
6583 # @var{email-address} "@var{nickname} "@var{realname}"
6585 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6586 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6587 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6592 One line defines one persons description.
6594 Actually, in default setup, @var{nickname} is used in summary-mode and
6595 @var{realname} is used in draft preparation mode. This behavior is
6596 better understood if you try it and confirmed the function first. You
6597 can write and try a small definition, so you will know the idea of the
6598 address book before writing a big one.
6600 And, if MH alias file is specified in variable @code{wl-alias-file},
6601 it is used as an address information in the draft preparation mode.
6603 If variable @code{wl-use-ldap} is non-nil (initial setting is
6604 @code{nil}), address completion in draft mode uses LDAP information.
6606 If you use LDAP, you have to set @code{wl-ldap-server},
6607 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6608 not have LDAP feature as built-in feature (Currently only XEmacs can
6609 have built-in LDAP feature), you have to set command exec @env{PATH} to
6610 the program @command{ldapsearch}.
6613 @node Address Manager, , Mail Addresses, Address Book
6614 @section Address Manager
6615 @cindex Address Manager
6617 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6618 the address book and insert address to draft buffer.
6620 @subsection Key Bindings
6624 @kindex t (Address Manager)
6625 @findex wl-addrmgr-set-to
6626 Add @samp{To:} mark.
6629 @kindex c (Address Manager)
6630 @findex wl-addrmgr-set-cc
6631 Add @samp{Cc:} mark.
6634 @kindex b (Address Manager)
6635 @findex wl-addrmgr-set-bcc
6636 Add @samp{Bcc:} mark.
6639 @kindex u (Address Manager)
6640 @findex wl-addrmgr-unmark
6644 @kindex x (Address Manager)
6645 @findex wl-addrmgr-apply
6647 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6648 buffer and quit address manager. When no draft buffer, make new draft
6649 with insert marked addresses.
6651 If no mark, quit address manager.
6655 @kindex q (Address Manager)
6656 @findex wl-addrmgr-quit
6657 Quit address manager.
6660 @kindex a (Address Manager)
6661 @findex wl-addrmgr-add
6665 @kindex d (Address Manager)
6666 @findex wl-addrmgr-delete
6670 @kindex e (Address Manager)
6671 @findex wl-addrmgr-edit
6676 @node Customization, Terminology, Address Book, Top
6677 @chapter Customizing Wanderlust
6678 @cindex Customization
6681 * Living with other packages:: Cooperating with other packages
6682 * Highlights:: Highlights
6683 * Biff:: Notify Mail arrival
6684 * Advanced Settings:: Advanced Settings
6685 * Customizable Variables:: Customizable Variables
6690 @node Living with other packages, Highlights, Customization, Customization
6691 @section Living with other packages
6693 Examples with other packages.
6696 * imput:: imput (im-wl.el)
6697 * BBDB:: The Insidious Big Brother Database
6698 * LSDB:: The Lovely Sister Database
6699 * supercite:: supercite.el
6700 * mu-cite:: mu-cite.el
6701 * X-Face:: x-face,bitmap-mule
6702 * dired-dd:: dired-dd.el
6704 * Addrbook:: Addrbook
6705 * mime-w3m:: mime-w3m.el
6709 @node imput, BBDB, Living with other packages, Living with other packages
6714 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6717 If @command{imput} is on the @code{exec-path} at the installation,
6718 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6722 (autoload 'wl-draft-send-with-imput-async "im-wl")
6723 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6728 @node BBDB, LSDB, imput, Living with other packages
6732 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
6733 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
6734 and do the following settings.
6736 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6737 byte-compiled and installed.
6745 ;; @r{enable pop-ups}
6746 (setq bbdb-use-pop-up t)
6747 ;; @r{auto collection}
6748 (setq bbdb/mail-auto-create-p t)
6749 ;; @r{exceptional folders against auto collection}
6750 (setq bbdb-wl-ignore-folder-regexp "^@@")
6751 (setq signature-use-bbdb t)
6752 (setq bbdb-north-american-phone-numbers-p nil)
6753 ;; @r{shows the name of bbdb in the summary} :-)
6754 (setq wl-summary-from-function 'bbdb-wl-from-func)
6755 ;; @r{automatically add mailing list fields}
6756 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6757 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6761 You can complete address with BBDB by @kbd{M-@key{TAB}}
6765 @node LSDB, supercite, BBDB, Living with other packages
6769 The following is an example setting to use
6770 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
6777 (add-hook 'wl-draft-mode-hook
6779 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
6783 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
6784 (complete address with LSDB).
6787 @node supercite, mu-cite, LSDB, Living with other packages
6788 @subsection sc.el(supercite), sc-register.el
6792 The same setting as usual mailers should be OK. The following is an
6793 example of settings:
6797 (autoload 'sc-cite-original "supercite" nil t)
6798 (add-hook 'mail-citation-hook 'sc-cite-original)
6803 @node mu-cite, X-Face, supercite, Living with other packages
6804 @subsection mu-cite.el
6807 The same setting as usual mailers should be OK. The following is an
6808 example of settings.
6810 If you use mu-cite version 8.0 or earlier:
6814 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6815 (setq mail-citation-hook 'mu-cite/cite-original)
6819 If you use mu-cite version 8.1 or later:
6823 (autoload 'mu-cite-original "mu-cite" nil t)
6824 (add-hook 'mail-citation-hook (function mu-cite-original))
6828 @node X-Face, dired-dd, mu-cite, Living with other packages
6832 If you have installed one of the following, you can decode
6833 @samp{X-Face:} field in message buffer and you will see face image.
6836 * x-face-xmas:: XEmacs case
6837 * x-face-mule:: Emacs case
6840 If there is an encoded X-Face string in a file @file{~/.xface} (the
6841 value of the variable @code{wl-x-face-file}), it is inserted as a
6842 @samp{X-Face:} field in the draft buffer (if
6843 @code{wl-auto-insert-x-face} is non-nil).
6845 @node x-face-xmas, x-face-mule, X-Face, X-Face
6846 @subsubsection x-face-xmas (for XEmacs)
6849 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6850 1.3.6.13 or later, do the following:
6854 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6855 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6859 @node x-face-mule, , x-face-xmas, X-Face
6860 @subsubsection x-face-mule (for Emacs)
6864 If you use @file{x-face-mule.el} in bitmap-mule
6865 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6869 (autoload 'x-face-decode-message-header "x-face-mule")
6870 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6874 @subsubsection x-face-e21 (for Emacs 21.x)
6877 With Emacs 21.x, you can use @file{x-face-e21.el}
6878 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6879 to display X-Face. In this case, bitmap-mule is not required.
6884 (autoload 'x-face-decode-message-header "x-face-e21")
6885 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6890 @node dired-dd, MHC, X-Face, Living with other packages
6891 @subsection dired-dd(Dired-DragDrop)
6892 @pindex Dired-DragDrop
6894 @cindex Drag and Drop
6896 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6897 compose multi-part by simple Drag-and-Drop from dired to the draft
6898 buffer being edited in GNU Emacs (this feature is not Wanderlust
6899 specific, but general-purpose for SEMI).
6903 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6909 ;; @r{Set dired-x variables here.}
6910 ;; @r{To and flo@dots{}}
6912 (progn (require 'dired-dd)
6913 (require 'dired-dd-mime))))))
6917 @node MHC, Addrbook, dired-dd, Living with other packages
6921 Message Harmonized Calendaring system
6922 (@uref{http://www.quickhack.net/mhc/})
6924 By using MHC, you can make a calendar from the messages.
6930 (setq mhc-mailer-package 'wl)
6931 (autoload 'mhc-mode "mhc" nil t)
6932 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6933 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6941 (autoload 'mhc-wl-setup "mhc-wl")
6942 (add-hook 'wl-init-hook 'mhc-wl-setup)
6946 @node Addrbook, mime-w3m, MHC, Living with other packages
6947 @subsection wl-addrbook.el
6951 (@uref{http://www.mew.org/})
6953 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6954 @code{load-path} and do the following settings.
6958 (require 'wl-addrbook)
6963 @node mime-w3m, , Addrbook, Living with other packages
6964 @subsection mime-w3m.el
6967 You can display html part by using @file{mime-w3m.el}
6968 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6969 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6972 @node Highlights, Biff, Living with other packages, Customization
6975 @subsection Customizable Variables
6978 @item wl-summary-highlight
6979 @vindex wl-summary-highlight
6980 The initial setting is @code{t}.
6981 If non-nil, the summary is highlighted.
6983 @item wl-highlight-max-summary-lines
6984 @vindex wl-highlight-max-summary-lines
6985 The initial setting is 10000.
6986 The summary is not highlighted if it has more lines than this value.
6988 @item wl-summary-highlight-partial-threshold
6989 @vindex wl-summary-highlight-partial-threshold
6990 The initial setting is 1000.
6991 This is a threshold whether the whole summary is highlighted.
6992 If there are more lines of messages in the summary, it is partially
6995 @item wl-summary-partial-highlight-above-lines
6996 @vindex wl-summary-partial-highlight-above-lines
6997 The initial setting is 30. If there are more lines of messages than
6998 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6999 after the point that is the same number of lines as this value above the
7000 cursor line are highlighted partially. (If this value is @code{nil},
7001 the last same number of lines as the value of
7002 @code{wl-summary-highlight-partial-threshold} are highlighted.)
7004 @item wl-highlight-body-too
7005 @vindex wl-highlight-body-too
7006 The initial setting is @code{t}.
7007 If non-nil, bodies of drafts and messages are also highlighted.
7009 @item wl-highlight-message-header-alist
7010 @vindex wl-highlight-message-header-alist
7011 When highlighting headers of drafts and messages, this variable
7012 specifies which faces are allocated to important
7013 (@code{wl-highlight-message-important-header-contents}), secondly
7014 important (@code{wl-highlight-message-important-header-contents2}), and
7015 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7017 Similarly, it can be used for allocating arbitrary faces to arbitrary
7018 regular expressions.
7020 @item wl-highlight-citation-prefix-regexp
7021 @vindex wl-highlight-citation-prefix-regexp
7022 Specifies a regular expression to which quoted lines in bodies of
7023 drafts and messages match.
7024 Bodies matching to this regular expression are highlighted by the faces
7025 specified by (@code{wl-highlight-message-cited-text-*}).
7027 @item wl-highlight-highlight-citation-too
7028 @vindex wl-highlight-highlight-citation-too
7029 The initial setting is @code{nil}.
7030 If non-nil, the quoting regular expression itself given by
7031 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7033 @item wl-highlight-citation-header-regexp
7034 @vindex wl-highlight-citation-header-regexp
7035 Specifies a regular expression that denotes beginning of quotation.
7036 Bodies matching to this regular expression are highlighted by the face
7037 specified by @code{wl-highlight-message-headers}.
7039 @item wl-highlight-max-header-size
7040 @vindex wl-highlight-max-header-size
7041 The initial setting is @code{nil}. If a header size is larger than this
7042 value, it will not be highlighted. If @code{nil}, always highlighted
7043 (ignore header size).
7045 @item wl-highlight-max-message-size
7046 @vindex wl-highlight-max-message-size
7047 The initial setting is 10000.
7048 If a message is larger than this value, it will not be highlighted.
7049 With this variable, highlight is suppressed for uuencode or huge digest
7052 @item wl-highlight-signature-separator
7053 @vindex wl-highlight-signature-separator
7054 Specifies regular expressions that denotes the boundary of a signature.
7055 It can be a regular expression, or a list of ones.
7056 Messages after the place that matches this regular expression are
7057 highlighted by the face specified by
7058 @code{wl-highlight-message-signature}.
7060 @item wl-max-signature-size
7061 @vindex wl-max-signature-size
7062 The initial setting is 400.
7063 This is the largest size for a signature to be highlighted.
7065 @item wl-use-highlight-mouse-line
7066 @vindex wl-use-highlight-mouse-line
7067 The initial setting is @code{t}.
7068 If non-nil, the line pointed by the mouse is highlighted in the folder
7069 mode, summary mode, and the like.
7072 @subsection Setting Colors and Fonts of the Characters
7074 If you want to change colors or fonts of the characters, you need to
7075 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7076 want to change fonts, and @code{set-face-foreground} for colors, and so
7077 on. You cannot write face settings in @file{.emacs}; write in
7080 For example, if you want to change the color for signatures to yellow,
7084 (set-face-foreground 'wl-highlight-message-signature "yellow")
7090 Faces defined in Wanderlust:
7093 @item wl-highlight-message-headers
7094 The face for field names of message headers.
7096 @item wl-highlight-message-header-contents
7097 The face for field bodies of message headers.
7099 @item wl-highlight-message-important-header-contents
7100 The face for important parts of message headers.
7101 Per default, this face is used for a body of @samp{Subject:} field.
7102 You can change its value by editing
7103 @code{wl-highlight-message-header-alist}.
7105 @item wl-highlight-message-important-header-contents2
7106 The face for secondly important parts of message headers.
7107 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7108 fields. You can change its value by editing
7109 @code{wl-highlight-message-header-alist}.
7111 @item wl-highlight-message-unimportant-header-contents
7112 The face for unimportant parts of message headers.
7113 Per default, this face is used for bodies of @samp{X-} fields
7114 @samp{User-Agent:} fields. You can change its value by editing
7115 @code{wl-highlight-message-header-alist}.
7117 @item wl-highlight-message-citation-header
7118 The face for headers of quoted messages.
7120 @item wl-highlight-message-cited-text-*
7121 The face for texts of quoted messages. The last @samp{*} is a
7122 @var{single figure} so that 10 different colors can be used according to
7125 @item wl-highlight-message-signature
7126 The face for signatures of messages. The initial settings are
7127 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7128 dark background colors.
7130 @item wl-highlight-header-separator-face
7131 The face for header separators of draft messages.
7133 @item wl-highlight-summary-important-face
7134 The face for message lines with important marks in the summary.
7136 @item wl-highlight-summary-new-face
7137 The face for message lines with new marks in the summary.
7139 @item wl-highlight-summary-displaying-face
7140 The face for the message line that is currently displayed.
7141 This face is overlaid.
7143 @item wl-highlight-thread-indent-face
7144 The face for the threads that is currently displayed.
7146 @item wl-highlight-summary-unread-face
7147 The face for message lines with unread marks in the summary.
7149 @item wl-highlight-summary-deleted-face
7150 The face for message lines with delete marks in the summary.
7152 @item wl-highlight-summary-refiled-face
7153 The face for message lines with re-file marks in the summary.
7155 @item wl-highlight-refile-destination-face
7156 The face for re-file information part of message lines with re-file
7157 marks in the summary.
7159 @item wl-highlight-summary-copied-face
7160 The face for message lines with copy marks in the summary.
7162 @item wl-highlight-summary-target-face
7163 The face for message lines with target marks @samp{*} in the summary.
7165 @item wl-highlight-summary-thread-top-face
7166 The face for message lines that are on the top of the thread in the
7169 @item wl-highlight-summary-normal-face
7170 The face for message lines that are not on top of the thread in the
7173 @item wl-highlight-folder-unknown-face
7174 The face for folders that are not known to have how many unsync messages
7177 @item wl-highlight-folder-zero-face
7178 The face for folders that have no unsync messages in the folder mode.
7180 @item wl-highlight-folder-few-face
7181 The face for folders that have some unsync messages in the folder mode.
7183 @item wl-highlight-folder-many-face
7184 The face for folders that have many unsync messages in the folder mode.
7185 The boundary between `some' and `many' is specified by the variable
7186 @code{wl-folder-many-unsync-threshold}.
7188 @item wl-highlight-folder-unread-face
7189 The face for folders that have no unsync but unread messages in the
7192 @item wl-highlight-folder-killed-face
7193 The face for folders that are deleted from the access group in the
7196 @item wl-highlight-folder-opened-face
7197 The face for open groups in the folder mode.
7198 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7199 @code{nil} or a @var{number}.
7201 @item wl-highlight-folder-closed-face
7202 The face for close groups in the folder mode.
7203 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7204 @code{nil} or a @var{number}.
7206 @item wl-highlight-folder-path-face
7207 The face for the path to the currently selected folder in the folder
7210 @item wl-highlight-logo-face
7211 The face for logo in the demo.
7213 @item wl-highlight-demo-face
7214 The face for strings (for example, a version number) in the demo.
7218 @node Biff, Advanced Settings, Highlights, Customization
7219 @section Notify Mail arrival
7222 Following setting is to notify mail arrival of @samp{%inbox}
7223 by the indicator on the modeline
7226 (setq wl-biff-check-folder-list '("%inbox"))
7229 @subsection Customizable Variables
7231 @item wl-biff-check-folder-list
7232 @vindex wl-biff-check-folder-list
7233 The initial setting is @code{nil}.
7234 This is the list of folders to check mail arrival.
7235 If @code{nil}, wl doesn't check mail arrival.
7237 @item wl-biff-check-interval
7238 @vindex wl-biff-check-interval
7239 The initial setting is 40 (in seconds).
7240 Check mail arrival in this period.
7242 @item wl-biff-notify-hook
7243 @vindex wl-biff-notify-hook
7244 This hook is run at the arrival of new mail.
7245 To beep with mail arrival(initial setting), set as follows.
7247 (setq wl-biff-notify-hook '(ding))
7249 For silence, set to @code{nil}.
7253 @node Advanced Settings, Customizable Variables, Biff, Customization
7254 @section Advanced Settings
7257 * Draft for Reply:: Draft for Reply
7258 * Thread Format:: Appearance of Thread
7259 * User-Agent Field:: @samp{User-Agent:} Header Field
7263 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
7264 @subsection Draft for Replay
7265 @vindex wl-draft-reply-with-argument-list
7266 @vindex wl-draft-reply-without-argument-list
7267 @vindex wl-draft-reply-myself-with-argument-list
7268 @vindex wl-draft-reply-myself-without-argument-list
7270 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
7271 The addressee for the draft is decided by following rules.
7273 For example, you can set as follows:
7277 (setq wl-draft-reply-without-argument-list
7278 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7279 ("Followup-To" . (nil nil ("Followup-To")))
7280 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7281 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
7285 Where each element of the list @code{wl-draft-reply-without-argument-list}
7289 (key . (to-list cc-list newsgroup-list))
7292 and if the field designated by @samp{key} exist in the parent message,
7293 parent's field values designated by @samp{to-list} are copied to @samp{To:}
7294 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
7295 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
7296 the draft respectively.
7301 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7304 Match if the parent has @samp{Mail-Followup-To} field.
7305 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
7306 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
7310 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7313 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
7314 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
7317 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
7320 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
7321 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
7324 These are evaluated in order and first matched one is used.
7326 Moreover, the behavior of @kbd{a} with prefix argument can
7327 be directed by @code{wl-draft-reply-with-argument-list} as well.
7329 By the way, you can use some function (will be evaluated in the parent
7330 message buffer) in the place of @samp{key} or @samp{to-list} etc.
7331 For example, if you only want to reply to mailing lists in
7332 @code{wl-subscribed-mailing-list} if the parent has some of them,
7337 (defun wl-mailing-list-addresses ()
7341 (nth 1 (std11-extract-address-components addr)))
7344 (elmo-multiple-fields-body-list (list "To" "Cc"))
7346 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
7347 (setq list-addrs (cons to list-addrs))))
7348 (nreverse list-addrs)))
7350 (setq wl-draft-reply-with-argument-list
7351 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
7352 ("Reply-To" . (("Reply-To") nil nil))
7353 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
7354 ("From" . (("From") nil nil))))
7359 Note: To set the behavior when you reply to the message written by yourself,
7360 use @code{wl-draft-reply-myself-without-argument-list} and
7361 @code{wl-draft-reply-myself-with-argument-list} instead of them.
7363 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
7364 @subsection Appearance of Threads
7368 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
7369 390 09/18(Fri)07:25 +-[ Tsumura-san ]
7370 391 09/18(Fri)19:24 +-[ Murata-san ]
7371 392 09/20(Sun)21:49 +-[ Okunishi-san ]
7372 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
7373 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
7374 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
7375 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
7376 412 09/22(Tue)09:28 | +-[ Teranishi ]
7377 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
7378 416 09/22(Tue)12:38 | +-[ Teranishi ]
7379 395 09/20(Sun)21:49 +-[ Okunishi-san ]
7380 397 09/21(Mon)00:15 +-[ Okunishi-san ]
7384 Settings to make appearance of threads like shown above:
7388 (setq wl-thread-indent-level 2)
7389 (setq wl-thread-have-younger-brother-str "+")
7390 (setq wl-thread-youngest-child-str "+")
7391 (setq wl-thread-vertical-str "|")
7392 (setq wl-thread-horizontal-str "-")
7393 (setq wl-thread-space-str " ")
7397 If you do not want to see branches, do the following:
7401 (setq wl-thread-indent-level 2)
7402 (setq wl-thread-have-younger-brother-str " ")
7403 (setq wl-thread-youngest-child-str " ")
7404 (setq wl-thread-vertical-str " ")
7405 (setq wl-thread-horizontal-str " ")
7406 (setq wl-thread-space-str " ")
7411 @node User-Agent Field, , Thread Format, Advanced Settings
7412 @subsection User-Agent Field
7416 If you are eccentric enough to elaborate @samp{X-Mailer:} or
7417 @samp{User-Agent:} fields, define a function that generate appropriate
7418 strings as you like, and set it to variable
7419 @code{wl-generate-mailer-string-function}.
7421 If you do not want verbose @samp{User-Agent:} field, do the following:
7425 (setq wl-generate-mailer-string-function
7426 'wl-generate-user-agent-string-1)
7430 The following is a example:
7434 (setq wl-generate-mailer-string-function nil)
7435 (setq wl-draft-additional-header-alist
7437 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
7442 @node Customizable Variables, Hooks, Advanced Settings, Customization
7443 @section Customizable Variables
7445 Customizable variables that have not been described yet:
7448 @item wl-default-folder
7449 @vindex wl-default-folder
7450 The initial setting is @samp{%inbox}. This is the default value for moving to
7451 a folder and the like.
7453 @item wl-draft-folder
7454 @vindex wl-draft-folder
7455 The initial setting is @samp{+draft}. It is the folder to which drafts are
7456 saved. It must be a localdir folder.
7458 @item wl-trash-folder
7459 @vindex wl-trash-folder
7460 The initial setting is @samp{+trash}. It is the wastebasket folder.
7461 If you changed this variable, you had better restart Wanderlust.
7463 @item wl-interactive-exit
7464 @vindex wl-interactive-exit
7465 The initial setting is @code{t}.
7466 If non-nil, you are asked for confirmation when Wanderlust terminates.
7468 @item wl-interactive-send
7469 @vindex wl-interactive-send
7470 The initial setting is @code{t}.
7471 If non-nil, you are asked for confirmation when mail is sent.
7473 @item wl-default-sync-range
7474 @vindex wl-default-sync-range
7475 The initial setting is @samp{update}.
7476 Default update range of the summary. You can specify
7477 @samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
7478 See description of @code{wl-summary-sync} for the meaning of ranges.
7480 @item wl-folder-sync-range-alist
7481 @vindex wl-folder-sync-range-alist
7482 The initial setting is the alist shown below:
7487 ("^\\+draft$\\|^\\+queue$" . "all"))
7492 This is an associative list of regular expressions of folder names and
7493 update range of the summary. Update range is one of the @samp{all},
7494 @samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
7495 match any of them, the value of @code{wl-default-sync-range} is used
7496 (@samp{update} by default).
7497 See description of @code{wl-summary-sync} for the meaning of ranges.
7500 @vindex wl-ask-range
7501 The initial setting is @code{t}.
7502 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
7503 for updating the summary when you changed folders.
7505 @item wl-mime-charset
7506 @vindex wl-mime-charset
7507 The initial setting is @code{x-ctext}.
7508 This is the MIME charset for messages that are not MIME (e.g. without
7509 @samp{Content-Type:}). This value also used as default charset for
7510 summary. (If you want to share Summary on Nemacs and other Emacsen, set
7511 this value as @code{iso-2022-jp}.)
7513 @item wl-highlight-folder-with-icon
7514 @vindex wl-highlight-folder-with-icon
7515 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
7516 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
7518 @item wl-strict-diff-folders
7519 @vindex wl-strict-diff-folders
7520 This is a list of regular expressions of folders.
7521 Unread messages are checked, for example when you press @kbd{s} in
7522 the folder mode, usually in a brief way (rapidly processed but not
7524 The folders matching this variable are seriously checked.
7525 You may want to set this variable so as to match conditional filter
7526 folders for IMAP4 folders.
7527 The initial setting is @code{nil}.
7529 @item wl-folder-use-server-diff
7530 @vindex wl-folder-use-server-diff
7531 When unread messages are checked, for example when you press @kbd{s} in
7532 the folder mode, usually (the number of messages on the server) @minus{}
7533 (the number of local messages) will be the number of unread messages.
7534 However, if this variable is non-nil, the number of unread messages on
7535 the server is checked. This affects IMAP4 folders only, but IMAP4
7536 folders in mail boxes matching
7537 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
7538 the number of unread messages on the server, even if they matches this
7539 variable. The initial setting is @code{t}.
7541 @item wl-auto-check-folder-name
7542 @vindex wl-auto-check-folder-name
7543 The initial setting is @code{nil}.
7544 You can specify a folder or a group which is checked for unread message
7545 at the start. You can also specify a list of folders (groups) to be checked.
7546 If the value is @code{nil}, whole Desktop is checked at the start.
7547 If it is @code{none}, no folders are checked.
7549 @item wl-auto-uncheck-folder-list
7550 @vindex wl-auto-uncheck-folder-list
7551 The initial setting is the list shown below:
7560 You can set a list of regular expressions to specify folders
7561 which are not automatically checked even if they are included
7562 in some groups assigned by @code{wl-auto-check-folder-name}.
7564 @item wl-auto-check-folder-list
7565 @vindex wl-auto-check-folder-list
7566 The initial setting is @code{nil}.
7567 You can set a list of regular expressions to specify exceptions
7568 for @code{wl-auto-uncheck-folder-list}.
7570 @item wl-no-save-folder-list
7571 @vindex wl-no-save-folder-list
7572 The initial setting is the list shown below:
7581 This is a list of regular expressions of folders not to be saved.
7583 @item wl-save-folder-list
7584 @vindex wl-save-folder-list
7585 The initial setting is @code{nil}.
7586 This is a list of regular expressions of folders to be saved.
7587 This takes precedence over @code{wl-no-save-folder-list}.
7589 @item wl-folder-mime-charset-alist
7590 @vindex wl-folder-mime-charset-alist
7591 The initial setting is the alist shown below:
7595 (("^-alt\\.chinese" . big5)
7596 ("^-relcom\\." . koi8-r)
7598 ("^-han\\." . euc-kr))
7603 This is an associative list of regular expressions of folder names and
7605 If a folder do not match, @code{wl-mime-charset} is used.
7607 @item wl-folder-init-load-access-folders
7608 @vindex wl-folder-init-load-access-folders
7609 The initial setting is @code{nil}.
7610 This is a list of access groups to be loaded specifically at the start.
7611 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7613 @item wl-folder-init-no-load-access-folders
7614 @vindex wl-folder-init-no-load-access-folders
7615 The initial setting is @code{nil}.
7616 This is a list of access groups not to be loaded specifically at the
7618 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7620 @item wl-delete-folder-alist
7621 @vindex wl-delete-folder-alist
7622 The initial setting is the alist shown below:
7631 This list determines disposition of messages with delete marks.
7632 Each item in the list is a folder and destination; you can specify any
7633 one of the following in the place of destination:
7636 @code{remove} or @code{null} : deletes the messages instantly.
7637 string : moves the messages to the specific folder.
7638 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7641 @item wl-refile-policy-alist
7642 @vindex wl-refile-policy-alist
7643 The initial setting is the list shown below:
7653 This list determines whether messages with re-file marks are moved or
7654 copied. Each item in the list is a cons cell of a folder and
7655 @code{copy} or @code{move}.
7657 @item wl-x-face-file
7658 @vindex wl-x-face-file
7659 The initial setting is @file{~/.xface}.
7660 The name of the file that contains encoded X-Face strings.
7663 @item wl-demo-display-logo
7664 @vindex wl-demo-display-logo
7665 If non-nil, bitmap image is shown on the opening demo. If you set
7666 @code{xpm} or @code{xbm}, (if possible) display selected image type
7669 @item elmo-use-database
7670 @vindex elmo-use-database
7671 This is meaningful for XEmacs only. The initial setting depends on
7672 XEmacs (@code{t} for XEmacs with dbm).
7673 If non-nil, Message-ID is controlled by dbm.
7675 @item elmo-passwd-alist-file-name
7676 @vindex elmo-passwd-alist-file-name
7677 The initial setting is @file{passwd}.
7678 This is the name of the file in which passwords are saved.
7679 @code{elmo-passwd-alist-save} saves current passwords to the file.
7681 @item elmo-nntp-list-folders-use-cache
7682 @vindex elmo-nntp-list-folders-use-cache
7683 The initial setting is 600 (in seconds).
7684 This is period in seconds during which results of @samp{list} and
7685 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7688 @item elmo-nntp-max-number-precedes-list-active
7689 @vindex elmo-nntp-max-number-precedes-list-active
7690 The initial setting is @code{nil}.
7691 If non-nil, the number of article obtained by @samp{list active} in NNTP
7692 are used as the maximum article number of the folder.
7693 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7694 and if the number of read messages is not correct.
7696 @item elmo-nntp-default-use-listgroup
7697 @vindex elmo-nntp-default-use-listgroup
7698 The initial setting is @code{t}.
7699 If non-nil, @samp{listgroup} is used for checking the total number of
7700 articles. If it is @code{nil}, @samp{group} is used. In the latter
7701 case, the processing will be a little faster at the sacrifice of
7704 @item elmo-pop3-send-command-synchronously
7705 @vindex elmo-pop3-send-command-synchronously
7706 The initial setting is @code{nil}.
7707 If non-nil, POP3 commands are issued synchronously. Some implementation
7708 of POP3 server fails to get summary information without this setting.
7709 You may have to set this variable to @code{t}, if the process hangs
7710 while looking up POP3.
7712 @item elmo-dop-flush-confirm
7713 @vindex elmo-dop-flush-confirm
7714 The initial setting is @code{t}.
7715 If non-nil, you are asked for confirmation if accumulated off-line
7716 operations are executed.
7718 @item elmo-display-progress-threshold
7719 @vindex elmo-display-progress-threshold
7720 The initial setting is 20.
7721 Threshold for display of progress gauge. If number of renewal is more than
7722 this value, display progress gauge.
7726 @node Hooks, , Customizable Variables, Customization
7731 @node Terminology, Mailing List, Customization, Top
7732 @chapter Terminology around Wanderlust
7735 Here we explain terminologies used in this manual.
7739 A container in which messages are stored.
7742 A set consists of some folders.
7745 A special group consists of automatically collected folders under
7746 some specified path.
7747 @xref{Folder Definition}.
7749 @item summary buffer
7750 A buffer for displaying list of messages in some folder.
7752 @item sticky summary
7753 Compared with ordinary summary buffer which will be destroyed after
7754 exiting from it, this type of summary will be remain even after exiting
7755 by @kbd{q} or @kbd{g}.
7756 @xref{Sticky Summary}.
7759 To delete or put into the archive expired messages.
7766 To cache messages beforehand in order to read messages after you will be
7767 disconnected from the server.
7771 @node Mailing List, Addition, Terminology, Top
7772 @chapter Wanderlust Mailing List
7776 Topics related to Wanderlust are discussed in following mailing lists.
7777 The latest version is also announced there.
7780 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7783 In this list Japanese is mainly used for discussion. We also have a list
7784 for discussion in English:
7787 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
7789 (Messages posted to this list are also forwarded to the former one.)
7791 A guide can be obtained automatically by sending mail to
7792 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
7793 the English one) with the body
7799 Please send bug reports or patches to one of those lists. You can post to
7800 the mailing list even though you are not a member of it.
7802 If you send a bug report, please attach Backtrace with it.
7803 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7806 I would like to express my thanks to the members of the mailing list for
7807 valuable advice and many pieces of code they contributed.
7810 @node Addition, Index, Mailing List, Top
7811 @chapter Additional Information
7813 @section Brief History
7816 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7817 3/10 Made a msgdb mechanism by elisp.
7818 3/26 IMAP and NNTP can be displayed in threads.
7819 4/13 Began to assemble thread display modules as elmo.
7820 5/01 Finished 0.1.0, initial version with many defects.
7821 6/12 I made a slip of the tongue and said I was writing elisp
7822 mailer supporting IMAP
7823 6/16 0.1.3 was announced at tm-ja, elisp ML.
7824 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7825 7/01 Support for mm-backend (0.3.0).
7826 8/25 multi folder added (0.5.0).
7827 8/28 filter folder added (0.5.1).
7828 9/10 You can open/close threads (0.6.0).
7829 9/11 fldmgr by Murata-san made editing folders easy.
7830 9/18 lha folders added by Okunishi-san (0.6.3).
7831 9/24 Display of branches of threads (0.6.5).
7832 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7833 10/28 Off-line operations (0.7.4).
7834 12/09 Becomes beta version.
7835 12/21 wl-expire by Murata-san.
7836 1999 2/03 auto-refile by Tsumura-san.
7837 4/28 wl-template by Murata-san.
7838 5/18 Released 1.0.0 stable.
7839 7/05 Scoring by Murata-san (2.1.0).
7840 9/26 New plugged system by Murata-san (2.2.2).
7841 12/20 Support Modified UTF7.
7842 2000 3/24 Released 1.1.0 stable.
7843 4/03 CVS development started.
7844 5/07 Thread restoration & Its speed up with Murata-san.
7845 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7846 7/11 killed message feature.
7847 7/18 Use UIDL in POP3.
7848 9/12 biff feature with Satata-san & Yamaoka-san.
7849 10/17 expire-hide by Okada-san.
7850 11/08 Released 2.4.0 stable.
7851 2001 7/04 Released 2.6.0 stable.
7852 8/21 wl-addrmgr by Kitamoto-san.
7853 12/27 Released 2.8.1 stable.
7854 2002 12/11 Released 2.10.0 stable.
7857 See @file{ChangeLog} for details.
7861 According to a dictionary, Wanderlust has the meaning:
7865 n eager longing for or impulse towards travelling in distant lands
7866 [Ger, fr wandern to wander + lust desire, pleasure]
7870 but I had no profound intention. (if farfetched, IMAP @result{} you can
7871 read mail anywhere @result{} desire to wander ?)
7873 Elmo is the abbreviation of @samp{Elisp Library for Message
7874 Orchestration}. At first I meant the red puppet in the Sesame Street,
7875 but you may associate it with Wandering @result{} Drifting @result{}
7876 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7880 Each versions has code names (they are almost jokes).
7881 Currently they are picked up alphabetically from the top 40 hits of
7882 U.S. Billboard magazines in 1980s.
7884 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7887 @node Index, , Addition, Top
7891 * Concept Index:: Concept Index
7892 * Key Index:: Key Index
7893 * Variable Index:: Variable Index
7894 * Function Index:: Function Index
7897 @node Concept Index, Key Index, Index, Index
7898 @unnumberedsec Concept Index
7901 @node Key Index, Variable Index, Concept Index, Index
7902 @unnumberedsec Key Index
7905 @node Variable Index, Function Index, Key Index, Index
7906 @unnumberedsec Variable Index
7909 @node Function Index, , Variable Index, Index
7910 @unnumberedsec Function Index