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}, 13 types of folders are predefined. These
674 are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP,
675 Shimbun, Namazu, Multi, Filter, 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.
1654 @samp{'flag} [@samp{/} @var{global-flag}]
1656 @samp{'cache/00} - @samp{'cache/1F}
1660 A folder named @samp{'flag} is a special virtual folder which collects
1661 messages which have @var{global-flag}.
1663 Now, @samp{important} flag is supported as @var{global-flag}. You can
1664 review important messages at once after you put important marks on the
1665 messages in the different folders.
1667 In this folder, if you delete message, @var{global-flag} put on the
1668 message is removed. If you append messages to this folder, the message
1669 will have @var{global-flag}.
1672 A folder named @samp{'sendlog} is a virtual folder which collects
1673 cached messages which are recoded on @file{~/.elmo/sendlog}.
1674 It might be useful when you forgot to add cc for yourself.
1675 To use this, you should set @code{wl-draft-use-cache} to non-nil
1676 so that sent messages are cached.
1679 You can access cached messages fetched via network by accessing
1680 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1681 the name of the subdirectories of the cache directory
1682 (@file{~/.elmo/cache}).
1685 @node Folder, Summary, Folders, Top
1686 @chapter Folder mode
1689 After you start Wanderlust, folder mode is appeared firstly.
1690 It contains folder list you subscribed.
1691 You can select and edit folders in this mode.
1694 * Selecting Folder:: Select folder you want to read
1695 * Folder Manager:: Editing folders
1699 @node Selecting Folder, Folder Manager, Folder, Folder
1700 @section Selecting Folder
1701 @cindex Selecting Folder
1703 @subsection Usage (TIPS)
1705 @subsubsection Check new, unread number
1707 Folder mode looks like this.
1708 (In XEmacs, it looks much nicer @t{;-)})
1712 [-]Desktop:14186/35580/67263
1717 [-]Emacsen:0/34/4837
1718 Wanderlust ML:0/0/558
1721 XEmacs Beta:0/29/255
1732 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1736 @kbd{s} key on the folder line updates these numbers.
1737 It changes its color if it has many new messages.
1739 The whole folder mode is a folder group named @samp{Desktop}.
1740 Folder group open/close by return key.
1741 A operation to a folder group is treated as operations on the
1743 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1744 six children folders update its unread number status.
1746 @subsubsection Select Folder
1748 To enter summary mode of the folder, type return (or space) key on
1750 If the variable @code{wl-stay-folder-window} has non-nil value,
1751 summary window appears on the right of the folder mode window.
1753 @subsection Key bindings
1755 Folder mode's key binding (related to selecting folders) is following.
1760 @kindex @key{SPC} (Folder)
1761 @kindex @key{RET} (Folder)
1762 @findex wl-folder-jump-to-current-entity
1763 Enter to the summary mode of the folder at the current cursor point.
1764 With prefix argument, enter the sticky summary.
1765 If the cursor is on the top of folder group line,
1766 the folder group is opened or closed.
1767 When the cursor is on the access group and this command is called
1768 with prefix argument, folder children list is updated to the newest one.
1769 (Children list is updated recursively if the access folder has hierarchical
1771 (@code{wl-folder-jump-to-current-entity})
1774 @kindex M-@key{RET} (Folder)
1775 @findex wl-folder-update-recursive-current-entity
1776 Folder children list of the access group at the current cursor point
1777 is updated to the newest one.
1778 (Children list is updated recursively if the access folder has hierarchical
1780 (@code{wl-folder-update-recursive-current-entity})
1785 Create a new draft message.
1790 @findex wl-folder-write-current-folder
1791 If the current cursor point is on the NNTP folder, create a new draft
1792 message which already has @samp{Newsgroups:} field. If the current
1793 cursor point is on the folder for mailing list (refile destination),
1794 create a new draft message which already has @samp{To:} field with
1795 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1797 (@code{wl-folder-write-current-folder})
1800 @kindex C-c C-o (Folder)
1801 @findex wl-jump-to-draft-buffer
1802 Move to the draft buffer if available. If multiple draft buffer exists,
1803 moved to one after another. If prefix argument is specified, load draft
1804 folder's message to the draft buffer and jump to it.
1805 (@code{wl-jump-to-draft-buffer})
1809 @findex wl-folder-check-current-entity
1810 Update new and unread number information of the folder at the current
1812 (@code{wl-folder-check-current-entity})
1816 @findex wl-folder-sync-current-entity
1817 Update summary information of the folder at the current cursor point.
1818 (@code{wl-folder-sync-current-entity})
1821 @kindex r s (Folder)
1822 @findex wl-folder-check-region
1823 Update new and unread number information of the folders in the currently
1825 (@code{wl-folder-check-region})
1828 @kindex r S (Folder)
1829 @findex wl-folder-sync-region
1830 Update summary information of the folders in the currently selected region.
1831 (@code{wl-folder-sync-region})
1835 @findex wl-status-update
1836 Sync up address book status with @file{~/.addresses}'s content.
1837 (@code{wl-status-update})
1841 @findex wl-folder-prev-unread
1842 Jump cursor to the folder which have unread messages on the upward from
1843 current cursor point.
1844 (@code{wl-folder-prev-unread})
1848 Jump cursor to the folder which have unread messages on the downward
1849 from current cursor point.
1850 (@code{wl-folder-next-unread})
1854 Move cursor to the folder on the previous line.
1855 (@code{wl-folder-prev-entity})
1859 Move cursor to the folder on the next line.
1860 (@code{wl-folder-next-entity})
1864 Jump to the folder specified by the user input.
1865 (@code{wl-folder-jump-folder})
1869 @findex wl-folder-prefetch-current-entity
1870 Prefetch new messages of the folder at the current cursor point by
1871 @code{wl-summary-incorporate}.
1872 If the cursor is on the folder group, it is executed recursively.
1873 (@code{wl-folder-prefetch-current-entity})
1877 @findex wl-folder-mark-as-read-all-current-entity
1878 Mark all unread messages of the folder at the current cursor point as read.
1879 If the cursor is on the folder group, it is executed recursively.
1880 (@code{wl-folder-mark-as-read-all-current-entity})
1884 @findex wl-folder-goto-first-unread-folder
1885 Enter summary mode of the first unread folder.
1886 (@code{wl-folder-goto-first-unread-folder})
1890 @findex wl-folder-empty-trash
1892 (@code{wl-folder-empty-trash})
1896 @findex wl-folder-flush-queue
1898 (@code{wl-folder-flush-queue})
1902 @findex wl-folder-virtual
1903 Move to the virtual folder (filter folder) with the condition specified.
1904 (@code{wl-folder-virtual})
1908 @findex wl-folder-pick
1909 Search the folders with the condition specified.
1910 (@code{wl-folder-pick})
1914 @findex wl-folder-open-all-unread-folder
1915 All unread folder is opened.
1916 (@code{wl-folder-open-all-unread-folder})
1920 @findex wl-folder-open-close
1921 Folder group is opened/closed.
1922 (@code{wl-thread-open-close})
1926 All folder group is opened.
1927 (@code{wl-folder-open-all})
1931 All folder group is closed.
1932 (@code{wl-folder-close-all})
1942 (@code{wl-folder-suspend})
1945 @kindex M-s (Folder)
1946 Save current folder status.
1950 @kindex M-t (Folder)
1951 Toggle Wanderlust's offline/online status.
1952 (@code{wl-toggle-plugged})
1955 @kindex C-t (Folder)
1956 Start Wanderlust's plug-status manager.
1957 (@code{wl-plugged-change})
1960 @subsection Customize variables
1963 @item wl-folders-file
1964 @vindex wl-folders-file
1965 The initial setting is @file{~/.folders}.
1966 Subscribed folders are described (saved) in this file.
1968 @item wl-folder-info-save
1969 @vindex wl-folder-info-save
1970 The initial setting is @code{t}. If non-nil, unread information is
1971 saved and used in the next Wanderlust session.
1973 @item wl-stay-folder-window
1974 @vindex wl-stay-folder-window
1975 The initial setting is @code{nil}.
1976 If non-nil, summary window is appeared on the right side of the folder buffer.
1978 @item wl-folder-window-width
1979 @vindex wl-folder-window-width
1980 The initial setting is 20.
1981 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1983 @item wl-folder-use-frame
1984 @vindex wl-folder-use-frame
1985 The initial setting is @code{nil}.
1986 If non-nil, use new frame for the folder window.
1988 @item wl-folder-many-unsync-threshold
1989 @vindex wl-folder-many-unsync-threshold
1990 The initial setting is 70.
1991 If the number of unread messages is more than this value,
1992 folder color is changed.
1994 @item wl-highlight-folder-by-numbers
1995 @vindex wl-highlight-folder-by-numbers
1996 This option controls how to highlight each line in the folder buffer.
1997 The default value is @code{t}, highlighting with various colors based on
1998 the message numbers. If it is @code{nil}, highlighting with various
1999 colors based on the folder status. In addition, if it is a number
2000 (e.g. 1), highlighting will be done based on both the message numbers
2001 and the folder status.
2003 @item wl-folder-desktop-name
2004 @vindex wl-folder-desktop-name
2005 The initial setting is @samp{Desktop}.
2006 The name of top folder group.
2008 @item wl-folder-petname-alist
2009 @vindex wl-folder-petname-alist
2010 The initial setting is @code{nil}.
2011 An alist of folder's realname and its nickname.
2013 @item wl-folder-access-subscribe-alist
2014 @vindex wl-folder-access-subscribe-alist
2015 The initial setting is @code{nil}.
2017 Control automatic subscribing and unsubscribing of the children list
2023 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2027 If @var{subscribe-flag} is non-nil, folders which have name matched to
2028 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2029 already unsubscribed folder is not displayed even when the
2030 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2037 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2038 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2039 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2040 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2044 @item wl-folder-hierarchy-access-folders
2045 @vindex wl-folder-hierarchy-access-folders
2046 The initial setting is the list shown below:
2055 A list of regular expressions for access groups which creates children
2056 folder list hierarchically.
2058 For example, if you specify
2059 @code{wl-folder-hierarchy-access-folders} like following,
2063 (setq wl-folder-hierarchy-access-folders
2064 '("^-$" "^-alt$" "^-japan$" "^-comp$" "^-comp.unix$"))
2069 you obtain the access group hierarchy as follows.
2075 -fj.comp.announce:0/0/2
2076 -fj.comp.dev.cdrom:0/0/0
2078 [+]-japan:238/238/1688
2081 -comp.unix.admin:0/0/0
2082 -comp.unix.dos-under-unix:0/0/0
2083 -comp.unix.programmer:0/0/0
2084 [-]-comp.unix.bsd:0/0/23
2085 -comp.unix.bsd.freebsd.announce:0/0/0
2090 If you opened @samp{-} in this example, only the direct children is created
2091 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2092 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2093 is not created until the children access group is opened.
2097 @node Folder Manager, , Selecting Folder, Folder
2098 @section Editing Folders
2099 @cindex Folder Manager
2100 @cindex Folder, Edit
2101 @cindex Folder, Subscribe
2102 @cindex Folder, Unsubscribe
2104 As described before, subscribed folder list is saved in @file{~/.folders} file.
2105 But you don't have to edit @file{~/.folders} directly.
2106 You can append, delete, edit folders from folder mode.
2108 @subsection Usage (Tips)
2110 @subsubsection Append Folder
2112 @kbd{m a} appends new folder to the folder mode.
2113 @kbd{m g} appends new folder group.
2114 To append new folder to this group, firstly open it,
2115 then execute append command in the next line.
2117 @subsubsection Edit Folder
2119 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2120 Thus, you can change folder position as if you were editing a normal file.
2122 @subsubsection Create Multi Folder.
2126 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2128 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2130 Type @kbd{m m}, then you can create multi folder.
2133 @subsubsection Delete Nickname, Filter
2135 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2136 minibuffer while appending.
2138 @subsubsection Append Folder to Empty Group
2140 To append new folder to the empty folder group
2141 (after you create folder group by typing @kbd{m g}),
2142 firstly open it, then execute append command in the next line.
2143 If it is closed, folder is appended on the same level with
2144 the folder group above. It is difficult to explain by words so try it.
2145 In other words, appended position depends on the
2146 open/close status of the upper one.
2148 @subsubsection Charset of the Folders File.
2150 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2152 @subsubsection Create Filter
2154 @kbd{m f} adds filter to the folder at the current cursor point. To
2155 create new filter folder and leave the current folder unchanged, copy it
2156 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2157 filter can be specified while appending filter. If you put
2158 ``''(@var{NULL}), filter is deleted.
2160 @subsubsection Sort Folders
2162 Sorting of the folders is executed by the function specified by
2163 @code{wl-fldmgr-sort-function}.
2164 The initial setting is @code{wl-fldmgr-sort-standard},
2165 which sorts alphabetically.
2166 Sorting affects only on the current folder group. It does not
2167 affect on the child groups.
2169 @subsubsection Hiding Folders in the Access Group
2171 Usually, access group displays all children folders, but you can set
2172 some folders hidden. Following operations are only available on access
2175 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2176 (subscribe/unsubscribe) of the folder at current cursor point. Against
2177 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2180 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2181 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2182 argument and if the argument has positive number, the unsubscribe it.
2183 If the prefix argument has negative value, folder becomes visible and if
2184 zero, folder visibility is toggled.
2186 The other commands, @code{wl-fldmgr-subscribe} and
2187 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2190 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2191 executed in the access group, they have a same effect with
2192 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2193 The difference is that cut commands deletes folders from the current
2196 @subsubsection Operations in the Access Group
2198 You can insert and delete folders in the access group like usual folder
2199 group. But insert and delete commands can be only available for the
2200 children folders of the access group and they only sets the subscribe
2201 status. In other words, insertion of the folder means subscribing,
2202 deletion means unsubscribing.
2203 @footnote{In the current implementation,
2204 it is faster to delete region than to unsubscribe region.}
2206 To update the access group when children folders are inserted or deleted
2207 by other way (other than Wanderlust),
2208 open the access group by typing @kbd{C-u @key{RET}}.
2209 @xref{Selecting Folder}.
2211 The order of children folders of access group is saved after
2212 insertion/deletion/sorting.
2213 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2214 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2215 newly created folders are inserted on the top of the access group.
2217 @subsection Key bindings
2218 @cindex Keybind, Folder Mode
2219 @cindex Keybind, Folder Buffer
2221 Key bindings on the folder mode related to folder editing are shown below.
2222 All bindings starts with @kbd{m}, and primary commands are binded to
2223 one stroke key binding.
2227 @kindex m a (Folder)
2228 @findex wl-fldmgr-add
2230 (@code{wl-fldmgr-add})
2235 @kindex m g (Folder)
2236 @findex wl-fldmgr-make-group
2237 Create a folder group.
2238 (@code{wl-fldmgr-make-group})
2241 @kindex m A (Folder)
2242 @findex wl-fldmgr-make-access-group
2243 Create an access group.
2244 (@code{wl-fldmgr-make-access-group})
2247 @kindex m d (Folder)
2248 @findex wl-fldmgr-delete
2249 Delete folder itself and msgdb.
2250 If the folder itself cannot be deleted like NNTP folder,
2251 only msgdb is deleted.
2252 (@code{wl-fldmgr-delete})
2257 @kindex m R (Folder)
2258 @findex wl-fldmgr-rename
2259 Change the name of folder or folder group.
2260 msgdb's path is also changed.
2261 (@code{wl-fldmgr-rename})
2267 @findex wl-fldmgr-make-multi
2268 Create a multi folders in the cutlist (cut, copied folders).
2269 (@code{wl-fldmgr-make-multi})
2274 @kindex m f (Folder)
2275 @findex wl-fldmgr-make-filter
2276 Create a filter folder. (Put a filter on the folder).
2277 (@code{wl-fldmgr-make-filter})
2281 @kindex M-c (Folder)
2282 @kindex m c (Folder)
2283 @findex wl-fldmgr-copy
2284 Copy folder (it is not available on folder group).
2285 (@code{wl-fldmgr-copy})
2289 @kindex M-w (Folder)
2290 @kindex m W (Folder)
2291 @findex wl-fldmgr-copy-region
2292 Copy folders in the specified region.
2293 (@code{wl-fldmgr-copy-region})
2297 @kindex C-k (Folder)
2298 @kindex m k (Folder)
2299 @findex wl-fldmgr-cut
2300 Cut folder. Folder itself is not deleted.
2301 (@code{wl-fldmgr-cut})
2305 @kindex C-w (Folder)
2306 @kindex m C-w (Folder)
2307 @findex wl-fldmgr-cut-region
2308 Cut folders in the specified region.
2309 (@code{wl-fldmgr-cut-region})
2313 @kindex C-y (Folder)
2314 @kindex m y (Folder)
2315 @findex wl-fldmgr-yank
2316 Paste folders that are copied or cut (folders in the cut-list).
2317 (@code{wl-fldmgr-yank})
2320 @kindex m p (Folder)
2321 @findex wl-fldmgr-set-petname
2322 Put nickname on the folder.
2323 (@code{wl-fldmgr-set-petname})
2326 @kindex m q (Folder)
2327 @findex wl-fldmgr-clear-cut-entity-list
2328 Clear the cut-list. (cut, copied folder information is cleared,
2329 you cannot paste after this)
2330 (@code{wl-fldmgr-clear-cut-entity-list})
2333 @kindex m s (Folder)
2334 @findex wl-fldmgr-sort
2335 Sort folders in the current folder group.
2336 (@code{wl-fldmgr-sort})
2339 @kindex m C-s (Folder)
2340 @findex wl-fldmgr-save
2341 Save current folder view to the @file{wl-folders-file}.
2342 (@code{wl-fldmgr-save})
2345 [Following commands are only available on the access groups]
2351 @kindex m u (Folder)
2352 @findex wl-fldmgr-unsubscribe
2353 Set the visibility of folder (subscribe/unsubscribe).
2354 (@code{wl-fldmgr-unsubscribe})
2359 @kindex r u (Folder)
2360 @findex wl-fldmgr-unsubscribe-region
2361 Set the visibility of the folders (subscribe/unsubscribe) in the
2363 (@code{wl-fldmgr-unsubscribe-region})
2368 @kindex m l (Folder)
2369 @findex wl-fldmgr-access-display-normal
2370 List folders that are currently available.
2371 (@code{wl-fldmgr-access-display-normal})
2376 @kindex m L (Folder)
2377 @findex wl-fldmgr-access-display-all
2378 List all folders regardless of the subscription status.
2379 (@code{wl-fldmgr-access-display-all})
2383 @subsection Customize variables
2386 @item wl-interactive-save-folders
2387 @vindex wl-interactive-save-folders
2388 The initial setting is @code{t}. If non-nil and folder view is
2389 modified, confirm saving it before Wanderlust or Emacs exits. If
2390 @code{nil}, save without confirmation.
2392 @item wl-fldmgr-make-backup
2393 @vindex wl-fldmgr-make-backup
2394 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2395 created before saving the folder status.
2397 @item wl-fldmgr-sort-function
2398 @vindex wl-fldmgr-sort-function
2399 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2400 sort folders. By default function, folders are sorted alphabetically
2401 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2404 @item wl-fldmgr-sort-group-first
2405 @vindex wl-fldmgr-sort-group-first
2406 The initial setting is @code{t}. If non-nil,
2407 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2408 does not care whether it is folder group or not.
2410 @item wl-folder-check-async
2411 @vindex wl-folder-check-async
2412 The initial setting is @code{t}. If non-nil, check folder's unread
2413 status asynchronously. It boosts newsgroup checking.
2415 @item wl-folder-check-fast
2416 @vindex wl-folder-check-fast
2417 The initial setting is @code{nil}.
2418 If non-nil, it does not update folder status while checking.
2420 @item wl-folder-notify-deleted
2421 @vindex wl-folder-notify-deleted
2422 The initial setting is @code{nil}.
2424 If non-nil, negative value is displayed when the message is deleted. If
2425 @code{sync}, folder is synchronized when the message is deleted. If
2426 @code{nil}, message deletion is ignored.
2428 @item wl-fldmgr-add-complete-with-current-folder-list
2429 @vindex wl-fldmgr-add-complete-with-current-folder-list
2430 The initial setting is @code{nil}.
2431 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2432 candidate for @code{wl-fldmgr-add}.
2435 @subsection Miscellanea
2437 Following is a note for folder editing.
2441 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2442 paste(yank) command pastes the folders on one cut or copy command
2443 (If copy command is executed by region, folders in the region are pasted
2444 by one paste command)
2447 You cannot cut @samp{Desktop} group.
2448 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2451 You cannot copy folder group.
2454 Operations on the access group are only available for the folders
2455 in the same access group.
2458 You cannot create a folder which has same name with the folders already exist.
2461 You cannot insert folders which have same name in one group.
2462 You can insert them in the different groups.
2463 You cannot put same nickname to the different folders.
2467 @node Summary, Message, Folder, Top
2468 @chapter Summary Mode
2470 After you select the folder via folder mode, you enter to the summary
2474 * Usage of Summary Mode:: TIPS
2475 * Thread Operations:: Thread operations
2476 * Cache:: File cache, Buffer cache, and Prefetch
2477 * Auto Refile:: Auto refile settings
2478 * Sticky Summary:: Summary make sticky
2479 * Summary View:: Format of summary lines
2480 * Key Bindings of Summary:: Key bindings
2481 * Variables of Summary:: Customize Summary Mode
2485 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2486 @section Usage (Tips)
2488 @subsection Summary Content
2490 In the summary mode, messages are displayed like following.
2494 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2495 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2496 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2497 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2504 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2508 If you want to know how to change the format for this, please refer
2509 the section format of Summary lines.
2510 @xref{Summary View}.
2512 @var{Message number} is the message's unique number in the folder. In
2513 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2514 in the MH folder, it is the filename of the message.
2516 @var{Temporal mark} and @var{Persistent mark} are described later.
2518 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2519 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2520 Japanese, but if you want to display it in English, set the value of
2521 @code{wl-summary-weekday-name-lang} as @samp{en}.
2523 @var{Sender}'s indentation corresponds to the depth of the thread.
2524 Sender name is displayed as nickname if it is defined in the address
2525 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2526 displaying with nickname.
2528 If number is printed at the head of @var{Sender} part like @samp{+2},
2529 that means the message have 2 follow messages.
2531 @var{Subject} is the @samp{Subject:} header field of the message. If
2532 the message have same @samp{Subject:} with the parent message, it is not
2533 displayed. Some mailing list puts its sequence number in the
2534 @samp{Subject:} field, but it is
2535 ignored. @code{wl-summary-no-subject-message} is displayed when the
2536 message has empty subject field.
2538 @subsection Temporary Marks
2539 @cindex Mark, Temporary
2541 There are four temporary marks,
2542 @samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}.
2543 Temporary marks indicates message operations.
2548 You can execute a command on the all messages that have @samp{*} mark,
2549 with the key bindings which begins with @kbd{m}.
2552 The mark to dispose. You can put @samp{d} by typing @kbd{d} key.
2555 The mark to force delete. 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 The mark to prefetch reserved.
2570 You can put this mark by typing @kbd{i} key.
2573 The mark to resend reserved.
2574 After you type @kbd{~} key, prompt appears to input address to resend.
2575 Your answer is printed in the summary line.
2578 @kbd{x} key executes action for temporary marks, respectively.
2580 @subsection Persistent Marks
2582 There are five persistent marks, @samp{N}, @samp{?}, @samp{U}, @samp{!},
2583 @samp{u}, @samp{A}, @samp{&} and @samp{$}.
2585 The persistent mark indicates the message's status and it is saved.
2586 Each persistent mark indicates:
2592 It is new but cached message.
2594 It is unread message.
2596 It is unread but cached message.
2598 It is read but it is not cached.
2600 It is already replied message.
2602 It is already replied but cached message.
2604 It is important message. You can put @samp{$} mark by typing @kbd{$}
2605 key (if already exists, the mark is deleted). It is convenient to put
2606 this mark on the messages to remember (If you want to remember to write
2607 a reply for the message, for example) because this mark remains after
2608 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2609 @samp{'mark} folder even the message itself is deleted in the actual folder.
2612 If the message is read and cached (or local message),there are no
2616 @samp{N}, @samp{U}, @samp{u}, @samp{A} indicates that the message have
2617 no cache. Messages with the marks other than these, you can read them
2618 in the offline status even they are in the IMAP folder or netnews
2621 Among messages with persistent marks, ones with marks specified by
2622 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2623 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2625 @subsection How To Read
2627 Basically, you can read messages only typing space key again and again.
2629 To update summary status to the newest status (synchronize),
2632 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2633 moves cursor to the next message.
2634 Enter message buffer by typing @kbd{j} key.
2635 To operate multipart, you have to enter to the message buffer.
2638 @subsection Pack the Message Numbers
2639 You can pack the message numbers in Summary by
2640 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2641 News Spool Folder and Maildir Folder are supported folder types.
2644 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2645 @section Thread Operations
2647 For example, the following line indicates one thread (a context of a topic).
2650 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2654 If you type @kbd{/} on this line, the thread is opened and it changes
2655 the appearance like following.
2659 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2660 388 09/17(Thu)22:34 +-[ Murata san ]
2664 (Message 388 is the replied message to the message 384.)
2665 If you type @kbd{/} key once again, the thread is closed.
2666 With prefix argument, @kbd{/} opens all children threads.
2668 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2671 Commands with the key binding that begins with @kbd{t} executes commands
2672 on the messages in the thread.
2673 @xref{Key Bindings of Summary}.
2675 @subsection reconstruct thread by hand
2677 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2678 (@code{wl-summary-save-current-message}) at the corresponding message,
2679 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2680 message then you have the reconstructed thread.
2683 @node Cache, Auto Refile, Thread Operations, Summary
2686 @subsection Cache File
2688 The messages which have to access via network (e.x. IMAP, NNTP folder)
2689 are cached as a local file so as to save network traffic or to enable
2690 off-line operation. The cache file is saved under the directory
2691 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2692 elmo-cache-expire-by-size}. The command deletes cache files to the
2693 specified size by the order of last accessed time.
2695 @subsection Buffer Cache and Prefetching
2697 The messages that are read are kept in the cache buffer so as to make
2698 the behavior fast when you are to read the message again. It is called
2699 `buffer cache'. The number of cache buffer is specified by
2700 @code{wl-message-buffer-cache-size}.
2702 There are message prefetching mechanism in the Wanderlust that
2703 prefetches next message while you are reading.
2705 You can control the message prefetching mechanism by these two
2709 @item wl-message-buffer-prefetch-folder-type-list
2710 @vindex wl-message-buffer-prefetch-folder-type-list
2711 The initial setting is @code{t}. In this case, prefetch messages in all
2713 If it is a list of folder types, it specifies the folder types in which
2714 message prefetching is enabled.
2715 Following is an example (prefetch messages in nntp and imap4 folders)
2719 (setq wl-message-buffer-prefetch-folder-type-list
2724 In this case, multi folder that contains localdir and imap4 prefetches
2725 only imap4 messages. This variable precedes the value of
2726 @code{wl-message-buffer-prefetch-folder-list}.
2728 @item wl-message-buffer-prefetch-folder-list
2729 @vindex wl-message-buffer-prefetch-folder-list
2730 The initial setting is @code{nil}.
2731 A list of regexp of folders to enable message prefetching.
2733 @item wl-message-buffer-prefetch-depth
2734 @vindex wl-message-buffer-prefetch-depth
2735 The initial setting is 3. The number of messages for automatical prefetch.
2737 @item wl-message-buffer-prefetch-idle-time
2738 @vindex wl-message-buffer-prefetch-idle-time
2739 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2741 @item wl-message-buffer-prefetch-threshold
2742 @vindex wl-message-buffer-prefetch-threshold
2743 The initial setting is 30000 (bytes). If prefetching message has larger
2744 size than this value, Wanderlust does not prefetch automatically.
2745 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2746 the message is not checked for the size.
2748 @item wl-auto-prefetch-first
2749 @vindex wl-auto-prefetch-first
2750 The initial setting is @code{nil}.
2751 If non-nil, first message is automatically prefetched to the buffer
2752 when you enter the folder.
2756 @node Auto Refile, Sticky Summary, Cache, Summary
2757 @section Auto Refile
2758 @vindex elmo-msgdb-extra-fields
2759 @vindex wl-refile-rule-alist
2760 @findex wl-summary-auto-refile
2762 You can refile messages automatically, by typing @kbd{C-o}
2763 (@code{wl-summary-auto-refile}). It decides destination of refile by
2764 the content of the message header information (information in the msgdb).
2766 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2767 available. If you want to decide destination by other header fields,
2768 set the variable @code{elmo-msgdb-extra-fields} like following.
2772 (setq elmo-msgdb-extra-fields
2782 By this setting, Wanderlust saves extra fields in the msgdb. You have
2783 to type @kbd{s all} to get extra fields for the messages that are
2784 already exists in the summary.
2786 Then, specify the refile rule. The refile target folder of auto
2787 refiling is decided by the value of @code{wl-refile-rule-alist}.
2788 @code{wl-refile-rule-alist} is a list of a rule:
2792 (@var{field} (@var{regexp} . @var{target})
2793 (@var{regexp} . @var{target})
2798 Each rule means `if @var{field} value matches @var{regexp},
2799 then refile to @var{target} folder'.
2800 The rule matched first is applied.
2802 @var{field} is a string of field name. You can specify a list of field name
2803 string, too. In this case, if one of these fields is matched, then the
2804 rule is fired (i.e. OR condition).
2806 @var{regexp} is a regular expression for field value. @var{target} is a target
2807 folder string. You can specify a rule at @var{target} part, too. In this
2808 case, If the field value of the rule and the current rule is matched,
2809 then the current rule is fired (i.e. AND condition).
2811 You can refer matched substring of @var{regexp} to specify @var{target} part.
2812 To refer substring, use following keys:
2816 means substitute original matched text.
2819 means substitute what matched the @var{N}th `\(@dots{}\)'.
2820 (@var{N} is a number.)
2823 Following is an example of @code{wl-refile-rule-alist}.
2827 (setq wl-refile-rule-alist
2829 ("^Wanderlust" . "+wl")
2830 ("^Elisp" . "+elisp"))
2832 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2834 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2835 "+from-me-to-you"))))))
2839 After these settings, refile marks are automatically put on the condition
2840 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2842 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2844 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2845 with these persistent marks are not automatically refiled.
2846 It means Wanderlust does not execute auto refile on unread messages by
2847 the default setting.
2848 To execute auto refile on all messages, set following.
2851 (setq wl-summary-auto-refile-skip-marks nil)
2855 @node Sticky Summary, Summary View, Auto Refile, Summary
2856 @section Sticky Summary
2857 @cindex Summary, Sticky
2858 @cindex Sticky Summary
2860 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2862 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2863 @kbd{G} in some suummary sticky summary buffer is created.
2864 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2865 makes current one sticky.
2867 The buffer name of the sticky summary becomes like
2868 @samp{Summary:@var{folder-name}}.
2869 You can visit the sticky summary at any time by @kbd{C-x b}
2870 (@code{switch-to-buffer}), or you can go round summary buffers by
2871 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2872 (@code{wl-summary-next-buffer}) in summary mode.
2874 In sticky summary, the summary buffer is preserved after @kbd{g} or
2875 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2876 another summary by @kbd{C-u g}. Other operations in the sticky summary
2877 are same as normal summary.
2879 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2880 are automatically stuck.
2883 @node Summary View, Key Bindings of Summary, Sticky Summary, Summary
2884 @section Format of summary lines
2885 @cindex Format of summary lines
2886 You can alter the format of lines in Summary mode.
2888 Summary line format is specified by @code{wl-summary-line-format}.
2889 You can use control strings defined by
2890 @code{wl-summary-line-format-spec-alist}.
2896 ;; @r{number temporary-mark persistent-mark date branch}
2897 ;; @r{[ (number-of-children) sender ] subject}
2898 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
2902 Where the number set the column number of the field (for negative value,
2905 Major control strings defined by @code{wl-summary-line-format-spec-alist}
2906 are displayed in the following list.
2917 %t branch of the thread
2918 %[ [ (< for re-connected child)
2919 %] ] (> for re-connected child)
2923 %c +number-of-children: (display only for opened thread)
2924 %C [+number-of-children] (display only for opened thread)
2925 %T temporary mark (mandatory)
2926 %P persistent mark (mandatory)
2930 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
2931 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
2932 the constant column. For example, if you specify @samp{%T} or
2933 @samp{%P} after the @samp{%t}, which changes its length by thread
2934 position, marks are not treated correctly.
2936 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
2937 column of the enclosed region is justified to the `number'. Multiple
2938 level @samp{%number(} parenthesis can be defined. It is useful to
2939 justify the column of the multiple control strings. For example, in the
2940 above @code{wl-summary-line-format},
2946 means ``Adjust number-of-children and sender string to the 17 column''.
2948 You can specify the format by each folders with
2949 @code{wl-folder-summary-line-format-alist}. Please set regular
2950 expression for folder names and summary line format as the following
2955 (setq wl-folder-summary-line-format-alist
2956 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
2957 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
2961 @subsection on the format for sender name
2963 The format string @samp{%f} displays the return value of the function specified
2964 by @code{wl-summary-from-function}. If you use the function
2965 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
2966 while displays the recipient names if the folder name matches with
2967 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
2968 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
2970 For example, to display recipient names for the message in @samp{+backup} if
2971 its sender is yourself, set up as follows.
2974 (setq wl-summary-showto-folder-regexp "^\\+backup$")
2978 @node Key Bindings of Summary, Variables of Summary, Summary View, Summary
2979 @section Key bindings
2980 @cindex Keybind, Summary Mode
2981 @cindex Keybind, Summary Buffer
2983 Key bindings of the summary mode are shown below.
2987 @kindex @key{SPC} (Summary)
2988 @findex wl-summary-read
2989 Proceed reading a message at the current cursor point.
2990 (@code{wl-summary-read})
2994 @findex wl-summary-redisplay
2995 Redisplay a message at the current cursor point.
2996 If this command is called with prefix argument,
2997 Redisplay message regardless of the message cache (message is re-loaded
2999 (@code{wl-summary-redisplay})
3003 @findex wl-summary-display-top
3004 Display the top message in the folder.
3005 (@code{wl-summary-display-top})
3009 @findex wl-summary-display-bottom
3010 Display the bottom message in the folder.
3011 (@code{wl-summary-display-bottom})
3015 @kindex @key{BS} (Summary)
3016 @kindex @key{DEL} (Summary)
3017 Display the previous page of the message at the current cursor point.
3018 @findex wl-summary-prev-page
3019 (@code{wl-summary-prev-page})
3022 @kindex @key{RET} (Summary)
3023 @findex wl-summary-next-line-content
3024 Display the next line of the message at the current cursor point.
3025 Display the message at the current cursor point if it is not displayed yet.
3026 (@code{wl-summary-next-line-content})
3031 @kindex M-@key{RET} (Summary)
3032 @findex wl-summary-prev-line-content
3033 Display the previous line of the message at the current cursor point.
3034 Display the message at the current cursor point if it is not displayed yet.
3035 (@code{wl-summary-prev-line-content})
3039 @findex wl-thread-open-close
3040 Toggle open or close the thread at the current cursor point.
3041 (@code{wl-thread-open-close})
3046 @findex wl-thread-open-all
3047 (@code{wl-thread-open-all})
3052 @findex wl-thread-close-all
3053 (@code{wl-thread-close-all})
3057 @findex wl-summary-goto-folder
3059 (@code{wl-summary-goto-folder})
3063 Mark all messages in the folder as read.
3064 @findex wl-summary-mark-as-read-all
3065 (@code{wl-summary-mark-as-read-all})
3069 @findex wl-summary-reply
3070 Prepare a draft for reply the message at the current cursor point.
3071 (@code{wl-summary-reply})
3075 @findex wl-summary-reply-with-citation
3076 Prepare a draft for reply the message at the current cursor point.
3077 (@code{wl-summary-reply-with-citation})
3081 @findex wl-summary-cancel-message
3082 If the message at current cursor point is your own netnews article,
3084 (@code{wl-summary-cancel-message})
3088 @findex wl-summary-reedit
3089 Prepare a draft for re-editing the message at current cursor point.
3090 If the message at current cursor point is your own netnews article,
3091 a draft for `supersedes message' for the message is prepared.
3092 (@code{wl-summary-reedit})
3095 @kindex M-E (Summary)
3096 @findex wl-summary-resend-bounced-mail
3097 If the message at current cursor point is a bounced message,
3098 a draft for re-sending original message is prepared.
3099 (@code{wl-summary-resend-bounced-mail})
3103 @findex wl-summary-forward
3104 A draft for forwarding the message at current cursor point is prepared.
3105 (@code{wl-summary-forward})
3109 @findex wl-summary-mark-as-important
3110 Put @samp{$} mark on the message at current cursor point.
3111 If already marked as @samp{$}, remove the mark.
3112 (@code{wl-summary-mark-as-important})
3118 Save the message at current cursor point.
3119 @findex wl-summary-save
3120 (@code{wl-summary-save})
3124 @findex wl-summary-next
3125 Move cursor to the next message.
3126 If message is marked with a temporal mark in
3127 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3128 In the offline mode, cursor is not moved to the messages which are not cached
3130 (@code{wl-summary-next})
3134 @findex wl-summary-prev
3135 Move cursor to the previous message.
3136 If message is marked with a temporal mark in
3137 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3138 In the offline mode, cursor is not moved to the messages which are not cached
3140 (@code{wl-summary-prev})
3144 @findex wl-summary-down
3145 Move cursor to the downward message which is unread or marked
3147 In the offline mode, cursor is not moved to the messages which are not cached
3149 If there are messages which have target mark @samp{*} in the summary,
3150 cursor is moved to the downward message which have a target mark.
3151 This behavior is changed according to the value of @code{wl-summary-move-order}.
3152 (@code{wl-summary-down})
3156 @findex wl-summary-up
3157 Move cursor to the upward message which is unread or marked
3159 In the offline mode, cursor is not moved to the messages which are not cached
3161 If there are messages which have target mark @samp{*} in the summary,
3162 cursor is moved to the downward message which have a target mark.
3163 This behavior is changed according to the value of @code{wl-summary-move-order}.
3164 (@code{wl-summary-up})
3168 @findex wl-summary-write
3169 Prepare a new draft.
3170 (@code{wl-summary-write})
3174 @findex wl-summary-write-current-folder
3175 Prepare a new draft. If the current folder is NNTP folder,
3176 @samp{Newsgroups:} field is completed. If the current folder is mailing
3177 list folder (refile destination), guess @samp{To:} field and completed
3178 (If @code{wl-subscribed-mailing-list} is valid list)
3179 (@code{wl-summary-write-current-folder})
3183 @findex wl-summary-redisplay-all-header
3184 Redisplay the message at current cursor point with all header fields.
3185 (@code{wl-summary-redisplay-all-header})
3189 @findex wl-summary-redisplay-no-mime
3190 Redisplay the message at current cursor point without MIME analysis.
3191 (@code{wl-summary-redisplay-no-mime})
3195 @findex wl-summary-burst
3196 If the message at current cursor point has
3197 encapsulates multiple messages using MIME,
3198 de-capsulate and extract them on the current folder.
3199 If it is invoked in non-writable folder or it is called with prefix
3200 argument, it asks the destination folder.
3201 (@code{wl-summary-burst})
3204 @kindex @@ (Summary)
3205 @findex wl-summary-edit-addresses
3206 Append/change/delete the message's sender information to the address
3207 book @file{~/.addresses} interactively. If this command is called with
3208 prefix argument, arbitrary address can be edited.
3209 (@code{wl-summary-edit-petname})
3213 @findex wl-status-update
3214 Sync up address book status with @file{~/.addresses}'s content.
3215 (@code{wl-status-update})
3219 @findex wl-summary-pipe-message
3220 Pipe current message's content to the external process.
3221 (@code{wl-summary-pipe-message})
3225 @findex wl-summary-print-message
3226 Print out current message's content.
3227 It uses @code{ps-print} module in Emacs 20.x.
3228 If you don't use color printer, you might want to set
3229 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3232 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3235 (@code{wl-summary-print-message})
3239 @findex wl-summary-exit
3240 Exit current folder.
3241 (@code{wl-summary-exit})
3245 @findex wl-summary-jump-to-current-message
3246 Jump cursor to the currently displayed message's window.
3247 (@code{wl-summary-jump-to-current-message})
3251 Jump cursor to the other message.
3252 @findex wl-summary-jump-to-msg
3253 (@code{wl-summary-jump-to-msg})
3257 Update summary status and
3258 prefetch all messages which have marks included in the
3259 @code{wl-summary-incorporate-marks}.
3260 @findex wl-summary-incorporate
3261 (@code{wl-summary-incorporate})
3264 @kindex M-j (Summary)
3265 @findex wl-summary-jump-to-msg-by-message-id
3266 Jump cursor to the message which have specified @samp{Message-Id:}. If
3267 @code{elmo-use-database} is non-nil, other folder is also searched.
3268 (@code{wl-summary-jump-to-msg-by-message-id})
3272 Jump to parent message.
3273 @findex wl-summary-jump-to-parent-message
3274 (@code{wl-summary-jump-to-parent-message})
3278 @findex wl-summary-mark-as-unread
3279 Mark as unread the message at current cursor point.
3280 (@code{wl-summary-mark-as-unread})
3284 @findex wl-summary-sync
3285 Synchronize summary view after prompting the update range.
3286 You can specify one of the follows.
3290 all Discard present msgdb and retrieve all informations.
3291 Do not retrieve killed messages.
3292 all-entirely Discard present msgdb and retrieve all informations.
3293 Retrieve killed messages, too.
3294 update Update the difference between informations in present
3295 msgdb and in current folder instance.
3296 Do not retrieve killed messages.
3297 update-entirely Update the difference between informations in present
3298 msgdb and in current folder instance.
3299 Retrieve killed messages, too.
3300 rescan Redisplay summary by rescanning present msgdb.
3301 rescan-noscore Redisplay summary by rescanning present msgdb.
3302 Display messages killed by score, too.
3303 cache-status Sync the all marks with the real status of cache.
3306 first:NUM Move to the filter folder(partial filter).
3307 last:NUM Move to the filter folder(partial filter).
3312 (@code{wl-summary-sync})
3316 @findex wl-summary-sort
3318 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3319 (@code{wl-summary-sort})
3323 @findex wl-summary-toggle-thread
3324 Toggle the threading. The state will be preserved after exiting
3325 Wanderlust. You can alter default state for newly created summary
3326 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3327 Threading status is displayed on the modeline.
3328 @samp{@{S@}} means threading is off (Sequence) and
3329 @samp{@{T@}} means threading is on (Thread).
3330 (@code{wl-summary-toggle-thread})
3334 @findex wl-summary-toggle-disp-folder
3335 Toggle displaying of folder window.
3336 (@code{wl-summary-toggle-disp-folder})
3340 Toggle displaying of message window.
3341 @findex wl-summary-toggle-disp-msg
3342 (@code{wl-summary-toggle-disp-msg})
3346 Move to the virtual folder (filter folder) with the condition specified.
3347 If called with prefix argument and current folder is virtual, exit it.
3348 @findex wl-summary-virtual
3349 (@code{wl-summary-virtual})
3352 @kindex @key{TAB} (Summary)
3353 @findex wl-summary-goto-last-displayed-msg
3354 Jump to the message which is displayed last.
3355 (@code{wl-summary-goto-last-displayed-msg})
3359 Put @samp{*} mark on the messages that satisfies the specified condition.
3360 @findex wl-summary-pick
3361 (@code{wl-summary-pick})
3365 @findex wl-summary-mark-as-read
3366 Mark as read the message at the current cursor point.
3367 (@code{wl-summary-mark-as-read})
3371 Execute action for all temporary marks in the summary buffer.
3372 @findex wl-summary-exec
3373 (@code{wl-summary-exec})
3377 @findex wl-summary-target-mark-line
3378 Put target mark on the message at the current cursor point.
3379 (@code{wl-summary-target-mark-line})
3383 Put refile mark on the message at the current cursor point.
3384 @findex wl-summary-refile
3385 (@code{wl-summary-refile})
3388 @kindex C-o (Summary)
3389 Execute auto refile.
3390 @findex wl-summary-auto-refile
3391 (@code{wl-summary-auto-refile})
3395 Put copy mark on the message at the current cursor point.
3396 @findex wl-summary-copy
3397 (@code{wl-summary-copy})
3400 @kindex M-o (Summary)
3401 Put refile mark on the message at the current cursor point with the destination
3402 previously specified.
3403 @findex wl-summary-refile-prev-destination
3404 (@code{wl-summary-refile-prev-destination})
3408 @findex wl-summary-dispose
3409 Put disposal mark on the message at the current cursor point.
3410 The result of disposal is controlled by @code{wl-dispose-folder-alist},
3411 refiled to @code{wl-trash-folder} by default.
3412 (@code{wl-summary-dispose})
3416 @findex wl-summary-delete
3417 Put force deletion mark on the message at the current cursor point.
3418 (@code{wl-summary-delete})
3422 Put prefetch reservation mark on the message at the current cursor point.
3423 @findex wl-summary-prefetch
3424 (@code{wl-summary-prefetch})
3428 @findex wl-summary-resend
3429 Put resend reservation mark on the message at the current cursor point.
3430 (@code{wl-summary-resend})
3434 @findex wl-summary-unmark
3435 Unmark the temporal mark on the message at the current cursor point.
3436 (@code{wl-summary-unmark})
3440 Unmark all the temporal marks.
3441 @findex wl-summary-unmark-all
3442 (@code{wl-summary-unmark-all})
3445 @kindex r R (Summary)
3446 @findex wl-summary-mark-as-read-region
3447 Mark as read messages in the specified region.
3448 (@code{wl-summary-mark-as-read-region})
3451 @kindex r $ (Summary)
3452 @findex wl-summary-mark-as-important-region
3453 Mark as important @samp{$} messages in the specified region.
3454 If @samp{$} mark already exists, remove the mark.
3455 (@code{wl-summary-mark-as-important-region})
3458 @kindex r ! (Summary)
3459 @findex wl-summary-mark-as-unread-region
3460 Mark as unread messages in the specified region.
3461 (@code{wl-summary-mark-as-unread-region})
3464 @kindex r x (Summary)
3465 @findex wl-summary-exec-region
3466 Execute action for each temporary marks on the messages in the
3468 (@code{wl-summary-exec-region})
3471 @kindex r * (Summary)
3472 @findex wl-summary-target-mark-region
3473 Put target mark on the messages in the specified region.
3474 (@code{wl-summary-target-mark-region})
3477 @kindex r o (Summary)
3478 @findex wl-summary-refile-region
3479 Put refile mark on the messages in the specified region.
3480 (@code{wl-summary-refile-region})
3483 @kindex r O (Summary)
3484 @findex wl-summary-copy-region
3485 Put copy mark on the messages in the specified region.
3486 (@code{wl-summary-copy-region})
3489 @kindex r d (Summary)
3490 @findex wl-summary-dispose-region
3491 Put disposal mark on the messages in the specified region.
3492 (@code{wl-summary-dispose-region})
3495 @kindex r i (Summary)
3496 @findex wl-summary-prefetch-region
3497 Put prefetch reservation mark on messages in the specified region.
3498 (@code{wl-summary-prefetch-region})
3501 @kindex r u (Summary)
3502 @findex wl-summary-unmark-region
3503 Delete temporal mark on the messages in the specified region.
3504 (@code{wl-summary-unmark-region})
3507 @kindex r y (Summary)
3508 Save messages in the specified region.
3509 @findex wl-summary-save-region
3510 (@code{wl-summary-save-region})
3513 @kindex t R (Summary)
3514 @findex wl-thread-mark-as-read
3515 Mark as read 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-read})
3520 @kindex t $ (Summary)
3521 @findex wl-thread-mark-as-important
3522 Put important mark @samp{$} on the messages which are the
3523 descendant of the current thread.
3524 If @samp{$} mark exists, remove the mark.
3525 With prefix argument, it affects on the all messages in the thread tree.
3526 (@code{wl-thread-mark-as-important})
3529 @kindex t ! (Summary)
3530 @findex wl-thread-mark-as-unread
3531 Mark as unread messages which are the descendant of the current thread.
3532 With prefix argument, it affects on the all messages in the thread tree.
3533 (@code{wl-thread-mark-as-unread})
3536 @kindex t x (Summary)
3537 @findex wl-thread-exec
3538 Execute action for temporary marks on the messages which are
3539 the descendant of the current thread. With prefix argument, it affects
3540 on the all messages in the thread tree.
3541 (@code{wl-thread-exec})
3544 @kindex t * (Summary)
3545 @findex wl-thread-target-mark
3546 Put target mark @samp{*} on the messages which are the descendant of the
3547 current thread. With prefix argument, it affects on the all messages in
3549 (@code{wl-thread-target-mark})
3552 @kindex t o (Summary)
3553 @findex wl-thread-refile
3554 Put refile mark on the messages which are the descendant of the current thread.
3555 With prefix argument, it affects on the all messages in the thread tree.
3556 (@code{wl-thread-refile})
3559 @kindex t O (Summary)
3560 @findex wl-thread-copy
3561 Put copy mark on the messages which are the descendant of the current thread.
3562 With prefix argument, it affects on the all messages in the thread tree.
3563 (@code{wl-thread-copy})
3566 @kindex t d (Summary)
3567 @findex wl-thread-dispose
3568 Put disposal mark on the messages which are the descendant of the current thread.
3569 With prefix argument, it affects on the all messages in the thread tree.
3570 (@code{wl-thread-dispose})
3573 @kindex t i (Summary)
3574 @findex wl-thread-prefetch
3575 Put prefetch reservation mark on messages which are the descendant of
3577 (@code{wl-thread-prefetch})
3580 @kindex t u (Summary)
3581 @findex wl-thread-unmark
3582 Unmark temporal mark on the messages which are the descendant of the
3583 current thread. With prefix argument, it affects on the all messages in
3585 (@code{wl-thread-unmark})
3588 @kindex t y (Summary)
3589 @findex wl-thread-save
3590 Save messages which are the descendant of the current thread.
3591 With prefix argument, it affects on the all messages in the thread tree.
3592 (@code{wl-thread-save})
3595 @kindex m R (Summary)
3596 @findex wl-summary-target-mark-mark-as-read
3597 Mark as read all messages which have target mark @samp{*}.
3598 (@code{wl-summary-target-mark-mark-as-read})
3601 @kindex m $ (Summary)
3602 @findex wl-summary-target-mark-mark-as-important
3603 Mark as important all messages which have target mark @samp{*}.
3604 If already marked as @samp{$}, remove the mark.
3605 (@code{wl-summary-target-mark-mark-as-important})
3608 @kindex m ! (Summary)
3609 @findex wl-summary-target-mark-mark-as-unread
3610 Mark as unread all messages which have target mark @samp{*}.
3611 (@code{wl-summary-target-mark-mark-as-unread})
3614 @kindex m o (Summary)
3615 @findex wl-summary-target-mark-refile
3616 Put refile mark on the messages which have target mark @samp{*}.
3617 (@code{wl-summary-target-mark-refile})
3620 @kindex m O (Summary)
3621 @findex wl-summary-target-mark-copy
3622 Put copy mark on the messages which have target mark @samp{*}.
3623 (@code{wl-summary-target-mark-copy})
3626 @kindex m d (Summary)
3627 @findex wl-summary-target-mark-dispose
3628 Put disposal mark on the messages which have target mark @samp{*}.
3629 (@code{wl-summary-target-mark-dispose})
3632 @kindex m i (Summary)
3633 @findex wl-summary-target-mark-prefetch
3634 Put prefetch reservation mark on messages which have target mark @samp{*}.
3635 (@code{wl-summary-target-mark-prefetch})
3638 @kindex m y (Summary)
3639 @findex wl-summary-target-mark-save
3640 Save messages which have target mark @samp{*}.
3641 (@code{wl-summary-target-mark-save})
3644 @kindex m u (Summary)
3645 Unmark all temporal marks.
3646 (@code{wl-summary-delete-all-temp-marks})
3647 @findex wl-summary-delete-all-temp-marks
3650 @kindex m a (Summary)
3651 Put target mark @samp{*} on the all messages.
3652 (@code{wl-summary-target-mark-all})
3653 @findex wl-summary-target-mark-all
3656 @kindex m t (Summary)
3657 Put target mark @samp{*} on the messages in the current thread.
3658 @findex wl-summary-target-mark-thread
3659 (@code{wl-summary-target-mark-thread})
3662 @kindex m r (Summary)
3663 @findex wl-summary-target-mark-region
3664 Put target mark @samp{*} on the messages in the specified region.
3665 (@code{wl-summary-target-mark-region})
3668 @kindex m A (Summary)
3669 @findex wl-summary-target-mark-reply-with-citation
3670 Prepare a draft which cites all messages which have target mark @samp{*}.
3671 (@code{wl-summary-target-mark-reply-with-citation})
3674 @kindex m f (Summary)
3675 @findex wl-summary-target-mark-forward
3676 Prepare a draft which forwards all messages which have target mark @samp{*}.
3677 (@code{wl-summary-target-mark-forward})
3680 @kindex m U (Summary)
3681 @findex wl-summary-target-mark-uudecode
3682 Uudecode the messages which have target mark @samp{*}.
3683 (@code{wl-summary-target-mark-uudecode})
3686 @kindex m ? (Summary)
3687 @findex wl-summary-target-mark-pick
3688 Pick messages from the @samp{*} marked messages.
3689 That is, @samp{*} marks on the messages are remained
3690 if the specified condition is satisfied.
3691 (@code{wl-summary-target-mark-pick})
3694 @kindex m # (Summary)
3695 @findex wl-summary-target-mark-print
3696 Print out all messages which have target mark @samp{*}.
3697 (@code{wl-summary-target-mark-print})
3700 @kindex m | (Summary)
3701 @findex wl-summary-target-mark-pipe
3702 Pipe content of each message with target mark @samp{*} to some specified
3704 (@code{wl-summary-target-mark-pipe})
3707 @kindex M-t (Summary)
3708 @findex wl-toggle-plugged
3709 Toggle offline/online status of Wanderlust.
3710 (@code{wl-toggle-plugged})
3713 @kindex C-t (Summary)
3714 Start Wanderlust's plug-status manager.
3715 (@code{wl-plugged-change})
3718 @kindex C-c C-o (Summary)
3719 @findex wl-jump-to-draft-buffer
3720 Move to the draft buffer if available. If multiple draft buffer exists,
3721 moved to one after another. If prefix argument is specified, load draft
3722 folder's message to the draft buffer and jump to it.
3723 (@code{wl-jump-to-draft-buffer})
3726 @kindex M-w (Summary)
3727 @findex wl-summary-save-current-message
3728 Save the message at the current cursor point.
3729 (@code{wl-summary-save-current-message})
3732 @kindex C-y (Summary)
3733 @findex wl-summary-yank-saved-message
3734 Regard the message at the current cursor point as
3735 parent, connect the message saved by
3736 @code{wl-summary-save-current-message}
3738 (@code{wl-summary-yank-saved-message})
3741 @kindex C-x C-s (Summary)
3742 @findex wl-summary-save-status
3743 Save the current summary.
3744 (@code{wl-summary-save-status})
3748 @node Variables of Summary, , Key Bindings of Summary, Summary
3749 @section Customiziable variables
3752 @item wl-summary-move-order
3753 @vindex wl-summary-move-order
3754 The initial setting is @code{unread}. Specify cursor moving policy. If
3755 you want to precede new messages, set @code{new}. If you want to
3756 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3759 @item wl-auto-select-first
3760 @vindex wl-auto-select-first
3761 The initial setting is @code{nil}.
3762 If non-nil, first message is automatically displayed when you enter
3765 @item wl-auto-select-next
3766 @vindex wl-auto-select-next
3767 The initial setting is @code{nil}. This controls behavior when there is
3768 no unread message in current summary.
3771 nil: asks whether you want to go back to folder mode
3772 'unread: asks whether you want to go to next unread folder
3773 If the next one comes to be possessing no unread message
3774 by treatment of cross-posted messages or Scoring, then
3775 asks whether you want to go to next to next folder.
3776 'skip-no-unread: similar as unread
3777 But does not ask before going to next to next folder.
3778 otherwise: asks whether you want to go to next unread folder
3781 It might be useful to set @code{'skip-no-unread} for people who
3782 want to continue reading by just pressing and pressing space key.
3784 @item wl-thread-insert-opened
3785 @vindex wl-thread-insert-opened
3786 The initial setting is @code{nil}.
3787 If non-nil, thread is inserted as opened.
3789 @item wl-thread-open-reading-thread
3790 @vindex wl-thread-open-reading-thread
3791 The initial setting is @code{t}. If non-nil, reading thread is
3792 automatically opened though it is closed thread.
3794 @item wl-summary-exit-next-move
3795 @vindex wl-summary-exit-next-move
3796 The initial setting is @code{t}. If non-nil, move to next folder at
3799 @item wl-folder-move-cur-folder
3800 @vindex wl-folder-move-cur-folder
3801 The initial setting is @code{nil}. If non-nil, cursor position on the
3804 @item wl-summary-weekday-name-lang
3805 @vindex wl-summary-weekday-name-lang
3806 Specify language of the weekday.
3807 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3808 displays Deutsch. You should rescan summary view after changing this value.
3810 @item wl-summary-fix-timezone
3811 @vindex wl-summary-fix-timezone
3812 The initial setting is @code{nil}.
3813 Time zone of the date string in summary mode is adjusted using this value.
3814 If @code{nil}, it is adjust to the default time zone information
3815 (system's default time zone or environment variable @samp{TZ}).
3817 @item wl-use-petname
3818 @vindex wl-use-petname
3819 The initial setting is @code{t}.
3820 If non-nil, sender part displays nickname.
3822 @item wl-break-pages
3823 @vindex wl-break-pages
3824 The initial setting is @code{t}.
3825 If non-nil, message is split as pages by @samp{^L}.
3827 @item wl-message-window-size
3828 @vindex wl-message-window-size
3829 The initial setting is '(1 . 4).
3830 A cons cell to specify the rate of summary and message window.
3831 car:cdr corresponds summary:message.
3833 @item wl-summary-from-function
3834 @vindex wl-summary-from-function
3835 Format function to display sender in summary.
3836 The initial setting is @code{wl-summary-default-from}.
3838 @item wl-summary-no-from-message
3839 @vindex wl-summary-no-from-message
3840 The initial setting is @samp{nobody@@nowhere?}. A string which is
3841 displayed when there's no @samp{From:} field in the message.
3843 @item wl-summary-subject-function
3844 @vindex wl-summary-subject-function
3845 Format function to display subject in summary.
3846 The initial setting is @code{wl-summary-default-subject} and
3847 it will cut the list name part etc. on the top of the subject.
3848 To display subject as it is, set as follows.
3851 (setq wl-summary-subject-function 'identity)
3854 @item wl-summary-no-subject-message
3855 @vindex wl-summary-no-subject-message
3856 The initial setting is @samp{(WL:No Subject in original.)}. A string
3857 which is displayed when there's no @samp{Subject:} field in the message.
3859 @item wl-summary-default-view
3860 @vindex wl-summary-default-view
3861 The initial setting is @code{'thread}.
3862 The default state for newly created summary. You can set either
3863 @code{'thread} for thread view or @code{'sequence} for sequential view.
3865 @item wl-summary-use-frame
3866 @vindex wl-summary-use-frame
3867 The initial setting is @code{nil}.
3868 If non-nil, use new frame for the summary.
3870 @item wl-use-folder-petname
3871 @vindex wl-use-folder-petname
3872 The initial setting is the list shown below:
3881 A list of display policy (symbol) of folder nickname. Available symbols
3886 Display folder petname on modeline.
3888 Destination folder is notified as nickname if
3889 @code{wl-auto-select-next} is non-nil.
3891 You can input folder name by nickname in the function
3892 @code{wl-summary-read-folder}.
3895 @item wl-summary-move-direction-toggle
3896 @vindex wl-summary-move-direction-toggle
3897 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3898 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3899 want to aware of reading direction, set this to @code{t}.
3901 @item wl-summary-width
3902 @vindex wl-summary-width
3903 The initial setting is 80.
3904 Width of summary line. If @code{nil}, summary line's width is as is.
3906 @item wl-summary-print-argument-within-window
3907 @vindex wl-summary-print-argument-within-window
3908 The initial setting is @code{nil}.
3909 If non-nil, the action argument is always printed on right side of
3912 @item wl-summary-from-width
3913 @vindex wl-summary-from-width
3914 The initial setting is 17.
3915 Width of sender part of summary line.
3917 @item wl-summary-indent-length-limit
3918 @vindex wl-summary-indent-length-limit
3919 The initial setting is 46.
3920 Specify the limit of thread indent level. @code{nil} means unlimited
3922 If you set this to @code{nil} you should set @code{wl-summary-width}
3925 @item wl-summary-max-thread-depth
3926 @vindex wl-summary-max-thread-depth
3927 The initial setting is 15.
3928 If thread depth of the message is larger than this value,
3929 the thread is divided.
3931 @item wl-summary-recenter
3932 @vindex wl-summary-recenter
3933 The initial setting is t.
3934 If non-nil, cursor point is moved to the center of the summary window.
3936 @item wl-summary-divide-thread-when-subject-changed
3937 @vindex wl-summary-divide-thread-when-subject-changed
3938 The initial setting is @code{nil}. If non-nil, thread is split if
3939 the subject is changed.
3941 @item wl-summary-search-via-nntp
3942 @vindex wl-summary-search-via-nntp
3943 The initial setting is @code{confirm}.
3945 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3946 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3947 from the NNTP server @code{elmo-nntp-default-server}. The value of
3948 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3949 @code{elmo-nntp-default-stream-type} are used.
3951 If @code{confirm}, server name can be specified. You can specify NNTP
3952 folder format like @samp{-:username@@servername:119!}.
3954 @item wl-summary-keep-cursor-command
3955 @vindex wl-summary-keep-cursor-command
3956 The initial setting is the list shown below:
3960 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3965 When you entered to summary by these commands and the target summary
3966 buffer already exists, summary status is not automatically updated and
3967 cursor position is saved.
3969 @item elmo-folder-update-threshold
3970 @vindex elmo-folder-update-threshold
3971 The initial setting is 500. If updated message number is larger than
3972 this value, confirm whether drop them or not (in the case where the value
3973 of @code{elmo-folder-update-confirm} is non-nil).
3975 @item elmo-folder-update-confirm
3976 @vindex elmo-folder-update-confirm
3977 The initial setting is @code{t}. If the value is non-nil, do check with
3978 @code{elmo-folder-update-threshold}.
3980 @item wl-summary-always-sticky-folder-list
3981 @vindex wl-summary-always-sticky-folder-list
3982 The initial setting is @code{nil}.
3983 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3984 are automatically stuck. Each element is regexp of folder name.
3986 @item wl-summary-reserve-mark-list
3987 @vindex wl-summary-reserve-mark-list
3988 The initial setting is the list shown below:
3997 If a message is already marked as temporal marks in this list, the
3998 message is not marked by any mark command.
4000 @item wl-summary-skip-mark-list
4001 @vindex wl-summary-skip-mark-list
4002 The initial setting is the list shown below:
4011 If a message is already marked as temporal marks in this list, the
4012 message is skipped at cursor move.
4014 @item elmo-message-fetch-threshold
4015 @vindex elmo-message-fetch-threshold
4016 The initial setting is 30000 (bytes). If displaying message has larger
4017 size than this value, Wanderlust confirms whether fetch the message or
4018 not (in the case where the value of @code{elmo-message-fetch-confirm}
4021 @item elmo-message-fetch-confirm
4022 @vindex elmo-message-fetch-confirm
4023 The initial setting is @code{t}. If the value is non-nil, do check with
4024 @code{elmo-message-fetch-threshold}.
4026 @item wl-prefetch-threshold
4027 @vindex wl-prefetch-threshold
4028 The initial setting is 30000 (bytes). If prefetching message has larger
4029 size than this value and @code{wl-prefetch-confirm} is non-nil,
4030 Wanderlust confirms whether prefetch the message or not. If
4031 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
4032 without confirmation.
4034 @item wl-prefetch-confirm
4035 @vindex wl-prefetch-confirm
4036 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4037 prefetch the message or not if the message has larger size than
4038 @code{wl-prefetch-threshold}.
4040 @item elmo-imap4-use-cache
4041 @vindex elmo-imap4-use-cache
4042 The initial setting is @code{t}. If non-nil, messages read via IMAP4
4045 @item elmo-nntp-use-cache
4046 @vindex elmo-nntp-use-cache
4047 The initial setting is @code{t}. If non-nil, messages read via NNTP are
4050 @item elmo-pop3-use-cache
4051 @vindex elmo-pop3-use-cache
4052 The initial setting is @code{t}. If non-nil, messages read via POP3 are
4055 @item elmo-shimbun-use-cache
4056 @vindex elmo-shimbun-use-cache
4057 The initial setting is @code{t}. If non-nil, messages read in Shimbun
4060 @item wl-folder-process-duplicates-alist
4061 @vindex wl-folder-process-duplicates-alist
4062 The initial setting is @code{nil}.
4063 This list determines how to deal with duplicated messages in the same folder.
4064 Each item in the list is regexp of folder name and action; you can specify any
4065 one of the following in the place of action:
4068 @code{nil} : do nothing for duplicated messages.
4069 @code{hide} : hide duplicated messages from the summary.
4070 @code{read} : set duplicated messages as read.
4074 Following is an example (hide duplicated messages in multi folders)
4078 (setq wl-folder-process-duplicates-alist
4079 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4080 ("^\\*.*" . hide) (".*" . read)))
4086 @node Message, Draft, Summary, Top
4087 @chapter Message Buffer
4089 Message Buffers utilize MIME-View mode of SEMI. For operational
4090 procedures and key bindings, refer to respective documents.
4091 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4092 You can also see help by @kbd{?} in message buffer.
4094 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4095 brings you back to Summary mode. @kbd{l} toggles display of Summary
4098 @section Key Bindings
4104 @findex wl-message-toggle-disp-summary
4105 Toggles display of Summary buffer.
4106 (@code{wl-message-toggle-disp-summary})
4109 @findex wl-message-refer-article-or-url
4110 @kindex Button-2 (Message)
4111 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4112 corresponding message if found.
4113 (@code{wl-message-refer-article-or-url})
4115 @item Button-4 (upward movement of a wheel)
4116 @kindex Button-4 (Message)
4117 @findex wl-message-wheel-down
4118 Scrolls the message backwards. When the top of the message is hit,
4119 moves to the previous message.
4120 (@code{wl-message-wheel-down})
4122 @item Button-5 (downward movement of a wheel)
4123 @kindex Button-5 (Message)
4124 @findex wl-message-wheel-up
4125 Scrolls the message forward. When the bottom of the message is hit,
4126 moves to the next message.
4127 (@code{wl-message-wheel-up})
4131 @findex wl-message-delete-current-part
4132 Delete the part under cursor. In fact it appends modified message to
4133 the current folder then moves old one to trash folder. Therefore the
4134 message number will be changed.
4135 (@code{wl-message-delete-current-part})
4138 @section Customizable Variables
4141 @item wl-message-window-size
4142 @vindex wl-message-window-size
4143 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4144 its car and cdr value corresponds to the ratio of Summary and Message
4147 @item wl-message-ignored-field-list
4148 @vindex wl-message-ignored-field-list
4149 (SEMI only) Initial setting is @code{nil}.
4150 All fields that match this list will be hidden in message buffer.
4151 Each elements are regexp of field-name.
4152 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4154 @item wl-message-visible-field-list
4155 @vindex wl-message-visible-field-list
4156 (SEMI only) Initial setting is @code{nil}.
4157 All fields that match this list will be display in message buffer.
4158 Each elements are regexp of field-name. This value precedes
4159 @code{wl-message-ignored-field-list}.
4160 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4162 @item wl-message-sort-field-list
4163 @vindex wl-message-sort-field-list
4164 (SEMI only) Initial setting is
4165 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4166 Header fields in message buffer are ordered by this value.
4167 Each elements are regexp of field-name.
4169 @item wl-message-truncate-lines
4170 @vindex wl-message-truncate-lines
4171 The initial value is the value of @code{default-truncate-lines}.
4172 If it is non-nil, truncate long lines in message buffer.
4175 @node Draft, Disconnected Operations, Message, Top
4176 @chapter Draft Buffer
4178 At Summary mode, pressing @kbd{w} and the like creates a new draft
4179 buffer. You can edit and send mail and news articles in this buffer.
4181 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4182 with those if possible.
4185 * Usage of Draft Mode:: TIPS
4186 * Key Bindings of Draft:: Key bindings
4187 * Variables of Draft Mode:: Customize Draft Mode
4190 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4193 Basically it is Emacs-standard mail mode.
4197 * Editing Message Body::
4198 * Dynamical Message Re-arrangement::
4203 @node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
4204 @subsection Editing Message Header
4206 You can freely edit header region above @samp{--text follows this line--},
4207 until you invoke the sending operation.
4209 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4210 addresses. @kbd{@key{TAB}} completes them.
4212 You can use following headers to specify recipients. Add some of them
4213 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4216 @item @samp{Newsgroups:}
4217 Specify newsgroups to which you post the news article.
4220 Specify addresses to send a copy (Carbon Copy) of the message.
4223 Following ones are removed from the header contents before sending.
4227 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4230 Specify folders in which a copy of the message is saved.
4233 Specify recipients to send encapsulated copy of the message.
4236 You can add initial headers by following variables.
4242 The initial setting is @code{nil}.
4243 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4244 the draft when it is prepared. If function is specified, its return
4249 The initial setting is @code{nil}.
4250 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4251 the draft when it is prepared.
4254 @node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4255 @subsection Editing Messages
4257 As a matter of course, editing message body can be performed in the same
4258 way as usual writing. You may write message body under
4259 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4260 @samp{--text follows this line--} intact.)
4262 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4263 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4264 a MIME user interface for GNU Emacs}.
4265 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4267 If you save the draft buffer you are editing, it is appended to the
4268 folder specified by @code{wl-draft-folder}.
4270 @node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
4271 @subsection Dynamic Modification of Messages
4272 @vindex wl-draft-config-alist
4273 @c @cindex Change Message
4274 @c @cindex Message, Change Dynamic
4276 You can set @code{wl-draft-config-alist} so that header and body of the
4277 message will automatically modified depending on information of header
4280 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4282 In the example below, the header is modified when
4283 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4284 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4285 before sending the message.
4289 (setq wl-draft-config-alist
4290 '(((string-match "aaa\\.example\\.com$" (system-name))
4291 ;; @r{applied if the expression is non-nil}
4292 (wl-smtp-posting-server . "mailserver-B")
4293 (wl-nntp-posting-server . "newsserver-B")
4294 ;; @r{settings of temporary variables}
4296 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4297 ;; @r{applied if it matches the header of the draft buffer}
4298 ("Organization" . (format "Go %s" my-webpage)))
4299 ;; @r{you can write elisp expressions here (eval only)}
4300 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4301 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4306 The format of @code{wl-draft-config-alist} is:
4310 '(("@var{regexp of the header}" or @var{elisp expression}
4311 ("@var{Field}" . value(@var{elisp expression}))
4312 (@var{variable} . value(@var{elisp expression}))
4313 (@var{sub-function} . value(@var{elisp expression}))
4316 ("@var{regexp of the header}" or @var{elisp expression}
4317 ("@var{Field}" . value(@var{elisp expression}))
4322 Per default, there are 13 following sub-functions.
4325 'header: Inserts the specified string at the bottom of the header.
4326 'header-top: Inserts the specified string at the top of the header.
4327 'header-file: Inserts the specified file at the bottom of the header.
4328 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4329 'top: Inserts the specified string at the top of the body.
4330 'top-file: Inserts the specified file at the top of the body.
4331 'body: Replaces the body with the specified string.
4332 Specifying @code{nil} deletes the entire body string.
4333 'body-file: Replaces the body with the content of the specified file.
4334 'bottom: Inserts the specified string at the bottom of the body.
4335 'bottom-file: Inserts the specified file at the top of the body.
4336 'part-top: Inserts the specified string at the top of the current part.
4337 'part-bottom: Inserts the specified string at the bottom of the current part.
4338 'template: Applies the specified template.
4339 (refer to the next subsection)
4342 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4343 change them or add your own functions. If you read the code, you can
4344 easily find how to write the functions.
4346 At the first of each item, @var{a regular expression of the header} or
4347 an @var{elisp expression} should be specified. In the case of an elisp
4348 expression, the item is applied when the expression is evaluated
4351 Per default, when multiple items match or are evaluated non-nil, all
4352 such items are applied, but if you set a variable
4353 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4356 At the second of the item, a cons or a list of functions should be
4357 specified. The car part of the cons should be a header field, a
4358 variable, or a sub-function. When a header field is specified, the
4359 field will be modified. If a variable is specified, the value of the
4360 variable will be modified temporarily.
4362 In the cdr part of a cons, not only a variable but also an elisp
4363 expression can be specified as is. If the car part is a header field
4364 and the cdr part is @code{nil}, the field will be deleted.
4366 See the next example as well:
4370 (setq wl-draft-config-alist
4372 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4373 ;; @r{applied if it matches the header of the buffer being replied}
4374 (body . " Hello.\n")
4375 (template . "default")
4380 As in the (1) above, if a header regexp is prepended with @code{reply},
4381 it is applied when the draft is prepared by @code{wl-summary-reply} for
4382 example, and when it matches the header being replied. It is ignored
4383 when there is no buffer being replied, like after @code{wl-draft} was
4386 If you want to use name of parent folder, you can refer the buffer local
4387 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4388 changes From according to the folder name of the summary in which the draft
4393 (setq wl-draft-config-alist
4394 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4395 (\"From\" . \"user@@domain1\"))
4396 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4397 (\"From\" . \"user@@domain2\"))))
4402 Note that @code{wl-draft-config-alist} is applied only once when
4403 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4404 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4405 aborting transmission, execute @kbd{C-c C-e}
4406 (@code{wl-draft-config-exec}) explicitly.
4408 If you don't want to apply @code{wl-draft-config-alist} when
4409 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4413 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4416 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4417 prepared, do the following:
4420 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4423 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4424 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4428 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4431 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4432 @subsection Inserting Templates
4434 @cindex Apply Template
4436 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4437 @kbd{M-x wl-template-select} in the draft buffer.
4439 The format of @code{wl-template-alist} is almost the same as
4440 @code{wl-draft-config-alist}.
4444 (setq wl-template-alist
4447 ("Organization" . "Example Co.Ltd.")
4448 (body . "Hello.\n"))
4450 (template . "default") ;; @r{(a)}
4451 ("To" . "boss@@example.com")
4452 ("Subject" . "Report")
4453 (body-file . "~/work/report.txt")
4459 As you can see, the only difference is item (template) names such as
4460 @samp{default} and @samp{report}, instead of a regexp of header.
4461 Because definition of each item is the same as
4462 @code{wl-draft-config-alist}, you can call another template, like (a).
4464 Executing the command @code{wl-template-select} results in template
4465 selection, but the result differs depending on variable
4466 @code{wl-template-visible-select}.
4468 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4469 window is shown below the draft buffer. You can select a template by
4470 @kbd{n} and @kbd{p} seeing the buffer window.
4472 Press the @key{RET} key and the template is actually applied to the draft
4473 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4474 adjust the window size by @code{wl-template-buffer-lines}.
4476 If @code{wl-template-visible-select} is @code{nil}, you should type the
4477 name of the template in the mini buffer.
4479 As shown in the example in @code{wl-draft-config-alist}, you can select
4480 @samp{default} template by writing:
4483 (template . "default")
4486 @node POP-before-SMTP, , Template, Usage of Draft Mode
4487 @subsection Sending mail by POP-before-SMTP
4488 @cindex POP-before-SMTP
4490 You can send mail by POP-before-SMTP with this single line:
4493 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4497 Configure the following variables if you need.
4500 @item wl-pop-before-smtp-user
4501 The POP user name for POP-before-SMTP authentication.
4502 If unset, @code{elmo-pop3-default-user} is used.
4504 @item wl-pop-before-smtp-server
4505 The POP server name for POP-before-SMTP authentication.
4506 If unset, @code{elmo-pop3-default-server} is used.
4508 @item wl-pop-before-smtp-authenticate-type
4509 The POP authentication method for POP-before-SMTP authentication.
4510 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4512 @item wl-pop-before-smtp-port
4513 The POP port number for POP-before-SMTP authentication.
4514 If unset, @code{elmo-pop3-default-port} is used.
4516 @item wl-pop-before-smtp-stream-type
4517 If non-nil, POP connection is established using SSL. If
4518 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4519 unset, @code{elmo-pop3-default-stream-type} is used.
4522 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4523 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4525 Therefore, if SMTP server and POP server are actually the same, and if
4526 POP folder per default (such as @samp{&}) is available, no settings are
4529 Refer to the following URL about POP-before-SMTP.
4533 http://spam.ayamura.org/tools/smPbS.html
4534 http://www.iecc.com/pop-before-smtp.html
4539 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4540 @section Key Bindings
4541 @cindex Keybind, Draft Mode
4542 @cindex Keybind, Draft Buffer
4547 @kindex C-c C-y (Draft)
4548 @findex wl-draft-yank-original
4549 Cites the content of the current message buffer (the part under cursor).
4550 If the region is active, cites the region (it affects only if
4551 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4552 (on XEmacs) is Non-nil).
4553 (@code{wl-draft-yank-original})
4556 @kindex C-c C-p (Draft)
4557 @findex wl-draft-preview-message
4558 Previews the content of the current draft.
4559 This is useful for previewing MIME multi-part messages.
4560 (@code{wl-draft-preview-message})
4563 @kindex C-c C-s (Draft)
4564 @findex wl-draft-send
4565 Sends the content of the current draft. Does not erase the draft buffer.
4566 This is useful for sending multiple messages, which are a little different
4568 (@code{wl-draft-send})
4571 @kindex C-c C-c (Draft)
4572 @findex wl-draft-send-and-exit
4573 Sends the content of the current draft and erases the draft buffer.
4574 (@code{wl-draft-send-and-exit})
4577 @kindex C-x C-s (Draft)
4578 @findex wl-draft-save
4579 Save the current draft.
4580 (@code{wl-draft-save})
4583 @kindex C-c C-k (Draft)
4584 @findex wl-draft-kill
4585 Kills the current draft.
4586 (@code{wl-draft-kill})
4589 @kindex C-x k (Draft)
4590 @findex wl-draft-mimic-kill-buffer
4591 Kills the current draft.
4592 (@code{wl-draft-mimic-kill-buffer})
4595 @kindex C-c C-z (Draft)
4596 @findex wl-draft-save-and-exit
4597 Saves the current draft, and erases the draft buffer.
4598 This is useful if you want to suspend editing of the draft.
4599 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4600 the @samp{+draft} folder.
4601 (@code{wl-draft-save-and-exit})
4604 @kindex C-c C-r (Draft)
4605 @findex wl-caesar-region
4606 Encodes or decodes the specified region in Caesar cipher.
4607 (@code{wl-caesar-region})
4611 @findex wl-draft-highlight-and-recenter
4612 Recenter and rehighlight current draft.
4613 (@code{wl-draft-highlight-and-recenter})
4617 @findex wl-toggle-plugged
4618 Toggles off-line/on-line states of Wanderlust.
4619 (@code{wl-toggle-plugged})
4622 @kindex C-c C-o (Draft)
4623 @findex wl-jump-to-draft-buffer
4624 Jumps to the other draft buffer, if exists.
4625 With prefix argument, reads a file (if any) from the draft folder when
4626 there is no such buffer.
4627 (@code{wl-jump-to-draft-buffer})
4630 @kindex C-c C-e (Draft)
4631 @findex wl-draft-config-exec
4632 Applies @code{wl-draft-config-alist}.
4633 (@code{wl-draft-config-exec})
4636 @kindex C-c C-j (Draft)
4637 @findex wl-template-select
4639 (@code{wl-template-select})
4642 @kindex C-c C-a (Draft)
4644 Enter Address Manager.
4645 @xref{Address Manager}.
4649 @kindex C-c C-d (Draft)
4650 @findex wl-draft-elide-region
4651 Elide the text between point and mark (@code{wl-draft-elide-region}).
4652 The text is killed and replaced with the contents of the variable
4653 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4657 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4658 @section Customizable Variables
4661 @item wl-subscribed-mailing-list
4662 @vindex wl-subscribed-mailing-list
4663 The initial setting is @code{nil}. Mailing lists to which you
4664 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4665 field of a reply draft, removes your own address from
4666 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4667 contained in @samp{To:} or @samp{Cc:} field of a message to be
4668 automatically re-filed, the destination folder will be leaned in
4669 connection with the address.
4675 (setq wl-subscribed-mailing-list
4676 '("wl@@lists.airs.net"
4678 "emacs-mime-ja@@m17n.org"))
4682 @item wl-insert-mail-followup-to
4683 @vindex wl-insert-mail-followup-to
4684 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4685 field is automatically inserted in the draft buffer.
4687 @item wl-insert-mail-reply-to
4688 @vindex wl-insert-mail-reply-to
4689 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4690 field is automatically inserted in the draft buffer.
4692 @item wl-auto-insert-x-face
4693 @vindex wl-auto-insert-x-face
4694 The initial setting is @code{t}. If non-nil and there is an encoded
4695 X-Face string in a file @file{~/.xface} (the value of the variable
4696 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4697 draft buffer. If @code{nil}, it is not automatically inserted.
4699 @item wl-insert-message-id
4700 @vindex wl-insert-message-id
4701 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4702 is automatically inserted on the transmission.
4704 @item wl-message-id-use-wl-from
4705 @vindex wl-message-id-use-wl-from
4706 The initial setting is @code{nil}. If non-nil, the value of
4707 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4709 @item wl-local-domain
4710 @vindex wl-local-domain
4711 The initial setting is @code{nil}. If @code{nil}, the return value of
4712 the function @code{system-name} will be used as the domain part of
4715 If @code{system-name} does not return FQDN (i.e. the full name of the
4716 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4717 to the string of the local domain name without hostname (like
4718 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4719 @samp{.} @code{wl-local-domain} is used as domain part of the
4722 If your terminal does not have global IP, set the value of
4723 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4724 you use invalid @samp{Message-ID:}.)
4726 Moreover, concatenation of @code{system-name} @samp{.}
4727 @code{wl-local-domain} will be used as an argument to the HELO command
4730 @item wl-message-id-domain
4731 @vindex wl-message-id-domain
4732 The initial setting is @code{nil}. If non-nil, this value is used as a
4733 domain part of the @samp{Message-ID:}. If your terminal does not have
4734 global IP address, set unique string to this value (e.x. your e-mail
4737 @item wl-unique-id-suffix
4738 @vindex wl-unique-id-suffix
4739 The initial setting is @samp{.wl}. You can specify the string in generated
4740 Message-ID which appear just before @samp{@@}.
4742 @item wl-draft-config-alist
4743 @vindex wl-draft-config-alist
4744 The initial setting is @code{nil}. Modifies the draft message just
4745 before the transmission. The content of @code{wl-draft-config-alist}
4746 will be automatically applied only once on the transmission. If you
4747 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4750 @item wl-template-alist
4751 @vindex wl-template-alist
4752 The initial setting is @code{nil}.
4753 This variable specifies the template to be applied in the draft buffer.
4755 @item wl-draft-config-matchone
4756 @vindex wl-draft-config-matchone
4757 The initial setting is @code{nil}. If non-nil, only the first matching
4758 item is used when @code{wl-draft-config-alist} is applied. If
4759 @code{nil}, all matching items are used.
4761 @item wl-template-visible-select
4762 @vindex wl-template-visible-select
4763 The initial setting is @code{t}.
4764 If non-nil, you can preview the result of the template selection in
4767 @item wl-template-confirm
4768 @vindex wl-template-confirm
4769 The initial setting is @code{nil}.
4770 If non-nil, asks for confirmation when you press the enter key to select
4771 template while previewing.
4773 @item wl-template-buffer-lines
4774 @vindex wl-template-buffer-lines
4775 The initial setting is 7.
4776 If @code{wl-template-visible-select} is non-nil, this variable specifies
4777 the size of the preview window.
4779 @item wl-draft-buffer-style
4780 @vindex wl-draft-buffer-style
4781 The initial setting is @code{full}.
4782 Style of draft buffer window (except for replying and forwarding).
4783 @code{keep} is to use current window,
4784 @code{full} is to use full frame window,
4785 @code{split} is to split current window and use it.
4786 If some function is specified, it is called with the draft buffer
4789 @item wl-draft-reply-buffer-style
4790 @vindex wl-draft-reply-buffer-style
4791 The initial setting is @code{split}.
4792 Style of draft buffer for replying and forwarding.
4793 @code{keep} is to use message buffer window,
4794 @code{full} is to use full frame window,
4795 @code{split} is to split message buffer window and use it.
4796 If some function is specified, it is called with the draft buffer
4799 @item wl-draft-use-frame
4800 @vindex wl-draft-use-frame
4801 The initial setting is @code{nil}.
4802 If non-nil, use new frame for the draft.
4804 @item wl-draft-truncate-lines
4805 @vindex wl-draft-truncate-lines
4806 The initial value is the value of @code{default-truncate-lines}.
4807 If it is non-nil, truncate long lines in draft buffer.
4811 The initial setting is the value of the variable
4812 @code{user-mail-address}. The value of this variable is inserted as a
4813 @samp{From:} field of the draft when it is prepared.
4815 @item wl-envelope-from
4816 @vindex wl-envelope-from
4817 The initial setting is @code{nil}.
4818 The value of this variable is used for envelope from (MAIL FROM).
4819 If @code{nil}, the address part of @code{wl-from} is used.
4821 @item wl-user-mail-address-list
4822 @vindex wl-user-mail-address-list
4823 The initial setting is @code{nil}.
4824 This is the User's address list. If you have multiple addresses,
4827 @item wl-reply-subject-prefix
4828 @vindex wl-reply-subject-prefix
4829 The initial setting is @samp{Re: }.
4830 In the @samp{Subject:} of the reply draft, this string is prepended to
4831 the @samp{Subject:} of being replied.
4833 @item wl-forward-subject-prefix
4834 @vindex wl-forward-subject-prefix
4835 The initial setting is @samp{Forward: }.
4836 In the @samp{Subject:} of the forwarding draft, this string is prepended
4837 to the @samp{Subject:} of being forwarded.
4839 @item wl-draft-reply-use-address-with-full-name
4840 @vindex wl-draft-reply-use-address-with-full-name
4841 The initial setting is @code{t}.
4842 If non-nil, insert her full name with address when prepare a draft for
4843 reply a message. If it is @code{nil}, insert her address only.
4845 @item wl-draft-enable-queuing
4846 @vindex wl-draft-enable-queuing
4847 The initial setting is @code{t}.
4848 This flag controls off-line transmission. If non-nil, the draft is
4851 @item wl-draft-use-cache
4852 @vindex wl-draft-use-cache
4853 The initial setting is @code{nil}. If the value is non-nil and
4854 @code{wl-insert-message-id} is nil, cache the message which is sent.
4856 @item wl-fcc-force-as-read
4857 @vindex wl-fcc-force-as-read
4858 The initial setting is @code{nil}. If the value is non-nil,
4859 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4861 @item wl-auto-flush-queue
4862 @vindex wl-auto-flush-queue
4863 The initial setting is t.
4864 This flag controls automatic transmission of the queue when Wanderlust
4865 becomes on-line. If non-nil, the queue is automatically transmitted
4866 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4867 manually, press @kbd{F} in the folder mode.
4869 @item wl-ignored-forwarded-headers
4870 @vindex wl-ignored-forwarded-headers
4871 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4872 All headers that match this regexp will be deleted when forwarding a message.
4874 @item wl-ignored-resent-headers
4875 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4876 All headers that match this regexp will be deleted when resending a message.
4878 @item wl-draft-always-delete-myself
4879 @vindex wl-draft-always-delete-myself
4880 If non-nil, always removes your own address from @samp{To:} and
4881 @samp{Cc:} when you are replying to the mail addressed to you.
4883 @item wl-draft-delete-myself-from-bcc-fcc
4884 @vindex wl-draft-delete-myself-from-bcc-fcc
4885 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4886 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
4888 @item wl-smtp-posting-server
4889 @vindex wl-smtp-posting-server
4890 The initial setting is @code{nil}.
4891 This is the SMTP server name for mail transmission.
4893 @item wl-smtp-posting-port
4894 @vindex wl-smtp-posting-port
4895 The initial setting is @code{nil}.
4896 This is the SMTP port number for mail transmission.
4897 If @code{nil}, default SMTP port number (25) is used.
4899 @item wl-smtp-posting-user
4900 @vindex wl-smtp-posting-user
4901 The initial setting is @code{nil}.
4902 This is the user name for SMTP AUTH authentication. If @code{nil},
4903 @code{smtp-authenticate-user} is used.
4905 @item wl-smtp-authenticate-type
4906 @vindex wl-smtp-authenticate-type
4907 The initial setting is @code{nil}.
4908 This is the authentication method for SMTP AUTH authentication. If
4909 @code{nil}, @code{smtp-authenticate-type} is used. If
4910 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4913 @item wl-smtp-connection-type
4914 @vindex wl-smtp-connection-type
4915 The initial setting is @code{nil}.
4916 This variable specifies how to establish SMTP connections.
4917 If @code{nil}, @code{smtp-connection-type} is used.
4918 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4920 @item wl-nntp-posting-server
4921 @vindex wl-nntp-posting-server
4922 The initial setting is @code{nil}.
4923 This is the NNTP server name used for news submission.
4924 If @code{nil}, @code{elmo-nntp-default-server} is used.
4926 @item wl-nntp-posting-user
4927 @vindex wl-nntp-posting-user
4928 The initial setting is @code{nil}.
4929 This is the user name for AUTHINFO authentication on news submission.
4930 If @code{nil}, @code{elmo-nntp-default-user} is used.
4931 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4933 @item wl-nntp-posting-port
4934 @vindex wl-nntp-posting-port
4935 The initial setting is @code{nil}.
4936 This is the port number of the NNTP server used for news submission.
4937 If @code{nil}, @code{elmo-nntp-default-server} is used.
4939 @item wl-nntp-posting-stream-type
4940 @vindex wl-nntp-posting-stream-type
4941 The initial setting is @code{nil}.
4942 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4943 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4944 connection will be established.
4946 @item wl-nntp-posting-function
4947 @vindex wl-nntp-posting-function
4948 The initial setting is @code{elmo-nntp-post}.
4949 This is the function to post NNTP message.
4951 @item wl-nntp-posting-config-alist
4952 @vindex wl-nntp-posting-config-alist
4953 The initial setting is @code{nil}.
4954 The value takes an alist to define NNTP server like following example.
4955 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
4959 (setq wl-nntp-posting-config-alist
4960 '((",?gmane\\." . "news.gmane.org")
4962 ((server . "news-server")
4963 (user . "newsmaster")
4965 (function . elmo-nntp-post)))
4966 (".*" . "default-news-server")))
4970 @item wl-pop-before-smtp-user
4971 @vindex wl-pop-before-smtp-user
4972 The initial setting is @code{nil}.
4973 This is the POP user name for POP-before-SMTP.
4974 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4976 @item wl-pop-before-smtp-server
4977 @vindex wl-pop-before-smtp-server
4978 The initial setting is @code{nil}.
4979 This is the POP server name for POP-before-SMTP.
4980 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4982 @item wl-pop-before-smtp-authenticate-type
4983 @vindex wl-pop-before-smtp-authenticate-type
4984 The initial setting is @code{nil}.
4985 This is the authentication method for POP-before-SMTP authentication.
4986 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4988 @item wl-pop-before-smtp-port
4989 @vindex wl-pop-before-smtp-port
4990 The initial setting is @code{nil}.
4991 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4992 @code{elmo-pop3-default-port} is used.
4994 @item wl-pop-before-smtp-stream-type
4995 @vindex wl-pop-before-smtp-stream-type
4996 The initial setting is @code{nil}.
4997 This flag controls the use of SSL for POP-before-SMTP. If it is
4998 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4999 STARTTLS (RFC2595) connection will be established.
5001 @item wl-draft-queue-save-variables
5002 @vindex wl-draft-queue-save-variables
5003 Specifies a list of variable to which queued messages are saved on the
5004 off-line transmission.
5006 @item wl-draft-sendlog
5007 @vindex wl-draft-sendlog
5008 The initial setting is @code{t}.
5009 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
5013 @item drafts are sent by smtp or qmail
5014 @item saved into folders by fcc
5015 @item saved into folders by queuing
5018 (it is written even if the transmission fails).
5019 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
5020 and left to the logging function of @command{imput}.
5023 @item wl-draft-sendlog-max-size
5024 @vindex wl-draft-sendlog-max-size
5025 The initial setting is 20000 (in bytes).
5026 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
5027 beyond the size specified by this variable.
5031 The initial setting is @code{nil}.
5032 If non-nil, address completion uses LDAP.
5034 @item wl-ldap-server
5035 @vindex wl-ldap-server
5036 The initial setting is @samp{localhost}.
5037 LDAP server name for address completion.
5040 @vindex wl-ldap-port
5041 The initial setting is @code{nil}.
5042 If non-nil, the value is used as port number.
5045 @vindex wl-ldap-base
5046 The initial setting is @samp{c=US}.
5047 LDAP search starting point (base) for address completion.
5049 @item wl-draft-remove-group-list-contents
5050 @vindex wl-draft-remove-group-list-contents
5051 The initial setting is @code{t}.
5052 If non-nil, remove the group-lists' members in the recipients when
5053 sending the message (group-list means the description such as
5054 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5057 @node Disconnected Operations, Expire and Archive, Draft, Top
5058 @chapter Off-line Management
5059 @cindex Disconnected Operations
5061 Wanderlust has on-line and off-line states.
5064 * Off-line State:: Wanderlust has on-line and off-line states
5065 * Enable Operations:: Enable Disconnected Operations
5066 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5067 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5068 * Variables of Plugged Mode:: Customize Plugged Mode
5072 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5073 @section Off-line State
5075 Wanderlust has on-line and off-line states. In the off-line state, you
5076 cannot access messages via network, unless they are cached.
5078 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5079 in the mode line indicates the off-line state. In folder or summary
5080 modes, press @kbd{M-t} to switch between off- and on-line.
5082 You can invoke Wanderlust in the off-line state by setting
5083 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5085 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5086 ignores uncached messages.
5089 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5090 @section Enable Disconeected Operations
5092 Even in the off-line state, provided that relevant messages are cached,
5093 and the variable @code{elmo-enable-disconnected-operation} (described
5094 later) is non-nil, you can following operations:
5095 @xref{Plugged Mode}, @xref{Off-line State settings}.
5098 * Send Messages off-line:: Transmit Messages
5099 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5100 * Creation of Folders:: Create Folders off-line (IMAP4)
5101 * Marking:: Mark (IMAP4)
5102 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
5105 As soon as Wanderlust becomes on-line, such operations invoked off-line
5106 are reflected in the servers via network.
5109 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5110 @subsection Transmission of Messages
5112 You can proceed sending operation for mail/news messages while you are
5113 off-line, then it will be reserved for sending (if you are using
5114 @file{im-wl.el}, it is irrelevant).
5115 Messages reserved for sending while off-line are accumulated in the
5116 queue folder, @samp{+queue}. These messages are transmitted at once when
5117 Wanderlust becomes on-line.
5119 You can visit @samp{+queue} in the off-line state and confirm content of
5120 messages in the queue. You can also remove messages. Removed messages
5121 are not transmitted even in the on-line state.
5124 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5125 @subsection Re-file and Copy (IMAP4)
5127 Re-file and copy operations to IMAP folders invoked during the off-line
5128 state are accumulated in the queue, and reflected in the server side
5129 when Wanderlust becomes on-line. If you visit destination folders after
5130 off-line re-file or copy, it looks as if messages were appended even in
5133 For the safety reasons, messages re-filed off-line are removed from
5134 source folders only if their @samp{Message-ID:} match messages on the
5135 servers. While the queue is processed, messages that failed to be
5136 re-filed or copied to the specified folders are appended to the folder
5140 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5141 @subsection Creation of Folders (IMAP4)
5143 You can create IMAP folders off-line. The creation of folders are
5144 reflected in the servers when Wanderlust becomes on-line. If the creation
5145 of those folders fails at that time for some reasons, messages
5146 to be re-filed into those are appended to the folder @samp{+lost+found}
5150 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5151 @subsection Marking (IMAP4)
5153 Off-line changes in unread/read and importance mark @samp{$} information
5154 are also reflected in the servers when Wanderlust becomes on-line.
5157 @node Pre-fetching Reservations, , Marking, Enable Operations
5158 @subsection Pre-fetching (IMAP4, NNTP)
5160 You can make reservations for pre-fetching messages in IMAP or NNTP
5161 folders. Reserved messages are marked with @samp{!} but not cached
5162 yet. When Wanderlust becomes on-line, they are pre-fetched from
5165 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5166 these off-line operations for IMAP4 and NNTP do not take place, and
5167 off-line re-file, copy or suchlike simply results in error.
5169 Because off-line operations use cache files, it is a bad idea to erase
5170 them by hand; it may cause Wanderlust to malfunction.
5172 If you want to remove caches, be sure to execute @kbd{M-x
5173 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5174 remove caches for messages relevant to off-line operations.
5177 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5178 @section Switching On-line/Off-line per Server/Port
5180 @kbd{M-t} described above switches networking states as a whole, but you
5181 can switch on-line/off-line per server/port.
5183 Pressing @kbd{C-t} in the folder or summary modes brings you in
5184 wl-plugged-mode shown below, in which you can change the plugged state
5189 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5192 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5193 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5195 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5196 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5202 The first line indicates status of the following three variables, and
5203 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5204 column modifies the values of these variables.
5208 "Queuing" @code{wl-draft-enable-queuing}
5209 "AutoFlushQueue" @code{wl-auto-flush-queue}
5210 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5214 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5217 The second and after lines indicate on-line/off-line states of servers
5218 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5219 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5220 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5222 @dfn{sending queue} means messages accumulated in the folder
5223 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5224 off-line operations when @code{elmo-enable-disconnected-operation} is
5226 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5227 @c off-line operations are enabled.
5229 They are displayed if there are any of them. In the example above, in
5230 the sending queue there are two messages (the first and the second in
5231 the queue folder) for smtp to hosta and one (the third) for nntp to
5232 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5235 If you change @samp{(wl-plugged)} in the second line, the variable
5236 @code{wl-plugged} is changed, so that the mode line indicator and
5237 plugged states of all ports are affected. If you change plugged states
5238 of any servers or ports, @samp{(wl-plugged)} in the second line is
5239 affected depending on @code{elmo-plugged-condition} settings and the
5240 plugged state of each port.
5243 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5244 @section Invoking Wanderlust in the Off-line State
5246 As described before, if you set @code{wl-plugged} to @code{nil} in
5247 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5248 off-line state. You can specify off-line state on a per server or port
5249 basis. Refer to @code{wl-reset-plugged-alist} also.
5251 Usually, when Wanderlust starts up, the plugged state of each port is
5252 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5253 @code{wl-nntp-posting-server} and so on. If you want to change the
5254 plugged state of these ports or to add other ports, configure
5255 @code{wl-make-plugged-hook} with a function.
5259 (add-hook 'wl-make-plugged-hook
5261 (elmo-set-plugged plugged-value(t/nil) server port)
5262 ;; @r{add or change plugged states of the port of the server}
5263 (elmo-set-plugged plugged-value(t/nil) server)
5264 ;; @r{if the port is omitted, all ports are affected}
5265 ;; @r{(you cannot omit the port if you newly add the server)}
5271 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5272 @section Customizable Variables
5277 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5278 mode from the beginning.
5280 @item wl-queue-folder
5281 @vindex wl-queue-folder
5282 The initial setting is @samp{+queue}.
5283 This is the folder in which messages in the transmission queue are
5286 @item wl-auto-flush-queue
5287 @vindex wl-auto-flush-queue
5288 The initial setting is @code{t}.
5289 This flag controls automatic transmission of the queue when Wanderlust
5290 becomes on-line. If non-nil, the queue is automatically transmitted
5291 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5292 manually, press @kbd{F} in the folder mode.
5294 @item elmo-enable-disconnected-operation
5295 @vindex elmo-enable-disconnected-operation
5296 The initial setting is @code{t}. Controls off-line operations
5297 regarding IMAP4. If non-nil, off-line operations are carried out.
5299 @item elmo-lost+found-folder
5300 @vindex elmo-lost+found-folder
5301 The initial setting is @samp{+lost+found}.
5302 This is the folder to which messages are saved when they fails to be
5303 appended while the off-line re-file/copy queue is processed.
5305 @item elmo-plugged-condition
5306 @vindex elmo-plugged-condition
5307 The initial setting is @code{one}.
5308 The value of @code{wl-plugged} reflects the return value of the function
5309 @code{elmo-plugged-p} (without arguments).
5310 This variable @code{elmo-plugged-condition} specifies the condition on
5311 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5312 plugged state of each port.
5315 'one : plugged if one or more ports are plugged.
5316 'all : plugged if all ports are plugged.
5317 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5318 states of the ports.
5319 @var{function} : reflects the return value of the @var{function}
5320 functions available per default
5321 'elmo-plug-on-by-servers
5322 : reflects the plugged state of the servers specified by the
5323 variable elmo-plug-on-servers.
5324 'elmo-plug-on-by-exclude-servers
5325 : reflects the plugged state of the servers that are not
5326 in elmo-plug-on-exclude-servers.
5327 elmo-plug-on-exclude-servers defaults to
5330 (system-name)without the domain part)
5336 (setq elmo-plugged-condition 'all)
5338 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5339 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5341 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5342 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5346 @item wl-reset-plugged-alist
5347 @vindex wl-reset-plugged-alist
5348 The initial setting is @code{t}. If non-nil, plugged states are
5349 initialized on a per server or port basis when Wanderlust starts up.
5351 If @code{nil}, plugged states are retained while Emacs is running. In
5352 other words, they are initialized when Emacs is restarted even if the
5353 value is @code{nil}.
5357 @node Expire and Archive, Scoring, Disconnected Operations, Top
5358 @chapter Automatic Expiration and Archiving of Messages
5359 @cindex Expire and Archive
5362 * Expire:: Expiration and Archiving
5363 * Archive:: Archiving All Messages
5367 @node Expire, Archive, Expire and Archive, Expire and Archive
5369 @cindex Expire Message
5371 Expiration means deletion of old messages which have outlasted a
5372 certain period of time.
5374 @code{wl-expire} supports not only simple deletion, but also moving to
5375 specified archiving folders.
5379 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5380 or @kbd{M-e} in the summary mode.
5382 @subsection Configuring @code{wl-expire-alist}
5384 An example configuration of @code{wl-expire-alist} is shown below.
5385 Everything in this @code{wl-expire-alist} makes a great difference in
5386 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5387 to @code{t}, especially in the initial stage.
5391 (setq wl-expire-alist
5392 '(("^\\+trash$" (date 14) remove)
5394 ("^\\+tmp$" (date 7) trash)
5395 ;; @r{re-file to @code{wl-trash-folder}}
5396 ("^\\+outbox$" (number 300) "$outbox;lha")
5397 ;; @r{re-file to the specific folder}
5399 ;; @r{do not expire}
5400 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5401 ;; @r{archive by message number (retaining numbers)}
5402 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5403 ;; @r{archive by a fixed number (retaining numbers)}
5404 ("^\\+diary$" (date 30) wl-expire-archive-date)
5405 ;; @r{archive by year and month (numbers discarded)}
5410 Items in the list has the format of:
5413 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5417 The folder is examined if it matches @var{regexp-for-folders} from the
5418 beginning of the list. If you invoke expiration on the folder that does
5419 not match any of them, nothing will happen. And if either the second or
5420 the third element of the item is @code{nil}, expiration will not take
5423 You can use any one of the following for
5424 @var{specification-of-message-to-be-deleted}:
5427 @item (number @var{n1} [@var{n2}])
5428 deletes messages depending on the number of messages in the folder.
5430 @var{n1} is the number of messages which should survive deletion, for example
5431 if its value is 500, the newest 500 messages survive and the rests are
5434 @var{n2} is the number of messages in the folder on which expiration should
5435 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5436 folders with 510 or more messages are expired.
5437 If you configured automatic expiration, frequently used folders may
5438 expire every time it receive messages, and you may be annoyed with the
5439 long delay in reading mail.
5440 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5441 expiration would not take place until a certain number of messages
5444 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5445 with important/new/unread) are not deleted.
5446 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5447 will expire so as to have 500 messages including such ones.
5448 Otherwise, it will have 500 messages except such ones.
5450 @item (date @var{d1})
5451 deletes messages depending on the dates.
5453 Messages dated @var{d1} or more days ago are deleted, for example if its
5454 value is seven, messages seven days old or more are deleted. Note that
5455 the date is the one in the @samp{Date:} field of the message, not when
5456 the message entered the folder.
5458 Messages with no or invalid @samp{Date:} field does not expire; you
5459 might have to delete them by hand.
5462 You can use any one of the following in the place of @var{destination}:
5466 deletes the messages instantly.
5469 hide the messages from summary (messages are not deleted).
5472 moves the messages to @code{wl-trash-folder}.
5474 @item @var{string}(folder)
5475 moves the messages to the folder specified with @var{string}.
5477 It would be useful for specifying an archiving folder, but because this
5478 does not move important messages, it might be better to use the
5479 standard functions described below.
5481 @item @var{function}
5482 invokes the specified @var{function}.
5484 To the @var{function}, three arguments are passed: a folder name, a list
5485 of messages to be deleted, and msgdb information of the summary. You
5486 can specify function-specific arguments after the name of the
5487 @var{function}. Note that the list contains messages with marks in
5488 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5491 These are four standard functions; three of them move messages to an archive
5492 folder in the specified way. This means old messages can be compressed
5493 and saved in a file, being deleted from the original folder.
5494 The last one divides messages to some MH folders.
5497 @item wl-expire-archive-number1
5498 re-files to archiving folders corresponding to the message numbers of
5499 the messages being deleted. For example, a message numbered 102 will be
5500 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5501 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5502 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5504 The archiving folders to which messages are re-filed are determined by
5505 the name of the folder as follows (in this case, archiving folders are
5506 handled as if @code{elmo-archive-treat-file} were non-nil).
5509 @item If the folder type is localdir:
5510 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5512 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5513 (@file{~/Mail/ml/wl-00100.zip}).
5515 @item The folder type is other than localdir:
5516 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5518 For example, @samp{%#mh/ml/wl} corresponds to
5519 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5522 As you can see, in the case of localdir, the folder type is not included
5523 in the path name, but otherwise it is included.
5524 And you can control the prefix to the archiving folder name by
5525 @code{wl-expire-archive-folder-prefix}.
5526 Refer to @code{wl-expire-archive-folder-prefix} for details.
5528 @item wl-expire-archive-number2
5529 re-files every certain number of messages to archiving folders.
5531 This differs from @samp{wl-expire-archive-number1} in that this re-files
5532 to the folder up to the specified number regardless of message numbers.
5533 The archiving folders to which messages are re-filed are determined in the
5534 same way as @code{wl-expire-archive-number1}.
5536 @item wl-expire-archive-date
5537 re-files messages depending on its date (year and month) to archive
5540 For example, a message dated December 1998 is re-filed to
5541 @code{$folder-199812;zip}. The name of the archiving folders except the
5542 date part are determined in the same way as
5543 @code{wl-expire-archive-number1}.
5546 You can set the first argument to these three standard functions to non-nil
5547 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5548 For example, it can be specified just after the name of the function:
5551 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5554 If you omit the argument, consecutive numbers from 1 are assigned for
5555 each archiving folder.
5557 @item wl-expire-localdir-date
5558 divedes messages depending on its date (year and month) to MH folders
5559 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5563 @subsection Treatment for Important or Unread Messages
5565 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5566 standard function, messages with marks in
5567 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5568 messages} thereafter) are retained.
5570 Per default, this variable include the important, new, and unread marks,
5571 so that messages with these marks are not removed.
5572 Note that you cannot include the temporary mark (i.e. temporary marks
5573 are removed anyway), and be sure to process temporary marks before you
5576 @subsection Auto Expiration
5578 The following setup invokes expiration when you move into the summary
5579 mode. There will be no confirmation, so make sure you made no mistake
5580 in regexp and other settings before you set up this.
5584 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5588 In the folder mode, you can invoke expiration per group as well as per
5589 folder. Therefore, if you specify @samp{Desktop} group, all folders
5590 matching @code{wl-expire-alist} expire.
5594 @subsection Treating archive folders.
5595 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5596 you must set non-nil value to @code{elmo-archive-treat-file}.
5598 @subsection Confirming
5600 If you are to use @code{remove}, try @code{trash} at first and see
5601 messages move to @code{wl-trash-folder} as expected, then replace it
5602 with @code{remove}. It would be dangerous to use @code{remove} from the
5605 If you are to use @code{wl-expire-archive-number1} and the like, try to
5606 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5607 you can append messages to it. Even if settings in
5608 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5609 would not be saved anywhere and disappeared in case the archiver program
5612 After you make sure you can archive to the folder correctly, you can
5613 invoke expiration and utilize the log.
5615 If you set @code{wl-expire-use-log} to @code{t},
5616 @file{~/.elmo/expired-log} should contain the log, for example:
5620 delete +ml/wl (593 594 595 596 597 598 599)
5621 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5625 The first column indicates the operation, i.e. @samp{delete},
5626 @samp{copy}, or @samp{move}. The next is the name of the folder that
5627 expired. In the case of @samp{copy} and @samp{move}, the destination
5628 folder is recorded after @samp{->}. The last is the list of message
5629 numbers that are actually deleted or moved (in the case of @samp{copy}
5630 and @samp{move}, the number is the one in the source folder, rather than
5631 the destination folder).
5633 @subsection Re-filing Reserved Messages
5635 The three standard functions copy reserved messages to the archive
5636 folder, but do not delete them from the source folder. Because
5637 reserved messages and the like always remain, they are recorded in
5638 @file{~/.elmo/expired-alist} so that they are not copied over and over
5639 again. They are not recorded if copied by @code{wl-summary-archive}.
5641 If you enabled logging, usually @samp{move} is recorded for re-filing,
5642 but instead @samp{copy} and @samp{delete} are recorded separately if
5643 reserved messages are involved. This is because it actually copies
5644 messages including reserved, then deletes ones except reserved in that
5647 @section Customizable Variables
5650 @item wl-expire-alist
5651 @vindex wl-expire-alist
5652 The initial setting is @code{nil}.
5653 This variable specifies folders and methods to expire. For details,
5654 refer to @code{wl-expire-alist} settings above.
5656 @item wl-summary-expire-reserve-marks
5657 @vindex wl-summary-expire-reserve-marks
5658 The initial setting is the list below.
5662 (list wl-summary-important-mark
5664 wl-summary-unread-mark
5665 wl-summary-unread-uncached-mark
5666 wl-summary-unread-cached-mark)
5670 Messages with these marks are retained in the folder, even after
5672 Only permanent marks can be listed, not temporary marks.
5674 You can list marks one by one as in the default; you can use the
5675 following settings as well:
5679 All messages with permanent marks are retained,
5680 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5684 All messages are handled as usual ones that are already read, no matter
5685 what marks they have; even important messages are deleted.
5688 @item wl-expire-archive-files
5689 @vindex wl-expire-archive-files
5690 The initial setting is 100.
5691 This variable specifies the number of messages to be retained in one
5694 @item wl-expire-number-with-reserve-marks
5695 @vindex wl-expire-number-with-reserve-marks
5696 The initial setting is @code{nil}.
5697 If non-nil, if expiring messages are specified by @code{number},
5698 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5700 @item wl-expire-archive-get-folder-function
5701 @vindex wl-expire-archive-get-folder-function
5702 The initial setting is @code{wl-expire-archive-get-folder}.
5704 This variable specifies a function that returns the name of an archiving
5705 folder for standard functions in the place of @var{destination}.
5706 You can use the following three variables for simple modification of
5707 folder names; if you want more complex settings, define your own
5708 function in this variable.
5710 @code{wl-expire-archive-get-folder} can be customized by these
5713 @item @code{wl-expire-archive-folder-name-fmt}
5714 @item @code{wl-expire-archive-folder-type}
5715 @item @code{wl-expire-archive-folder-prefix}
5718 @item wl-expire-archive-folder-name-fmt
5719 @vindex wl-expire-archive-folder-name-fmt
5720 The initial setting is @samp{%s-%%05d;%s}.
5721 This is a @code{format} string for archiving folders used in
5722 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5723 Note that you must specify the message number by @samp{%%d}, because it
5724 is parsed twice by @code{format}.
5726 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5729 @item wl-expire-archive-date-folder-name-fmt
5730 @vindex wl-expire-archive-date-folder-name-fmt
5731 The initial setting is @samp{%s-%%04d%%02d;%s}.
5732 This is a @code{format} string for archiving folders used in
5733 @code{wl-expire-archive-date}. Note that you must specify the message
5734 number by @samp{%%d}, because it is parsed twice by @code{format}.
5735 There should be @samp{%%d} twice, one for the year and the other for the
5738 If you modify this, adjust
5739 @code{wl-expire-archive-date-folder-num-regexp} as well.
5741 @item wl-expire-archive-folder-type
5742 @vindex wl-expire-archive-folder-type
5743 The initial setting is @code{zip}.
5744 This variable specifies an archiver type of the archiving folders.
5746 @item wl-expire-archive-folder-prefix
5747 @vindex wl-expire-archive-folder-prefix
5748 The initial setting is @code{nil}.
5749 This variable specifies the prefix (directory structure) to archiving
5751 Exercise extreme caution in using this feature, as it has not been
5753 In the worst case, there is a fear of destructing archiving folders.
5757 There will be no prefix.
5760 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5761 @samp{$ml/wl-00000;zip;wl}.
5764 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5767 @samp{$ml/wl-00000;zip;ml/wl}.
5770 @item wl-expire-archive-folder-num-regexp
5771 @vindex wl-expire-archive-folder-num-regexp
5772 The initial setting is @samp{-\\([-0-9]+\\);}.
5773 This variable specifies the regular expression to be used for getting
5774 message numbers from multiple archiving folders specified by
5775 @code{elmo-list-folders}.
5776 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5778 @item wl-expire-archive-date-folder-num-regexp
5779 @vindex wl-expire-archive-date-folder-num-regexp
5780 The initial setting is @samp{-\\([-0-9]+\\);}.
5781 This is the regular expression to be used for getting message numbers
5782 from multiple archiving folders specified by @code{elmo-list-folders}.
5783 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5785 @item wl-expire-delete-oldmsg-confirm
5786 @vindex wl-expire-delete-oldmsg-confirm
5787 The initial setting is @code{t}.
5788 If non-nil, messages older than the one with the largest number will be
5789 deleted with confirmation.
5790 If @code{nil}, they are deleted without confirmation.
5792 This feature is valid only if non-nil is specified as a argument to the
5793 standard functions so as to retain numbers.
5795 @item wl-expire-use-log
5796 @vindex wl-expire-use-log
5797 The initial setting is @code{nil}.
5798 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5799 They are appended but not truncated or rotated automatically; you might
5800 need to remove it manually.
5802 @item wl-expire-add-seen-list
5803 @vindex wl-expire-add-seen-list
5804 The initial setting is @code{t}.
5806 If non-nil, when messages are re-filed by expiration, read/unread
5807 information is passed to the destination folder.
5809 However if you do not read the destination folder from Wanderlust,
5810 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5811 want to set this to @code{nil} if you are simply saving to some
5812 archiving folders. Even if its value is @code{nil}, messages in the
5813 archiving folders are simply treated as unread; it does not affect
5816 @item wl-expire-folder-update-msgdb
5817 @vindex wl-expire-folder-update-msgdb
5818 The initial setting is @code{t}.
5819 If @code{t}, in the folder mode, expiration is carried out after
5820 updating summary information. If you specified a list of regular
5821 expressions of folder names, summary information is updated for matching
5826 @node Archive, , Expire, Expire and Archive
5827 @section Archiving Messages
5829 @subsection Archiving Messages
5830 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5831 folders. If there are the archiving folders already, only new messages
5834 You can use @code{wl-archive-alist} in order to specify how messages are
5835 archived according to their folder names, as in @code{wl-expire-alist}.
5840 (setq wl-archive-alist
5841 '(("^\\+tmp$" wl-archive-date)
5842 ("^\\+outbox$" wl-archive-number2)
5843 (".*" wl-archive-number1)))
5847 Each item in the list has the following format:
5850 (@var{folders-regexp} @var{deleting-function})
5853 As you can see, you can only use a function after @var{folders-regexp}.
5854 Per default, there are three functions:
5857 @item @code{wl-archive-number1}
5858 @item @code{wl-archive-number2}
5859 @item @code{wl-archive-date}
5862 As inferred from their names, they work similarly to "expire" versions,
5863 other than the following points:
5866 @item No messages are deleted
5867 @item Message numbers are retained even if invoked without arguments
5870 These functions are good to archive all messages in a folder by their
5871 numbers or by their dates.
5872 These are also useful for backup or confirmation purposes before
5874 If you try to re-file them after they are archived, they are deleted but
5877 Per default, the archiving folders to which messages are copied are
5878 determined automatically by @code{wl-expire-archive-get-folder-function}.
5879 You can copy to a specific folder by invoking with a prefix argument,
5880 i.e. @kbd{C-u M-x wl-summary-archive}.
5882 Note that this feature has not been seriously tested, because you can
5883 simply copy to an archiving folder, for example by
5884 @code{wl-summary-copy-region}.
5886 The archiving folders are determined by the same logic as in
5887 @code{wl-summary-expire}; the following customizable variables are
5891 @item @code{wl-expire-archive-files}
5892 @item @code{wl-expire-archive-get-folder-function}
5893 @item @code{wl-expire-archive-folder-name-fmt}
5894 @item @code{wl-expire-archive-folder-type}
5895 @item @code{wl-expire-archive-folder-prefix}
5896 @item @code{wl-expire-archive-folder-num-regexp}
5899 @subsection Customizable Variables
5902 @item wl-archive-alist
5903 @vindex wl-archive-alist
5904 The initial setting is the list shown below:
5908 ((".*" wl-archive-number1))
5913 This variable specifies a function that copies to archiving folders.
5914 To the function, three arguments are passed: a folder name, a list of
5915 messages in the folder, and msgdb information of the summary.
5916 Needless to say, you can use your own function.
5920 @node Scoring, Split messages, Expire and Archive, Top
5921 @chapter Score of the Messages
5923 @c @cindex Kill File
5925 Scoring is the function that associates a score (value) with each
5926 message, and marks as read or deletes from the summary according to it.
5928 You can put target or important marks on essential messages, or read marks
5929 on the ones you do not want to read, for example spam articles.
5931 This scoring function has a capability and a format similar to the one
5932 that Gnus has, although there are some unsupported features and
5933 Wanderlust specifics.
5934 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5937 * Score Commands:: Score Commands
5938 * Score File Format:: Score File Format
5942 @node Score Commands, Score File Format, Scoring, Scoring
5943 @section Score Commands
5944 @cindex Score Commands
5946 @subsection Score File Specification
5948 @code{wl-score-folder-alist} specifies score files or variables in which
5949 scores are defined, corresponding to folder names.
5953 (setq wl-score-folder-alist
5962 If paths to the score files are omitted, the directory specified in the
5963 variable @code{wl-score-files-directory} is assumed.
5965 No matter what you write in @code{wl-score-folder-alist}, the default
5966 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5967 read (it does not have to exist).
5968 Therefore, in the example above, the three score files,
5969 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5970 the folders that matches @samp{^-.*}.
5972 @subsection Scored Messages
5974 Scores are attached to the messages that are specified by
5975 @code{wl-summary-score-marks} temporarily when the summary is updated;
5976 when you exit from the summary, the scores are removed and reverts to
5979 @subsection Creation of Score Files
5981 In the summary buffer, move to an appropriate message and type @kbd{L}.
5982 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5983 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5985 This makes @minus{}1000 are scored for messages with the same
5986 @samp{Subject:} as the string you entered. That is, such a score file
5987 is created automatically.
5989 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5990 The score file you just made appears.
5991 This buffer is called @dfn{score editing buffer} thereafter.
5992 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5993 as you are previously; type @kbd{a}. Then a score entry for "From"
5995 In this way, you can create a score file easily either in the summary
5996 buffer or in the score editing buffer.
5998 By the way, you might be aware the numbers of key strokes are different
5999 between @kbd{s s p} and @kbd{a}.
6000 This is determined by @code{wl-score-header-default-entry}.
6001 This variable specifies the default score entries corresponding to
6003 For example, for "subject" field, a type and a time limit are prompted,
6004 but for "from" field, they are fixed upon automatically as substring and
6005 permanent respectively.
6006 However, score values can be modified by the prefix argument.
6007 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
6010 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
6011 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
6012 erasing contents of the buffer deletes the score file being edited.
6016 @subsubsection Selecting Score Files
6018 You can change score files to which scores are appended by
6019 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
6020 @code{wl-score-change-score-file}.
6022 @subsubsection Summing Up the Score
6024 If you add the same entries by @code{wl-summary-increase-score},
6025 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
6026 scores for the entry is summed up.
6028 For example, if you create @samp{from} entry with the score of @minus{}1000 by
6029 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
6030 @minus{}1200 will be created as a result.
6032 @subsubsection Creating Thread Key
6034 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
6035 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6037 @subsubsection Creating Followup Key
6039 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6040 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6041 at the cursor to @samp{References} key.
6042 If @code{wl-score-auto-make-followup-entry} is non-nil,
6043 @samp{Message-ID} of all messages to be followed up within dates
6044 specified by @code{wl-score-expiry-days}.
6046 @subsection Key Bindings
6051 @findex wl-summary-increase-score
6052 Increases the score for the current message.
6053 And the score entry is appended to the score file at the same moment.
6054 You can specify the score value by a prefix argument.
6058 @findex wl-summary-lower-score
6059 Decreases the score for the current message.
6060 And the score entry is appended to the score file at the same moment.
6061 You can specify the score value by a prefix argument.
6064 @kindex h R (Summary)
6065 @findex wl-summary-rescore
6066 Re-applies the scoring.
6067 However, already scored messages are not scored anew.
6070 @kindex h c (Summary)
6071 @findex wl-score-change-score-file
6072 Changes the score file currently selected.
6075 @kindex h e (Summary)
6076 @findex wl-score-edit-current-scores
6077 Edits the score file currently selected.
6078 If there are multiple score files, the previously specified one is
6082 @kindex h f (Summary)
6083 @findex wl-score-edit-file
6084 Edits an arbitrary score file and selects it.
6087 @kindex h F (Summary)
6088 @findex wl-score-flush-cache
6089 Erases caches associated to the score files that are read.
6090 If you modified score files directly (from other than Wanderlust), you
6091 need to re-read them after erasing the cache.
6094 @kindex h m (Summary)
6095 @findex wl-score-set-mark-below
6096 Specifies the criterion for scores to be marked as read.
6097 Messages with scores less than this value are marked as read.
6100 @kindex h x (Summary)
6101 @findex wl-score-set-expunge-below
6102 Specifies the criterion for scores to be deleted from the summary.
6103 Messages with scores less than this value are deleted.
6104 "Deleted" means it is not shown; they are not removed from the summary
6105 information or the folder.
6106 The deleted messages can be shown by rescan-noscore again.
6109 @subsection Key Bindings in the Score Editing Buffer
6113 @kindex C-c C-k (Score Mode)
6114 @findex wl-score-edit-kill
6115 Abandons the file being edited.
6118 @kindex C-c C-c (Score Mode)
6119 @findex wl-score-edit-exit
6120 Saves the file being edited, and quits from the edit mode.
6123 @kindex C-c C-p (Score Mode)
6124 @findex wl-score-pretty-print
6128 @kindex C-c C-d (Score Mode)
6129 @findex wl-score-edit-insert-date
6130 Inserts the number of dates from Dec. 31, 1 B.C.
6131 It is used for creating the third factor of time-limited scores.
6134 @kindex C-c C-s (Score Mode)
6135 @findex wl-score-edit-insert-header
6136 Inserts the header of the message selected in the summary buffer.
6139 @kindex C-c C-e (Score Mode)
6140 @findex wl-score-edit-insert-entry
6141 Inserts the score entry of the message selected in the summary buffer.
6144 @subsection Customizable Variables
6147 @item wl-summary-default-score
6148 @vindex wl-summary-default-score
6149 The initial setting is 0 (zero).
6150 This variable specifies the default value of the score.
6151 The score is increased or decreased based upon this value.
6153 @item wl-summary-important-above
6154 @vindex wl-summary-important-above
6155 The initial setting is @code{nil}.
6156 Messages with scores larger than this value are attached with the
6157 important mark (@samp{$}).
6158 If @code{nil}, no important marks are attached.
6160 @item wl-summary-target-above
6161 @vindex wl-summary-target-above
6162 The initial setting is @code{nil}.
6163 Messages with scores larger than this value are attached with the target
6165 If @code{nil}, no target marks are attached.
6167 @item wl-summary-mark-below
6168 @vindex wl-summary-mark-below
6169 The initial setting is 0 (zero).
6170 Messages with scores smaller than this value are marked as read.
6172 @item wl-summary-expunge-below
6173 @vindex wl-summary-expunge-below
6174 The initial setting is @code{nil}.
6175 Messages with scores smaller than this value are deleted from the
6177 If @code{nil}, they are not deleted.
6179 @item wl-summary-score-marks
6180 @vindex wl-summary-score-marks
6181 The initial setting is the list shown below:
6185 (list wl-summary-new-mark)
6190 Messages with these marks are scored.
6192 @item wl-use-scoring
6193 @vindex wl-use-scoring
6194 The initial setting is t.
6195 If non-nil, scoring is enabled.
6197 @item wl-score-files-directory
6198 @vindex wl-score-files-directory
6199 The initial setting is @file{~/.elmo/}.
6200 The default directory for score files.
6202 @item wl-score-interactive-default-score
6203 @vindex wl-score-interactive-default-score
6204 The initial setting is 1000.
6205 This value is used as a score when a score factor is @code{nil} in the
6206 score file. It is also used in @code{wl-summary-increase-score} and
6207 @code{wl-summary-lower-score}, on condition that the value of
6208 @code{wl-score-header-default-entry} is @code{nil}.
6210 @item wl-score-expiry-days
6211 @vindex wl-score-expiry-days
6212 The initial setting is 7.
6213 This is the number of days before time-limited scores are deleted.
6215 @item wl-score-update-entry-dates
6216 @vindex wl-score-update-entry-dates
6217 The initial setting is @code{t}.
6218 If non-nil, it enables deletion of time-limited scores.
6220 @item wl-score-header-default-entry
6221 @vindex wl-score-header-default-entry
6222 Specifies the default value for each header field for score entries
6223 created by @code{wl-summary-increase-score},
6224 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6226 @item wl-score-simplify-fuzzy-regexp
6227 @vindex wl-score-simplify-fuzzy-regexp
6228 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6229 regular expression to be deleted from the string.
6230 Because this is usually used for Subject, the default is prefixes that
6231 are attached by mailing list programs.
6233 @item wl-summary-rescore-partial-threshold
6234 @vindex wl-summary-rescore-partial-threshold
6235 The initial setting is 200.
6236 When sync-all or rescan is executed, if there are messages more than
6237 this value, only the last same number of messages as this value are
6240 @item wl-summary-auto-sync-marks
6241 @vindex wl-summary-auto-sync-marks
6242 If non-nil, unread/important marks are synchronized when the summary
6244 Unread marks reflect information on the IMAP4 server.
6245 Important marks reflect information on the IMAP4 server (flagged or
6246 not), and contents of @samp{'mark} folder.
6247 The initial setting is @code{t}.
6251 @node Score File Format, , Score Commands, Scoring
6252 @section Score File Format
6253 @cindex Score File Format
6255 The format of score files are the same as Gnus, and basically you can
6256 use Gnus score files as they are. But they are not fully compatible
6257 because some keys are not supported and there are Wanderlust specifics.
6258 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6263 ("for sale" -1000 nil s)
6264 ("profit" -1000 nil s))
6266 ("spam@@spamspamspam" -10000 nil s))
6268 ("my@@address" 3001 nil s))
6270 (1000000 -10 nil >))
6280 If the key is a string, it is the name of the header to be matched.
6281 The following keys are available:
6282 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6283 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6284 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6285 @code{Chars} and @code{Lines} mean the size and the number of lines of
6286 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6287 are described later.
6288 The rest corresponds the field of the same name.
6290 Arbitrary numbers of core entries are specified after the key.
6291 Each score entry consists of these five factors:
6295 A factor that matches header. This should be a number in the cases of
6296 @code{lines} and @code{chars}, otherwise a string.
6299 A score factor. When the first item matches, the score of the message
6300 is increased or decreased by this value.
6303 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6304 of a number, the score is deleted if it does not match for days
6305 (@code{wl-score-expiry-days}) from the date specified by this.
6306 The date is since Dec. 31, 1 B.C.
6309 A type factor. This specifies the way the first factor matches.
6310 Available types depend on keys.
6313 @item From, Subject, References, Message-ID
6314 For these keys in string, @code{r} and @code{R} (regexp),
6315 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6316 as well as @code{f} and @code{F} (fuzzy) can be used.
6317 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6320 For these keys, the following five numerical relative operators can be
6321 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6324 This key matches @code{From} header, and scores all follow-ups to the
6326 For example, it would be useful for increasing scores for follow-ups to
6329 You can use the same types as @code{From} except for @code{f}.
6330 And a @samp{Followup} entry is automatically appended to the score file.
6333 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6334 A @samp{Thread} entry is automatically appended for each article that
6335 has @var{x} in the @code{References} header.
6336 You can make sure the whole thread including messages that does not have
6337 all ancestors @code{Message-ID} in @code{References} is scored.
6339 You can use the same types as @code{References} except for @code{f}.
6340 And a @samp{Thread} entry is automatically appended to the score file.
6344 A factor for extension header. This is meaningful only if the key is
6346 This specifies headers to be matched other than standard headers like
6347 @code{Subject} and @code{From}.
6348 Note that you should specify the header in
6349 @code{elmo-msgdb-extra-fields} also.
6350 Therefore it does not work in folders where extension headers cannot be
6355 The sum of these scores @emph{after all factors are applied} becomes the
6356 score of the message.
6358 @cindex Score File Atoms
6360 Messages with a score less than this value is marked as read.
6361 The default is @code{wl-summary-mark-below}.
6364 Messages with a score less than this value is deleted from the summary.
6365 The default is @code{wl-summary-expunge-below}.
6367 @item mark-and-expunge
6368 Both @code{mark} and @code{expunge} are applied,
6369 i.e. messages with a score less than this value is marked as read and
6370 deleted from the summary.
6373 Messages with a score greater than this value is attached with temp
6375 The default is @code{wl-summary-target-above}.
6378 Messages with a score greater than this value is attached with important
6380 The default is @code{wl-summary-important-above}.
6385 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6386 are used, you need to set @code{elmo-msgdb-extra-fields}.
6389 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6392 There are other restrictions as shown below:
6395 @item Because @samp{References} field in the summary information
6396 contains only the last @samp{Message-ID}, @code{references} key matches
6400 Keys that can be seen by folder of types:
6404 chars lines xref extra
6405 localdir,localnews Y E E E
6406 nntp (supporting xover) Y E E N
6412 N: cannot be seen (ignored)
6413 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6418 @node Split messages, Address Book, Scoring, Top
6419 @chapter Message splitting
6420 @cindex Split messages
6422 You can use @code{elmo-split} to split message in folder specified by
6423 the variable @code{elmo-split-folder} a la @command{procmail} according
6424 to some specified rules. To use this feature, set as follows in your
6425 @file{~/.emacs} at first.
6428 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
6431 Set source folder like following.
6434 (setq elmo-split-folder "%inbox")
6437 And specify the rule in the variable @code{elmo-split-rule} (its format
6438 will be is described below).
6439 Then you can invoke @kbd{M-x elmo-split} to split messages according to
6440 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
6441 to do a rehearsal and show result (do not split actually).
6444 We will describe how to specify the rule. First of all, see following
6449 (setq elmo-split-rule
6450 ;; @r{Store messages from spammers into @samp{+junk}}
6451 '(((or (address-equal from "i.am@@spammer")
6452 (address-equal from "dull-work@@dull-boy")
6453 (address-equal from "death-march@@software")
6454 (address-equal from "ares@@aon.at")
6455 (address-equal from "get-money@@richman"))
6457 ;; @r{Store messages from mule mailing list into @samp{%mule}}
6458 ((equal x-ml-name "mule") "%mule")
6459 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
6460 ;; @r{and continue evaluating following rules}
6461 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
6462 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
6463 ((match from "\\(.*\\)@@yahoo\\.com")
6465 ;; @r{Store unmatched mails into @samp{+inbox}}
6470 The basic unit of the rule is a combination like
6473 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
6476 If @samp{CONDITION} is true, @samp{ACTION} is performed.
6477 The 1st element @samp{CONDITION} is a condition represented by a
6478 balanced expression (sexp). Its grammar will be explained below.
6479 The 2nd element @samp{ACTION} is the name of the folder to split
6480 messages into, or a symbol. When the 3rd element @code{continue} is
6481 specified as symbol, evaluating rules is not stopped even when the
6482 condition is satisfied.
6484 The grammar for @samp{CONDITION} is as follows. See example above to
6485 learn how to write the condition practically.
6489 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
6490 (@samp{FIELD-NAME} is a symbol that describes the field name)
6494 True if the field value equals to @samp{VALUE}.
6495 Case of the letters are ignored.
6497 True if the field value matches to VALUE.
6498 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6499 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6500 @item @code{address-equal}
6501 True if one of the addresses in the field equals to
6502 @samp{VALUE}. Case of the letters are ignored.
6503 @item @code{address-match}
6504 True if one of the addresses in the field matches to
6506 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6507 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6511 Functions which accept an integer argument (@samp{SIZE}).
6515 True if the size of the message is less than @samp{SIZE}.
6517 True if the size of the message is greater than @samp{SIZE}.
6521 Functions which accept any number of arguments.
6525 True if one of the argument returns true.
6527 True if all of the arguments return true.
6533 When a symbol is specified, it is evaluated.
6536 You can specify followings as 2nd @samp{ACTION}.
6542 If some string is specified, it will be regarded as the destination
6543 folder, and the message will be appended to it.
6548 If the symbol @samp{delete} is specified, delete the substance of the
6549 message in @code{elmo-split-folder}
6554 If the symbol @samp{noop} is specified, do nothing on the message and
6560 If some function is specified, execute it.
6563 If the message passes all rules, it will be dealed along @samp{ACTION}
6564 specified by @code{elmo-split-default-action}.
6567 @node Address Book, Customization, Split messages, Top
6568 @chapter Address Book
6569 @cindex Address Book
6571 With address book, you can utilize address completion, and you have
6572 summary displayed with nicknames.
6575 * Mail Addresses:: Definition of Address Book
6576 * Address Manager:: Address Manager
6580 @node Mail Addresses, Address Manager, Address Book, Address Book
6581 @section Address book
6582 @cindex Address book Definition
6584 @cindex Alias, Address
6586 The file @file{~/.addresses} is a simple address book for Wanderlust.
6587 Make address file @file{~/.addresses}, and edit to suit your requirement.
6589 The data written in @file{~/.addresses} are used for address completion
6590 under draft editing mode. Furthermore, they are used when showing names
6591 in summary display mode. You can safely skip this section, if you don't
6592 want to customize address completion and summary display.
6593 It is possible to add/change/remove addresses from @file{~/.addresses} in
6594 summary buffer after Wanderlust is invoked. @refill
6596 The format is very simple. Like this. @refill
6601 # @r{Lines begin with @samp{#} are comment.}
6602 # @r{Empty lines are ignored}
6604 # @r{Format of each line:}
6605 # @var{email-address} "@var{nickname} "@var{realname}"
6607 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6608 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6609 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6614 One line defines one persons description.
6616 Actually, in default setup, @var{nickname} is used in summary-mode and
6617 @var{realname} is used in draft preparation mode. This behavior is
6618 better understood if you try it and confirmed the function first. You
6619 can write and try a small definition, so you will know the idea of the
6620 address book before writing a big one.
6622 And, if MH alias file is specified in variable @code{wl-alias-file},
6623 it is used as an address information in the draft preparation mode.
6625 If variable @code{wl-use-ldap} is non-nil (initial setting is
6626 @code{nil}), address completion in draft mode uses LDAP information.
6628 If you use LDAP, you have to set @code{wl-ldap-server},
6629 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6630 not have LDAP feature as built-in feature (Currently only XEmacs can
6631 have built-in LDAP feature), you have to set command exec @env{PATH} to
6632 the program @command{ldapsearch}.
6635 @node Address Manager, , Mail Addresses, Address Book
6636 @section Address Manager
6637 @cindex Address Manager
6639 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6640 the address book and insert address to draft buffer.
6642 @subsection Key Bindings
6646 @kindex t (Address Manager)
6647 @findex wl-addrmgr-set-to
6648 Add @samp{To:} mark.
6651 @kindex c (Address Manager)
6652 @findex wl-addrmgr-set-cc
6653 Add @samp{Cc:} mark.
6656 @kindex b (Address Manager)
6657 @findex wl-addrmgr-set-bcc
6658 Add @samp{Bcc:} mark.
6661 @kindex u (Address Manager)
6662 @findex wl-addrmgr-unmark
6666 @kindex x (Address Manager)
6667 @findex wl-addrmgr-apply
6669 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6670 buffer and quit address manager. When no draft buffer, make new draft
6671 with insert marked addresses.
6673 If no mark, quit address manager.
6677 @kindex q (Address Manager)
6678 @findex wl-addrmgr-quit
6679 Quit address manager.
6682 @kindex a (Address Manager)
6683 @findex wl-addrmgr-add
6687 @kindex d (Address Manager)
6688 @findex wl-addrmgr-delete
6692 @kindex e (Address Manager)
6693 @findex wl-addrmgr-edit
6698 @node Customization, Terminology, Address Book, Top
6699 @chapter Customizing Wanderlust
6700 @cindex Customization
6703 * Living with other packages:: Cooperating with other packages
6704 * Highlights:: Highlights
6705 * Biff:: Notify Mail arrival
6706 * Advanced Settings:: Advanced Settings
6707 * Customizable Variables:: Customizable Variables
6712 @node Living with other packages, Highlights, Customization, Customization
6713 @section Living with other packages
6715 Examples with other packages.
6718 * imput:: imput (im-wl.el)
6719 * BBDB:: The Insidious Big Brother Database
6720 * LSDB:: The Lovely Sister Database
6721 * supercite:: supercite.el
6722 * mu-cite:: mu-cite.el
6723 * X-Face:: x-face,bitmap-mule
6724 * dired-dd:: dired-dd.el
6726 * Addrbook:: Addrbook
6727 * mime-w3m:: mime-w3m.el
6731 @node imput, BBDB, Living with other packages, Living with other packages
6736 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6739 If @command{imput} is on the @code{exec-path} at the installation,
6740 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6744 (autoload 'wl-draft-send-with-imput-async "im-wl")
6745 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6750 @node BBDB, LSDB, imput, Living with other packages
6754 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
6755 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
6756 and do the following settings.
6758 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6759 byte-compiled and installed.
6767 ;; @r{enable pop-ups}
6768 (setq bbdb-use-pop-up t)
6769 ;; @r{auto collection}
6770 (setq bbdb/mail-auto-create-p t)
6771 ;; @r{exceptional folders against auto collection}
6772 (setq bbdb-wl-ignore-folder-regexp "^@@")
6773 (setq signature-use-bbdb t)
6774 (setq bbdb-north-american-phone-numbers-p nil)
6775 ;; @r{shows the name of bbdb in the summary} :-)
6776 (setq wl-summary-from-function 'bbdb-wl-from-func)
6777 ;; @r{automatically add mailing list fields}
6778 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6779 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6783 You can complete address with BBDB by @kbd{M-@key{TAB}}
6787 @node LSDB, supercite, BBDB, Living with other packages
6791 The following is an example setting to use
6792 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
6799 (add-hook 'wl-draft-mode-hook
6801 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
6805 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
6806 (complete address with LSDB).
6809 @node supercite, mu-cite, LSDB, Living with other packages
6810 @subsection sc.el(supercite), sc-register.el
6814 The same setting as usual mailers should be OK. The following is an
6815 example of settings:
6819 (autoload 'sc-cite-original "supercite" nil t)
6820 (add-hook 'mail-citation-hook 'sc-cite-original)
6825 @node mu-cite, X-Face, supercite, Living with other packages
6826 @subsection mu-cite.el
6829 The same setting as usual mailers should be OK. The following is an
6830 example of settings.
6832 If you use mu-cite version 8.0 or earlier:
6836 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6837 (setq mail-citation-hook 'mu-cite/cite-original)
6841 If you use mu-cite version 8.1 or later:
6845 (autoload 'mu-cite-original "mu-cite" nil t)
6846 (add-hook 'mail-citation-hook (function mu-cite-original))
6850 @node X-Face, dired-dd, mu-cite, Living with other packages
6854 If you have installed one of the following, you can decode
6855 @samp{X-Face:} field in message buffer and you will see face image.
6858 * x-face-xmas:: XEmacs case
6859 * x-face-mule:: Emacs case
6862 If there is an encoded X-Face string in a file @file{~/.xface} (the
6863 value of the variable @code{wl-x-face-file}), it is inserted as a
6864 @samp{X-Face:} field in the draft buffer (if
6865 @code{wl-auto-insert-x-face} is non-nil).
6867 @node x-face-xmas, x-face-mule, X-Face, X-Face
6868 @subsubsection x-face-xmas (for XEmacs)
6871 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6872 1.3.6.13 or later, do the following:
6876 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6877 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6881 @node x-face-mule, , x-face-xmas, X-Face
6882 @subsubsection x-face-mule (for Emacs)
6886 If you use @file{x-face-mule.el} in bitmap-mule
6887 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6891 (autoload 'x-face-decode-message-header "x-face-mule")
6892 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6896 @subsubsection x-face-e21 (for Emacs 21.x)
6899 With Emacs 21.x, you can use @file{x-face-e21.el}
6900 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6901 to display X-Face. In this case, bitmap-mule is not required.
6906 (autoload 'x-face-decode-message-header "x-face-e21")
6907 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6912 @node dired-dd, MHC, X-Face, Living with other packages
6913 @subsection dired-dd(Dired-DragDrop)
6914 @pindex Dired-DragDrop
6916 @cindex Drag and Drop
6918 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6919 compose multi-part by simple Drag-and-Drop from dired to the draft
6920 buffer being edited in GNU Emacs (this feature is not Wanderlust
6921 specific, but general-purpose for SEMI).
6925 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6931 ;; @r{Set dired-x variables here.}
6932 ;; @r{To and flo@dots{}}
6934 (progn (require 'dired-dd)
6935 (require 'dired-dd-mime))))))
6939 @node MHC, Addrbook, dired-dd, Living with other packages
6943 Message Harmonized Calendaring system
6944 (@uref{http://www.quickhack.net/mhc/})
6946 By using MHC, you can make a calendar from the messages.
6952 (setq mhc-mailer-package 'wl)
6953 (autoload 'mhc-mode "mhc" nil t)
6954 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6955 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6963 (autoload 'mhc-wl-setup "mhc-wl")
6964 (add-hook 'wl-init-hook 'mhc-wl-setup)
6968 @node Addrbook, mime-w3m, MHC, Living with other packages
6969 @subsection wl-addrbook.el
6973 (@uref{http://www.mew.org/})
6975 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6976 @code{load-path} and do the following settings.
6980 (require 'wl-addrbook)
6985 @node mime-w3m, , Addrbook, Living with other packages
6986 @subsection mime-w3m.el
6989 You can display html part by using @file{mime-w3m.el}
6990 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6991 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6994 @node Highlights, Biff, Living with other packages, Customization
6997 @subsection Customizable Variables
7000 @item wl-summary-highlight
7001 @vindex wl-summary-highlight
7002 The initial setting is @code{t}.
7003 If non-nil, the summary is highlighted.
7005 @item wl-highlight-max-summary-lines
7006 @vindex wl-highlight-max-summary-lines
7007 The initial setting is 10000.
7008 The summary is not highlighted if it has more lines than this value.
7010 @item wl-summary-highlight-partial-threshold
7011 @vindex wl-summary-highlight-partial-threshold
7012 The initial setting is 1000.
7013 This is a threshold whether the whole summary is highlighted.
7014 If there are more lines of messages in the summary, it is partially
7017 @item wl-summary-partial-highlight-above-lines
7018 @vindex wl-summary-partial-highlight-above-lines
7019 The initial setting is 30. If there are more lines of messages than
7020 @code{wl-summary-highlight-partial-threshold} in the summary, messages
7021 after the point that is the same number of lines as this value above the
7022 cursor line are highlighted partially. (If this value is @code{nil},
7023 the last same number of lines as the value of
7024 @code{wl-summary-highlight-partial-threshold} are highlighted.)
7026 @item wl-highlight-body-too
7027 @vindex wl-highlight-body-too
7028 The initial setting is @code{t}.
7029 If non-nil, bodies of drafts and messages are also highlighted.
7031 @item wl-highlight-message-header-alist
7032 @vindex wl-highlight-message-header-alist
7033 When highlighting headers of drafts and messages, this variable
7034 specifies which faces are allocated to important
7035 (@code{wl-highlight-message-important-header-contents}), secondly
7036 important (@code{wl-highlight-message-important-header-contents2}), and
7037 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7039 Similarly, it can be used for allocating arbitrary faces to arbitrary
7040 regular expressions.
7042 @item wl-highlight-citation-prefix-regexp
7043 @vindex wl-highlight-citation-prefix-regexp
7044 Specifies a regular expression to which quoted lines in bodies of
7045 drafts and messages match.
7046 Bodies matching to this regular expression are highlighted by the faces
7047 specified by (@code{wl-highlight-message-cited-text-*}).
7049 @item wl-highlight-highlight-citation-too
7050 @vindex wl-highlight-highlight-citation-too
7051 The initial setting is @code{nil}.
7052 If non-nil, the quoting regular expression itself given by
7053 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7055 @item wl-highlight-citation-header-regexp
7056 @vindex wl-highlight-citation-header-regexp
7057 Specifies a regular expression that denotes beginning of quotation.
7058 Bodies matching to this regular expression are highlighted by the face
7059 specified by @code{wl-highlight-message-headers}.
7061 @item wl-highlight-max-header-size
7062 @vindex wl-highlight-max-header-size
7063 The initial setting is @code{nil}. If a header size is larger than this
7064 value, it will not be highlighted. If @code{nil}, always highlighted
7065 (ignore header size).
7067 @item wl-highlight-max-message-size
7068 @vindex wl-highlight-max-message-size
7069 The initial setting is 10000.
7070 If a message is larger than this value, it will not be highlighted.
7071 With this variable, highlight is suppressed for uuencode or huge digest
7074 @item wl-highlight-signature-separator
7075 @vindex wl-highlight-signature-separator
7076 Specifies regular expressions that denotes the boundary of a signature.
7077 It can be a regular expression, or a list of ones.
7078 Messages after the place that matches this regular expression are
7079 highlighted by the face specified by
7080 @code{wl-highlight-message-signature}.
7082 @item wl-max-signature-size
7083 @vindex wl-max-signature-size
7084 The initial setting is 400.
7085 This is the largest size for a signature to be highlighted.
7087 @item wl-use-highlight-mouse-line
7088 @vindex wl-use-highlight-mouse-line
7089 The initial setting is @code{t}.
7090 If non-nil, the line pointed by the mouse is highlighted in the folder
7091 mode, summary mode, and the like.
7094 @subsection Setting Colors and Fonts of the Characters
7096 If you want to change colors or fonts of the characters, you need to
7097 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7098 want to change fonts, and @code{set-face-foreground} for colors, and so
7099 on. You cannot write face settings in @file{.emacs}; write in
7102 For example, if you want to change the color for signatures to yellow,
7106 (set-face-foreground 'wl-highlight-message-signature "yellow")
7112 Faces defined in Wanderlust:
7115 @item wl-highlight-message-headers
7116 The face for field names of message headers.
7118 @item wl-highlight-message-header-contents
7119 The face for field bodies of message headers.
7121 @item wl-highlight-message-important-header-contents
7122 The face for important parts of message headers.
7123 Per default, this face is used for a body of @samp{Subject:} field.
7124 You can change its value by editing
7125 @code{wl-highlight-message-header-alist}.
7127 @item wl-highlight-message-important-header-contents2
7128 The face for secondly important parts of message headers.
7129 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7130 fields. You can change its value by editing
7131 @code{wl-highlight-message-header-alist}.
7133 @item wl-highlight-message-unimportant-header-contents
7134 The face for unimportant parts of message headers.
7135 Per default, this face is used for bodies of @samp{X-} fields
7136 @samp{User-Agent:} fields. You can change its value by editing
7137 @code{wl-highlight-message-header-alist}.
7139 @item wl-highlight-message-citation-header
7140 The face for headers of quoted messages.
7142 @item wl-highlight-message-cited-text-*
7143 The face for texts of quoted messages. The last @samp{*} is a
7144 @var{single figure} so that 10 different colors can be used according to
7147 @item wl-highlight-message-signature
7148 The face for signatures of messages. The initial settings are
7149 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7150 dark background colors.
7152 @item wl-highlight-header-separator-face
7153 The face for header separators of draft messages.
7155 @item wl-highlight-summary-important-face
7156 The face for message lines with important marks in the summary.
7158 @item wl-highlight-summary-new-face
7159 The face for message lines with new marks in the summary.
7161 @item wl-highlight-summary-displaying-face
7162 The face for the message line that is currently displayed.
7163 This face is overlaid.
7165 @item wl-highlight-thread-indent-face
7166 The face for the threads that is currently displayed.
7168 @item wl-highlight-summary-unread-face
7169 The face for message lines with unread marks in the summary.
7171 @item wl-highlight-summary-deleted-face
7172 The face for message lines with delete marks in the summary.
7174 @item wl-highlight-summary-refiled-face
7175 The face for message lines with re-file marks in the summary.
7177 @item wl-highlight-refile-destination-face
7178 The face for re-file information part of message lines with re-file
7179 marks in the summary.
7181 @item wl-highlight-summary-copied-face
7182 The face for message lines with copy marks in the summary.
7184 @item wl-highlight-summary-target-face
7185 The face for message lines with target marks @samp{*} in the summary.
7187 @item wl-highlight-summary-thread-top-face
7188 The face for message lines that are on the top of the thread in the
7191 @item wl-highlight-summary-normal-face
7192 The face for message lines that are not on top of the thread in the
7195 @item wl-highlight-folder-unknown-face
7196 The face for folders that are not known to have how many unsync messages
7199 @item wl-highlight-folder-zero-face
7200 The face for folders that have no unsync messages in the folder mode.
7202 @item wl-highlight-folder-few-face
7203 The face for folders that have some unsync messages in the folder mode.
7205 @item wl-highlight-folder-many-face
7206 The face for folders that have many unsync messages in the folder mode.
7207 The boundary between `some' and `many' is specified by the variable
7208 @code{wl-folder-many-unsync-threshold}.
7210 @item wl-highlight-folder-unread-face
7211 The face for folders that have no unsync but unread messages in the
7214 @item wl-highlight-folder-killed-face
7215 The face for folders that are deleted from the access group in the
7218 @item wl-highlight-folder-opened-face
7219 The face for open groups in the folder mode.
7220 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7221 @code{nil} or a @var{number}.
7223 @item wl-highlight-folder-closed-face
7224 The face for close groups in the folder mode.
7225 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7226 @code{nil} or a @var{number}.
7228 @item wl-highlight-folder-path-face
7229 The face for the path to the currently selected folder in the folder
7232 @item wl-highlight-logo-face
7233 The face for logo in the demo.
7235 @item wl-highlight-demo-face
7236 The face for strings (for example, a version number) in the demo.
7240 @node Biff, Advanced Settings, Highlights, Customization
7241 @section Notify Mail arrival
7244 Following setting is to notify mail arrival of @samp{%inbox}
7245 by the indicator on the modeline
7248 (setq wl-biff-check-folder-list '("%inbox"))
7251 @subsection Customizable Variables
7253 @item wl-biff-check-folder-list
7254 @vindex wl-biff-check-folder-list
7255 The initial setting is @code{nil}.
7256 This is the list of folders to check mail arrival.
7257 If @code{nil}, wl doesn't check mail arrival.
7259 @item wl-biff-check-interval
7260 @vindex wl-biff-check-interval
7261 The initial setting is 40 (in seconds).
7262 Check mail arrival in this period.
7264 @item wl-biff-notify-hook
7265 @vindex wl-biff-notify-hook
7266 This hook is run at the arrival of new mail.
7267 To beep with mail arrival(initial setting), set as follows.
7269 (setq wl-biff-notify-hook '(ding))
7271 For silence, set to @code{nil}.
7275 @node Advanced Settings, Customizable Variables, Biff, Customization
7276 @section Advanced Settings
7279 * Draft for Reply:: Draft for Reply
7280 * Thread Format:: Appearance of Thread
7281 * User-Agent Field:: @samp{User-Agent:} Header Field
7285 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
7286 @subsection Draft for Replay
7287 @vindex wl-draft-reply-with-argument-list
7288 @vindex wl-draft-reply-without-argument-list
7289 @vindex wl-draft-reply-myself-with-argument-list
7290 @vindex wl-draft-reply-myself-without-argument-list
7292 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
7293 The addressee for the draft is decided by following rules.
7295 For example, you can set as follows:
7299 (setq wl-draft-reply-without-argument-list
7300 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7301 ("Followup-To" . (nil nil ("Followup-To")))
7302 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7303 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
7307 Where each element of the list @code{wl-draft-reply-without-argument-list}
7311 (key . (to-list cc-list newsgroup-list))
7314 and if the field designated by @samp{key} exist in the parent message,
7315 parent's field values designated by @samp{to-list} are copied to @samp{To:}
7316 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
7317 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
7318 the draft respectively.
7323 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7326 Match if the parent has @samp{Mail-Followup-To} field.
7327 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
7328 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
7332 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7335 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
7336 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
7339 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
7342 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
7343 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
7346 These are evaluated in order and first matched one is used.
7348 Moreover, the behavior of @kbd{a} with prefix argument can
7349 be directed by @code{wl-draft-reply-with-argument-list} as well.
7351 By the way, you can use some function (will be evaluated in the parent
7352 message buffer) in the place of @samp{key} or @samp{to-list} etc.
7353 For example, if you only want to reply to mailing lists in
7354 @code{wl-subscribed-mailing-list} if the parent has some of them,
7359 (defun wl-mailing-list-addresses ()
7363 (nth 1 (std11-extract-address-components addr)))
7366 (elmo-multiple-fields-body-list (list "To" "Cc"))
7368 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
7369 (setq list-addrs (cons to list-addrs))))
7370 (nreverse list-addrs)))
7372 (setq wl-draft-reply-with-argument-list
7373 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
7374 ("Reply-To" . (("Reply-To") nil nil))
7375 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
7376 ("From" . (("From") nil nil))))
7381 Note: To set the behavior when you reply to the message written by yourself,
7382 use @code{wl-draft-reply-myself-without-argument-list} and
7383 @code{wl-draft-reply-myself-with-argument-list} instead of them.
7385 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
7386 @subsection Appearance of Threads
7390 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
7391 390 09/18(Fri)07:25 +-[ Tsumura-san ]
7392 391 09/18(Fri)19:24 +-[ Murata-san ]
7393 392 09/20(Sun)21:49 +-[ Okunishi-san ]
7394 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
7395 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
7396 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
7397 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
7398 412 09/22(Tue)09:28 | +-[ Teranishi ]
7399 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
7400 416 09/22(Tue)12:38 | +-[ Teranishi ]
7401 395 09/20(Sun)21:49 +-[ Okunishi-san ]
7402 397 09/21(Mon)00:15 +-[ Okunishi-san ]
7406 Settings to make appearance of threads like shown above:
7410 (setq wl-thread-indent-level 2)
7411 (setq wl-thread-have-younger-brother-str "+")
7412 (setq wl-thread-youngest-child-str "+")
7413 (setq wl-thread-vertical-str "|")
7414 (setq wl-thread-horizontal-str "-")
7415 (setq wl-thread-space-str " ")
7419 If you do not want to see branches, do the following:
7423 (setq wl-thread-indent-level 2)
7424 (setq wl-thread-have-younger-brother-str " ")
7425 (setq wl-thread-youngest-child-str " ")
7426 (setq wl-thread-vertical-str " ")
7427 (setq wl-thread-horizontal-str " ")
7428 (setq wl-thread-space-str " ")
7433 @node User-Agent Field, , Thread Format, Advanced Settings
7434 @subsection User-Agent Field
7438 If you are eccentric enough to elaborate @samp{X-Mailer:} or
7439 @samp{User-Agent:} fields, define a function that generate appropriate
7440 strings as you like, and set it to variable
7441 @code{wl-generate-mailer-string-function}.
7443 If you do not want verbose @samp{User-Agent:} field, do the following:
7447 (setq wl-generate-mailer-string-function
7448 'wl-generate-user-agent-string-1)
7452 The following is a example:
7456 (setq wl-generate-mailer-string-function nil)
7457 (setq wl-draft-additional-header-alist
7459 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
7464 @node Customizable Variables, Hooks, Advanced Settings, Customization
7465 @section Customizable Variables
7467 Customizable variables that have not been described yet:
7470 @item wl-default-folder
7471 @vindex wl-default-folder
7472 The initial setting is @samp{%inbox}. This is the default value for moving to
7473 a folder and the like.
7475 @item wl-draft-folder
7476 @vindex wl-draft-folder
7477 The initial setting is @samp{+draft}. It is the folder to which drafts are
7478 saved. It must be a localdir folder.
7480 @item wl-trash-folder
7481 @vindex wl-trash-folder
7482 The initial setting is @samp{+trash}. It is the wastebasket folder.
7483 If you changed this variable, you had better restart Wanderlust.
7485 @item wl-interactive-exit
7486 @vindex wl-interactive-exit
7487 The initial setting is @code{t}.
7488 If non-nil, you are asked for confirmation when Wanderlust terminates.
7490 @item wl-interactive-send
7491 @vindex wl-interactive-send
7492 The initial setting is @code{t}.
7493 If non-nil, you are asked for confirmation when mail is sent.
7495 @item wl-default-sync-range
7496 @vindex wl-default-sync-range
7497 The initial setting is @samp{update}.
7498 Default update range of the summary. You can specify
7499 @samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
7500 See description of @code{wl-summary-sync} for the meaning of ranges.
7502 @item wl-folder-sync-range-alist
7503 @vindex wl-folder-sync-range-alist
7504 The initial setting is the alist shown below:
7509 ("^\\+draft$\\|^\\+queue$" . "all"))
7514 This is an associative list of regular expressions of folder names and
7515 update range of the summary. Update range is one of the @samp{all},
7516 @samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
7517 match any of them, the value of @code{wl-default-sync-range} is used
7518 (@samp{update} by default).
7519 See description of @code{wl-summary-sync} for the meaning of ranges.
7522 @vindex wl-ask-range
7523 The initial setting is @code{t}.
7524 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
7525 for updating the summary when you changed folders.
7527 @item wl-mime-charset
7528 @vindex wl-mime-charset
7529 The initial setting is @code{x-ctext}.
7530 This is the MIME charset for messages that are not MIME (e.g. without
7531 @samp{Content-Type:}). This value also used as default charset for
7532 summary. (If you want to share Summary on Nemacs and other Emacsen, set
7533 this value as @code{iso-2022-jp}.)
7535 @item wl-highlight-folder-with-icon
7536 @vindex wl-highlight-folder-with-icon
7537 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
7538 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
7540 @item wl-strict-diff-folders
7541 @vindex wl-strict-diff-folders
7542 This is a list of regular expressions of folders.
7543 Unread messages are checked, for example when you press @kbd{s} in
7544 the folder mode, usually in a brief way (rapidly processed but not
7546 The folders matching this variable are seriously checked.
7547 You may want to set this variable so as to match conditional filter
7548 folders for IMAP4 folders.
7549 The initial setting is @code{nil}.
7551 @item wl-folder-use-server-diff
7552 @vindex wl-folder-use-server-diff
7553 When unread messages are checked, for example when you press @kbd{s} in
7554 the folder mode, usually (the number of messages on the server) @minus{}
7555 (the number of local messages) will be the number of unread messages.
7556 However, if this variable is non-nil, the number of unread messages on
7557 the server is checked. This affects IMAP4 folders only, but IMAP4
7558 folders in mail boxes matching
7559 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
7560 the number of unread messages on the server, even if they matches this
7561 variable. The initial setting is @code{t}.
7563 @item wl-auto-check-folder-name
7564 @vindex wl-auto-check-folder-name
7565 The initial setting is @code{nil}.
7566 You can specify a folder or a group which is checked for unread message
7567 at the start. You can also specify a list of folders (groups) to be checked.
7568 If the value is @code{nil}, whole Desktop is checked at the start.
7569 If it is @code{none}, no folders are checked.
7571 @item wl-auto-uncheck-folder-list
7572 @vindex wl-auto-uncheck-folder-list
7573 The initial setting is the list shown below:
7582 You can set a list of regular expressions to specify folders
7583 which are not automatically checked even if they are included
7584 in some groups assigned by @code{wl-auto-check-folder-name}.
7586 @item wl-auto-check-folder-list
7587 @vindex wl-auto-check-folder-list
7588 The initial setting is @code{nil}.
7589 You can set a list of regular expressions to specify exceptions
7590 for @code{wl-auto-uncheck-folder-list}.
7592 @item wl-no-save-folder-list
7593 @vindex wl-no-save-folder-list
7594 The initial setting is the list shown below:
7603 This is a list of regular expressions of folders not to be saved.
7605 @item wl-save-folder-list
7606 @vindex wl-save-folder-list
7607 The initial setting is @code{nil}.
7608 This is a list of regular expressions of folders to be saved.
7609 This takes precedence over @code{wl-no-save-folder-list}.
7611 @item wl-folder-mime-charset-alist
7612 @vindex wl-folder-mime-charset-alist
7613 The initial setting is the alist shown below:
7617 (("^-alt\\.chinese" . big5)
7618 ("^-relcom\\." . koi8-r)
7620 ("^-han\\." . euc-kr))
7625 This is an associative list of regular expressions of folder names and
7627 If a folder do not match, @code{wl-mime-charset} is used.
7629 @item wl-folder-init-load-access-folders
7630 @vindex wl-folder-init-load-access-folders
7631 The initial setting is @code{nil}.
7632 This is a list of access groups to be loaded specifically at the start.
7633 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7635 @item wl-folder-init-no-load-access-folders
7636 @vindex wl-folder-init-no-load-access-folders
7637 The initial setting is @code{nil}.
7638 This is a list of access groups not to be loaded specifically at the
7640 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7642 @item wl-delete-folder-alist
7643 @vindex wl-delete-folder-alist
7644 The initial setting is the alist shown below:
7653 This list determines disposition of messages with delete marks.
7654 Each item in the list is a folder and destination; you can specify any
7655 one of the following in the place of destination:
7658 @code{remove} or @code{null} : deletes the messages instantly.
7659 string : moves the messages to the specific folder.
7660 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7663 @item wl-refile-policy-alist
7664 @vindex wl-refile-policy-alist
7665 The initial setting is the list shown below:
7675 This list determines whether messages with re-file marks are moved or
7676 copied. Each item in the list is a cons cell of a folder and
7677 @code{copy} or @code{move}.
7679 @item wl-x-face-file
7680 @vindex wl-x-face-file
7681 The initial setting is @file{~/.xface}.
7682 The name of the file that contains encoded X-Face strings.
7685 @item wl-demo-display-logo
7686 @vindex wl-demo-display-logo
7687 If non-nil, bitmap image is shown on the opening demo. If you set
7688 @code{xpm} or @code{xbm}, (if possible) display selected image type
7691 @item elmo-use-database
7692 @vindex elmo-use-database
7693 This is meaningful for XEmacs only. The initial setting depends on
7694 XEmacs (@code{t} for XEmacs with dbm).
7695 If non-nil, Message-ID is controlled by dbm.
7697 @item elmo-passwd-alist-file-name
7698 @vindex elmo-passwd-alist-file-name
7699 The initial setting is @file{passwd}.
7700 This is the name of the file in which passwords are saved.
7701 @code{elmo-passwd-alist-save} saves current passwords to the file.
7703 @item elmo-nntp-list-folders-use-cache
7704 @vindex elmo-nntp-list-folders-use-cache
7705 The initial setting is 600 (in seconds).
7706 This is period in seconds during which results of @samp{list} and
7707 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7710 @item elmo-nntp-max-number-precedes-list-active
7711 @vindex elmo-nntp-max-number-precedes-list-active
7712 The initial setting is @code{nil}.
7713 If non-nil, the number of article obtained by @samp{list active} in NNTP
7714 are used as the maximum article number of the folder.
7715 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7716 and if the number of read messages is not correct.
7718 @item elmo-nntp-default-use-listgroup
7719 @vindex elmo-nntp-default-use-listgroup
7720 The initial setting is @code{t}.
7721 If non-nil, @samp{listgroup} is used for checking the total number of
7722 articles. If it is @code{nil}, @samp{group} is used. In the latter
7723 case, the processing will be a little faster at the sacrifice of
7726 @item elmo-pop3-send-command-synchronously
7727 @vindex elmo-pop3-send-command-synchronously
7728 The initial setting is @code{nil}.
7729 If non-nil, POP3 commands are issued synchronously. Some implementation
7730 of POP3 server fails to get summary information without this setting.
7731 You may have to set this variable to @code{t}, if the process hangs
7732 while looking up POP3.
7734 @item elmo-dop-flush-confirm
7735 @vindex elmo-dop-flush-confirm
7736 The initial setting is @code{t}.
7737 If non-nil, you are asked for confirmation if accumulated off-line
7738 operations are executed.
7740 @item elmo-display-progress-threshold
7741 @vindex elmo-display-progress-threshold
7742 The initial setting is 20.
7743 Threshold for display of progress gauge. If number of renewal is more than
7744 this value, display progress gauge.
7748 @node Hooks, , Customizable Variables, Customization
7753 @node Terminology, Mailing List, Customization, Top
7754 @chapter Terminology around Wanderlust
7757 Here we explain terminologies used in this manual.
7761 A container in which messages are stored.
7764 A set consists of some folders.
7767 A special group consists of automatically collected folders under
7768 some specified path.
7769 @xref{Folder Definition}.
7771 @item summary buffer
7772 A buffer for displaying list of messages in some folder.
7774 @item sticky summary
7775 Compared with ordinary summary buffer which will be destroyed after
7776 exiting from it, this type of summary will be remain even after exiting
7777 by @kbd{q} or @kbd{g}.
7778 @xref{Sticky Summary}.
7781 To delete or put into the archive expired messages.
7788 To cache messages beforehand in order to read messages after you will be
7789 disconnected from the server.
7793 @node Mailing List, Addition, Terminology, Top
7794 @chapter Wanderlust Mailing List
7798 Topics related to Wanderlust are discussed in following mailing lists.
7799 The latest version is also announced there.
7802 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7805 In this list Japanese is mainly used for discussion. We also have a list
7806 for discussion in English:
7809 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
7811 (Messages posted to this list are also forwarded to the former one.)
7813 A guide can be obtained automatically by sending mail to
7814 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
7815 the English one) with the body
7821 Please send bug reports or patches to one of those lists. You can post to
7822 the mailing list even though you are not a member of it.
7824 If you send a bug report, please attach Backtrace with it.
7825 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7828 I would like to express my thanks to the members of the mailing list for
7829 valuable advice and many pieces of code they contributed.
7832 @node Addition, Index, Mailing List, Top
7833 @chapter Additional Information
7835 @section Brief History
7838 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7839 3/10 Made a msgdb mechanism by elisp.
7840 3/26 IMAP and NNTP can be displayed in threads.
7841 4/13 Began to assemble thread display modules as elmo.
7842 5/01 Finished 0.1.0, initial version with many defects.
7843 6/12 I made a slip of the tongue and said I was writing elisp
7844 mailer supporting IMAP
7845 6/16 0.1.3 was announced at tm-ja, elisp ML.
7846 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7847 7/01 Support for mm-backend (0.3.0).
7848 8/25 multi folder added (0.5.0).
7849 8/28 filter folder added (0.5.1).
7850 9/10 You can open/close threads (0.6.0).
7851 9/11 fldmgr by Murata-san made editing folders easy.
7852 9/18 lha folders added by Okunishi-san (0.6.3).
7853 9/24 Display of branches of threads (0.6.5).
7854 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7855 10/28 Off-line operations (0.7.4).
7856 12/09 Becomes beta version.
7857 12/21 wl-expire by Murata-san.
7858 1999 2/03 auto-refile by Tsumura-san.
7859 4/28 wl-template by Murata-san.
7860 5/18 Released 1.0.0 stable.
7861 7/05 Scoring by Murata-san (2.1.0).
7862 9/26 New plugged system by Murata-san (2.2.2).
7863 12/20 Support Modified UTF7.
7864 2000 3/24 Released 1.1.0 stable.
7865 4/03 CVS development started.
7866 5/07 Thread restoration & Its speed up with Murata-san.
7867 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7868 7/11 killed message feature.
7869 7/18 Use UIDL in POP3.
7870 9/12 biff feature with Satata-san & Yamaoka-san.
7871 10/17 expire-hide by Okada-san.
7872 11/08 Released 2.4.0 stable.
7873 2001 7/04 Released 2.6.0 stable.
7874 8/21 wl-addrmgr by Kitamoto-san.
7875 12/27 Released 2.8.1 stable.
7876 2002 12/11 Released 2.10.0 stable.
7879 See @file{ChangeLog} for details.
7883 According to a dictionary, Wanderlust has the meaning:
7887 n eager longing for or impulse towards travelling in distant lands
7888 [Ger, fr wandern to wander + lust desire, pleasure]
7892 but I had no profound intention. (if farfetched, IMAP @result{} you can
7893 read mail anywhere @result{} desire to wander ?)
7895 Elmo is the abbreviation of @samp{Elisp Library for Message
7896 Orchestration}. At first I meant the red puppet in the Sesame Street,
7897 but you may associate it with Wandering @result{} Drifting @result{}
7898 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7902 Each versions has code names (they are almost jokes).
7903 Currently they are picked up alphabetically from the top 40 hits of
7904 U.S. Billboard magazines in 1980s.
7906 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7909 @node Index, , Addition, Top
7913 * Concept Index:: Concept Index
7914 * Key Index:: Key Index
7915 * Variable Index:: Variable Index
7916 * Function Index:: Function Index
7919 @node Concept Index, Key Index, Index, Index
7920 @unnumberedsec Concept Index
7923 @node Key Index, Variable Index, Concept Index, Index
7924 @unnumberedsec Key Index
7927 @node Variable Index, Function Index, Key Index, Index
7928 @unnumberedsec Variable Index
7931 @node Function Index, , Variable Index, Index
7932 @unnumberedsec Function Index