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,
20 Yet another message interface on Emacsen.
22 Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata},
24 @w{Kenichi Okada}, @w{Kaoru Takahashi},
25 @w{Bun Mizuhara} and @w{Masayuki Osada}.
27 This edition is for Wanderlust version @value{VERSION}.
29 Permission is granted to make and distribute verbatim copies of
30 this manual provided the copyright notice and this permission notice
31 are 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
36 notice identical to this one except for the removal of this paragraph
37 (this 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 entire
42 resulting derived work is distributed under the terms of a permission
43 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
64 @vskip 0pt plus 1filll
65 Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi},
66 @w{Fujikazu Okunishi}, @w{Masahiro Murata},
67 @w{Kenichi Okada}, @w{Kaoru Takahashi},
68 @w{Bun Mizuhara} and @w{Masayuki Osada}.
70 This manual is for Wanderlust version @value{VERSION}.
72 Permission is granted to make and distribute verbatim copies of
73 this manual provided the copyright notice and this permission notice
74 are preserved on all copies.
76 Permission is granted to copy and distribute modified versions of this
77 manual under the conditions for verbatim copying, provided that the entire
78 resulting derived work is distributed under the terms of a permission
79 notice identical to this one.
81 Permission is granted to copy and distribute translations of this manual
82 into another language, under the above conditions for modified versions.
88 @node Top, Introduction, (dir), (dir)
89 @top Wanderlust User's Manual
101 This manual is for Wanderlust @value{VERSION}.
106 * Introduction:: Read this first.
107 * Start Me Up:: Invoking Wanderlust.
108 * Folders:: How to specify folders.
109 * Folder:: Selecting and editing folders.
110 * Summary:: Reading and refiling messages.
111 * Message:: Saving and playing MIME multipart entities.
112 * Draft:: Draft buffer, sending mail and news.
113 * Disconnected Operations:: Off-Line management
114 * Expire and Archive:: Automatic expiration and archiving of messages.
115 * Scoring:: Score of the messages.
116 * Customization:: Customizing Wanderlust.
117 * Mailing List:: Wanderlust mailing list
118 * Addition:: Additional Information
123 @node Introduction, Start Me Up, Top, Top
124 @chapter Introduction of Wanderlust
127 Wanderlust is an mail/news management system on Emacsen.
128 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
130 The main features of Wanderlust:
133 @item Pure elisp implementation.
134 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
135 @item Unified access method to messages based on Mew-like Folder Specification.
136 @item Mew-like Key-bind and mark handling.
137 @item Manages unread messages.
138 @item Interactive thread display.
139 @item Folder Mode shows the list of subscribed folders.
140 @item Message Cache, Disconnected Operation (Read Only).
141 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
142 @item MIME compliant (by SEMI or tm).
143 @item Transmission of news and mail are unified by Message transmitting draft.
144 @item Graphical list of folders (XEmacs and Emacs 21).
145 @item View a part of message without retrieving the whole message (IMAP4).
146 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
147 @item Virtual Folders.
148 @item Supports compressed folder using common archiving utilities.
149 @item Old articles in folders are automatically removed/archived (Expiration).
150 @item Automatic re-file.
151 @item Template function makes it convenient to send fixed form messages.
157 Wanderlust is supposed to run on following Emacsen:
158 @c Wanderlust runs even on Nemacs 3.3.2 based on Emacs 18.55, 18.59 (with
159 @c limited functionality).
162 @item Nemacs 3.3.2 (Caution: limited functionality)
163 @item Mule 2.3 based on Emacs 19.28
164 @item Mule 2.3 based on Emacs 19.34
165 @item Emacs 20.2 or later
166 @item XEmacs 20.4 or later
167 @item Meadow 1.00 or later
168 @item Mule for Windows v1.22
169 @item NTEmacs 20.4 or later
173 IMAP4 connectivity with following imapd are confirmed to work with
177 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c
178 @item Cyrus imapd 1.4, 1.5.19, 1.6.22, 2.0.5
179 @item AIR MAIL (AIRC imapd release 2.00)
181 @item Microsoft Exchange Server 5.5
182 @item Sun Internet Mail Server 4.0
185 @c LDAP connectivity with following LDAPd are confirmed to work with
189 @node Start Me Up, Folders, Introduction, Top
190 @chapter Start up Wanderlust
193 The necessary procedure for starting Wanderlust is explained in steps
196 (Of course, you need a mail/news readable environment in advance)
199 * MIME Modules:: Installing the MIME modules.
200 * Download:: Download and extract the packages.
201 * Install:: Byte-compile and install.
202 * Minimal Settings:: @file{.emacs} setup.
203 * Mail Addresses:: Address book definition.
204 * Folder Definition:: Folder definition.
205 * Start Wanderlust:: Starting Wanderlust
209 @node MIME Modules, Download, Start Me Up, Start Me Up
210 @section Installing MIME modules
217 SEMI or tm must be installed to make Wanderlust work correctly.
219 SEMI does not run on Emacs19.28 or earlier
220 @footnote{SEMI runs on Emacs 19.34. @*
221 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} describes how to.},
222 so you must install tm, the predecessor of SEMI. (tm version 8.7 or later
225 However, SEMI is recommended because of its wider functionality.
227 Refer to the documents of each package for detailed installation procedure.
229 SEMI and tm can be downloaded from these sites:
233 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
234 tm: http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
238 You need packages named APEL and FLIM to use SEMI.
239 You can download APEL and FLIM from following URLs:
243 APEL: ftp://ftp.m17n.org/pub/mule/apel/
244 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
248 You have to install APEL, FLIM and SEMI in this order.
249 Generally @samp{make install} will do the job.
250 (In XEmacs 21, @samp{make install-package}.)
252 Recommended combination of APEL, FLIM and SEMI are following:
255 @item APEL 10.2, FLIM 1.13.2 and SEMI 1.13.7
258 You can also use many other FLIM/SEMI variants. Combination of the
259 latest versions should work. For example, following combination is
263 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
264 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
267 @c You have to re-install Wanderlust
268 @c if you upgraded APEL, FLIM, SEMI or tm.
270 @node Download, Install, MIME Modules, Start Me Up
271 @section Download and Extract the Package
274 You can download Wanderlust package from following sites:
278 ftp://ftp.gohome.org/wl/
281 Mirrored ftp/http sites:
285 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
286 http://www.jpl.org/elips/wl/
287 http://www.ring.gr.jp/archives/text/elisp/wl/
288 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
289 ftp://opaopa.org/pub/mirror/elisp/wl/
293 Extract the obtained package to your working directory:
298 % tar zxvf wl-@var{version}.tar.gz
299 % cd wl-@var{version}
303 @subsection To use SSL (Secure Socket Layer)
308 SSL (Secure Socket Layer) can be used for
309 SMTP, IMAP, NNTP and POP connections in Wanderlust.
311 There are two ways to use SSL. One is to start SSL negotiation just after
312 the connection establishment (generic way).
313 The other one is to start SSL negotiation by invoking STARTTLS command in
316 To use the formar SSL (generic SSL), you must install @file{ssl.el} in
317 the @file{utils} directory. OpenSSL command @command{openssl} is also
318 required to use @file{ssl.el}. You must set PATH to the directory that
319 OpenSSL commands are installed.
321 To use the latter SSL(STARTTLS), you must install starttls package in
323 You can download starttls package from the following site.
326 ftp://opaopa.org/pub/elisp/
329 @node Install, Minimal Settings, Download, Start Me Up
330 @section Byte-compile and install
337 @subsection Installation
339 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
340 Set the Emacs's command name to @code{EMACS}.
341 Set package installation directory to @code{LISPDIR}.
342 Then, please execute following commands.
351 Destination directory is auto-probed if you leave @code{LISPDIR}
352 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
354 If you are using an Emacs variant which does not merge specified directory
355 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
356 then you will see the error message:
359 Cannot open load file: mime-setup
363 In this case, either add destination directories of custom, APEL, FLIM
364 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
365 @code{load-path} in @file{WL-CFG} in extracted directory.
367 If you want to use BBDB, then the necessary modules are byte-compiled and
368 installed when BBDB directory is added to @code{load-path}.
371 @subsection @file{WL-CFG}
373 Contents of the file @file{WL-CFG} is loaded under installation if a file
374 with that name exists in extracted directory. You can use @file{WL-CFG} to
375 configure @code{load-path} to extra packages such as SEMI if needed.
377 If you want to specify the install directory of Wanderlust related
378 files, then set following variables in @file{WL-CFG}
382 A directory to install WL modules.
383 This directory is relative directory from @code{LISPDIR}.
384 WL modules include @file{wl*.el}, @file{wl*.elc} files.
385 @c Modules under the directory @file{util/} are also installed if
386 @c it detected as necessary.
389 A directory to install ELMO modules.
390 This directory is relative directory from @code{LISPDIR}.
391 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
392 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
396 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
398 If you want to install ELMO related files under a sub-directory
399 such as "elmo" then add following to @file{WL-CFG}:
402 (setq ELMO_PREFIX "elmo")
405 @subsection Install as a XEmacs package
406 @cindex XEmacs package
407 @cindex XEmacs package install
408 @cindex Package, XEmacs
409 @cindex Package install, XEmacs
410 @c @cindex install-package
412 It is possible to install Wanderlust as one of packages of XEmacs (21.0
413 or later). Configuration for autoload and icon-path in local
414 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
417 Follow the next example to install Wanderlust as an XEmacs package.
423 % make install-package
427 package directory is auto-probed, if SEMI is installed.
428 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
430 @subsection Run in place
432 If wl and elmo directories are defined in @code{load-path}, then
433 byte-compilation and installation are not necessary to start Wanderlust.
434 For example, if package is extracted in @file{~/work}, Wanderlust can be
435 invoked with following setting in @file{~/.emacs}.
439 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
440 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
446 Manual is described in Info format. Please do following.
455 If you install Wanderlust as a XEmacs package, Info file is already
456 installed too, so there are no need of these commands.
458 Manual directory is automatically detected. Of course, it can be
459 configured by @code{INFODIR} in @file{Makefile}.
461 You can read manual at the following URL:
464 http://www.gohome.org/wl/doc/wl-euc_toc.html
467 @node Minimal Settings, Mail Addresses, Install, Start Me Up
468 @section Set up .emacs
469 @cindex Minimal Settings
471 @cindex Configuration
475 The Wanderlust package contains two module groups.
478 @item ELMO (elmo-*.el)
479 These modules show everything as folders. This is the back-end for WL.
481 These modules controls the behavior of main body of Wanderlust.
482 They are also the front-end for ELMO.
485 You can customize the behavior of Wanderlust by changing the value
486 of environmental variables which begins with @code{elmo-} and @code{wl-}.
488 The minimal requirement for settings is as the following.
492 ;; @r{The setting to use SEMI/tm}
495 ;; @r{autoload configuration}
496 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
497 (autoload 'wl "wl" "Wanderlust" t)
498 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
500 ;; @r{Directory where icons are placed (XEmacs or Emacs 21). Default value
502 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
503 (setq wl-icon-dir "~/work/wl/etc")
505 ;; @r{SMTP server for mail posting. Default: @code{nil}}
506 (setq wl-smtp-posting-server "your.smtp.server.com")
507 ;; @r{NNTP server for news posting. Default: @code{nil}}
508 (setq wl-nntp-posting-server "your.nntp.server.com")
512 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
513 file exists). So it is convenient to gather Wanderlust specific settings
514 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
515 because you can't write them in @file{.emacs}
516 (if you write it to @file{.emacs}, you'll get an error).
519 All above described settings except (load "mime-setup") and autoload
520 configuration can be written in
523 @subsection @code{mail-user-agent}
524 @cindex Default Mailer
525 @cindex Mailer, Default
526 @vindex mail-user-agent
529 If you write following setting in you @file{.emacs}, you can
530 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
531 This means it enables you to run Wanderlust as a default mail composer
534 It is effective only when your Emacs can define @code{mail-user-agent}.
535 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
539 (autoload 'wl-user-agent-compose "wl-draft" nil t)
540 (if (boundp 'mail-user-agent)
541 (setq mail-user-agent 'wl-user-agent))
542 (if (fboundp 'define-mail-user-agent)
543 (define-mail-user-agent
545 'wl-user-agent-compose
553 @node Mail Addresses, Folder Definition, Minimal Settings, Start Me Up
554 @section Address book
555 @cindex Address book Definition
557 @cindex Alias, Address
559 The file @file{~/.addresses} is a simple address book for Wanderlust.
560 Make address file @file{~/.addresses}, and edit to suit your requirement.
562 The data written in @file{~/.addresses} are used for address completion
563 under draft editing mode. Furthermore, they are used when showing names
564 in summary display mode. You can safely skip this section, if you don't
565 want to customize address completion and summary display.
566 It is possible to add/change/remove addresses from @file{~/.addresses} in
567 summary buffer after Wanderlust is invoked. @refill
569 The format is very simple. Like this. @refill
574 # @r{Lines begin with @samp{#} are comment.}
575 # @r{Empty lines are ignored}
577 # @r{Format of each line:}
578 # @var{email-address} "@var{nickname} "@var{realname}"
580 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
581 foo@@bar.gohome.org "Mr. Foo" "John Foo"
582 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
587 One line defines one persons description.
589 Actually, in default setup, @var{nickname} is used in summary-mode and
590 @var{realname} is used in draft preparation mode. This behavior is
591 better understood if you try it and confirmed the function first. You
592 can write and try a small definition, so you will know the idea of the
593 address book before writing a big one.
595 And, if MH alias file is specified in variable @code{wl-alias-file},
596 it is used as an address information in the draft preparation mode.
598 If variable @code{wl-use-ldap} is non-nil (initial setting is
599 @code{nil}), address completion in draft mode uses LDAP information.
601 If you use LDAP, you have to set @code{wl-ldap-server},
602 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
603 not have LDAP feature as built-in feature (Currently only XEmacs can
604 have built-in LDAP feature), you have to set command exec PATH to the
605 program @command{ldapsearch}.
607 @node Folder Definition, Start Wanderlust, Mail Addresses, Start Me Up
608 @section Folder Definition
609 @cindex Folder Definition
612 You can skip this section because it is possible to add/edit the
613 subscribe folders from the buffer for list of folders.
615 Define the folders you want to subscribe in file @file{~/.folders}. The
616 contents written in @file{~/.folders} become the folders which you
617 subscribe to as it is.
619 Format for @file{~/.folders} is very simple. Here is an example:
624 # @r{Lines begin with @samp{#} are comment.}
625 # @r{Empty lines are ignored}
627 # @var{folder name} "@var{folder nickname}"
628 # @r{(nicknames are not necessary)}
633 %#mh/Backup@@my.imap.server.com "Sent"
636 %#mh/spool/wl "Wanderlust ML"
637 %#mh/spool/elips "ELIPS ML"
638 %#mh/spool/tm-ja "tm Japanese ML"
639 %#mh/spool/xemacs-beta "XEmacs beta"
640 -fj.news.reader.gnus@@other.nntp.server.com "Gnus Net news"
641 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
644 # @r{If folder name ends with @samp{/}, that means an `access group',}
645 # @r{all subfolders automatically included in one folder group.}
647 %#mh/expire@@localhost /
648 # @r{All MH folders are included in one folder group.}
653 Each line contains one folder you want to read. The definition of
654 folders will be explained in detail in the next section.
656 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
657 become one folder group. One folder group is treated as a directory
658 which can bed opened and closed in folder mode. It is convenient for
659 collecting some folders and putting them in order.
661 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
662 line and you have to write it that way (It is because the parser sucks).
664 There are two types of groups. One is like @samp{Emacsen} from above
665 example which the user chooses his favorite folders as a group.
667 The other one is @dfn{access group} like @samp{+} from above example.
668 It makes all the sub-folders in a folder to a group. (It differs from
669 the type of the folder. For example, @samp{+} makes entire MH
670 sub-directories to one group)
672 This behavior is better understood if you try it and confirmed the
673 function first. You can write and try a small folder definition, so you
674 will know the idea of the folder function before writing the real one.
676 @node Start Wanderlust, , Folder Definition, Start Me Up
677 @section Start Wanderlust
678 @cindex Start Wanderlust
680 If installation and configuration worked well, you can invoke Wanderlust by
681 typing following command in Emacs.
688 After initialization, Folder Mode which shows the list of folders will appear.
689 That means the folders you defined in the @file{~/.folders} are listed
690 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
691 can skip folder checking.
694 @node Folders, Folder, Start Me Up, Top
695 @chapter Wanderlust's folders
698 This chapter describes the folder types which Wanderlust is able to handle.
700 Wanderlust uses ELMO as it's interface, so every folder types supported
701 by ELMO is usable in Wanderlust.
703 As of version @value{VERSION}, 10 types of folders are predefined. These are
704 IMAP, NNTP, LocalDir(MH), News Spool, POP, Archive, Multi, Filter, Pipe
705 and Internal folder types.
708 * IMAP Folder:: @samp{%} -- IMAP folder
709 * NNTP Folder:: @samp{-} -- NNTP folder
710 * MH Folder:: @samp{+} -- MH folder
711 * Maildir Folder:: @samp{.} -- Maildir folder
712 * News Spool Folder:: @samp{=} -- News spool folder
713 * Archive Folder:: @samp{$} -- Archive folder
714 * POP Folder:: @samp{&} -- POP folder
715 * Multi Folder:: @samp{*} -- Multi folder
716 * Filter Folder:: @samp{/} -- Filter folder
717 * Pipe Folder:: @samp{|} -- Pipe folder
718 * Internal Folder:: @samp{'} -- Internal folder
722 @node IMAP Folder, NNTP Folder, Folders, Folders
729 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
735 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
739 You can specify @code{login} (encoded password transmission),
740 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
741 authentication) or @code{plain} (or @code{nil}, plain password
742 transmission) as @var{authenticate-type}. (To use CRAM-MD5 or
743 DIGEST-MD5 authentication, you must install @file{utils/sasl} package.)
748 @var{username} -> The value of @code{elmo-default-imap4-user}.
749 Initial setting is @env{USER} environment variable or
750 @env{LOGNAME} environment variable or return value of
751 @code{(user-login-name)}.
752 @var{authenticate-type} -> The value of @code{elmo-default-imap4-authenticate-type}.
753 Initial setting is "auth".
754 @var{hostname} -> The value of @code{elmo-default-imap4-server}.
755 Initial setting is "localhost".
756 @var{port} -> The value of @code{elmo-default-imap4-port}.
757 Initial setting is 143.
760 You can omit the @var{hostname} from folder names if you set
761 @code{elmo-default-imap4-server} as your main IMAP server.
762 For example, you can specify a folder as @samp{foo%imap@@gateway} even
763 if you have to go through a firewall.
765 SSL (Secure Socket Layer) connection will be used if a folder name
766 ends with @samp{!}. Or, if the value of @code{elmo-default-imap4-ssl} is non-nil,
767 SSL will be the default connection.
768 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
769 If the value of @code{elmo-default-imap4-ssl} is 'starttls,
770 STARTTLS will be the default connection.
772 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
773 authentication method, the password is sent in encoded form. But, if
774 your server is unable to receive an encoded password, authentication
775 will fall back to @code{plain} (that is, sending password in raw format)
776 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
777 authentication will fall back to @code{plain} without confirmation
778 (default value is @code{nil}).
784 %inbox -> IMAP mailbox "inbox"
785 %#mh/inbox -> IMAP mailbox "#mh/inbox"
787 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
788 %inbox:hoge/login@@server1
789 -> server1's IMAP mailbox "inbox"
790 of user "hoge", with plain password authentication
795 @subsection International mailbox names (Modified UTF7)
796 @cindex Modified UTF7
803 You can use international mailbox names in @var{mailbox} part, if you
804 are using Emacs which can treat unicode and
805 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
806 value is @code{nil}).
808 Currently, following Emacsen can treat unicode.
811 @item Emacs 20.3 or later + Mule-UCS
813 If you installed Mule-UCS package, Emacs can treat unicode.
814 You can obtain Mule-UCS package from following URL.
817 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
820 @item XEmacs 21.2.13 or later + ucs-conv package
822 By default, XEmacs 21 cannot treat unicodes, but if you installed
823 ucs-conv package, it can.
824 You can obtain ucs-conv package from following anonymous CVS.
828 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
829 Password: @var{NULL} (Just enter return key)
830 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
834 You also need utf7 conversion programs, @command{u7tou8} and
835 @command{u8tou7} to use international mailbox name in the current
836 XEmacs. These programs are included in the UTF7 package which can be
837 obtained from following URL.
840 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
844 @node NNTP Folder, MH Folder, IMAP Folder, Folders
849 A folder to access USENET news via NNTP protocol (RFC 977).
850 One newsgroup is treated as a folder.
856 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
862 @var{hostname} -> The value of @code{elmo-default-nntp-server}.
863 Initial setting is @samp{localhost}.
864 @var{username} -> The value of @code{elmo-default-nntp-user}.
865 Initial setting is @code{nil}.
866 @var{port} -> The value of @code{elmo-default-nntp-port}.
867 Initial setting is 119.
870 AUTHINFO is used as authentication method if the @var{username} is non-nil.
871 SSL will be default method if @code{elmo-default-nntp-ssl} is non-nil even
872 if the folder name doesn't end with @samp{!}.
873 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
874 if the value of @code{elmo-default-nntp-ssl} is @code{starttls},
875 STARTTLS will be the default connection.
881 -fj.rec.tv -> Newsgroup `fj.rec.tv'.
882 -fj.rec.tv@@newsserver -> Newsgroup `fj.rec.tv' on newsserver.
886 @node MH Folder, Maildir Folder, NNTP Folder, Folders
892 A folder to access MH format mail (1 file is 1 mail).
897 @samp{+} @var{directory-name}
900 Normally, @var{directory-name} is an relative path to the variable
901 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
902 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
903 (this is also true for drive-letters).
905 Message number is used for the name of the message file.
911 +inbox -> @file{~/Mail/inbox}
912 +from/teranisi -> @file{~/Mail/from/teranisi}
913 +~/test -> @file{~/test}
917 @node Maildir Folder, News Spool Folder, MH Folder, Folders
918 @section Maildir Folder
919 @cindex Maildir Folder
923 A folder to access to Maildir format (1 file is 1 mail).
928 @samp{.} [@var{directory-name}]
931 Normally, @var{directory-name} is a relative path to the variable
932 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
933 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
934 (this is also true for drive-letters).
936 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
937 Messages are contained in the @file{cur} directory. All message files
938 in the @file{new} directory are moved to @file{cur} directory when you
939 access to the folder. All message files contained in the @file{tmp}
940 directory and not accessed for 36 hours are deleted.
942 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
948 . -> @file{~/Maildir}
949 .inbox -> @file{~/Maildir/inbox}
950 .from/teranisi -> @file{~/Maildir/from/teranisi}
951 .~/test -> @file{~/test}
956 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
957 @section News Spool Folder
958 @cindex News spool Folder
962 This folder handles locally saved news articles which are proposed by
963 Mew/IM. You can also read articles directly from a spool-file which is
964 retrieved by an utility like @command{gnspool}.
969 @samp{=} @var{directory-name}
972 @var{directory-name} is a sub-directory to the directory defined by
973 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
974 You can use @samp{.} as directory delimiter as well as @samp{/}.
980 =fj/os/os2 -> @file{~/News/fj/os/os2}
981 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
986 @node Archive Folder, POP Folder, News Spool Folder, Folders
987 @section Archive Folder
988 @cindex Archive Folder
992 This method can handle archive files, which are compressed by utilities
993 such as Info-ZIP or LHA, as one folder.
999 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1003 @var{path-name} is the relative path from
1004 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1005 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1006 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1007 also permitted under the environment of ange-ftp, efs.
1009 The actual file name of the archive folder is
1010 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1011 under the @var{path-name}. If a file named @var{path-name} exists, it is
1012 treated as folder. The suffix is automatically decided for
1013 @var{archiver-type}.
1015 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1016 (Initial setting is @code{zip}) is referred.
1018 @var{prefix} specifies the internal directory structure of the archive.
1019 For example, if the ML server is fml, @file{msend.tar.gz} has a
1020 structure like @file{spool/1}, so you have to specify @samp{spool} as
1027 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1028 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1029 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1030 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1035 * Archiver:: Archivers supported
1036 * Archive Tips:: TIPS
1037 * Archive Vars:: Customization
1041 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1042 @subsection Supported Archives
1052 By default, following archives are supported.
1056 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1057 GNU TAR('tgz, 'tar) ;; read-only
1061 If your archiver can include multiple files in one archive, you have a
1062 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1063 of the candidate. TAR is supported read-only because it cannot delete
1064 file in the archive (@code{mv})).
1066 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1067 archiver of Wanderlust because they cannot include multiple
1068 files. Archivers that cannot extract files to standard output are also
1071 @subsection OS specific information about archiver.
1073 Behaviors of the following archivers are confirmed by further experiences.
1074 (@samp{*} mark means recommended archiver).
1077 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1078 LHA OS/2 version Rel.2.06b Feb 18, 1998
1079 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1080 *Zip 2.2 (November 3rd 1997).
1081 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1082 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1083 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1085 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1086 LHa for UNIX V 1.14c
1087 UnZip 5.32 of 3 November 1997
1088 Zip 2.2 (November 3rd 1997)
1089 GNU tar 1.12 (1.11.x is no good)
1090 gzip 1.2.4 (18 Aug 93)
1092 [Win32] Win.98/Meadow
1096 GNU tar 1.11.8 + 1.5(WIN32)
1103 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1104 Hiramatsu version of LHA is only supported.
1105 In Win32, LHa32 is only supported (DOS version is no good).
1107 * Caution about GNU tar
1109 You have to take care about GNU tar's version because many version has
1110 problem on deleting file from archive.
1112 Please test @option{--delete} @option{-f} options work. Otherwise, your
1113 archive will be destroyed. No problem is reported on above versions of
1117 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1119 @cindex Archive Tips
1121 For comfortable migration, usage of @code{wl-summary-archive}
1122 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1123 archive folders created by expiration, you must set non-nil value to
1124 @code{elmo-archive-treat-file}.
1126 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1127 in processing speed. For comfortable use, Emacs20 is recommended.
1128 (If re-search's performance is the problem, 19.3x or later may be okay.)
1130 If many files are included in one archive,
1131 it takes long time to access to the archive folder because
1132 archiver starting overhead is increased (especially LHA).
1133 150-200 messages in one archive is recommended.
1135 Of course, following is possible @t{:-)}
1136 (meanings of these variables are described later.)
1140 (setq wl-fcc "$backup")
1141 (setq wl-trash-folder "$trash;lha")
1145 @node Archive Vars, , Archive Tips, Archive Folder
1146 @subsection Variables About Archive Folder
1147 @cindex Archive variables
1150 @item elmo-archive-default-type
1151 @vindex elmo-archive-default-type
1152 The initial setting is @code{zip}.
1153 Set archiver type by symbol.
1155 @item elmo-archive-@var{type}-method-alist
1156 @vindex elmo-archive-TYPE-method-alist
1157 Define archiver @var{type}'s methods.
1158 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1159 Each element of the alist is following.
1163 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1164 (@var{action} . @var{function}) ;; function
1168 Currently available actions are following.
1172 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1173 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1180 actions enclosed with braces are optional (They are used for better
1183 @item elmo-archive-suffix-alist
1184 @vindex elmo-archive-suffix-alist
1185 An alist of archiver-type (symbol) and suffix.
1187 @item elmo-archive-file-regexp-alist
1188 @vindex elmo-archive-file-regexp-alist
1189 An alist of a regexp to get file number from list output of archiver
1190 and archiver-type (symbol).
1192 @item elmo-archive-method-list
1193 @vindex elmo-archive-method-list
1194 A list of elmo-archive-@var{type}-method-alist
1195 (@var{type} is a symbol of archiver-type).
1197 @item elmo-archive-lha-dos-compatible
1198 @vindex elmo-archive-lha-dos-compatible
1199 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1200 DOS (Mr. Yoshizaki original) compatible.
1202 @item elmo-archive-cmdstr-max-length
1203 @vindex elmo-archive-cmdstr-max-length
1204 The initial setting is 8000.
1206 Max length of command line argument for external archiver program.
1207 Emacs does not have a limit of command line byte length, but some OS
1208 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1209 this limit because it calls external archiver program directly (not
1210 called via shell). For example, you cannot delete messages if archiver
1211 program must receive larger bytes of arguments to delete. OS/2 have a
1212 command line argument limit of 8190 bytes, so we defined default as 8000
1215 However, you don't have an influence of command line argument limit
1216 if the archiver has `actions' to receive target file information from
1217 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1220 @node POP Folder, Multi Folder, Archive Folder, Folders
1228 A folder to access e-mails via POP3 protocol (RFC 1939).
1234 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1239 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1240 as @var{authenticate-type}.
1244 @var{username} -> The value of @code{elmo-default-pop3-user}.
1245 Initial setting is @env{USER} environment variable or
1246 @env{LOGNAME} environment variable or return value of
1247 @code{(user-login-name)}.
1248 @var{authenticate-type} -> The value of @code{elmo-default-pop3-authenticate-type}.
1249 Initial setting is @samp{user}.
1250 @var{hostname} -> The value of @code{elmo-default-pop3-server}.
1251 Initial setting is @samp{localhost}.
1252 @var{port} -> The value of @code{elmo-default-pop3-port}.
1253 Initial setting is 110.
1260 &hoge@@localhost -> access to localhost as user @samp{hoge}.
1261 &hoge@@popserver:109 -> access to the server "popserver" on port 109
1262 as user @samp{hoge}.
1266 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1267 (XEmacs doesn't need @file{md5.el}).
1268 @file{md5.el} is included in @file{utils/sasl/lisp/} or Emacs/W3 package:
1271 http://www.cs.indiana.edu/elisp/w3/docs.html
1274 or LCD archive (GPL2).
1276 If the last character of the folder name is @samp{!}, Wanderlust connects to
1277 the POP server via SSL (Secure Socket Layer). If you set non-nil
1278 value to @code{elmo-default-pop-ssl}, you don't have to put @samp{!} in the
1279 end of the folder name to use SSL.
1280 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
1281 if the value of @code{elmo-default-pop-ssl} is @code{starttls},
1282 STARTTLS will be the default connection.
1284 @node Multi Folder, Filter Folder, POP Folder, Folders
1285 @section Multi Folder
1286 @cindex Multi Folder
1288 @cindex Folder, Multiple
1289 @cindex Folder, Marge
1291 A folder to access to a folder which collects messages from
1292 multiple folders virtually.
1298 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1302 After @samp{*} character, specify multiple folders you want to collect
1303 separated by ',' like
1304 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1310 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1311 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1312 treated as one folder.
1314 *+inbox,-fj.rec.tv,%inbox
1315 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1320 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1321 @section Filter Folder
1322 @cindex Filter Folder
1324 @cindex Folder, Filtering
1325 @cindex Folder, Virtual
1327 A folder to access to a folder which collects all messages that
1328 satisfy a condition virtually.
1333 @samp{/} @var{condition} @samp{/} @var{target-folder}
1336 In the @var{condition} part, you can specify following.
1340 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1342 first: @var{number} messages are picked from top of folder.
1343 last: @var{number} messages are picked from bottom of folder.
1349 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1350 /first:20/%inbox -> First 20 messages from %inbox are picked.
1355 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1357 since: only messages arrived since @var{date} are picked.
1358 before: only messages arrived before @var{date} are picked.
1360 You can specify following as @var{date}.
1364 yesterday -> a day before today.
1365 lastweek -> same day of last week.
1366 lastmonth -> same day of last month.
1367 lastyear -> same day of last year.
1368 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1369 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1377 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1379 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1385 Field filter: @samp{@var{field}:@var{value}}
1387 All messages that have @var{field} and its value is @var{value} are picked.
1388 @var{field} and @var{value} are case insensitive.
1394 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1395 and its value includes "teranisi" string are picked.
1396 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1404 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1405 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1407 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1408 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1414 /from:teranisi&!to:teranisi/+inbox
1415 -> In +inbox, messages are picked if the message's
1416 From: field includes "teranisi" and
1417 To: field doesn't include "teranisi".
1419 /tocc:"Yuuichi Teranishi"/+inbox
1420 -> In +inbox, messages are picked if the
1421 message's To: field or Cc: field includes
1422 "Yuuichi Teranishi".
1424 /(from:yt|from:teranisi)&subject:report/+inbox
1425 -> In +inbox, messages are picked if the message's
1426 From: field includes "yt" or "teranisi", and
1427 Subject includes "report".
1433 Tip for string description:
1435 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1436 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1437 should be escaped with @samp{\} in it). You can enclose the string with
1438 @samp{"} even it does not contain these characters.
1444 *%inbox,/from:teranisi/%inbox@@server
1445 -> Messages in %inbox or
1446 message is in the %inbox@@server folder and it's From field
1447 includes "teranisi" are collected.
1449 /last:100//to:teranisi/*+inbox,%inbox
1450 -> Latest 100 messages which is in the +inbox or %inbox folder
1451 and To: field matches "teranisi".
1453 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1454 -> Pick messages which have From: field and it includes "hogehoge"
1455 from latest 20 messages in the %#mh/inbox@@localhost
1456 and To: or Cc: field includes "teranisi".
1459 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1460 @section Pipe Folder
1464 @cindex Download Message
1465 @cindex Incorporate Message
1467 In the pipe folder, messages are automatically transferred from the source
1468 folder to destination folder.
1473 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1476 When you access to the pipe folder, messages are automatically transferred
1477 from @var{source-folder} to @var{destination-folder}.
1478 It is convenient if you want to download messages to local disk via POP.
1479 For example, if you specify following
1482 |&username@@popserver|+inbox
1485 and access to it, messages are downloaded automatically from
1486 &username@@popserver to @samp{+inbox}.
1492 %inbox|%myinbox -> Download %inbox to %myinbox.
1493 *&user@@popserver1,&user@@popserver2|+inbox
1494 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1498 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1500 @node Internal Folder, , Pipe Folder, Folders
1501 @section Internal folder
1502 @cindex Internal Folder
1504 @cindex Folder, @samp{$} mark
1506 A folder to access to internal messages of Wanderlust.
1518 A folder named @samp{'mark} is a special virtual folder which collects
1519 messages which have important mark @samp{$}.
1521 You can review important messages at once after you put important marks
1522 on the messages in the different folders.
1524 In this folder, if you delete message, important mark @samp{$} put on
1525 the message is removed. If you append messages to this folder, the
1526 message will have @samp{$} mark.
1528 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1529 folder. If you want IMAP folder's message remove from @{'mark} folder,
1530 remove important mark at IMAP Folder.)
1532 You can access to the cached messages fetched via network by accessing
1533 to the folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1534 the name of the subdirectories of the cache directory
1535 (@file{~/.elmo/cache}).
1538 @node Folder, Summary, Folders, Top
1539 @chapter Folder mode
1542 After you start Wanderlust, folder mode is appeared firstly.
1543 It contains folder list you subscribed.
1544 You can select and edit folders in this mode.
1547 * Selecting Folder:: Select folder you want to read.
1548 * Folder Manager:: Editing folders.
1552 @node Selecting Folder, Folder Manager, Folder, Folder
1553 @section Selecting Folder
1554 @cindex Selecting Folder
1556 @subsection Usage (TIPS)
1558 @subsubsection Check new, unread number
1560 Folder mode looks like this.
1561 (In XEmacs, it looks much nicer @t{;-)})
1565 [-]Desktop:14186/35580/67263
1570 [-]Emacsen:0/34/4837
1571 Wanderlust ML:0/0/558
1574 XEmacs Beta:0/29/255
1585 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1589 @kbd{s} key on the folder line updates these numbers.
1590 It changes its color if it has many new messages.
1592 The whole folder mode is a folder group named @samp{Desktop}.
1593 Folder group open/close by return key.
1594 A operation to a folder group is treated as operations on the
1596 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1597 six children folders update its unread number status.
1599 @subsubsection Select Folder
1601 To enter summary mode of the folder, type return (or space) key on
1603 If the variable @code{wl-stay-folder-window} has non-nil value,
1604 summary window appears on the right of the folder mode window.
1606 @subsection Key bindings
1608 Folder mode's key binding (related to selecting folders) is following.
1613 @kindex @key{SPC} (Folder)
1614 @kindex @key{RET} (Folder)
1615 @findex wl-folder-jump-to-current-entity
1616 Enter to the summary mode of the folder at the current cursor point.
1617 If the cursor is on the top of folder group line,
1618 the folder group is opened or closed.
1619 When the cursor is on the access group and this command is called
1620 with prefix argument, folder children list is updated to the newest one.
1621 (Children list is updated recursively if the access folder has hierarchical
1623 (@code{wl-folder-jump-to-current-entity})
1626 @kindex M-@key{RET} (Folder)
1627 @findex wl-folder-update-recursive-current-entity
1628 Folder children list of the access group at the current cursor point
1629 is updated to the newest one.
1630 (Children list is updated recursively if the access folder has hierarchical
1632 (@code{wl-folder-update-recursive-current-entity})
1637 Create a new draft message.
1642 @findex wl-folder-write-current-newsgroup
1643 If the current cursor point is on the NNTP folder,
1644 create a new draft message which already has newsgroups field.
1645 (@code{wl-folder-write-current-newsgroup})
1648 @kindex C-c C-o (Folder)
1649 @findex wl-jump-to-draft-buffer
1650 Move to the draft buffer if available. If multiple draft buffer exists,
1651 moved to one after another. If prefix argument is specified, load draft
1652 folder's message to the draft buffer and jump to it.
1653 (@code{wl-jump-to-draft-buffer})
1657 @findex wl-folder-check-current-entity
1658 Update new and unread number information of the folder at the current
1660 (@code{wl-folder-check-current-entity})
1664 @findex wl-folder-sync-current-entity
1665 Update summary information of the folder at the current cursor point.
1666 (@code{wl-folder-sync-current-entity})
1669 @kindex r s (Folder)
1670 @findex wl-folder-check-region
1671 Update new and unread number information of the folders in the currently
1673 (@code{wl-folder-check-region})
1676 @kindex r S (Folder)
1677 @findex wl-folder-sync-region
1678 Update summary information of the folders in the currently selected region.
1679 (@code{wl-folder-sync-region})
1683 @findex wl-status-update
1684 Sync up address book status with @file{~/.addresses}'s content.
1685 (@code{wl-status-update})
1689 @findex wl-folder-prev-unread
1690 Jump cursor to the folder which have unread messages on the upward from
1691 current cursor point.
1692 (@code{wl-folder-prev-unread})
1696 Jump cursor to the folder which have unread messages on the downward
1697 from current cursor point.
1698 (@code{wl-folder-next-unread})
1702 Move cursor to the folder on the previous line.
1703 (@code{wl-folder-prev-entity})
1707 Move cursor to the folder on the next line.
1708 (@code{wl-folder-next-entity})
1712 Jump to the folder specified by the user input.
1713 (@code{wl-folder-jump-folder})
1717 @findex wl-folder-prefetch-current-entity
1718 Prefetch new messages of the folder at the current cursor point by
1719 @code{wl-summary-incorporate}.
1720 If the cursor is on the folder group, it is executed recursively.
1721 (@code{wl-folder-prefetch-current-entity})
1725 @findex wl-folder-mark-as-read-all-current-entity
1726 Mark all unread messages of the folder at the current cursor point as read.
1727 If the cursor is on the folder group, it is executed recursively.
1728 (@code{wl-folder-mark-as-read-all-current-entity})
1732 @findex wl-folder-goto-first-unread-folder
1733 Enter summary mode of the first unread folder.
1734 (@code{wl-folder-goto-first-unread-folder})
1738 @findex wl-folder-empty-trash
1740 (@code{wl-folder-empty-trash})
1744 @findex wl-folder-open-all-unread-folder
1745 All unread folder is opened.
1746 (@code{wl-folder-open-all-unread-folder})
1750 @findex wl-folder-open-close
1751 Folder group is opened/closed.
1752 (@code{wl-thread-open-close})
1756 All folder group is opened.
1757 (@code{wl-folder-open-all})
1761 All folder group is closed.
1762 (@code{wl-folder-close-all})
1772 (@code{wl-folder-suspend})
1775 @kindex M-s (Folder)
1776 Save current folder status.
1780 @kindex M-t (Folder)
1781 Toggle Wanderlust's offline/online status.
1782 (@code{wl-toggle-plugged})
1785 @kindex C-t (Folder)
1786 Start Wanderlust's plug-status manager.
1787 (@code{wl-plugged-change})
1790 @subsection Customize variables
1793 @item wl-folders-file
1794 @vindex wl-folders-file
1795 The initial setting is @file{~/.folders}.
1796 Subscribed folders are described (saved) in this file.
1798 @item wl-folder-info-save
1799 @vindex wl-folder-info-save
1800 The initial setting is @code{t}. If non-nil, unread information is
1801 saved and used in the next Wanderlust session.
1803 @item wl-stay-folder-window
1804 @vindex wl-stay-folder-window
1805 The initial setting is @code{nil}.
1806 If non-nil, summary window is appeared on the right side of the folder buffer.
1808 @item wl-folder-window-width
1809 @vindex wl-folder-window-width
1810 The initial setting is 20.
1811 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1813 @item wl-folder-many-unsync-threshold
1814 @vindex wl-folder-many-unsync-threshold
1815 The initial setting is 70.
1816 If the number of unread messages is more than this value,
1817 folder color is changed.
1819 @item wl-highlight-folder-by-numbers
1820 @vindex wl-highlight-folder-by-numbers
1821 This option controls how to highlight each line in the folder buffer.
1822 The default value is @code{t}, highlighting with various colors based on
1823 the message numbers. If it is @code{nil}, highlighting with various
1824 colors based on the folder status. In addition, if it is a number
1825 (e.g. 1), highlighting will be done based on both the message numbers
1826 and the folder status.
1828 @item wl-folder-desktop-name
1829 @vindex wl-folder-desktop-name
1830 The initial setting is @samp{Desktop}.
1831 The name of top folder group.
1833 @item wl-folder-petname-alist
1834 @vindex wl-folder-petname-alist
1835 The initial setting is @code{nil}.
1836 An alist of folder's realname and its nickname.
1838 @item wl-folder-access-subscribe-alist
1839 @vindex wl-folder-access-subscribe-alist
1840 The initial setting is @code{nil}.
1842 Control automatic subscribing and unsubscribing of the children list
1848 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1852 If @var{subscribe-flag} is non-nil, folders which have name matched to
1853 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1854 already unsubscribed folder is not displayed even when the
1855 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1862 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1863 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1864 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1865 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1869 @item wl-folder-hierarchy-access-folders
1870 @vindex wl-folder-hierarchy-access-folders
1871 The initial setting is the list shown below:
1880 A list of access groups which creates children folder list hierarchically.
1882 For example, if you specify
1883 @code{wl-folder-hierarchy-access-folders} like following,
1887 (setq wl-folder-hierarchy-access-folders
1888 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1893 such access group hierarchy is obtained.
1899 -fj.comp.announce:0/0/2
1900 -fj.comp.dev.cdrom:0/0/0
1902 [+]-japan:238/238/1688
1905 -comp.unix.admin:0/0/0
1906 -comp.unix.dos-under-unix:0/0/0
1907 -comp.unix.programmer:0/0/0
1908 [-]-comp.unix.bsd:0/0/23
1909 -comp.unix.bsd.freebsd.announce:0/0/0
1914 If you opened @samp{-} in this example, only the direct children is created
1915 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1916 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1917 is not created until the children access group is opened.
1921 @node Folder Manager, , Selecting Folder, Folder
1922 @section Editing Folders
1923 @cindex Folder Manager
1924 @cindex Folder, Edit
1925 @cindex Folder, Subscribe
1926 @cindex Folder, Unsubscribe
1928 As described before, subscribed folder list is saved in @file{~/.folders} file.
1929 But you don't have to edit @file{~/.folders} directly.
1930 You can append, delete, edit folders from folder mode.
1932 @subsection Usage (Tips)
1934 @subsubsection Append Folder
1936 @kbd{m a} appends new folder to the folder mode.
1937 @kbd{m g} appends new folder group.
1938 To append new folder to this group, firstly open it,
1939 then execute append command in the next line.
1941 @subsubsection Edit Folder
1943 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1944 Thus, you can change folder position as if you were editing a normal file.
1946 @subsubsection Create Multi Folder.
1950 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
1952 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
1954 Type @kbd{m m}, then you can create multi folder.
1957 @subsubsection Delete Nickname, Filter
1959 You can delete nickname or filter by putting ``''(@var{NULL}) from the
1960 minibuffer while appending.
1962 @subsubsection Append Folder to Empty Group
1964 To append new folder to the empty folder group
1965 (after you create folder group by typing @kbd{m g}),
1966 firstly open it, then execute append command in the next line.
1967 If it is closed, folder is appended on the same level with
1968 the above folder group. It is difficult to explain by words so try it.
1969 In other words, appended position depends on the
1970 above folder group's open/close status.
1972 @subsubsection Charset of the Folders File.
1974 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
1976 @subsubsection Create Filter
1978 @kbd{m f} adds filter to the folder at the current cursor point. To
1979 create new filter folder and leave the current folder unchanged, copy it
1980 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
1981 filter can be specified while appending filter. If you put
1982 ``''(@var{NULL}), filter is deleted.
1984 @subsubsection Sort Folders
1986 Sorting of the folders is executed by the function specified by
1987 @code{wl-fldmgr-sort-func}.
1988 The initial setting is @code{wl-fldmgr-sort-standard},
1989 which sorts alphabetically.
1990 Sorting affects only on the current folder group. It does not
1991 affect on the child groups.
1993 @subsubsection Hiding Folders in the Access Group
1995 Usually, access group displays all children folders, but you can set
1996 some folders hidden. Following operations are only available on access
1999 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2000 (subscribe/unsubscribe) of the folder at current cursor point. Against
2001 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2004 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2005 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2006 argument and if the argument has positive number, the unsubscribe it.
2007 If the prefix argument has negative value, folder becomes visible and if
2008 zero, folder visibility is toggled.
2010 The other commands, @code{wl-fldmgr-subscribe} and
2011 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2014 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2015 executed in the access group, they have a same effect with
2016 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2017 The difference is that cut(-region) commands deletes folders from the
2020 @subsubsection Operations in the Access Group
2022 You can insert and delete folders in the access group like usual folder
2023 group. But insert and delete commands can be only available for the
2024 children folders of the access group and they only sets the subscribe
2025 status. In other words, insertion of the folder means subscribing,
2026 deletion means unsubscribing.
2027 @footnote{In the current implementation,
2028 it is faster to delete region than to unsubscribe region.}
2030 To update the access group when children folders are inserted or deleted
2031 by other way (other than Wanderlust),
2032 open the access group by typing @kbd{C-u @key{RET}}.
2033 @xref{Selecting Folder}.
2035 The order of children folders of access group is saved after
2036 insertion/deletion/sorting.
2037 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2038 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2039 newly created folders are inserted on the top of the access group.
2041 @subsection Key bindings
2042 @cindex Keybind, Folder Mode
2043 @cindex Keybind, Folder Buffer
2045 Key bindings on the folder mode related to folder editing are shown below.
2046 All bindings starts with @kbd{m}, and primary commands are binded to
2047 one stroke key binding.
2051 @kindex m a (Folder)
2052 @findex wl-fldmgr-add
2054 (@code{wl-fldmgr-add})
2059 @kindex m g (Folder)
2060 @findex wl-fldmgr-make-group
2061 Create a folder group.
2062 (@code{wl-fldmgr-make-group})
2065 @kindex m A (Folder)
2066 @findex wl-fldmgr-make-access-group
2067 Create an access group.
2068 (@code{wl-fldmgr-make-access-group})
2071 @kindex m d (Folder)
2072 @findex wl-fldmgr-delete
2073 Delete folder itself and msgdb.
2074 If the folder itself cannot be deleted like NNTP folder,
2075 only msgdb is deleted.
2076 (@code{wl-fldmgr-delete})
2081 @kindex m R (Folder)
2082 @findex wl-fldmgr-rename
2083 Change the name of folder or folder group.
2084 msgdb's path is also changed.
2085 (@code{wl-fldmgr-rename})
2091 @findex wl-fldmgr-make-multi
2092 Create a multi folders in the cutlist (cut, copied folders).
2093 (@code{wl-fldmgr-make-multi})
2098 @kindex m f (Folder)
2099 @findex wl-fldmgr-make-filter
2100 Create a filter folder. (Put a filter on the folder).
2101 (@code{wl-fldmgr-make-filter})
2105 @kindex M-c (Folder)
2106 @kindex m c (Folder)
2107 @findex wl-fldmgr-copy
2108 Copy folder (it is not available on folder group).
2109 (@code{wl-fldmgr-copy})
2113 @kindex M-w (Folder)
2114 @kindex m W (Folder)
2115 @findex wl-fldmgr-copy-region
2116 Copy folders in the specified region.
2117 (@code{wl-fldmgr-copy-region})
2121 @kindex C-k (Folder)
2122 @kindex m k (Folder)
2123 @findex wl-fldmgr-cut
2124 Cut folder. Folder itself is not deleted.
2125 (@code{wl-fldmgr-cut})
2129 @kindex C-w (Folder)
2130 @kindex m C-w (Folder)
2131 @findex wl-fldmgr-cut-region
2132 Cut folders in the specified region.
2133 (@code{wl-fldmgr-cut-region})
2137 @kindex C-y (Folder)
2138 @kindex m y (Folder)
2139 @findex wl-fldmgr-yank
2140 Paste folders that are copied or cut (folders in the cut-list).
2141 (@code{wl-fldmgr-yank})
2144 @kindex m p (Folder)
2145 @findex wl-fldmgr-set-petname
2146 Put nickname on the folder.
2147 (@code{wl-fldmgr-set-petname})
2150 @kindex m q (Folder)
2151 @findex wl-fldmgr-clear-cut-entity-list
2152 Clear the cut-list. (cut, copied folder information is cleared,
2153 you cannot paste after this)
2154 (@code{wl-fldmgr-clear-cut-entity-list})
2157 @kindex m s (Folder)
2158 @findex wl-fldmgr-sort
2159 Sort folders in the current folder group.
2160 (@code{wl-fldmgr-sort})
2163 @kindex m C-s (Folder)
2164 @findex wl-fldmgr-save
2165 Save current folder view to the @file{wl-folders-file}.
2166 (@code{wl-fldmgr-save})
2169 [Following commands are only available on the access groups]
2175 @kindex m u (Folder)
2176 @findex wl-fldmgr-unsubscribe
2177 Set the visibility of folder (subscribe/unsubscribe).
2178 (@code{wl-fldmgr-unsubscribe})
2183 @kindex r u (Folder)
2184 @findex wl-fldmgr-unsubscribe-region
2185 Set the visibility of the folders (subscribe/unsubscribe) in the
2187 (@code{wl-fldmgr-unsubscribe-region})
2192 @kindex m l (Folder)
2193 @findex wl-fldmgr-access-display-normal
2194 List folders that are currently available.
2195 (@code{wl-fldmgr-access-display-normal})
2200 @kindex m L (Folder)
2201 @findex wl-fldmgr-access-display-all
2202 List all folders regardless of the subscription status.
2203 (@code{wl-fldmgr-access-display-all})
2207 @subsection Customize variables
2210 @item wl-interactive-save-folders
2211 @vindex wl-interactive-save-folders
2212 The initial setting is @code{t}. If non-nil and folder view is
2213 modified, confirm saving it before Wanderlust or Emacs exits. If
2214 @code{nil}, save without confirmation.
2216 @item wl-fldmgr-make-backup
2217 @vindex wl-fldmgr-make-backup
2218 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2219 created before saving the folder status.
2221 @item wl-fldmgr-sort-func
2222 @vindex wl-fldmgr-sort-func
2223 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2224 sort folders. By default function, folders are sorted alphabetically
2225 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2228 @item wl-fldmgr-sort-group-first
2229 @vindex wl-fldmgr-sort-group-first
2230 The initial setting is @code{t}. If non-nil,
2231 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2232 does not care whether it is folder group or not.
2234 @item wl-folder-check-async
2235 @vindex wl-folder-check-async
2236 The initial setting is @code{t}. If non-nil, check folder's unread
2237 status asynchronously. It boosts newsgroup checking.
2239 @item wl-folder-check-fast
2240 @vindex wl-folder-check-fast
2241 The initial setting is @code{nil}.
2242 If non-nil, it does not update folder status while checking.
2244 @item wl-folder-notify-deleted
2245 @vindex wl-folder-notify-deleted
2246 The initial setting is @code{nil}.
2248 If non-nil, negative value is displayed when the message is deleted. If
2249 @code{sync}, folder is synchronized when the message is deleted. If
2250 @code{nil}, message deletion is ignored.
2253 @subsection Miscellanea
2255 Following is a note for folder editing.
2259 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2260 paste(yank) command pastes the folders on one cut or copy command
2261 (If copy command is executed by region, folders in the region are pasted
2262 by one paste command)
2265 You cannot cut @samp{Desktop} group.
2266 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2269 You cannot copy folder group.
2272 Operations on the access group are only available for the folders
2273 in the same access group.
2276 You cannot create a folder which has same name with the folders already exist.
2279 You cannot insert folders which have same name in one group.
2280 You can insert them in the different groups.
2281 You cannot put same nickname to the different folders.
2285 @node Summary, Message, Folder, Top
2286 @chapter Summary Mode
2288 After you select the folder via folder mode, you enter to the summary
2292 * Usage of Summary Mode:: TIPS.
2293 * Thread Oparations:: Thread oparations.
2294 * Cache:: File cache, Buffer cache, and Prefetch.
2295 * Auto Refile:: Auto refile settings.
2296 * Sticky Summary:: Summary make sticky.
2297 * Key Bindings of Summary:: Key bindings.
2298 * Variables of Summary:: Customize Summary Mode.
2302 @node Usage of Summary Mode, Thread Oparations, Summary, Summary
2303 @section Usage (Tips)
2305 @subsection Summary Content
2307 In the summary mode, messages are displayed like following.
2311 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2312 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2313 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2314 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2321 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2325 You cannot change this in the current version.
2327 @var{Message number} is the message's unique number in the folder. In
2328 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2329 in the MH folder, it is the filename of the message.
2331 @var{Temporal mark} and @var{Persistent mark} are described later.
2333 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2334 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2335 Japanese, but if you want to display it in English, set the value of
2336 @code{wl-summary-weekday-name-lang} as @samp{en}.
2338 @var{Sender}'s indentation corresponds to the depth of the thread.
2339 Sender name is displayed as nickname if it is defined in the address
2340 book. Set @code{wl-use-petname} as @samp{nil}, if you want to quit
2341 displaying with nickname.
2343 If number is printed at the head of @var{Sender} part like @samp{+2},
2344 that means the message have 2 follow messages.
2346 @var{Subject} is the @samp{Subject:} header field of the message. If
2347 the message have same @samp{Subject:} with the parent message, it is not
2348 displayed. Some mailing list puts its sequence number in the
2349 @samp{Subject:} field, but it is
2350 ignored. @code{wl-summary-no-subject-message} is displayed when the
2351 message has empty subject field.
2353 @subsection Temporary Marks
2354 @cindex Mark, Temporary
2356 There are four temporary marks,
2357 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2358 Temporary marks indicates message operations.
2363 You can execute a command on the all messages that have @samp{*} mark,
2364 with the key bindings which begins with @kbd{m}.
2367 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2371 After you type @kbd{o} key, prompt appears to input refile destination.
2372 Your answer is printed in the summary line.
2376 You can put this mark by typing @kbd{O} key.
2377 The difference between this mark and refile mark is,
2378 this mark does not delete the message while latter does.
2381 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2383 @subsection Persistent Marks
2385 There are five persistent marks,
2386 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2388 The persistent mark indicates the message's status and it is saved.
2389 Each persistent mark indicates:
2395 It is unread message.
2397 It is unread but cached message.
2399 It is read but it is not cached.
2401 It is important message. You can put @samp{$} mark by typing @kbd{$}
2402 key (if already exists, the mark is deleted). It is convenient to put
2403 this mark on the messages to remember (If you want to remember to write
2404 a reply for the message, for example) because this mark remains after
2405 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2406 even the message itself is deleted in the actual folder.
2409 If the message is read and cached (or local message),there are no
2413 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2414 cache. Messages with the marks other than these, you can read them in
2415 the offline status even they are in the IMAP folder or netnews folder.
2417 @subsection How To Read
2419 Basically, you can read messages only typing space key again and again.
2421 To update summary status to the newest status (synchronize),
2424 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2425 moves cursor to the next message.
2426 Enter message buffer by typing @kbd{j} key.
2427 To operate multipart, you have to enter to the message buffer.
2431 @node Thread Oparations, Cache, Usage of Summary Mode, Summary
2432 @section Thread Operations
2434 For example, the following line indicates one thread (a context of a topic).
2437 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2441 If you type @kbd{/} on this line, the thread is opened and it changes
2442 the appearance like following.
2446 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2447 388 09/17(Thu)22:34 +-[ Murata san ]
2451 (Message 388 is the replied message to the message 384.)
2452 If you type @kbd{/} key once again, the thread is closed.
2453 With prefix argument, @kbd{/} opens all children threads.
2455 Commands with the key binding that begins with @kbd{t} executes commands
2456 on the messages in the thread.
2459 @node Cache, Auto Refile, Thread Oparations, Summary
2462 @subsection Cache File
2464 The messages which have to access via network (e.x. IMAP, NNTP folder)
2465 are cached as a local file. The cache file is saved under the directory
2466 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2467 elmo-cache-expire-by-size}. The command deletes cache files to the
2468 specified size by the order of last accessed time.
2470 @subsection Buffer Cache and Prefetching
2472 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2473 that are read are kept in the cache buffer. It is called `buffer
2474 cache'. The number of cache buffer is specified by
2475 @code{elmo-buffer-cache-size}.
2477 There are message prefetching mechanism in the Wanderlust that
2478 prefetches next message while you are reading. This function requires
2479 that the value of @code{elmo-use-buffer-cache} is non-nil.
2481 You can control the message prefetching mechanism by these two
2485 @item wl-cache-prefetch-folder-type-list
2486 @vindex wl-cache-prefetch-folder-type-list
2487 The initial setting is the list shown below:
2495 It specifies the folder types in which message prefetching is enabled.
2496 In the initial setting, multi folder that contains localdir and imap4
2497 prefetches only imap4 messages. This variable precedes the value of
2498 @code{wl-cache-prefetch-folder-list}.
2500 If you want to prefetch localdir and localnews also, following setting
2505 (setq wl-cache-prefetch-folder-type-list
2506 '(nntp imap4 localdir localnews))
2510 @item wl-cache-prefetch-folder-list
2511 @vindex wl-cache-prefetch-folder-list
2512 The initial setting is @code{nil}.
2513 A list of regexp of folders to enable message prefetching.
2517 @node Auto Refile, Sticky Summary, Cache, Summary
2518 @section Auto Refile
2519 @vindex elmo-msgdb-extra-fields
2520 @vindex wl-refile-rule-alist
2521 @findex wl-summary-auto-refile
2523 You can refile messages automatically, by typing @kbd{C-o}
2524 (@code{wl-summary-auto-refile}). It decides destination of refile by
2525 the content of the message header information (information in the msgdb).
2527 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2528 available. If you want to decide destination by other header fields,
2529 set the variable @code{elmo-msgdb-extra-fields} like following.
2533 (setq elmo-msgdb-extra-fields
2543 By this setting, Wanderlust saves extra fields in the msgdb. You have
2544 to type @kbd{s all} to get extra fields for the messages that are
2545 already exists in the summary.
2547 Then, specify the refile rule. The refile target folder of auto
2548 refiling is decided by the value of @code{wl-refile-rule-alist}.
2549 @code{wl-refile-rule-alist} is a list of a rule:
2553 (@var{field} (@var{regexp} . @var{target})
2554 (@var{regexp} . @var{target})
2559 Each rule means `if @var{field} value matches @var{regexp},
2560 then refile to @var{target} folder'.
2561 The rule matched first is applied.
2563 @var{field} is a string of field name. You can specify a list of field name
2564 string, too. In this case, if one of these fields is matched, then the
2565 rule is fired (i.e. OR condition).
2567 @var{regexp} is a regular expression for field value. @var{target} is a target
2568 folder string. You can specify a rule at @var{target} part, too. In this
2569 case, If the field value of the rule and the current rule is matched,
2570 then the current rule is fired (i.e. AND condition).
2572 In @var{target} part, you can refer matched substring of @var{regexp}.
2573 To refer substring, specify following in @var{target}:
2577 means substitute original matched text.
2580 means substitute what matched the @var{N}th `\(@dots{}\)'.
2581 (@var{N} is a number.)
2584 Following is an example of @code{wl-refile-rule-alist}.
2588 (setq wl-refile-rule-alist
2590 ("^Wanderlust" . "+wl")
2591 ("^Elisp" . "+elisp"))
2593 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2595 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2596 "+from-me-to-you"))))))
2600 After these settings, refile marks are automatically put on the condition
2601 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2603 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2605 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2606 with these persistent marks are not automatically refiled.
2607 It means Wanderlust does not execute auto refile on unread messages by
2608 the default setting.
2609 To execute auto refile on all messages, set following.
2612 (setq wl-summary-auto-refile-skip-marks nil)
2616 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2617 @section Sticky Summary
2618 @cindex Summary, Sticky
2619 @cindex Sticky Summary
2621 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2623 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2624 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2626 The buffer name of the sticky summary becomes like
2627 @samp{Summary:@var{folder-name}}.
2629 You can visit the sticky summary at any time by @kbd{C-x b}
2630 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2631 q}. Other operations in the sticky summary are same as normal summary.
2633 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2634 are automatically sticked.
2637 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2638 @section Key bindings
2639 @cindex Keybind, Summary Mode
2640 @cindex Keybind, Summary Buffer
2642 Key bindings of the summary mode are shown below.
2646 @kindex @key{SPC} (Summary)
2647 @findex wl-summary-read
2648 Proceed reading a message at the current cursor point.
2649 (@code{wl-summary-read})
2653 @findex wl-summary-redisplay
2654 Redisplay a message at the current cursor point.
2655 If this command is called with prefix argument,
2656 Redisplay message regardless of the message cache (message is re-loaded
2658 (@code{wl-summary-redisplay})
2662 @findex wl-summary-display-top
2663 Display the top message in the folder.
2664 (@code{wl-summary-display-top})
2668 @findex wl-summary-display-bottom
2669 Display the bottom message in the folder.
2670 (@code{wl-summary-display-bottom})
2674 @kindex @key{BS} (Summary)
2675 @kindex @key{DEL} (Summary)
2676 Display the previous page of the message at the current cursor point.
2677 @findex wl-summary-prev-page
2678 (@code{wl-summary-prev-page})
2681 @kindex @key{RET} (Summary)
2682 @findex wl-summary-next-line-content
2683 Display the next line of the message at the current cursor point.
2684 Display the message at the current cursor point if it is not displayed yet.
2685 (@code{wl-summary-next-line-content})
2690 @kindex M-@key{RET} (Summary)
2691 @findex wl-summary-prev-line-content
2692 Display the previous line of the message at the current cursor point.
2693 Display the message at the current cursor point if it is not displayed yet.
2694 (@code{wl-summary-prev-line-content})
2698 @findex wl-thread-open-close
2699 Toggle open or close the thread at the current cursor point.
2700 (@code{wl-thread-open-close})
2705 @findex wl-thread-open-all
2706 (@code{wl-thread-open-all})
2711 @findex wl-thread-close-all
2712 (@code{wl-thread-close-all})
2716 @findex wl-summary-goto-folder
2718 (@code{wl-summary-goto-folder})
2722 Mark all messages in the folder as read.
2723 @findex wl-summary-mark-as-read-all
2724 (@code{wl-summary-mark-as-read-all})
2728 @findex wl-summary-reply
2729 Prepare a draft for reply the message at the current cursor point.
2730 (@code{wl-summary-reply})
2734 @findex wl-summary-reply-with-citation
2735 Prepare a draft for reply the message at the current cursor point.
2736 (@code{wl-summary-reply-with-citation})
2740 @findex wl-summary-cancel-message
2741 If the message at current cursor point is your own netnews article,
2743 (@code{wl-summary-cancel-message})
2747 @findex wl-summary-reedit
2748 Prepare a draft for re-editing the message at current cursor point.
2749 If the message at current cursor point is your own netnews article,
2750 a draft for `supersedes message' for the message is prepared.
2751 (@code{wl-summary-reedit})
2754 @kindex M-e (Summary)
2755 @findex wl-summary-resend-bounced-mail
2756 If the message at current cursor point is a bounced message,
2757 a draft for re-sending original message is prepared.
2758 (@code{wl-summary-resend-bounced-mail})
2762 @findex wl-summary-forward
2763 A draft for forwarding the message at current cursor point is prepared.
2764 (@code{wl-summary-forward})
2768 @findex wl-summary-mark-as-important
2769 Put @samp{$} mark on the message at current cursor point.
2770 If already marked as @samp{$}, delete it.
2771 (@code{wl-summary-mark-as-important})
2777 Save the message at current cursor point.
2778 @findex wl-summary-save
2779 (@code{wl-summary-save})
2783 @findex wl-summary-next
2784 Move cursor to the next message.
2785 If message is marked with a temporal mark in
2786 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2787 In the offline mode, cursor is not moved to the messages which are not cached
2789 (@code{wl-summary-next})
2793 @findex wl-summary-prev
2794 Move cursor to the previous message.
2795 If message is marked with a temporal mark in
2796 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2797 In the offline mode, cursor is not moved to the messages which are not cached
2799 (@code{wl-summary-prev})
2803 @findex wl-summary-down
2804 Move cursor to the downward message which is unread or marked
2806 (@code{wl-summary-down})
2810 @findex wl-summary-up
2811 Move cursor to the upward message which is unread or marked
2813 (@code{wl-summary-up})
2817 @findex wl-summary-write
2818 Prepare a new draft.
2819 (@code{wl-summary-write})
2823 @findex wl-summary-write-current-newsgroup
2824 Prepare a new draft. If the current folder is netnews folder,
2825 @samp{Newsgroups:} field is completed.
2826 (@code{wl-summary-write-current-newsgroup})
2830 @findex wl-summary-redisplay-all-header
2831 Redisplay the message at current cursor point with all header fields.
2832 (@code{wl-summary-redisplay-all-header})
2836 @findex wl-summary-redisplay-no-mime
2837 Redisplay the message at current cursor point without MIME analysis.
2838 (@code{wl-summary-redisplay-no-mime})
2842 @findex wl-summary-burst
2843 If the message at current cursor point has
2844 encapsulates multiple messages using MIME,
2845 de-capsulate and extract them on the current folder.
2846 (@code{wl-summary-burst})
2849 @kindex @@ (Summary)
2850 @findex wl-summary-edit-addresses
2851 Append/change/delete the message's sender information to the address
2852 book @file{~/.addresses} interactively. If this command is called with
2853 prefix argument, arbitrary address can be edited.
2854 (@code{wl-summary-edit-petname})
2858 @findex wl-status-update
2859 Sync up address book status with @file{~/.addresses}'s content.
2860 (@code{wl-status-update})
2864 @findex wl-summary-pipe-message
2865 Pipe current message's content to the external process.
2866 (@code{wl-summary-pipe-message})
2870 @findex wl-summary-print-message
2871 Print out current message's content.
2872 It uses @code{ps-print} module in Emacs 20.x.
2873 If you don't use color printer, you might want to set
2874 @code{wl-ps-print-buffer-func} to @code{ps-print-buffer}.
2877 (setq wl-ps-print-buffer-func 'ps-print-buffer)
2880 (@code{wl-summary-print-message})
2884 @findex wl-summary-exit
2885 Exit current folder.
2886 (@code{wl-summary-exit})
2890 @findex wl-summary-jump-to-current-message
2891 Jump cursor to the currently displayed message's window.
2892 (@code{wl-summary-jump-to-current-message})
2896 Jump cursor to the other message.
2897 @findex wl-summary-jump-to-msg
2898 (@code{wl-summary-jump-to-msg})
2902 Update summary status and
2903 prefetch all messages which have marks included in the
2904 @code{wl-summary-incorporate-marks}.
2905 @findex wl-summary-incorporate
2906 (@code{wl-summary-incorporate})
2909 @kindex M-j (Summary)
2910 @findex wl-summary-jump-to-msg-by-message-id
2911 Jump cursor to the message which have specified @samp{Message-Id:}. If
2912 @code{elmo-use-database} is non-nil, other folder is also searched.
2913 (@code{wl-summary-jump-to-msg-by-message-id})
2917 Jump to parent message.
2918 @findex wl-summary-jump-to-parent-message
2919 (@code{wl-summary-jump-to-parent-message})
2923 @findex wl-summary-mark-as-unread
2924 Mark as unread the message at current cursor point.
2925 (@code{wl-summary-mark-as-unread})
2929 @findex wl-summary-sync
2930 Synchronize summary view after prompting the update range
2931 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
2935 all ...Discard current summary and update all message.
2936 update ...Update the difference between summary and the folder itself.
2937 rescan ...Rescan the msgdb and display again.
2938 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2939 first, last ...Move to the filter folder(partial filter).
2944 (@code{wl-summary-sync})
2948 @findex wl-summary-sort
2950 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
2951 (@code{wl-summary-sort})
2955 @findex wl-summary-toggle-thread
2956 Toggle the threading.
2957 Threading status is displayed on the modeline.
2958 @samp{@{S@}} means threading is off (Sequence) and
2959 @samp{@{T@}} means threading is on (Thread).
2960 (@code{wl-summary-toggle-thread})
2964 @findex wl-summary-toggle-disp-folder
2965 Toggle displaying of folder window.
2966 (@code{wl-summary-toggle-disp-folder})
2970 Toggle displaying of message window.
2971 @findex wl-summary-toggle-disp-msg
2972 (@code{wl-summary-toggle-disp-msg})
2976 Move to the virtual folder with the condition specified.
2977 If called with prefix argument and current folder is virtual, exit it.
2978 @findex wl-summary-virtual
2979 (@code{wl-summary-virtual})
2982 @kindex @key{TAB} (Summary)
2983 @findex wl-summary-goto-last-displayed-msg
2984 Jump to the message which is displayed last.
2985 (@code{wl-summary-goto-last-displayed-msg})
2989 Put @samp{*} mark on the messages that satisfies the specified condition.
2990 @findex wl-summary-pick
2991 (@code{wl-summary-pick})
2995 @findex wl-summary-mark-as-read
2996 Mark as read the message at the current cursor point.
2997 (@code{wl-summary-mark-as-read})
3001 Prefetch the message at the current cursor point.
3002 With prefix argument, prefetch the message even if it is cached.
3003 @findex wl-summary-prefetch
3004 (@code{wl-summary-prefetch})
3008 Execute @samp{D}, @samp{o} and @samp{O} marks.
3009 @findex wl-summary-exec
3010 (@code{wl-summary-exec})
3014 @findex wl-summary-target-mark-line
3015 Put target mark on the message at the current cursor point.
3016 (@code{wl-summary-target-mark-line})
3020 Put refile mark on the message at the current cursor point.
3021 @findex wl-summary-refile
3022 (@code{wl-summary-refile})
3025 @kindex C-o (Summary)
3026 Execute auto refile.
3027 @findex wl-summary-auto-refile
3028 (@code{wl-summary-auto-refile})
3032 Put copy mark on the message at the current cursor point.
3033 @findex wl-summary-copy
3034 (@code{wl-summary-copy})
3037 @kindex M-o (Summary)
3038 Put refile mark on the message at the current cursor point with the destination
3039 previously specified.
3040 @findex wl-summary-refile-prev-destination
3041 (@code{wl-summary-refile-prev-destination})
3045 @findex wl-summary-delete
3046 Put delete mark on the message at the current cursor point.
3047 (@code{wl-summary-delete})
3051 @findex wl-summary-unmark
3052 Unmark the temporal mark on the message at the current cursor point.
3053 (@code{wl-summary-unmark})
3057 Unmark all the temporal marks.
3058 @findex wl-summary-unmark-all
3059 (@code{wl-summary-unmark-all})
3062 @kindex r R (Summary)
3063 @findex wl-summary-mark-as-read-region
3064 Mark as read messages in the specified region.
3065 (@code{wl-summary-mark-as-read-region})
3068 @kindex r $ (Summary)
3069 @findex wl-summary-mark-as-important-region
3070 Mark as important @samp{$} messages in the specified region.
3071 If @samp{$} already exists, it is deleted.
3072 (@code{wl-summary-mark-as-important-region})
3075 @kindex r ! (Summary)
3076 @findex wl-summary-mark-as-unread-region
3077 Mark as unread messages in the specified region.
3078 (@code{wl-summary-mark-as-unread-region})
3081 @kindex r i (Summary)
3082 @findex wl-summary-prefetch-region
3083 Prefetch messages in the specified region.
3084 (@code{wl-summary-prefetch-region})
3087 @kindex r x (Summary)
3088 @findex wl-summary-exec-region
3089 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3091 (@code{wl-summary-exec-region})
3094 @kindex r * (Summary)
3095 @findex wl-summary-target-mark-region
3096 Put target mark on the messages in the specified region.
3097 (@code{wl-summary-target-mark-region})
3100 @kindex r o (Summary)
3101 @findex wl-summary-refile-region
3102 Put refile mark on the messages in the specified region.
3103 (@code{wl-summary-refile-region})
3106 @kindex r O (Summary)
3107 @findex wl-summary-copy-region
3108 Put copy mark on the messages in the specified region.
3109 (@code{wl-summary-copy-region})
3112 @kindex r d (Summary)
3113 @findex wl-summary-delete-region
3114 Put delete mark on the messages in the specified region.
3115 (@code{wl-summary-delete-region})
3118 @kindex r u (Summary)
3119 @findex wl-summary-unmark-region
3120 Delete temporal mark on the messages in the specified region.
3121 (@code{wl-summary-unmark-region})
3124 @kindex r y (Summary)
3125 Save messages in the specified region.
3126 @findex wl-summary-save-region
3127 (@code{wl-summary-save-region})
3130 @kindex t R (Summary)
3131 @findex wl-thread-mark-as-read
3132 Mark as read messages which are the descendant of the current thread.
3133 With prefix argument, it affects on the all messages in the thread tree.
3134 (@code{wl-thread-mark-as-read})
3137 @kindex t $ (Summary)
3138 @findex wl-thread-mark-as-important
3139 Put important mark @samp{$} on the messages which are the
3140 descendant of the current thread.
3141 If @samp{$} mark exists, it is deleted.
3142 With prefix argument, it affects on the all messages in the thread tree.
3143 (@code{wl-thread-mark-as-important})
3146 @kindex t ! (Summary)
3147 @findex wl-thread-mark-as-unread
3148 Mark as unread messages which are the descendant of the current thread.
3149 With prefix argument, it affects on the all messages in the thread tree.
3150 (@code{wl-thread-mark-as-unread})
3153 @kindex t i (Summary)
3154 @findex wl-thread-prefetch
3155 Prefetch messages which are the descendant of the current thread.
3156 With prefix argument, it affects on the all messages in the thread tree.
3157 (@code{wl-thread-prefetch})
3160 @kindex t x (Summary)
3161 @findex wl-thread-exec
3162 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3163 the descendant of the current thread. With prefix argument, it affects
3164 on the all messages in the thread tree.
3165 (@code{wl-thread-exec})
3168 @kindex t * (Summary)
3169 @findex wl-thread-target-mark
3170 Put target mark @samp{*} on the messages which are the descendant of the
3171 current thread. With prefix argument, it affects on the all messages in
3173 (@code{wl-thread-target-mark})
3176 @kindex t o (Summary)
3177 @findex wl-thread-refile
3178 Put refile mark on the messages which are the descendant of the current thread.
3179 With prefix argument, it affects on the all messages in the thread tree.
3180 (@code{wl-thread-refile})
3183 @kindex t O (Summary)
3184 @findex wl-thread-copy
3185 Put copy mark on the messages which are the descendant of the current thread.
3186 With prefix argument, it affects on the all messages in the thread tree.
3187 (@code{wl-thread-copy})
3190 @kindex t d (Summary)
3191 @findex wl-thread-delete
3192 Put delete mar on the messages which are the descendant of the current thread.
3193 With prefix argument, it affects on the all messages in the thread tree.
3194 (@code{wl-thread-delete})
3197 @kindex t u (Summary)
3198 @findex wl-thread-unmark
3199 Unmark temporal mark on the messages which are the descendant of the
3200 current thread. With prefix argument, it affects on the all messages in
3202 (@code{wl-thread-unmark})
3205 @kindex t y (Summary)
3206 @findex wl-thread-save
3207 Save messages which are the descendant of the current thread.
3208 With prefix argument, it affects on the all messages in the thread tree.
3209 (@code{wl-thread-save})
3212 @kindex m i (Summary)
3213 @findex wl-summary-target-mark-prefetch
3214 Prefetch all messages which have target mark @samp{*}.
3215 (@code{wl-summary-target-mark-prefetch})
3218 @kindex m R (Summary)
3219 @findex wl-summary-target-mark-mark-as-read
3220 Mark as read all messages which have target mark @samp{*}.
3221 (@code{wl-summary-target-mark-mark-as-read})
3224 @kindex m $ (Summary)
3225 @findex wl-summary-target-mark-mark-as-important
3226 Mark as important all messages which have target mark @samp{*}.
3227 If already marked as @samp{$}, it is deleted.
3228 (@code{wl-summary-target-mark-mark-as-important})
3231 @kindex m ! (Summary)
3232 @findex wl-summary-target-mark-mark-as-unread
3233 Mark as unread all messages which have target mark @samp{*}.
3234 (@code{wl-summary-target-mark-mark-as-unread})
3237 @kindex m o (Summary)
3238 @findex wl-summary-target-mark-refile
3239 Put refile mark on the messages which have target mark @samp{*}.
3240 (@code{wl-summary-target-mark-refile})
3243 @kindex m O (Summary)
3244 @findex wl-summary-target-mark-copy
3245 Put copy mark on the messages which have target mark @samp{*}.
3246 (@code{wl-summary-target-mark-copy})
3249 @kindex m d (Summary)
3250 @findex wl-summary-target-mark-delete
3251 Put delete mark on the messages which have target mark @samp{*}.
3252 (@code{wl-summary-target-mark-delete})
3255 @kindex m y (Summary)
3256 @findex wl-summary-target-mark-save
3257 Save messages which have target mark @samp{*}.
3258 (@code{wl-summary-target-mark-save})
3261 @kindex m u (Summary)
3262 Unmark all temporal marks.
3263 (@code{wl-summary-delete-all-temp-marks})
3264 @findex wl-summary-delete-all-temp-marks
3267 @kindex m a (Summary)
3268 Put target mark @samp{*} on the all messages.
3269 (@code{wl-summary-target-mark-all})
3270 @findex wl-summary-target-mark-all
3273 @kindex m t (Summary)
3274 Put target mark @samp{*} on the messages in the current thread.
3275 @findex wl-summary-target-mark-thread
3276 (@code{wl-summary-target-mark-thread})
3279 @kindex m r (Summary)
3280 @findex wl-summary-target-mark-region
3281 Put target mark @samp{*} on the messages in the specified region.
3282 (@code{wl-summary-target-mark-region})
3285 @kindex m A (Summary)
3286 @findex wl-summary-target-mark-reply-with-citation
3287 Prepare a draft which cites all messages which have target mark @samp{*}.
3288 (@code{wl-summary-target-mark-reply-with-citation})
3291 @kindex m f (Summary)
3292 @findex wl-summary-target-mark-forward
3293 Prepare a draft which forwards all messages which have target mark @samp{*}.
3294 (@code{wl-summary-target-mark-forward})
3297 @kindex m U (Summary)
3298 @findex wl-summary-target-mark-uudecode
3299 Uudecode the messages which have target mark @samp{*}.
3300 (@code{wl-summary-target-mark-uudecode})
3303 @kindex m ? (Summary)
3304 @findex wl-summary-target-mark-pick
3305 Pick messages from the @samp{*} marked messages.
3306 That is, @samp{*} marks on the messages are remained
3307 if the specified condition is satisfied.
3308 (@code{wl-summary-target-mark-pick})
3311 @kindex M-t (Summary)
3312 @findex wl-toggle-plugged
3313 Toggle offline/online status of Wanderlust.
3314 (@code{wl-toggle-plugged})
3317 @kindex C-t (Summary)
3318 Start Wanderlust's plug-status manager.
3319 (@code{wl-plugged-change})
3322 @kindex C-c C-o (Summary)
3323 @findex wl-jump-to-draft-buffer
3324 Move to the draft buffer if available. If multiple draft buffer exists,
3325 moved to one after another. If prefix argument is specified, load draft
3326 folder's message to the draft buffer and jump to it.
3327 (@code{wl-jump-to-draft-buffer})
3331 @node Variables of Summary, , Key Bindings of Summary, Summary
3332 @section Customiziable variables
3335 @item wl-summary-move-order
3336 @vindex wl-summary-move-order
3337 The initial setting is @code{unread}. Specify cursor moving policy. If
3338 you want to precede new messages, set @code{new}. If you want to
3339 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3342 @item wl-auto-select-first
3343 @vindex wl-auto-select-first
3344 The initial setting is @code{nil}.
3345 If non-nil, first message is automatically displayed.
3347 @item wl-auto-select-next
3348 @vindex wl-auto-select-next
3349 The initial setting is @code{nil}. If non-nil, jump to next summary
3350 automatically. If @code{unread}, jump to next unread folder's summary
3351 after confirmation. If @code{skip-no-unread}, unread folders are
3352 automatically skipped.
3354 @item wl-thread-insert-opened
3355 @vindex wl-thread-insert-opened
3356 The initial setting is @code{nil}.
3357 If non-nil, thread is inserted as opened.
3359 @item wl-thread-open-reading-thread
3360 @vindex wl-thread-open-reading-thread
3361 The initial setting is @code{t}. If non-nil, reading thread is
3362 automatically opened though it is closed thread.
3364 @item wl-summary-exit-next-move
3365 @vindex wl-summary-exit-next-move
3366 The initial setting is @code{t}. If non-nil, move to next folder at
3369 @item wl-folder-move-cur-folder
3370 @vindex wl-folder-move-cur-folder
3371 The initial setting is @code{nil}. If non-nil, cursor position on the
3374 @item wl-summary-weekday-name-lang
3375 @vindex wl-summary-weekday-name-lang
3376 The initial setting is @samp{ja}. Specify language of the weekday.
3377 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3380 @item wl-summary-fix-timezone
3381 @vindex wl-summary-fix-timezone
3382 The initial setting is @samp{JST}. Timezone to adjust summary's
3383 timezone. If @code{nil}, adjust to GMT.
3385 @item wl-use-petname
3386 @vindex wl-use-petname
3387 The initial setting is @code{t}.
3388 If non-nil, sender part displays nickname.
3390 @item wl-break-pages
3391 @vindex wl-break-pages
3392 The initial setting is @code{t}.
3393 If non-nil, message is splitted as pages by @samp{^L}.
3395 @item wl-message-window-size
3396 @vindex wl-message-window-size
3397 The initial setting is '(1 . 4).
3398 A cons cell to specify the rate of summary and message window.
3399 car:cdr corresponds summary:message.
3401 @item wl-summary-recenter
3402 @vindex wl-summary-recenter
3403 The initial setting is t.
3404 If non-nil, cursor point is moved to the center of the summary window.
3406 @item wl-summary-indent-length-limit
3407 @vindex wl-summary-indent-length-limit
3408 The initial setting is 46.
3409 Specify the limit of thread indent level.
3410 If nil, max indent level is unlimited.
3412 @item wl-summary-no-from-message
3413 @vindex wl-summary-no-from-message
3414 The initial setting is @samp{nobody@@nowhere?}. A string which is
3415 displayed when there's no @samp{From:} field in the message.
3417 @item wl-summary-no-subject-message
3418 @vindex wl-summary-no-subject-message
3419 The initial setting is @samp{(WL:No Subject in original.)}. A string
3420 which is displayed when there's no @samp{Subject:} field in the message.
3422 @item wl-summary-width
3423 @vindex wl-summary-width
3424 The initial setting is 80.
3425 Width of summary line. If @code{nil}, summary line's width is as is.
3427 @item wl-use-folder-petname
3428 @vindex wl-use-folder-petname
3429 The initial setting is the list shown below:
3438 A list of display policy (symbol) of folder nickname. Available symbols
3443 Display folder petname on modeline.
3445 Destination folder is notified as nickname if
3446 @code{wl-auto-select-next} is non-nil.
3448 You can input folder name by nickname in the function
3449 @code{wl-summary-read-folder}.
3452 @item wl-summary-move-direction-toggle
3453 @vindex wl-summary-move-direction-toggle
3454 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3455 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3456 want to aware of reading direction, set this to @code{t}.
3459 @vindex wl-from-width
3460 The initial setting is 17.
3461 Width of sender part of summary line.
3463 @item wl-summary-divide-thread-when-subject-changed
3464 @vindex wl-summary-divide-thread-when-subject-changed
3465 The initial setting is @code{nil}. If non-nil, thread is splitted if
3466 the subject is changed.
3468 @item wl-summary-search-via-nntp
3469 @vindex wl-summary-search-via-nntp
3470 The initial setting is @code{confirm}.
3472 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3473 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3474 from the NNTP server @code{elmo-default-nntp-server}. The value of
3475 @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
3476 @code{elmo-default-nntp-ssl} are used.
3478 If @code{confirm}, server name can be specified. You can specify NNTP
3479 folder format like @samp{-:username@@servername:119!}.
3481 @item wl-summary-keep-cursor-command
3482 @vindex wl-summary-keep-cursor-command
3483 The initial setting is the list shown below:
3487 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3492 When you entered to summary by these commands and the target summary
3493 buffer already exists, summary status is not automatically updated and
3494 cursor position is saved.
3496 @item wl-summary-update-confirm-threshold
3497 @vindex wl-summary-update-confirm-threshold
3498 The initial setting is 500. If updated message number is larger than
3499 this value, confirm whether drop them or not.
3501 @item wl-summary-always-sticky-folder-list
3502 @vindex wl-summary-always-sticky-folder-list
3503 The initial setting is @code{nil}.
3504 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3505 are automatically sticked. Each element is regexp of folder name.
3507 @item wl-summary-reserve-mark-list
3508 @vindex wl-summary-reserve-mark-list
3509 The initial setting is the list shown below:
3518 If a message is already marked as temporal marks in this list, the
3519 message is not marked by any mark command.
3521 @item wl-summary-skip-mark-list
3522 @vindex wl-summary-skip-mark-list
3523 The initial setting is the list shown below:
3532 If a message is already marked as temporal marks in this list, the
3533 message is skipped at cursor move.
3535 @item wl-fetch-confirm-threshold
3536 @vindex wl-fetch-confirm-threshold
3537 The initial setting is 30000 (bytes). If displaying message has larger
3538 size than this value, Wanderlust confirms whether fetch the message or
3539 not. If @code{nil}, the message is fetched without confirmation.
3541 @item wl-prefetch-threshold
3542 @vindex wl-prefetch-threshold
3543 The initial setting is 30000 (bytes). If prefetching message has larger
3544 size than this value and @code{wl-prefetch-confirm} is non-nil,
3545 Wanderlust confirms whether prefetch the message or not. If
3546 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3547 without confirmation.
3549 @item wl-prefetch-confirm
3550 @vindex wl-prefetch-confirm
3551 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3552 prefetch the message or not if the message has larger size than
3553 @code{wl-prefetch-threshold}.
3555 @item wl-cache-fetch-threshold
3556 @vindex wl-cache-fetch-threshold
3557 The initial setting is 30000 (bytes). The messages which have larger
3558 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3559 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3562 @item elmo-imap4-use-cache
3563 @vindex elmo-imap4-use-cache
3564 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3567 @item elmo-nntp-use-cache
3568 @vindex elmo-nntp-use-cache
3569 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3572 @item elmo-pop3-use-cache
3573 @vindex elmo-pop3-use-cache
3574 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3579 @node Message, Draft, Summary, Top
3580 @chapter Message Buffer
3582 Message Buffers utilize MIME-View mode of SEMI/tm. For operational
3583 procedures and key bindings, refer to respective documents.
3584 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3586 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3587 brings you back to Summary mode. @kbd{l} toggles display of Summary
3590 @section Key Bindings
3596 @findex wl-message-toggle-disp-summary
3597 Toggles display of Summary mode buffer.
3598 (@code{wl-message-toggle-disp-summary})
3601 @findex wl-message-refer-article-or-url
3602 @kindex Button-2 (Message)
3603 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3604 corresponding message if found.
3605 (@code{wl-message-refer-article-or-url})
3607 @item Button-4 (upward movement of a wheel)
3608 @kindex Button-4 (Message)
3609 @findex wl-message-wheel-down
3610 Scrolls the message backwards. When the top of the message is hit,
3611 moves to the previous message.
3612 (@code{wl-message-wheel-down})
3614 @item Button-5 (downward movement of a wheel)
3615 @kindex Button-5 (Message)
3616 @findex wl-message-wheel-up
3617 Scrolls the message forward. When the bottom of the message is hit,
3618 moves to the next message.
3619 (@code{wl-message-wheel-up})
3622 @section Customizable Variables
3625 @item wl-message-window-size
3626 @vindex wl-message-window-size
3627 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3628 its car and cdr value corresponds to the ratio of Summary and Message
3633 @node Draft, Disconnected Operations, Message, Top
3634 @chapter Draft Buffer
3636 At Summary mode, pressing @kbd{w} and the like creates a new draft
3637 buffer. You can edit and send mail and news articles in this buffer.
3641 Basically it is Emacs-standard mail mode.
3643 @subsection Address Completion
3645 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3646 addresses. @kbd{@key{TAB}} completes them.
3648 If you want to submit a news article, add @samp{Newsgroups:} field by
3649 yourself. Field names can be completed by @kbd{@key{TAB}}.
3651 If you save the draft buffer you are editing, it is appended to the
3652 folder specified by @code{wl-draft-folder}.
3654 Using @samp{FCC:} field, you can specify the folder to which a copy of
3655 the message is saved when it is sent.
3657 @subsection Editing Messages
3659 Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
3660 editing, refer to respective documents.
3661 @xref{MIME-Edit, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3663 @subsection Dynamic Modification of Messages
3664 @vindex wl-draft-config-alist
3665 @c @cindex Change Message
3666 @c @cindex Message, Change Dynamic
3668 You can set @code{wl-draft-config-alist} so that header and body of the
3669 message will automatically modified depending on information of header
3672 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3674 In the example below, the header is modified when
3675 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3676 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3677 before sending the message.
3681 (setq wl-draft-config-alist
3682 '(((string-match "aaa.ne.jp$" (system-name))
3683 ;; @r{applied if the expression is non-nil}
3684 (wl-smtp-posting-server . "mailserver-B")
3685 (wl-nntp-posting-server . "newsserver-B")
3686 ;; @r{settings of temporary variables}
3688 ("^To: .*user@@aaa.bbb.com"
3689 ;; @r{applied if it matches the header of the draft buffer}
3690 ("Organization" . (format "Go %s" my-webpage)))
3691 ;; @r{you can write elisp expressions here (eval only)}
3692 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3693 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3698 The format of @code{wl-draft-config-alist} is:
3702 '(("@var{regexp of the header}" or elisp expression
3703 ("@var{Field}" . value(elisp expression))
3704 (@var{variable} . value(elisp expression))
3705 (@var{sub-function} . value(elisp expression))
3708 ("@var{regexp of the header}" or elisp expression
3709 ("@var{Field}" . value(elisp expression))
3714 Per default, there are 10 following sub-functions.
3717 'header: Inserts the specified string at the bottom of the header.
3718 'header-file: Inserts the specified file at the bottom of the header.
3719 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3720 'top: Inserts the specified string at the top of the body.
3721 'top-file: Inserts the specified file at the top of the body.
3722 'body: Replaces the body with the specified string.
3723 Specifying nil deletes the entire body string.
3724 'body-file: Replaces the body with the content of the specified file.
3725 'bottom: Inserts the specified string at the bottom of the body.
3726 'bottom-file: Inserts the specified file at the top of the body.
3727 'template: Applies the specified template.
3728 (refer to the next subsection)
3731 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3732 change them or add your own functions. If you read the code, you can
3733 easily find how to write the functions.
3735 At the first of each item, @var{a regular expression of the header} or
3736 an elisp expression should be specified. In the case of an elisp
3737 expression, the item is applied when the expression is evaluated
3740 Per default, when multiple items match or are evaluated non-nil, all
3741 such items are applied, but if you set a variable
3742 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3745 At the second of the item, a cons or a list of functions should be
3746 specified. The car part of the cons should be a header field, a
3747 variable, or a sub-function. When a header field is specified, the
3748 field will be modified. If a variable is specified, the value of the
3749 variable will be modified temporarily.
3751 In the cdr part of a cons, not only a variable but also an elisp
3752 expression can be specified as is. If the car part is a header field
3753 and the cdr part is @code{nil}, the field will be deleted.
3755 See the next example as well:
3759 (setq wl-draft-config-alist
3761 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3762 ;; @r{applied if it matches the header of the buffer being replied}
3763 (body . " Hello.\n")
3764 (template . "default")
3769 As in the (1) above, if a header regexp is prepended with @code{reply},
3770 it is applied when the draft is prepared by @code{wl-summary-reply} for
3771 example, and when it matches the header being replied. It is ignored
3772 when there is no buffer being replied, like after @code{wl-draft} was
3775 Note that @code{wl-draft-config-alist} is applied only once when
3776 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3777 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3778 aborting transmission, execute @kbd{C-c C-e}
3779 (@code{wl-draft-config-exec}).
3781 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3782 prepared, do the following:
3785 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3788 @subsection Inserting Templates
3790 @cindex Apply Template
3792 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3793 @kbd{M-x wl-template-select} in the draft buffer.
3795 The format of @code{wl-template-alist} is almost the same as
3796 @code{wl-draft-config-alist}.
3800 (setq wl-template-alist
3803 ("Organization" . "~/.wl sample")
3804 (body . "Hello.\n"))
3806 (template . "default") ;; @r{(a)}
3807 ("To" . "jousi@@kaisha.jp")
3808 ("Subject" . "Report")
3809 (body-file . "~/work/report.txt")
3815 As you can see, the only difference is item (template) names such as
3816 @samp{default} and @samp{report}, instead of a regexp of header.
3817 Because definition of each item is the same as
3818 @code{wl-draft-config-alist}, you can call another template, like (a).
3820 Executing the command @code{wl-template-select} results in template
3821 selection, but the result differs depending on variable
3822 @code{wl-template-visible-select}.
3824 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3825 window is shown below the draft buffer. You can select a template by
3826 @kbd{n} and @kbd{p} seeing the buffer window.
3828 Press the @key{RET} key and the template is actually applied to the draft
3829 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3830 adjust the window size by @code{wl-template-buffer-lines}.
3832 If @code{wl-template-visible-select} is @code{nil}, you should type the
3833 name of the template in the mini buffer.
3835 As shown in the example in @code{wl-draft-config-alist}, you can select
3836 @samp{default} template by writing:
3839 (template . "default")
3842 @subsection Sending mail by POP-before-SMTP
3843 @cindex POP-before-SMTP
3845 You can send mail by POP-before-SMTP with this single line:
3848 (setq wl-draft-send-mail-func 'wl-draft-send-mail-with-pop-before-smtp)
3852 Configure the following variables if you need.
3855 @item wl-pop-before-smtp-user
3856 The POP user name for POP-before-SMTP authentication.
3857 If unset, @code{elmo-default-pop3-user} is used.
3859 @item wl-pop-before-smtp-server
3860 The POP server name for POP-before-SMTP authentication.
3861 If unset, @code{elmo-default-pop3-server} is used.
3863 @item wl-pop-before-smtp-authenticate-type
3864 The POP authentication method for POP-before-SMTP authentication.
3865 If unset, @code{elmo-default-pop3-authenticate-type} is used.
3867 @item wl-pop-before-smtp-port
3868 The POP port number for POP-before-SMTP authentication.
3869 If unset, @code{elmo-default-pop3-port} is used.
3871 @item wl-pop-before-smtp-ssl
3872 If non-nil, POP connection is established using SSL. If
3873 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
3874 unset, @code{elmo-default-pop3-ssl} is used.
3877 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
3878 unset, settings for POP folders (@code{elmo-default-pop3-*}) are
3880 Therefore, if SMTP server and POP server are actually the same, and if
3881 POP folder per default (such as @samp{&}) is available, no settings are
3884 Refer to the following URL about POP-before-SMTP.
3888 http://spam.ayamura.org/tools/smPbS.html
3889 http://www.iecc.com/pop-before-smtp.html
3893 @section Key Bindings
3894 @cindex Keybind, Draft Mode
3895 @cindex Keybind, Draft Buffer
3900 @kindex C-c C-y (Draft)
3901 @findex wl-draft-yank-original
3902 Cites the content of the current message buffer.
3903 (@code{wl-draft-yank-original})
3906 @kindex C-c C-p (Draft)
3907 @findex wl-draft-preview-message
3908 Previews the content of the current draft.
3909 This is useful for previewing MIME multi-part messages.
3910 (@code{wl-draft-preview-message})
3913 @kindex C-c C-s (Draft)
3914 @findex wl-draft-send
3915 Sends the content of the current draft. Does not erase the draft buffer.
3916 This is useful for sending multiple messages, which are a little different
3918 (@code{wl-draft-send})
3921 @kindex C-c C-c (Draft)
3922 @findex wl-draft-send-and-exit
3923 Sends the content of the current draft and erases the draft buffer.
3924 (@code{wl-draft-send-and-exit})
3927 @kindex C-x C-s (Draft)
3928 @findex wl-draft-save
3929 Save the current draft.
3930 (@code{wl-draft-save})
3933 @kindex C-c C-k (Draft)
3934 @findex wl-draft-kill
3935 Kills the current draft.
3936 (@code{wl-draft-kill})
3939 @kindex C-x k (Draft)
3940 @findex wl-draft-mimic-kill-buffer
3941 Kills the current draft.
3942 (@code{wl-draft-mimic-kill-buffer})
3945 @kindex C-c C-z (Draft)
3946 @findex wl-draft-save-and-exit
3947 Saves the current draft, and erases the draft buffer.
3948 This is useful if you want to suspend editing of the draft.
3949 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
3950 the @samp{+draft} folder.
3951 (@code{wl-draft-save-and-exit})
3954 @kindex C-c C-r (Draft)
3955 @findex wl-caesar-region
3956 Encodes or decodes the specified region in Caesar cipher.
3957 (@code{wl-caesar-region})
3961 @findex wl-toggle-plugged
3962 Toggles off-line/on-line states of Wanderlust.
3963 (@code{wl-toggle-plugged})
3966 @kindex C-c C-o (Draft)
3967 @findex wl-jump-to-draft-buffer
3968 Jumps to the other draft buffer, if exists.
3969 With prefix argument, reads a file (if any) from the draft folder when
3970 there is no such buffer.
3971 (@code{wl-jump-to-draft-buffer})
3974 @kindex C-c C-e (Draft)
3975 @findex wl-draft-config-exec
3976 Applies @code{wl-draft-config-alist}.
3977 (@code{wl-draft-config-exec})
3980 @kindex C-c C-j (Draft)
3981 @findex wl-template-select
3983 (@code{wl-template-select})
3986 @kindex C-c C-a (Draft)
3987 @findex wl-draft-insert-x-face-field
3988 Inserts the content of a file @file{~/.xface} (the value of the variable
3989 @code{wl-x-face-file}) as an @samp{X-Face:} field in the draft buffer.
3991 There should be encoded X-Face strings as a content of a file @file{~/.xface}.
3992 (@code{wl-draft-insert-x-face-field})
3995 @section Customizable Variables
3998 @item wl-subscribed-mailing-list
3999 @vindex wl-subscribed-mailing-list
4000 The initial setting is @code{nil}. Mailing lists to which you
4001 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4002 field of a reply draft, removes your own address from
4003 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4004 contained in @samp{To:} or @samp{Cc:} field of a message to be
4005 automatically re-filed, the destination folder will be leaned in
4006 connection with the address.
4008 @item wl-insert-mail-followup-to
4009 @vindex wl-insert-mail-followup-to
4010 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4011 field is automatically inserted in the draft buffer.
4013 @item wl-insert-mail-reply-to
4014 @vindex wl-insert-mail-reply-to
4015 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4016 field is automatically inserted in the draft buffer.
4018 @item wl-auto-insert-x-face
4019 @vindex wl-auto-insert-x-face
4020 The initial setting is @code{t}. If non-nil and there is an encoded
4021 X-Face string in a file @file{~/.xface} (the value of the variable
4022 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4023 draft buffer. If @code{nil}, it is not automatically inserted. Press
4024 @kbd{C-c C-a} to insert.
4026 @item wl-insert-message-id
4027 @vindex wl-insert-message-id
4028 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4029 is automatically inserted on the transmission.
4031 @item wl-local-domain
4032 @vindex wl-local-domain
4033 The initial setting is @code{nil}. If @code{nil}, the return value of
4034 the function @code{system-name} will be used as the domain part of
4037 If @code{system-name} does not return FQDN (i.e. the full name of the
4038 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4039 to the string of the local domain name without hostname (like
4040 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4041 @samp{.} @code{wl-local-domain} is used as domain part of the
4044 If your terminal does not have global IP, set the value of
4045 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4046 you use invalid @samp{Message-ID:}.)
4048 Moreover, concatenation of @code{system-name} @samp{.}
4049 @code{wl-local-domain} will be used as an argument to the HELO command
4052 @item wl-message-id-domain
4053 @vindex wl-message-id-domain
4054 The initial setting is @code{nil}. If non-nil, this value is used as a
4055 domain part of the @samp{Message-ID:}. If your terminal does not have
4056 global IP, set unique string to this value (e.x. your e-mail address).
4058 @item wl-message-id-domain
4059 @vindex wl-message-id-domain
4060 The initial setting is @code{nil}. If @code{nil}, the return value of
4061 the function @code{system-name} will be used as the domain part of
4062 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4063 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4064 @strong{must} set this variable to the string of the full name of the
4065 host. Otherwise, you might be beaten up on the Net News.
4067 @item wl-draft-config-alist
4068 @vindex wl-draft-config-alist
4069 The initial setting is @code{nil}. Modifies the draft message just
4070 before the transmission. The content of @code{wl-draft-config-alist}
4071 will be automatically applied only once on the transmission. If you
4072 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4075 @item wl-template-alist
4076 @vindex wl-template-alist
4077 The initial setting is @code{nil}.
4078 This variable specifies the template to be applied in the draft buffer.
4080 @item wl-draft-config-matchone
4081 @vindex wl-draft-config-matchone
4082 The initial setting is @code{nil}. If non-nil, only the first matching
4083 item is used when @code{wl-draft-config-alist} is applied. If
4084 @code{nil}, all matching items are used.
4086 @item wl-template-visible-select
4087 @vindex wl-template-visible-select
4088 The initial setting is @code{t}.
4089 If non-nil, you can preview the result of the template selection in
4092 @item wl-template-confirm
4093 @vindex wl-template-confirm
4094 The initial setting is @code{nil}.
4095 If non-nil, asks for confirmation when you press the enter key to select
4096 template while previewing.
4098 @item wl-template-buffer-lines
4099 @vindex wl-template-buffer-lines
4100 The initial setting is 7.
4101 If @code{wl-template-visible-select} is non-nil, this variable specifies
4102 the size of the preview window.
4104 @item wl-draft-reply-buffer-style
4105 @vindex wl-draft-reply-buffer-style
4106 The initial setting is @code{split}. @code{split} or @code{full} can be
4107 specified. In the case of @code{full}, the whole frame will be used for
4108 a reply draft buffer when it is prepared.
4110 @item wl-draft-use-frame
4111 @vindex wl-draft-use-frame
4112 The initial setting is @code{nil}.
4113 If non-nil, use new frame for the draft.
4117 The initial setting is the value of the variable
4118 @code{user-mail-address}. The value of this variable is inserted as a
4119 @samp{From:} field of the draft when it is prepared.
4121 @item wl-envelope-from
4122 @vindex wl-envelope-from
4123 The initial setting is @code{nil}.
4124 The value of this variable is used for envelope from (MAIL FROM).
4125 If @code{nil}, the address part of @code{wl-from} is used.
4127 @item wl-user-mail-address-list
4128 @vindex wl-user-mail-address-list
4129 The initial setting is @code{nil}.
4130 This is the User's address list. If you have multiple addresses,
4135 The initial setting is @code{nil}.
4136 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4137 the draft when it is prepared. If function is specified, its return
4142 The initial setting is @code{nil}.
4143 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4144 the draft when it is prepared.
4146 @item wl-reply-subject-prefix
4147 @vindex wl-reply-subject-prefix
4148 The initial setting is @samp{Re: }.
4149 In the @samp{Subject:} of the reply draft, this string is prepended to
4150 the @samp{Subject:} of being replied.
4152 @item wl-draft-reply-use-address-with-full-name
4153 @vindex wl-draft-reply-use-address-with-full-name
4154 The initial setting is @code{t}.
4155 If non-nil, insert her full name with address when prepare a draft for
4156 reply a message. If it is @code{nil}, insert her address only.
4158 @item wl-draft-enable-queuing
4159 @vindex wl-draft-enable-queuing
4160 The initial setting is @code{t}.
4161 This flag controls off-line transmission. If non-nil, the draft is
4164 @item wl-draft-use-cache
4165 @vindex wl-draft-use-cache
4166 The initial setting is @code{t}.
4167 If non-nil, cache the message which is sent.
4169 @item wl-auto-flush-queue
4170 @vindex wl-auto-flush-queue
4171 The initial setting is t.
4172 This flag controls automatic transmission of the queue when Wanderlust
4173 becomes on-line. If non-nil, the queue is automatically transmitted
4174 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4175 manually, press @kbd{F} in the folder mode.
4177 @item wl-draft-always-delete-myself
4178 @vindex wl-draft-always-delete-myself
4179 If non-nil, always removes your own address from @samp{To:} and
4180 @samp{Cc:} when you are replying to the mail addressed to you.
4182 @item wl-smtp-posting-server
4183 @vindex wl-smtp-posting-server
4184 The initial setting is @code{nil}.
4185 This is the SMTP server name for mail transmission.
4187 @item wl-smtp-posting-user
4188 @vindex wl-smtp-posting-user
4189 The initial setting is @code{nil}.
4190 This is the user name for SMTP AUTH authentication. If @code{nil},
4191 @code{smtp-authenticate-user} is used.
4193 @item wl-smtp-authenticate-type
4194 @vindex wl-smtp-authenticate-type
4195 The initial setting is @code{nil}.
4196 This is the authentication method for SMTP AUTH authentication. If
4197 @code{nil}, @code{smtp-authenticate-type} is used. If
4198 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4201 @item wl-smtp-connection-type
4202 @vindex wl-smtp-connection-type
4203 The initial setting is @code{nil}.
4204 This variable specifies how to establish SMTP connections.
4205 If @code{nil}, @code{smtp-connection-type} is used.
4206 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4208 @item wl-nntp-posting-server
4209 @vindex wl-nntp-posting-server
4210 The initial setting is @code{nil}.
4211 This is the NNTP server name used for news submission.
4212 If @code{nil}, @code{elmo-default-nntp-server} is used.
4214 @item wl-nntp-posting-user
4215 @vindex wl-nntp-posting-user
4216 The initial setting is @code{nil}.
4217 This is the user name for AUTHINFO authentication on news submission.
4218 If @code{nil}, @code{elmo-default-nntp-user} is used.
4219 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4221 @item wl-nntp-posting-port
4222 @vindex wl-nntp-posting-port
4223 The initial setting is @code{nil}.
4224 This is the port number of the NNTP server used for news submission.
4225 If @code{nil}, @code{elmo-default-nntp-server} is used.
4227 @item wl-nntp-posting-ssl
4228 @vindex wl-nntp-posting-ssl
4229 The initial setting is @code{nil}.
4230 If @code{nil}, @code{elmo-default-nntp-ssl} is evaluated. If non-nil,
4231 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4232 connection will be established.
4234 @item wl-pop-before-smtp-user
4235 @vindex wl-pop-before-smtp-user
4236 The initial setting is @code{nil}.
4237 This is the POP user name for POP-before-SMTP.
4238 If it is @code{nil}, @code{elmo-default-pop3-user} is used.
4240 @item wl-pop-before-smtp-server
4241 @vindex wl-pop-before-smtp-server
4242 The initial setting is @code{nil}.
4243 This is the POP server name for POP-before-SMTP.
4244 If it is @code{nil}, @code{elmo-default-pop3-server} is used.
4246 @item wl-pop-before-smtp-authenticate-type
4247 @vindex wl-pop-before-smtp-authenticate-type
4248 The initial setting is @code{nil}.
4249 This is the authentication method for POP-before-SMTP authentication.
4250 If it is @code{nil}, @code{elmo-default-pop3-authenticate} is used.
4252 @item wl-pop-before-smtp-port
4253 @vindex wl-pop-before-smtp-port
4254 The initial setting is @code{nil}.
4255 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4256 @code{elmo-default-pop3-port} is used.
4258 @item wl-pop-before-smtp-ssl
4259 @vindex wl-pop-before-smtp-ssl
4260 The initial setting is @code{nil}.
4261 This flag controls the use of SSL for POP-before-SMTP. If it is
4262 @code{nil}, @code{elmo-default-pop3-ssl} is used. If @code{starttls},
4263 STARTTLS (RFC2595) connection will be established.
4265 @item wl-draft-queue-save-variables
4266 @vindex wl-draft-queue-save-variables
4267 Specifies a list of variable to which queued messages are saved on the
4268 off-line transmission.
4270 @item wl-draft-sendlog
4271 @vindex wl-draft-sendlog
4272 The initial setting is @code{t}.
4273 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4277 @item drafts are sent by smtp or qmail
4278 @item saved into folders by fcc
4279 @item saved into folders by queuing
4282 (it is written even if the transmission fails).
4283 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4284 and left to the logging function of imput.
4287 @item wl-draft-sendlog-max-size
4288 @vindex wl-draft-sendlog-max-size
4289 The initial setting is 20000 (in bytes).
4290 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4291 beyond the size specified by this variable.
4295 The initial setting is @code{nil}.
4296 If non-nil, address completion uses LDAP.
4298 @item wl-ldap-server
4299 @vindex wl-ldap-server
4300 The initial setting is @samp{localhost}.
4301 LDAP server name for address completion.
4304 @vindex wl-ldap-port
4305 The initial setting is @code{nil}.
4306 If non-nil, the value is used as port number.
4309 @vindex wl-ldap-base
4310 The initial setting is @samp{c=US}.
4311 LDAP search starting point (base) for address completion.
4314 @node Disconnected Operations, Expire and Archive, Draft, Top
4315 @chapter Off-line Management
4316 @cindex Disconnected Operations
4318 Wanderlust has on-line and off-line states.
4321 * Off-line State:: Wanderlust has on-line and off-line states.
4322 * Enable Operations:: Enable Disconeected Oparations.
4323 * Plugged Mode:: Switching On-line/Off-line per Server/Port.
4324 * Off-line State settings:: Invoking Wanderlust in the Off-line State.
4325 * Variables of Plugged Mode:: Customize Plugged Mode.
4329 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4330 @section Off-line State
4332 Wanderlust has on-line and off-line states. In the off-line state, you
4333 cannot access messages via network, unless they are cached.
4335 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4336 in the mode line indicates the off-line state. In folder or summary
4337 modes, press @kbd{M-t} to switch between off- and on-line.
4339 You can invoke Wanderlust in the off-line state by setting
4340 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4342 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4343 ignores uncached messages.
4346 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4347 @section Enable Disconeected Oparations
4349 Even in the off-line state, provided that relevant messages are cached,
4350 and the variable @code{elmo-enable-disconnected-operation} (described
4351 later) is non-nil, you can following oparations:
4352 @xref{Plugged Mode}, @xref{Off-line State settings}.
4355 * Send Messages off-line:: Transmit Messages.
4356 * Re-file and Copy queue:: Re-file and Copy (IMAP4).
4357 * Creation of Folders:: Create Folders off-line (IMAP4).
4358 * Marking:: Mark (IMAP4).
4359 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP).
4362 As soon as Wanderlust becomes on-line, such operations invoked off-line
4363 are reflected in the servers via network.
4366 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4367 @subsection Transmission of Messages
4369 You can send mail/news messages off-line (if you are using
4370 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4371 accumulated in the queue folder, @samp{+queue}. These messages are
4372 transmitted at once when Wanderlust becomes on-line.
4374 You can visit @samp{+queue} in the off-line state and confirm content of
4375 messages in the queue. You can also remove messages. Removed messages
4376 are not transmitted even in the on-line state.
4379 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4380 @subsection Re-file and Copy (IMAP4)
4382 Re-file and copy operations to IMAP folders invoked during the off-line
4383 state are accumulated in the queue, and reflected in the server side
4384 when Wanderlust becomes on-line. If you visit destination folders after
4385 off-line re-file or copy, it looks as if messages were appended even in
4388 For the safety reasons, messages re-filed off-line are removed from
4389 source folders only if their @samp{Message-ID:} match messages on the
4390 servers. While the queue is processed, messages that failed to be
4391 re-filed or copied to the specified folders are appended to the folder
4395 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4396 @subsection Creation of Folders (IMAP4)
4398 You can create IMAP folders off-line. The creation of folders are
4399 reflected in the servers when Wanderlust becomes on-line. At that time,
4400 if folders failed to be created on the servers for any reasons, messages
4401 re-filed to such folders are appended to the folder @samp{+lost+found}.
4404 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4405 @subsection Marking (IMAP4)
4407 Off-line changes in unread/read and importance mark @samp{$} information
4408 are also reflected in the servers when Wanderlust becomes on-line.
4411 @node Pre-fetching Reservations, , Marking, Enable Operations
4412 @subsection Pre-fetching (IMAP4, NNTP)
4414 You can make reservations for pre-fetching messages in IMAP or NNTP
4415 folders. Reserved messages are marked with @samp{!} but not cached
4416 yet. When Wanderlust becomes on-line, they are pre-fetched from
4419 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4420 these off-line operations for IMAP4 and NNTP do not take place, and
4421 off-line re-file, copy or suchlike simply results in error.
4423 Because off-line operations use cache files, it is a bad idea to erase
4424 them by hand; it may cause Wanderlust to malfunction.
4426 If you want to remove caches, be sure to execute @kbd{M-x
4427 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4428 remove caches for messages relevant to off-line operations.
4431 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4432 @section Switching On-line/Off-line per Server/Port
4434 @kbd{M-t} described above switches networking states as a whole, but you
4435 can switch on-line/off-line per server/port.
4437 Pressing @kbd{C-t} in the folder or summary modes brings you in
4438 wl-plugged-mode shown below, in which you can change the plugged state
4443 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4446 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4447 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4449 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4450 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4456 The first line indicates status of the following three variables, and
4457 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
4458 column modifies the values of these variables.
4462 "Queuing" @code{wl-draft-enable-queuing}
4463 "AutoFlushQueue" @code{wl-auto-flush-queue}
4464 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4468 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4471 The second and after lines indicate on-line/off-line states of servers
4472 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4473 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4474 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4476 @dfn{sending queue} means messages accumulated in the folder
4477 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4478 off-line operations when @code{elmo-enable-disconnected-operation} is
4480 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4481 @c off-line operations are enabled.
4483 They are displayed if there are any of them. In the example above, in
4484 the sending queue there are two messages (the first and the second in
4485 the queue folder) for smtp to hosta and one (the third) for nntp to
4486 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4489 If you change @samp{(wl-plugged)} in the second line, the variable
4490 @code{wl-plugged} is changed, so that the mode line indicator and
4491 plugged states of all ports are affected. If you change plugged states
4492 of any servers or ports, @samp{(wl-plugged)} in the second line is
4493 affected depending on @code{elmo-plugged-condition} settings and the
4494 plugged state of each port.
4497 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4498 @section Invoking Wanderlust in the Off-line State
4500 As described before, if you set @code{wl-plugged} to @code{nil} in
4501 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4502 off-line state. You can specify off-line state on a per server or port
4503 basis. Refer to @code{wl-reset-plugged-alist} also.
4505 Usually, when Wanderlust starts up, the plugged state of each port is
4506 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4507 @code{wl-nntp-posting-server} and so on. If you want to change the
4508 plugged state of these ports or to add other ports, configure
4509 @code{wl-make-plugged-hook} with a function.
4513 (add-hook 'wl-make-plugged-hook
4515 (elmo-set-plugged plugged-value(t/nil) server port)
4516 ;; @r{add or change plugged states of the port of the server}
4517 (elmo-set-plugged plugged-value(t/nil) server)
4518 ;; @r{if the port is omitted, all ports are affected}
4519 ;; @r{(you cannot omit the port if you newly add the server)}
4525 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4526 @section Customizable Variables
4531 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4532 mode from the beginning.
4534 @item wl-queue-folder
4535 @vindex wl-queue-folder
4536 The initial setting is @samp{+queue}.
4537 This is the folder in which messages in the transmission queue are
4540 @item wl-auto-flush-queue
4541 @vindex wl-auto-flush-queue
4542 The initial setting is @code{t}.
4543 This flag controls automatic transmission of the queue when Wanderlust
4544 becomes on-line. If non-nil, the queue is automatically transmitted
4545 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4546 manually, press @kbd{F} in the folder mode.
4548 @item elmo-enable-disconnected-operation
4549 @vindex elmo-enable-disconnected-operation
4550 The initial setting is @code{nil}. Controls off-line operations
4551 regarding IMAP4. If non-nil, off-line operations are carried out.
4553 @item elmo-lost+found-folder
4554 @vindex elmo-lost+found-folder
4555 The initial setting is @samp{+lost+found}.
4556 This is the folder to which messages are saved when they fails to be
4557 appended while the off-line re-file/copy queue is processed.
4559 @item elmo-plugged-condition
4560 @vindex elmo-plugged-condition
4561 The initial setting is @code{one}.
4562 The value of @code{wl-plugged} reflects the return value of the function
4563 @code{elmo-plugged-p} (without arguments).
4564 This variable @code{elmo-plugged-condition} specifies the condition on
4565 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4566 plugged state of each port.
4569 'one : plugged if one or more ports are plugged.
4570 'all : plugged if all ports are plugged.
4571 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4572 states of the ports.
4573 @var{function} : reflects the return value of the @var{function}
4574 functions available per default
4575 'elmo-plug-on-by-servers
4576 : reflects the plugged state of the servers specified by the
4577 variable elmo-plug-on-servers.
4578 'elmo-plug-on-by-exclude-servers
4579 : reflects the plugged state of the servers that are not
4580 in elmo-plug-on-exclude-servers.
4581 elmo-plug-on-exclude-servers defaults to
4584 (system-name)without the domain part)
4590 (setq elmo-plugged-condition 'all)
4592 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4593 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4595 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4596 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4600 @item wl-reset-plugged-alist
4601 @vindex wl-reset-plugged-alist
4602 The initial setting is @code{t}. If non-nil, plugged states are
4603 initialized on a per server or port basis when Wanderlust starts up.
4605 If @code{nil}, plugged states are retained while Emacs is running. In
4606 other words, they are initialized when Emacs is restarted even if the
4607 value is @code{nil}.
4611 @node Expire and Archive, Scoring, Disconnected Operations, Top
4612 @chapter Automatic Expiration and Archiving of Messages
4613 @cindex Expire and Archive
4616 * Expire:: Expiration and Archiving
4617 * Archive:: Archiving All Messages
4621 @node Expire, Archive, Expire and Archive, Expire and Archive
4623 @cindex Expire Message
4625 Expiration means deletion of old messages which have outlasted a
4626 certain period of time.
4628 @code{wl-expire} supports not only simple deletion, but also moving to
4629 specified archiving folders.
4633 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4634 or @kbd{M-e} in the summary mode.
4636 @subsection Configuring @code{wl-expire-alist}
4638 An example configuration of @code{wl-expire-alist} is shown below.
4639 Everything in this @code{wl-expire-alist} makes a great difference in
4640 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4641 to @code{t}, especially in the initial stage.
4645 (setq wl-expire-alist
4646 '(("^\\+trash$" (date 14) remove)
4648 ("^\\+tmp$" (date 7) trash)
4649 ;; @r{re-file to @code{wl-trash-folder}}
4650 ("^\\+outbox$" (number 300) "$outbox;lha")
4651 ;; @r{re-file to the specific folder}
4653 ;; @r{do not expire}
4654 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4655 ;; @r{archive by message number (retaining numbers)}
4656 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4657 ;; @r{archive by a fixed number (retaining numbers)}
4658 ("^\\+diary$" (date 30) wl-expire-archive-date)
4659 ;; @r{archive by year and month (numbers discarded)}
4664 Items in the list has the format of:
4667 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4671 The folder is examined if it matches @var{regexp-for-folders} from the
4672 beginning of the list. If you invoke expiration on the folder that does
4673 not match any of them, nothing will happen. And if either the second or
4674 the third element of the item is @code{nil}, expiration will not take
4677 You can use any one of the following for
4678 @var{specification-of-message-to-be-deleted}:
4681 @item (number @var{n1} [@var{n2}])
4682 deletes messages depending on the number of messages in the folder.
4684 @var{n1} is the number of messages which should survive deletion, for example
4685 if its value is 500, the newest 500 messages survive and the rests are
4688 @var{n2} is the number of messages in the folder on which expiration should
4689 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4690 folders with 510 or more messages are expired.
4691 If you configured automatic expiration, frequently used folders may
4692 expire every time it receive messages, and you may be annoyed with the
4693 long delay in reading mail.
4694 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4695 expiration would not take place until a certain number of messages
4698 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4699 with important/new/unread) are not deleted.
4700 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4701 will expire so as to have 500 messages including such ones.
4702 Otherwise, it will have 500 messages except such ones.
4704 @item (date @var{d1})
4705 deletes messages depending on the dates.
4707 Messages dated @var{d1} or more days ago are deleted, for example if its
4708 value is seven, messages seven days old or more are deleted. Note that
4709 the date is the one in the @samp{Date:} field of the message, not when
4710 the message entered the folder.
4712 Messages with no or invalid @samp{Date:} field does not expire; you
4713 might have to delete them by hand.
4716 You can use any one of the following in the place of @var{destination}:
4720 deletes the messages instantly.
4723 moves the messages to @code{wl-trash-folder}.
4725 @item @var{string}(folder)
4726 moves the messages to the folder specified with @var{string}.
4728 It would be useful for specifying an archiving folder, but because this
4729 does not move important messages, it might be better to use the
4730 standard functions described below.
4732 @item @var{function}
4733 invokes the specified @var{function}.
4735 To the @var{function}, three arguments are passed: a folder name, a list
4736 of messages to be deleted, and msgdb information of the summary. You
4737 can specify function-specific arguments after the name of the
4738 @var{function}. Note that the list contains messages with marks in
4739 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4742 These are three standard functions; they moves messages to an archive
4743 folder in the specified way. This means old messages can be compressed
4744 and saved in a file, being deleted from the original folder.
4747 @item wl-expire-archive-number1
4748 re-files to archiving folders corresponding to the message numbers of
4749 the messages being deleted. For example, a message numbered 102 will be
4750 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4751 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4752 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4754 The archiving folders to which messages are re-filed are determined by
4755 the name of the folder as follows (in this case, archiving folders are
4756 handled as if @code{elmo-archive-treat-file} were non-nil).
4759 @item If the folder type is localdir:
4760 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4762 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4763 (@file{~/Mail/ml/wl-00100.zip}).
4765 @item The folder type is other than localdir:
4766 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4768 For example, @samp{%#mh/ml/wl} corresponds to
4769 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4772 As you can see, in the case of localdir, the folder type is not included
4773 in the path name, but otherwise it is included.
4774 And you can control the prefix to the archiving folder name by
4775 @code{wl-expire-archive-folder-prefix}.
4776 Refer to @code{wl-expire-archive-folder-prefix} for details.
4778 @item wl-expire-archive-number2
4779 re-files every certain number of messages to archiving folders.
4781 This differs from @samp{wl-expire-archive-number1} in that this re-files
4782 to the folder up to the specified number regardless of message numbers.
4783 The archiving folders to which messages are re-filed are determined in the
4784 same way as @code{wl-expire-archive-number1}.
4786 @item wl-expire-archive-date
4787 re-files messages depending on its date (year and month) to archive
4790 For example, a message dated December 1998 is re-filed to
4791 @code{$folder-199812;zip}. The name of the archiving folders except the
4792 date part are determined in the same way as
4793 @code{wl-expire-archive-number1}.
4796 You can set the first argument to these three standard functions to non-nil
4797 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4798 For example, it can be specified just after the name of the function:
4801 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4804 If you omit the argument, consecutive numbers from 1 are assigned for
4805 each archiving folder.
4808 @subsection Treatment for Important or Unread Messages
4810 If you specify any of @code{remove}, @code{trash}, a folder name, or a
4811 standard function, messages with marks in
4812 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
4813 messages} thereafter) are retained.
4815 Per default, this variable include the important, new, and unread marks,
4816 so that messages with these marks are not removed.
4817 Note that you cannot include the temporary mark (i.e. temporary marks
4818 are removed anyway), and be sure to process temporary marks before you
4821 @subsection Auto Expiration
4823 The following setup invokes expiration when you move into the summary
4824 mode. There will be no confirmation, so make sure you made no mistake
4825 in regexp and other settings before you set up this.
4829 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4833 In the folder mode, you can invoke expiration per group as well as per
4834 folder. Therefore, if you specify @samp{Desktop} group, all folders
4835 matching @code{wl-expire-alist} expire.
4839 @subsection Treating archive folders.
4840 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
4841 you must set non-nil value to @code{elmo-archive-treat-file}.
4843 @subsection Confirming
4845 If you are to use @code{remove}, try @code{trash} at first and see
4846 messages move to @code{wl-trash-folder} as expected, then replace it
4847 with @code{remove}. It would be dangerous to use @code{remove} from the
4850 If you are to use @code{wl-expire-archive-number1} and the like, try to
4851 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
4852 you can append messages to it. Even if settings in
4853 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
4854 would not be saved anywhere and disappeared in case the archiver program
4857 After you make sure you can archive to the folder correctly, you can
4858 invoke expiration and utilize the log.
4860 If you set @code{wl-expire-use-log} to @code{t},
4861 @file{~/.elmo/expired-log} should contain the log, for example:
4865 delete +ml/wl (593 594 595 596 597 598 599)
4866 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
4870 The first column indicates the operation, i.e. @samp{delete},
4871 @samp{copy}, or @samp{move}. The next is the name of the folder that
4872 expired. In the case of @samp{copy} and @samp{move}, the destination
4873 folder is recorded after @samp{->}. The last is the list of message
4874 numbers that are actually deleted or moved (in the case of @samp{copy}
4875 and @samp{move}, the number is the one in the source folder, rather than
4876 the destination folder).
4878 @subsection Re-filing Reserved Messages
4880 The three standard functions copy reserved messages to the archive
4881 folder, but do not delete them from the source folder. Because
4882 reserved messages and the like always remain, they are recorded in
4883 @file{~/.elmo/expired-alist} so that they are not copied over and over
4884 again. They are not recorded if copied by @code{wl-summary-archive}.
4886 If you enabled logging, usually @samp{move} is recorded for re-filing,
4887 but instead @samp{copy} and @samp{delete} are recorded separately if
4888 reserved messages are involved. This is because it actually copies
4889 messages including reserved, then deletes ones except reserved in that
4892 @section Customizable Variables
4895 @item wl-expire-alist
4896 @vindex wl-expire-alist
4897 The initial setting is @code{nil}.
4898 This variable specifies folders and methods to expire. For details,
4899 refer to @code{wl-expire-alist} settings above.
4901 @item wl-summary-expire-reserve-marks
4902 @vindex wl-summary-expire-reserve-marks
4903 The initial setting is the list below.
4907 (list wl-summary-important-mark
4909 wl-summary-unread-mark
4910 wl-summary-unread-uncached-mark
4911 wl-summary-unread-cached-mark)
4915 Messages with these marks are retained in the folder, even after
4917 Only permanent marks can be listed, not temporary marks.
4919 You can list marks one by one as in the default; you can use the
4920 following settings as well:
4924 All messages with permanent marks are retained,
4925 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
4929 All messages are handled as usual ones that are already read, no matter
4930 what marks they have; even important messages are deleted.
4933 @item wl-expire-archive-files
4934 @vindex wl-expire-archive-files
4935 The initial setting is 100.
4936 This variable specifies the number of messages to be retained in one
4939 @item wl-expire-number-with-reserve-marks
4940 @vindex wl-expire-number-with-reserve-marks
4941 The initial setting is @code{nil}.
4942 If non-nil, if expiring messages are specified by @code{number},
4943 messages with @code{wl-summary-expire-reserve-marks} are also retained.
4945 @item wl-expire-archive-get-folder-func
4946 @vindex wl-expire-archive-get-folder-func
4947 The initial setting is @code{wl-expire-archive-get-folder}.
4949 This variable specifies a function that returns the name of an archiving
4950 folder for standard functions in the place of @var{destination}.
4951 You can use the following three variables for simple modification of
4952 folder names; if you want more complex settings, define your own
4953 function in this variable.
4955 @code{wl-expire-archive-get-folder} can be customized by these
4958 @item @code{wl-expire-archive-folder-name-fmt}
4959 @item @code{wl-expire-archive-folder-type}
4960 @item @code{wl-expire-archive-folder-prefix}
4963 @item wl-expire-archive-folder-name-fmt
4964 @vindex wl-expire-archive-folder-name-fmt
4965 The initial setting is @samp{%s-%%05d;%s}.
4966 This is a @code{format} string for archiving folders used in
4967 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
4968 Note that you must specify the message number by @samp{%%d}, because it
4969 is parsed twice by @code{format}.
4971 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
4974 @item wl-expire-archive-date-folder-name-fmt
4975 @vindex wl-expire-archive-date-folder-name-fmt
4976 The initial setting is @samp{%s-%%04d%%02d;%s}.
4977 This is a @code{format} string for archiving folders used in
4978 @code{wl-expire-archive-date}. Note that you must specify the message
4979 number by @samp{%%d}, because it is parsed twice by @code{format}.
4980 There should be @samp{%%d} twice, one for the year and the other for the
4983 If you modify this, adjust
4984 @code{wl-expire-archive-date-folder-num-regexp} as well.
4986 @item wl-expire-archive-folder-type
4987 @vindex wl-expire-archive-folder-type
4988 The initial setting is @code{zip}.
4989 This variable specifies an archiver type of the archiving folders.
4991 @item wl-expire-archive-folder-prefix
4992 @vindex wl-expire-archive-folder-prefix
4993 The initial setting is @code{nil}.
4994 This variable specifies the prefix (directory structure) to archiving
4996 Exercise extreme caution in using this feature, as it has not been
4998 In the worst case, there is a fear of destructing archiving folders.
5002 There will be no prefix.
5005 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5006 @samp{$ml/wl-00000;zip;wl}.
5009 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5012 @samp{$ml/wl-00000;zip;ml/wl}.
5015 @item wl-expire-archive-folder-num-regexp
5016 @vindex wl-expire-archive-folder-num-regexp
5017 The initial setting is @samp{-\\([-0-9]+\\);}.
5018 This variable specifies the regular expression to be used for getting
5019 message numbers from multiple archiving folders specified by
5020 @code{elmo-list-folders}.
5021 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5023 @item wl-expire-archive-date-folder-num-regexp
5024 @vindex wl-expire-archive-date-folder-num-regexp
5025 The initial setting is @samp{-\\([-0-9]+\\);}.
5026 This is the regular expression to be used for getting message numbers
5027 from multiple archiving folders specified by @code{elmo-list-folders}.
5028 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5030 @item wl-expire-delete-oldmsg-confirm
5031 @vindex wl-expire-delete-oldmsg-confirm
5032 The initial setting is @code{t}.
5033 If non-nil, messages older than the one with the largest number will be
5034 deleted with confirmation.
5035 If @code{nil}, they are deleted without confirmation.
5037 This feature is valid only if non-nil is specified as a argument to the
5038 standard functions so as to retain numbers.
5040 @item wl-expire-use-log
5041 @vindex wl-expire-use-log
5042 The initial setting is @code{nil}.
5043 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5044 They are appended but not truncated or rotated automatically; you might
5045 need to remove it manually.
5047 @item wl-expire-add-seen-list
5048 @vindex wl-expire-add-seen-list
5049 The initial setting is @code{t}.
5051 If non-nil, when messages are re-filed by expiration, read/unread
5052 information is passed to the destination folder.
5054 However if you do not read the destination folder from Wanderlust,
5055 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5056 want to set this to @code{nil} if you are simply saving to some
5057 archiving folders. Even if its value is @code{nil}, messages in the
5058 archiving folders are simply treated as unread; it does not affect
5061 @item wl-expire-folder-update-msgdb
5062 @vindex wl-expire-folder-update-msgdb
5063 The initial setting is @code{t}.
5064 If @code{t}, in the folder mode, expiration is carried out after
5065 updating summary information. If you specified a list of regular
5066 expressions of folder names, summary information is updated for matching
5071 @node Archive, , Expire, Expire and Archive
5072 @section Archiving Messages
5074 @subsection Archiving Messages
5075 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5076 folders. If there are the archiving folders already, only new messages
5079 You can use @code{wl-archive-alist} in order to specify how messages are
5080 archived according to their folder names, as in @code{wl-expire-alist}.
5085 (setq wl-archive-alist
5086 '(("^\\+tmp$" wl-archive-date)
5087 ("^\\+outbox$" wl-archive-number2)
5088 (".*" wl-archive-number1)))
5092 Each item in the list has the following format:
5095 (@var{folders-regexp} @var{deleting-function})
5098 As you can see, you can only use a function after @var{folders-regexp}.
5099 Per default, there are three functions:
5102 @item @code{wl-archive-number1}
5103 @item @code{wl-archive-number2}
5104 @item @code{wl-archive-date}
5107 As inferred from their names, they work similarly to "expire" versions,
5108 other than the following points:
5111 @item No messages are deleted
5112 @item Message numbers are retained even if invoked without arguments
5115 These functions are good to archive all messages in a folder by their
5116 numbers or by their dates.
5117 These are also useful for backup or confirmation purposes before
5119 If you try to re-file them after they are archived, they are deleted but
5122 Per default, the archiving folders to which messages are copied are
5123 determined automatically by @code{wl-expire-archive-get-folder-func}.
5124 You can copy to a specific folder by invoking with a prefix argument,
5125 i.e. @kbd{C-u M-x wl-summary-archive}.
5127 Note that this feature has not been seriously tested, because you can
5128 simply copy to an archiving folder, for example by
5129 @code{wl-summary-copy-region}.
5131 The archiving folders are determined by the same logic as in
5132 @code{wl-summary-expire}; the following customizable variables are
5136 @item @code{wl-expire-archive-files}
5137 @item @code{wl-expire-archive-get-folder-func}
5138 @item @code{wl-expire-archive-folder-name-fmt}
5139 @item @code{wl-expire-archive-folder-type}
5140 @item @code{wl-expire-archive-folder-prefix}
5141 @item @code{wl-expire-archive-folder-num-regexp}
5144 @subsection Customizable Variables
5147 @item wl-archive-alist
5148 @vindex wl-archive-alist
5149 The initial setting is the list shown below:
5153 ((".*" wl-archive-number1))
5158 This variable specifies a function that copies to archiving folders.
5159 To the function, three arguments are passed: a folder name, a list of
5160 messages in the folder, and msgdb information of the summary.
5161 Needless to say, you can use your own function.
5165 @node Scoring, Customization, Expire and Archive, Top
5166 @chapter Score of the Messages
5168 @c @cindex Kill File
5170 Scoring is the function that associates a score (value) with each
5171 message, and marks as read or deletes from the summary according to it.
5173 You can put target or important marks on essential messages, or read marks
5174 on the ones you do not want to read, for example spam articles.
5176 This scoring function has a capability and a format similar to the one
5177 that Gnus has, although there are some unsupported features and
5178 Wanderlust specifics.
5179 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5182 * Score Commands:: Score Commands
5183 * Score File Format:: Score File Format
5187 @node Score Commands, Score File Format, Scoring, Scoring
5188 @section Score Commands
5189 @cindex Score Commands
5191 @subsection Score File Specification
5193 @code{wl-score-folder-alist} specifies score files or variables in which
5194 scores are defined, corresponding to folder names.
5198 (setq wl-score-folder-alist
5207 If paths to the score files are omitted, the directory specified in the
5208 variable @code{wl-score-files-dir} is assumed.
5210 No matter what you write in @code{wl-score-folder-alist}, the default
5211 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5212 read (it does not have to exist).
5213 Therefore, in the example above, the three score files,
5214 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5215 the folders that matches @samp{^-.*}.
5217 @subsection Scored Messages
5219 Scores are attached to the messages that are specified by
5220 @code{wl-summary-score-marks} temporarily when the summary is updated;
5221 when you exit from the summary, the scores are removed and reverts to
5224 @subsection Creation of Score Files
5226 In the summary buffer, move to an appropriate message and type @kbd{L}.
5227 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5228 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5230 This makes @minus{}1000 are scored for messages with the same
5231 @samp{Subject:} as the string you entered. That is, such a score file
5232 is created automatically.
5234 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5235 The score file you just made appears.
5236 This buffer is called @dfn{score editing buffer} thereafter.
5237 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5238 as you are previously; type @kbd{a}. Then a score entry for "From"
5240 In this way, you can create a score file easily either in the summary
5241 buffer or in the score editing buffer.
5243 By the way, you might be aware the numbers of key strokes are different
5244 between @kbd{s s p} and @kbd{a}.
5245 This is determined by @code{wl-score-header-default-entry}.
5246 This variable specifies the default score entries corresponding to
5248 For example, for "subject" field, a type and a time limit are prompted,
5249 but for "from" field, they are fixed upon automatically as substring and
5250 permanent respectively.
5251 However, score values can be modified by the prefix argument.
5252 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5255 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5256 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5257 erasing contents of the buffer deletes the score file being edited.
5261 @subsubsection Selecting Score Files
5263 You can change score files to which scores are appended by
5264 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5265 @code{wl-score-change-score-file}.
5267 @subsubsection Summing Up the Score
5269 If you add the same entries by @code{wl-summary-increase-score},
5270 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5271 scores for the entry is summed up.
5273 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5274 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5275 @minus{}1200 will be created as a result.
5277 @subsubsection Creating Thread Key
5279 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5280 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5282 @subsubsection Creating Followup Key
5284 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5285 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5286 at the cursor to @samp{References} key.
5287 If @code{wl-score-auto-make-followup-entry} is non-nil,
5288 @samp{Message-ID} of all messages to be followed up within dates
5289 specified by @code{wl-score-expiry-days}.
5291 @subsection Key Bindings
5296 @findex wl-summary-increase-score
5297 Increases the score for the current message.
5298 And the score entry is appended to the score file at the same moment.
5299 You can specify the score value by a prefix argument.
5303 @findex wl-summary-lower-score
5304 Decreases the score for the current message.
5305 And the score entry is appended to the score file at the same moment.
5306 You can specify the score value by a prefix argument.
5309 @kindex h R (Summary)
5310 @findex wl-summary-rescore
5311 Re-applies the scoring.
5312 However, already scored messages are not scored anew.
5315 @kindex h c (Summary)
5316 @findex wl-score-change-score-file
5317 Changes the score file currently selected.
5320 @kindex h e (Summary)
5321 @findex wl-score-edit-current-scores
5322 Edits the score file currently selected.
5323 If there are multiple score files, the previously specified one is
5327 @kindex h f (Summary)
5328 @findex wl-score-edit-file
5329 Edits an arbitrary score file and selects it.
5332 @kindex h F (Summary)
5333 @findex wl-score-flush-cache
5334 Erases caches associated to the score files that are read.
5335 If you modified score files directly (from other than Wanderlust), you
5336 need to re-read them after erasing the cache.
5339 @kindex h m (Summary)
5340 @findex wl-score-set-mark-below
5341 Specifies the criterion for scores to be marked as read.
5342 Messages with scores less than this value are marked as read.
5345 @kindex h x (Summary)
5346 @findex wl-score-set-expunge-below
5347 Specifies the criterion for scores to be deleted from the summary.
5348 Messages with scores less than this value are deleted.
5349 "Deleted" means it is not shown; they are not removed from the summary
5350 information or the folder.
5351 The deleted messages can be shown by rescan-noscore again.
5354 @subsection Key Bindings in the Score Editing Buffer
5358 @kindex C-c C-k (Score Mode)
5359 @findex wl-score-edit-kill
5360 Abandons the file being edited.
5363 @kindex C-c C-c (Score Mode)
5364 @findex wl-score-edit-exit
5365 Saves the file being edited, and quits from the edit mode.
5368 @kindex C-c C-p (Score Mode)
5369 @findex wl-score-pretty-print
5373 @kindex C-c C-d (Score Mode)
5374 @findex wl-score-edit-insert-date
5375 Inserts the number of dates from Dec. 31, 1 B.C.
5376 It is used for creating the third factor of time-limited scores.
5379 @kindex C-c C-s (Score Mode)
5380 @findex wl-score-edit-insert-header
5381 Inserts the header of the message selected in the summary buffer.
5384 @kindex C-c C-e (Score Mode)
5385 @findex wl-score-edit-insert-entry
5386 Inserts the score entry of the message selected in the summary buffer.
5389 @subsection Customizable Variables
5392 @item wl-summary-default-score
5393 @vindex wl-summary-default-score
5394 The initial setting is 0 (zero).
5395 This variable specifies the default value of the score.
5396 The score is increased or decreased based upon this value.
5398 @item wl-summary-important-above
5399 @vindex wl-summary-important-above
5400 The initial setting is @code{nil}.
5401 Messages with scores larger than this value are attached with the
5402 important mark (@samp{$}).
5403 If @code{nil}, no important marks are attached.
5405 @item wl-summary-target-above
5406 @vindex wl-summary-target-above
5407 The initial setting is @code{nil}.
5408 Messages with scores larger than this value are attached with the target
5410 If @code{nil}, no target marks are attached.
5412 @item wl-summary-mark-below
5413 @vindex wl-summary-mark-below
5414 The initial setting is 0 (zero).
5415 Messages with scores smaller than this value are marked as read.
5417 @item wl-summary-expunge-below
5418 @vindex wl-summary-expunge-below
5419 The initial setting is @code{nil}.
5420 Messages with scores smaller than this value are deleted from the
5422 If @code{nil}, they are not deleted.
5424 @item wl-summary-score-marks
5425 @vindex wl-summary-score-marks
5426 The initial setting is the list shown below:
5430 (list wl-summary-new-mark)
5435 Messages with these marks are scored.
5437 @item wl-use-scoring
5438 @vindex wl-use-scoring
5439 The initial setting is t.
5440 If non-nil, scoring is enabled.
5442 @item wl-score-files-dir
5443 @vindex wl-score-files-dir
5444 The initial setting is @file{~/.elmo/}.
5445 The default directory for score files.
5447 @item wl-score-interactive-default-score
5448 @vindex wl-score-interactive-default-score
5449 The initial setting is 1000.
5450 This value is used as a score when a score factor is @code{nil} in the
5451 score file. It is also used in @code{wl-summary-increase-score} and
5452 @code{wl-summary-lower-score}, on condition that the value of
5453 @code{wl-score-header-default-entry} is @code{nil}.
5455 @item wl-score-expiry-days
5456 @vindex wl-score-expiry-days
5457 The initial setting is 7.
5458 This is the number of days before time-limited scores are deleted.
5460 @item wl-score-update-entry-dates
5461 @vindex wl-score-update-entry-dates
5462 The initial setting is @code{t}.
5463 If non-nil, it enables deletion of time-limited scores.
5465 @item wl-score-header-default-entry
5466 @vindex wl-score-header-default-entry
5467 Specifies the default value for each header field for score entries
5468 created by @code{wl-summary-increase-score},
5469 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5471 @item wl-score-simplify-fuzzy-regexp
5472 @vindex wl-score-simplify-fuzzy-regexp
5473 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5474 regular expression to be deleted from the string.
5475 Because this is usually used for Subject, the default is prefixes that
5476 are attached by mailing list programs.
5478 @item wl-summary-rescore-partial-threshold
5479 @vindex wl-summary-rescore-partial-threshold
5480 The initial setting is 200.
5481 When sync-all or rescan is executed, if there are messages more than
5482 this value, only the last same number of messages as this value are
5485 @item wl-summary-auto-sync-marks
5486 @vindex wl-summary-auto-sync-marks
5487 If non-nil, unread/important marks are synchronized when the summary
5489 Unread marks reflect information on the IMAP4 server.
5490 Important marks reflect information on the IMAP4 server (flagged or
5491 not), and contents of @samp{'mark} folder.
5492 The initial setting is @code{t}.
5496 @node Score File Format, , Score Commands, Scoring
5497 @section Score File Format
5498 @cindex Score File Format
5500 The format of score files are the same as Gnus, and basically you can
5501 use Gnus score files as they are. But they are not fully compatible
5502 because some keys are not supported and there are Wanderlust specifics.
5503 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5508 ("for sale" -1000 nil s)
5509 ("profit" -1000 nil s))
5511 ("spam@@spamspamspam" -10000 nil s))
5513 ("my@@address" 3001 nil s))
5515 (1000000 -10 nil >))
5525 If the key is a string, it is the name of the header to be matched.
5526 The following keys are available:
5527 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5528 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5529 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5530 @code{Chars} and @code{Lines} mean the size and the number of lines of
5531 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5532 are described later.
5533 The rest corresponds the field of the same name.
5535 Arbitrary numbers of core entries are specified after the key.
5536 Each score entry consists of these five factors:
5540 A factor that matches header. This should be a number in the cases of
5541 @code{lines} and @code{chars}, otherwise a string.
5544 A score factor. When the first item matches, the score of the message
5545 is increased or decreased by this value.
5548 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5549 of a number, the score is deleted if it does not match for days
5550 (@code{wl-score-expiry-days}) from the date specified by this.
5551 The date is since Dec. 31, 1 B.C.
5554 A type factor. This specifies the way the first factor matches.
5555 Available types depend on keys.
5558 @item From, Subject, References, Message-ID
5559 For these keys in string, @code{r} and @code{R} (regexp),
5560 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5561 as well as @code{f} and @code{F} (fuzzy) can be used.
5562 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5565 For these keys, the following five numerical relative operators can be
5566 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5569 This key matches @code{From} header, and scores all follow-ups to the
5571 For example, it would be useful for increasing scores for follow-ups to
5574 You can use the same types as @code{From} except for @code{f}.
5575 And a @samp{Followup} entry is automatically appended to the score file.
5578 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5579 A @samp{Thread} entry is automatically appended for each article that
5580 has @var{x} in the @code{References} header.
5581 You can make sure the whole thread including messages that does not have
5582 all ancestors @code{Message-ID} in @code{References} is scored.
5584 You can use the same types as @code{References} except for @code{f}.
5585 And a @samp{Thread} entry is automatically appended to the score file.
5589 A factor for extension header. This is meaningful only if the key is
5591 This specifies headers to be matched other than standard headers like
5592 @code{Subject} and @code{From}.
5593 Note that you should specify the header in
5594 @code{elmo-msgdb-extra-fields} also.
5595 Therefore it does not work in folders where extension headers cannot be
5600 The sum of these scores @emph{after all factors are applied} becomes the
5601 score of the message.
5603 @cindex Score File Atoms
5605 Messages with a score less than this value is marked as read.
5606 The default is @code{wl-summary-mark-below}.
5609 Messages with a score less than this value is deleted from the summary.
5610 The default is @code{wl-summary-expunge-below}.
5612 @item mark-and-expunge
5613 Both @code{mark} and @code{expunge} are applied,
5614 i.e. messages with a score less than this value is marked as read and
5615 deleted from the summary.
5618 Messages with a score greater than this value is attached with temp
5620 The default is @code{wl-summary-target-above}.
5623 Messages with a score greater than this value is attached with important
5625 The default is @code{wl-summary-important-above}.
5630 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5631 are used, you need to set @code{elmo-msgdb-extra-fields}.
5634 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5637 There are other restrictions as shown below:
5640 @item Because @samp{References} field in the summary information
5641 contains only the last @samp{Message-ID}, @code{references} key matches
5645 Keys that can be seen by folder of types:
5649 chars lines xref extra
5650 localdir,localnews Y E E E
5651 nntp (supporting xover) Y E E N
5657 N: cannot be seen (ignored)
5658 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5663 @node Customization, Mailing List, Scoring, Top
5664 @chapter Customizing Wanderlust
5665 @cindex Customization
5668 * Living with other packages:: Living with other packages
5669 * Highlights:: Highlights
5670 * Biff:: Notify Mail arrival
5671 * Advanced Settings:: Advanced Settings
5672 * Customizable Variables:: Customizable Variables
5677 @node Living with other packages, Highlights, Customization, Customization
5678 @section Living with other packages
5680 Examples with other packages.
5683 * imput:: imput (im-wl.el)
5685 * supercite:: supercite.el
5686 * mu-cite:: mu-cite.el
5687 * x-face-mule:: x-face-mule.el
5688 * dired-dd:: dired-dd.el
5692 @node imput, BBDB, Living with other packages, Living with other packages
5697 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5700 If imput is on the @code{exec-path} at the installation, @file{im-wl.el}
5701 is byte-compiled and installed.
5706 (autoload 'wl-draft-send-with-imput-async "im-wl")
5707 (setq wl-draft-send-func 'wl-draft-send-with-imput-async)
5712 @node BBDB, supercite, imput, Living with other packages
5716 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
5719 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
5720 byte-compiled and installed.
5728 ;; @r{enable pop-ups}
5729 (setq bbdb-use-pop-up t)
5730 ;; @r{auto collection}
5731 (setq bbdb/mail-auto-create-p t)
5732 (setq signature-use-bbdb t)
5733 (setq bbdb-north-american-phone-numbers-p nil)
5734 ;; @r{shows the name of bbdb in the summary} :-)
5735 (setq wl-summary-from-func 'bbdb-wl-from-func)
5736 ;; @r{automatically add mailing list fields}
5737 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
5738 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
5742 @node supercite, mu-cite, BBDB, Living with other packages
5743 @subsection sc.el(supercite), sc-register.el
5747 The same setting as usual mailers should be OK. The following is an
5748 example of settings:
5752 (autoload 'sc-cite-original "sc" nil t)
5753 (setq mail-yank-hooks 'sc-cite-original)
5754 (setq sc-preferred-header-style 1)
5755 (setq sc-electric-references-p nil)
5756 (setq sc-citation-leader "")
5757 (setq sc-load-hook '(lambda () (require 'sc-register)))
5758 (setq sc-preferred-attribution 'registeredname)
5763 @node mu-cite, x-face-mule, supercite, Living with other packages
5764 @subsection mu-cite.el
5767 The same setting as usual mailers should be OK. The following is an
5768 example of settings.
5770 If you use mu-cite version 8.0 or earlier:
5774 (autoload 'mu-cite/cite-original "mu-cite" nil t)
5775 (setq mail-citation-hook 'mu-cite/cite-original)
5779 If you use mu-cite version 8.1 or later:
5783 (autoload 'mu-cite-original "mu-cite" nil t)
5784 (add-hook 'mail-citation-hook (function mu-cite-original))
5788 @node x-face-mule, dired-dd, mu-cite, Living with other packages
5789 @subsection x-face-mule.el
5793 It depends on the version of x-face-mule.
5794 If you use x-face-mule 0.19 or older, do the following:
5798 (setq wl-highlight-x-face-func
5801 (x-face-mule:x-face-decode-message-header))))
5805 If you use x-face-mule 0.20 or later, try the following:
5809 (setq wl-highlight-x-face-func
5812 (x-face-mule-x-face-decode-message-header))))
5813 (require 'x-face-mule)
5817 Use these settings when you use @file{x-face-mule.el} attached to
5818 bitmap-mule 8.0 or later:
5822 (autoload 'x-face-decode-message-header "x-face-mule")
5823 (setq wl-highlight-x-face-func 'x-face-decode-message-header)
5827 If there is an encoded X-Face string in a file @file{~/.xface} (the
5828 value of the variable @code{wl-x-face-file}), it is inserted as a
5829 @samp{X-Face:} field in the draft buffer (if
5830 @code{wl-auto-insert-x-face} is non-nil).
5833 @node dired-dd, , x-face-mule, Living with other packages
5834 @subsection dired-dd(Dired-DragDrop)
5835 @pindex Dired-DragDrop
5837 @cindex Drag and Drop
5839 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
5840 compose multi-part by simple Drag-and-Drop from dired to the draft
5841 buffer being edited in GNU Emacs (this feature is not Wanderlust
5842 specific, but general-purpose for tm/SEMI).
5846 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
5852 ;; @r{Set dired-x variables here.}
5853 ;; @r{To and flo@dots{}}
5855 (progn (require 'dired-dd)
5856 (require 'dired-dd-mime))))))
5861 @node Highlights, Biff, Living with other packages, Customization
5864 @subsection Customizable Variables
5867 @item wl-summary-highlight
5868 @vindex wl-summary-highlight
5869 The initial setting is @code{t}.
5870 If non-nil, the summary is highlighted.
5872 @item wl-highlight-max-summary-lines
5873 @vindex wl-highlight-max-summary-lines
5874 The initial setting is 10000.
5875 The summary is not highlighted if it has more lines than this value.
5877 @item wl-summary-highlight-partial-threshold
5878 @vindex wl-summary-highlight-partial-threshold
5879 The initial setting is 1000.
5880 This is a threshold whether the whole summary is highlighted.
5881 If there are more lines of messages in the summary, it is partially
5884 @item wl-summary-partial-highlight-above-lines
5885 @vindex wl-summary-partial-highlight-above-lines
5886 The initial setting is 30.
5887 If there are more lines of messages than
5888 @code{wl-summary-highlight-partial-threshold} in the summary, messages
5889 after the point that is the same number of lines as this value above the
5890 cursor line are highlighted partially.
5891 (If this value is nil, the last same number of lines as the value of
5892 @code{wl-summary-highlight-partial-threshold} are highlighted.)
5894 @item wl-highlight-body-too
5895 @vindex wl-highlight-body-too
5896 The initial setting is @code{t}.
5897 If non-nil, bodies of drafts and messages are also highlighted.
5899 @item wl-highlight-message-header-alist
5900 @vindex wl-highlight-message-header-alist
5901 When highlighting headers of drafts and messages, this variable
5902 specifies which faces are allocated to important
5903 (@code{wl-highlight-message-important-header-contents}), secondly
5904 important (@code{wl-highlight-message-important-header-contents2}), and
5905 unimportant (@code{wl-highlight-message-unimportant-header-contents})
5907 Similarly, it can be used for allocating arbitrary faces to arbitrary
5908 regular expressions.
5910 @item wl-highlight-citation-prefix-regexp
5911 @vindex wl-highlight-citation-prefix-regexp
5912 Specifies a regular expression to which quoted lines in bodies of
5913 drafts and messages match.
5914 Bodies matching to this regular expression are highlighted by the faces
5915 specified by (@code{wl-highlight-message-cited-text-*}).
5917 @item wl-highlight-highlight-citation-too
5918 @vindex wl-highlight-highlight-citation-too
5919 The initial setting is @code{nil}.
5920 If non-nil, the quoting regular expression itself given by
5921 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
5923 @item wl-highlight-citation-header-regexp
5924 @vindex wl-highlight-citation-header-regexp
5925 Specifies a regular expression that denotes beginning of quotation.
5926 Bodies matching to this regular expression are highlighted by the face
5927 specified by @code{wl-highlight-message-headers}.
5929 @item wl-highlight-max-message-size
5930 @vindex wl-highlight-max-message-size
5931 The initial setting is 10000.
5932 If a message is larger than this value, it will not be highlighted.
5933 With this variable, highlight is suppressed for uuencode or huge digest
5936 @item wl-highlight-signature-separator
5937 @vindex wl-highlight-signature-separator
5938 Specifies regular expressions that denotes the boundary of a signature.
5939 It can be a regular expression, or a list of ones.
5940 Messages after the place that matches this regular expression are
5941 highlighted by the face specified by
5942 @code{wl-highlight-message-signature}.
5944 @item wl-max-signature-size
5945 @vindex wl-max-signature-size
5946 The initial setting is 400.
5947 This is the largest size for a signature to be highlighted.
5949 @item wl-use-highlight-mouse-line
5950 @vindex wl-use-highlight-mouse-line
5951 The initial setting is @code{t}.
5952 If non-nil, the line pointed by the mouse is highlighted in the folder
5953 mode, summary mode, and the like.
5956 @subsection Setting Colors and Fonts of the Characters
5958 If you want to change colors or fonts of the characters, you need to
5959 modify faces defined in Wanderlust. Use @code{set-face-font} if you
5960 want to change fonts, and @code{set-face-foreground} for colors, and so
5961 on. You cannot write face settings in @file{.emacs}; write in
5964 For example, if you want to change the color for signatures to yellow,
5968 (set-face-foreground 'wl-highlight-message-signature "yellow")
5974 Faces defined in Wanderlust:
5977 @item wl-highlight-message-headers
5978 The face for field names of message headers.
5980 @item wl-highlight-message-header-contents
5981 The face for field bodies of message headers.
5983 @item wl-highlight-message-important-header-contents
5984 The face for important parts of message headers.
5985 Per default, this face is used for a body of @samp{Subject:} field.
5986 You can change its value by editing
5987 @code{wl-highlight-message-header-alist}.
5989 @item wl-highlight-message-important-header-contents2
5990 The face for secondly important parts of message headers.
5991 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
5992 fields. You can change its value by editing
5993 @code{wl-highlight-message-header-alist}.
5995 @item wl-highlight-message-unimportant-header-contents
5996 The face for unimportant parts of message headers.
5997 Per default, this face is used for bodies of @samp{X-} fields
5998 @samp{User-Agent:} fields. You can change its value by editing
5999 @code{wl-highlight-message-header-alist}.
6001 @item wl-highlight-message-citation-header
6002 The face for headers of quoted messages.
6004 @item wl-highlight-message-cited-text-*
6005 The face for texts of quoted messages.
6006 The last @samp{*} is a single figure so that 10 different colors can be used
6007 according to citation levels.
6009 @item wl-highlight-message-signature
6010 The face for signatures of messages.
6011 The initial settings are khaki for light background colors, and
6012 DarkSlateBlue for dark background colors.
6014 @item wl-highlight-header-separator-face
6015 The face for header separators of draft messages.
6017 @item wl-highlight-summary-important-face
6018 The face for message lines with important marks in the summary.
6020 @item wl-highlight-summary-new-face
6021 The face for message lines with new marks in the summary.
6023 @item wl-highlight-summary-displaying-face
6024 The face for the message line that is currently displayed.
6025 This face is overlaid.
6027 @item wl-highlight-thread-indent-face
6028 The face for the threads that is currently displayed.
6030 @item wl-highlight-summary-unread-face
6031 The face for message lines with unread marks in the summary.
6033 @item wl-highlight-summary-deleted-face
6034 The face for message lines with delete marks in the summary.
6036 @item wl-highlight-summary-refiled-face
6037 The face for message lines with re-file marks in the summary.
6039 @item wl-highlight-refile-destination-face
6040 The face for re-file information part of message lines with re-file
6041 marks in the summary.
6043 @item wl-highlight-summary-copied-face
6044 The face for message lines with copy marks in the summary.
6046 @item wl-highlight-summary-target-face
6047 The face for message lines with target marks @samp{*} in the summary.
6049 @item wl-highlight-summary-thread-top-face
6050 The face for message lines that are on the top of the thread in the
6053 @item wl-highlight-summary-normal-face
6054 The face for message lines that are not on top of the thread in the
6057 @item wl-highlight-folder-unknown-face
6058 The face for folders that are not known to have how many unsync messages
6061 @item wl-highlight-folder-zero-face
6062 The face for folders that have no unsync messages in the folder mode.
6064 @item wl-highlight-folder-few-face
6065 The face for folders that have some unsync messages in the folder mode.
6067 @item wl-highlight-folder-many-face
6068 The face for folders that have many unsync messages in the folder mode.
6069 The boundary between `some' and `many' is specified by the variable
6070 @code{wl-folder-many-unsync-threshold}.
6072 @item wl-highlight-folder-unread-face
6073 The face for folders that have no unsync but unread messages in the
6076 @item wl-highlight-folder-killed-face
6077 The face for folders that are deleted from the access group in the
6080 @item wl-highlight-folder-opened-face
6081 The face for open groups in the folder mode.
6082 It is meaningful when @code{wl-highlight-group-folder-by-numbers} is
6083 @code{nil} or a number.
6085 @item wl-highlight-folder-closed-face
6086 The face for close groups in the folder mode.
6087 It is meaningful when @code{wl-highlight-group-folder-by-numbers} is
6088 @code{nil} or a number.
6090 @item wl-highlight-folder-path-face
6091 The face for the path to the currently selected folder in the folder
6094 @item wl-highlight-logo-face
6095 The face for logo in the demo.
6097 @item wl-highlight-demo-face
6098 The face for strings (for example, a version number) in the demo.
6102 @node Biff, Advanced Settings, Highlights, Customization
6103 @section Notify Mail arrival
6106 Following setting is to notify mail arrival of @samp{%inbox}
6107 by the indicator on the modeline
6110 (setq wl-biff-check-folder-list '("%inbox"))
6113 @subsection Customizable Variables
6115 @item wl-biff-check-folder-list
6116 @vindex wl-biff-check-folder-list
6117 The initial setting is @code{nil}.
6118 This is the list of folders to check mail arrival.
6119 If @code{nil}, wl doesn't check mail arrival.
6121 @item wl-biff-check-interval
6122 @vindex wl-biff-check-interval
6123 The initial setting is 40 (in seconds).
6124 Check mail arrival in this period.
6128 @node Advanced Settings, Customizable Variables, Biff, Customization
6129 @section Advanced Settings
6132 * Draft for Reply:: Draft for Reply
6133 * Thread Format:: Appearance of Thread
6134 * User-Agent Field:: @samp{User-Agent:} Header Field
6138 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6139 @subsection Draft for Replay
6141 If you want, when you replying to articles in mailing lists, the address
6142 in Reply-To field of the original message to be prepared to To field of
6143 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6148 (setq wl-draft-reply-without-argument-list
6149 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6150 ("Followup-To" . (nil nil ("Followup-To")))
6151 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6152 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6157 (Only if there are both of @samp{X-ML-Name} and @samp{Reply-To} fields in the
6158 original message, @samp{Reply-To} field in the original is copied to @samp{To:}
6161 Moreover, the behavior of @kbd{a} with prefix argument can
6162 be directed by @code{wl-draft-reply-with-argument-list} as well.
6164 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6165 @subsection Appearance of Threads
6169 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6170 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6171 391 09/18(Fri)19:24 +-[ Murata-san ]
6172 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6173 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6174 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6175 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6176 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6177 412 09/22(Tue)09:28 | +-[ Teranishi ]
6178 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6179 416 09/22(Tue)12:38 | +-[ Teranishi ]
6180 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6181 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6185 Settings to make appearance of threads like shown above:
6189 (setq wl-thread-indent-level 2)
6190 (setq wl-thread-have-younger-brother-str "+")
6191 (setq wl-thread-youngest-child-str "+")
6192 (setq wl-thread-vertical-str "|")
6193 (setq wl-thread-horizontal-str "-")
6194 (setq wl-thread-space-str " ")
6198 If you do not want to see branches, do the following:
6202 (setq wl-thread-indent-level 2)
6203 (setq wl-thread-have-younger-brother-str " ")
6204 (setq wl-thread-youngest-child-str " ")
6205 (setq wl-thread-vertical-str " ")
6206 (setq wl-thread-horizontal-str " ")
6207 (setq wl-thread-space-str " ")
6212 @node User-Agent Field, , Thread Format, Advanced Settings
6213 @subsection User-Agent Field
6217 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6218 @samp{User-Agent:} fields, define a function that generate appropriate
6219 strings as you like, and set it to
6220 @code{wl-generate-mailer-string-func}.
6222 If you do not want verbose @samp{User-Agent:} field, do the following:
6226 (setq wl-generate-mailer-string-func
6229 (concat "User-Agent: "
6230 (wl-generate-user-agent-string-1 nil)))))
6234 The following is a example:
6238 (setq wl-generate-mailer-string-func
6241 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6246 @node Customizable Variables, Hooks, Advanced Settings, Customization
6247 @section Customizable Variables
6249 Customizable variables that have not been described yet:
6252 @item wl-default-folder
6253 @vindex wl-default-folder
6254 The initial setting is @samp{%inbox}. This is the default value for moving to
6255 a folder and the like.
6257 @item wl-draft-folder
6258 @vindex wl-draft-folder
6259 The initial setting is @samp{+draft}. It is the folder to which drafts are
6260 saved. It must be a localdir folder.
6262 @item wl-trash-folder
6263 @vindex wl-trash-folder
6264 The initial setting is @samp{+trash}. It is the wastebasket folder.
6265 If you changed this variable, you had better restart Wanderlust.
6267 @item wl-interactive-exit
6268 @vindex wl-interactive-exit
6269 The initial setting is @code{t}.
6270 If non-nil, you are asked for confirmation when Wanderlust terminates.
6272 @item wl-interactive-send
6273 @vindex wl-interactive-send
6274 The initial setting is @code{nil}.
6275 If non-nil, you are asked for confirmation when mail is sent.
6277 @item wl-folder-sync-range-alist
6278 @vindex wl-folder-sync-range-alist
6279 The initial setting is the list shown below:
6284 ("^\\+draft$\\|^\\+queue$" . "all"))
6288 This is an associative list of regular expressions of folder names and
6289 update range of the summary. Update range is one of the @samp{all},
6290 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6291 @samp{last}. If a folder do not match, @samp{update} is used.
6294 @vindex wl-ask-range
6295 The initial setting is @code{t}.
6296 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6297 for updating the summary when you changed folders.
6299 @item wl-mime-charset
6300 @vindex wl-mime-charset
6301 The initial setting is @code{x-ctext}.
6302 This is the MIME charset for messages that are not MIME (e.g. without
6303 @samp{Content-Type:}). This value also used as default charset for
6304 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6305 this value as @code{iso-2022-jp}.)
6307 @item wl-highlight-folder-with-icon
6308 @vindex wl-highlight-folder-with-icon
6309 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6310 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6312 @item wl-strict-diff-folders
6313 @vindex wl-strict-diff-folders
6314 This is a list of regular expressions of folders.
6315 Unread messages are checked, for example when you press @kbd{s} in
6316 the folder mode, usually in a brief way (rapidly processed but not
6318 The folders matching this variable are seriously checked.
6319 You may want to set this variable so as to match conditional filter
6320 folders for IMAP4 folders.
6321 The initial setting is @code{nil}.
6323 @item wl-folder-use-server-diff
6324 @vindex wl-folder-use-server-diff
6325 When unread messages are checked, for example when you press @kbd{s} in
6326 the folder mode, usually (the number of messages on the server) @minus{}
6327 (the number of local messages) will be the number of unread messages.
6328 However, if this variable is non-nil, the number of unread messages on
6329 the server is checked. This affects IMAP4 folders only, but IMAP4
6330 folders in mail boxes matching
6331 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6332 the number of unread messages on the server, even if they matches this
6333 variable. The initial setting is @code{t}.
6335 @item wl-auto-check-folder-name
6336 @vindex wl-auto-check-folder-name
6337 The initial setting is @code{nil}.
6338 If non-nil, the folder with the name of the value is checked for unread
6339 messages at the start.
6340 If it is @code{none}, no folders are checked.
6341 If it is a list, all folders in the list are checked at the start.
6343 @item wl-auto-uncheck-folder-list
6344 @vindex wl-auto-uncheck-folder-list
6345 The initial setting is the list shown below:
6354 Folders with the name matching this variable are not checked for unread
6355 messages at the start, even if they are included in the groups in
6356 @code{wl-auto-check-folder-name}.
6358 @item wl-auto-check-folder-list
6359 @vindex wl-auto-check-folder-list
6360 The initial setting is @code{nil}.
6361 Folders with the name matching this variable are always checked for
6362 unread messages at the start, if they are included in the groups in
6363 @code{wl-auto-check-folder-name}.
6364 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6366 @item wl-no-save-folder-list
6367 @vindex wl-no-save-folder-list
6368 The initial setting is the list shown below:
6377 This is a list of regular expressions of folders not to be saved.
6379 @item wl-save-folder-list
6380 @vindex wl-save-folder-list
6381 The initial setting is @code{nil}.
6382 This is a list of regular expressions of folders to be saved.
6383 This takes precedence over @code{wl-no-save-folder-list}.
6385 @item wl-folder-mime-charset-alist
6386 @vindex wl-folder-mime-charset-alist
6387 The initial setting is the list shown below:
6391 (("^-alt\\.chinese" . big5)
6392 ("^-relcom\\." . koi8-r)
6394 ("^-han\\." . euc-kr))
6399 This is an associative list of regular expressions of folder names and
6401 If a folder do not match, @code{wl-mime-charset} is used.
6403 @item wl-folder-init-load-access-folders
6404 @vindex wl-folder-init-load-access-folders
6405 The initial setting is @code{nil}.
6406 This is a list of access groups to be loaded specifically at the start.
6407 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6409 @item wl-folder-init-no-load-access-folders
6410 @vindex wl-folder-init-no-load-access-folders
6411 The initial setting is @code{nil}.
6412 This is a list of access groups not to be loaded specifically at the
6414 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6416 @item wl-delete-folder-alist
6417 @vindex wl-delete-folder-alist
6418 The initial setting is the list shown below:
6427 This list determines disposition of messages with delete marks.
6428 Each item in the list is a folder and destination; you can specify any
6429 one of the following in the place of destination:
6432 'remove or 'null : deletes the messages instantly.
6433 string : moves the messages to the specific folder.
6434 'trash or others : moves the messages to `wl-trash-folder'.
6437 @item wl-refile-policy-alist
6438 @vindex wl-refile-policy-alist
6439 The initial setting is the list shown below:
6449 This list determines whether messages with re-file marks are moved or
6450 copied. Each item in the list is a cons cell of a folder and
6451 @code{copy} or @code{move}.
6453 @item wl-x-face-file
6454 @vindex wl-x-face-file
6455 The initial setting is @file{~/.xface}.
6456 The name of the file that contains encoded X-Face strings.
6459 @item wl-demo-display-logo
6460 @vindex wl-demo-display-logo
6461 If non-nil, bitmap image is shown on the opening demo. If you set
6462 @code{xpm} or @code{xbm}, (if possible) display selected image type
6465 @item elmo-use-database
6466 @vindex elmo-use-database
6467 This is meaningful for XEmacs only. The initial setting depends on
6468 XEmacs (@code{t} for XEmacs with dbm).
6469 If non-nil, Message-ID is controlled by dbm.
6471 @item elmo-passwd-alist-file-name
6472 @vindex elmo-passwd-alist-file-name
6473 The initial setting is @file{passwd}.
6474 This is the name of the file in which passwords are saved.
6475 @code{elmo-passwd-alist-save} saves current passwords to the file.
6477 @item elmo-nntp-list-folders-use-cache
6478 @vindex elmo-nntp-list-folders-use-cache
6479 The initial setting is 600 (in seconds).
6480 This is period in seconds during which results of @samp{list} and
6481 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6484 @item elmo-nntp-max-number-precedes-list-active
6485 @vindex elmo-nntp-max-number-precedes-list-active
6486 The initial setting is @code{nil}.
6487 If non-nil, the number of article obtained by @samp{list active} in NNTP
6488 are used as the maximum article number of the folder.
6489 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6490 and if the number of read messages is not correct.
6492 @item elmo-nntp-default-use-listgroup
6493 @vindex elmo-nntp-default-use-listgroup
6494 The initial setting is @code{t}.
6495 If non-nil, @samp{listgroup} is used for checking the total number of
6496 articles. If it is @code{nil}, @samp{group} is used. In the latter
6497 case, the processing will be a little faster at the sacrifice of
6500 @item elmo-pop3-send-command-synchronously
6501 @vindex elmo-pop3-send-command-synchronously
6502 The initial setting is @code{nil}.
6503 If non-nil, POP3 commands are issued synchronously. Some implementation
6504 of POP3 server fails to get summary information without this setting.
6505 You may have to set this variable to @code{t}, if the process hangs
6506 while looking up POP3.
6508 @item elmo-dop-flush-confirm
6509 @vindex elmo-dop-flush-confirm
6510 The initial setting is @code{t}.
6511 If non-nil, you are asked for confirmation if accumulated off-line
6512 operations are executed.
6514 @item elmo-display-progress-threshold
6515 @vindex elmo-display-progress-threshold
6516 The initial setting is 20.
6517 Threshold for display of progress gauge. If number of renewal is more than
6518 this value, display progress gauge.
6522 @node Hooks, , Customizable Variables, Customization
6528 @node Mailing List, Addition, Customization, Top
6529 @chapter Wanderlust Mailing List
6534 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6537 Topics related to Wanderlust are discussed in the mailing list.
6538 The latest version is also announced there (in Japanese, sorry).
6540 A guide can be obtained automatically by sending mail to
6541 @t{wl-ctl@@lists.airs.net} with the body
6546 Please send bug reports or patches to the mailing list.
6547 You can post to the mailing list even though you are not a member of it.
6549 If you send a bug report, please attach Backtrace with it.
6550 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to in Japanese.}
6552 I would like to express my thanks to the members of the mailing list for
6553 valuable advice and many pieces of code they contributed.
6556 @node Addition, Index, Mailing List, Top
6557 @chapter Additional Information
6559 @section Brief History
6562 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6563 3/10 Made a msgdb mechanism by elisp.
6564 3/26 IMAP and NNTP can be displayed in threads.
6565 4/13 Began to assemble thread display modules as elmo.
6566 5/01 Finished 0.1.0, initial version with many defects.
6567 6/12 I made a slip of the tongue and said I was writing elisp
6568 mailer supporting IMAP
6569 6/16 0.1.3 was announced at tm-ja, elisp ML.
6570 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6571 7/01 Support for mm-backend (0.3.0).
6572 8/25 multi folder added (0.5.0).
6573 8/28 filter folder added (0.5.1).
6574 9/10 You can open/close threads (0.6.0).
6575 9/11 fldmgr by Murata-san made editing folders easy.
6576 9/18 lha folders added by Okunishi-san (0.6.3).
6577 9/24 Display of branches of threads (0.6.5).
6578 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6579 10/28 Off-line operations (0.7.4).
6580 12/09 Becomes beta version.
6581 12/21 wl-expire by Murata-san.
6582 1999 2/03 auto-refile by Tsumura-san.
6583 4/28 wl-template by Murata-san.
6584 5/18 Released 1.0.0 stable.
6585 7/05 Scoring by Murata-san (2.1.0).
6586 9/26 New plugged system by Murata-san (2.2.2).
6587 12/20 Support Modified UTF7.
6588 2000 3/24 Released 1.1.0 stable.
6589 4/03 CVS development started.
6590 5/07 Thread restoration & Its speed up with Murata-san.
6591 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6592 7/11 killed message feature.
6593 7/18 Use UIDL in POP3.
6594 9/12 biff feature with Satata-san & Yamaoka-san.
6597 See @file{ChangeLog} for details.
6601 According to a dictionary, Wanderlust has the meaning:
6605 n eager longing for or impulse towards travelling in distant lands
6606 [Ger, fr wandern to wander + lust desire, pleasure]
6610 but I had no profound intention. (if farfetched, IMAP @result{} you can
6611 read mail anywhere @result{} desire to wander ?)
6613 Elmo is the abbreviation of @samp{Elisp Library for Message
6614 Orchestration}. At first I meant the red puppet in the Sesame Street,
6615 but you may associate it with Wandering @result{} Drifting @result{}
6616 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6620 Each versions has code names (they are almost jokes).
6621 Currently they are picked up alphabetically from the top 40 hits of
6622 U.S. Billboard magazines in 1980s.
6624 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
6627 @node Index, , Addition, Top
6631 * Concept Index:: Concept Index
6632 * Key Index:: Key Index
6633 * Variable Index:: Variable Index
6634 * Function Index:: Function Index
6637 @node Concept Index, Key Index, Index, Index
6638 @unnumberedsec Concept Index
6641 @node Key Index, Variable Index, Concept Index, Index
6642 @unnumberedsec Key Index
6645 @node Variable Index, Function Index, Key Index, Index
6646 @unnumberedsec Variable Index
6649 @node Function Index, , Variable Index, Index
6650 @unnumberedsec Function Index