1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada},
25 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
27 This edition is for Wanderlust version @value{VERSION}.
29 Permission is granted to make and distribute verbatim copies of this
30 manual provided the copyright notice and this permission notice are
31 preserved on all copies.
34 Permission is granted to process this file through TeX and print the
35 results, provided the printed document carries copying permission notice
36 identical to this one except for the removal of this paragraph (this
37 paragraph not being relevant to the printed manual).
40 Permission is granted to copy and distribute modified versions of this
41 manual under the conditions for verbatim copying, provided that the
42 entire resulting derived work is distributed under the terms of a
43 permission notice identical to this one.
45 Permission is granted to copy and distribute translations of this manual
46 into another language, under the above conditions for modified versions.
52 @title Wanderlust User's Manual
53 @subtitle Yet another message interface on Emacsen
54 @subtitle for Wanderlust version @value{VERSION}
55 @author Yuuichi Teranishi
56 @author Fujikazu Okunishi
57 @author Masahiro Murata
59 @author Kaoru Takahashi
61 @author Masayuki Osada
62 @author Katsumi Yamaoka
64 @author Yoichi Nakayama
67 @vskip 0pt plus 1filll
68 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
69 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
70 @w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
71 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
73 This manual is for Wanderlust version @value{VERSION}.
75 Permission is granted to make and distribute verbatim copies of this
76 manual provided the copyright notice and this permission notice are
77 preserved on all copies.
79 Permission is granted to copy and distribute modified versions of this
80 manual under the conditions for verbatim copying, provided that the
81 entire resulting derived work is distributed under the terms of a
82 permission notice identical to this one.
84 Permission is granted to copy and distribute translations of this manual
85 into another language, under the above conditions for modified versions.
91 @node Top, Introduction, (dir), (dir)
92 @top Wanderlust User's Manual
107 This manual is for Wanderlust @value{VERSION}.
112 * Introduction:: Read this first
113 * Start Me Up:: Invoking Wanderlust
114 * Folders:: How to specify folders
115 * Folder:: Selecting and editing folders
116 * Summary:: Reading and refiling messages
117 * Message:: Saving and playing MIME multipart entities
118 * Draft:: Draft buffer, sending mail and news
119 * Disconnected Operations:: Off-Line management
120 * Expire and Archive:: Automatic expiration and archiving of messages
121 * Scoring:: Score of the messages
122 * Address Book:: Management of Address Book
123 * Customization:: Customizing Wanderlust
124 * Mailing List:: Wanderlust mailing list
125 * Addition:: Additional Information
130 @node Introduction, Start Me Up, Top, Top
131 @chapter Introduction of Wanderlust
134 Wanderlust is an mail/news management system on Emacsen.
135 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
137 The main features of Wanderlust:
140 @item Pure elisp implementation.
141 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
142 @item Unified access method to messages based on Mew-like Folder Specification.
143 @item Mew-like Key-bind and mark handling.
144 @item Manages unread messages.
145 @item Interactive thread display.
146 @item Folder Mode shows the list of subscribed folders.
147 @item Message Cache, Disconnected Operation (Read Only).
148 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
149 @item MIME compliant (by SEMI).
150 @item Transmission of news and mail are unified by Message transmitting draft.
151 @item Graphical list of folders (XEmacs and Emacs 21).
152 @item View a part of message without retrieving the whole message (IMAP4).
153 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
154 @item Virtual Folders.
155 @item Supports compressed folder using common archiving utilities.
156 @item Old articles in folders are automatically removed/archived (Expiration).
157 @item Automatic re-file.
158 @item Template function makes it convenient to send fixed form messages.
164 Wanderlust is supposed to run on following Emacsen:
167 @item Mule 2.3 based on Emacs 19.34
168 @item Emacs 20.2 or later
169 @item XEmacs 20.4 or later
170 @item Meadow 1.00 or later
171 @item NTEmacs 20.4 or later
175 IMAP4 connectivity with following imapd are confirmed to work with
179 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
180 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
181 @item Courier-IMAP 1.3.2 or later
182 @item AIR MAIL (AIRC imapd release 2.00)
184 @item Microsoft Exchange Server 5.5
185 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
188 LDAP connectivity with following LDAPd are confirmed to work with
192 @item OpenLDAP 2.0.6 or later
196 @node Start Me Up, Folders, Introduction, Top
197 @chapter Start up Wanderlust
200 The necessary procedure for starting Wanderlust is explained in steps
203 (Of course, you need a mail/news readable environment in advance)
206 * MIME Modules:: Installing the MIME modules
207 * Download:: Download and extract the packages
208 * Install:: Byte-compile and install
209 * Minimal Settings:: @file{.emacs} setup
210 * Folder Definition:: Folder definition
211 * Start Wanderlust:: Starting Wanderlust
215 @node MIME Modules, Download, Start Me Up, Start Me Up
216 @section Installing MIME modules
223 SEMI or tm must be installed to make Wanderlust work correctly.
225 SEMI does not run on Emacs 19.28 or earlier
226 @footnote{SEMI runs on Emacs 19.34. @*
227 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} describes how to.},
228 so you must install tm, the predecessor of SEMI. (tm version 8.7 or later
231 However, SEMI is recommended because of its wider functionality.
233 Refer to the documents of each package for detailed installation procedure.
235 SEMI and tm can be downloaded from these sites:
239 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
240 tm: http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
244 You need packages named APEL and FLIM to use SEMI.
245 You can download APEL and FLIM from following URLs:
249 APEL: ftp://ftp.m17n.org/pub/mule/apel/
250 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
254 You have to install APEL, FLIM and SEMI in this order. Generally,
255 @samp{make install} will do the job. (In XEmacs 21, @samp{make
258 Recommended combination of APEL, FLIM and SEMI are following:
261 @item APEL 10.3, FLIM 1.14.2 and SEMI 1.14.3
264 You can also use many other FLIM/SEMI variants. Combination of the
265 latest versions should work. For example, the following combination are
269 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
270 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
273 You have to re-install Wanderlust if you upgraded APEL, FLIM, SEMI or
277 @node Download, Install, MIME Modules, Start Me Up
278 @section Download and Extract the Package
281 You can download Wanderlust package from following sites:
285 ftp://ftp.gohome.org/wl/
288 Mirrored ftp/http sites:
292 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
293 http://www.jpl.org/elips/wl/
294 http://www.ring.gr.jp/archives/text/elisp/wl/
295 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
296 ftp://opaopa.org/pub/mirror/elisp/wl/
297 @c ftp://roguelife.org/pub/tsumura/wl/
301 Extract the obtained package to your working directory:
306 % tar zxvf wl-@var{version}.tar.gz
307 % cd wl-@var{version}
311 @subsection To use SSL (Secure Socket Layer)
316 SSL (Secure Socket Layer) can be used for
317 SMTP, IMAP, NNTP and POP connections in Wanderlust.
319 There are two ways to use SSL. One is to start SSL negotiation just
320 after the connection establishment (generic way). The other one is to
321 start SSL negotiation by invoking STARTTLS command in the each session.
323 To use the formal SSL (generic SSL), you must set @env{PATH} to the
324 directory that OpenSSL commands are installed.
326 To use the latter SSL(STARTTLS), you must install starttls package in
328 You can download starttls package from the following site.
331 ftp://opaopa.org/pub/elisp/
334 @node Install, Minimal Settings, Download, Start Me Up
335 @section Byte-compile and install
342 @subsection Installation
344 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
345 Set the Emacs's command name to @code{EMACS}.
346 Set package installation directory to @code{LISPDIR}.
347 Then, please execute following commands.
356 Destination directory is auto-probed if you leave @code{LISPDIR}
357 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
359 If you are using an Emacs variant which does not merge specified directory
360 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
361 then you will see the error message:
364 Cannot open load file: mime-setup
368 In this case, either add destination directories of custom, APEL, FLIM
369 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
370 @code{load-path} in @file{WL-CFG} in extracted directory.
372 If you want to use BBDB, then the necessary modules are byte-compiled
373 and installed when BBDB directory is added to @code{load-path}.
376 @subsection @file{WL-CFG}
378 Contents of the file @file{WL-CFG} is loaded under installation if a file
379 with that name exists in extracted directory. You can use @file{WL-CFG} to
380 configure @code{load-path} to extra packages such as SEMI if needed.
382 If you want to specify the install directory of Wanderlust related
383 files, then set following variables in @file{WL-CFG}
387 A directory to install WL modules.
388 This directory is relative directory from @code{LISPDIR}.
389 WL modules include @file{wl*.el}, @file{wl*.elc} files.
390 @c Modules under the directory @file{util/} are also installed if
391 @c it detected as necessary.
394 A directory to install ELMO modules.
395 This directory is relative directory from @code{LISPDIR}.
396 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
397 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
401 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
403 If you want to install ELMO related files under a sub-directory
404 such as "elmo" then add following to @file{WL-CFG}:
407 (setq ELMO_PREFIX "elmo")
410 @subsection Install as a XEmacs package
411 @cindex XEmacs package
412 @cindex XEmacs package install
413 @cindex Package, XEmacs
414 @cindex Package install, XEmacs
415 @c @cindex install-package
417 It is possible to install Wanderlust as one of packages of XEmacs (21.0
418 or later). Configuration for autoload and icon-path in local
419 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
422 Follow the next example to install Wanderlust as an XEmacs package.
428 % make install-package
432 package directory is auto-probed, if SEMI is installed.
433 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
435 @subsection Run in place
437 If wl and elmo directories are defined in @code{load-path}, then
438 byte-compilation and installation are not necessary to start Wanderlust.
439 For example, if package is extracted in @file{~/work}, Wanderlust can be
440 invoked with following setting in @file{~/.emacs}.
444 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
445 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
451 Manual is described in Info format. Please do following.
460 If you install Wanderlust as a XEmacs package, Info file is already
461 installed too, so there are no need of these commands.
463 Manual directory is automatically detected. Of course, it can be
464 configured by @code{INFODIR} in @file{Makefile}.
466 You can read manual at the following URL:
469 http://www.gohome.org/wl/doc/wl-euc_toc.html
472 @node Minimal Settings, Folder Definition, Install, Start Me Up
473 @section Set up .emacs
474 @cindex Minimal Settings
476 @cindex Configuration
480 The Wanderlust package contains two module groups.
483 @item ELMO (elmo-*.el)
484 These modules show everything as folders. This is the back-end for WL.
486 These modules controls the behavior of main body of Wanderlust.
487 They are also the front-end for ELMO.
490 You can customize the behavior of Wanderlust by changing the value
491 of environmental variables which begins with @code{elmo-} and @code{wl-}.
493 The minimal requirement for settings is as the following.
497 ;; @r{The setting to use SEMI}
498 (require 'mime-setup)
500 ;; @r{autoload configuration}
501 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
502 (autoload 'wl "wl" "Wanderlust" t)
503 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
505 ;; @r{Directory where icons are placed (XEmacs or Emacs 21).}
506 ;; @r{Default: @code{nil}.}
507 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
508 (setq wl-icon-dir "~/work/wl/etc")
510 ;; @r{SMTP server for mail posting. Default: @code{nil}}
511 (setq wl-smtp-posting-server "your.smtp.example.com")
512 ;; @r{NNTP server for news posting. Default: @code{nil}}
513 (setq wl-nntp-posting-server "your.nntp.example.com")
517 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
518 file exists). So it is convenient to gather Wanderlust specific settings
519 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
520 because you can't write them in @file{.emacs}
521 (if you write it to @file{.emacs}, you'll get an error).
524 All above described settings except @samp{(require 'mime-setup)} and autoload
525 configuration can be written in
528 @subsection @code{mail-user-agent}
529 @cindex Default Mailer
530 @cindex Mailer, Default
531 @vindex mail-user-agent
534 If you write following setting in you @file{.emacs}, you can
535 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
536 This means it enables you to run Wanderlust as a default mail composer
539 It is effective only when your Emacs can define @code{mail-user-agent}.
540 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
544 (autoload 'wl-user-agent-compose "wl-draft" nil t)
545 (if (boundp 'mail-user-agent)
546 (setq mail-user-agent 'wl-user-agent))
547 (if (fboundp 'define-mail-user-agent)
548 (define-mail-user-agent
550 'wl-user-agent-compose
559 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
560 @section Folder Definition
561 @cindex Folder Definition
564 You can skip this section because it is possible to add/edit the
565 subscribe folders from the buffer for list of folders.
566 @xref{Folder Manager}.
568 Define the folders you want to subscribe in file @file{~/.folders}. The
569 contents written in @file{~/.folders} become the folders which you
570 subscribe to as it is.
572 Format for @file{~/.folders} is very simple. Here is an example:
577 # @r{Lines begin with @samp{#} are comment.}
578 # @r{Empty lines are ignored}
580 # @var{folder name} "@var{folder nickname}"
581 # @r{(nicknames are not necessary)}
586 %#mh/Backup@@my.imap.example.com "Sent"
589 %#mh/spool/wl "Wanderlust ML"
590 %#mh/spool/elips "ELIPS ML"
591 %#mh/spool/apel-ja "APEL Japanese ML"
592 %#mh/spool/xemacs-beta "XEmacs beta"
593 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
594 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
597 # @r{If folder name ends with @samp{/}, that means an `access group',}
598 # @r{all subfolders automatically included in one folder group.}
600 %#mh/expire@@localhost /
601 # @r{All MH folders are included in one folder group.}
606 Each line contains one folder you want to read. The definition of
607 folders will be explained in detail in the next section.
609 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
610 become one folder group. One folder group is treated as a directory
611 which can be opened and closed in folder mode. It is convenient for
612 collecting some folders and putting them in order.
614 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
615 line and you have to write it that way (It is because the parser sucks).
617 There are two types of groups. One is like @samp{Emacsen} from above
618 example which the user chooses his favorite folders as a group.
620 The other one is @dfn{access group} like @samp{+ /} from above example.
621 It makes all the sub-folders in a folder to a group. (It differs from
622 the type of the folder. For example, @samp{+} followed by @samp{/}
623 makes entire MH sub-directories to one group)
625 This behavior is better understood if you try it and confirmed the
626 function first. You can write and try a small folder definition, so you
627 will know the idea of the folder function before writing the real one.
629 @node Start Wanderlust, , Folder Definition, Start Me Up
630 @section Start Wanderlust
631 @cindex Start Wanderlust
633 If installation and configuration worked well, you can invoke Wanderlust by
634 typing following command in Emacs.
641 After initialization, Folder Mode which shows the list of folders will appear.
642 That means the folders you defined in the @file{~/.folders} are listed
643 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
644 can skip folder checking.
647 @node Folders, Folder, Start Me Up, Top
648 @chapter Wanderlust's folders
651 This chapter describes the folder types which Wanderlust is able to handle.
653 Wanderlust uses ELMO as it's interface, so every folder types supported
654 by ELMO is usable in Wanderlust.
656 As of version @value{VERSION}, 11 types of folders are predefined. These are
657 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
658 Pipe and Internal folder types.
661 * IMAP Folder:: @samp{%} -- IMAP folder
662 * NNTP Folder:: @samp{-} -- NNTP folder
663 * MH Folder:: @samp{+} -- MH folder
664 * Maildir Folder:: @samp{.} -- Maildir folder
665 * News Spool Folder:: @samp{=} -- News spool folder
666 * Archive Folder:: @samp{$} -- Archive folder
667 * POP Folder:: @samp{&} -- POP folder
668 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
669 * Namazu Folder:: @samp{[} -- Namazu Folder
670 * Multi Folder:: @samp{*} -- Multi folder
671 * Filter Folder:: @samp{/} -- Filter folder
672 * Pipe Folder:: @samp{|} -- Pipe folder
673 * Internal Folder:: @samp{'} -- Internal folder
677 @node IMAP Folder, NNTP Folder, Folders, Folders
685 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
691 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
695 You can specify @code{login} (encoded password transmission),
696 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
697 authentication) or @code{clear} (or @code{nil}, plain password
698 transmission) as @var{authenticate-type}.
703 @var{username} -> The value of @code{elmo-imap4-default-user}.
704 Initial setting is @env{USER} environment variable or
705 @env{LOGNAME} environment variable or return value of
706 @code{(user-login-name)}.
707 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
708 Initial setting is "auth".
709 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
710 Initial setting is "localhost".
711 @var{port} -> The value of @code{elmo-imap4-default-port}.
712 Initial setting is 143.
715 You can omit the @var{hostname} from folder names if you set
716 @code{elmo-imap4-default-server} as your main IMAP server.
717 For example, you can specify a folder as @samp{foo%imap@@gateway} even
718 if you have to go through a firewall.
722 ;; @r{Example: imap4.exaple.org as main IMAP server}
723 (setq elmo-imap4-default-server "imap4.example.org")
727 SSL (Secure Socket Layer) connection will be used if a folder name ends
728 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
729 is @code{ssl}, SSL will be the default connection. If a folder name
730 ends with @samp{!!}, STARTTLS connection will be established. If the
731 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
732 STARTTLS will be the default connection.
736 ;; @r{Example: Use SSL connection}
737 (setq elmo-imap4-default-stream-type 'ssl)
741 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
742 authentication method, the password is sent in encoded form. But, if
743 your server is unable to receive an encoded password, authentication
744 will fall back to @code{clear} (that is, sending password in raw format)
745 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
746 authentication will fall back to @code{clear} without confirmation
747 (default value is @code{nil}).
751 ;; @r{Example: password in raw format}
752 (setq elmo-imap4-default-authenticate-type 'clear)
760 %inbox -> IMAP mailbox "inbox"
761 %#mh/inbox -> IMAP mailbox "#mh/inbox"
763 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
764 %inbox:hoge/clear@@server1
765 -> server1's IMAP mailbox "inbox"
766 of user "hoge", with plain password authentication
771 @subsection International mailbox names (Modified UTF7)
772 @cindex Modified UTF7
779 You can use international mailbox names in @var{mailbox} part, if you
780 are using Emacs which can treat unicode and
781 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
782 value is @code{nil}).
784 Currently, following Emacsen can treat unicode.
787 @item Emacs 20.3 or later + Mule-UCS
789 If you installed Mule-UCS package, Emacs can treat unicode.
790 You can obtain Mule-UCS package from following URL.
793 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
796 @item XEmacs 21.2.13 or later + ucs-conv package
798 By default, XEmacs 21 cannot treat unicodes, but if you installed
799 ucs-conv package, it can.
800 You can obtain ucs-conv package from following anonymous CVS.
804 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
805 Password: @var{NULL} (Just enter return key)
806 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
810 You also need utf7 conversion programs, @command{u7tou8} and
811 @command{u8tou7} to use international mailbox name in the current
812 XEmacs. These programs are included in the UTF7 package which can be
813 obtained from following URL.
816 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
821 @node NNTP Folder, MH Folder, IMAP Folder, Folders
832 A folder to access USENET news via NNTP protocol (RFC 977).
833 One newsgroup is treated as a folder.
839 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
845 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
846 Initial setting is @samp{localhost}.
847 @var{username} -> The value of @code{elmo-nntp-default-user}.
848 Initial setting is @code{nil}.
849 @var{port} -> The value of @code{elmo-nntp-default-port}.
850 Initial setting is 119.
853 AUTHINFO is used as authentication method if the @var{username} is
854 non-nil. SSL will be default method if
855 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
856 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
857 STARTTLS connection will be established. if the value of
858 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
859 be the default connection.
865 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
866 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
871 @node MH Folder, Maildir Folder, NNTP Folder, Folders
878 A folder to access MH format mail (1 file is 1 mail).
883 @samp{+} @var{directory-name}
886 Normally, @var{directory-name} is an relative path to the variable
887 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
888 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
889 (this is also true for drive-letters).
891 Message number is used for the name of the message file.
897 +inbox -> @file{~/Mail/inbox}
898 +from/teranisi -> @file{~/Mail/from/teranisi}
899 +~/test -> @file{~/test}
904 @node Maildir Folder, News Spool Folder, MH Folder, Folders
905 @section Maildir Folder
907 @cindex Maildir Folder
911 A folder to access Maildir format (1 file is 1 mail).
916 @samp{.} [@var{directory-name}]
919 Normally, @var{directory-name} is a relative path to the variable
920 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
921 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
922 (this is also true for drive-letters).
924 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
925 Messages are contained in the @file{cur} directory. All message files
926 in the @file{new} directory are moved to @file{cur} directory when you
927 access the folder. All message files contained in the @file{tmp}
928 directory and not accessed for 36 hours are deleted.
930 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
936 . -> @file{~/Maildir}
937 .inbox -> @file{~/Maildir/inbox}
938 .from/teranisi -> @file{~/Maildir/from/teranisi}
939 .~/test -> @file{~/test}
944 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
945 @section News Spool Folder
947 @cindex News spool Folder
950 This folder handles locally saved news articles which are proposed by
951 Mew/IM. You can also read articles directly from a spool-file which is
952 retrieved by an utility like @command{gnspool}.
957 @samp{=} @var{directory-name}
960 @var{directory-name} is a sub-directory to the directory defined by
961 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
962 You can use @samp{.} as directory delimiter as well as @samp{/}.
968 =fj/os/os2 -> @file{~/News/fj/os/os2}
969 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
974 @node Archive Folder, POP Folder, News Spool Folder, Folders
975 @section Archive Folder
977 @cindex Archive Folder
980 This method can handle archive files, which are compressed by utilities
981 such as Info-ZIP or LHA, as one folder.
987 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
991 @var{path-name} is the relative path from
992 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
993 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
994 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
995 also permitted under the environment of ange-ftp, efs.
997 The actual file name of the archive folder is
998 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
999 under the @var{path-name}. If a file named @var{path-name} exists, it is
1000 treated as folder. The suffix is automatically decided for
1001 @var{archiver-type}.
1003 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1004 (Initial setting is @code{zip}) is referred.
1006 @var{prefix} specifies the internal directory structure of the archive.
1007 For example, if the ML server is fml, @file{msend.tar.gz} has a
1008 structure like @file{spool/1}, so you have to specify @samp{spool} as
1015 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1016 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1017 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1018 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1023 * Archiver:: Supported Archivers
1024 * Archive Tips:: TIPS
1025 * Archive Vars:: Customization
1029 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1030 @subsection Supported Archives
1040 By default, following archives are supported.
1044 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1045 GNU TAR('tgz, 'tar) ;; read-only
1049 If your archiver can include multiple files in one archive, you have a
1050 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1051 of the candidate. TAR is supported read-only because it cannot delete
1052 file in the archive (@code{mv})).
1054 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1055 archiver of Wanderlust because they cannot include multiple
1056 files. Archivers that cannot extract files to standard output are also
1059 @subsection OS specific information about archiver.
1061 Behaviors of the following archivers are confirmed by further experiences.
1062 (@samp{*} mark means recommended archiver).
1065 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1066 LHA OS/2 version Rel.2.06b Feb 18, 1998
1067 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1068 *Zip 2.2 (November 3rd 1997).
1069 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1070 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1071 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1073 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1074 LHa for UNIX V 1.14c
1075 UnZip 5.32 of 3 November 1997
1076 Zip 2.2 (November 3rd 1997)
1077 GNU tar 1.12 (1.11.x is no good)
1078 gzip 1.2.4 (18 Aug 93)
1080 [Win32] Win.98/Meadow
1084 GNU tar 1.11.8 + 1.5(WIN32)
1091 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1092 Hiramatsu version of LHA is only supported.
1093 In Win32, LHa32 is only supported (DOS version is no good).
1095 * Caution about GNU tar
1097 You have to take care about GNU tar's version because many version has
1098 problem on deleting file from archive.
1100 Please test @option{--delete} @option{-f} options work. Otherwise, your
1101 archive will be destroyed. No problem is reported on above versions of
1105 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1107 @cindex Archive Tips
1109 For comfortable migration, usage of @code{wl-summary-archive}
1110 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1111 archive folders created by expiration, you must set non-nil value to
1112 @code{elmo-archive-treat-file}.
1114 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1115 in processing speed. For comfortable use, Emacs20 is recommended.
1116 (If re-search's performance is the problem, 19.3x or later may be okay.)
1118 If many files are included in one archive,
1119 it takes long time to access the archive folder because
1120 archiver starting overhead is increased (especially LHA).
1121 150-200 messages in one archive is recommended.
1123 Of course, following is possible @t{:-)}
1124 (meanings of these variables are described later.)
1128 (setq wl-fcc "$backup")
1129 (setq wl-trash-folder "$trash;lha")
1133 @node Archive Vars, , Archive Tips, Archive Folder
1134 @subsection Variables About Archive Folder
1135 @cindex Archive variables
1138 @item elmo-archive-default-type
1139 @vindex elmo-archive-default-type
1140 The initial setting is @code{zip}.
1141 Set archiver type by symbol.
1143 @item elmo-archive-@var{type}-method-alist
1144 @vindex elmo-archive-TYPE-method-alist
1145 Define archiver @var{type}'s methods.
1146 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1147 Each element of the alist is following.
1151 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1152 (@var{action} . @var{function}) ;; function
1156 Currently available actions are following.
1160 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1161 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1168 actions enclosed with braces are optional (They are used for better
1171 @item elmo-archive-suffix-alist
1172 @vindex elmo-archive-suffix-alist
1173 An alist of archiver-type (symbol) and suffix.
1175 @item elmo-archive-file-regexp-alist
1176 @vindex elmo-archive-file-regexp-alist
1177 An alist of a regexp to get file number from list output of archiver
1178 and archiver-type (symbol).
1180 @item elmo-archive-method-list
1181 @vindex elmo-archive-method-list
1182 A list of elmo-archive-@var{type}-method-alist
1183 (@var{type} is a symbol of archiver-type).
1185 @item elmo-archive-lha-dos-compatible
1186 @vindex elmo-archive-lha-dos-compatible
1187 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1188 DOS (Mr. Yoshizaki original) compatible.
1190 @item elmo-archive-cmdstr-max-length
1191 @vindex elmo-archive-cmdstr-max-length
1192 The initial setting is 8000.
1194 Max length of command line argument for external archiver program.
1195 Emacs does not have a limit of command line byte length, but some OS
1196 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1197 this limit because it calls external archiver program directly (not
1198 called via shell). For example, you cannot delete messages if archiver
1199 program must receive larger bytes of arguments to delete. OS/2 have a
1200 command line argument limit of 8190 bytes, so we defined default as 8000
1203 However, you don't have an influence of command line argument limit
1204 if the archiver has `actions' to receive target file information from
1205 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1209 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1217 A folder to access e-mails via POP3 protocol (RFC 1939).
1223 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1228 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1229 as @var{authenticate-type}.
1233 @var{username} -> The value of @code{elmo-pop3-default-user}.
1234 Initial setting is @env{USER} environment variable or
1235 @env{LOGNAME} environment variable or return value of
1236 @code{(user-login-name)}.
1237 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1238 Initial setting is @samp{user}.
1239 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1240 Initial setting is @samp{localhost}.
1241 @var{port} -> The value of @code{elmo-pop3-default-port}.
1242 Initial setting is 110.
1249 &hoge@@localhost -> access localhost as user @samp{hoge}.
1250 &hoge@@popserver:109 -> access the server "popserver" on port 109
1251 as user @samp{hoge}.
1255 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1256 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1257 @file{utils/sasl/lisp/} or Emacs/W3 package
1258 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1261 If the last character of the folder name is @samp{!}, Wanderlust
1262 connects to the POP server via SSL (Secure Socket Layer). If you set
1263 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1264 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1265 with @samp{!!}, STARTTLS connection will be established. if the value
1266 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1270 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1271 @section Shimbun Folder
1273 @cindex Shimbun Folder
1274 @cindex Folder, Shimbun
1279 A folder for watching "shimbun" (means "newspaper" in Japanese),
1280 news site and mailing list archives on WWW by using emacs-w3m
1281 (@uref{http://emacs-w3m.namazu.org/}).
1283 You should possess w3m and emacs-w3m to use this.
1289 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1293 Admissible values of @var{module-name} and @var{folder-name} are
1294 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1300 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1301 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1306 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1307 @section Namazu Folder
1309 @cindex Namazu Folder
1310 @cindex Folder, Namazu
1311 @cindex Folder, Text Search
1314 A folder to access messages found in namazu-index with some condition.
1315 It uses namazu (@uref{http://www.namazu.org/}) for search.
1321 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1326 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1327 @section Multi Folder
1329 @cindex Multi Folder
1330 @cindex Folder, Multiple
1331 @cindex Folder, Marge
1333 A folder to access virtual folder which collects messages from
1340 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1344 After @samp{*} character, specify multiple folders you want to collect
1345 separated by @samp{,} like
1346 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1352 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1353 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1354 treated as one folder.
1356 *+inbox,-fj.rec.tv,%inbox
1357 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1362 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1363 @section Filter Folder
1365 @cindex Filter Folder
1366 @cindex Folder, Filtering
1367 @cindex Folder, Virtual
1368 @cindex Folder, Conditional
1370 A folder to access virtual folder which collects all messages that
1371 satisfy a condition.
1376 @samp{/} @var{condition} @samp{/} @var{target-folder}
1379 In the @var{condition} part, you can specify following.
1383 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1385 first: @var{number} messages are picked from top of folder.
1386 last: @var{number} messages are picked from bottom of folder.
1392 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1393 /first:20/%inbox -> First 20 messages from %inbox are picked.
1398 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1400 since: only messages arrived since @var{date} are picked.
1401 before: only messages arrived before @var{date} are picked.
1403 You can specify following as @var{date}.
1407 yesterday -> a day before today.
1408 lastweek -> same day of last week.
1409 lastmonth -> same day of last month.
1410 lastyear -> same day of last year.
1411 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1412 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1420 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1422 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1428 Field filter: @samp{@var{field}:@var{value}}
1430 All messages that have @var{field} and its value is @var{value} are picked.
1431 @var{field} and @var{value} are case insensitive.
1437 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1438 and its value includes "teranisi" string are picked.
1439 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1447 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1448 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1450 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1451 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1457 /from:teranisi&!to:teranisi/+inbox
1458 -> In +inbox, messages are picked if the message's
1459 From: field includes "teranisi" and
1460 To: field doesn't include "teranisi".
1462 /tocc:"Yuuichi Teranishi"/+inbox
1463 -> In +inbox, messages are picked if the
1464 message's To: field or Cc: field includes
1465 "Yuuichi Teranishi".
1467 /(from:yt|from:teranisi)&subject:report/+inbox
1468 -> In +inbox, messages are picked if the message's
1469 From: field includes "yt" or "teranisi", and
1470 Subject includes "report".
1476 Tip for string description:
1478 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1479 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1480 should be escaped with @samp{\} in it). You can enclose the string with
1481 @samp{"} even it does not contain these characters.
1487 *%inbox,/from:teranisi/%inbox@@server
1488 -> Messages in %inbox or
1489 message is in the %inbox@@server folder and it's From field
1490 includes "teranisi" are collected.
1492 /last:100//to:teranisi/*+inbox,%inbox
1493 -> Latest 100 messages which is in the +inbox or %inbox folder
1494 and To: field matches "teranisi".
1496 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1497 -> Pick messages which have From: field and it includes "hogehoge"
1498 from latest 20 messages in the %#mh/inbox@@localhost
1499 and To: or Cc: field includes "teranisi".
1502 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1503 @section Pipe Folder
1507 @cindex Download Message
1508 @cindex Incorporate Message
1510 In the pipe folder, messages are automatically transferred from the source
1511 folder to destination folder.
1516 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1519 When you access the pipe folder, messages are automatically transferred
1520 from @var{source-folder} to @var{destination-folder}.
1521 It is convenient if you want to download messages to local disk via POP.
1522 For example, if you specify following
1525 |&username@@popserver|+inbox
1529 and access it, messages are downloaded automatically from
1530 @samp{&username@@popserver} to @samp{+inbox}.
1536 %inbox|%myinbox -> Download %inbox to %myinbox.
1537 *&user@@popserver1,&user@@popserver2|+inbox
1538 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1542 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1544 @node Internal Folder, , Pipe Folder, Folders
1545 @section Internal folder
1547 @cindex Internal Folder
1548 @cindex Folder, @samp{$} mark
1550 @c @cindex Folder, Null
1552 A folder to access internal messages of Wanderlust.
1564 A folder named @samp{'mark} is a special virtual folder which collects
1565 messages which have important mark @samp{$}.
1567 You can review important messages at once after you put important marks
1568 on the messages in the different folders.
1570 In this folder, if you delete message, important mark @samp{$} put on
1571 the message is removed. If you append messages to this folder, the
1572 message will have @samp{$} mark.
1574 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1575 folder. If you want IMAP folder's message remove from @samp{'mark}
1576 folder, remove important mark at IMAP Folder.)
1578 You can access cached messages fetched via network by accessing
1579 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1580 the name of the subdirectories of the cache directory
1581 (@file{~/.elmo/cache}).
1584 @node Folder, Summary, Folders, Top
1585 @chapter Folder mode
1588 After you start Wanderlust, folder mode is appeared firstly.
1589 It contains folder list you subscribed.
1590 You can select and edit folders in this mode.
1593 * Selecting Folder:: Select folder you want to read
1594 * Folder Manager:: Editing folders
1598 @node Selecting Folder, Folder Manager, Folder, Folder
1599 @section Selecting Folder
1600 @cindex Selecting Folder
1602 @subsection Usage (TIPS)
1604 @subsubsection Check new, unread number
1606 Folder mode looks like this.
1607 (In XEmacs, it looks much nicer @t{;-)})
1611 [-]Desktop:14186/35580/67263
1616 [-]Emacsen:0/34/4837
1617 Wanderlust ML:0/0/558
1620 XEmacs Beta:0/29/255
1631 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1635 @kbd{s} key on the folder line updates these numbers.
1636 It changes its color if it has many new messages.
1638 The whole folder mode is a folder group named @samp{Desktop}.
1639 Folder group open/close by return key.
1640 A operation to a folder group is treated as operations on the
1642 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1643 six children folders update its unread number status.
1645 @subsubsection Select Folder
1647 To enter summary mode of the folder, type return (or space) key on
1649 If the variable @code{wl-stay-folder-window} has non-nil value,
1650 summary window appears on the right of the folder mode window.
1652 @subsection Key bindings
1654 Folder mode's key binding (related to selecting folders) is following.
1659 @kindex @key{SPC} (Folder)
1660 @kindex @key{RET} (Folder)
1661 @findex wl-folder-jump-to-current-entity
1662 Enter to the summary mode of the folder at the current cursor point.
1663 If the cursor is on the top of folder group line,
1664 the folder group is opened or closed.
1665 When the cursor is on the access group and this command is called
1666 with prefix argument, folder children list is updated to the newest one.
1667 (Children list is updated recursively if the access folder has hierarchical
1669 (@code{wl-folder-jump-to-current-entity})
1672 @kindex M-@key{RET} (Folder)
1673 @findex wl-folder-update-recursive-current-entity
1674 Folder children list of the access group at the current cursor point
1675 is updated to the newest one.
1676 (Children list is updated recursively if the access folder has hierarchical
1678 (@code{wl-folder-update-recursive-current-entity})
1683 Create a new draft message.
1688 @findex wl-folder-write-current-folder
1689 If the current cursor point is on the NNTP folder, create a new draft
1690 message which already has @samp{Newsgroups:} field. If the current
1691 cursor point is on the folder for mailing list (refile destination),
1692 create a new draft message which already has @samp{To:} field with
1693 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1695 (@code{wl-folder-write-current-folder})
1698 @kindex C-c C-o (Folder)
1699 @findex wl-jump-to-draft-buffer
1700 Move to the draft buffer if available. If multiple draft buffer exists,
1701 moved to one after another. If prefix argument is specified, load draft
1702 folder's message to the draft buffer and jump to it.
1703 (@code{wl-jump-to-draft-buffer})
1707 @findex wl-folder-check-current-entity
1708 Update new and unread number information of the folder at the current
1710 (@code{wl-folder-check-current-entity})
1714 @findex wl-folder-sync-current-entity
1715 Update summary information of the folder at the current cursor point.
1716 (@code{wl-folder-sync-current-entity})
1719 @kindex r s (Folder)
1720 @findex wl-folder-check-region
1721 Update new and unread number information of the folders in the currently
1723 (@code{wl-folder-check-region})
1726 @kindex r S (Folder)
1727 @findex wl-folder-sync-region
1728 Update summary information of the folders in the currently selected region.
1729 (@code{wl-folder-sync-region})
1733 @findex wl-status-update
1734 Sync up address book status with @file{~/.addresses}'s content.
1735 (@code{wl-status-update})
1739 @findex wl-folder-prev-unread
1740 Jump cursor to the folder which have unread messages on the upward from
1741 current cursor point.
1742 (@code{wl-folder-prev-unread})
1746 Jump cursor to the folder which have unread messages on the downward
1747 from current cursor point.
1748 (@code{wl-folder-next-unread})
1752 Move cursor to the folder on the previous line.
1753 (@code{wl-folder-prev-entity})
1757 Move cursor to the folder on the next line.
1758 (@code{wl-folder-next-entity})
1762 Jump to the folder specified by the user input.
1763 (@code{wl-folder-jump-folder})
1767 @findex wl-folder-prefetch-current-entity
1768 Prefetch new messages of the folder at the current cursor point by
1769 @code{wl-summary-incorporate}.
1770 If the cursor is on the folder group, it is executed recursively.
1771 (@code{wl-folder-prefetch-current-entity})
1775 @findex wl-folder-mark-as-read-all-current-entity
1776 Mark all unread messages of the folder at the current cursor point as read.
1777 If the cursor is on the folder group, it is executed recursively.
1778 (@code{wl-folder-mark-as-read-all-current-entity})
1782 @findex wl-folder-goto-first-unread-folder
1783 Enter summary mode of the first unread folder.
1784 (@code{wl-folder-goto-first-unread-folder})
1788 @findex wl-folder-empty-trash
1790 (@code{wl-folder-empty-trash})
1794 @findex wl-folder-open-all-unread-folder
1795 All unread folder is opened.
1796 (@code{wl-folder-open-all-unread-folder})
1800 @findex wl-folder-open-close
1801 Folder group is opened/closed.
1802 (@code{wl-thread-open-close})
1806 All folder group is opened.
1807 (@code{wl-folder-open-all})
1811 All folder group is closed.
1812 (@code{wl-folder-close-all})
1822 (@code{wl-folder-suspend})
1825 @kindex M-s (Folder)
1826 Save current folder status.
1830 @kindex M-t (Folder)
1831 Toggle Wanderlust's offline/online status.
1832 (@code{wl-toggle-plugged})
1835 @kindex C-t (Folder)
1836 Start Wanderlust's plug-status manager.
1837 (@code{wl-plugged-change})
1840 @subsection Customize variables
1843 @item wl-folders-file
1844 @vindex wl-folders-file
1845 The initial setting is @file{~/.folders}.
1846 Subscribed folders are described (saved) in this file.
1848 @item wl-folder-info-save
1849 @vindex wl-folder-info-save
1850 The initial setting is @code{t}. If non-nil, unread information is
1851 saved and used in the next Wanderlust session.
1853 @item wl-stay-folder-window
1854 @vindex wl-stay-folder-window
1855 The initial setting is @code{nil}.
1856 If non-nil, summary window is appeared on the right side of the folder buffer.
1858 @item wl-folder-window-width
1859 @vindex wl-folder-window-width
1860 The initial setting is 20.
1861 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1863 @item wl-folder-use-frame
1864 @vindex wl-folder-use-frame
1865 The initial setting is @code{nil}.
1866 If non-nil, use new frame for the folder window.
1868 @item wl-folder-many-unsync-threshold
1869 @vindex wl-folder-many-unsync-threshold
1870 The initial setting is 70.
1871 If the number of unread messages is more than this value,
1872 folder color is changed.
1874 @item wl-highlight-folder-by-numbers
1875 @vindex wl-highlight-folder-by-numbers
1876 This option controls how to highlight each line in the folder buffer.
1877 The default value is @code{t}, highlighting with various colors based on
1878 the message numbers. If it is @code{nil}, highlighting with various
1879 colors based on the folder status. In addition, if it is a number
1880 (e.g. 1), highlighting will be done based on both the message numbers
1881 and the folder status.
1883 @item wl-folder-desktop-name
1884 @vindex wl-folder-desktop-name
1885 The initial setting is @samp{Desktop}.
1886 The name of top folder group.
1888 @item wl-folder-petname-alist
1889 @vindex wl-folder-petname-alist
1890 The initial setting is @code{nil}.
1891 An alist of folder's realname and its nickname.
1893 @item wl-folder-access-subscribe-alist
1894 @vindex wl-folder-access-subscribe-alist
1895 The initial setting is @code{nil}.
1897 Control automatic subscribing and unsubscribing of the children list
1903 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1907 If @var{subscribe-flag} is non-nil, folders which have name matched to
1908 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1909 already unsubscribed folder is not displayed even when the
1910 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1917 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1918 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1919 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1920 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1924 @item wl-folder-hierarchy-access-folders
1925 @vindex wl-folder-hierarchy-access-folders
1926 The initial setting is the list shown below:
1935 A list of access groups which creates children folder list hierarchically.
1937 For example, if you specify
1938 @code{wl-folder-hierarchy-access-folders} like following,
1942 (setq wl-folder-hierarchy-access-folders
1943 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1948 such access group hierarchy is obtained.
1954 -fj.comp.announce:0/0/2
1955 -fj.comp.dev.cdrom:0/0/0
1957 [+]-japan:238/238/1688
1960 -comp.unix.admin:0/0/0
1961 -comp.unix.dos-under-unix:0/0/0
1962 -comp.unix.programmer:0/0/0
1963 [-]-comp.unix.bsd:0/0/23
1964 -comp.unix.bsd.freebsd.announce:0/0/0
1969 If you opened @samp{-} in this example, only the direct children is created
1970 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1971 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1972 is not created until the children access group is opened.
1976 @node Folder Manager, , Selecting Folder, Folder
1977 @section Editing Folders
1978 @cindex Folder Manager
1979 @cindex Folder, Edit
1980 @cindex Folder, Subscribe
1981 @cindex Folder, Unsubscribe
1983 As described before, subscribed folder list is saved in @file{~/.folders} file.
1984 But you don't have to edit @file{~/.folders} directly.
1985 You can append, delete, edit folders from folder mode.
1987 @subsection Usage (Tips)
1989 @subsubsection Append Folder
1991 @kbd{m a} appends new folder to the folder mode.
1992 @kbd{m g} appends new folder group.
1993 To append new folder to this group, firstly open it,
1994 then execute append command in the next line.
1996 @subsubsection Edit Folder
1998 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1999 Thus, you can change folder position as if you were editing a normal file.
2001 @subsubsection Create Multi Folder.
2005 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2007 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2009 Type @kbd{m m}, then you can create multi folder.
2012 @subsubsection Delete Nickname, Filter
2014 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2015 minibuffer while appending.
2017 @subsubsection Append Folder to Empty Group
2019 To append new folder to the empty folder group
2020 (after you create folder group by typing @kbd{m g}),
2021 firstly open it, then execute append command in the next line.
2022 If it is closed, folder is appended on the same level with
2023 the above folder group. It is difficult to explain by words so try it.
2024 In other words, appended position depends on the
2025 above folder group's open/close status.
2027 @subsubsection Charset of the Folders File.
2029 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2031 @subsubsection Create Filter
2033 @kbd{m f} adds filter to the folder at the current cursor point. To
2034 create new filter folder and leave the current folder unchanged, copy it
2035 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2036 filter can be specified while appending filter. If you put
2037 ``''(@var{NULL}), filter is deleted.
2039 @subsubsection Sort Folders
2041 Sorting of the folders is executed by the function specified by
2042 @code{wl-fldmgr-sort-function}.
2043 The initial setting is @code{wl-fldmgr-sort-standard},
2044 which sorts alphabetically.
2045 Sorting affects only on the current folder group. It does not
2046 affect on the child groups.
2048 @subsubsection Hiding Folders in the Access Group
2050 Usually, access group displays all children folders, but you can set
2051 some folders hidden. Following operations are only available on access
2054 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2055 (subscribe/unsubscribe) of the folder at current cursor point. Against
2056 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2059 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2060 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2061 argument and if the argument has positive number, the unsubscribe it.
2062 If the prefix argument has negative value, folder becomes visible and if
2063 zero, folder visibility is toggled.
2065 The other commands, @code{wl-fldmgr-subscribe} and
2066 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2069 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2070 executed in the access group, they have a same effect with
2071 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2072 The difference is that cut commands deletes folders from the current
2075 @subsubsection Operations in the Access Group
2077 You can insert and delete folders in the access group like usual folder
2078 group. But insert and delete commands can be only available for the
2079 children folders of the access group and they only sets the subscribe
2080 status. In other words, insertion of the folder means subscribing,
2081 deletion means unsubscribing.
2082 @footnote{In the current implementation,
2083 it is faster to delete region than to unsubscribe region.}
2085 To update the access group when children folders are inserted or deleted
2086 by other way (other than Wanderlust),
2087 open the access group by typing @kbd{C-u @key{RET}}.
2088 @xref{Selecting Folder}.
2090 The order of children folders of access group is saved after
2091 insertion/deletion/sorting.
2092 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2093 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2094 newly created folders are inserted on the top of the access group.
2096 @subsection Key bindings
2097 @cindex Keybind, Folder Mode
2098 @cindex Keybind, Folder Buffer
2100 Key bindings on the folder mode related to folder editing are shown below.
2101 All bindings starts with @kbd{m}, and primary commands are binded to
2102 one stroke key binding.
2106 @kindex m a (Folder)
2107 @findex wl-fldmgr-add
2109 (@code{wl-fldmgr-add})
2114 @kindex m g (Folder)
2115 @findex wl-fldmgr-make-group
2116 Create a folder group.
2117 (@code{wl-fldmgr-make-group})
2120 @kindex m A (Folder)
2121 @findex wl-fldmgr-make-access-group
2122 Create an access group.
2123 (@code{wl-fldmgr-make-access-group})
2126 @kindex m d (Folder)
2127 @findex wl-fldmgr-delete
2128 Delete folder itself and msgdb.
2129 If the folder itself cannot be deleted like NNTP folder,
2130 only msgdb is deleted.
2131 (@code{wl-fldmgr-delete})
2136 @kindex m R (Folder)
2137 @findex wl-fldmgr-rename
2138 Change the name of folder or folder group.
2139 msgdb's path is also changed.
2140 (@code{wl-fldmgr-rename})
2146 @findex wl-fldmgr-make-multi
2147 Create a multi folders in the cutlist (cut, copied folders).
2148 (@code{wl-fldmgr-make-multi})
2153 @kindex m f (Folder)
2154 @findex wl-fldmgr-make-filter
2155 Create a filter folder. (Put a filter on the folder).
2156 (@code{wl-fldmgr-make-filter})
2160 @kindex M-c (Folder)
2161 @kindex m c (Folder)
2162 @findex wl-fldmgr-copy
2163 Copy folder (it is not available on folder group).
2164 (@code{wl-fldmgr-copy})
2168 @kindex M-w (Folder)
2169 @kindex m W (Folder)
2170 @findex wl-fldmgr-copy-region
2171 Copy folders in the specified region.
2172 (@code{wl-fldmgr-copy-region})
2176 @kindex C-k (Folder)
2177 @kindex m k (Folder)
2178 @findex wl-fldmgr-cut
2179 Cut folder. Folder itself is not deleted.
2180 (@code{wl-fldmgr-cut})
2184 @kindex C-w (Folder)
2185 @kindex m C-w (Folder)
2186 @findex wl-fldmgr-cut-region
2187 Cut folders in the specified region.
2188 (@code{wl-fldmgr-cut-region})
2192 @kindex C-y (Folder)
2193 @kindex m y (Folder)
2194 @findex wl-fldmgr-yank
2195 Paste folders that are copied or cut (folders in the cut-list).
2196 (@code{wl-fldmgr-yank})
2199 @kindex m p (Folder)
2200 @findex wl-fldmgr-set-petname
2201 Put nickname on the folder.
2202 (@code{wl-fldmgr-set-petname})
2205 @kindex m q (Folder)
2206 @findex wl-fldmgr-clear-cut-entity-list
2207 Clear the cut-list. (cut, copied folder information is cleared,
2208 you cannot paste after this)
2209 (@code{wl-fldmgr-clear-cut-entity-list})
2212 @kindex m s (Folder)
2213 @findex wl-fldmgr-sort
2214 Sort folders in the current folder group.
2215 (@code{wl-fldmgr-sort})
2218 @kindex m C-s (Folder)
2219 @findex wl-fldmgr-save
2220 Save current folder view to the @file{wl-folders-file}.
2221 (@code{wl-fldmgr-save})
2224 [Following commands are only available on the access groups]
2230 @kindex m u (Folder)
2231 @findex wl-fldmgr-unsubscribe
2232 Set the visibility of folder (subscribe/unsubscribe).
2233 (@code{wl-fldmgr-unsubscribe})
2238 @kindex r u (Folder)
2239 @findex wl-fldmgr-unsubscribe-region
2240 Set the visibility of the folders (subscribe/unsubscribe) in the
2242 (@code{wl-fldmgr-unsubscribe-region})
2247 @kindex m l (Folder)
2248 @findex wl-fldmgr-access-display-normal
2249 List folders that are currently available.
2250 (@code{wl-fldmgr-access-display-normal})
2255 @kindex m L (Folder)
2256 @findex wl-fldmgr-access-display-all
2257 List all folders regardless of the subscription status.
2258 (@code{wl-fldmgr-access-display-all})
2262 @subsection Customize variables
2265 @item wl-interactive-save-folders
2266 @vindex wl-interactive-save-folders
2267 The initial setting is @code{t}. If non-nil and folder view is
2268 modified, confirm saving it before Wanderlust or Emacs exits. If
2269 @code{nil}, save without confirmation.
2271 @item wl-fldmgr-make-backup
2272 @vindex wl-fldmgr-make-backup
2273 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2274 created before saving the folder status.
2276 @item wl-fldmgr-sort-function
2277 @vindex wl-fldmgr-sort-function
2278 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2279 sort folders. By default function, folders are sorted alphabetically
2280 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2283 @item wl-fldmgr-sort-group-first
2284 @vindex wl-fldmgr-sort-group-first
2285 The initial setting is @code{t}. If non-nil,
2286 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2287 does not care whether it is folder group or not.
2289 @item wl-folder-check-async
2290 @vindex wl-folder-check-async
2291 The initial setting is @code{t}. If non-nil, check folder's unread
2292 status asynchronously. It boosts newsgroup checking.
2294 @item wl-folder-check-fast
2295 @vindex wl-folder-check-fast
2296 The initial setting is @code{nil}.
2297 If non-nil, it does not update folder status while checking.
2299 @item wl-folder-notify-deleted
2300 @vindex wl-folder-notify-deleted
2301 The initial setting is @code{nil}.
2303 If non-nil, negative value is displayed when the message is deleted. If
2304 @code{sync}, folder is synchronized when the message is deleted. If
2305 @code{nil}, message deletion is ignored.
2308 @subsection Miscellanea
2310 Following is a note for folder editing.
2314 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2315 paste(yank) command pastes the folders on one cut or copy command
2316 (If copy command is executed by region, folders in the region are pasted
2317 by one paste command)
2320 You cannot cut @samp{Desktop} group.
2321 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2324 You cannot copy folder group.
2327 Operations on the access group are only available for the folders
2328 in the same access group.
2331 You cannot create a folder which has same name with the folders already exist.
2334 You cannot insert folders which have same name in one group.
2335 You can insert them in the different groups.
2336 You cannot put same nickname to the different folders.
2340 @node Summary, Message, Folder, Top
2341 @chapter Summary Mode
2343 After you select the folder via folder mode, you enter to the summary
2347 * Usage of Summary Mode:: TIPS
2348 * Thread Operations:: Thread operations
2349 * Cache:: File cache, Buffer cache, and Prefetch
2350 * Auto Refile:: Auto refile settings
2351 * Sticky Summary:: Summary make sticky
2352 * Key Bindings of Summary:: Key bindings
2353 * Variables of Summary:: Customize Summary Mode
2357 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2358 @section Usage (Tips)
2360 @subsection Summary Content
2362 In the summary mode, messages are displayed like following.
2366 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2367 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2368 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2369 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2376 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2380 You cannot change this in the current version.
2382 @var{Message number} is the message's unique number in the folder. In
2383 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2384 in the MH folder, it is the filename of the message.
2386 @var{Temporal mark} and @var{Persistent mark} are described later.
2388 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2389 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2390 Japanese, but if you want to display it in English, set the value of
2391 @code{wl-summary-weekday-name-lang} as @samp{en}.
2393 @var{Sender}'s indentation corresponds to the depth of the thread.
2394 Sender name is displayed as nickname if it is defined in the address
2395 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2396 displaying with nickname.
2398 If number is printed at the head of @var{Sender} part like @samp{+2},
2399 that means the message have 2 follow messages.
2401 @var{Subject} is the @samp{Subject:} header field of the message. If
2402 the message have same @samp{Subject:} with the parent message, it is not
2403 displayed. Some mailing list puts its sequence number in the
2404 @samp{Subject:} field, but it is
2405 ignored. @code{wl-summary-no-subject-message} is displayed when the
2406 message has empty subject field.
2408 @subsection Temporary Marks
2409 @cindex Mark, Temporary
2411 There are four temporary marks,
2412 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2413 Temporary marks indicates message operations.
2418 You can execute a command on the all messages that have @samp{*} mark,
2419 with the key bindings which begins with @kbd{m}.
2422 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2426 After you type @kbd{o} key, prompt appears to input refile destination.
2427 Your answer is printed in the summary line.
2431 You can put this mark by typing @kbd{O} key.
2432 The difference between this mark and refile mark is,
2433 this mark does not delete the message while latter does.
2436 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2438 @subsection Persistent Marks
2440 There are five persistent marks,
2441 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2443 The persistent mark indicates the message's status and it is saved.
2444 Each persistent mark indicates:
2450 It is unread message.
2452 It is unread but cached message.
2454 It is read but it is not cached.
2456 It is important message. You can put @samp{$} mark by typing @kbd{$}
2457 key (if already exists, the mark is deleted). It is convenient to put
2458 this mark on the messages to remember (If you want to remember to write
2459 a reply for the message, for example) because this mark remains after
2460 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2461 even the message itself is deleted in the actual folder.
2464 If the message is read and cached (or local message),there are no
2468 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2469 cache. Messages with the marks other than these, you can read them in
2470 the offline status even they are in the IMAP folder or netnews folder.
2472 @subsection How To Read
2474 Basically, you can read messages only typing space key again and again.
2476 To update summary status to the newest status (synchronize),
2479 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2480 moves cursor to the next message.
2481 Enter message buffer by typing @kbd{j} key.
2482 To operate multipart, you have to enter to the message buffer.
2485 @subsection Pack the Message Numbers
2486 You can pack the message numbers in Summary by
2487 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2488 News Spool Folder and Maildir Folder are supported folder types.
2491 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2492 @section Thread Operations
2494 For example, the following line indicates one thread (a context of a topic).
2497 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2501 If you type @kbd{/} on this line, the thread is opened and it changes
2502 the appearance like following.
2506 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2507 388 09/17(Thu)22:34 +-[ Murata san ]
2511 (Message 388 is the replied message to the message 384.)
2512 If you type @kbd{/} key once again, the thread is closed.
2513 With prefix argument, @kbd{/} opens all children threads.
2515 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2518 Commands with the key binding that begins with @kbd{t} executes commands
2519 on the messages in the thread.
2520 @xref{Key Bindings of Summary}.
2522 @subsection reconstruct thread by hand
2524 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2525 (@code{wl-summary-save-current-message}) at the corresponding message,
2526 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2527 message then you have the reconstructed thread.
2530 @node Cache, Auto Refile, Thread Operations, Summary
2533 @subsection Cache File
2535 The messages which have to access via network (e.x. IMAP, NNTP folder)
2536 are cached as a local file. The cache file is saved under the directory
2537 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2538 elmo-cache-expire-by-size}. The command deletes cache files to the
2539 specified size by the order of last accessed time.
2541 @subsection Buffer Cache and Prefetching
2543 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2544 that are read are kept in the cache buffer. It is called `buffer
2545 cache'. The number of cache buffer is specified by
2546 @code{elmo-buffer-cache-size}.
2548 There are message prefetching mechanism in the Wanderlust that
2549 prefetches next message while you are reading. This function requires
2550 that the value of @code{elmo-use-buffer-cache} is non-nil.
2552 You can control the message prefetching mechanism by these two
2556 @item wl-cache-prefetch-folder-type-list
2557 @vindex wl-cache-prefetch-folder-type-list
2558 The initial setting is the list shown below:
2566 It specifies the folder types in which message prefetching is enabled.
2567 In the initial setting, multi folder that contains localdir and imap4
2568 prefetches only imap4 messages. This variable precedes the value of
2569 @code{wl-cache-prefetch-folder-list}.
2571 If you want to prefetch localdir and localnews also, following setting
2576 (setq wl-cache-prefetch-folder-type-list
2577 '(nntp imap4 localdir localnews))
2581 @item wl-cache-prefetch-folder-list
2582 @vindex wl-cache-prefetch-folder-list
2583 The initial setting is @code{nil}.
2584 A list of regexp of folders to enable message prefetching.
2588 @node Auto Refile, Sticky Summary, Cache, Summary
2589 @section Auto Refile
2590 @vindex elmo-msgdb-extra-fields
2591 @vindex wl-refile-rule-alist
2592 @findex wl-summary-auto-refile
2594 You can refile messages automatically, by typing @kbd{C-o}
2595 (@code{wl-summary-auto-refile}). It decides destination of refile by
2596 the content of the message header information (information in the msgdb).
2598 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2599 available. If you want to decide destination by other header fields,
2600 set the variable @code{elmo-msgdb-extra-fields} like following.
2604 (setq elmo-msgdb-extra-fields
2614 By this setting, Wanderlust saves extra fields in the msgdb. You have
2615 to type @kbd{s all} to get extra fields for the messages that are
2616 already exists in the summary.
2618 Then, specify the refile rule. The refile target folder of auto
2619 refiling is decided by the value of @code{wl-refile-rule-alist}.
2620 @code{wl-refile-rule-alist} is a list of a rule:
2624 (@var{field} (@var{regexp} . @var{target})
2625 (@var{regexp} . @var{target})
2630 Each rule means `if @var{field} value matches @var{regexp},
2631 then refile to @var{target} folder'.
2632 The rule matched first is applied.
2634 @var{field} is a string of field name. You can specify a list of field name
2635 string, too. In this case, if one of these fields is matched, then the
2636 rule is fired (i.e. OR condition).
2638 @var{regexp} is a regular expression for field value. @var{target} is a target
2639 folder string. You can specify a rule at @var{target} part, too. In this
2640 case, If the field value of the rule and the current rule is matched,
2641 then the current rule is fired (i.e. AND condition).
2643 In @var{target} part, you can refer matched substring of @var{regexp}.
2644 To refer substring, specify following in @var{target}:
2648 means substitute original matched text.
2651 means substitute what matched the @var{N}th `\(@dots{}\)'.
2652 (@var{N} is a number.)
2655 Following is an example of @code{wl-refile-rule-alist}.
2659 (setq wl-refile-rule-alist
2661 ("^Wanderlust" . "+wl")
2662 ("^Elisp" . "+elisp"))
2664 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2666 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2667 "+from-me-to-you"))))))
2671 After these settings, refile marks are automatically put on the condition
2672 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2674 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2676 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2677 with these persistent marks are not automatically refiled.
2678 It means Wanderlust does not execute auto refile on unread messages by
2679 the default setting.
2680 To execute auto refile on all messages, set following.
2683 (setq wl-summary-auto-refile-skip-marks nil)
2687 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2688 @section Sticky Summary
2689 @cindex Summary, Sticky
2690 @cindex Sticky Summary
2692 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2694 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2695 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2697 The buffer name of the sticky summary becomes like
2698 @samp{Summary:@var{folder-name}}.
2700 You can visit the sticky summary at any time by @kbd{C-x b}
2701 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2702 q}. Other operations in the sticky summary are same as normal summary.
2704 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2705 are automatically stuck.
2708 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2709 @section Key bindings
2710 @cindex Keybind, Summary Mode
2711 @cindex Keybind, Summary Buffer
2713 Key bindings of the summary mode are shown below.
2717 @kindex @key{SPC} (Summary)
2718 @findex wl-summary-read
2719 Proceed reading a message at the current cursor point.
2720 (@code{wl-summary-read})
2724 @findex wl-summary-redisplay
2725 Redisplay a message at the current cursor point.
2726 If this command is called with prefix argument,
2727 Redisplay message regardless of the message cache (message is re-loaded
2729 (@code{wl-summary-redisplay})
2733 @findex wl-summary-display-top
2734 Display the top message in the folder.
2735 (@code{wl-summary-display-top})
2739 @findex wl-summary-display-bottom
2740 Display the bottom message in the folder.
2741 (@code{wl-summary-display-bottom})
2745 @kindex @key{BS} (Summary)
2746 @kindex @key{DEL} (Summary)
2747 Display the previous page of the message at the current cursor point.
2748 @findex wl-summary-prev-page
2749 (@code{wl-summary-prev-page})
2752 @kindex @key{RET} (Summary)
2753 @findex wl-summary-next-line-content
2754 Display the next line of the message at the current cursor point.
2755 Display the message at the current cursor point if it is not displayed yet.
2756 (@code{wl-summary-next-line-content})
2761 @kindex M-@key{RET} (Summary)
2762 @findex wl-summary-prev-line-content
2763 Display the previous line of the message at the current cursor point.
2764 Display the message at the current cursor point if it is not displayed yet.
2765 (@code{wl-summary-prev-line-content})
2769 @findex wl-thread-open-close
2770 Toggle open or close the thread at the current cursor point.
2771 (@code{wl-thread-open-close})
2776 @findex wl-thread-open-all
2777 (@code{wl-thread-open-all})
2782 @findex wl-thread-close-all
2783 (@code{wl-thread-close-all})
2787 @findex wl-summary-goto-folder
2789 (@code{wl-summary-goto-folder})
2793 Mark all messages in the folder as read.
2794 @findex wl-summary-mark-as-read-all
2795 (@code{wl-summary-mark-as-read-all})
2799 @findex wl-summary-reply
2800 Prepare a draft for reply the message at the current cursor point.
2801 (@code{wl-summary-reply})
2805 @findex wl-summary-reply-with-citation
2806 Prepare a draft for reply the message at the current cursor point.
2807 (@code{wl-summary-reply-with-citation})
2811 @findex wl-summary-cancel-message
2812 If the message at current cursor point is your own netnews article,
2814 (@code{wl-summary-cancel-message})
2818 @findex wl-summary-reedit
2819 Prepare a draft for re-editing the message at current cursor point.
2820 If the message at current cursor point is your own netnews article,
2821 a draft for `supersedes message' for the message is prepared.
2822 (@code{wl-summary-reedit})
2825 @kindex M-e (Summary)
2826 @findex wl-summary-resend-bounced-mail
2827 If the message at current cursor point is a bounced message,
2828 a draft for re-sending original message is prepared.
2829 (@code{wl-summary-resend-bounced-mail})
2833 @findex wl-summary-forward
2834 A draft for forwarding the message at current cursor point is prepared.
2835 (@code{wl-summary-forward})
2839 @findex wl-summary-mark-as-important
2840 Put @samp{$} mark on the message at current cursor point.
2841 If already marked as @samp{$}, delete it.
2842 (@code{wl-summary-mark-as-important})
2848 Save the message at current cursor point.
2849 @findex wl-summary-save
2850 (@code{wl-summary-save})
2854 @findex wl-summary-next
2855 Move cursor to the next message.
2856 If message is marked with a temporal mark in
2857 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2858 In the offline mode, cursor is not moved to the messages which are not cached
2860 (@code{wl-summary-next})
2864 @findex wl-summary-prev
2865 Move cursor to the previous message.
2866 If message is marked with a temporal mark in
2867 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2868 In the offline mode, cursor is not moved to the messages which are not cached
2870 (@code{wl-summary-prev})
2874 @findex wl-summary-down
2875 Move cursor to the downward message which is unread or marked
2877 In the offline mode, cursor is not moved to the messages which are not cached
2879 If there are messages which have target mark @samp{*} in the summary,
2880 cursor is moved to the downward message which have a target mark.
2881 This behavior is changed according to the value of @code{wl-summary-move-order}.
2882 (@code{wl-summary-down})
2886 @findex wl-summary-up
2887 Move cursor to the upward message which is unread or marked
2889 In the offline mode, cursor is not moved to the messages which are not cached
2891 If there are messages which have target mark @samp{*} in the summary,
2892 cursor is moved to the downward message which have a target mark.
2893 This behavior is changed according to the value of @code{wl-summary-move-order}.
2894 (@code{wl-summary-up})
2898 @findex wl-summary-write
2899 Prepare a new draft.
2900 (@code{wl-summary-write})
2904 @findex wl-summary-write-current-folder
2905 Prepare a new draft. If the current folder is NNTP folder,
2906 @samp{Newsgroups:} field is completed. If the current folder is mailing
2907 list folder (refile destination), guess @samp{To:} field and completed
2908 (If @code{wl-subscribed-mailing-list} is valid list)
2909 (@code{wl-summary-write-current-folder})
2913 @findex wl-summary-redisplay-all-header
2914 Redisplay the message at current cursor point with all header fields.
2915 (@code{wl-summary-redisplay-all-header})
2919 @findex wl-summary-redisplay-no-mime
2920 Redisplay the message at current cursor point without MIME analysis.
2921 (@code{wl-summary-redisplay-no-mime})
2925 @findex wl-summary-burst
2926 If the message at current cursor point has
2927 encapsulates multiple messages using MIME,
2928 de-capsulate and extract them on the current folder.
2929 (@code{wl-summary-burst})
2932 @kindex @@ (Summary)
2933 @findex wl-summary-edit-addresses
2934 Append/change/delete the message's sender information to the address
2935 book @file{~/.addresses} interactively. If this command is called with
2936 prefix argument, arbitrary address can be edited.
2937 (@code{wl-summary-edit-petname})
2941 @findex wl-status-update
2942 Sync up address book status with @file{~/.addresses}'s content.
2943 (@code{wl-status-update})
2947 @findex wl-summary-pipe-message
2948 Pipe current message's content to the external process.
2949 (@code{wl-summary-pipe-message})
2953 @findex wl-summary-print-message
2954 Print out current message's content.
2955 It uses @code{ps-print} module in Emacs 20.x.
2956 If you don't use color printer, you might want to set
2957 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
2960 (setq wl-ps-print-buffer-function 'ps-print-buffer)
2963 (@code{wl-summary-print-message})
2967 @findex wl-summary-exit
2968 Exit current folder.
2969 (@code{wl-summary-exit})
2973 @findex wl-summary-jump-to-current-message
2974 Jump cursor to the currently displayed message's window.
2975 (@code{wl-summary-jump-to-current-message})
2979 Jump cursor to the other message.
2980 @findex wl-summary-jump-to-msg
2981 (@code{wl-summary-jump-to-msg})
2985 Update summary status and
2986 prefetch all messages which have marks included in the
2987 @code{wl-summary-incorporate-marks}.
2988 @findex wl-summary-incorporate
2989 (@code{wl-summary-incorporate})
2992 @kindex M-j (Summary)
2993 @findex wl-summary-jump-to-msg-by-message-id
2994 Jump cursor to the message which have specified @samp{Message-Id:}. If
2995 @code{elmo-use-database} is non-nil, other folder is also searched.
2996 (@code{wl-summary-jump-to-msg-by-message-id})
3000 Jump to parent message.
3001 @findex wl-summary-jump-to-parent-message
3002 (@code{wl-summary-jump-to-parent-message})
3006 @findex wl-summary-mark-as-unread
3007 Mark as unread the message at current cursor point.
3008 (@code{wl-summary-mark-as-unread})
3012 @findex wl-summary-sync
3013 Synchronize summary view after prompting the update range
3014 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3018 all ...Discard current summary and update all message.
3019 update ...Update the difference between summary and the folder itself.
3020 rescan ...Rescan the msgdb and display again.
3021 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3022 first, last ...Move to the filter folder(partial filter).
3027 (@code{wl-summary-sync})
3031 @findex wl-summary-sort
3033 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3034 (@code{wl-summary-sort})
3038 @findex wl-summary-toggle-thread
3039 Toggle the threading.
3040 Threading status is displayed on the modeline.
3041 @samp{@{S@}} means threading is off (Sequence) and
3042 @samp{@{T@}} means threading is on (Thread).
3043 (@code{wl-summary-toggle-thread})
3047 @findex wl-summary-toggle-disp-folder
3048 Toggle displaying of folder window.
3049 (@code{wl-summary-toggle-disp-folder})
3053 Toggle displaying of message window.
3054 @findex wl-summary-toggle-disp-msg
3055 (@code{wl-summary-toggle-disp-msg})
3059 Move to the virtual folder with the condition specified.
3060 If called with prefix argument and current folder is virtual, exit it.
3061 @findex wl-summary-virtual
3062 (@code{wl-summary-virtual})
3065 @kindex @key{TAB} (Summary)
3066 @findex wl-summary-goto-last-displayed-msg
3067 Jump to the message which is displayed last.
3068 (@code{wl-summary-goto-last-displayed-msg})
3072 Put @samp{*} mark on the messages that satisfies the specified condition.
3073 @findex wl-summary-pick
3074 (@code{wl-summary-pick})
3078 @findex wl-summary-mark-as-read
3079 Mark as read the message at the current cursor point.
3080 (@code{wl-summary-mark-as-read})
3084 Prefetch the message at the current cursor point.
3085 With prefix argument, prefetch the message even if it is cached.
3086 @findex wl-summary-prefetch
3087 (@code{wl-summary-prefetch})
3091 Execute @samp{D}, @samp{o} and @samp{O} marks.
3092 @findex wl-summary-exec
3093 (@code{wl-summary-exec})
3097 @findex wl-summary-target-mark-line
3098 Put target mark on the message at the current cursor point.
3099 (@code{wl-summary-target-mark-line})
3103 Put refile mark on the message at the current cursor point.
3104 @findex wl-summary-refile
3105 (@code{wl-summary-refile})
3108 @kindex C-o (Summary)
3109 Execute auto refile.
3110 @findex wl-summary-auto-refile
3111 (@code{wl-summary-auto-refile})
3115 Put copy mark on the message at the current cursor point.
3116 @findex wl-summary-copy
3117 (@code{wl-summary-copy})
3120 @kindex M-o (Summary)
3121 Put refile mark on the message at the current cursor point with the destination
3122 previously specified.
3123 @findex wl-summary-refile-prev-destination
3124 (@code{wl-summary-refile-prev-destination})
3128 @findex wl-summary-delete
3129 Put delete mark on the message at the current cursor point.
3130 (@code{wl-summary-delete})
3134 @findex wl-summary-unmark
3135 Unmark the temporal mark on the message at the current cursor point.
3136 (@code{wl-summary-unmark})
3140 Unmark all the temporal marks.
3141 @findex wl-summary-unmark-all
3142 (@code{wl-summary-unmark-all})
3145 @kindex r R (Summary)
3146 @findex wl-summary-mark-as-read-region
3147 Mark as read messages in the specified region.
3148 (@code{wl-summary-mark-as-read-region})
3151 @kindex r $ (Summary)
3152 @findex wl-summary-mark-as-important-region
3153 Mark as important @samp{$} messages in the specified region.
3154 If @samp{$} already exists, it is deleted.
3155 (@code{wl-summary-mark-as-important-region})
3158 @kindex r ! (Summary)
3159 @findex wl-summary-mark-as-unread-region
3160 Mark as unread messages in the specified region.
3161 (@code{wl-summary-mark-as-unread-region})
3164 @kindex r i (Summary)
3165 @findex wl-summary-prefetch-region
3166 Prefetch messages in the specified region.
3167 (@code{wl-summary-prefetch-region})
3170 @kindex r x (Summary)
3171 @findex wl-summary-exec-region
3172 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3174 (@code{wl-summary-exec-region})
3177 @kindex r * (Summary)
3178 @findex wl-summary-target-mark-region
3179 Put target mark on the messages in the specified region.
3180 (@code{wl-summary-target-mark-region})
3183 @kindex r o (Summary)
3184 @findex wl-summary-refile-region
3185 Put refile mark on the messages in the specified region.
3186 (@code{wl-summary-refile-region})
3189 @kindex r O (Summary)
3190 @findex wl-summary-copy-region
3191 Put copy mark on the messages in the specified region.
3192 (@code{wl-summary-copy-region})
3195 @kindex r d (Summary)
3196 @findex wl-summary-delete-region
3197 Put delete mark on the messages in the specified region.
3198 (@code{wl-summary-delete-region})
3201 @kindex r u (Summary)
3202 @findex wl-summary-unmark-region
3203 Delete temporal mark on the messages in the specified region.
3204 (@code{wl-summary-unmark-region})
3207 @kindex r y (Summary)
3208 Save messages in the specified region.
3209 @findex wl-summary-save-region
3210 (@code{wl-summary-save-region})
3213 @kindex t R (Summary)
3214 @findex wl-thread-mark-as-read
3215 Mark as read messages which are the descendant of the current thread.
3216 With prefix argument, it affects on the all messages in the thread tree.
3217 (@code{wl-thread-mark-as-read})
3220 @kindex t $ (Summary)
3221 @findex wl-thread-mark-as-important
3222 Put important mark @samp{$} on the messages which are the
3223 descendant of the current thread.
3224 If @samp{$} mark exists, it is deleted.
3225 With prefix argument, it affects on the all messages in the thread tree.
3226 (@code{wl-thread-mark-as-important})
3229 @kindex t ! (Summary)
3230 @findex wl-thread-mark-as-unread
3231 Mark as unread messages which are the descendant of the current thread.
3232 With prefix argument, it affects on the all messages in the thread tree.
3233 (@code{wl-thread-mark-as-unread})
3236 @kindex t i (Summary)
3237 @findex wl-thread-prefetch
3238 Prefetch messages which are the descendant of the current thread.
3239 With prefix argument, it affects on the all messages in the thread tree.
3240 (@code{wl-thread-prefetch})
3243 @kindex t x (Summary)
3244 @findex wl-thread-exec
3245 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3246 the descendant of the current thread. With prefix argument, it affects
3247 on the all messages in the thread tree.
3248 (@code{wl-thread-exec})
3251 @kindex t * (Summary)
3252 @findex wl-thread-target-mark
3253 Put target mark @samp{*} on the messages which are the descendant of the
3254 current thread. With prefix argument, it affects on the all messages in
3256 (@code{wl-thread-target-mark})
3259 @kindex t o (Summary)
3260 @findex wl-thread-refile
3261 Put refile mark on the messages which are the descendant of the current thread.
3262 With prefix argument, it affects on the all messages in the thread tree.
3263 (@code{wl-thread-refile})
3266 @kindex t O (Summary)
3267 @findex wl-thread-copy
3268 Put copy mark on the messages which are the descendant of the current thread.
3269 With prefix argument, it affects on the all messages in the thread tree.
3270 (@code{wl-thread-copy})
3273 @kindex t d (Summary)
3274 @findex wl-thread-delete
3275 Put delete mar on the messages which are the descendant of the current thread.
3276 With prefix argument, it affects on the all messages in the thread tree.
3277 (@code{wl-thread-delete})
3280 @kindex t u (Summary)
3281 @findex wl-thread-unmark
3282 Unmark temporal mark on the messages which are the descendant of the
3283 current thread. With prefix argument, it affects on the all messages in
3285 (@code{wl-thread-unmark})
3288 @kindex t y (Summary)
3289 @findex wl-thread-save
3290 Save messages which are the descendant of the current thread.
3291 With prefix argument, it affects on the all messages in the thread tree.
3292 (@code{wl-thread-save})
3295 @kindex m i (Summary)
3296 @findex wl-summary-target-mark-prefetch
3297 Prefetch all messages which have target mark @samp{*}.
3298 (@code{wl-summary-target-mark-prefetch})
3301 @kindex m R (Summary)
3302 @findex wl-summary-target-mark-mark-as-read
3303 Mark as read all messages which have target mark @samp{*}.
3304 (@code{wl-summary-target-mark-mark-as-read})
3307 @kindex m $ (Summary)
3308 @findex wl-summary-target-mark-mark-as-important
3309 Mark as important all messages which have target mark @samp{*}.
3310 If already marked as @samp{$}, it is deleted.
3311 (@code{wl-summary-target-mark-mark-as-important})
3314 @kindex m ! (Summary)
3315 @findex wl-summary-target-mark-mark-as-unread
3316 Mark as unread all messages which have target mark @samp{*}.
3317 (@code{wl-summary-target-mark-mark-as-unread})
3320 @kindex m o (Summary)
3321 @findex wl-summary-target-mark-refile
3322 Put refile mark on the messages which have target mark @samp{*}.
3323 (@code{wl-summary-target-mark-refile})
3326 @kindex m O (Summary)
3327 @findex wl-summary-target-mark-copy
3328 Put copy mark on the messages which have target mark @samp{*}.
3329 (@code{wl-summary-target-mark-copy})
3332 @kindex m d (Summary)
3333 @findex wl-summary-target-mark-delete
3334 Put delete mark on the messages which have target mark @samp{*}.
3335 (@code{wl-summary-target-mark-delete})
3338 @kindex m y (Summary)
3339 @findex wl-summary-target-mark-save
3340 Save messages which have target mark @samp{*}.
3341 (@code{wl-summary-target-mark-save})
3344 @kindex m u (Summary)
3345 Unmark all temporal marks.
3346 (@code{wl-summary-delete-all-temp-marks})
3347 @findex wl-summary-delete-all-temp-marks
3350 @kindex m a (Summary)
3351 Put target mark @samp{*} on the all messages.
3352 (@code{wl-summary-target-mark-all})
3353 @findex wl-summary-target-mark-all
3356 @kindex m t (Summary)
3357 Put target mark @samp{*} on the messages in the current thread.
3358 @findex wl-summary-target-mark-thread
3359 (@code{wl-summary-target-mark-thread})
3362 @kindex m r (Summary)
3363 @findex wl-summary-target-mark-region
3364 Put target mark @samp{*} on the messages in the specified region.
3365 (@code{wl-summary-target-mark-region})
3368 @kindex m A (Summary)
3369 @findex wl-summary-target-mark-reply-with-citation
3370 Prepare a draft which cites all messages which have target mark @samp{*}.
3371 (@code{wl-summary-target-mark-reply-with-citation})
3374 @kindex m f (Summary)
3375 @findex wl-summary-target-mark-forward
3376 Prepare a draft which forwards all messages which have target mark @samp{*}.
3377 (@code{wl-summary-target-mark-forward})
3380 @kindex m U (Summary)
3381 @findex wl-summary-target-mark-uudecode
3382 Uudecode the messages which have target mark @samp{*}.
3383 (@code{wl-summary-target-mark-uudecode})
3386 @kindex m ? (Summary)
3387 @findex wl-summary-target-mark-pick
3388 Pick messages from the @samp{*} marked messages.
3389 That is, @samp{*} marks on the messages are remained
3390 if the specified condition is satisfied.
3391 (@code{wl-summary-target-mark-pick})
3394 @kindex M-t (Summary)
3395 @findex wl-toggle-plugged
3396 Toggle offline/online status of Wanderlust.
3397 (@code{wl-toggle-plugged})
3400 @kindex C-t (Summary)
3401 Start Wanderlust's plug-status manager.
3402 (@code{wl-plugged-change})
3405 @kindex C-c C-o (Summary)
3406 @findex wl-jump-to-draft-buffer
3407 Move to the draft buffer if available. If multiple draft buffer exists,
3408 moved to one after another. If prefix argument is specified, load draft
3409 folder's message to the draft buffer and jump to it.
3410 (@code{wl-jump-to-draft-buffer})
3413 @kindex M-w (Summary)
3414 @findex wl-summary-save-current-message
3415 Save the message at the current cursor point.
3416 (@code{wl-summary-save-current-message})
3419 @kindex C-y (Summary)
3420 @findex wl-summary-yank-saved-message
3421 Regard the message at the current cursor point as
3422 parent, connect the message saved by
3423 @code{wl-summary-save-current-message}
3425 (@code{wl-summary-yank-saved-message})
3429 @node Variables of Summary, , Key Bindings of Summary, Summary
3430 @section Customiziable variables
3433 @item wl-summary-move-order
3434 @vindex wl-summary-move-order
3435 The initial setting is @code{unread}. Specify cursor moving policy. If
3436 you want to precede new messages, set @code{new}. If you want to
3437 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3440 @item wl-auto-select-first
3441 @vindex wl-auto-select-first
3442 The initial setting is @code{nil}.
3443 If non-nil, first message is automatically displayed.
3445 @item wl-auto-select-next
3446 @vindex wl-auto-select-next
3447 The initial setting is @code{nil}. If non-nil, jump to next summary
3448 automatically. If @code{unread}, jump to next unread folder's summary
3449 after confirmation. If @code{skip-no-unread}, unread folders are
3450 automatically skipped.
3452 @item wl-thread-insert-opened
3453 @vindex wl-thread-insert-opened
3454 The initial setting is @code{nil}.
3455 If non-nil, thread is inserted as opened.
3457 @item wl-thread-open-reading-thread
3458 @vindex wl-thread-open-reading-thread
3459 The initial setting is @code{t}. If non-nil, reading thread is
3460 automatically opened though it is closed thread.
3462 @item wl-summary-exit-next-move
3463 @vindex wl-summary-exit-next-move
3464 The initial setting is @code{t}. If non-nil, move to next folder at
3467 @item wl-folder-move-cur-folder
3468 @vindex wl-folder-move-cur-folder
3469 The initial setting is @code{nil}. If non-nil, cursor position on the
3472 @item wl-summary-weekday-name-lang
3473 @vindex wl-summary-weekday-name-lang
3474 The initial setting is @samp{ja}. Specify language of the weekday.
3475 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3478 @item wl-summary-fix-timezone
3479 @vindex wl-summary-fix-timezone
3480 The initial setting is @code{nil}.
3481 Time zone of the date string in summary mode is adjusted using this value.
3482 If @code{nil}, it is adjust to the default time zone information
3483 (system's default time zone or environment variable @samp{TZ}).
3485 @item wl-use-petname
3486 @vindex wl-use-petname
3487 The initial setting is @code{t}.
3488 If non-nil, sender part displays nickname.
3490 @item wl-break-pages
3491 @vindex wl-break-pages
3492 The initial setting is @code{t}.
3493 If non-nil, message is split as pages by @samp{^L}.
3495 @item wl-message-window-size
3496 @vindex wl-message-window-size
3497 The initial setting is '(1 . 4).
3498 A cons cell to specify the rate of summary and message window.
3499 car:cdr corresponds summary:message.
3501 @item wl-summary-recenter
3502 @vindex wl-summary-recenter
3503 The initial setting is t.
3504 If non-nil, cursor point is moved to the center of the summary window.
3506 @item wl-summary-indent-length-limit
3507 @vindex wl-summary-indent-length-limit
3508 The initial setting is 46.
3509 Specify the limit of thread indent level.
3510 If nil, max indent level is unlimited.
3512 @item wl-summary-no-from-message
3513 @vindex wl-summary-no-from-message
3514 The initial setting is @samp{nobody@@nowhere?}. A string which is
3515 displayed when there's no @samp{From:} field in the message.
3517 @item wl-summary-no-subject-message
3518 @vindex wl-summary-no-subject-message
3519 The initial setting is @samp{(WL:No Subject in original.)}. A string
3520 which is displayed when there's no @samp{Subject:} field in the message.
3522 @item wl-summary-width
3523 @vindex wl-summary-width
3524 The initial setting is 80.
3525 Width of summary line. If @code{nil}, summary line's width is as is.
3527 @item wl-summary-use-frame
3528 @vindex wl-summary-use-frame
3529 The initial setting is @code{nil}.
3530 If non-nil, use new frame for the summary.
3532 @item wl-use-folder-petname
3533 @vindex wl-use-folder-petname
3534 The initial setting is the list shown below:
3543 A list of display policy (symbol) of folder nickname. Available symbols
3548 Display folder petname on modeline.
3550 Destination folder is notified as nickname if
3551 @code{wl-auto-select-next} is non-nil.
3553 You can input folder name by nickname in the function
3554 @code{wl-summary-read-folder}.
3557 @item wl-summary-move-direction-toggle
3558 @vindex wl-summary-move-direction-toggle
3559 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3560 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3561 want to aware of reading direction, set this to @code{t}.
3564 @vindex wl-from-width
3565 The initial setting is 17.
3566 Width of sender part of summary line.
3568 @item wl-summary-divide-thread-when-subject-changed
3569 @vindex wl-summary-divide-thread-when-subject-changed
3570 The initial setting is @code{nil}. If non-nil, thread is split if
3571 the subject is changed.
3573 @item wl-summary-search-via-nntp
3574 @vindex wl-summary-search-via-nntp
3575 The initial setting is @code{confirm}.
3577 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3578 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3579 from the NNTP server @code{elmo-nntp-default-server}. The value of
3580 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3581 @code{elmo-nntp-default-stream-type} are used.
3583 If @code{confirm}, server name can be specified. You can specify NNTP
3584 folder format like @samp{-:username@@servername:119!}.
3586 @item wl-summary-keep-cursor-command
3587 @vindex wl-summary-keep-cursor-command
3588 The initial setting is the list shown below:
3592 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3597 When you entered to summary by these commands and the target summary
3598 buffer already exists, summary status is not automatically updated and
3599 cursor position is saved.
3601 @item wl-summary-update-confirm-threshold
3602 @vindex wl-summary-update-confirm-threshold
3603 The initial setting is 500. If updated message number is larger than
3604 this value, confirm whether drop them or not.
3606 @item wl-summary-always-sticky-folder-list
3607 @vindex wl-summary-always-sticky-folder-list
3608 The initial setting is @code{nil}.
3609 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3610 are automatically stuck. Each element is regexp of folder name.
3612 @item wl-summary-reserve-mark-list
3613 @vindex wl-summary-reserve-mark-list
3614 The initial setting is the list shown below:
3623 If a message is already marked as temporal marks in this list, the
3624 message is not marked by any mark command.
3626 @item wl-summary-skip-mark-list
3627 @vindex wl-summary-skip-mark-list
3628 The initial setting is the list shown below:
3637 If a message is already marked as temporal marks in this list, the
3638 message is skipped at cursor move.
3640 @item wl-fetch-confirm-threshold
3641 @vindex wl-fetch-confirm-threshold
3642 The initial setting is 30000 (bytes). If displaying message has larger
3643 size than this value, Wanderlust confirms whether fetch the message or
3644 not. If @code{nil}, the message is fetched without confirmation.
3646 @item wl-prefetch-threshold
3647 @vindex wl-prefetch-threshold
3648 The initial setting is 30000 (bytes). If prefetching message has larger
3649 size than this value and @code{wl-prefetch-confirm} is non-nil,
3650 Wanderlust confirms whether prefetch the message or not. If
3651 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3652 without confirmation.
3654 @item wl-prefetch-confirm
3655 @vindex wl-prefetch-confirm
3656 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3657 prefetch the message or not if the message has larger size than
3658 @code{wl-prefetch-threshold}.
3660 @item wl-cache-fetch-threshold
3661 @vindex wl-cache-fetch-threshold
3662 The initial setting is 30000 (bytes). The messages which have larger
3663 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3664 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3667 @item elmo-imap4-use-cache
3668 @vindex elmo-imap4-use-cache
3669 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3672 @item elmo-nntp-use-cache
3673 @vindex elmo-nntp-use-cache
3674 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3677 @item elmo-pop3-use-cache
3678 @vindex elmo-pop3-use-cache
3679 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3682 @item elmo-shimbun-use-cache
3683 @vindex elmo-shimbun-use-cache
3684 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3687 @item wl-folder-process-duplicates-alist
3688 @vindex wl-folder-process-duplicates-alist
3689 The initial setting is @code{nil}.
3690 This list determines how to deal with duplicated messages in the same folder.
3691 Each item in the list is regexp of folder name and action; you can specify any
3692 one of the following in the place of action:
3695 @code{nil} : do nothing for duplicated messages.
3696 @code{hide} : hide duplicated messages from the summary.
3697 @code{read} : set duplicated messages as read.
3701 Following is an example (hide duplicated messages in multi folders)
3705 (setq wl-folder-process-duplicates-alist
3706 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3707 ("^\\*.*" . hide) (".*" . read)))
3713 @node Message, Draft, Summary, Top
3714 @chapter Message Buffer
3716 Message Buffers utilize MIME-View mode of SEMI. For operational
3717 procedures and key bindings, refer to respective documents.
3718 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3719 You can also see help by @kbd{?} in message buffer.
3721 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3722 brings you back to Summary mode. @kbd{l} toggles display of Summary
3725 @section Key Bindings
3731 @findex wl-message-toggle-disp-summary
3732 Toggles display of Summary mode buffer.
3733 (@code{wl-message-toggle-disp-summary})
3736 @findex wl-message-refer-article-or-url
3737 @kindex Button-2 (Message)
3738 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3739 corresponding message if found.
3740 (@code{wl-message-refer-article-or-url})
3742 @item Button-4 (upward movement of a wheel)
3743 @kindex Button-4 (Message)
3744 @findex wl-message-wheel-down
3745 Scrolls the message backwards. When the top of the message is hit,
3746 moves to the previous message.
3747 (@code{wl-message-wheel-down})
3749 @item Button-5 (downward movement of a wheel)
3750 @kindex Button-5 (Message)
3751 @findex wl-message-wheel-up
3752 Scrolls the message forward. When the bottom of the message is hit,
3753 moves to the next message.
3754 (@code{wl-message-wheel-up})
3757 @section Customizable Variables
3760 @item wl-message-window-size
3761 @vindex wl-message-window-size
3762 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3763 its car and cdr value corresponds to the ratio of Summary and Message
3766 @item wl-message-ignored-field-list
3767 @vindex wl-message-ignored-field-list
3768 (SEMI only) Initial setting is @code{nil}.
3769 All fields that match this list will be hidden in message buffer.
3770 Each elements are regexp of field-name.
3771 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3773 @item wl-message-visible-field-list
3774 @vindex wl-message-visible-field-list
3775 (SEMI only) Initial setting is @code{nil}.
3776 All fields that match this list will be display in message buffer.
3777 Each elements are regexp of field-name. This value precedes
3778 @code{wl-message-ignored-field-list}.
3779 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3781 @item wl-message-sort-field-list
3782 @vindex wl-message-sort-field-list
3783 (SEMI only) Initial setting is
3784 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3785 Header fields in message buffer are ordered by this value.
3786 Each elements are regexp of field-name.
3788 @item wl-message-truncate-lines
3789 @vindex wl-message-truncate-lines
3790 The initial value is the value of @code{default-truncate-lines}.
3791 If it is non-nil, truncate long lines in message buffer.
3794 @node Draft, Disconnected Operations, Message, Top
3795 @chapter Draft Buffer
3797 At Summary mode, pressing @kbd{w} and the like creates a new draft
3798 buffer. You can edit and send mail and news articles in this buffer.
3802 Basically it is Emacs-standard mail mode.
3804 @subsection Address Completion
3806 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3807 addresses. @kbd{@key{TAB}} completes them.
3809 If you want to submit a news article, add @samp{Newsgroups:} field by
3810 yourself. Field names can be completed by @kbd{@key{TAB}}.
3812 If you save the draft buffer you are editing, it is appended to the
3813 folder specified by @code{wl-draft-folder}.
3815 Using @samp{FCC:} field, you can specify the folder to which a copy of
3816 the message is saved when it is sent.
3818 @subsection Editing Messages
3820 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
3821 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
3822 a MIME user interface for GNU Emacs}.
3823 You can also see help by @kbd{C-c C-x ?} in draft buffer.
3825 @subsection Dynamic Modification of Messages
3826 @vindex wl-draft-config-alist
3827 @c @cindex Change Message
3828 @c @cindex Message, Change Dynamic
3830 You can set @code{wl-draft-config-alist} so that header and body of the
3831 message will automatically modified depending on information of header
3834 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3836 In the example below, the header is modified when
3837 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3838 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3839 before sending the message.
3843 (setq wl-draft-config-alist
3844 '(((string-match "aaa.example.com$" (system-name))
3845 ;; @r{applied if the expression is non-nil}
3846 (wl-smtp-posting-server . "mailserver-B")
3847 (wl-nntp-posting-server . "newsserver-B")
3848 ;; @r{settings of temporary variables}
3850 ("^To: .*user@@aaa.bbb.example.com"
3851 ;; @r{applied if it matches the header of the draft buffer}
3852 ("Organization" . (format "Go %s" my-webpage)))
3853 ;; @r{you can write elisp expressions here (eval only)}
3854 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3855 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3860 The format of @code{wl-draft-config-alist} is:
3864 '(("@var{regexp of the header}" or @var{elisp expression}
3865 ("@var{Field}" . value(@var{elisp expression}))
3866 (@var{variable} . value(@var{elisp expression}))
3867 (@var{sub-function} . value(@var{elisp expression}))
3870 ("@var{regexp of the header}" or @var{elisp expression}
3871 ("@var{Field}" . value(@var{elisp expression}))
3876 Per default, there are 10 following sub-functions.
3879 'header: Inserts the specified string at the bottom of the header.
3880 'header-file: Inserts the specified file at the bottom of the header.
3881 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3882 'top: Inserts the specified string at the top of the body.
3883 'top-file: Inserts the specified file at the top of the body.
3884 'body: Replaces the body with the specified string.
3885 Specifying @code{nil} deletes the entire body string.
3886 'body-file: Replaces the body with the content of the specified file.
3887 'bottom: Inserts the specified string at the bottom of the body.
3888 'bottom-file: Inserts the specified file at the top of the body.
3889 'template: Applies the specified template.
3890 (refer to the next subsection)
3893 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3894 change them or add your own functions. If you read the code, you can
3895 easily find how to write the functions.
3897 At the first of each item, @var{a regular expression of the header} or
3898 an @var{elisp expression} should be specified. In the case of an elisp
3899 expression, the item is applied when the expression is evaluated
3902 Per default, when multiple items match or are evaluated non-nil, all
3903 such items are applied, but if you set a variable
3904 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3907 At the second of the item, a cons or a list of functions should be
3908 specified. The car part of the cons should be a header field, a
3909 variable, or a sub-function. When a header field is specified, the
3910 field will be modified. If a variable is specified, the value of the
3911 variable will be modified temporarily.
3913 In the cdr part of a cons, not only a variable but also an elisp
3914 expression can be specified as is. If the car part is a header field
3915 and the cdr part is @code{nil}, the field will be deleted.
3917 See the next example as well:
3921 (setq wl-draft-config-alist
3923 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3924 ;; @r{applied if it matches the header of the buffer being replied}
3925 (body . " Hello.\n")
3926 (template . "default")
3931 As in the (1) above, if a header regexp is prepended with @code{reply},
3932 it is applied when the draft is prepared by @code{wl-summary-reply} for
3933 example, and when it matches the header being replied. It is ignored
3934 when there is no buffer being replied, like after @code{wl-draft} was
3937 Note that @code{wl-draft-config-alist} is applied only once when
3938 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3939 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3940 aborting transmission, execute @kbd{C-c C-e}
3941 (@code{wl-draft-config-exec}) explicitly.
3943 If you don't want to apply @code{wl-draft-config-alist} when
3944 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
3948 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
3951 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3952 prepared, do the following:
3955 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3958 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
3959 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
3963 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
3966 @subsection Inserting Templates
3968 @cindex Apply Template
3970 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3971 @kbd{M-x wl-template-select} in the draft buffer.
3973 The format of @code{wl-template-alist} is almost the same as
3974 @code{wl-draft-config-alist}.
3978 (setq wl-template-alist
3981 ("Organization" . "~/.wl sample")
3982 (body . "Hello.\n"))
3984 (template . "default") ;; @r{(a)}
3985 ("To" . "boss@@example.com")
3986 ("Subject" . "Report")
3987 (body-file . "~/work/report.txt")
3993 As you can see, the only difference is item (template) names such as
3994 @samp{default} and @samp{report}, instead of a regexp of header.
3995 Because definition of each item is the same as
3996 @code{wl-draft-config-alist}, you can call another template, like (a).
3998 Executing the command @code{wl-template-select} results in template
3999 selection, but the result differs depending on variable
4000 @code{wl-template-visible-select}.
4002 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4003 window is shown below the draft buffer. You can select a template by
4004 @kbd{n} and @kbd{p} seeing the buffer window.
4006 Press the @key{RET} key and the template is actually applied to the draft
4007 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4008 adjust the window size by @code{wl-template-buffer-lines}.
4010 If @code{wl-template-visible-select} is @code{nil}, you should type the
4011 name of the template in the mini buffer.
4013 As shown in the example in @code{wl-draft-config-alist}, you can select
4014 @samp{default} template by writing:
4017 (template . "default")
4020 @subsection Sending mail by POP-before-SMTP
4021 @cindex POP-before-SMTP
4023 You can send mail by POP-before-SMTP with this single line:
4026 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4030 Configure the following variables if you need.
4033 @item wl-pop-before-smtp-user
4034 The POP user name for POP-before-SMTP authentication.
4035 If unset, @code{elmo-pop3-default-user} is used.
4037 @item wl-pop-before-smtp-server
4038 The POP server name for POP-before-SMTP authentication.
4039 If unset, @code{elmo-pop3-default-server} is used.
4041 @item wl-pop-before-smtp-authenticate-type
4042 The POP authentication method for POP-before-SMTP authentication.
4043 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4045 @item wl-pop-before-smtp-port
4046 The POP port number for POP-before-SMTP authentication.
4047 If unset, @code{elmo-pop3-default-port} is used.
4049 @item wl-pop-before-smtp-stream-type
4050 If non-nil, POP connection is established using SSL. If
4051 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4052 unset, @code{elmo-pop3-default-stream-type} is used.
4055 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4056 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4058 Therefore, if SMTP server and POP server are actually the same, and if
4059 POP folder per default (such as @samp{&}) is available, no settings are
4062 Refer to the following URL about POP-before-SMTP.
4066 http://spam.ayamura.org/tools/smPbS.html
4067 http://www.iecc.com/pop-before-smtp.html
4071 @section Key Bindings
4072 @cindex Keybind, Draft Mode
4073 @cindex Keybind, Draft Buffer
4078 @kindex C-c C-y (Draft)
4079 @findex wl-draft-yank-original
4080 Cites the content of the current message buffer.
4081 (@code{wl-draft-yank-original})
4084 @kindex C-c C-p (Draft)
4085 @findex wl-draft-preview-message
4086 Previews the content of the current draft.
4087 This is useful for previewing MIME multi-part messages.
4088 (@code{wl-draft-preview-message})
4091 @kindex C-c C-s (Draft)
4092 @findex wl-draft-send
4093 Sends the content of the current draft. Does not erase the draft buffer.
4094 This is useful for sending multiple messages, which are a little different
4096 (@code{wl-draft-send})
4099 @kindex C-c C-c (Draft)
4100 @findex wl-draft-send-and-exit
4101 Sends the content of the current draft and erases the draft buffer.
4102 (@code{wl-draft-send-and-exit})
4105 @kindex C-x C-s (Draft)
4106 @findex wl-draft-save
4107 Save the current draft.
4108 (@code{wl-draft-save})
4111 @kindex C-c C-k (Draft)
4112 @findex wl-draft-kill
4113 Kills the current draft.
4114 (@code{wl-draft-kill})
4117 @kindex C-x k (Draft)
4118 @findex wl-draft-mimic-kill-buffer
4119 Kills the current draft.
4120 (@code{wl-draft-mimic-kill-buffer})
4123 @kindex C-c C-z (Draft)
4124 @findex wl-draft-save-and-exit
4125 Saves the current draft, and erases the draft buffer.
4126 This is useful if you want to suspend editing of the draft.
4127 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4128 the @samp{+draft} folder.
4129 (@code{wl-draft-save-and-exit})
4132 @kindex C-c C-r (Draft)
4133 @findex wl-caesar-region
4134 Encodes or decodes the specified region in Caesar cipher.
4135 (@code{wl-caesar-region})
4139 @findex wl-draft-highlight-and-recenter
4140 Recenter and rehighlight current draft.
4141 (@code{wl-draft-highlight-and-recenter})
4145 @findex wl-toggle-plugged
4146 Toggles off-line/on-line states of Wanderlust.
4147 (@code{wl-toggle-plugged})
4150 @kindex C-c C-o (Draft)
4151 @findex wl-jump-to-draft-buffer
4152 Jumps to the other draft buffer, if exists.
4153 With prefix argument, reads a file (if any) from the draft folder when
4154 there is no such buffer.
4155 (@code{wl-jump-to-draft-buffer})
4158 @kindex C-c C-e (Draft)
4159 @findex wl-draft-config-exec
4160 Applies @code{wl-draft-config-alist}.
4161 (@code{wl-draft-config-exec})
4164 @kindex C-c C-j (Draft)
4165 @findex wl-template-select
4167 (@code{wl-template-select})
4170 @kindex C-c C-a (Draft)
4172 Enter Address Manager.
4173 @xref{Address Manager}.
4177 @section Customizable Variables
4180 @item wl-subscribed-mailing-list
4181 @vindex wl-subscribed-mailing-list
4182 The initial setting is @code{nil}. Mailing lists to which you
4183 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4184 field of a reply draft, removes your own address from
4185 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4186 contained in @samp{To:} or @samp{Cc:} field of a message to be
4187 automatically re-filed, the destination folder will be leaned in
4188 connection with the address.
4194 (setq wl-subscribed-mailing-list
4195 '("wl@@lists.airs.net"
4197 "emacs-mime-ja@@m17n.org"))
4201 @item wl-insert-mail-followup-to
4202 @vindex wl-insert-mail-followup-to
4203 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4204 field is automatically inserted in the draft buffer.
4206 @item wl-insert-mail-reply-to
4207 @vindex wl-insert-mail-reply-to
4208 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4209 field is automatically inserted in the draft buffer.
4211 @item wl-auto-insert-x-face
4212 @vindex wl-auto-insert-x-face
4213 The initial setting is @code{t}. If non-nil and there is an encoded
4214 X-Face string in a file @file{~/.xface} (the value of the variable
4215 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4216 draft buffer. If @code{nil}, it is not automatically inserted.
4218 @item wl-insert-message-id
4219 @vindex wl-insert-message-id
4220 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4221 is automatically inserted on the transmission.
4223 @item wl-local-domain
4224 @vindex wl-local-domain
4225 The initial setting is @code{nil}. If @code{nil}, the return value of
4226 the function @code{system-name} will be used as the domain part of
4229 If @code{system-name} does not return FQDN (i.e. the full name of the
4230 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4231 to the string of the local domain name without hostname (like
4232 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4233 @samp{.} @code{wl-local-domain} is used as domain part of the
4236 If your terminal does not have global IP, set the value of
4237 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4238 you use invalid @samp{Message-ID:}.)
4240 Moreover, concatenation of @code{system-name} @samp{.}
4241 @code{wl-local-domain} will be used as an argument to the HELO command
4244 @item wl-message-id-domain
4245 @vindex wl-message-id-domain
4246 The initial setting is @code{nil}. If non-nil, this value is used as a
4247 domain part of the @samp{Message-ID:}. If your terminal does not have
4248 global IP address, set unique string to this value (e.x. your e-mail
4251 @item wl-message-id-domain
4252 @vindex wl-message-id-domain
4253 The initial setting is @code{nil}. If @code{nil}, the return value of
4254 the function @code{system-name} will be used as the domain part of
4255 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4256 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4257 @strong{must} set this variable to the string of the full name of the
4258 host. Otherwise, you might be beaten up on the Net News.
4260 @item wl-draft-config-alist
4261 @vindex wl-draft-config-alist
4262 The initial setting is @code{nil}. Modifies the draft message just
4263 before the transmission. The content of @code{wl-draft-config-alist}
4264 will be automatically applied only once on the transmission. If you
4265 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4268 @item wl-template-alist
4269 @vindex wl-template-alist
4270 The initial setting is @code{nil}.
4271 This variable specifies the template to be applied in the draft buffer.
4273 @item wl-draft-config-matchone
4274 @vindex wl-draft-config-matchone
4275 The initial setting is @code{nil}. If non-nil, only the first matching
4276 item is used when @code{wl-draft-config-alist} is applied. If
4277 @code{nil}, all matching items are used.
4279 @item wl-template-visible-select
4280 @vindex wl-template-visible-select
4281 The initial setting is @code{t}.
4282 If non-nil, you can preview the result of the template selection in
4285 @item wl-template-confirm
4286 @vindex wl-template-confirm
4287 The initial setting is @code{nil}.
4288 If non-nil, asks for confirmation when you press the enter key to select
4289 template while previewing.
4291 @item wl-template-buffer-lines
4292 @vindex wl-template-buffer-lines
4293 The initial setting is 7.
4294 If @code{wl-template-visible-select} is non-nil, this variable specifies
4295 the size of the preview window.
4297 @item wl-draft-reply-buffer-style
4298 @vindex wl-draft-reply-buffer-style
4299 The initial setting is @code{split}. @code{split} or @code{full} can be
4300 specified. In the case of @code{full}, the whole frame will be used for
4301 a reply draft buffer when it is prepared.
4303 @item wl-draft-use-frame
4304 @vindex wl-draft-use-frame
4305 The initial setting is @code{nil}.
4306 If non-nil, use new frame for the draft.
4308 @item wl-draft-truncate-lines
4309 @vindex wl-draft-truncate-lines
4310 The initial value is the value of @code{default-truncate-lines}.
4311 If it is non-nil, truncate long lines in draft buffer.
4315 The initial setting is the value of the variable
4316 @code{user-mail-address}. The value of this variable is inserted as a
4317 @samp{From:} field of the draft when it is prepared.
4319 @item wl-envelope-from
4320 @vindex wl-envelope-from
4321 The initial setting is @code{nil}.
4322 The value of this variable is used for envelope from (MAIL FROM).
4323 If @code{nil}, the address part of @code{wl-from} is used.
4325 @item wl-user-mail-address-list
4326 @vindex wl-user-mail-address-list
4327 The initial setting is @code{nil}.
4328 This is the User's address list. If you have multiple addresses,
4333 The initial setting is @code{nil}.
4334 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4335 the draft when it is prepared. If function is specified, its return
4340 The initial setting is @code{nil}.
4341 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4342 the draft when it is prepared.
4344 @item wl-reply-subject-prefix
4345 @vindex wl-reply-subject-prefix
4346 The initial setting is @samp{Re: }.
4347 In the @samp{Subject:} of the reply draft, this string is prepended to
4348 the @samp{Subject:} of being replied.
4350 @item wl-draft-reply-use-address-with-full-name
4351 @vindex wl-draft-reply-use-address-with-full-name
4352 The initial setting is @code{t}.
4353 If non-nil, insert her full name with address when prepare a draft for
4354 reply a message. If it is @code{nil}, insert her address only.
4356 @item wl-draft-enable-queuing
4357 @vindex wl-draft-enable-queuing
4358 The initial setting is @code{t}.
4359 This flag controls off-line transmission. If non-nil, the draft is
4362 @item wl-draft-use-cache
4363 @vindex wl-draft-use-cache
4364 The initial setting is @code{nil}. If the value is non-nil and
4365 @code{wl-insert-message-id} is nil, cache the message which is sent.
4367 @item wl-fcc-force-as-read
4368 @vindex wl-fcc-force-as-read
4369 The initial setting is @code{nil}. If the value is non-nil,
4370 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4372 @item wl-auto-flush-queue
4373 @vindex wl-auto-flush-queue
4374 The initial setting is t.
4375 This flag controls automatic transmission of the queue when Wanderlust
4376 becomes on-line. If non-nil, the queue is automatically transmitted
4377 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4378 manually, press @kbd{F} in the folder mode.
4380 @item wl-ignored-forwarded-headers
4381 @vindex wl-ignored-forwarded-headers
4382 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4383 All headers that match this regexp will be deleted when forwarding a message.
4385 @item wl-ignored-resent-headers
4386 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4387 All headers that match this regexp will be deleted when resending a message.
4389 @item wl-draft-always-delete-myself
4390 @vindex wl-draft-always-delete-myself
4391 If non-nil, always removes your own address from @samp{To:} and
4392 @samp{Cc:} when you are replying to the mail addressed to you.
4394 @item wl-draft-delete-myself-from-bcc-fcc
4395 @vindex wl-draft-delete-myself-from-bcc-fcc
4396 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4397 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4399 @item wl-smtp-posting-server
4400 @vindex wl-smtp-posting-server
4401 The initial setting is @code{nil}.
4402 This is the SMTP server name for mail transmission.
4404 @item wl-smtp-posting-user
4405 @vindex wl-smtp-posting-user
4406 The initial setting is @code{nil}.
4407 This is the user name for SMTP AUTH authentication. If @code{nil},
4408 @code{smtp-authenticate-user} is used.
4410 @item wl-smtp-authenticate-type
4411 @vindex wl-smtp-authenticate-type
4412 The initial setting is @code{nil}.
4413 This is the authentication method for SMTP AUTH authentication. If
4414 @code{nil}, @code{smtp-authenticate-type} is used. If
4415 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4418 @item wl-smtp-connection-type
4419 @vindex wl-smtp-connection-type
4420 The initial setting is @code{nil}.
4421 This variable specifies how to establish SMTP connections.
4422 If @code{nil}, @code{smtp-connection-type} is used.
4423 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4425 @item wl-nntp-posting-server
4426 @vindex wl-nntp-posting-server
4427 The initial setting is @code{nil}.
4428 This is the NNTP server name used for news submission.
4429 If @code{nil}, @code{elmo-nntp-default-server} is used.
4431 @item wl-nntp-posting-user
4432 @vindex wl-nntp-posting-user
4433 The initial setting is @code{nil}.
4434 This is the user name for AUTHINFO authentication on news submission.
4435 If @code{nil}, @code{elmo-nntp-default-user} is used.
4436 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4438 @item wl-nntp-posting-port
4439 @vindex wl-nntp-posting-port
4440 The initial setting is @code{nil}.
4441 This is the port number of the NNTP server used for news submission.
4442 If @code{nil}, @code{elmo-nntp-default-server} is used.
4444 @item wl-nntp-posting-stream-type
4445 @vindex wl-nntp-posting-stream-type
4446 The initial setting is @code{nil}.
4447 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4448 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4449 connection will be established.
4451 @item wl-pop-before-smtp-user
4452 @vindex wl-pop-before-smtp-user
4453 The initial setting is @code{nil}.
4454 This is the POP user name for POP-before-SMTP.
4455 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4457 @item wl-pop-before-smtp-server
4458 @vindex wl-pop-before-smtp-server
4459 The initial setting is @code{nil}.
4460 This is the POP server name for POP-before-SMTP.
4461 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4463 @item wl-pop-before-smtp-authenticate-type
4464 @vindex wl-pop-before-smtp-authenticate-type
4465 The initial setting is @code{nil}.
4466 This is the authentication method for POP-before-SMTP authentication.
4467 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4469 @item wl-pop-before-smtp-port
4470 @vindex wl-pop-before-smtp-port
4471 The initial setting is @code{nil}.
4472 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4473 @code{elmo-pop3-default-port} is used.
4475 @item wl-pop-before-smtp-stream-type
4476 @vindex wl-pop-before-smtp-stream-type
4477 The initial setting is @code{nil}.
4478 This flag controls the use of SSL for POP-before-SMTP. If it is
4479 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4480 STARTTLS (RFC2595) connection will be established.
4482 @item wl-draft-queue-save-variables
4483 @vindex wl-draft-queue-save-variables
4484 Specifies a list of variable to which queued messages are saved on the
4485 off-line transmission.
4487 @item wl-draft-sendlog
4488 @vindex wl-draft-sendlog
4489 The initial setting is @code{t}.
4490 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4494 @item drafts are sent by smtp or qmail
4495 @item saved into folders by fcc
4496 @item saved into folders by queuing
4499 (it is written even if the transmission fails).
4500 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4501 and left to the logging function of @command{imput}.
4504 @item wl-draft-sendlog-max-size
4505 @vindex wl-draft-sendlog-max-size
4506 The initial setting is 20000 (in bytes).
4507 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4508 beyond the size specified by this variable.
4512 The initial setting is @code{nil}.
4513 If non-nil, address completion uses LDAP.
4515 @item wl-ldap-server
4516 @vindex wl-ldap-server
4517 The initial setting is @samp{localhost}.
4518 LDAP server name for address completion.
4521 @vindex wl-ldap-port
4522 The initial setting is @code{nil}.
4523 If non-nil, the value is used as port number.
4526 @vindex wl-ldap-base
4527 The initial setting is @samp{c=US}.
4528 LDAP search starting point (base) for address completion.
4530 @item wl-draft-remove-group-list-contents
4531 @vindex wl-draft-remove-group-list-contents
4532 The initial setting is @code{t}.
4533 If non-nil, remove the group-lists' members in the recipients when
4534 sending the message (group-list means the description such as
4535 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4538 @node Disconnected Operations, Expire and Archive, Draft, Top
4539 @chapter Off-line Management
4540 @cindex Disconnected Operations
4542 Wanderlust has on-line and off-line states.
4545 * Off-line State:: Wanderlust has on-line and off-line states
4546 * Enable Operations:: Enable Disconnected Operations
4547 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4548 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4549 * Variables of Plugged Mode:: Customize Plugged Mode
4553 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4554 @section Off-line State
4556 Wanderlust has on-line and off-line states. In the off-line state, you
4557 cannot access messages via network, unless they are cached.
4559 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4560 in the mode line indicates the off-line state. In folder or summary
4561 modes, press @kbd{M-t} to switch between off- and on-line.
4563 You can invoke Wanderlust in the off-line state by setting
4564 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4566 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4567 ignores uncached messages.
4570 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4571 @section Enable Disconeected Operations
4573 Even in the off-line state, provided that relevant messages are cached,
4574 and the variable @code{elmo-enable-disconnected-operation} (described
4575 later) is non-nil, you can following operations:
4576 @xref{Plugged Mode}, @xref{Off-line State settings}.
4579 * Send Messages off-line:: Transmit Messages
4580 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4581 * Creation of Folders:: Create Folders off-line (IMAP4)
4582 * Marking:: Mark (IMAP4)
4583 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4586 As soon as Wanderlust becomes on-line, such operations invoked off-line
4587 are reflected in the servers via network.
4590 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4591 @subsection Transmission of Messages
4593 You can send mail/news messages off-line (if you are using
4594 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4595 accumulated in the queue folder, @samp{+queue}. These messages are
4596 transmitted at once when Wanderlust becomes on-line.
4598 You can visit @samp{+queue} in the off-line state and confirm content of
4599 messages in the queue. You can also remove messages. Removed messages
4600 are not transmitted even in the on-line state.
4603 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4604 @subsection Re-file and Copy (IMAP4)
4606 Re-file and copy operations to IMAP folders invoked during the off-line
4607 state are accumulated in the queue, and reflected in the server side
4608 when Wanderlust becomes on-line. If you visit destination folders after
4609 off-line re-file or copy, it looks as if messages were appended even in
4612 For the safety reasons, messages re-filed off-line are removed from
4613 source folders only if their @samp{Message-ID:} match messages on the
4614 servers. While the queue is processed, messages that failed to be
4615 re-filed or copied to the specified folders are appended to the folder
4619 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4620 @subsection Creation of Folders (IMAP4)
4622 You can create IMAP folders off-line. The creation of folders are
4623 reflected in the servers when Wanderlust becomes on-line. At that time,
4624 if folders failed to be created on the servers for any reasons, messages
4625 re-filed to such folders are appended to the folder @samp{+lost+found}.
4628 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4629 @subsection Marking (IMAP4)
4631 Off-line changes in unread/read and importance mark @samp{$} information
4632 are also reflected in the servers when Wanderlust becomes on-line.
4635 @node Pre-fetching Reservations, , Marking, Enable Operations
4636 @subsection Pre-fetching (IMAP4, NNTP)
4638 You can make reservations for pre-fetching messages in IMAP or NNTP
4639 folders. Reserved messages are marked with @samp{!} but not cached
4640 yet. When Wanderlust becomes on-line, they are pre-fetched from
4643 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4644 these off-line operations for IMAP4 and NNTP do not take place, and
4645 off-line re-file, copy or suchlike simply results in error.
4647 Because off-line operations use cache files, it is a bad idea to erase
4648 them by hand; it may cause Wanderlust to malfunction.
4650 If you want to remove caches, be sure to execute @kbd{M-x
4651 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4652 remove caches for messages relevant to off-line operations.
4655 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4656 @section Switching On-line/Off-line per Server/Port
4658 @kbd{M-t} described above switches networking states as a whole, but you
4659 can switch on-line/off-line per server/port.
4661 Pressing @kbd{C-t} in the folder or summary modes brings you in
4662 wl-plugged-mode shown below, in which you can change the plugged state
4667 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4670 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4671 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4673 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4674 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4680 The first line indicates status of the following three variables, and
4681 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4682 column modifies the values of these variables.
4686 "Queuing" @code{wl-draft-enable-queuing}
4687 "AutoFlushQueue" @code{wl-auto-flush-queue}
4688 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4692 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4695 The second and after lines indicate on-line/off-line states of servers
4696 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4697 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4698 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4700 @dfn{sending queue} means messages accumulated in the folder
4701 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4702 off-line operations when @code{elmo-enable-disconnected-operation} is
4704 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4705 @c off-line operations are enabled.
4707 They are displayed if there are any of them. In the example above, in
4708 the sending queue there are two messages (the first and the second in
4709 the queue folder) for smtp to hosta and one (the third) for nntp to
4710 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4713 If you change @samp{(wl-plugged)} in the second line, the variable
4714 @code{wl-plugged} is changed, so that the mode line indicator and
4715 plugged states of all ports are affected. If you change plugged states
4716 of any servers or ports, @samp{(wl-plugged)} in the second line is
4717 affected depending on @code{elmo-plugged-condition} settings and the
4718 plugged state of each port.
4721 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4722 @section Invoking Wanderlust in the Off-line State
4724 As described before, if you set @code{wl-plugged} to @code{nil} in
4725 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4726 off-line state. You can specify off-line state on a per server or port
4727 basis. Refer to @code{wl-reset-plugged-alist} also.
4729 Usually, when Wanderlust starts up, the plugged state of each port is
4730 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4731 @code{wl-nntp-posting-server} and so on. If you want to change the
4732 plugged state of these ports or to add other ports, configure
4733 @code{wl-make-plugged-hook} with a function.
4737 (add-hook 'wl-make-plugged-hook
4739 (elmo-set-plugged plugged-value(t/nil) server port)
4740 ;; @r{add or change plugged states of the port of the server}
4741 (elmo-set-plugged plugged-value(t/nil) server)
4742 ;; @r{if the port is omitted, all ports are affected}
4743 ;; @r{(you cannot omit the port if you newly add the server)}
4749 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4750 @section Customizable Variables
4755 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4756 mode from the beginning.
4758 @item wl-queue-folder
4759 @vindex wl-queue-folder
4760 The initial setting is @samp{+queue}.
4761 This is the folder in which messages in the transmission queue are
4764 @item wl-auto-flush-queue
4765 @vindex wl-auto-flush-queue
4766 The initial setting is @code{t}.
4767 This flag controls automatic transmission of the queue when Wanderlust
4768 becomes on-line. If non-nil, the queue is automatically transmitted
4769 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4770 manually, press @kbd{F} in the folder mode.
4772 @item elmo-enable-disconnected-operation
4773 @vindex elmo-enable-disconnected-operation
4774 The initial setting is @code{nil}. Controls off-line operations
4775 regarding IMAP4. If non-nil, off-line operations are carried out.
4777 @item elmo-lost+found-folder
4778 @vindex elmo-lost+found-folder
4779 The initial setting is @samp{+lost+found}.
4780 This is the folder to which messages are saved when they fails to be
4781 appended while the off-line re-file/copy queue is processed.
4783 @item elmo-plugged-condition
4784 @vindex elmo-plugged-condition
4785 The initial setting is @code{one}.
4786 The value of @code{wl-plugged} reflects the return value of the function
4787 @code{elmo-plugged-p} (without arguments).
4788 This variable @code{elmo-plugged-condition} specifies the condition on
4789 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4790 plugged state of each port.
4793 'one : plugged if one or more ports are plugged.
4794 'all : plugged if all ports are plugged.
4795 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4796 states of the ports.
4797 @var{function} : reflects the return value of the @var{function}
4798 functions available per default
4799 'elmo-plug-on-by-servers
4800 : reflects the plugged state of the servers specified by the
4801 variable elmo-plug-on-servers.
4802 'elmo-plug-on-by-exclude-servers
4803 : reflects the plugged state of the servers that are not
4804 in elmo-plug-on-exclude-servers.
4805 elmo-plug-on-exclude-servers defaults to
4808 (system-name)without the domain part)
4814 (setq elmo-plugged-condition 'all)
4816 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4817 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4819 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4820 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4824 @item wl-reset-plugged-alist
4825 @vindex wl-reset-plugged-alist
4826 The initial setting is @code{t}. If non-nil, plugged states are
4827 initialized on a per server or port basis when Wanderlust starts up.
4829 If @code{nil}, plugged states are retained while Emacs is running. In
4830 other words, they are initialized when Emacs is restarted even if the
4831 value is @code{nil}.
4835 @node Expire and Archive, Scoring, Disconnected Operations, Top
4836 @chapter Automatic Expiration and Archiving of Messages
4837 @cindex Expire and Archive
4840 * Expire:: Expiration and Archiving
4841 * Archive:: Archiving All Messages
4845 @node Expire, Archive, Expire and Archive, Expire and Archive
4847 @cindex Expire Message
4849 Expiration means deletion of old messages which have outlasted a
4850 certain period of time.
4852 @code{wl-expire} supports not only simple deletion, but also moving to
4853 specified archiving folders.
4857 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4858 or @kbd{M-e} in the summary mode.
4860 @subsection Configuring @code{wl-expire-alist}
4862 An example configuration of @code{wl-expire-alist} is shown below.
4863 Everything in this @code{wl-expire-alist} makes a great difference in
4864 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4865 to @code{t}, especially in the initial stage.
4869 (setq wl-expire-alist
4870 '(("^\\+trash$" (date 14) remove)
4872 ("^\\+tmp$" (date 7) trash)
4873 ;; @r{re-file to @code{wl-trash-folder}}
4874 ("^\\+outbox$" (number 300) "$outbox;lha")
4875 ;; @r{re-file to the specific folder}
4877 ;; @r{do not expire}
4878 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4879 ;; @r{archive by message number (retaining numbers)}
4880 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4881 ;; @r{archive by a fixed number (retaining numbers)}
4882 ("^\\+diary$" (date 30) wl-expire-archive-date)
4883 ;; @r{archive by year and month (numbers discarded)}
4888 Items in the list has the format of:
4891 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4895 The folder is examined if it matches @var{regexp-for-folders} from the
4896 beginning of the list. If you invoke expiration on the folder that does
4897 not match any of them, nothing will happen. And if either the second or
4898 the third element of the item is @code{nil}, expiration will not take
4901 You can use any one of the following for
4902 @var{specification-of-message-to-be-deleted}:
4905 @item (number @var{n1} [@var{n2}])
4906 deletes messages depending on the number of messages in the folder.
4908 @var{n1} is the number of messages which should survive deletion, for example
4909 if its value is 500, the newest 500 messages survive and the rests are
4912 @var{n2} is the number of messages in the folder on which expiration should
4913 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4914 folders with 510 or more messages are expired.
4915 If you configured automatic expiration, frequently used folders may
4916 expire every time it receive messages, and you may be annoyed with the
4917 long delay in reading mail.
4918 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4919 expiration would not take place until a certain number of messages
4922 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4923 with important/new/unread) are not deleted.
4924 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4925 will expire so as to have 500 messages including such ones.
4926 Otherwise, it will have 500 messages except such ones.
4928 @item (date @var{d1})
4929 deletes messages depending on the dates.
4931 Messages dated @var{d1} or more days ago are deleted, for example if its
4932 value is seven, messages seven days old or more are deleted. Note that
4933 the date is the one in the @samp{Date:} field of the message, not when
4934 the message entered the folder.
4936 Messages with no or invalid @samp{Date:} field does not expire; you
4937 might have to delete them by hand.
4940 You can use any one of the following in the place of @var{destination}:
4944 deletes the messages instantly.
4947 hide the messages from summary (messages are not deleted).
4950 moves the messages to @code{wl-trash-folder}.
4952 @item @var{string}(folder)
4953 moves the messages to the folder specified with @var{string}.
4955 It would be useful for specifying an archiving folder, but because this
4956 does not move important messages, it might be better to use the
4957 standard functions described below.
4959 @item @var{function}
4960 invokes the specified @var{function}.
4962 To the @var{function}, three arguments are passed: a folder name, a list
4963 of messages to be deleted, and msgdb information of the summary. You
4964 can specify function-specific arguments after the name of the
4965 @var{function}. Note that the list contains messages with marks in
4966 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4969 These are three standard functions; they moves messages to an archive
4970 folder in the specified way. This means old messages can be compressed
4971 and saved in a file, being deleted from the original folder.
4974 @item wl-expire-archive-number1
4975 re-files to archiving folders corresponding to the message numbers of
4976 the messages being deleted. For example, a message numbered 102 will be
4977 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4978 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4979 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4981 The archiving folders to which messages are re-filed are determined by
4982 the name of the folder as follows (in this case, archiving folders are
4983 handled as if @code{elmo-archive-treat-file} were non-nil).
4986 @item If the folder type is localdir:
4987 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4989 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4990 (@file{~/Mail/ml/wl-00100.zip}).
4992 @item The folder type is other than localdir:
4993 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4995 For example, @samp{%#mh/ml/wl} corresponds to
4996 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4999 As you can see, in the case of localdir, the folder type is not included
5000 in the path name, but otherwise it is included.
5001 And you can control the prefix to the archiving folder name by
5002 @code{wl-expire-archive-folder-prefix}.
5003 Refer to @code{wl-expire-archive-folder-prefix} for details.
5005 @item wl-expire-archive-number2
5006 re-files every certain number of messages to archiving folders.
5008 This differs from @samp{wl-expire-archive-number1} in that this re-files
5009 to the folder up to the specified number regardless of message numbers.
5010 The archiving folders to which messages are re-filed are determined in the
5011 same way as @code{wl-expire-archive-number1}.
5013 @item wl-expire-archive-date
5014 re-files messages depending on its date (year and month) to archive
5017 For example, a message dated December 1998 is re-filed to
5018 @code{$folder-199812;zip}. The name of the archiving folders except the
5019 date part are determined in the same way as
5020 @code{wl-expire-archive-number1}.
5023 You can set the first argument to these three standard functions to non-nil
5024 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5025 For example, it can be specified just after the name of the function:
5028 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5031 If you omit the argument, consecutive numbers from 1 are assigned for
5032 each archiving folder.
5035 @subsection Treatment for Important or Unread Messages
5037 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5038 standard function, messages with marks in
5039 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5040 messages} thereafter) are retained.
5042 Per default, this variable include the important, new, and unread marks,
5043 so that messages with these marks are not removed.
5044 Note that you cannot include the temporary mark (i.e. temporary marks
5045 are removed anyway), and be sure to process temporary marks before you
5048 @subsection Auto Expiration
5050 The following setup invokes expiration when you move into the summary
5051 mode. There will be no confirmation, so make sure you made no mistake
5052 in regexp and other settings before you set up this.
5056 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5060 In the folder mode, you can invoke expiration per group as well as per
5061 folder. Therefore, if you specify @samp{Desktop} group, all folders
5062 matching @code{wl-expire-alist} expire.
5066 @subsection Treating archive folders.
5067 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5068 you must set non-nil value to @code{elmo-archive-treat-file}.
5070 @subsection Confirming
5072 If you are to use @code{remove}, try @code{trash} at first and see
5073 messages move to @code{wl-trash-folder} as expected, then replace it
5074 with @code{remove}. It would be dangerous to use @code{remove} from the
5077 If you are to use @code{wl-expire-archive-number1} and the like, try to
5078 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5079 you can append messages to it. Even if settings in
5080 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5081 would not be saved anywhere and disappeared in case the archiver program
5084 After you make sure you can archive to the folder correctly, you can
5085 invoke expiration and utilize the log.
5087 If you set @code{wl-expire-use-log} to @code{t},
5088 @file{~/.elmo/expired-log} should contain the log, for example:
5092 delete +ml/wl (593 594 595 596 597 598 599)
5093 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5097 The first column indicates the operation, i.e. @samp{delete},
5098 @samp{copy}, or @samp{move}. The next is the name of the folder that
5099 expired. In the case of @samp{copy} and @samp{move}, the destination
5100 folder is recorded after @samp{->}. The last is the list of message
5101 numbers that are actually deleted or moved (in the case of @samp{copy}
5102 and @samp{move}, the number is the one in the source folder, rather than
5103 the destination folder).
5105 @subsection Re-filing Reserved Messages
5107 The three standard functions copy reserved messages to the archive
5108 folder, but do not delete them from the source folder. Because
5109 reserved messages and the like always remain, they are recorded in
5110 @file{~/.elmo/expired-alist} so that they are not copied over and over
5111 again. They are not recorded if copied by @code{wl-summary-archive}.
5113 If you enabled logging, usually @samp{move} is recorded for re-filing,
5114 but instead @samp{copy} and @samp{delete} are recorded separately if
5115 reserved messages are involved. This is because it actually copies
5116 messages including reserved, then deletes ones except reserved in that
5119 @section Customizable Variables
5122 @item wl-expire-alist
5123 @vindex wl-expire-alist
5124 The initial setting is @code{nil}.
5125 This variable specifies folders and methods to expire. For details,
5126 refer to @code{wl-expire-alist} settings above.
5128 @item wl-summary-expire-reserve-marks
5129 @vindex wl-summary-expire-reserve-marks
5130 The initial setting is the list below.
5134 (list wl-summary-important-mark
5136 wl-summary-unread-mark
5137 wl-summary-unread-uncached-mark
5138 wl-summary-unread-cached-mark)
5142 Messages with these marks are retained in the folder, even after
5144 Only permanent marks can be listed, not temporary marks.
5146 You can list marks one by one as in the default; you can use the
5147 following settings as well:
5151 All messages with permanent marks are retained,
5152 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5156 All messages are handled as usual ones that are already read, no matter
5157 what marks they have; even important messages are deleted.
5160 @item wl-expire-archive-files
5161 @vindex wl-expire-archive-files
5162 The initial setting is 100.
5163 This variable specifies the number of messages to be retained in one
5166 @item wl-expire-number-with-reserve-marks
5167 @vindex wl-expire-number-with-reserve-marks
5168 The initial setting is @code{nil}.
5169 If non-nil, if expiring messages are specified by @code{number},
5170 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5172 @item wl-expire-archive-get-folder-function
5173 @vindex wl-expire-archive-get-folder-function
5174 The initial setting is @code{wl-expire-archive-get-folder}.
5176 This variable specifies a function that returns the name of an archiving
5177 folder for standard functions in the place of @var{destination}.
5178 You can use the following three variables for simple modification of
5179 folder names; if you want more complex settings, define your own
5180 function in this variable.
5182 @code{wl-expire-archive-get-folder} can be customized by these
5185 @item @code{wl-expire-archive-folder-name-fmt}
5186 @item @code{wl-expire-archive-folder-type}
5187 @item @code{wl-expire-archive-folder-prefix}
5190 @item wl-expire-archive-folder-name-fmt
5191 @vindex wl-expire-archive-folder-name-fmt
5192 The initial setting is @samp{%s-%%05d;%s}.
5193 This is a @code{format} string for archiving folders used in
5194 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5195 Note that you must specify the message number by @samp{%%d}, because it
5196 is parsed twice by @code{format}.
5198 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5201 @item wl-expire-archive-date-folder-name-fmt
5202 @vindex wl-expire-archive-date-folder-name-fmt
5203 The initial setting is @samp{%s-%%04d%%02d;%s}.
5204 This is a @code{format} string for archiving folders used in
5205 @code{wl-expire-archive-date}. Note that you must specify the message
5206 number by @samp{%%d}, because it is parsed twice by @code{format}.
5207 There should be @samp{%%d} twice, one for the year and the other for the
5210 If you modify this, adjust
5211 @code{wl-expire-archive-date-folder-num-regexp} as well.
5213 @item wl-expire-archive-folder-type
5214 @vindex wl-expire-archive-folder-type
5215 The initial setting is @code{zip}.
5216 This variable specifies an archiver type of the archiving folders.
5218 @item wl-expire-archive-folder-prefix
5219 @vindex wl-expire-archive-folder-prefix
5220 The initial setting is @code{nil}.
5221 This variable specifies the prefix (directory structure) to archiving
5223 Exercise extreme caution in using this feature, as it has not been
5225 In the worst case, there is a fear of destructing archiving folders.
5229 There will be no prefix.
5232 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5233 @samp{$ml/wl-00000;zip;wl}.
5236 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5239 @samp{$ml/wl-00000;zip;ml/wl}.
5242 @item wl-expire-archive-folder-num-regexp
5243 @vindex wl-expire-archive-folder-num-regexp
5244 The initial setting is @samp{-\\([-0-9]+\\);}.
5245 This variable specifies the regular expression to be used for getting
5246 message numbers from multiple archiving folders specified by
5247 @code{elmo-list-folders}.
5248 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5250 @item wl-expire-archive-date-folder-num-regexp
5251 @vindex wl-expire-archive-date-folder-num-regexp
5252 The initial setting is @samp{-\\([-0-9]+\\);}.
5253 This is the regular expression to be used for getting message numbers
5254 from multiple archiving folders specified by @code{elmo-list-folders}.
5255 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5257 @item wl-expire-delete-oldmsg-confirm
5258 @vindex wl-expire-delete-oldmsg-confirm
5259 The initial setting is @code{t}.
5260 If non-nil, messages older than the one with the largest number will be
5261 deleted with confirmation.
5262 If @code{nil}, they are deleted without confirmation.
5264 This feature is valid only if non-nil is specified as a argument to the
5265 standard functions so as to retain numbers.
5267 @item wl-expire-use-log
5268 @vindex wl-expire-use-log
5269 The initial setting is @code{nil}.
5270 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5271 They are appended but not truncated or rotated automatically; you might
5272 need to remove it manually.
5274 @item wl-expire-add-seen-list
5275 @vindex wl-expire-add-seen-list
5276 The initial setting is @code{t}.
5278 If non-nil, when messages are re-filed by expiration, read/unread
5279 information is passed to the destination folder.
5281 However if you do not read the destination folder from Wanderlust,
5282 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5283 want to set this to @code{nil} if you are simply saving to some
5284 archiving folders. Even if its value is @code{nil}, messages in the
5285 archiving folders are simply treated as unread; it does not affect
5288 @item wl-expire-folder-update-msgdb
5289 @vindex wl-expire-folder-update-msgdb
5290 The initial setting is @code{t}.
5291 If @code{t}, in the folder mode, expiration is carried out after
5292 updating summary information. If you specified a list of regular
5293 expressions of folder names, summary information is updated for matching
5298 @node Archive, , Expire, Expire and Archive
5299 @section Archiving Messages
5301 @subsection Archiving Messages
5302 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5303 folders. If there are the archiving folders already, only new messages
5306 You can use @code{wl-archive-alist} in order to specify how messages are
5307 archived according to their folder names, as in @code{wl-expire-alist}.
5312 (setq wl-archive-alist
5313 '(("^\\+tmp$" wl-archive-date)
5314 ("^\\+outbox$" wl-archive-number2)
5315 (".*" wl-archive-number1)))
5319 Each item in the list has the following format:
5322 (@var{folders-regexp} @var{deleting-function})
5325 As you can see, you can only use a function after @var{folders-regexp}.
5326 Per default, there are three functions:
5329 @item @code{wl-archive-number1}
5330 @item @code{wl-archive-number2}
5331 @item @code{wl-archive-date}
5334 As inferred from their names, they work similarly to "expire" versions,
5335 other than the following points:
5338 @item No messages are deleted
5339 @item Message numbers are retained even if invoked without arguments
5342 These functions are good to archive all messages in a folder by their
5343 numbers or by their dates.
5344 These are also useful for backup or confirmation purposes before
5346 If you try to re-file them after they are archived, they are deleted but
5349 Per default, the archiving folders to which messages are copied are
5350 determined automatically by @code{wl-expire-archive-get-folder-function}.
5351 You can copy to a specific folder by invoking with a prefix argument,
5352 i.e. @kbd{C-u M-x wl-summary-archive}.
5354 Note that this feature has not been seriously tested, because you can
5355 simply copy to an archiving folder, for example by
5356 @code{wl-summary-copy-region}.
5358 The archiving folders are determined by the same logic as in
5359 @code{wl-summary-expire}; the following customizable variables are
5363 @item @code{wl-expire-archive-files}
5364 @item @code{wl-expire-archive-get-folder-function}
5365 @item @code{wl-expire-archive-folder-name-fmt}
5366 @item @code{wl-expire-archive-folder-type}
5367 @item @code{wl-expire-archive-folder-prefix}
5368 @item @code{wl-expire-archive-folder-num-regexp}
5371 @subsection Customizable Variables
5374 @item wl-archive-alist
5375 @vindex wl-archive-alist
5376 The initial setting is the list shown below:
5380 ((".*" wl-archive-number1))
5385 This variable specifies a function that copies to archiving folders.
5386 To the function, three arguments are passed: a folder name, a list of
5387 messages in the folder, and msgdb information of the summary.
5388 Needless to say, you can use your own function.
5392 @node Scoring, Address Book, Expire and Archive, Top
5393 @chapter Score of the Messages
5395 @c @cindex Kill File
5397 Scoring is the function that associates a score (value) with each
5398 message, and marks as read or deletes from the summary according to it.
5400 You can put target or important marks on essential messages, or read marks
5401 on the ones you do not want to read, for example spam articles.
5403 This scoring function has a capability and a format similar to the one
5404 that Gnus has, although there are some unsupported features and
5405 Wanderlust specifics.
5406 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5409 * Score Commands:: Score Commands
5410 * Score File Format:: Score File Format
5414 @node Score Commands, Score File Format, Scoring, Scoring
5415 @section Score Commands
5416 @cindex Score Commands
5418 @subsection Score File Specification
5420 @code{wl-score-folder-alist} specifies score files or variables in which
5421 scores are defined, corresponding to folder names.
5425 (setq wl-score-folder-alist
5434 If paths to the score files are omitted, the directory specified in the
5435 variable @code{wl-score-files-dir} is assumed.
5437 No matter what you write in @code{wl-score-folder-alist}, the default
5438 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5439 read (it does not have to exist).
5440 Therefore, in the example above, the three score files,
5441 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5442 the folders that matches @samp{^-.*}.
5444 @subsection Scored Messages
5446 Scores are attached to the messages that are specified by
5447 @code{wl-summary-score-marks} temporarily when the summary is updated;
5448 when you exit from the summary, the scores are removed and reverts to
5451 @subsection Creation of Score Files
5453 In the summary buffer, move to an appropriate message and type @kbd{L}.
5454 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5455 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5457 This makes @minus{}1000 are scored for messages with the same
5458 @samp{Subject:} as the string you entered. That is, such a score file
5459 is created automatically.
5461 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5462 The score file you just made appears.
5463 This buffer is called @dfn{score editing buffer} thereafter.
5464 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5465 as you are previously; type @kbd{a}. Then a score entry for "From"
5467 In this way, you can create a score file easily either in the summary
5468 buffer or in the score editing buffer.
5470 By the way, you might be aware the numbers of key strokes are different
5471 between @kbd{s s p} and @kbd{a}.
5472 This is determined by @code{wl-score-header-default-entry}.
5473 This variable specifies the default score entries corresponding to
5475 For example, for "subject" field, a type and a time limit are prompted,
5476 but for "from" field, they are fixed upon automatically as substring and
5477 permanent respectively.
5478 However, score values can be modified by the prefix argument.
5479 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5482 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5483 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5484 erasing contents of the buffer deletes the score file being edited.
5488 @subsubsection Selecting Score Files
5490 You can change score files to which scores are appended by
5491 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5492 @code{wl-score-change-score-file}.
5494 @subsubsection Summing Up the Score
5496 If you add the same entries by @code{wl-summary-increase-score},
5497 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5498 scores for the entry is summed up.
5500 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5501 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5502 @minus{}1200 will be created as a result.
5504 @subsubsection Creating Thread Key
5506 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5507 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5509 @subsubsection Creating Followup Key
5511 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5512 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5513 at the cursor to @samp{References} key.
5514 If @code{wl-score-auto-make-followup-entry} is non-nil,
5515 @samp{Message-ID} of all messages to be followed up within dates
5516 specified by @code{wl-score-expiry-days}.
5518 @subsection Key Bindings
5523 @findex wl-summary-increase-score
5524 Increases the score for the current message.
5525 And the score entry is appended to the score file at the same moment.
5526 You can specify the score value by a prefix argument.
5530 @findex wl-summary-lower-score
5531 Decreases the score for the current message.
5532 And the score entry is appended to the score file at the same moment.
5533 You can specify the score value by a prefix argument.
5536 @kindex h R (Summary)
5537 @findex wl-summary-rescore
5538 Re-applies the scoring.
5539 However, already scored messages are not scored anew.
5542 @kindex h c (Summary)
5543 @findex wl-score-change-score-file
5544 Changes the score file currently selected.
5547 @kindex h e (Summary)
5548 @findex wl-score-edit-current-scores
5549 Edits the score file currently selected.
5550 If there are multiple score files, the previously specified one is
5554 @kindex h f (Summary)
5555 @findex wl-score-edit-file
5556 Edits an arbitrary score file and selects it.
5559 @kindex h F (Summary)
5560 @findex wl-score-flush-cache
5561 Erases caches associated to the score files that are read.
5562 If you modified score files directly (from other than Wanderlust), you
5563 need to re-read them after erasing the cache.
5566 @kindex h m (Summary)
5567 @findex wl-score-set-mark-below
5568 Specifies the criterion for scores to be marked as read.
5569 Messages with scores less than this value are marked as read.
5572 @kindex h x (Summary)
5573 @findex wl-score-set-expunge-below
5574 Specifies the criterion for scores to be deleted from the summary.
5575 Messages with scores less than this value are deleted.
5576 "Deleted" means it is not shown; they are not removed from the summary
5577 information or the folder.
5578 The deleted messages can be shown by rescan-noscore again.
5581 @subsection Key Bindings in the Score Editing Buffer
5585 @kindex C-c C-k (Score Mode)
5586 @findex wl-score-edit-kill
5587 Abandons the file being edited.
5590 @kindex C-c C-c (Score Mode)
5591 @findex wl-score-edit-exit
5592 Saves the file being edited, and quits from the edit mode.
5595 @kindex C-c C-p (Score Mode)
5596 @findex wl-score-pretty-print
5600 @kindex C-c C-d (Score Mode)
5601 @findex wl-score-edit-insert-date
5602 Inserts the number of dates from Dec. 31, 1 B.C.
5603 It is used for creating the third factor of time-limited scores.
5606 @kindex C-c C-s (Score Mode)
5607 @findex wl-score-edit-insert-header
5608 Inserts the header of the message selected in the summary buffer.
5611 @kindex C-c C-e (Score Mode)
5612 @findex wl-score-edit-insert-entry
5613 Inserts the score entry of the message selected in the summary buffer.
5616 @subsection Customizable Variables
5619 @item wl-summary-default-score
5620 @vindex wl-summary-default-score
5621 The initial setting is 0 (zero).
5622 This variable specifies the default value of the score.
5623 The score is increased or decreased based upon this value.
5625 @item wl-summary-important-above
5626 @vindex wl-summary-important-above
5627 The initial setting is @code{nil}.
5628 Messages with scores larger than this value are attached with the
5629 important mark (@samp{$}).
5630 If @code{nil}, no important marks are attached.
5632 @item wl-summary-target-above
5633 @vindex wl-summary-target-above
5634 The initial setting is @code{nil}.
5635 Messages with scores larger than this value are attached with the target
5637 If @code{nil}, no target marks are attached.
5639 @item wl-summary-mark-below
5640 @vindex wl-summary-mark-below
5641 The initial setting is 0 (zero).
5642 Messages with scores smaller than this value are marked as read.
5644 @item wl-summary-expunge-below
5645 @vindex wl-summary-expunge-below
5646 The initial setting is @code{nil}.
5647 Messages with scores smaller than this value are deleted from the
5649 If @code{nil}, they are not deleted.
5651 @item wl-summary-score-marks
5652 @vindex wl-summary-score-marks
5653 The initial setting is the list shown below:
5657 (list wl-summary-new-mark)
5662 Messages with these marks are scored.
5664 @item wl-use-scoring
5665 @vindex wl-use-scoring
5666 The initial setting is t.
5667 If non-nil, scoring is enabled.
5669 @item wl-score-files-dir
5670 @vindex wl-score-files-dir
5671 The initial setting is @file{~/.elmo/}.
5672 The default directory for score files.
5674 @item wl-score-interactive-default-score
5675 @vindex wl-score-interactive-default-score
5676 The initial setting is 1000.
5677 This value is used as a score when a score factor is @code{nil} in the
5678 score file. It is also used in @code{wl-summary-increase-score} and
5679 @code{wl-summary-lower-score}, on condition that the value of
5680 @code{wl-score-header-default-entry} is @code{nil}.
5682 @item wl-score-expiry-days
5683 @vindex wl-score-expiry-days
5684 The initial setting is 7.
5685 This is the number of days before time-limited scores are deleted.
5687 @item wl-score-update-entry-dates
5688 @vindex wl-score-update-entry-dates
5689 The initial setting is @code{t}.
5690 If non-nil, it enables deletion of time-limited scores.
5692 @item wl-score-header-default-entry
5693 @vindex wl-score-header-default-entry
5694 Specifies the default value for each header field for score entries
5695 created by @code{wl-summary-increase-score},
5696 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5698 @item wl-score-simplify-fuzzy-regexp
5699 @vindex wl-score-simplify-fuzzy-regexp
5700 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5701 regular expression to be deleted from the string.
5702 Because this is usually used for Subject, the default is prefixes that
5703 are attached by mailing list programs.
5705 @item wl-summary-rescore-partial-threshold
5706 @vindex wl-summary-rescore-partial-threshold
5707 The initial setting is 200.
5708 When sync-all or rescan is executed, if there are messages more than
5709 this value, only the last same number of messages as this value are
5712 @item wl-summary-auto-sync-marks
5713 @vindex wl-summary-auto-sync-marks
5714 If non-nil, unread/important marks are synchronized when the summary
5716 Unread marks reflect information on the IMAP4 server.
5717 Important marks reflect information on the IMAP4 server (flagged or
5718 not), and contents of @samp{'mark} folder.
5719 The initial setting is @code{t}.
5723 @node Score File Format, , Score Commands, Scoring
5724 @section Score File Format
5725 @cindex Score File Format
5727 The format of score files are the same as Gnus, and basically you can
5728 use Gnus score files as they are. But they are not fully compatible
5729 because some keys are not supported and there are Wanderlust specifics.
5730 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5735 ("for sale" -1000 nil s)
5736 ("profit" -1000 nil s))
5738 ("spam@@spamspamspam" -10000 nil s))
5740 ("my@@address" 3001 nil s))
5742 (1000000 -10 nil >))
5752 If the key is a string, it is the name of the header to be matched.
5753 The following keys are available:
5754 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5755 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5756 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5757 @code{Chars} and @code{Lines} mean the size and the number of lines of
5758 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5759 are described later.
5760 The rest corresponds the field of the same name.
5762 Arbitrary numbers of core entries are specified after the key.
5763 Each score entry consists of these five factors:
5767 A factor that matches header. This should be a number in the cases of
5768 @code{lines} and @code{chars}, otherwise a string.
5771 A score factor. When the first item matches, the score of the message
5772 is increased or decreased by this value.
5775 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5776 of a number, the score is deleted if it does not match for days
5777 (@code{wl-score-expiry-days}) from the date specified by this.
5778 The date is since Dec. 31, 1 B.C.
5781 A type factor. This specifies the way the first factor matches.
5782 Available types depend on keys.
5785 @item From, Subject, References, Message-ID
5786 For these keys in string, @code{r} and @code{R} (regexp),
5787 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5788 as well as @code{f} and @code{F} (fuzzy) can be used.
5789 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5792 For these keys, the following five numerical relative operators can be
5793 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5796 This key matches @code{From} header, and scores all follow-ups to the
5798 For example, it would be useful for increasing scores for follow-ups to
5801 You can use the same types as @code{From} except for @code{f}.
5802 And a @samp{Followup} entry is automatically appended to the score file.
5805 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5806 A @samp{Thread} entry is automatically appended for each article that
5807 has @var{x} in the @code{References} header.
5808 You can make sure the whole thread including messages that does not have
5809 all ancestors @code{Message-ID} in @code{References} is scored.
5811 You can use the same types as @code{References} except for @code{f}.
5812 And a @samp{Thread} entry is automatically appended to the score file.
5816 A factor for extension header. This is meaningful only if the key is
5818 This specifies headers to be matched other than standard headers like
5819 @code{Subject} and @code{From}.
5820 Note that you should specify the header in
5821 @code{elmo-msgdb-extra-fields} also.
5822 Therefore it does not work in folders where extension headers cannot be
5827 The sum of these scores @emph{after all factors are applied} becomes the
5828 score of the message.
5830 @cindex Score File Atoms
5832 Messages with a score less than this value is marked as read.
5833 The default is @code{wl-summary-mark-below}.
5836 Messages with a score less than this value is deleted from the summary.
5837 The default is @code{wl-summary-expunge-below}.
5839 @item mark-and-expunge
5840 Both @code{mark} and @code{expunge} are applied,
5841 i.e. messages with a score less than this value is marked as read and
5842 deleted from the summary.
5845 Messages with a score greater than this value is attached with temp
5847 The default is @code{wl-summary-target-above}.
5850 Messages with a score greater than this value is attached with important
5852 The default is @code{wl-summary-important-above}.
5857 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5858 are used, you need to set @code{elmo-msgdb-extra-fields}.
5861 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5864 There are other restrictions as shown below:
5867 @item Because @samp{References} field in the summary information
5868 contains only the last @samp{Message-ID}, @code{references} key matches
5872 Keys that can be seen by folder of types:
5876 chars lines xref extra
5877 localdir,localnews Y E E E
5878 nntp (supporting xover) Y E E N
5884 N: cannot be seen (ignored)
5885 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5890 @node Address Book, Customization, Scoring, Top
5891 @chapter Address Book
5892 @cindex Address Book
5894 With address book, you can utilize address completion, and you have
5895 summary displayed with nicknames.
5898 * Mail Addresses:: Definition of Address Book
5899 * Address Manager:: Address Manager
5902 @node Mail Addresses, Address Manager, Address Book, Address Book
5903 @section Address book
5904 @cindex Address book Definition
5906 @cindex Alias, Address
5908 The file @file{~/.addresses} is a simple address book for Wanderlust.
5909 Make address file @file{~/.addresses}, and edit to suit your requirement.
5911 The data written in @file{~/.addresses} are used for address completion
5912 under draft editing mode. Furthermore, they are used when showing names
5913 in summary display mode. You can safely skip this section, if you don't
5914 want to customize address completion and summary display.
5915 It is possible to add/change/remove addresses from @file{~/.addresses} in
5916 summary buffer after Wanderlust is invoked. @refill
5918 The format is very simple. Like this. @refill
5923 # @r{Lines begin with @samp{#} are comment.}
5924 # @r{Empty lines are ignored}
5926 # @r{Format of each line:}
5927 # @var{email-address} "@var{nickname} "@var{realname}"
5929 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
5930 foo@@bar.gohome.org "Mr. Foo" "John Foo"
5931 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
5936 One line defines one persons description.
5938 Actually, in default setup, @var{nickname} is used in summary-mode and
5939 @var{realname} is used in draft preparation mode. This behavior is
5940 better understood if you try it and confirmed the function first. You
5941 can write and try a small definition, so you will know the idea of the
5942 address book before writing a big one.
5944 And, if MH alias file is specified in variable @code{wl-alias-file},
5945 it is used as an address information in the draft preparation mode.
5947 If variable @code{wl-use-ldap} is non-nil (initial setting is
5948 @code{nil}), address completion in draft mode uses LDAP information.
5950 If you use LDAP, you have to set @code{wl-ldap-server},
5951 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
5952 not have LDAP feature as built-in feature (Currently only XEmacs can
5953 have built-in LDAP feature), you have to set command exec @env{PATH} to
5954 the program @command{ldapsearch}.
5957 @node Address Manager, , Mail Addresses, Address Book
5958 @section Address Manager
5959 @cindex Address Manager
5961 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
5962 the address book and insert address to draft buffer.
5964 @subsection Key Bindings
5968 @kindex t (Address Manager)
5969 @findex wl-addrmgr-set-to
5970 Add @samp{To:} mark.
5973 @kindex c (Address Manager)
5974 @findex wl-addrmgr-set-cc
5975 Add @samp{Cc:} mark.
5978 @kindex b (Address Manager)
5979 @findex wl-addrmgr-set-bcc
5980 Add @samp{Bcc:} mark.
5983 @kindex u (Address Manager)
5984 @findex wl-addrmgr-unmark
5988 @kindex x (Address Manager)
5989 @findex wl-addrmgr-apply
5991 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
5992 buffer and quit address manager. When no draft buffer, make new draft
5993 with insert marked addresses.
5995 If no mark, quit address manager.
5999 @kindex q (Address Manager)
6000 @findex wl-addrmgr-quit
6001 Quit address manager.
6004 @kindex a (Address Manager)
6005 @findex wl-addrmgr-add
6009 @kindex d (Address Manager)
6010 @findex wl-addrmgr-delete
6014 @kindex e (Address Manager)
6015 @findex wl-addrmgr-edit
6020 @node Customization, Mailing List, Address Book, Top
6021 @chapter Customizing Wanderlust
6022 @cindex Customization
6025 * Living with other packages:: Cooperating with other packages
6026 * Highlights:: Highlights
6027 * Biff:: Notify Mail arrival
6028 * Advanced Settings:: Advanced Settings
6029 * Customizable Variables:: Customizable Variables
6034 @node Living with other packages, Highlights, Customization, Customization
6035 @section Living with other packages
6037 Examples with other packages.
6040 * imput:: imput (im-wl.el)
6042 * supercite:: supercite.el
6043 * mu-cite:: mu-cite.el
6044 * X-Face:: x-face,bitmap-mule
6045 * dired-dd:: dired-dd.el
6047 * Addrbook:: Addrbook
6048 * mime-w3m:: mime-w3m.el
6052 @node imput, BBDB, Living with other packages, Living with other packages
6057 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6060 If @command{imput} is on the @code{exec-path} at the installation,
6061 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6065 (autoload 'wl-draft-send-with-imput-async "im-wl")
6066 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6071 @node BBDB, supercite, imput, Living with other packages
6075 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6078 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6079 byte-compiled and installed.
6087 ;; @r{enable pop-ups}
6088 (setq bbdb-use-pop-up t)
6089 ;; @r{auto collection}
6090 (setq bbdb/mail-auto-create-p t)
6091 (setq signature-use-bbdb t)
6092 (setq bbdb-north-american-phone-numbers-p nil)
6093 ;; @r{shows the name of bbdb in the summary} :-)
6094 (setq wl-summary-from-function 'bbdb-wl-from-func)
6095 ;; @r{automatically add mailing list fields}
6096 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6097 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6101 @node supercite, mu-cite, BBDB, Living with other packages
6102 @subsection sc.el(supercite), sc-register.el
6106 The same setting as usual mailers should be OK. The following is an
6107 example of settings:
6111 (autoload 'sc-cite-original "sc" nil t)
6112 (setq mail-yank-hooks 'sc-cite-original)
6113 (setq sc-preferred-header-style 1)
6114 (setq sc-electric-references-p nil)
6115 (setq sc-citation-leader "")
6116 (setq sc-load-hook '(lambda () (require 'sc-register)))
6117 (setq sc-preferred-attribution 'registeredname)
6122 @node mu-cite, X-Face, supercite, Living with other packages
6123 @subsection mu-cite.el
6126 The same setting as usual mailers should be OK. The following is an
6127 example of settings.
6129 If you use mu-cite version 8.0 or earlier:
6133 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6134 (setq mail-citation-hook 'mu-cite/cite-original)
6138 If you use mu-cite version 8.1 or later:
6142 (autoload 'mu-cite-original "mu-cite" nil t)
6143 (add-hook 'mail-citation-hook (function mu-cite-original))
6147 @node X-Face, dired-dd, mu-cite, Living with other packages
6151 If you have installed one of the following, you can decode
6152 @samp{X-Face:} field in message buffer and you will see face image.
6155 * x-face-xmas:: XEmacs case
6156 * x-face-mule:: Emacs 19.34, 20.x case
6157 * x-face-e21:: Emacs 21.x case
6160 If there is an encoded X-Face string in a file @file{~/.xface} (the
6161 value of the variable @code{wl-x-face-file}), it is inserted as a
6162 @samp{X-Face:} field in the draft buffer (if
6163 @code{wl-auto-insert-x-face} is non-nil).
6165 @node x-face-xmas, x-face-mule, X-Face, X-Face
6166 @subsubsection x-face-xmas (for XEmacs)
6169 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6170 1.3.6.13 or later, do the following:
6174 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6175 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6179 @node x-face-mule, x-face-e21, x-face-xmas, X-Face
6180 @subsubsection x-face-mule (for Emacs 19.34, 20.x)
6184 If you use @file{x-face-mule.el} in bitmap-mule
6185 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6189 (autoload 'x-face-decode-message-header "x-face-mule")
6190 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6194 @node x-face-e21, , x-face-mule, X-Face
6195 @subsubsection x-face-e21 (for Emacs 21.x)
6198 If you use @file{x-face-e21.el} (@uref{ftp://jpl.org/pub/elisp/})
6199 with bitmap-mule (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}),
6205 (autoload 'x-face-decode-message-header "x-face-e21")
6206 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6211 @node dired-dd, MHC, X-Face, Living with other packages
6212 @subsection dired-dd(Dired-DragDrop)
6213 @pindex Dired-DragDrop
6215 @cindex Drag and Drop
6217 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6218 compose multi-part by simple Drag-and-Drop from dired to the draft
6219 buffer being edited in GNU Emacs (this feature is not Wanderlust
6220 specific, but general-purpose for SEMI).
6224 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6230 ;; @r{Set dired-x variables here.}
6231 ;; @r{To and flo@dots{}}
6233 (progn (require 'dired-dd)
6234 (require 'dired-dd-mime))))))
6238 @node MHC, Addrbook, dired-dd, Living with other packages
6242 Message Harmonized Calendaring system
6243 (@uref{http://www.quickhack.net/mhc/})
6245 By using MHC, you can make a calendar from the messages.
6251 (setq mhc-mailer-package 'wl)
6252 (autoload 'mhc-mode "mhc" nil t)
6253 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6254 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6262 (autoload 'mhc-wl-setup "mhc-wl")
6263 (add-hook 'wl-init-hook 'mhc-wl-setup)
6267 @node Addrbook, mime-w3m, MHC, Living with other packages
6268 @subsection wl-addrbook.el
6272 (@uref{http://www.mew.org/})
6274 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6275 @code{load-path} and do the following settings.
6279 (require 'wl-addrbook)
6284 @node mime-w3m, , Addrbook, Living with other packages
6285 @subsection mime-w3m.el
6288 You can display html part by using @file{mime-w3m.el}
6289 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6290 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6293 @node Highlights, Biff, Living with other packages, Customization
6296 @subsection Customizable Variables
6299 @item wl-summary-highlight
6300 @vindex wl-summary-highlight
6301 The initial setting is @code{t}.
6302 If non-nil, the summary is highlighted.
6304 @item wl-highlight-max-summary-lines
6305 @vindex wl-highlight-max-summary-lines
6306 The initial setting is 10000.
6307 The summary is not highlighted if it has more lines than this value.
6309 @item wl-summary-highlight-partial-threshold
6310 @vindex wl-summary-highlight-partial-threshold
6311 The initial setting is 1000.
6312 This is a threshold whether the whole summary is highlighted.
6313 If there are more lines of messages in the summary, it is partially
6316 @item wl-summary-partial-highlight-above-lines
6317 @vindex wl-summary-partial-highlight-above-lines
6318 The initial setting is 30. If there are more lines of messages than
6319 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6320 after the point that is the same number of lines as this value above the
6321 cursor line are highlighted partially. (If this value is @code{nil},
6322 the last same number of lines as the value of
6323 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6325 @item wl-highlight-body-too
6326 @vindex wl-highlight-body-too
6327 The initial setting is @code{t}.
6328 If non-nil, bodies of drafts and messages are also highlighted.
6330 @item wl-highlight-message-header-alist
6331 @vindex wl-highlight-message-header-alist
6332 When highlighting headers of drafts and messages, this variable
6333 specifies which faces are allocated to important
6334 (@code{wl-highlight-message-important-header-contents}), secondly
6335 important (@code{wl-highlight-message-important-header-contents2}), and
6336 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6338 Similarly, it can be used for allocating arbitrary faces to arbitrary
6339 regular expressions.
6341 @item wl-highlight-citation-prefix-regexp
6342 @vindex wl-highlight-citation-prefix-regexp
6343 Specifies a regular expression to which quoted lines in bodies of
6344 drafts and messages match.
6345 Bodies matching to this regular expression are highlighted by the faces
6346 specified by (@code{wl-highlight-message-cited-text-*}).
6348 @item wl-highlight-highlight-citation-too
6349 @vindex wl-highlight-highlight-citation-too
6350 The initial setting is @code{nil}.
6351 If non-nil, the quoting regular expression itself given by
6352 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6354 @item wl-highlight-citation-header-regexp
6355 @vindex wl-highlight-citation-header-regexp
6356 Specifies a regular expression that denotes beginning of quotation.
6357 Bodies matching to this regular expression are highlighted by the face
6358 specified by @code{wl-highlight-message-headers}.
6360 @item wl-highlight-max-header-size
6361 @vindex wl-highlight-max-header-size
6362 The initial setting is @code{nil}. If a header size is larger than this
6363 value, it will not be highlighted. If @code{nil}, always highlighted
6364 (ignore header size).
6366 @item wl-highlight-max-message-size
6367 @vindex wl-highlight-max-message-size
6368 The initial setting is 10000.
6369 If a message is larger than this value, it will not be highlighted.
6370 With this variable, highlight is suppressed for uuencode or huge digest
6373 @item wl-highlight-signature-separator
6374 @vindex wl-highlight-signature-separator
6375 Specifies regular expressions that denotes the boundary of a signature.
6376 It can be a regular expression, or a list of ones.
6377 Messages after the place that matches this regular expression are
6378 highlighted by the face specified by
6379 @code{wl-highlight-message-signature}.
6381 @item wl-max-signature-size
6382 @vindex wl-max-signature-size
6383 The initial setting is 400.
6384 This is the largest size for a signature to be highlighted.
6386 @item wl-use-highlight-mouse-line
6387 @vindex wl-use-highlight-mouse-line
6388 The initial setting is @code{t}.
6389 If non-nil, the line pointed by the mouse is highlighted in the folder
6390 mode, summary mode, and the like.
6393 @subsection Setting Colors and Fonts of the Characters
6395 If you want to change colors or fonts of the characters, you need to
6396 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6397 want to change fonts, and @code{set-face-foreground} for colors, and so
6398 on. You cannot write face settings in @file{.emacs}; write in
6401 For example, if you want to change the color for signatures to yellow,
6405 (set-face-foreground 'wl-highlight-message-signature "yellow")
6411 Faces defined in Wanderlust:
6414 @item wl-highlight-message-headers
6415 The face for field names of message headers.
6417 @item wl-highlight-message-header-contents
6418 The face for field bodies of message headers.
6420 @item wl-highlight-message-important-header-contents
6421 The face for important parts of message headers.
6422 Per default, this face is used for a body of @samp{Subject:} field.
6423 You can change its value by editing
6424 @code{wl-highlight-message-header-alist}.
6426 @item wl-highlight-message-important-header-contents2
6427 The face for secondly important parts of message headers.
6428 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6429 fields. You can change its value by editing
6430 @code{wl-highlight-message-header-alist}.
6432 @item wl-highlight-message-unimportant-header-contents
6433 The face for unimportant parts of message headers.
6434 Per default, this face is used for bodies of @samp{X-} fields
6435 @samp{User-Agent:} fields. You can change its value by editing
6436 @code{wl-highlight-message-header-alist}.
6438 @item wl-highlight-message-citation-header
6439 The face for headers of quoted messages.
6441 @item wl-highlight-message-cited-text-*
6442 The face for texts of quoted messages. The last @samp{*} is a
6443 @var{single figure} so that 10 different colors can be used according to
6446 @item wl-highlight-message-signature
6447 The face for signatures of messages. The initial settings are
6448 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6449 dark background colors.
6451 @item wl-highlight-header-separator-face
6452 The face for header separators of draft messages.
6454 @item wl-highlight-summary-important-face
6455 The face for message lines with important marks in the summary.
6457 @item wl-highlight-summary-new-face
6458 The face for message lines with new marks in the summary.
6460 @item wl-highlight-summary-displaying-face
6461 The face for the message line that is currently displayed.
6462 This face is overlaid.
6464 @item wl-highlight-thread-indent-face
6465 The face for the threads that is currently displayed.
6467 @item wl-highlight-summary-unread-face
6468 The face for message lines with unread marks in the summary.
6470 @item wl-highlight-summary-deleted-face
6471 The face for message lines with delete marks in the summary.
6473 @item wl-highlight-summary-refiled-face
6474 The face for message lines with re-file marks in the summary.
6476 @item wl-highlight-refile-destination-face
6477 The face for re-file information part of message lines with re-file
6478 marks in the summary.
6480 @item wl-highlight-summary-copied-face
6481 The face for message lines with copy marks in the summary.
6483 @item wl-highlight-summary-target-face
6484 The face for message lines with target marks @samp{*} in the summary.
6486 @item wl-highlight-summary-thread-top-face
6487 The face for message lines that are on the top of the thread in the
6490 @item wl-highlight-summary-normal-face
6491 The face for message lines that are not on top of the thread in the
6494 @item wl-highlight-folder-unknown-face
6495 The face for folders that are not known to have how many unsync messages
6498 @item wl-highlight-folder-zero-face
6499 The face for folders that have no unsync messages in the folder mode.
6501 @item wl-highlight-folder-few-face
6502 The face for folders that have some unsync messages in the folder mode.
6504 @item wl-highlight-folder-many-face
6505 The face for folders that have many unsync messages in the folder mode.
6506 The boundary between `some' and `many' is specified by the variable
6507 @code{wl-folder-many-unsync-threshold}.
6509 @item wl-highlight-folder-unread-face
6510 The face for folders that have no unsync but unread messages in the
6513 @item wl-highlight-folder-killed-face
6514 The face for folders that are deleted from the access group in the
6517 @item wl-highlight-folder-opened-face
6518 The face for open groups in the folder mode.
6519 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6520 @code{nil} or a @var{number}.
6522 @item wl-highlight-folder-closed-face
6523 The face for close groups in the folder mode.
6524 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6525 @code{nil} or a @var{number}.
6527 @item wl-highlight-folder-path-face
6528 The face for the path to the currently selected folder in the folder
6531 @item wl-highlight-logo-face
6532 The face for logo in the demo.
6534 @item wl-highlight-demo-face
6535 The face for strings (for example, a version number) in the demo.
6539 @node Biff, Advanced Settings, Highlights, Customization
6540 @section Notify Mail arrival
6543 Following setting is to notify mail arrival of @samp{%inbox}
6544 by the indicator on the modeline
6547 (setq wl-biff-check-folder-list '("%inbox"))
6550 @subsection Customizable Variables
6552 @item wl-biff-check-folder-list
6553 @vindex wl-biff-check-folder-list
6554 The initial setting is @code{nil}.
6555 This is the list of folders to check mail arrival.
6556 If @code{nil}, wl doesn't check mail arrival.
6558 @item wl-biff-check-interval
6559 @vindex wl-biff-check-interval
6560 The initial setting is 40 (in seconds).
6561 Check mail arrival in this period.
6563 @item wl-biff-notify-hook
6564 @vindex wl-biff-notify-hook
6565 This hook is run at the arrival of new mail.
6566 To beep with mail arrival(initial setting), set as follows.
6568 (setq wl-biff-notify-hook '(ding))
6570 For silence, set to @code{nil}.
6574 @node Advanced Settings, Customizable Variables, Biff, Customization
6575 @section Advanced Settings
6578 * Draft for Reply:: Draft for Reply
6579 * Thread Format:: Appearance of Thread
6580 * User-Agent Field:: @samp{User-Agent:} Header Field
6584 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6585 @subsection Draft for Replay
6586 @vindex wl-draft-reply-with-argument-list
6587 @vindex wl-draft-reply-without-argument-list
6588 @vindex wl-draft-reply-myself-with-argument-list
6589 @vindex wl-draft-reply-myself-without-argument-list
6591 If you want, when you replying to articles in mailing lists, the address
6592 in Reply-To field of the original message to be prepared to To field of
6593 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6598 (setq wl-draft-reply-without-argument-list
6599 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6600 ("Followup-To" . (nil nil ("Followup-To")))
6601 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6602 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6607 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6608 in the original message, @samp{Reply-To:} field in the original is
6609 copied to @samp{To:} field.)
6611 Moreover, the behavior of @kbd{a} with prefix argument can
6612 be directed by @code{wl-draft-reply-with-argument-list} as well.
6614 Note: To set the behavior when you reply to the message written by yourself, use
6615 @code{wl-draft-reply-myself-without-argument-list} and
6616 @code{wl-draft-reply-myself-with-argument-list}
6619 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6620 @subsection Appearance of Threads
6624 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6625 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6626 391 09/18(Fri)19:24 +-[ Murata-san ]
6627 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6628 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6629 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6630 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6631 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6632 412 09/22(Tue)09:28 | +-[ Teranishi ]
6633 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6634 416 09/22(Tue)12:38 | +-[ Teranishi ]
6635 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6636 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6640 Settings to make appearance of threads like shown above:
6644 (setq wl-thread-indent-level 2)
6645 (setq wl-thread-have-younger-brother-str "+")
6646 (setq wl-thread-youngest-child-str "+")
6647 (setq wl-thread-vertical-str "|")
6648 (setq wl-thread-horizontal-str "-")
6649 (setq wl-thread-space-str " ")
6653 If you do not want to see branches, do the following:
6657 (setq wl-thread-indent-level 2)
6658 (setq wl-thread-have-younger-brother-str " ")
6659 (setq wl-thread-youngest-child-str " ")
6660 (setq wl-thread-vertical-str " ")
6661 (setq wl-thread-horizontal-str " ")
6662 (setq wl-thread-space-str " ")
6667 @node User-Agent Field, , Thread Format, Advanced Settings
6668 @subsection User-Agent Field
6672 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6673 @samp{User-Agent:} fields, define a function that generate appropriate
6674 strings as you like, and set it to variable
6675 @code{wl-generate-mailer-string-function}.
6677 If you do not want verbose @samp{User-Agent:} field, do the following:
6681 (setq wl-generate-mailer-string-function
6684 (concat "User-Agent: "
6685 (wl-generate-user-agent-string-1 nil)))))
6689 The following is a example:
6693 (setq mime-edit-insert-user-agent-field nil)
6694 (setq wl-generate-mailer-string-function
6697 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6702 @node Customizable Variables, Hooks, Advanced Settings, Customization
6703 @section Customizable Variables
6705 Customizable variables that have not been described yet:
6708 @item wl-default-folder
6709 @vindex wl-default-folder
6710 The initial setting is @samp{%inbox}. This is the default value for moving to
6711 a folder and the like.
6713 @item wl-draft-folder
6714 @vindex wl-draft-folder
6715 The initial setting is @samp{+draft}. It is the folder to which drafts are
6716 saved. It must be a localdir folder.
6718 @item wl-trash-folder
6719 @vindex wl-trash-folder
6720 The initial setting is @samp{+trash}. It is the wastebasket folder.
6721 If you changed this variable, you had better restart Wanderlust.
6723 @item wl-interactive-exit
6724 @vindex wl-interactive-exit
6725 The initial setting is @code{t}.
6726 If non-nil, you are asked for confirmation when Wanderlust terminates.
6728 @item wl-interactive-send
6729 @vindex wl-interactive-send
6730 The initial setting is @code{t}.
6731 If non-nil, you are asked for confirmation when mail is sent.
6733 @item wl-folder-sync-range-alist
6734 @vindex wl-folder-sync-range-alist
6735 The initial setting is the alist shown below:
6740 ("^\\+draft$\\|^\\+queue$" . "all"))
6745 This is an associative list of regular expressions of folder names and
6746 update range of the summary. Update range is one of the @samp{all},
6747 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6748 @samp{last}. If a folder do not match, @samp{update} is used.
6751 @vindex wl-ask-range
6752 The initial setting is @code{t}.
6753 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6754 for updating the summary when you changed folders.
6756 @item wl-mime-charset
6757 @vindex wl-mime-charset
6758 The initial setting is @code{x-ctext}.
6759 This is the MIME charset for messages that are not MIME (e.g. without
6760 @samp{Content-Type:}). This value also used as default charset for
6761 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6762 this value as @code{iso-2022-jp}.)
6764 @item wl-highlight-folder-with-icon
6765 @vindex wl-highlight-folder-with-icon
6766 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6767 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6769 @item wl-strict-diff-folders
6770 @vindex wl-strict-diff-folders
6771 This is a list of regular expressions of folders.
6772 Unread messages are checked, for example when you press @kbd{s} in
6773 the folder mode, usually in a brief way (rapidly processed but not
6775 The folders matching this variable are seriously checked.
6776 You may want to set this variable so as to match conditional filter
6777 folders for IMAP4 folders.
6778 The initial setting is @code{nil}.
6780 @item wl-folder-use-server-diff
6781 @vindex wl-folder-use-server-diff
6782 When unread messages are checked, for example when you press @kbd{s} in
6783 the folder mode, usually (the number of messages on the server) @minus{}
6784 (the number of local messages) will be the number of unread messages.
6785 However, if this variable is non-nil, the number of unread messages on
6786 the server is checked. This affects IMAP4 folders only, but IMAP4
6787 folders in mail boxes matching
6788 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6789 the number of unread messages on the server, even if they matches this
6790 variable. The initial setting is @code{t}.
6792 @item wl-auto-check-folder-name
6793 @vindex wl-auto-check-folder-name
6794 The initial setting is @code{nil}.
6795 If non-nil, the folder with the name of the value is checked for unread
6796 messages at the start.
6797 If it is @code{none}, no folders are checked.
6798 If it is a list, all folders in the list are checked at the start.
6800 @item wl-auto-uncheck-folder-list
6801 @vindex wl-auto-uncheck-folder-list
6802 The initial setting is the list shown below:
6811 Folders with the name matching this variable are not checked for unread
6812 messages at the start, even if they are included in the groups in
6813 @code{wl-auto-check-folder-name}.
6815 @item wl-auto-check-folder-list
6816 @vindex wl-auto-check-folder-list
6817 The initial setting is @code{nil}.
6818 Folders with the name matching this variable are always checked for
6819 unread messages at the start, if they are included in the groups in
6820 @code{wl-auto-check-folder-name}.
6821 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6823 @item wl-no-save-folder-list
6824 @vindex wl-no-save-folder-list
6825 The initial setting is the list shown below:
6834 This is a list of regular expressions of folders not to be saved.
6836 @item wl-save-folder-list
6837 @vindex wl-save-folder-list
6838 The initial setting is @code{nil}.
6839 This is a list of regular expressions of folders to be saved.
6840 This takes precedence over @code{wl-no-save-folder-list}.
6842 @item wl-folder-mime-charset-alist
6843 @vindex wl-folder-mime-charset-alist
6844 The initial setting is the alist shown below:
6848 (("^-alt\\.chinese" . big5)
6849 ("^-relcom\\." . koi8-r)
6851 ("^-han\\." . euc-kr))
6856 This is an associative list of regular expressions of folder names and
6858 If a folder do not match, @code{wl-mime-charset} is used.
6860 @item wl-folder-init-load-access-folders
6861 @vindex wl-folder-init-load-access-folders
6862 The initial setting is @code{nil}.
6863 This is a list of access groups to be loaded specifically at the start.
6864 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6866 @item wl-folder-init-no-load-access-folders
6867 @vindex wl-folder-init-no-load-access-folders
6868 The initial setting is @code{nil}.
6869 This is a list of access groups not to be loaded specifically at the
6871 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6873 @item wl-delete-folder-alist
6874 @vindex wl-delete-folder-alist
6875 The initial setting is the alist shown below:
6884 This list determines disposition of messages with delete marks.
6885 Each item in the list is a folder and destination; you can specify any
6886 one of the following in the place of destination:
6889 @code{remove} or @code{null} : deletes the messages instantly.
6890 string : moves the messages to the specific folder.
6891 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
6894 @item wl-refile-policy-alist
6895 @vindex wl-refile-policy-alist
6896 The initial setting is the list shown below:
6906 This list determines whether messages with re-file marks are moved or
6907 copied. Each item in the list is a cons cell of a folder and
6908 @code{copy} or @code{move}.
6910 @item wl-x-face-file
6911 @vindex wl-x-face-file
6912 The initial setting is @file{~/.xface}.
6913 The name of the file that contains encoded X-Face strings.
6916 @item wl-demo-display-logo
6917 @vindex wl-demo-display-logo
6918 If non-nil, bitmap image is shown on the opening demo. If you set
6919 @code{xpm} or @code{xbm}, (if possible) display selected image type
6922 @item elmo-use-database
6923 @vindex elmo-use-database
6924 This is meaningful for XEmacs only. The initial setting depends on
6925 XEmacs (@code{t} for XEmacs with dbm).
6926 If non-nil, Message-ID is controlled by dbm.
6928 @item elmo-passwd-alist-file-name
6929 @vindex elmo-passwd-alist-file-name
6930 The initial setting is @file{passwd}.
6931 This is the name of the file in which passwords are saved.
6932 @code{elmo-passwd-alist-save} saves current passwords to the file.
6934 @item elmo-nntp-list-folders-use-cache
6935 @vindex elmo-nntp-list-folders-use-cache
6936 The initial setting is 600 (in seconds).
6937 This is period in seconds during which results of @samp{list} and
6938 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6941 @item elmo-nntp-max-number-precedes-list-active
6942 @vindex elmo-nntp-max-number-precedes-list-active
6943 The initial setting is @code{nil}.
6944 If non-nil, the number of article obtained by @samp{list active} in NNTP
6945 are used as the maximum article number of the folder.
6946 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6947 and if the number of read messages is not correct.
6949 @item elmo-nntp-default-use-listgroup
6950 @vindex elmo-nntp-default-use-listgroup
6951 The initial setting is @code{t}.
6952 If non-nil, @samp{listgroup} is used for checking the total number of
6953 articles. If it is @code{nil}, @samp{group} is used. In the latter
6954 case, the processing will be a little faster at the sacrifice of
6957 @item elmo-pop3-send-command-synchronously
6958 @vindex elmo-pop3-send-command-synchronously
6959 The initial setting is @code{nil}.
6960 If non-nil, POP3 commands are issued synchronously. Some implementation
6961 of POP3 server fails to get summary information without this setting.
6962 You may have to set this variable to @code{t}, if the process hangs
6963 while looking up POP3.
6965 @item elmo-dop-flush-confirm
6966 @vindex elmo-dop-flush-confirm
6967 The initial setting is @code{t}.
6968 If non-nil, you are asked for confirmation if accumulated off-line
6969 operations are executed.
6971 @item elmo-display-progress-threshold
6972 @vindex elmo-display-progress-threshold
6973 The initial setting is 20.
6974 Threshold for display of progress gauge. If number of renewal is more than
6975 this value, display progress gauge.
6979 @node Hooks, , Customizable Variables, Customization
6985 @node Mailing List, Addition, Customization, Top
6986 @chapter Wanderlust Mailing List
6991 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6994 Topics related to Wanderlust are discussed in the mailing list.
6995 The latest version is also announced there (in Japanese, sorry).
6997 A guide can be obtained automatically by sending mail to
6998 @t{wl-ctl@@lists.airs.net} with the body
7003 Please send bug reports or patches to the mailing list. You can post to
7004 the mailing list even though you are not a member of it.
7006 If you send a bug report, please attach Backtrace with it.
7007 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7010 I would like to express my thanks to the members of the mailing list for
7011 valuable advice and many pieces of code they contributed.
7014 @node Addition, Index, Mailing List, Top
7015 @chapter Additional Information
7017 @section Brief History
7020 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7021 3/10 Made a msgdb mechanism by elisp.
7022 3/26 IMAP and NNTP can be displayed in threads.
7023 4/13 Began to assemble thread display modules as elmo.
7024 5/01 Finished 0.1.0, initial version with many defects.
7025 6/12 I made a slip of the tongue and said I was writing elisp
7026 mailer supporting IMAP
7027 6/16 0.1.3 was announced at tm-ja, elisp ML.
7028 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7029 7/01 Support for mm-backend (0.3.0).
7030 8/25 multi folder added (0.5.0).
7031 8/28 filter folder added (0.5.1).
7032 9/10 You can open/close threads (0.6.0).
7033 9/11 fldmgr by Murata-san made editing folders easy.
7034 9/18 lha folders added by Okunishi-san (0.6.3).
7035 9/24 Display of branches of threads (0.6.5).
7036 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7037 10/28 Off-line operations (0.7.4).
7038 12/09 Becomes beta version.
7039 12/21 wl-expire by Murata-san.
7040 1999 2/03 auto-refile by Tsumura-san.
7041 4/28 wl-template by Murata-san.
7042 5/18 Released 1.0.0 stable.
7043 7/05 Scoring by Murata-san (2.1.0).
7044 9/26 New plugged system by Murata-san (2.2.2).
7045 12/20 Support Modified UTF7.
7046 2000 3/24 Released 1.1.0 stable.
7047 4/03 CVS development started.
7048 5/07 Thread restoration & Its speed up with Murata-san.
7049 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7050 7/11 killed message feature.
7051 7/18 Use UIDL in POP3.
7052 9/12 biff feature with Satata-san & Yamaoka-san.
7053 10/17 expire-hide by Okada-san.
7054 11/08 Released 2.4.0 stable.
7055 2001 7/04 Released 2.6.0 stable.
7056 8/21 wl-addrmgr by Kitamoto-san.
7059 See @file{ChangeLog} for details.
7063 According to a dictionary, Wanderlust has the meaning:
7067 n eager longing for or impulse towards travelling in distant lands
7068 [Ger, fr wandern to wander + lust desire, pleasure]
7072 but I had no profound intention. (if farfetched, IMAP @result{} you can
7073 read mail anywhere @result{} desire to wander ?)
7075 Elmo is the abbreviation of @samp{Elisp Library for Message
7076 Orchestration}. At first I meant the red puppet in the Sesame Street,
7077 but you may associate it with Wandering @result{} Drifting @result{}
7078 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7082 Each versions has code names (they are almost jokes).
7083 Currently they are picked up alphabetically from the top 40 hits of
7084 U.S. Billboard magazines in 1980s.
7086 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7089 @node Index, , Addition, Top
7093 * Concept Index:: Concept Index
7094 * Key Index:: Key Index
7095 * Variable Index:: Variable Index
7096 * Function Index:: Function Index
7099 @node Concept Index, Key Index, Index, Index
7100 @unnumberedsec Concept Index
7103 @node Key Index, Variable Index, Concept Index, Index
7104 @unnumberedsec Key Index
7107 @node Variable Index, Function Index, Key Index, Index
7108 @unnumberedsec Variable Index
7111 @node Function Index, , Variable Index, Index
7112 @unnumberedsec Function Index