1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
26 This edition is for Wanderlust version @value{VERSION}.
28 Permission is granted to make and distribute verbatim copies of this
29 manual provided the copyright notice and this permission notice are
30 preserved on all copies.
33 Permission is granted to process this file through TeX and print the
34 results, provided the printed document carries copying permission notice
35 identical to this one except for the removal of this paragraph (this
36 paragraph not being relevant to the printed manual).
39 Permission is granted to copy and distribute modified versions of this
40 manual under the conditions for verbatim copying, provided that the
41 entire resulting derived work is distributed under the terms of a
42 permission notice identical to this one.
44 Permission is granted to copy and distribute translations of this manual
45 into another language, under the above conditions for modified versions.
51 @title Wanderlust User's Manual
52 @subtitle Yet another message interface on Emacsen
53 @subtitle for Wanderlust version @value{VERSION}
54 @author Yuuichi Teranishi
55 @author Fujikazu Okunishi
56 @author Masahiro Murata
58 @author Kaoru Takahashi
60 @author Masayuki Osada
63 @vskip 0pt plus 1filll
64 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
65 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
66 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
68 This manual is for Wanderlust version @value{VERSION}.
70 Permission is granted to make and distribute verbatim copies of this
71 manual provided the copyright notice and this permission notice are
72 preserved on all copies.
74 Permission is granted to copy and distribute modified versions of this
75 manual under the conditions for verbatim copying, provided that the
76 entire resulting derived work is distributed under the terms of a
77 permission notice identical to this one.
79 Permission is granted to copy and distribute translations of this manual
80 into another language, under the above conditions for modified versions.
86 @node Top, Introduction, (dir), (dir)
87 @top Wanderlust User's Manual
99 This manual is for Wanderlust @value{VERSION}.
104 * Introduction:: Read this first.
105 * Start Me Up:: Invoking Wanderlust.
106 * Folders:: How to specify folders.
107 * Folder:: Selecting and editing folders.
108 * Summary:: Reading and refiling messages.
109 * Message:: Saving and playing MIME multipart entities.
110 * Draft:: Draft buffer, sending mail and news.
111 * Disconnected Operations:: Off-Line management
112 * Expire and Archive:: Automatic expiration and archiving of messages.
113 * Scoring:: Score of the messages.
114 * Customization:: Customizing Wanderlust.
115 * Mailing List:: Wanderlust mailing list
116 * Addition:: Additional Information
121 @node Introduction, Start Me Up, Top, Top
122 @chapter Introduction of Wanderlust
125 Wanderlust is an mail/news management system on Emacsen.
126 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
128 The main features of Wanderlust:
131 @item Pure elisp implementation.
132 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
133 @item Unified access method to messages based on Mew-like Folder Specification.
134 @item Mew-like Key-bind and mark handling.
135 @item Manages unread messages.
136 @item Interactive thread display.
137 @item Folder Mode shows the list of subscribed folders.
138 @item Message Cache, Disconnected Operation (Read Only).
139 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
140 @item MIME compliant (by SEMI or tm).
141 @item Transmission of news and mail are unified by Message transmitting draft.
142 @item Graphical list of folders (XEmacs and Emacs 21).
143 @item View a part of message without retrieving the whole message (IMAP4).
144 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
145 @item Virtual Folders.
146 @item Supports compressed folder using common archiving utilities.
147 @item Old articles in folders are automatically removed/archived (Expiration).
148 @item Automatic re-file.
149 @item Template function makes it convenient to send fixed form messages.
155 Wanderlust is supposed to run on following Emacsen:
156 @c Wanderlust runs even on Nemacs 3.3.2 based on Emacs 18.55, 18.59 (with
157 @c limited functionality).
160 @item Nemacs 3.3.2 (Caution: limited functionality)
161 @item Mule 2.3 based on Emacs 19.28
162 @item Mule 2.3 based on Emacs 19.34
163 @item Emacs 20.2 or later
164 @item XEmacs 20.4 or later
165 @item Meadow 1.00 or later
166 @item Mule for Windows v1.22
167 @item NTEmacs 20.4 or later
171 IMAP4 connectivity with following imapd are confirmed to work with
175 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
176 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
177 @item Courier-IMAP 1.3.2 or later
178 @item AIR MAIL (AIRC imapd release 2.00)
180 @item Microsoft Exchange Server 5.5
181 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
184 LDAP connectivity with following LDAPd are confirmed to work with
188 @item OpenLDAP 2.0.6 or later
192 @node Start Me Up, Folders, Introduction, Top
193 @chapter Start up Wanderlust
196 The necessary procedure for starting Wanderlust is explained in steps
199 (Of course, you need a mail/news readable environment in advance)
202 * MIME Modules:: Installing the MIME modules.
203 * Download:: Download and extract the packages.
204 * Install:: Byte-compile and install.
205 * Minimal Settings:: @file{.emacs} setup.
206 * Mail Addresses:: Address book definition.
207 * Folder Definition:: Folder definition.
208 * Start Wanderlust:: Starting Wanderlust
212 @node MIME Modules, Download, Start Me Up, Start Me Up
213 @section Installing MIME modules
220 SEMI or tm must be installed to make Wanderlust work correctly.
222 SEMI does not run on Emacs 19.28 or earlier
223 @footnote{SEMI runs on Emacs 19.34. @*
224 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} describes how to.},
225 so you must install tm, the predecessor of SEMI. (tm version 8.7 or later
228 However, SEMI is recommended because of its wider functionality.
230 Refer to the documents of each package for detailed installation procedure.
232 SEMI and tm can be downloaded from these sites:
236 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
237 tm: http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
241 You need packages named APEL and FLIM to use SEMI.
242 You can download APEL and FLIM from following URLs:
246 APEL: ftp://ftp.m17n.org/pub/mule/apel/
247 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
251 You have to install APEL, FLIM and SEMI in this order. Generally,
252 @samp{make install} will do the job. (In XEmacs 21, @samp{make
255 Recommended combination of APEL, FLIM and SEMI are following:
258 @item APEL 10.3, FLIM 1.14.2 and SEMI 1.14.3
261 You can also use many other FLIM/SEMI variants. Combination of the
262 latest versions should work. For example, the following combination are
266 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
267 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
270 You have to re-install Wanderlust if you upgraded APEL, FLIM, SEMI or
274 @node Download, Install, MIME Modules, Start Me Up
275 @section Download and Extract the Package
278 You can download Wanderlust package from following sites:
282 ftp://ftp.gohome.org/wl/
285 Mirrored ftp/http sites:
289 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
290 http://www.jpl.org/elips/wl/
291 http://www.ring.gr.jp/archives/text/elisp/wl/
292 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
293 ftp://opaopa.org/pub/mirror/elisp/wl/
294 @c ftp://roguelife.org/pub/tsumura/wl/
298 Extract the obtained package to your working directory:
303 % tar zxvf wl-@var{version}.tar.gz
304 % cd wl-@var{version}
308 @subsection To use SSL (Secure Socket Layer)
313 SSL (Secure Socket Layer) can be used for
314 SMTP, IMAP, NNTP and POP connections in Wanderlust.
316 There are two ways to use SSL. One is to start SSL negotiation just
317 after the connection establishment (generic way). The other one is to
318 start SSL negotiation by invoking STARTTLS command in the each session.
320 To use the formal SSL (generic SSL), you must install @file{ssl.el} in
321 the @file{utils} directory. OpenSSL command @command{openssl} is also
322 required to use @file{ssl.el}. You must set @env{PATH} to the directory
323 that OpenSSL commands are installed.
325 To use the latter SSL(STARTTLS), you must install starttls package in
327 You can download starttls package from the following site.
330 ftp://opaopa.org/pub/elisp/
333 @node Install, Minimal Settings, Download, Start Me Up
334 @section Byte-compile and install
341 @subsection Installation
343 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
344 Set the Emacs's command name to @code{EMACS}.
345 Set package installation directory to @code{LISPDIR}.
346 Then, please execute following commands.
355 Destination directory is auto-probed if you leave @code{LISPDIR}
356 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
358 If you are using an Emacs variant which does not merge specified directory
359 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
360 then you will see the error message:
363 Cannot open load file: mime-setup
367 In this case, either add destination directories of custom, APEL, FLIM
368 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
369 @code{load-path} in @file{WL-CFG} in extracted directory.
371 If you want to use BBDB, then the necessary modules are byte-compiled
372 and installed when BBDB directory is added to @code{load-path}.
375 @subsection @file{WL-CFG}
377 Contents of the file @file{WL-CFG} is loaded under installation if a file
378 with that name exists in extracted directory. You can use @file{WL-CFG} to
379 configure @code{load-path} to extra packages such as SEMI if needed.
381 If you want to specify the install directory of Wanderlust related
382 files, then set following variables in @file{WL-CFG}
386 A directory to install WL modules.
387 This directory is relative directory from @code{LISPDIR}.
388 WL modules include @file{wl*.el}, @file{wl*.elc} files.
389 @c Modules under the directory @file{util/} are also installed if
390 @c it detected as necessary.
393 A directory to install ELMO modules.
394 This directory is relative directory from @code{LISPDIR}.
395 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
396 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
400 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
402 If you want to install ELMO related files under a sub-directory
403 such as "elmo" then add following to @file{WL-CFG}:
406 (setq ELMO_PREFIX "elmo")
409 @subsection Install as a XEmacs package
410 @cindex XEmacs package
411 @cindex XEmacs package install
412 @cindex Package, XEmacs
413 @cindex Package install, XEmacs
414 @c @cindex install-package
416 It is possible to install Wanderlust as one of packages of XEmacs (21.0
417 or later). Configuration for autoload and icon-path in local
418 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
421 Follow the next example to install Wanderlust as an XEmacs package.
427 % make install-package
431 package directory is auto-probed, if SEMI is installed.
432 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
434 @subsection Run in place
436 If wl and elmo directories are defined in @code{load-path}, then
437 byte-compilation and installation are not necessary to start Wanderlust.
438 For example, if package is extracted in @file{~/work}, Wanderlust can be
439 invoked with following setting in @file{~/.emacs}.
443 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
444 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
450 Manual is described in Info format. Please do following.
459 If you install Wanderlust as a XEmacs package, Info file is already
460 installed too, so there are no need of these commands.
462 Manual directory is automatically detected. Of course, it can be
463 configured by @code{INFODIR} in @file{Makefile}.
465 You can read manual at the following URL:
468 http://www.gohome.org/wl/doc/wl-euc_toc.html
471 @node Minimal Settings, Mail Addresses, Install, Start Me Up
472 @section Set up .emacs
473 @cindex Minimal Settings
475 @cindex Configuration
479 The Wanderlust package contains two module groups.
482 @item ELMO (elmo-*.el)
483 These modules show everything as folders. This is the back-end for WL.
485 These modules controls the behavior of main body of Wanderlust.
486 They are also the front-end for ELMO.
489 You can customize the behavior of Wanderlust by changing the value
490 of environmental variables which begins with @code{elmo-} and @code{wl-}.
492 The minimal requirement for settings is as the following.
496 ;; @r{The setting to use SEMI/tm}
499 ;; @r{autoload configuration}
500 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
501 (autoload 'wl "wl" "Wanderlust" t)
502 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
504 ;; @r{Directory where icons are placed (XEmacs or Emacs 21).}
505 ;; @r{Default: @code{nil}.}
506 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
507 (setq wl-icon-dir "~/work/wl/etc")
509 ;; @r{SMTP server for mail posting. Default: @code{nil}}
510 (setq wl-smtp-posting-server "your.smtp.example.com")
511 ;; @r{NNTP server for news posting. Default: @code{nil}}
512 (setq wl-nntp-posting-server "your.nntp.example.com")
516 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
517 file exists). So it is convenient to gather Wanderlust specific settings
518 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
519 because you can't write them in @file{.emacs}
520 (if you write it to @file{.emacs}, you'll get an error).
523 All above described settings except (load "mime-setup") and autoload
524 configuration can be written in
527 @subsection @code{mail-user-agent}
528 @cindex Default Mailer
529 @cindex Mailer, Default
530 @vindex mail-user-agent
533 If you write following setting in you @file{.emacs}, you can
534 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
535 This means it enables you to run Wanderlust as a default mail composer
538 It is effective only when your Emacs can define @code{mail-user-agent}.
539 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
543 (autoload 'wl-user-agent-compose "wl-draft" nil t)
544 (if (boundp 'mail-user-agent)
545 (setq mail-user-agent 'wl-user-agent))
546 (if (fboundp 'define-mail-user-agent)
547 (define-mail-user-agent
549 'wl-user-agent-compose
557 @node Mail Addresses, Folder Definition, Minimal Settings, Start Me Up
558 @section Address book
559 @cindex Address book Definition
561 @cindex Alias, Address
563 The file @file{~/.addresses} is a simple address book for Wanderlust.
564 Make address file @file{~/.addresses}, and edit to suit your requirement.
566 The data written in @file{~/.addresses} are used for address completion
567 under draft editing mode. Furthermore, they are used when showing names
568 in summary display mode. You can safely skip this section, if you don't
569 want to customize address completion and summary display.
570 It is possible to add/change/remove addresses from @file{~/.addresses} in
571 summary buffer after Wanderlust is invoked. @refill
573 The format is very simple. Like this. @refill
578 # @r{Lines begin with @samp{#} are comment.}
579 # @r{Empty lines are ignored}
581 # @r{Format of each line:}
582 # @var{email-address} "@var{nickname} "@var{realname}"
584 teranisi@@gohome.org "YT" "Yuuichi Teranishi"
585 foo@@example.com "Mr. Foo" "John Foo"
586 bar@@example.org "Mr. Bar" "Michael Bar"
591 One line defines one persons description.
593 Actually, in default setup, @var{nickname} is used in summary-mode and
594 @var{realname} is used in draft preparation mode. This behavior is
595 better understood if you try it and confirmed the function first. You
596 can write and try a small definition, so you will know the idea of the
597 address book before writing a big one.
599 And, if MH alias file is specified in variable @code{wl-alias-file},
600 it is used as an address information in the draft preparation mode.
602 If variable @code{wl-use-ldap} is non-nil (initial setting is
603 @code{nil}), address completion in draft mode uses LDAP information.
605 If you use LDAP, you have to set @code{wl-ldap-server},
606 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
607 not have LDAP feature as built-in feature (Currently only XEmacs can
608 have built-in LDAP feature), you have to set command exec @env{PATH} to
609 the program @command{ldapsearch}.
611 @node Folder Definition, Start Wanderlust, Mail Addresses, Start Me Up
612 @section Folder Definition
613 @cindex Folder Definition
616 You can skip this section because it is possible to add/edit the
617 subscribe folders from the buffer for list of folders.
618 @xref{Folder Manager}.
620 Define the folders you want to subscribe in file @file{~/.folders}. The
621 contents written in @file{~/.folders} become the folders which you
622 subscribe to as it is.
624 Format for @file{~/.folders} is very simple. Here is an example:
629 # @r{Lines begin with @samp{#} are comment.}
630 # @r{Empty lines are ignored}
632 # @var{folder name} "@var{folder nickname}"
633 # @r{(nicknames are not necessary)}
638 %#mh/Backup@@my.imap.example.com "Sent"
641 %#mh/spool/wl "Wanderlust ML"
642 %#mh/spool/elips "ELIPS ML"
643 %#mh/spool/apel-ja "APEL Japanese ML"
644 %#mh/spool/xemacs-beta "XEmacs beta"
645 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
646 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
649 # @r{If folder name ends with @samp{/}, that means an `access group',}
650 # @r{all subfolders automatically included in one folder group.}
652 %#mh/expire@@localhost /
653 # @r{All MH folders are included in one folder group.}
658 Each line contains one folder you want to read. The definition of
659 folders will be explained in detail in the next section.
661 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
662 become one folder group. One folder group is treated as a directory
663 which can bed opened and closed in folder mode. It is convenient for
664 collecting some folders and putting them in order.
666 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
667 line and you have to write it that way (It is because the parser sucks).
669 There are two types of groups. One is like @samp{Emacsen} from above
670 example which the user chooses his favorite folders as a group.
672 The other one is @dfn{access group} like @samp{+} from above example.
673 It makes all the sub-folders in a folder to a group. (It differs from
674 the type of the folder. For example, @samp{+} makes entire MH
675 sub-directories to one group)
677 This behavior is better understood if you try it and confirmed the
678 function first. You can write and try a small folder definition, so you
679 will know the idea of the folder function before writing the real one.
681 @node Start Wanderlust, , Folder Definition, Start Me Up
682 @section Start Wanderlust
683 @cindex Start Wanderlust
685 If installation and configuration worked well, you can invoke Wanderlust by
686 typing following command in Emacs.
693 After initialization, Folder Mode which shows the list of folders will appear.
694 That means the folders you defined in the @file{~/.folders} are listed
695 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
696 can skip folder checking.
699 @node Folders, Folder, Start Me Up, Top
700 @chapter Wanderlust's folders
703 This chapter describes the folder types which Wanderlust is able to handle.
705 Wanderlust uses ELMO as it's interface, so every folder types supported
706 by ELMO is usable in Wanderlust.
708 As of version @value{VERSION}, 10 types of folders are predefined. These are
709 IMAP, NNTP, LocalDir(MH), News Spool, POP, Archive, Multi, Filter, Pipe
710 and Internal folder types.
713 * IMAP Folder:: @samp{%} -- IMAP folder
714 * NNTP Folder:: @samp{-} -- NNTP folder
715 * MH Folder:: @samp{+} -- MH folder
716 * Maildir Folder:: @samp{.} -- Maildir folder
717 * News Spool Folder:: @samp{=} -- News spool folder
718 * Archive Folder:: @samp{$} -- Archive folder
719 * POP Folder:: @samp{&} -- POP folder
720 * Multi Folder:: @samp{*} -- Multi folder
721 * Filter Folder:: @samp{/} -- Filter folder
722 * Pipe Folder:: @samp{|} -- Pipe folder
723 * Internal Folder:: @samp{'} -- Internal folder
727 @node IMAP Folder, NNTP Folder, Folders, Folders
734 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
740 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
744 You can specify @code{login} (encoded password transmission),
745 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
746 authentication) or @code{clear} (or @code{nil}, plain password
747 transmission) as @var{authenticate-type}. (To use CRAM-MD5 or
748 DIGEST-MD5 authentication, you must install @file{utils/sasl} package if FLIM version is earlier than 1.14.0. If FLIM version is 1.14.0 or later, you need not install @file{utils/sasl})
753 @var{username} -> The value of @code{elmo-default-imap4-user}.
754 Initial setting is @env{USER} environment variable or
755 @env{LOGNAME} environment variable or return value of
756 @code{(user-login-name)}.
757 @var{authenticate-type} -> The value of @code{elmo-default-imap4-authenticate-type}.
758 Initial setting is "auth".
759 @var{hostname} -> The value of @code{elmo-default-imap4-server}.
760 Initial setting is "localhost".
761 @var{port} -> The value of @code{elmo-default-imap4-port}.
762 Initial setting is 143.
765 You can omit the @var{hostname} from folder names if you set
766 @code{elmo-default-imap4-server} as your main IMAP server.
767 For example, you can specify a folder as @samp{foo%imap@@gateway} even
768 if you have to go through a firewall.
771 ;; Example: imap4.exaple.org as main IMAP server
772 (setq elmo-default-imap4-server "imap4.example.org")
775 SSL (Secure Socket Layer) connection will be used if a folder name ends
776 with @samp{!}. Or, if the value of @code{elmo-default-imap4-stream-type}
777 is @code{ssl}, SSL will be the default connection. If a folder name
778 ends with @samp{!!}, STARTTLS connection will be established. If the
779 value of @code{elmo-default-imap4-stream-type} is @code{starttls},
780 STARTTLS will be the default connection.
783 ;; Example: Use SSL connection
784 (setq elmo-default-imap4-stream-type 'ssl)
787 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
788 authentication method, the password is sent in encoded form. But, if
789 your server is unable to receive an encoded password, authentication
790 will fall back to @code{clear} (that is, sending password in raw format)
791 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
792 authentication will fall back to @code{clear} without confirmation
793 (default value is @code{nil}).
796 ;; Example: password in raw format
797 (setq elmo-default-imap4-authenticate-type 'clear)
804 %inbox -> IMAP mailbox "inbox"
805 %#mh/inbox -> IMAP mailbox "#mh/inbox"
807 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
808 %inbox:hoge/clear@@server1
809 -> server1's IMAP mailbox "inbox"
810 of user "hoge", with plain password authentication
815 @subsection International mailbox names (Modified UTF7)
816 @cindex Modified UTF7
823 You can use international mailbox names in @var{mailbox} part, if you
824 are using Emacs which can treat unicode and
825 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
826 value is @code{nil}).
828 Currently, following Emacsen can treat unicode.
831 @item Emacs 20.3 or later + Mule-UCS
833 If you installed Mule-UCS package, Emacs can treat unicode.
834 You can obtain Mule-UCS package from following URL.
837 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
840 @item XEmacs 21.2.13 or later + ucs-conv package
842 By default, XEmacs 21 cannot treat unicodes, but if you installed
843 ucs-conv package, it can.
844 You can obtain ucs-conv package from following anonymous CVS.
848 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
849 Password: @var{NULL} (Just enter return key)
850 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
854 You also need utf7 conversion programs, @command{u7tou8} and
855 @command{u8tou7} to use international mailbox name in the current
856 XEmacs. These programs are included in the UTF7 package which can be
857 obtained from following URL.
860 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
864 @node NNTP Folder, MH Folder, IMAP Folder, Folders
869 A folder to access USENET news via NNTP protocol (RFC 977).
870 One newsgroup is treated as a folder.
876 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
882 @var{hostname} -> The value of @code{elmo-default-nntp-server}.
883 Initial setting is @samp{localhost}.
884 @var{username} -> The value of @code{elmo-default-nntp-user}.
885 Initial setting is @code{nil}.
886 @var{port} -> The value of @code{elmo-default-nntp-port}.
887 Initial setting is 119.
890 AUTHINFO is used as authentication method if the @var{username} is non-nil.
891 SSL will be default method if @code{elmo-default-nntp-stream-type} is non-nil even
892 if the folder name doesn't end with @samp{!}.
893 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
894 if the value of @code{elmo-default-nntp-stream-type} is @code{starttls},
895 STARTTLS will be the default connection.
901 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
902 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
906 @node MH Folder, Maildir Folder, NNTP Folder, Folders
912 A folder to access MH format mail (1 file is 1 mail).
917 @samp{+} @var{directory-name}
920 Normally, @var{directory-name} is an relative path to the variable
921 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
922 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
923 (this is also true for drive-letters).
925 Message number is used for the name of the message file.
931 +inbox -> @file{~/Mail/inbox}
932 +from/teranisi -> @file{~/Mail/from/teranisi}
933 +~/test -> @file{~/test}
937 @node Maildir Folder, News Spool Folder, MH Folder, Folders
938 @section Maildir Folder
939 @cindex Maildir Folder
943 A folder to access to Maildir format (1 file is 1 mail).
948 @samp{.} [@var{directory-name}]
951 Normally, @var{directory-name} is a relative path to the variable
952 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
953 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
954 (this is also true for drive-letters).
956 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
957 Messages are contained in the @file{cur} directory. All message files
958 in the @file{new} directory are moved to @file{cur} directory when you
959 access to the folder. All message files contained in the @file{tmp}
960 directory and not accessed for 36 hours are deleted.
962 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
968 . -> @file{~/Maildir}
969 .inbox -> @file{~/Maildir/inbox}
970 .from/teranisi -> @file{~/Maildir/from/teranisi}
971 .~/test -> @file{~/test}
976 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
977 @section News Spool Folder
978 @cindex News spool Folder
982 This folder handles locally saved news articles which are proposed by
983 Mew/IM. You can also read articles directly from a spool-file which is
984 retrieved by an utility like @command{gnspool}.
989 @samp{=} @var{directory-name}
992 @var{directory-name} is a sub-directory to the directory defined by
993 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
994 You can use @samp{.} as directory delimiter as well as @samp{/}.
1000 =fj/os/os2 -> @file{~/News/fj/os/os2}
1001 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
1006 @node Archive Folder, POP Folder, News Spool Folder, Folders
1007 @section Archive Folder
1008 @cindex Archive Folder
1012 This method can handle archive files, which are compressed by utilities
1013 such as Info-ZIP or LHA, as one folder.
1019 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1023 @var{path-name} is the relative path from
1024 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1025 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1026 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1027 also permitted under the environment of ange-ftp, efs.
1029 The actual file name of the archive folder is
1030 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1031 under the @var{path-name}. If a file named @var{path-name} exists, it is
1032 treated as folder. The suffix is automatically decided for
1033 @var{archiver-type}.
1035 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1036 (Initial setting is @code{zip}) is referred.
1038 @var{prefix} specifies the internal directory structure of the archive.
1039 For example, if the ML server is fml, @file{msend.tar.gz} has a
1040 structure like @file{spool/1}, so you have to specify @samp{spool} as
1047 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1048 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1049 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1050 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1055 * Archiver:: Archivers supported
1056 * Archive Tips:: TIPS
1057 * Archive Vars:: Customization
1061 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1062 @subsection Supported Archives
1072 By default, following archives are supported.
1076 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1077 GNU TAR('tgz, 'tar) ;; read-only
1081 If your archiver can include multiple files in one archive, you have a
1082 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1083 of the candidate. TAR is supported read-only because it cannot delete
1084 file in the archive (@code{mv})).
1086 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1087 archiver of Wanderlust because they cannot include multiple
1088 files. Archivers that cannot extract files to standard output are also
1091 @subsection OS specific information about archiver.
1093 Behaviors of the following archivers are confirmed by further experiences.
1094 (@samp{*} mark means recommended archiver).
1097 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1098 LHA OS/2 version Rel.2.06b Feb 18, 1998
1099 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1100 *Zip 2.2 (November 3rd 1997).
1101 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1102 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1103 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1105 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1106 LHa for UNIX V 1.14c
1107 UnZip 5.32 of 3 November 1997
1108 Zip 2.2 (November 3rd 1997)
1109 GNU tar 1.12 (1.11.x is no good)
1110 gzip 1.2.4 (18 Aug 93)
1112 [Win32] Win.98/Meadow
1116 GNU tar 1.11.8 + 1.5(WIN32)
1123 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1124 Hiramatsu version of LHA is only supported.
1125 In Win32, LHa32 is only supported (DOS version is no good).
1127 * Caution about GNU tar
1129 You have to take care about GNU tar's version because many version has
1130 problem on deleting file from archive.
1132 Please test @option{--delete} @option{-f} options work. Otherwise, your
1133 archive will be destroyed. No problem is reported on above versions of
1137 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1139 @cindex Archive Tips
1141 For comfortable migration, usage of @code{wl-summary-archive}
1142 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1143 archive folders created by expiration, you must set non-nil value to
1144 @code{elmo-archive-treat-file}.
1146 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1147 in processing speed. For comfortable use, Emacs20 is recommended.
1148 (If re-search's performance is the problem, 19.3x or later may be okay.)
1150 If many files are included in one archive,
1151 it takes long time to access to the archive folder because
1152 archiver starting overhead is increased (especially LHA).
1153 150-200 messages in one archive is recommended.
1155 Of course, following is possible @t{:-)}
1156 (meanings of these variables are described later.)
1160 (setq wl-fcc "$backup")
1161 (setq wl-trash-folder "$trash;lha")
1165 @node Archive Vars, , Archive Tips, Archive Folder
1166 @subsection Variables About Archive Folder
1167 @cindex Archive variables
1170 @item elmo-archive-default-type
1171 @vindex elmo-archive-default-type
1172 The initial setting is @code{zip}.
1173 Set archiver type by symbol.
1175 @item elmo-archive-@var{type}-method-alist
1176 @vindex elmo-archive-TYPE-method-alist
1177 Define archiver @var{type}'s methods.
1178 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1179 Each element of the alist is following.
1183 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1184 (@var{action} . @var{function}) ;; function
1188 Currently available actions are following.
1192 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1193 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1200 actions enclosed with braces are optional (They are used for better
1203 @item elmo-archive-suffix-alist
1204 @vindex elmo-archive-suffix-alist
1205 An alist of archiver-type (symbol) and suffix.
1207 @item elmo-archive-file-regexp-alist
1208 @vindex elmo-archive-file-regexp-alist
1209 An alist of a regexp to get file number from list output of archiver
1210 and archiver-type (symbol).
1212 @item elmo-archive-method-list
1213 @vindex elmo-archive-method-list
1214 A list of elmo-archive-@var{type}-method-alist
1215 (@var{type} is a symbol of archiver-type).
1217 @item elmo-archive-lha-dos-compatible
1218 @vindex elmo-archive-lha-dos-compatible
1219 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1220 DOS (Mr. Yoshizaki original) compatible.
1222 @item elmo-archive-cmdstr-max-length
1223 @vindex elmo-archive-cmdstr-max-length
1224 The initial setting is 8000.
1226 Max length of command line argument for external archiver program.
1227 Emacs does not have a limit of command line byte length, but some OS
1228 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1229 this limit because it calls external archiver program directly (not
1230 called via shell). For example, you cannot delete messages if archiver
1231 program must receive larger bytes of arguments to delete. OS/2 have a
1232 command line argument limit of 8190 bytes, so we defined default as 8000
1235 However, you don't have an influence of command line argument limit
1236 if the archiver has `actions' to receive target file information from
1237 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1240 @node POP Folder, Multi Folder, Archive Folder, Folders
1248 A folder to access e-mails via POP3 protocol (RFC 1939).
1254 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1259 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1260 as @var{authenticate-type}.
1264 @var{username} -> The value of @code{elmo-default-pop3-user}.
1265 Initial setting is @env{USER} environment variable or
1266 @env{LOGNAME} environment variable or return value of
1267 @code{(user-login-name)}.
1268 @var{authenticate-type} -> The value of @code{elmo-default-pop3-authenticate-type}.
1269 Initial setting is @samp{user}.
1270 @var{hostname} -> The value of @code{elmo-default-pop3-server}.
1271 Initial setting is @samp{localhost}.
1272 @var{port} -> The value of @code{elmo-default-pop3-port}.
1273 Initial setting is 110.
1280 &hoge@@localhost -> access to localhost as user @samp{hoge}.
1281 &hoge@@popserver:109 -> access to the server "popserver" on port 109
1282 as user @samp{hoge}.
1286 To use APOP as an @var{authenticate-type}, @file{md5.el} is needed
1287 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1288 @file{utils/sasl/lisp/} or Emacs/W3 package
1289 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1292 If the last character of the folder name is @samp{!}, Wanderlust
1293 connects to the POP server via SSL (Secure Socket Layer). If you set
1294 non-nil value to @code{elmo-default-pop3-stream-type}, you don't have to put
1295 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1296 with @samp{!!}, STARTTLS connection will be established. if the value
1297 of @code{elmo-default-pop3-stream-type} is @code{starttls}, STARTTLS will be the
1300 @node Multi Folder, Filter Folder, POP Folder, Folders
1301 @section Multi Folder
1302 @cindex Multi Folder
1304 @cindex Folder, Multiple
1305 @cindex Folder, Marge
1307 A folder to access to a folder which collects messages from
1308 multiple folders virtually.
1314 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1318 After @samp{*} character, specify multiple folders you want to collect
1319 separated by @samp{,} like
1320 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1326 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1327 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1328 treated as one folder.
1330 *+inbox,-fj.rec.tv,%inbox
1331 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1336 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1337 @section Filter Folder
1338 @cindex Filter Folder
1340 @cindex Folder, Filtering
1341 @cindex Folder, Virtual
1343 A folder to access to a folder which collects all messages that
1344 satisfy a condition virtually.
1349 @samp{/} @var{condition} @samp{/} @var{target-folder}
1352 In the @var{condition} part, you can specify following.
1356 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1358 first: @var{number} messages are picked from top of folder.
1359 last: @var{number} messages are picked from bottom of folder.
1365 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1366 /first:20/%inbox -> First 20 messages from %inbox are picked.
1371 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1373 since: only messages arrived since @var{date} are picked.
1374 before: only messages arrived before @var{date} are picked.
1376 You can specify following as @var{date}.
1380 yesterday -> a day before today.
1381 lastweek -> same day of last week.
1382 lastmonth -> same day of last month.
1383 lastyear -> same day of last year.
1384 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1385 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1393 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1395 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1401 Field filter: @samp{@var{field}:@var{value}}
1403 All messages that have @var{field} and its value is @var{value} are picked.
1404 @var{field} and @var{value} are case insensitive.
1410 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1411 and its value includes "teranisi" string are picked.
1412 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1420 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1421 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1423 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1424 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1430 /from:teranisi&!to:teranisi/+inbox
1431 -> In +inbox, messages are picked if the message's
1432 From: field includes "teranisi" and
1433 To: field doesn't include "teranisi".
1435 /tocc:"Yuuichi Teranishi"/+inbox
1436 -> In +inbox, messages are picked if the
1437 message's To: field or Cc: field includes
1438 "Yuuichi Teranishi".
1440 /(from:yt|from:teranisi)&subject:report/+inbox
1441 -> In +inbox, messages are picked if the message's
1442 From: field includes "yt" or "teranisi", and
1443 Subject includes "report".
1449 Tip for string description:
1451 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1452 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1453 should be escaped with @samp{\} in it). You can enclose the string with
1454 @samp{"} even it does not contain these characters.
1460 *%inbox,/from:teranisi/%inbox@@server
1461 -> Messages in %inbox or
1462 message is in the %inbox@@server folder and it's From field
1463 includes "teranisi" are collected.
1465 /last:100//to:teranisi/*+inbox,%inbox
1466 -> Latest 100 messages which is in the +inbox or %inbox folder
1467 and To: field matches "teranisi".
1469 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1470 -> Pick messages which have From: field and it includes "hogehoge"
1471 from latest 20 messages in the %#mh/inbox@@localhost
1472 and To: or Cc: field includes "teranisi".
1475 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1476 @section Pipe Folder
1480 @cindex Download Message
1481 @cindex Incorporate Message
1483 In the pipe folder, messages are automatically transferred from the source
1484 folder to destination folder.
1489 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1492 When you access to the pipe folder, messages are automatically transferred
1493 from @var{source-folder} to @var{destination-folder}.
1494 It is convenient if you want to download messages to local disk via POP.
1495 For example, if you specify following
1498 |&username@@popserver|+inbox
1502 and access to it, messages are downloaded automatically from
1503 @samp{&username@@popserver} to @samp{+inbox}.
1509 %inbox|%myinbox -> Download %inbox to %myinbox.
1510 *&user@@popserver1,&user@@popserver2|+inbox
1511 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1515 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1517 @node Internal Folder, , Pipe Folder, Folders
1518 @section Internal folder
1519 @cindex Internal Folder
1521 @cindex Folder, @samp{$} mark
1523 A folder to access to internal messages of Wanderlust.
1535 A folder named @samp{'mark} is a special virtual folder which collects
1536 messages which have important mark @samp{$}.
1538 You can review important messages at once after you put important marks
1539 on the messages in the different folders.
1541 In this folder, if you delete message, important mark @samp{$} put on
1542 the message is removed. If you append messages to this folder, the
1543 message will have @samp{$} mark.
1545 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1546 folder. If you want IMAP folder's message remove from @samp{'mark}
1547 folder, remove important mark at IMAP Folder.)
1549 You can access to the cached messages fetched via network by accessing
1550 to the folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1551 the name of the subdirectories of the cache directory
1552 (@file{~/.elmo/cache}).
1555 @node Folder, Summary, Folders, Top
1556 @chapter Folder mode
1559 After you start Wanderlust, folder mode is appeared firstly.
1560 It contains folder list you subscribed.
1561 You can select and edit folders in this mode.
1564 * Selecting Folder:: Select folder you want to read.
1565 * Folder Manager:: Editing folders.
1569 @node Selecting Folder, Folder Manager, Folder, Folder
1570 @section Selecting Folder
1571 @cindex Selecting Folder
1573 @subsection Usage (TIPS)
1575 @subsubsection Check new, unread number
1577 Folder mode looks like this.
1578 (In XEmacs, it looks much nicer @t{;-)})
1582 [-]Desktop:14186/35580/67263
1587 [-]Emacsen:0/34/4837
1588 Wanderlust ML:0/0/558
1591 XEmacs Beta:0/29/255
1602 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1606 @kbd{s} key on the folder line updates these numbers.
1607 It changes its color if it has many new messages.
1609 The whole folder mode is a folder group named @samp{Desktop}.
1610 Folder group open/close by return key.
1611 A operation to a folder group is treated as operations on the
1613 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1614 six children folders update its unread number status.
1616 @subsubsection Select Folder
1618 To enter summary mode of the folder, type return (or space) key on
1620 If the variable @code{wl-stay-folder-window} has non-nil value,
1621 summary window appears on the right of the folder mode window.
1623 @subsection Key bindings
1625 Folder mode's key binding (related to selecting folders) is following.
1630 @kindex @key{SPC} (Folder)
1631 @kindex @key{RET} (Folder)
1632 @findex wl-folder-jump-to-current-entity
1633 Enter to the summary mode of the folder at the current cursor point.
1634 If the cursor is on the top of folder group line,
1635 the folder group is opened or closed.
1636 When the cursor is on the access group and this command is called
1637 with prefix argument, folder children list is updated to the newest one.
1638 (Children list is updated recursively if the access folder has hierarchical
1640 (@code{wl-folder-jump-to-current-entity})
1643 @kindex M-@key{RET} (Folder)
1644 @findex wl-folder-update-recursive-current-entity
1645 Folder children list of the access group at the current cursor point
1646 is updated to the newest one.
1647 (Children list is updated recursively if the access folder has hierarchical
1649 (@code{wl-folder-update-recursive-current-entity})
1654 Create a new draft message.
1659 @findex wl-folder-write-current-folder
1660 If the current cursor point is on the NNTP folder, create a new draft
1661 message which already has @samp{Newsgroups:} field. If the current
1662 cursor point is on the folder for mailing list (refile destination),
1663 create a new draft message which already has @samp{To:} field with
1664 guessed mailing list adderss (If @code{wl-subscribed-mailing-list} is
1666 (@code{wl-folder-write-current-folder})
1669 @kindex C-c C-o (Folder)
1670 @findex wl-jump-to-draft-buffer
1671 Move to the draft buffer if available. If multiple draft buffer exists,
1672 moved to one after another. If prefix argument is specified, load draft
1673 folder's message to the draft buffer and jump to it.
1674 (@code{wl-jump-to-draft-buffer})
1678 @findex wl-folder-check-current-entity
1679 Update new and unread number information of the folder at the current
1681 (@code{wl-folder-check-current-entity})
1685 @findex wl-folder-sync-current-entity
1686 Update summary information of the folder at the current cursor point.
1687 (@code{wl-folder-sync-current-entity})
1690 @kindex r s (Folder)
1691 @findex wl-folder-check-region
1692 Update new and unread number information of the folders in the currently
1694 (@code{wl-folder-check-region})
1697 @kindex r S (Folder)
1698 @findex wl-folder-sync-region
1699 Update summary information of the folders in the currently selected region.
1700 (@code{wl-folder-sync-region})
1704 @findex wl-status-update
1705 Sync up address book status with @file{~/.addresses}'s content.
1706 (@code{wl-status-update})
1710 @findex wl-folder-prev-unread
1711 Jump cursor to the folder which have unread messages on the upward from
1712 current cursor point.
1713 (@code{wl-folder-prev-unread})
1717 Jump cursor to the folder which have unread messages on the downward
1718 from current cursor point.
1719 (@code{wl-folder-next-unread})
1723 Move cursor to the folder on the previous line.
1724 (@code{wl-folder-prev-entity})
1728 Move cursor to the folder on the next line.
1729 (@code{wl-folder-next-entity})
1733 Jump to the folder specified by the user input.
1734 (@code{wl-folder-jump-folder})
1738 @findex wl-folder-prefetch-current-entity
1739 Prefetch new messages of the folder at the current cursor point by
1740 @code{wl-summary-incorporate}.
1741 If the cursor is on the folder group, it is executed recursively.
1742 (@code{wl-folder-prefetch-current-entity})
1746 @findex wl-folder-mark-as-read-all-current-entity
1747 Mark all unread messages of the folder at the current cursor point as read.
1748 If the cursor is on the folder group, it is executed recursively.
1749 (@code{wl-folder-mark-as-read-all-current-entity})
1753 @findex wl-folder-goto-first-unread-folder
1754 Enter summary mode of the first unread folder.
1755 (@code{wl-folder-goto-first-unread-folder})
1759 @findex wl-folder-empty-trash
1761 (@code{wl-folder-empty-trash})
1765 @findex wl-folder-open-all-unread-folder
1766 All unread folder is opened.
1767 (@code{wl-folder-open-all-unread-folder})
1771 @findex wl-folder-open-close
1772 Folder group is opened/closed.
1773 (@code{wl-thread-open-close})
1777 All folder group is opened.
1778 (@code{wl-folder-open-all})
1782 All folder group is closed.
1783 (@code{wl-folder-close-all})
1793 (@code{wl-folder-suspend})
1796 @kindex M-s (Folder)
1797 Save current folder status.
1801 @kindex M-t (Folder)
1802 Toggle Wanderlust's offline/online status.
1803 (@code{wl-toggle-plugged})
1806 @kindex C-t (Folder)
1807 Start Wanderlust's plug-status manager.
1808 (@code{wl-plugged-change})
1811 @subsection Customize variables
1814 @item wl-folders-file
1815 @vindex wl-folders-file
1816 The initial setting is @file{~/.folders}.
1817 Subscribed folders are described (saved) in this file.
1819 @item wl-folder-info-save
1820 @vindex wl-folder-info-save
1821 The initial setting is @code{t}. If non-nil, unread information is
1822 saved and used in the next Wanderlust session.
1824 @item wl-stay-folder-window
1825 @vindex wl-stay-folder-window
1826 The initial setting is @code{nil}.
1827 If non-nil, summary window is appeared on the right side of the folder buffer.
1829 @item wl-folder-window-width
1830 @vindex wl-folder-window-width
1831 The initial setting is 20.
1832 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1834 @item wl-folder-many-unsync-threshold
1835 @vindex wl-folder-many-unsync-threshold
1836 The initial setting is 70.
1837 If the number of unread messages is more than this value,
1838 folder color is changed.
1840 @item wl-highlight-folder-by-numbers
1841 @vindex wl-highlight-folder-by-numbers
1842 This option controls how to highlight each line in the folder buffer.
1843 The default value is @code{t}, highlighting with various colors based on
1844 the message numbers. If it is @code{nil}, highlighting with various
1845 colors based on the folder status. In addition, if it is a number
1846 (e.g. 1), highlighting will be done based on both the message numbers
1847 and the folder status.
1849 @item wl-folder-desktop-name
1850 @vindex wl-folder-desktop-name
1851 The initial setting is @samp{Desktop}.
1852 The name of top folder group.
1854 @item wl-folder-petname-alist
1855 @vindex wl-folder-petname-alist
1856 The initial setting is @code{nil}.
1857 An alist of folder's realname and its nickname.
1859 @item wl-folder-access-subscribe-alist
1860 @vindex wl-folder-access-subscribe-alist
1861 The initial setting is @code{nil}.
1863 Control automatic subscribing and unsubscribing of the children list
1869 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1873 If @var{subscribe-flag} is non-nil, folders which have name matched to
1874 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1875 already unsubscribed folder is not displayed even when the
1876 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1883 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1884 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1885 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1886 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1890 @item wl-folder-hierarchy-access-folders
1891 @vindex wl-folder-hierarchy-access-folders
1892 The initial setting is the list shown below:
1901 A list of access groups which creates children folder list hierarchically.
1903 For example, if you specify
1904 @code{wl-folder-hierarchy-access-folders} like following,
1908 (setq wl-folder-hierarchy-access-folders
1909 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1914 such access group hierarchy is obtained.
1920 -fj.comp.announce:0/0/2
1921 -fj.comp.dev.cdrom:0/0/0
1923 [+]-japan:238/238/1688
1926 -comp.unix.admin:0/0/0
1927 -comp.unix.dos-under-unix:0/0/0
1928 -comp.unix.programmer:0/0/0
1929 [-]-comp.unix.bsd:0/0/23
1930 -comp.unix.bsd.freebsd.announce:0/0/0
1935 If you opened @samp{-} in this example, only the direct children is created
1936 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1937 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1938 is not created until the children access group is opened.
1942 @node Folder Manager, , Selecting Folder, Folder
1943 @section Editing Folders
1944 @cindex Folder Manager
1945 @cindex Folder, Edit
1946 @cindex Folder, Subscribe
1947 @cindex Folder, Unsubscribe
1949 As described before, subscribed folder list is saved in @file{~/.folders} file.
1950 But you don't have to edit @file{~/.folders} directly.
1951 You can append, delete, edit folders from folder mode.
1953 @subsection Usage (Tips)
1955 @subsubsection Append Folder
1957 @kbd{m a} appends new folder to the folder mode.
1958 @kbd{m g} appends new folder group.
1959 To append new folder to this group, firstly open it,
1960 then execute append command in the next line.
1962 @subsubsection Edit Folder
1964 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1965 Thus, you can change folder position as if you were editing a normal file.
1967 @subsubsection Create Multi Folder.
1971 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
1973 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
1975 Type @kbd{m m}, then you can create multi folder.
1978 @subsubsection Delete Nickname, Filter
1980 You can delete nickname or filter by putting ``''(@var{NULL}) from the
1981 minibuffer while appending.
1983 @subsubsection Append Folder to Empty Group
1985 To append new folder to the empty folder group
1986 (after you create folder group by typing @kbd{m g}),
1987 firstly open it, then execute append command in the next line.
1988 If it is closed, folder is appended on the same level with
1989 the above folder group. It is difficult to explain by words so try it.
1990 In other words, appended position depends on the
1991 above folder group's open/close status.
1993 @subsubsection Charset of the Folders File.
1995 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
1997 @subsubsection Create Filter
1999 @kbd{m f} adds filter to the folder at the current cursor point. To
2000 create new filter folder and leave the current folder unchanged, copy it
2001 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2002 filter can be specified while appending filter. If you put
2003 ``''(@var{NULL}), filter is deleted.
2005 @subsubsection Sort Folders
2007 Sorting of the folders is executed by the function specified by
2008 @code{wl-fldmgr-sort-func}.
2009 The initial setting is @code{wl-fldmgr-sort-standard},
2010 which sorts alphabetically.
2011 Sorting affects only on the current folder group. It does not
2012 affect on the child groups.
2014 @subsubsection Hiding Folders in the Access Group
2016 Usually, access group displays all children folders, but you can set
2017 some folders hidden. Following operations are only available on access
2020 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2021 (subscribe/unsubscribe) of the folder at current cursor point. Against
2022 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2025 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2026 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2027 argument and if the argument has positive number, the unsubscribe it.
2028 If the prefix argument has negative value, folder becomes visible and if
2029 zero, folder visibility is toggled.
2031 The other commands, @code{wl-fldmgr-subscribe} and
2032 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2035 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2036 executed in the access group, they have a same effect with
2037 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2038 The difference is that cut commands deletes folders from the current
2041 @subsubsection Operations in the Access Group
2043 You can insert and delete folders in the access group like usual folder
2044 group. But insert and delete commands can be only available for the
2045 children folders of the access group and they only sets the subscribe
2046 status. In other words, insertion of the folder means subscribing,
2047 deletion means unsubscribing.
2048 @footnote{In the current implementation,
2049 it is faster to delete region than to unsubscribe region.}
2051 To update the access group when children folders are inserted or deleted
2052 by other way (other than Wanderlust),
2053 open the access group by typing @kbd{C-u @key{RET}}.
2054 @xref{Selecting Folder}.
2056 The order of children folders of access group is saved after
2057 insertion/deletion/sorting.
2058 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2059 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2060 newly created folders are inserted on the top of the access group.
2062 @subsection Key bindings
2063 @cindex Keybind, Folder Mode
2064 @cindex Keybind, Folder Buffer
2066 Key bindings on the folder mode related to folder editing are shown below.
2067 All bindings starts with @kbd{m}, and primary commands are binded to
2068 one stroke key binding.
2072 @kindex m a (Folder)
2073 @findex wl-fldmgr-add
2075 (@code{wl-fldmgr-add})
2080 @kindex m g (Folder)
2081 @findex wl-fldmgr-make-group
2082 Create a folder group.
2083 (@code{wl-fldmgr-make-group})
2086 @kindex m A (Folder)
2087 @findex wl-fldmgr-make-access-group
2088 Create an access group.
2089 (@code{wl-fldmgr-make-access-group})
2092 @kindex m d (Folder)
2093 @findex wl-fldmgr-delete
2094 Delete folder itself and msgdb.
2095 If the folder itself cannot be deleted like NNTP folder,
2096 only msgdb is deleted.
2097 (@code{wl-fldmgr-delete})
2102 @kindex m R (Folder)
2103 @findex wl-fldmgr-rename
2104 Change the name of folder or folder group.
2105 msgdb's path is also changed.
2106 (@code{wl-fldmgr-rename})
2112 @findex wl-fldmgr-make-multi
2113 Create a multi folders in the cutlist (cut, copied folders).
2114 (@code{wl-fldmgr-make-multi})
2119 @kindex m f (Folder)
2120 @findex wl-fldmgr-make-filter
2121 Create a filter folder. (Put a filter on the folder).
2122 (@code{wl-fldmgr-make-filter})
2126 @kindex M-c (Folder)
2127 @kindex m c (Folder)
2128 @findex wl-fldmgr-copy
2129 Copy folder (it is not available on folder group).
2130 (@code{wl-fldmgr-copy})
2134 @kindex M-w (Folder)
2135 @kindex m W (Folder)
2136 @findex wl-fldmgr-copy-region
2137 Copy folders in the specified region.
2138 (@code{wl-fldmgr-copy-region})
2142 @kindex C-k (Folder)
2143 @kindex m k (Folder)
2144 @findex wl-fldmgr-cut
2145 Cut folder. Folder itself is not deleted.
2146 (@code{wl-fldmgr-cut})
2150 @kindex C-w (Folder)
2151 @kindex m C-w (Folder)
2152 @findex wl-fldmgr-cut-region
2153 Cut folders in the specified region.
2154 (@code{wl-fldmgr-cut-region})
2158 @kindex C-y (Folder)
2159 @kindex m y (Folder)
2160 @findex wl-fldmgr-yank
2161 Paste folders that are copied or cut (folders in the cut-list).
2162 (@code{wl-fldmgr-yank})
2165 @kindex m p (Folder)
2166 @findex wl-fldmgr-set-petname
2167 Put nickname on the folder.
2168 (@code{wl-fldmgr-set-petname})
2171 @kindex m q (Folder)
2172 @findex wl-fldmgr-clear-cut-entity-list
2173 Clear the cut-list. (cut, copied folder information is cleared,
2174 you cannot paste after this)
2175 (@code{wl-fldmgr-clear-cut-entity-list})
2178 @kindex m s (Folder)
2179 @findex wl-fldmgr-sort
2180 Sort folders in the current folder group.
2181 (@code{wl-fldmgr-sort})
2184 @kindex m C-s (Folder)
2185 @findex wl-fldmgr-save
2186 Save current folder view to the @file{wl-folders-file}.
2187 (@code{wl-fldmgr-save})
2190 [Following commands are only available on the access groups]
2196 @kindex m u (Folder)
2197 @findex wl-fldmgr-unsubscribe
2198 Set the visibility of folder (subscribe/unsubscribe).
2199 (@code{wl-fldmgr-unsubscribe})
2204 @kindex r u (Folder)
2205 @findex wl-fldmgr-unsubscribe-region
2206 Set the visibility of the folders (subscribe/unsubscribe) in the
2208 (@code{wl-fldmgr-unsubscribe-region})
2213 @kindex m l (Folder)
2214 @findex wl-fldmgr-access-display-normal
2215 List folders that are currently available.
2216 (@code{wl-fldmgr-access-display-normal})
2221 @kindex m L (Folder)
2222 @findex wl-fldmgr-access-display-all
2223 List all folders regardless of the subscription status.
2224 (@code{wl-fldmgr-access-display-all})
2228 @subsection Customize variables
2231 @item wl-interactive-save-folders
2232 @vindex wl-interactive-save-folders
2233 The initial setting is @code{t}. If non-nil and folder view is
2234 modified, confirm saving it before Wanderlust or Emacs exits. If
2235 @code{nil}, save without confirmation.
2237 @item wl-fldmgr-make-backup
2238 @vindex wl-fldmgr-make-backup
2239 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2240 created before saving the folder status.
2242 @item wl-fldmgr-sort-func
2243 @vindex wl-fldmgr-sort-func
2244 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2245 sort folders. By default function, folders are sorted alphabetically
2246 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2249 @item wl-fldmgr-sort-group-first
2250 @vindex wl-fldmgr-sort-group-first
2251 The initial setting is @code{t}. If non-nil,
2252 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2253 does not care whether it is folder group or not.
2255 @item wl-folder-check-async
2256 @vindex wl-folder-check-async
2257 The initial setting is @code{t}. If non-nil, check folder's unread
2258 status asynchronously. It boosts newsgroup checking.
2260 @item wl-folder-check-fast
2261 @vindex wl-folder-check-fast
2262 The initial setting is @code{nil}.
2263 If non-nil, it does not update folder status while checking.
2265 @item wl-folder-notify-deleted
2266 @vindex wl-folder-notify-deleted
2267 The initial setting is @code{nil}.
2269 If non-nil, negative value is displayed when the message is deleted. If
2270 @code{sync}, folder is synchronized when the message is deleted. If
2271 @code{nil}, message deletion is ignored.
2274 @subsection Miscellanea
2276 Following is a note for folder editing.
2280 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2281 paste(yank) command pastes the folders on one cut or copy command
2282 (If copy command is executed by region, folders in the region are pasted
2283 by one paste command)
2286 You cannot cut @samp{Desktop} group.
2287 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2290 You cannot copy folder group.
2293 Operations on the access group are only available for the folders
2294 in the same access group.
2297 You cannot create a folder which has same name with the folders already exist.
2300 You cannot insert folders which have same name in one group.
2301 You can insert them in the different groups.
2302 You cannot put same nickname to the different folders.
2306 @node Summary, Message, Folder, Top
2307 @chapter Summary Mode
2309 After you select the folder via folder mode, you enter to the summary
2313 * Usage of Summary Mode:: TIPS.
2314 * Thread Operations:: Thread operations.
2315 * Cache:: File cache, Buffer cache, and Prefetch.
2316 * Auto Refile:: Auto refile settings.
2317 * Sticky Summary:: Summary make sticky.
2318 * Key Bindings of Summary:: Key bindings.
2319 * Variables of Summary:: Customize Summary Mode.
2323 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2324 @section Usage (Tips)
2326 @subsection Summary Content
2328 In the summary mode, messages are displayed like following.
2332 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2333 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2334 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2335 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2342 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2346 You cannot change this in the current version.
2348 @var{Message number} is the message's unique number in the folder. In
2349 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2350 in the MH folder, it is the filename of the message.
2352 @var{Temporal mark} and @var{Persistent mark} are described later.
2354 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2355 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2356 Japanese, but if you want to display it in English, set the value of
2357 @code{wl-summary-weekday-name-lang} as @samp{en}.
2359 @var{Sender}'s indentation corresponds to the depth of the thread.
2360 Sender name is displayed as nickname if it is defined in the address
2361 book. Set @code{wl-use-petname} as @samp{nil}, if you want to quit
2362 displaying with nickname.
2364 If number is printed at the head of @var{Sender} part like @samp{+2},
2365 that means the message have 2 follow messages.
2367 @var{Subject} is the @samp{Subject:} header field of the message. If
2368 the message have same @samp{Subject:} with the parent message, it is not
2369 displayed. Some mailing list puts its sequence number in the
2370 @samp{Subject:} field, but it is
2371 ignored. @code{wl-summary-no-subject-message} is displayed when the
2372 message has empty subject field.
2374 @subsection Temporary Marks
2375 @cindex Mark, Temporary
2377 There are four temporary marks,
2378 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2379 Temporary marks indicates message operations.
2384 You can execute a command on the all messages that have @samp{*} mark,
2385 with the key bindings which begins with @kbd{m}.
2388 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2392 After you type @kbd{o} key, prompt appears to input refile destination.
2393 Your answer is printed in the summary line.
2397 You can put this mark by typing @kbd{O} key.
2398 The difference between this mark and refile mark is,
2399 this mark does not delete the message while latter does.
2402 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2404 @subsection Persistent Marks
2406 There are five persistent marks,
2407 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2409 The persistent mark indicates the message's status and it is saved.
2410 Each persistent mark indicates:
2416 It is unread message.
2418 It is unread but cached message.
2420 It is read but it is not cached.
2422 It is important message. You can put @samp{$} mark by typing @kbd{$}
2423 key (if already exists, the mark is deleted). It is convenient to put
2424 this mark on the messages to remember (If you want to remember to write
2425 a reply for the message, for example) because this mark remains after
2426 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2427 even the message itself is deleted in the actual folder.
2430 If the message is read and cached (or local message),there are no
2434 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2435 cache. Messages with the marks other than these, you can read them in
2436 the offline status even they are in the IMAP folder or netnews folder.
2438 @subsection How To Read
2440 Basically, you can read messages only typing space key again and again.
2442 To update summary status to the newest status (synchronize),
2445 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2446 moves cursor to the next message.
2447 Enter message buffer by typing @kbd{j} key.
2448 To operate multipart, you have to enter to the message buffer.
2451 @subsection Pack the Message Numbers
2452 You can pack the message numbers in Summary by
2453 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2454 News Spool Folder and Maildir Folder are supported folder types.
2457 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2458 @section Thread Operations
2460 For example, the following line indicates one thread (a context of a topic).
2463 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2467 If you type @kbd{/} on this line, the thread is opened and it changes
2468 the appearance like following.
2472 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2473 388 09/17(Thu)22:34 +-[ Murata san ]
2477 (Message 388 is the replied message to the message 384.)
2478 If you type @kbd{/} key once again, the thread is closed.
2479 With prefix argument, @kbd{/} opens all children threads.
2481 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2484 Commands with the key binding that begins with @kbd{t} executes commands
2485 on the messages in the thread.
2486 @xref{Key Bindings of Summary}.
2488 @subsection reconstruct thread by hand
2490 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2491 (@code{wl-summary-save-current-message}) at the corresponding message,
2492 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2493 message then you have the reconstructed thread.
2496 @node Cache, Auto Refile, Thread Operations, Summary
2499 @subsection Cache File
2501 The messages which have to access via network (e.x. IMAP, NNTP folder)
2502 are cached as a local file. The cache file is saved under the directory
2503 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2504 elmo-cache-expire-by-size}. The command deletes cache files to the
2505 specified size by the order of last accessed time.
2507 @subsection Buffer Cache and Prefetching
2509 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2510 that are read are kept in the cache buffer. It is called `buffer
2511 cache'. The number of cache buffer is specified by
2512 @code{elmo-buffer-cache-size}.
2514 There are message prefetching mechanism in the Wanderlust that
2515 prefetches next message while you are reading. This function requires
2516 that the value of @code{elmo-use-buffer-cache} is non-nil.
2518 You can control the message prefetching mechanism by these two
2522 @item wl-cache-prefetch-folder-type-list
2523 @vindex wl-cache-prefetch-folder-type-list
2524 The initial setting is the list shown below:
2532 It specifies the folder types in which message prefetching is enabled.
2533 In the initial setting, multi folder that contains localdir and imap4
2534 prefetches only imap4 messages. This variable precedes the value of
2535 @code{wl-cache-prefetch-folder-list}.
2537 If you want to prefetch localdir and localnews also, following setting
2542 (setq wl-cache-prefetch-folder-type-list
2543 '(nntp imap4 localdir localnews))
2547 @item wl-cache-prefetch-folder-list
2548 @vindex wl-cache-prefetch-folder-list
2549 The initial setting is @code{nil}.
2550 A list of regexp of folders to enable message prefetching.
2554 @node Auto Refile, Sticky Summary, Cache, Summary
2555 @section Auto Refile
2556 @vindex elmo-msgdb-extra-fields
2557 @vindex wl-refile-rule-alist
2558 @findex wl-summary-auto-refile
2560 You can refile messages automatically, by typing @kbd{C-o}
2561 (@code{wl-summary-auto-refile}). It decides destination of refile by
2562 the content of the message header information (information in the msgdb).
2564 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2565 available. If you want to decide destination by other header fields,
2566 set the variable @code{elmo-msgdb-extra-fields} like following.
2570 (setq elmo-msgdb-extra-fields
2580 By this setting, Wanderlust saves extra fields in the msgdb. You have
2581 to type @kbd{s all} to get extra fields for the messages that are
2582 already exists in the summary.
2584 Then, specify the refile rule. The refile target folder of auto
2585 refiling is decided by the value of @code{wl-refile-rule-alist}.
2586 @code{wl-refile-rule-alist} is a list of a rule:
2590 (@var{field} (@var{regexp} . @var{target})
2591 (@var{regexp} . @var{target})
2596 Each rule means `if @var{field} value matches @var{regexp},
2597 then refile to @var{target} folder'.
2598 The rule matched first is applied.
2600 @var{field} is a string of field name. You can specify a list of field name
2601 string, too. In this case, if one of these fields is matched, then the
2602 rule is fired (i.e. OR condition).
2604 @var{regexp} is a regular expression for field value. @var{target} is a target
2605 folder string. You can specify a rule at @var{target} part, too. In this
2606 case, If the field value of the rule and the current rule is matched,
2607 then the current rule is fired (i.e. AND condition).
2609 In @var{target} part, you can refer matched substring of @var{regexp}.
2610 To refer substring, specify following in @var{target}:
2614 means substitute original matched text.
2617 means substitute what matched the @var{N}th `\(@dots{}\)'.
2618 (@var{N} is a number.)
2621 Following is an example of @code{wl-refile-rule-alist}.
2625 (setq wl-refile-rule-alist
2627 ("^Wanderlust" . "+wl")
2628 ("^Elisp" . "+elisp"))
2630 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2632 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2633 "+from-me-to-you"))))))
2637 After these settings, refile marks are automatically put on the condition
2638 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2640 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2642 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2643 with these persistent marks are not automatically refiled.
2644 It means Wanderlust does not execute auto refile on unread messages by
2645 the default setting.
2646 To execute auto refile on all messages, set following.
2649 (setq wl-summary-auto-refile-skip-marks nil)
2653 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2654 @section Sticky Summary
2655 @cindex Summary, Sticky
2656 @cindex Sticky Summary
2658 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2660 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2661 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2663 The buffer name of the sticky summary becomes like
2664 @samp{Summary:@var{folder-name}}.
2666 You can visit the sticky summary at any time by @kbd{C-x b}
2667 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2668 q}. Other operations in the sticky summary are same as normal summary.
2670 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2671 are automatically sticked.
2674 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2675 @section Key bindings
2676 @cindex Keybind, Summary Mode
2677 @cindex Keybind, Summary Buffer
2679 Key bindings of the summary mode are shown below.
2683 @kindex @key{SPC} (Summary)
2684 @findex wl-summary-read
2685 Proceed reading a message at the current cursor point.
2686 (@code{wl-summary-read})
2690 @findex wl-summary-redisplay
2691 Redisplay a message at the current cursor point.
2692 If this command is called with prefix argument,
2693 Redisplay message regardless of the message cache (message is re-loaded
2695 (@code{wl-summary-redisplay})
2699 @findex wl-summary-display-top
2700 Display the top message in the folder.
2701 (@code{wl-summary-display-top})
2705 @findex wl-summary-display-bottom
2706 Display the bottom message in the folder.
2707 (@code{wl-summary-display-bottom})
2711 @kindex @key{BS} (Summary)
2712 @kindex @key{DEL} (Summary)
2713 Display the previous page of the message at the current cursor point.
2714 @findex wl-summary-prev-page
2715 (@code{wl-summary-prev-page})
2718 @kindex @key{RET} (Summary)
2719 @findex wl-summary-next-line-content
2720 Display the next line of the message at the current cursor point.
2721 Display the message at the current cursor point if it is not displayed yet.
2722 (@code{wl-summary-next-line-content})
2727 @kindex M-@key{RET} (Summary)
2728 @findex wl-summary-prev-line-content
2729 Display the previous line of the message at the current cursor point.
2730 Display the message at the current cursor point if it is not displayed yet.
2731 (@code{wl-summary-prev-line-content})
2735 @findex wl-thread-open-close
2736 Toggle open or close the thread at the current cursor point.
2737 (@code{wl-thread-open-close})
2742 @findex wl-thread-open-all
2743 (@code{wl-thread-open-all})
2748 @findex wl-thread-close-all
2749 (@code{wl-thread-close-all})
2753 @findex wl-summary-goto-folder
2755 (@code{wl-summary-goto-folder})
2759 Mark all messages in the folder as read.
2760 @findex wl-summary-mark-as-read-all
2761 (@code{wl-summary-mark-as-read-all})
2765 @findex wl-summary-reply
2766 Prepare a draft for reply the message at the current cursor point.
2767 (@code{wl-summary-reply})
2771 @findex wl-summary-reply-with-citation
2772 Prepare a draft for reply the message at the current cursor point.
2773 (@code{wl-summary-reply-with-citation})
2777 @findex wl-summary-cancel-message
2778 If the message at current cursor point is your own netnews article,
2780 (@code{wl-summary-cancel-message})
2784 @findex wl-summary-reedit
2785 Prepare a draft for re-editing the message at current cursor point.
2786 If the message at current cursor point is your own netnews article,
2787 a draft for `supersedes message' for the message is prepared.
2788 (@code{wl-summary-reedit})
2791 @kindex M-e (Summary)
2792 @findex wl-summary-resend-bounced-mail
2793 If the message at current cursor point is a bounced message,
2794 a draft for re-sending original message is prepared.
2795 (@code{wl-summary-resend-bounced-mail})
2799 @findex wl-summary-forward
2800 A draft for forwarding the message at current cursor point is prepared.
2801 (@code{wl-summary-forward})
2805 @findex wl-summary-mark-as-important
2806 Put @samp{$} mark on the message at current cursor point.
2807 If already marked as @samp{$}, delete it.
2808 (@code{wl-summary-mark-as-important})
2814 Save the message at current cursor point.
2815 @findex wl-summary-save
2816 (@code{wl-summary-save})
2820 @findex wl-summary-next
2821 Move cursor to the next message.
2822 If message is marked with a temporal mark in
2823 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2824 In the offline mode, cursor is not moved to the messages which are not cached
2826 (@code{wl-summary-next})
2830 @findex wl-summary-prev
2831 Move cursor to the previous message.
2832 If message is marked with a temporal mark in
2833 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2834 In the offline mode, cursor is not moved to the messages which are not cached
2836 (@code{wl-summary-prev})
2840 @findex wl-summary-down
2841 Move cursor to the downward message which is unread or marked
2843 In the offline mode, cursor is not moved to the messages which are not cached
2845 If there are messages which have target mark @samp{*} in the summary,
2846 cursor is moved to the downward message which have a target mark.
2847 This behavior is changed according to the value of @code{wl-summary-move-order}.
2848 (@code{wl-summary-down})
2852 @findex wl-summary-up
2853 Move cursor to the upward message which is unread or marked
2855 In the offline mode, cursor is not moved to the messages which are not cached
2857 If there are messages which have target mark @samp{*} in the summary,
2858 cursor is moved to the downward message which have a target mark.
2859 This behavior is changed according to the value of @code{wl-summary-move-order}.
2860 (@code{wl-summary-up})
2864 @findex wl-summary-write
2865 Prepare a new draft.
2866 (@code{wl-summary-write})
2870 @findex wl-summary-write-current-folder
2871 Prepare a new draft. If the current folder is NNTP folder,
2872 @samp{Newsgroups:} field is completed. If the current folder is mailing
2873 list folder (refile destination), guess @samp{To:} field and completed
2874 (If @code{wl-subscribed-mailing-list} is valid list)
2875 (@code{wl-summary-write-current-folder})
2879 @findex wl-summary-redisplay-all-header
2880 Redisplay the message at current cursor point with all header fields.
2881 (@code{wl-summary-redisplay-all-header})
2885 @findex wl-summary-redisplay-no-mime
2886 Redisplay the message at current cursor point without MIME analysis.
2887 (@code{wl-summary-redisplay-no-mime})
2891 @findex wl-summary-burst
2892 If the message at current cursor point has
2893 encapsulates multiple messages using MIME,
2894 de-capsulate and extract them on the current folder.
2895 (@code{wl-summary-burst})
2898 @kindex @@ (Summary)
2899 @findex wl-summary-edit-addresses
2900 Append/change/delete the message's sender information to the address
2901 book @file{~/.addresses} interactively. If this command is called with
2902 prefix argument, arbitrary address can be edited.
2903 (@code{wl-summary-edit-petname})
2907 @findex wl-status-update
2908 Sync up address book status with @file{~/.addresses}'s content.
2909 (@code{wl-status-update})
2913 @findex wl-summary-pipe-message
2914 Pipe current message's content to the external process.
2915 (@code{wl-summary-pipe-message})
2919 @findex wl-summary-print-message
2920 Print out current message's content.
2921 It uses @code{ps-print} module in Emacs 20.x.
2922 If you don't use color printer, you might want to set
2923 @code{wl-ps-print-buffer-func} to @code{ps-print-buffer}.
2926 (setq wl-ps-print-buffer-func 'ps-print-buffer)
2929 (@code{wl-summary-print-message})
2933 @findex wl-summary-exit
2934 Exit current folder.
2935 (@code{wl-summary-exit})
2939 @findex wl-summary-jump-to-current-message
2940 Jump cursor to the currently displayed message's window.
2941 (@code{wl-summary-jump-to-current-message})
2945 Jump cursor to the other message.
2946 @findex wl-summary-jump-to-msg
2947 (@code{wl-summary-jump-to-msg})
2951 Update summary status and
2952 prefetch all messages which have marks included in the
2953 @code{wl-summary-incorporate-marks}.
2954 @findex wl-summary-incorporate
2955 (@code{wl-summary-incorporate})
2958 @kindex M-j (Summary)
2959 @findex wl-summary-jump-to-msg-by-message-id
2960 Jump cursor to the message which have specified @samp{Message-Id:}. If
2961 @code{elmo-use-database} is non-nil, other folder is also searched.
2962 (@code{wl-summary-jump-to-msg-by-message-id})
2966 Jump to parent message.
2967 @findex wl-summary-jump-to-parent-message
2968 (@code{wl-summary-jump-to-parent-message})
2972 @findex wl-summary-mark-as-unread
2973 Mark as unread the message at current cursor point.
2974 (@code{wl-summary-mark-as-unread})
2978 @findex wl-summary-sync
2979 Synchronize summary view after prompting the update range
2980 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
2984 all ...Discard current summary and update all message.
2985 update ...Update the difference between summary and the folder itself.
2986 rescan ...Rescan the msgdb and display again.
2987 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2988 first, last ...Move to the filter folder(partial filter).
2993 (@code{wl-summary-sync})
2997 @findex wl-summary-sort
2999 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3000 (@code{wl-summary-sort})
3004 @findex wl-summary-toggle-thread
3005 Toggle the threading.
3006 Threading status is displayed on the modeline.
3007 @samp{@{S@}} means threading is off (Sequence) and
3008 @samp{@{T@}} means threading is on (Thread).
3009 (@code{wl-summary-toggle-thread})
3013 @findex wl-summary-toggle-disp-folder
3014 Toggle displaying of folder window.
3015 (@code{wl-summary-toggle-disp-folder})
3019 Toggle displaying of message window.
3020 @findex wl-summary-toggle-disp-msg
3021 (@code{wl-summary-toggle-disp-msg})
3025 Move to the virtual folder with the condition specified.
3026 If called with prefix argument and current folder is virtual, exit it.
3027 @findex wl-summary-virtual
3028 (@code{wl-summary-virtual})
3031 @kindex @key{TAB} (Summary)
3032 @findex wl-summary-goto-last-displayed-msg
3033 Jump to the message which is displayed last.
3034 (@code{wl-summary-goto-last-displayed-msg})
3038 Put @samp{*} mark on the messages that satisfies the specified condition.
3039 @findex wl-summary-pick
3040 (@code{wl-summary-pick})
3044 @findex wl-summary-mark-as-read
3045 Mark as read the message at the current cursor point.
3046 (@code{wl-summary-mark-as-read})
3050 Prefetch the message at the current cursor point.
3051 With prefix argument, prefetch the message even if it is cached.
3052 @findex wl-summary-prefetch
3053 (@code{wl-summary-prefetch})
3057 Execute @samp{D}, @samp{o} and @samp{O} marks.
3058 @findex wl-summary-exec
3059 (@code{wl-summary-exec})
3063 @findex wl-summary-target-mark-line
3064 Put target mark on the message at the current cursor point.
3065 (@code{wl-summary-target-mark-line})
3069 Put refile mark on the message at the current cursor point.
3070 @findex wl-summary-refile
3071 (@code{wl-summary-refile})
3074 @kindex C-o (Summary)
3075 Execute auto refile.
3076 @findex wl-summary-auto-refile
3077 (@code{wl-summary-auto-refile})
3081 Put copy mark on the message at the current cursor point.
3082 @findex wl-summary-copy
3083 (@code{wl-summary-copy})
3086 @kindex M-o (Summary)
3087 Put refile mark on the message at the current cursor point with the destination
3088 previously specified.
3089 @findex wl-summary-refile-prev-destination
3090 (@code{wl-summary-refile-prev-destination})
3094 @findex wl-summary-delete
3095 Put delete mark on the message at the current cursor point.
3096 (@code{wl-summary-delete})
3100 @findex wl-summary-unmark
3101 Unmark the temporal mark on the message at the current cursor point.
3102 (@code{wl-summary-unmark})
3106 Unmark all the temporal marks.
3107 @findex wl-summary-unmark-all
3108 (@code{wl-summary-unmark-all})
3111 @kindex r R (Summary)
3112 @findex wl-summary-mark-as-read-region
3113 Mark as read messages in the specified region.
3114 (@code{wl-summary-mark-as-read-region})
3117 @kindex r $ (Summary)
3118 @findex wl-summary-mark-as-important-region
3119 Mark as important @samp{$} messages in the specified region.
3120 If @samp{$} already exists, it is deleted.
3121 (@code{wl-summary-mark-as-important-region})
3124 @kindex r ! (Summary)
3125 @findex wl-summary-mark-as-unread-region
3126 Mark as unread messages in the specified region.
3127 (@code{wl-summary-mark-as-unread-region})
3130 @kindex r i (Summary)
3131 @findex wl-summary-prefetch-region
3132 Prefetch messages in the specified region.
3133 (@code{wl-summary-prefetch-region})
3136 @kindex r x (Summary)
3137 @findex wl-summary-exec-region
3138 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3140 (@code{wl-summary-exec-region})
3143 @kindex r * (Summary)
3144 @findex wl-summary-target-mark-region
3145 Put target mark on the messages in the specified region.
3146 (@code{wl-summary-target-mark-region})
3149 @kindex r o (Summary)
3150 @findex wl-summary-refile-region
3151 Put refile mark on the messages in the specified region.
3152 (@code{wl-summary-refile-region})
3155 @kindex r O (Summary)
3156 @findex wl-summary-copy-region
3157 Put copy mark on the messages in the specified region.
3158 (@code{wl-summary-copy-region})
3161 @kindex r d (Summary)
3162 @findex wl-summary-delete-region
3163 Put delete mark on the messages in the specified region.
3164 (@code{wl-summary-delete-region})
3167 @kindex r u (Summary)
3168 @findex wl-summary-unmark-region
3169 Delete temporal mark on the messages in the specified region.
3170 (@code{wl-summary-unmark-region})
3173 @kindex r y (Summary)
3174 Save messages in the specified region.
3175 @findex wl-summary-save-region
3176 (@code{wl-summary-save-region})
3179 @kindex t R (Summary)
3180 @findex wl-thread-mark-as-read
3181 Mark as read messages which are the descendant of the current thread.
3182 With prefix argument, it affects on the all messages in the thread tree.
3183 (@code{wl-thread-mark-as-read})
3186 @kindex t $ (Summary)
3187 @findex wl-thread-mark-as-important
3188 Put important mark @samp{$} on the messages which are the
3189 descendant of the current thread.
3190 If @samp{$} mark exists, it is deleted.
3191 With prefix argument, it affects on the all messages in the thread tree.
3192 (@code{wl-thread-mark-as-important})
3195 @kindex t ! (Summary)
3196 @findex wl-thread-mark-as-unread
3197 Mark as unread messages which are the descendant of the current thread.
3198 With prefix argument, it affects on the all messages in the thread tree.
3199 (@code{wl-thread-mark-as-unread})
3202 @kindex t i (Summary)
3203 @findex wl-thread-prefetch
3204 Prefetch messages which are the descendant of the current thread.
3205 With prefix argument, it affects on the all messages in the thread tree.
3206 (@code{wl-thread-prefetch})
3209 @kindex t x (Summary)
3210 @findex wl-thread-exec
3211 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3212 the descendant of the current thread. With prefix argument, it affects
3213 on the all messages in the thread tree.
3214 (@code{wl-thread-exec})
3217 @kindex t * (Summary)
3218 @findex wl-thread-target-mark
3219 Put target mark @samp{*} on the messages which are the descendant of the
3220 current thread. With prefix argument, it affects on the all messages in
3222 (@code{wl-thread-target-mark})
3225 @kindex t o (Summary)
3226 @findex wl-thread-refile
3227 Put refile mark on the messages which are the descendant of the current thread.
3228 With prefix argument, it affects on the all messages in the thread tree.
3229 (@code{wl-thread-refile})
3232 @kindex t O (Summary)
3233 @findex wl-thread-copy
3234 Put copy mark on the messages which are the descendant of the current thread.
3235 With prefix argument, it affects on the all messages in the thread tree.
3236 (@code{wl-thread-copy})
3239 @kindex t d (Summary)
3240 @findex wl-thread-delete
3241 Put delete mar on the messages which are the descendant of the current thread.
3242 With prefix argument, it affects on the all messages in the thread tree.
3243 (@code{wl-thread-delete})
3246 @kindex t u (Summary)
3247 @findex wl-thread-unmark
3248 Unmark temporal mark on the messages which are the descendant of the
3249 current thread. With prefix argument, it affects on the all messages in
3251 (@code{wl-thread-unmark})
3254 @kindex t y (Summary)
3255 @findex wl-thread-save
3256 Save messages which are the descendant of the current thread.
3257 With prefix argument, it affects on the all messages in the thread tree.
3258 (@code{wl-thread-save})
3261 @kindex m i (Summary)
3262 @findex wl-summary-target-mark-prefetch
3263 Prefetch all messages which have target mark @samp{*}.
3264 (@code{wl-summary-target-mark-prefetch})
3267 @kindex m R (Summary)
3268 @findex wl-summary-target-mark-mark-as-read
3269 Mark as read all messages which have target mark @samp{*}.
3270 (@code{wl-summary-target-mark-mark-as-read})
3273 @kindex m $ (Summary)
3274 @findex wl-summary-target-mark-mark-as-important
3275 Mark as important all messages which have target mark @samp{*}.
3276 If already marked as @samp{$}, it is deleted.
3277 (@code{wl-summary-target-mark-mark-as-important})
3280 @kindex m ! (Summary)
3281 @findex wl-summary-target-mark-mark-as-unread
3282 Mark as unread all messages which have target mark @samp{*}.
3283 (@code{wl-summary-target-mark-mark-as-unread})
3286 @kindex m o (Summary)
3287 @findex wl-summary-target-mark-refile
3288 Put refile mark on the messages which have target mark @samp{*}.
3289 (@code{wl-summary-target-mark-refile})
3292 @kindex m O (Summary)
3293 @findex wl-summary-target-mark-copy
3294 Put copy mark on the messages which have target mark @samp{*}.
3295 (@code{wl-summary-target-mark-copy})
3298 @kindex m d (Summary)
3299 @findex wl-summary-target-mark-delete
3300 Put delete mark on the messages which have target mark @samp{*}.
3301 (@code{wl-summary-target-mark-delete})
3304 @kindex m y (Summary)
3305 @findex wl-summary-target-mark-save
3306 Save messages which have target mark @samp{*}.
3307 (@code{wl-summary-target-mark-save})
3310 @kindex m u (Summary)
3311 Unmark all temporal marks.
3312 (@code{wl-summary-delete-all-temp-marks})
3313 @findex wl-summary-delete-all-temp-marks
3316 @kindex m a (Summary)
3317 Put target mark @samp{*} on the all messages.
3318 (@code{wl-summary-target-mark-all})
3319 @findex wl-summary-target-mark-all
3322 @kindex m t (Summary)
3323 Put target mark @samp{*} on the messages in the current thread.
3324 @findex wl-summary-target-mark-thread
3325 (@code{wl-summary-target-mark-thread})
3328 @kindex m r (Summary)
3329 @findex wl-summary-target-mark-region
3330 Put target mark @samp{*} on the messages in the specified region.
3331 (@code{wl-summary-target-mark-region})
3334 @kindex m A (Summary)
3335 @findex wl-summary-target-mark-reply-with-citation
3336 Prepare a draft which cites all messages which have target mark @samp{*}.
3337 (@code{wl-summary-target-mark-reply-with-citation})
3340 @kindex m f (Summary)
3341 @findex wl-summary-target-mark-forward
3342 Prepare a draft which forwards all messages which have target mark @samp{*}.
3343 (@code{wl-summary-target-mark-forward})
3346 @kindex m U (Summary)
3347 @findex wl-summary-target-mark-uudecode
3348 Uudecode the messages which have target mark @samp{*}.
3349 (@code{wl-summary-target-mark-uudecode})
3352 @kindex m ? (Summary)
3353 @findex wl-summary-target-mark-pick
3354 Pick messages from the @samp{*} marked messages.
3355 That is, @samp{*} marks on the messages are remained
3356 if the specified condition is satisfied.
3357 (@code{wl-summary-target-mark-pick})
3360 @kindex M-t (Summary)
3361 @findex wl-toggle-plugged
3362 Toggle offline/online status of Wanderlust.
3363 (@code{wl-toggle-plugged})
3366 @kindex C-t (Summary)
3367 Start Wanderlust's plug-status manager.
3368 (@code{wl-plugged-change})
3371 @kindex C-c C-o (Summary)
3372 @findex wl-jump-to-draft-buffer
3373 Move to the draft buffer if available. If multiple draft buffer exists,
3374 moved to one after another. If prefix argument is specified, load draft
3375 folder's message to the draft buffer and jump to it.
3376 (@code{wl-jump-to-draft-buffer})
3379 @kindex M-w (Summary)
3380 @findex wl-summary-save-current-message
3381 Save the message at the current cursor point.
3382 (@code{wl-summary-save-current-message})
3385 @kindex C-y (Summary)
3386 @findex wl-summary-yank-saved-message
3387 Regard the message at the current cursor point as
3388 parent, connect the message saved by
3389 @code{wl-summary-save-current-message}
3391 (@code{wl-summary-yank-saved-message})
3395 @node Variables of Summary, , Key Bindings of Summary, Summary
3396 @section Customiziable variables
3399 @item wl-summary-move-order
3400 @vindex wl-summary-move-order
3401 The initial setting is @code{unread}. Specify cursor moving policy. If
3402 you want to precede new messages, set @code{new}. If you want to
3403 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3406 @item wl-auto-select-first
3407 @vindex wl-auto-select-first
3408 The initial setting is @code{nil}.
3409 If non-nil, first message is automatically displayed.
3411 @item wl-auto-select-next
3412 @vindex wl-auto-select-next
3413 The initial setting is @code{nil}. If non-nil, jump to next summary
3414 automatically. If @code{unread}, jump to next unread folder's summary
3415 after confirmation. If @code{skip-no-unread}, unread folders are
3416 automatically skipped.
3418 @item wl-thread-insert-opened
3419 @vindex wl-thread-insert-opened
3420 The initial setting is @code{nil}.
3421 If non-nil, thread is inserted as opened.
3423 @item wl-thread-open-reading-thread
3424 @vindex wl-thread-open-reading-thread
3425 The initial setting is @code{t}. If non-nil, reading thread is
3426 automatically opened though it is closed thread.
3428 @item wl-summary-exit-next-move
3429 @vindex wl-summary-exit-next-move
3430 The initial setting is @code{t}. If non-nil, move to next folder at
3433 @item wl-folder-move-cur-folder
3434 @vindex wl-folder-move-cur-folder
3435 The initial setting is @code{nil}. If non-nil, cursor position on the
3438 @item wl-summary-weekday-name-lang
3439 @vindex wl-summary-weekday-name-lang
3440 The initial setting is @samp{ja}. Specify language of the weekday.
3441 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3444 @item wl-summary-fix-timezone
3445 @vindex wl-summary-fix-timezone
3446 The initial setting is @samp{JST}. Timezone to adjust summary's
3447 timezone. If @code{nil}, adjust to GMT.
3449 @item wl-use-petname
3450 @vindex wl-use-petname
3451 The initial setting is @code{t}.
3452 If non-nil, sender part displays nickname.
3454 @item wl-break-pages
3455 @vindex wl-break-pages
3456 The initial setting is @code{t}.
3457 If non-nil, message is splitted as pages by @samp{^L}.
3459 @item wl-message-window-size
3460 @vindex wl-message-window-size
3461 The initial setting is '(1 . 4).
3462 A cons cell to specify the rate of summary and message window.
3463 car:cdr corresponds summary:message.
3465 @item wl-summary-recenter
3466 @vindex wl-summary-recenter
3467 The initial setting is t.
3468 If non-nil, cursor point is moved to the center of the summary window.
3470 @item wl-summary-indent-length-limit
3471 @vindex wl-summary-indent-length-limit
3472 The initial setting is 46.
3473 Specify the limit of thread indent level.
3474 If nil, max indent level is unlimited.
3476 @item wl-summary-no-from-message
3477 @vindex wl-summary-no-from-message
3478 The initial setting is @samp{nobody@@nowhere?}. A string which is
3479 displayed when there's no @samp{From:} field in the message.
3481 @item wl-summary-no-subject-message
3482 @vindex wl-summary-no-subject-message
3483 The initial setting is @samp{(WL:No Subject in original.)}. A string
3484 which is displayed when there's no @samp{Subject:} field in the message.
3486 @item wl-summary-width
3487 @vindex wl-summary-width
3488 The initial setting is 80.
3489 Width of summary line. If @code{nil}, summary line's width is as is.
3491 @item wl-use-folder-petname
3492 @vindex wl-use-folder-petname
3493 The initial setting is the list shown below:
3502 A list of display policy (symbol) of folder nickname. Available symbols
3507 Display folder petname on modeline.
3509 Destination folder is notified as nickname if
3510 @code{wl-auto-select-next} is non-nil.
3512 You can input folder name by nickname in the function
3513 @code{wl-summary-read-folder}.
3516 @item wl-summary-move-direction-toggle
3517 @vindex wl-summary-move-direction-toggle
3518 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3519 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3520 want to aware of reading direction, set this to @code{t}.
3523 @vindex wl-from-width
3524 The initial setting is 17.
3525 Width of sender part of summary line.
3527 @item wl-summary-divide-thread-when-subject-changed
3528 @vindex wl-summary-divide-thread-when-subject-changed
3529 The initial setting is @code{nil}. If non-nil, thread is splitted if
3530 the subject is changed.
3532 @item wl-summary-search-via-nntp
3533 @vindex wl-summary-search-via-nntp
3534 The initial setting is @code{confirm}.
3536 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3537 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3538 from the NNTP server @code{elmo-default-nntp-server}. The value of
3539 @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
3540 @code{elmo-default-nntp-stream-type} are used.
3542 If @code{confirm}, server name can be specified. You can specify NNTP
3543 folder format like @samp{-:username@@servername:119!}.
3545 @item wl-summary-keep-cursor-command
3546 @vindex wl-summary-keep-cursor-command
3547 The initial setting is the list shown below:
3551 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3556 When you entered to summary by these commands and the target summary
3557 buffer already exists, summary status is not automatically updated and
3558 cursor position is saved.
3560 @item wl-summary-update-confirm-threshold
3561 @vindex wl-summary-update-confirm-threshold
3562 The initial setting is 500. If updated message number is larger than
3563 this value, confirm whether drop them or not.
3565 @item wl-summary-always-sticky-folder-list
3566 @vindex wl-summary-always-sticky-folder-list
3567 The initial setting is @code{nil}.
3568 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3569 are automatically sticked. Each element is regexp of folder name.
3571 @item wl-summary-reserve-mark-list
3572 @vindex wl-summary-reserve-mark-list
3573 The initial setting is the list shown below:
3582 If a message is already marked as temporal marks in this list, the
3583 message is not marked by any mark command.
3585 @item wl-summary-skip-mark-list
3586 @vindex wl-summary-skip-mark-list
3587 The initial setting is the list shown below:
3596 If a message is already marked as temporal marks in this list, the
3597 message is skipped at cursor move.
3599 @item wl-fetch-confirm-threshold
3600 @vindex wl-fetch-confirm-threshold
3601 The initial setting is 30000 (bytes). If displaying message has larger
3602 size than this value, Wanderlust confirms whether fetch the message or
3603 not. If @code{nil}, the message is fetched without confirmation.
3605 @item wl-prefetch-threshold
3606 @vindex wl-prefetch-threshold
3607 The initial setting is 30000 (bytes). If prefetching message has larger
3608 size than this value and @code{wl-prefetch-confirm} is non-nil,
3609 Wanderlust confirms whether prefetch the message or not. If
3610 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3611 without confirmation.
3613 @item wl-prefetch-confirm
3614 @vindex wl-prefetch-confirm
3615 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3616 prefetch the message or not if the message has larger size than
3617 @code{wl-prefetch-threshold}.
3619 @item wl-cache-fetch-threshold
3620 @vindex wl-cache-fetch-threshold
3621 The initial setting is 30000 (bytes). The messages which have larger
3622 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3623 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3626 @item elmo-imap4-use-cache
3627 @vindex elmo-imap4-use-cache
3628 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3631 @item elmo-nntp-use-cache
3632 @vindex elmo-nntp-use-cache
3633 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3636 @item elmo-pop3-use-cache
3637 @vindex elmo-pop3-use-cache
3638 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3643 @node Message, Draft, Summary, Top
3644 @chapter Message Buffer
3646 Message Buffers utilize MIME-View mode of SEMI/tm. For operational
3647 procedures and key bindings, refer to respective documents.
3648 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3650 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3651 brings you back to Summary mode. @kbd{l} toggles display of Summary
3654 @section Key Bindings
3660 @findex wl-message-toggle-disp-summary
3661 Toggles display of Summary mode buffer.
3662 (@code{wl-message-toggle-disp-summary})
3665 @findex wl-message-refer-article-or-url
3666 @kindex Button-2 (Message)
3667 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3668 corresponding message if found.
3669 (@code{wl-message-refer-article-or-url})
3671 @item Button-4 (upward movement of a wheel)
3672 @kindex Button-4 (Message)
3673 @findex wl-message-wheel-down
3674 Scrolls the message backwards. When the top of the message is hit,
3675 moves to the previous message.
3676 (@code{wl-message-wheel-down})
3678 @item Button-5 (downward movement of a wheel)
3679 @kindex Button-5 (Message)
3680 @findex wl-message-wheel-up
3681 Scrolls the message forward. When the bottom of the message is hit,
3682 moves to the next message.
3683 (@code{wl-message-wheel-up})
3686 @section Customizable Variables
3689 @item wl-message-window-size
3690 @vindex wl-message-window-size
3691 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3692 its car and cdr value corresponds to the ratio of Summary and Message
3694 @item wl-message-ignored-field-list
3695 @vindex wl-message-ignored-field-list
3696 (SEMI only) Initial setting is nil.
3697 All fields that match this list will be hidden in message buffer.
3698 Each elements are regexp of field-name.
3699 If nil, the value of mime-view-ignored-field-list is used.
3700 @item wl-message-visible-field-list
3701 @vindex wl-message-visible-field-list
3702 (SEMI only) Initial setting is nil.
3703 All fields that match this list will be hidden in message buffer.
3704 Each elements are regexp of field-name. This value precedes
3705 wl-message-ignored-field-list.
3706 If nil, the value of mime-view-visible-field-list is used.
3707 @item wl-message-sort-field-list
3708 @vindex wl-message-sort-field-list
3709 (SEMI only) Initial setting is
3710 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3711 Header fields in message buffer are orderd by this value.
3712 Each elements are regexp of field-name.
3715 @node Draft, Disconnected Operations, Message, Top
3716 @chapter Draft Buffer
3718 At Summary mode, pressing @kbd{w} and the like creates a new draft
3719 buffer. You can edit and send mail and news articles in this buffer.
3723 Basically it is Emacs-standard mail mode.
3725 @subsection Address Completion
3727 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3728 addresses. @kbd{@key{TAB}} completes them.
3730 If you want to submit a news article, add @samp{Newsgroups:} field by
3731 yourself. Field names can be completed by @kbd{@key{TAB}}.
3733 If you save the draft buffer you are editing, it is appended to the
3734 folder specified by @code{wl-draft-folder}.
3736 Using @samp{FCC:} field, you can specify the folder to which a copy of
3737 the message is saved when it is sent.
3739 @subsection Editing Messages
3741 Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
3742 editing, refer to respective documents.
3743 @xref{MIME-Edit, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3745 @subsection Dynamic Modification of Messages
3746 @vindex wl-draft-config-alist
3747 @c @cindex Change Message
3748 @c @cindex Message, Change Dynamic
3750 You can set @code{wl-draft-config-alist} so that header and body of the
3751 message will automatically modified depending on information of header
3754 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3756 In the example below, the header is modified when
3757 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3758 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3759 before sending the message.
3763 (setq wl-draft-config-alist
3764 '(((string-match "aaa.example.com$" (system-name))
3765 ;; @r{applied if the expression is non-nil}
3766 (wl-smtp-posting-server . "mailserver-B")
3767 (wl-nntp-posting-server . "newsserver-B")
3768 ;; @r{settings of temporary variables}
3770 ("^To: .*user@@aaa.bbb.example.com"
3771 ;; @r{applied if it matches the header of the draft buffer}
3772 ("Organization" . (format "Go %s" my-webpage)))
3773 ;; @r{you can write elisp expressions here (eval only)}
3774 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3775 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3780 The format of @code{wl-draft-config-alist} is:
3784 '(("@var{regexp of the header}" or @var{elisp expression}
3785 ("@var{Field}" . value(@var{elisp expression}))
3786 (@var{variable} . value(@var{elisp expression}))
3787 (@var{sub-function} . value(@var{elisp expression}))
3790 ("@var{regexp of the header}" or @var{elisp expression}
3791 ("@var{Field}" . value(@var{elisp expression}))
3796 Per default, there are 10 following sub-functions.
3799 'header: Inserts the specified string at the bottom of the header.
3800 'header-file: Inserts the specified file at the bottom of the header.
3801 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3802 'top: Inserts the specified string at the top of the body.
3803 'top-file: Inserts the specified file at the top of the body.
3804 'body: Replaces the body with the specified string.
3805 Specifying @code{nil} deletes the entire body string.
3806 'body-file: Replaces the body with the content of the specified file.
3807 'bottom: Inserts the specified string at the bottom of the body.
3808 'bottom-file: Inserts the specified file at the top of the body.
3809 'template: Applies the specified template.
3810 (refer to the next subsection)
3813 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3814 change them or add your own functions. If you read the code, you can
3815 easily find how to write the functions.
3817 At the first of each item, @var{a regular expression of the header} or
3818 an @var{elisp expression} should be specified. In the case of an elisp
3819 expression, the item is applied when the expression is evaluated
3822 Per default, when multiple items match or are evaluated non-nil, all
3823 such items are applied, but if you set a variable
3824 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3827 At the second of the item, a cons or a list of functions should be
3828 specified. The car part of the cons should be a header field, a
3829 variable, or a sub-function. When a header field is specified, the
3830 field will be modified. If a variable is specified, the value of the
3831 variable will be modified temporarily.
3833 In the cdr part of a cons, not only a variable but also an elisp
3834 expression can be specified as is. If the car part is a header field
3835 and the cdr part is @code{nil}, the field will be deleted.
3837 See the next example as well:
3841 (setq wl-draft-config-alist
3843 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3844 ;; @r{applied if it matches the header of the buffer being replied}
3845 (body . " Hello.\n")
3846 (template . "default")
3851 As in the (1) above, if a header regexp is prepended with @code{reply},
3852 it is applied when the draft is prepared by @code{wl-summary-reply} for
3853 example, and when it matches the header being replied. It is ignored
3854 when there is no buffer being replied, like after @code{wl-draft} was
3857 Note that @code{wl-draft-config-alist} is applied only once when
3858 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3859 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3860 aborting transmission, execute @kbd{C-c C-e}
3861 (@code{wl-draft-config-exec}) explicitly.
3863 If you don't want to apply @code{wl-draft-config-alist} when
3864 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
3868 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
3871 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3872 prepared, do the following:
3875 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3878 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
3879 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
3883 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
3886 @subsection Inserting Templates
3888 @cindex Apply Template
3890 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3891 @kbd{M-x wl-template-select} in the draft buffer.
3893 The format of @code{wl-template-alist} is almost the same as
3894 @code{wl-draft-config-alist}.
3898 (setq wl-template-alist
3901 ("Organization" . "~/.wl sample")
3902 (body . "Hello.\n"))
3904 (template . "default") ;; @r{(a)}
3905 ("To" . "boss@@example.com")
3906 ("Subject" . "Report")
3907 (body-file . "~/work/report.txt")
3913 As you can see, the only difference is item (template) names such as
3914 @samp{default} and @samp{report}, instead of a regexp of header.
3915 Because definition of each item is the same as
3916 @code{wl-draft-config-alist}, you can call another template, like (a).
3918 Executing the command @code{wl-template-select} results in template
3919 selection, but the result differs depending on variable
3920 @code{wl-template-visible-select}.
3922 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3923 window is shown below the draft buffer. You can select a template by
3924 @kbd{n} and @kbd{p} seeing the buffer window.
3926 Press the @key{RET} key and the template is actually applied to the draft
3927 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3928 adjust the window size by @code{wl-template-buffer-lines}.
3930 If @code{wl-template-visible-select} is @code{nil}, you should type the
3931 name of the template in the mini buffer.
3933 As shown in the example in @code{wl-draft-config-alist}, you can select
3934 @samp{default} template by writing:
3937 (template . "default")
3940 @subsection Sending mail by POP-before-SMTP
3941 @cindex POP-before-SMTP
3943 You can send mail by POP-before-SMTP with this single line:
3946 (setq wl-draft-send-mail-func 'wl-draft-send-mail-with-pop-before-smtp)
3950 Configure the following variables if you need.
3953 @item wl-pop-before-smtp-user
3954 The POP user name for POP-before-SMTP authentication.
3955 If unset, @code{elmo-default-pop3-user} is used.
3957 @item wl-pop-before-smtp-server
3958 The POP server name for POP-before-SMTP authentication.
3959 If unset, @code{elmo-default-pop3-server} is used.
3961 @item wl-pop-before-smtp-authenticate-type
3962 The POP authentication method for POP-before-SMTP authentication.
3963 If unset, @code{elmo-default-pop3-authenticate-type} is used.
3965 @item wl-pop-before-smtp-port
3966 The POP port number for POP-before-SMTP authentication.
3967 If unset, @code{elmo-default-pop3-port} is used.
3969 @item wl-pop-before-smtp-stream-type
3970 If non-nil, POP connection is established using SSL. If
3971 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
3972 unset, @code{elmo-default-pop3-stream-type} is used.
3975 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
3976 unset, settings for POP folders (@code{elmo-default-pop3-*}) are
3978 Therefore, if SMTP server and POP server are actually the same, and if
3979 POP folder per default (such as @samp{&}) is available, no settings are
3982 Refer to the following URL about POP-before-SMTP.
3986 http://spam.ayamura.org/tools/smPbS.html
3987 http://www.iecc.com/pop-before-smtp.html
3991 @section Key Bindings
3992 @cindex Keybind, Draft Mode
3993 @cindex Keybind, Draft Buffer
3998 @kindex C-c C-y (Draft)
3999 @findex wl-draft-yank-original
4000 Cites the content of the current message buffer.
4001 (@code{wl-draft-yank-original})
4004 @kindex C-c C-p (Draft)
4005 @findex wl-draft-preview-message
4006 Previews the content of the current draft.
4007 This is useful for previewing MIME multi-part messages.
4008 (@code{wl-draft-preview-message})
4011 @kindex C-c C-s (Draft)
4012 @findex wl-draft-send
4013 Sends the content of the current draft. Does not erase the draft buffer.
4014 This is useful for sending multiple messages, which are a little different
4016 (@code{wl-draft-send})
4019 @kindex C-c C-c (Draft)
4020 @findex wl-draft-send-and-exit
4021 Sends the content of the current draft and erases the draft buffer.
4022 (@code{wl-draft-send-and-exit})
4025 @kindex C-x C-s (Draft)
4026 @findex wl-draft-save
4027 Save the current draft.
4028 (@code{wl-draft-save})
4031 @kindex C-c C-k (Draft)
4032 @findex wl-draft-kill
4033 Kills the current draft.
4034 (@code{wl-draft-kill})
4037 @kindex C-x k (Draft)
4038 @findex wl-draft-mimic-kill-buffer
4039 Kills the current draft.
4040 (@code{wl-draft-mimic-kill-buffer})
4043 @kindex C-c C-z (Draft)
4044 @findex wl-draft-save-and-exit
4045 Saves the current draft, and erases the draft buffer.
4046 This is useful if you want to suspend editing of the draft.
4047 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4048 the @samp{+draft} folder.
4049 (@code{wl-draft-save-and-exit})
4052 @kindex C-c C-r (Draft)
4053 @findex wl-caesar-region
4054 Encodes or decodes the specified region in Caesar cipher.
4055 (@code{wl-caesar-region})
4059 @findex wl-toggle-plugged
4060 Toggles off-line/on-line states of Wanderlust.
4061 (@code{wl-toggle-plugged})
4064 @kindex C-c C-o (Draft)
4065 @findex wl-jump-to-draft-buffer
4066 Jumps to the other draft buffer, if exists.
4067 With prefix argument, reads a file (if any) from the draft folder when
4068 there is no such buffer.
4069 (@code{wl-jump-to-draft-buffer})
4072 @kindex C-c C-e (Draft)
4073 @findex wl-draft-config-exec
4074 Applies @code{wl-draft-config-alist}.
4075 (@code{wl-draft-config-exec})
4078 @kindex C-c C-j (Draft)
4079 @findex wl-template-select
4081 (@code{wl-template-select})
4084 @kindex C-c C-a (Draft)
4085 @findex wl-draft-insert-x-face-field
4086 Inserts the content of a file @file{~/.xface} (the value of the variable
4087 @code{wl-x-face-file}) as an @samp{X-Face:} field in the draft buffer.
4089 There should be encoded X-Face strings as a content of a file @file{~/.xface}.
4090 (@code{wl-draft-insert-x-face-field})
4093 @section Customizable Variables
4096 @item wl-subscribed-mailing-list
4097 @vindex wl-subscribed-mailing-list
4098 The initial setting is @code{nil}. Mailing lists to which you
4099 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4100 field of a reply draft, removes your own address from
4101 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4102 contained in @samp{To:} or @samp{Cc:} field of a message to be
4103 automatically re-filed, the destination folder will be leaned in
4104 connection with the address.
4110 (setq wl-subscribed-mailing-list
4111 '("wl@@lists.airs.net"
4113 "emacs-mime-ja@@m17n.org"))
4117 @item wl-insert-mail-followup-to
4118 @vindex wl-insert-mail-followup-to
4119 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4120 field is automatically inserted in the draft buffer.
4122 @item wl-insert-mail-reply-to
4123 @vindex wl-insert-mail-reply-to
4124 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4125 field is automatically inserted in the draft buffer.
4127 @item wl-auto-insert-x-face
4128 @vindex wl-auto-insert-x-face
4129 The initial setting is @code{t}. If non-nil and there is an encoded
4130 X-Face string in a file @file{~/.xface} (the value of the variable
4131 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4132 draft buffer. If @code{nil}, it is not automatically inserted. Press
4133 @kbd{C-c C-a} to insert.
4135 @item wl-insert-message-id
4136 @vindex wl-insert-message-id
4137 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4138 is automatically inserted on the transmission.
4140 @item wl-local-domain
4141 @vindex wl-local-domain
4142 The initial setting is @code{nil}. If @code{nil}, the return value of
4143 the function @code{system-name} will be used as the domain part of
4146 If @code{system-name} does not return FQDN (i.e. the full name of the
4147 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4148 to the string of the local domain name without hostname (like
4149 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4150 @samp{.} @code{wl-local-domain} is used as domain part of the
4153 If your terminal does not have global IP, set the value of
4154 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4155 you use invalid @samp{Message-ID:}.)
4157 Moreover, concatenation of @code{system-name} @samp{.}
4158 @code{wl-local-domain} will be used as an argument to the HELO command
4161 @item wl-message-id-domain
4162 @vindex wl-message-id-domain
4163 The initial setting is @code{nil}. If non-nil, this value is used as a
4164 domain part of the @samp{Message-ID:}. If your terminal does not have
4165 global IP address, set unique string to this value (e.x. your e-mail
4168 @item wl-message-id-domain
4169 @vindex wl-message-id-domain
4170 The initial setting is @code{nil}. If @code{nil}, the return value of
4171 the function @code{system-name} will be used as the domain part of
4172 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4173 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4174 @strong{must} set this variable to the string of the full name of the
4175 host. Otherwise, you might be beaten up on the Net News.
4177 @item wl-draft-config-alist
4178 @vindex wl-draft-config-alist
4179 The initial setting is @code{nil}. Modifies the draft message just
4180 before the transmission. The content of @code{wl-draft-config-alist}
4181 will be automatically applied only once on the transmission. If you
4182 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4185 @item wl-template-alist
4186 @vindex wl-template-alist
4187 The initial setting is @code{nil}.
4188 This variable specifies the template to be applied in the draft buffer.
4190 @item wl-draft-config-matchone
4191 @vindex wl-draft-config-matchone
4192 The initial setting is @code{nil}. If non-nil, only the first matching
4193 item is used when @code{wl-draft-config-alist} is applied. If
4194 @code{nil}, all matching items are used.
4196 @item wl-template-visible-select
4197 @vindex wl-template-visible-select
4198 The initial setting is @code{t}.
4199 If non-nil, you can preview the result of the template selection in
4202 @item wl-template-confirm
4203 @vindex wl-template-confirm
4204 The initial setting is @code{nil}.
4205 If non-nil, asks for confirmation when you press the enter key to select
4206 template while previewing.
4208 @item wl-template-buffer-lines
4209 @vindex wl-template-buffer-lines
4210 The initial setting is 7.
4211 If @code{wl-template-visible-select} is non-nil, this variable specifies
4212 the size of the preview window.
4214 @item wl-draft-reply-buffer-style
4215 @vindex wl-draft-reply-buffer-style
4216 The initial setting is @code{split}. @code{split} or @code{full} can be
4217 specified. In the case of @code{full}, the whole frame will be used for
4218 a reply draft buffer when it is prepared.
4220 @item wl-draft-use-frame
4221 @vindex wl-draft-use-frame
4222 The initial setting is @code{nil}.
4223 If non-nil, use new frame for the draft.
4227 The initial setting is the value of the variable
4228 @code{user-mail-address}. The value of this variable is inserted as a
4229 @samp{From:} field of the draft when it is prepared.
4231 @item wl-envelope-from
4232 @vindex wl-envelope-from
4233 The initial setting is @code{nil}.
4234 The value of this variable is used for envelope from (MAIL FROM).
4235 If @code{nil}, the address part of @code{wl-from} is used.
4237 @item wl-user-mail-address-list
4238 @vindex wl-user-mail-address-list
4239 The initial setting is @code{nil}.
4240 This is the User's address list. If you have multiple addresses,
4245 The initial setting is @code{nil}.
4246 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4247 the draft when it is prepared. If function is specified, its return
4252 The initial setting is @code{nil}.
4253 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4254 the draft when it is prepared.
4256 @item wl-reply-subject-prefix
4257 @vindex wl-reply-subject-prefix
4258 The initial setting is @samp{Re: }.
4259 In the @samp{Subject:} of the reply draft, this string is prepended to
4260 the @samp{Subject:} of being replied.
4262 @item wl-draft-reply-use-address-with-full-name
4263 @vindex wl-draft-reply-use-address-with-full-name
4264 The initial setting is @code{t}.
4265 If non-nil, insert her full name with address when prepare a draft for
4266 reply a message. If it is @code{nil}, insert her address only.
4268 @item wl-draft-enable-queuing
4269 @vindex wl-draft-enable-queuing
4270 The initial setting is @code{t}.
4271 This flag controls off-line transmission. If non-nil, the draft is
4274 @item wl-draft-use-cache
4275 @vindex wl-draft-use-cache
4276 The initial setting is @code{nil}. If the value is non-nil and
4277 @code{wl-insert-message-id} is non-nil, cache the message which is sent.
4279 @item wl-auto-flush-queue
4280 @vindex wl-auto-flush-queue
4281 The initial setting is t.
4282 This flag controls automatic transmission of the queue when Wanderlust
4283 becomes on-line. If non-nil, the queue is automatically transmitted
4284 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4285 manually, press @kbd{F} in the folder mode.
4287 @item wl-ignored-forwarded-headers
4288 @vindex wl-ignored-forwarded-headers
4289 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4290 All headers that match this regexp will be deleted when forwarding a message.
4292 @item wl-ignored-resent-headers
4293 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4294 All headers that match this regexp will be deleted when resending a message.
4296 @item wl-draft-always-delete-myself
4297 @vindex wl-draft-always-delete-myself
4298 If non-nil, always removes your own address from @samp{To:} and
4299 @samp{Cc:} when you are replying to the mail addressed to you.
4301 @item wl-draft-delete-myself-from-bcc-fcc
4302 @vindex wl-draft-delete-myself-from-bcc-fcc
4303 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4304 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4306 @item wl-smtp-posting-server
4307 @vindex wl-smtp-posting-server
4308 The initial setting is @code{nil}.
4309 This is the SMTP server name for mail transmission.
4311 @item wl-smtp-posting-user
4312 @vindex wl-smtp-posting-user
4313 The initial setting is @code{nil}.
4314 This is the user name for SMTP AUTH authentication. If @code{nil},
4315 @code{smtp-authenticate-user} is used.
4317 @item wl-smtp-authenticate-type
4318 @vindex wl-smtp-authenticate-type
4319 The initial setting is @code{nil}.
4320 This is the authentication method for SMTP AUTH authentication. If
4321 @code{nil}, @code{smtp-authenticate-type} is used. If
4322 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4325 @item wl-smtp-connection-type
4326 @vindex wl-smtp-connection-type
4327 The initial setting is @code{nil}.
4328 This variable specifies how to establish SMTP connections.
4329 If @code{nil}, @code{smtp-connection-type} is used.
4330 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4332 @item wl-nntp-posting-server
4333 @vindex wl-nntp-posting-server
4334 The initial setting is @code{nil}.
4335 This is the NNTP server name used for news submission.
4336 If @code{nil}, @code{elmo-default-nntp-server} is used.
4338 @item wl-nntp-posting-user
4339 @vindex wl-nntp-posting-user
4340 The initial setting is @code{nil}.
4341 This is the user name for AUTHINFO authentication on news submission.
4342 If @code{nil}, @code{elmo-default-nntp-user} is used.
4343 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4345 @item wl-nntp-posting-port
4346 @vindex wl-nntp-posting-port
4347 The initial setting is @code{nil}.
4348 This is the port number of the NNTP server used for news submission.
4349 If @code{nil}, @code{elmo-default-nntp-server} is used.
4351 @item wl-nntp-posting-stream-type
4352 @vindex wl-nntp-posting-stream-type
4353 The initial setting is @code{nil}.
4354 If @code{nil}, @code{elmo-default-nntp-stream-type} is evaluated. If non-nil,
4355 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4356 connection will be established.
4358 @item wl-pop-before-smtp-user
4359 @vindex wl-pop-before-smtp-user
4360 The initial setting is @code{nil}.
4361 This is the POP user name for POP-before-SMTP.
4362 If it is @code{nil}, @code{elmo-default-pop3-user} is used.
4364 @item wl-pop-before-smtp-server
4365 @vindex wl-pop-before-smtp-server
4366 The initial setting is @code{nil}.
4367 This is the POP server name for POP-before-SMTP.
4368 If it is @code{nil}, @code{elmo-default-pop3-server} is used.
4370 @item wl-pop-before-smtp-authenticate-type
4371 @vindex wl-pop-before-smtp-authenticate-type
4372 The initial setting is @code{nil}.
4373 This is the authentication method for POP-before-SMTP authentication.
4374 If it is @code{nil}, @code{elmo-default-pop3-authenticate} is used.
4376 @item wl-pop-before-smtp-port
4377 @vindex wl-pop-before-smtp-port
4378 The initial setting is @code{nil}.
4379 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4380 @code{elmo-default-pop3-port} is used.
4382 @item wl-pop-before-smtp-stream-type
4383 @vindex wl-pop-before-smtp-stream-type
4384 The initial setting is @code{nil}.
4385 This flag controls the use of SSL for POP-before-SMTP. If it is
4386 @code{nil}, @code{elmo-default-pop3-stream-type} is used. If @code{starttls},
4387 STARTTLS (RFC2595) connection will be established.
4389 @item wl-draft-queue-save-variables
4390 @vindex wl-draft-queue-save-variables
4391 Specifies a list of variable to which queued messages are saved on the
4392 off-line transmission.
4394 @item wl-draft-sendlog
4395 @vindex wl-draft-sendlog
4396 The initial setting is @code{t}.
4397 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4401 @item drafts are sent by smtp or qmail
4402 @item saved into folders by fcc
4403 @item saved into folders by queuing
4406 (it is written even if the transmission fails).
4407 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4408 and left to the logging function of @command{imput}.
4411 @item wl-draft-sendlog-max-size
4412 @vindex wl-draft-sendlog-max-size
4413 The initial setting is 20000 (in bytes).
4414 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4415 beyond the size specified by this variable.
4419 The initial setting is @code{nil}.
4420 If non-nil, address completion uses LDAP.
4422 @item wl-ldap-server
4423 @vindex wl-ldap-server
4424 The initial setting is @samp{localhost}.
4425 LDAP server name for address completion.
4428 @vindex wl-ldap-port
4429 The initial setting is @code{nil}.
4430 If non-nil, the value is used as port number.
4433 @vindex wl-ldap-base
4434 The initial setting is @samp{c=US}.
4435 LDAP search starting point (base) for address completion.
4437 @item wl-draft-remove-group-list-contents
4438 @vindex wl-draft-remove-group-list-contents
4439 The initial setting is @code{t}.
4440 If non-nil, remove the group-lists' members in the recipients when
4441 sending the message (group-list means the description such as
4442 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4445 @node Disconnected Operations, Expire and Archive, Draft, Top
4446 @chapter Off-line Management
4447 @cindex Disconnected Operations
4449 Wanderlust has on-line and off-line states.
4452 * Off-line State:: Wanderlust has on-line and off-line states.
4453 * Enable Operations:: Enable Disconeected Operations.
4454 * Plugged Mode:: Switching On-line/Off-line per Server/Port.
4455 * Off-line State settings:: Invoking Wanderlust in the Off-line State.
4456 * Variables of Plugged Mode:: Customize Plugged Mode.
4460 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4461 @section Off-line State
4463 Wanderlust has on-line and off-line states. In the off-line state, you
4464 cannot access messages via network, unless they are cached.
4466 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4467 in the mode line indicates the off-line state. In folder or summary
4468 modes, press @kbd{M-t} to switch between off- and on-line.
4470 You can invoke Wanderlust in the off-line state by setting
4471 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4473 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4474 ignores uncached messages.
4477 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4478 @section Enable Disconeected Operations
4480 Even in the off-line state, provided that relevant messages are cached,
4481 and the variable @code{elmo-enable-disconnected-operation} (described
4482 later) is non-nil, you can following operations:
4483 @xref{Plugged Mode}, @xref{Off-line State settings}.
4486 * Send Messages off-line:: Transmit Messages.
4487 * Re-file and Copy queue:: Re-file and Copy (IMAP4).
4488 * Creation of Folders:: Create Folders off-line (IMAP4).
4489 * Marking:: Mark (IMAP4).
4490 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP).
4493 As soon as Wanderlust becomes on-line, such operations invoked off-line
4494 are reflected in the servers via network.
4497 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4498 @subsection Transmission of Messages
4500 You can send mail/news messages off-line (if you are using
4501 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4502 accumulated in the queue folder, @samp{+queue}. These messages are
4503 transmitted at once when Wanderlust becomes on-line.
4505 You can visit @samp{+queue} in the off-line state and confirm content of
4506 messages in the queue. You can also remove messages. Removed messages
4507 are not transmitted even in the on-line state.
4510 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4511 @subsection Re-file and Copy (IMAP4)
4513 Re-file and copy operations to IMAP folders invoked during the off-line
4514 state are accumulated in the queue, and reflected in the server side
4515 when Wanderlust becomes on-line. If you visit destination folders after
4516 off-line re-file or copy, it looks as if messages were appended even in
4519 For the safety reasons, messages re-filed off-line are removed from
4520 source folders only if their @samp{Message-ID:} match messages on the
4521 servers. While the queue is processed, messages that failed to be
4522 re-filed or copied to the specified folders are appended to the folder
4526 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4527 @subsection Creation of Folders (IMAP4)
4529 You can create IMAP folders off-line. The creation of folders are
4530 reflected in the servers when Wanderlust becomes on-line. At that time,
4531 if folders failed to be created on the servers for any reasons, messages
4532 re-filed to such folders are appended to the folder @samp{+lost+found}.
4535 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4536 @subsection Marking (IMAP4)
4538 Off-line changes in unread/read and importance mark @samp{$} information
4539 are also reflected in the servers when Wanderlust becomes on-line.
4542 @node Pre-fetching Reservations, , Marking, Enable Operations
4543 @subsection Pre-fetching (IMAP4, NNTP)
4545 You can make reservations for pre-fetching messages in IMAP or NNTP
4546 folders. Reserved messages are marked with @samp{!} but not cached
4547 yet. When Wanderlust becomes on-line, they are pre-fetched from
4550 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4551 these off-line operations for IMAP4 and NNTP do not take place, and
4552 off-line re-file, copy or suchlike simply results in error.
4554 Because off-line operations use cache files, it is a bad idea to erase
4555 them by hand; it may cause Wanderlust to malfunction.
4557 If you want to remove caches, be sure to execute @kbd{M-x
4558 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4559 remove caches for messages relevant to off-line operations.
4562 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4563 @section Switching On-line/Off-line per Server/Port
4565 @kbd{M-t} described above switches networking states as a whole, but you
4566 can switch on-line/off-line per server/port.
4568 Pressing @kbd{C-t} in the folder or summary modes brings you in
4569 wl-plugged-mode shown below, in which you can change the plugged state
4574 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4577 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4578 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4580 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4581 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4587 The first line indicates status of the following three variables, and
4588 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
4589 column modifies the values of these variables.
4593 "Queuing" @code{wl-draft-enable-queuing}
4594 "AutoFlushQueue" @code{wl-auto-flush-queue}
4595 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4599 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4602 The second and after lines indicate on-line/off-line states of servers
4603 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4604 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4605 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4607 @dfn{sending queue} means messages accumulated in the folder
4608 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4609 off-line operations when @code{elmo-enable-disconnected-operation} is
4611 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4612 @c off-line operations are enabled.
4614 They are displayed if there are any of them. In the example above, in
4615 the sending queue there are two messages (the first and the second in
4616 the queue folder) for smtp to hosta and one (the third) for nntp to
4617 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4620 If you change @samp{(wl-plugged)} in the second line, the variable
4621 @code{wl-plugged} is changed, so that the mode line indicator and
4622 plugged states of all ports are affected. If you change plugged states
4623 of any servers or ports, @samp{(wl-plugged)} in the second line is
4624 affected depending on @code{elmo-plugged-condition} settings and the
4625 plugged state of each port.
4628 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4629 @section Invoking Wanderlust in the Off-line State
4631 As described before, if you set @code{wl-plugged} to @code{nil} in
4632 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4633 off-line state. You can specify off-line state on a per server or port
4634 basis. Refer to @code{wl-reset-plugged-alist} also.
4636 Usually, when Wanderlust starts up, the plugged state of each port is
4637 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4638 @code{wl-nntp-posting-server} and so on. If you want to change the
4639 plugged state of these ports or to add other ports, configure
4640 @code{wl-make-plugged-hook} with a function.
4644 (add-hook 'wl-make-plugged-hook
4646 (elmo-set-plugged plugged-value(t/nil) server port)
4647 ;; @r{add or change plugged states of the port of the server}
4648 (elmo-set-plugged plugged-value(t/nil) server)
4649 ;; @r{if the port is omitted, all ports are affected}
4650 ;; @r{(you cannot omit the port if you newly add the server)}
4656 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4657 @section Customizable Variables
4662 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4663 mode from the beginning.
4665 @item wl-queue-folder
4666 @vindex wl-queue-folder
4667 The initial setting is @samp{+queue}.
4668 This is the folder in which messages in the transmission queue are
4671 @item wl-auto-flush-queue
4672 @vindex wl-auto-flush-queue
4673 The initial setting is @code{t}.
4674 This flag controls automatic transmission of the queue when Wanderlust
4675 becomes on-line. If non-nil, the queue is automatically transmitted
4676 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4677 manually, press @kbd{F} in the folder mode.
4679 @item elmo-enable-disconnected-operation
4680 @vindex elmo-enable-disconnected-operation
4681 The initial setting is @code{nil}. Controls off-line operations
4682 regarding IMAP4. If non-nil, off-line operations are carried out.
4684 @item elmo-lost+found-folder
4685 @vindex elmo-lost+found-folder
4686 The initial setting is @samp{+lost+found}.
4687 This is the folder to which messages are saved when they fails to be
4688 appended while the off-line re-file/copy queue is processed.
4690 @item elmo-plugged-condition
4691 @vindex elmo-plugged-condition
4692 The initial setting is @code{one}.
4693 The value of @code{wl-plugged} reflects the return value of the function
4694 @code{elmo-plugged-p} (without arguments).
4695 This variable @code{elmo-plugged-condition} specifies the condition on
4696 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4697 plugged state of each port.
4700 'one : plugged if one or more ports are plugged.
4701 'all : plugged if all ports are plugged.
4702 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4703 states of the ports.
4704 @var{function} : reflects the return value of the @var{function}
4705 functions available per default
4706 'elmo-plug-on-by-servers
4707 : reflects the plugged state of the servers specified by the
4708 variable elmo-plug-on-servers.
4709 'elmo-plug-on-by-exclude-servers
4710 : reflects the plugged state of the servers that are not
4711 in elmo-plug-on-exclude-servers.
4712 elmo-plug-on-exclude-servers defaults to
4715 (system-name)without the domain part)
4721 (setq elmo-plugged-condition 'all)
4723 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4724 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4726 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4727 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4731 @item wl-reset-plugged-alist
4732 @vindex wl-reset-plugged-alist
4733 The initial setting is @code{t}. If non-nil, plugged states are
4734 initialized on a per server or port basis when Wanderlust starts up.
4736 If @code{nil}, plugged states are retained while Emacs is running. In
4737 other words, they are initialized when Emacs is restarted even if the
4738 value is @code{nil}.
4742 @node Expire and Archive, Scoring, Disconnected Operations, Top
4743 @chapter Automatic Expiration and Archiving of Messages
4744 @cindex Expire and Archive
4747 * Expire:: Expiration and Archiving
4748 * Archive:: Archiving All Messages
4752 @node Expire, Archive, Expire and Archive, Expire and Archive
4754 @cindex Expire Message
4756 Expiration means deletion of old messages which have outlasted a
4757 certain period of time.
4759 @code{wl-expire} supports not only simple deletion, but also moving to
4760 specified archiving folders.
4764 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4765 or @kbd{M-e} in the summary mode.
4767 @subsection Configuring @code{wl-expire-alist}
4769 An example configuration of @code{wl-expire-alist} is shown below.
4770 Everything in this @code{wl-expire-alist} makes a great difference in
4771 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4772 to @code{t}, especially in the initial stage.
4776 (setq wl-expire-alist
4777 '(("^\\+trash$" (date 14) remove)
4779 ("^\\+tmp$" (date 7) trash)
4780 ;; @r{re-file to @code{wl-trash-folder}}
4781 ("^\\+outbox$" (number 300) "$outbox;lha")
4782 ;; @r{re-file to the specific folder}
4784 ;; @r{do not expire}
4785 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4786 ;; @r{archive by message number (retaining numbers)}
4787 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4788 ;; @r{archive by a fixed number (retaining numbers)}
4789 ("^\\+diary$" (date 30) wl-expire-archive-date)
4790 ;; @r{archive by year and month (numbers discarded)}
4795 Items in the list has the format of:
4798 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4802 The folder is examined if it matches @var{regexp-for-folders} from the
4803 beginning of the list. If you invoke expiration on the folder that does
4804 not match any of them, nothing will happen. And if either the second or
4805 the third element of the item is @code{nil}, expiration will not take
4808 You can use any one of the following for
4809 @var{specification-of-message-to-be-deleted}:
4812 @item (number @var{n1} [@var{n2}])
4813 deletes messages depending on the number of messages in the folder.
4815 @var{n1} is the number of messages which should survive deletion, for example
4816 if its value is 500, the newest 500 messages survive and the rests are
4819 @var{n2} is the number of messages in the folder on which expiration should
4820 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4821 folders with 510 or more messages are expired.
4822 If you configured automatic expiration, frequently used folders may
4823 expire every time it receive messages, and you may be annoyed with the
4824 long delay in reading mail.
4825 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4826 expiration would not take place until a certain number of messages
4829 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4830 with important/new/unread) are not deleted.
4831 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4832 will expire so as to have 500 messages including such ones.
4833 Otherwise, it will have 500 messages except such ones.
4835 @item (date @var{d1})
4836 deletes messages depending on the dates.
4838 Messages dated @var{d1} or more days ago are deleted, for example if its
4839 value is seven, messages seven days old or more are deleted. Note that
4840 the date is the one in the @samp{Date:} field of the message, not when
4841 the message entered the folder.
4843 Messages with no or invalid @samp{Date:} field does not expire; you
4844 might have to delete them by hand.
4847 You can use any one of the following in the place of @var{destination}:
4851 deletes the messages instantly.
4854 hide the messages from summary (messages are not deleted).
4857 moves the messages to @code{wl-trash-folder}.
4859 @item @var{string}(folder)
4860 moves the messages to the folder specified with @var{string}.
4862 It would be useful for specifying an archiving folder, but because this
4863 does not move important messages, it might be better to use the
4864 standard functions described below.
4866 @item @var{function}
4867 invokes the specified @var{function}.
4869 To the @var{function}, three arguments are passed: a folder name, a list
4870 of messages to be deleted, and msgdb information of the summary. You
4871 can specify function-specific arguments after the name of the
4872 @var{function}. Note that the list contains messages with marks in
4873 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4876 These are three standard functions; they moves messages to an archive
4877 folder in the specified way. This means old messages can be compressed
4878 and saved in a file, being deleted from the original folder.
4881 @item wl-expire-archive-number1
4882 re-files to archiving folders corresponding to the message numbers of
4883 the messages being deleted. For example, a message numbered 102 will be
4884 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4885 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4886 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4888 The archiving folders to which messages are re-filed are determined by
4889 the name of the folder as follows (in this case, archiving folders are
4890 handled as if @code{elmo-archive-treat-file} were non-nil).
4893 @item If the folder type is localdir:
4894 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4896 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4897 (@file{~/Mail/ml/wl-00100.zip}).
4899 @item The folder type is other than localdir:
4900 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4902 For example, @samp{%#mh/ml/wl} corresponds to
4903 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4906 As you can see, in the case of localdir, the folder type is not included
4907 in the path name, but otherwise it is included.
4908 And you can control the prefix to the archiving folder name by
4909 @code{wl-expire-archive-folder-prefix}.
4910 Refer to @code{wl-expire-archive-folder-prefix} for details.
4912 @item wl-expire-archive-number2
4913 re-files every certain number of messages to archiving folders.
4915 This differs from @samp{wl-expire-archive-number1} in that this re-files
4916 to the folder up to the specified number regardless of message numbers.
4917 The archiving folders to which messages are re-filed are determined in the
4918 same way as @code{wl-expire-archive-number1}.
4920 @item wl-expire-archive-date
4921 re-files messages depending on its date (year and month) to archive
4924 For example, a message dated December 1998 is re-filed to
4925 @code{$folder-199812;zip}. The name of the archiving folders except the
4926 date part are determined in the same way as
4927 @code{wl-expire-archive-number1}.
4930 You can set the first argument to these three standard functions to non-nil
4931 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4932 For example, it can be specified just after the name of the function:
4935 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4938 If you omit the argument, consecutive numbers from 1 are assigned for
4939 each archiving folder.
4942 @subsection Treatment for Important or Unread Messages
4944 If you specify any of @code{remove}, @code{trash}, a folder name, or a
4945 standard function, messages with marks in
4946 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
4947 messages} thereafter) are retained.
4949 Per default, this variable include the important, new, and unread marks,
4950 so that messages with these marks are not removed.
4951 Note that you cannot include the temporary mark (i.e. temporary marks
4952 are removed anyway), and be sure to process temporary marks before you
4955 @subsection Auto Expiration
4957 The following setup invokes expiration when you move into the summary
4958 mode. There will be no confirmation, so make sure you made no mistake
4959 in regexp and other settings before you set up this.
4963 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4967 In the folder mode, you can invoke expiration per group as well as per
4968 folder. Therefore, if you specify @samp{Desktop} group, all folders
4969 matching @code{wl-expire-alist} expire.
4973 @subsection Treating archive folders.
4974 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
4975 you must set non-nil value to @code{elmo-archive-treat-file}.
4977 @subsection Confirming
4979 If you are to use @code{remove}, try @code{trash} at first and see
4980 messages move to @code{wl-trash-folder} as expected, then replace it
4981 with @code{remove}. It would be dangerous to use @code{remove} from the
4984 If you are to use @code{wl-expire-archive-number1} and the like, try to
4985 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
4986 you can append messages to it. Even if settings in
4987 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
4988 would not be saved anywhere and disappeared in case the archiver program
4991 After you make sure you can archive to the folder correctly, you can
4992 invoke expiration and utilize the log.
4994 If you set @code{wl-expire-use-log} to @code{t},
4995 @file{~/.elmo/expired-log} should contain the log, for example:
4999 delete +ml/wl (593 594 595 596 597 598 599)
5000 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5004 The first column indicates the operation, i.e. @samp{delete},
5005 @samp{copy}, or @samp{move}. The next is the name of the folder that
5006 expired. In the case of @samp{copy} and @samp{move}, the destination
5007 folder is recorded after @samp{->}. The last is the list of message
5008 numbers that are actually deleted or moved (in the case of @samp{copy}
5009 and @samp{move}, the number is the one in the source folder, rather than
5010 the destination folder).
5012 @subsection Re-filing Reserved Messages
5014 The three standard functions copy reserved messages to the archive
5015 folder, but do not delete them from the source folder. Because
5016 reserved messages and the like always remain, they are recorded in
5017 @file{~/.elmo/expired-alist} so that they are not copied over and over
5018 again. They are not recorded if copied by @code{wl-summary-archive}.
5020 If you enabled logging, usually @samp{move} is recorded for re-filing,
5021 but instead @samp{copy} and @samp{delete} are recorded separately if
5022 reserved messages are involved. This is because it actually copies
5023 messages including reserved, then deletes ones except reserved in that
5026 @section Customizable Variables
5029 @item wl-expire-alist
5030 @vindex wl-expire-alist
5031 The initial setting is @code{nil}.
5032 This variable specifies folders and methods to expire. For details,
5033 refer to @code{wl-expire-alist} settings above.
5035 @item wl-summary-expire-reserve-marks
5036 @vindex wl-summary-expire-reserve-marks
5037 The initial setting is the list below.
5041 (list wl-summary-important-mark
5043 wl-summary-unread-mark
5044 wl-summary-unread-uncached-mark
5045 wl-summary-unread-cached-mark)
5049 Messages with these marks are retained in the folder, even after
5051 Only permanent marks can be listed, not temporary marks.
5053 You can list marks one by one as in the default; you can use the
5054 following settings as well:
5058 All messages with permanent marks are retained,
5059 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5063 All messages are handled as usual ones that are already read, no matter
5064 what marks they have; even important messages are deleted.
5067 @item wl-expire-archive-files
5068 @vindex wl-expire-archive-files
5069 The initial setting is 100.
5070 This variable specifies the number of messages to be retained in one
5073 @item wl-expire-number-with-reserve-marks
5074 @vindex wl-expire-number-with-reserve-marks
5075 The initial setting is @code{nil}.
5076 If non-nil, if expiring messages are specified by @code{number},
5077 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5079 @item wl-expire-archive-get-folder-func
5080 @vindex wl-expire-archive-get-folder-func
5081 The initial setting is @code{wl-expire-archive-get-folder}.
5083 This variable specifies a function that returns the name of an archiving
5084 folder for standard functions in the place of @var{destination}.
5085 You can use the following three variables for simple modification of
5086 folder names; if you want more complex settings, define your own
5087 function in this variable.
5089 @code{wl-expire-archive-get-folder} can be customized by these
5092 @item @code{wl-expire-archive-folder-name-fmt}
5093 @item @code{wl-expire-archive-folder-type}
5094 @item @code{wl-expire-archive-folder-prefix}
5097 @item wl-expire-archive-folder-name-fmt
5098 @vindex wl-expire-archive-folder-name-fmt
5099 The initial setting is @samp{%s-%%05d;%s}.
5100 This is a @code{format} string for archiving folders used in
5101 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5102 Note that you must specify the message number by @samp{%%d}, because it
5103 is parsed twice by @code{format}.
5105 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5108 @item wl-expire-archive-date-folder-name-fmt
5109 @vindex wl-expire-archive-date-folder-name-fmt
5110 The initial setting is @samp{%s-%%04d%%02d;%s}.
5111 This is a @code{format} string for archiving folders used in
5112 @code{wl-expire-archive-date}. Note that you must specify the message
5113 number by @samp{%%d}, because it is parsed twice by @code{format}.
5114 There should be @samp{%%d} twice, one for the year and the other for the
5117 If you modify this, adjust
5118 @code{wl-expire-archive-date-folder-num-regexp} as well.
5120 @item wl-expire-archive-folder-type
5121 @vindex wl-expire-archive-folder-type
5122 The initial setting is @code{zip}.
5123 This variable specifies an archiver type of the archiving folders.
5125 @item wl-expire-archive-folder-prefix
5126 @vindex wl-expire-archive-folder-prefix
5127 The initial setting is @code{nil}.
5128 This variable specifies the prefix (directory structure) to archiving
5130 Exercise extreme caution in using this feature, as it has not been
5132 In the worst case, there is a fear of destructing archiving folders.
5136 There will be no prefix.
5139 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5140 @samp{$ml/wl-00000;zip;wl}.
5143 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5146 @samp{$ml/wl-00000;zip;ml/wl}.
5149 @item wl-expire-archive-folder-num-regexp
5150 @vindex wl-expire-archive-folder-num-regexp
5151 The initial setting is @samp{-\\([-0-9]+\\);}.
5152 This variable specifies the regular expression to be used for getting
5153 message numbers from multiple archiving folders specified by
5154 @code{elmo-list-folders}.
5155 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5157 @item wl-expire-archive-date-folder-num-regexp
5158 @vindex wl-expire-archive-date-folder-num-regexp
5159 The initial setting is @samp{-\\([-0-9]+\\);}.
5160 This is the regular expression to be used for getting message numbers
5161 from multiple archiving folders specified by @code{elmo-list-folders}.
5162 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5164 @item wl-expire-delete-oldmsg-confirm
5165 @vindex wl-expire-delete-oldmsg-confirm
5166 The initial setting is @code{t}.
5167 If non-nil, messages older than the one with the largest number will be
5168 deleted with confirmation.
5169 If @code{nil}, they are deleted without confirmation.
5171 This feature is valid only if non-nil is specified as a argument to the
5172 standard functions so as to retain numbers.
5174 @item wl-expire-use-log
5175 @vindex wl-expire-use-log
5176 The initial setting is @code{nil}.
5177 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5178 They are appended but not truncated or rotated automatically; you might
5179 need to remove it manually.
5181 @item wl-expire-add-seen-list
5182 @vindex wl-expire-add-seen-list
5183 The initial setting is @code{t}.
5185 If non-nil, when messages are re-filed by expiration, read/unread
5186 information is passed to the destination folder.
5188 However if you do not read the destination folder from Wanderlust,
5189 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5190 want to set this to @code{nil} if you are simply saving to some
5191 archiving folders. Even if its value is @code{nil}, messages in the
5192 archiving folders are simply treated as unread; it does not affect
5195 @item wl-expire-folder-update-msgdb
5196 @vindex wl-expire-folder-update-msgdb
5197 The initial setting is @code{t}.
5198 If @code{t}, in the folder mode, expiration is carried out after
5199 updating summary information. If you specified a list of regular
5200 expressions of folder names, summary information is updated for matching
5205 @node Archive, , Expire, Expire and Archive
5206 @section Archiving Messages
5208 @subsection Archiving Messages
5209 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5210 folders. If there are the archiving folders already, only new messages
5213 You can use @code{wl-archive-alist} in order to specify how messages are
5214 archived according to their folder names, as in @code{wl-expire-alist}.
5219 (setq wl-archive-alist
5220 '(("^\\+tmp$" wl-archive-date)
5221 ("^\\+outbox$" wl-archive-number2)
5222 (".*" wl-archive-number1)))
5226 Each item in the list has the following format:
5229 (@var{folders-regexp} @var{deleting-function})
5232 As you can see, you can only use a function after @var{folders-regexp}.
5233 Per default, there are three functions:
5236 @item @code{wl-archive-number1}
5237 @item @code{wl-archive-number2}
5238 @item @code{wl-archive-date}
5241 As inferred from their names, they work similarly to "expire" versions,
5242 other than the following points:
5245 @item No messages are deleted
5246 @item Message numbers are retained even if invoked without arguments
5249 These functions are good to archive all messages in a folder by their
5250 numbers or by their dates.
5251 These are also useful for backup or confirmation purposes before
5253 If you try to re-file them after they are archived, they are deleted but
5256 Per default, the archiving folders to which messages are copied are
5257 determined automatically by @code{wl-expire-archive-get-folder-func}.
5258 You can copy to a specific folder by invoking with a prefix argument,
5259 i.e. @kbd{C-u M-x wl-summary-archive}.
5261 Note that this feature has not been seriously tested, because you can
5262 simply copy to an archiving folder, for example by
5263 @code{wl-summary-copy-region}.
5265 The archiving folders are determined by the same logic as in
5266 @code{wl-summary-expire}; the following customizable variables are
5270 @item @code{wl-expire-archive-files}
5271 @item @code{wl-expire-archive-get-folder-func}
5272 @item @code{wl-expire-archive-folder-name-fmt}
5273 @item @code{wl-expire-archive-folder-type}
5274 @item @code{wl-expire-archive-folder-prefix}
5275 @item @code{wl-expire-archive-folder-num-regexp}
5278 @subsection Customizable Variables
5281 @item wl-archive-alist
5282 @vindex wl-archive-alist
5283 The initial setting is the list shown below:
5287 ((".*" wl-archive-number1))
5292 This variable specifies a function that copies to archiving folders.
5293 To the function, three arguments are passed: a folder name, a list of
5294 messages in the folder, and msgdb information of the summary.
5295 Needless to say, you can use your own function.
5299 @node Scoring, Customization, Expire and Archive, Top
5300 @chapter Score of the Messages
5302 @c @cindex Kill File
5304 Scoring is the function that associates a score (value) with each
5305 message, and marks as read or deletes from the summary according to it.
5307 You can put target or important marks on essential messages, or read marks
5308 on the ones you do not want to read, for example spam articles.
5310 This scoring function has a capability and a format similar to the one
5311 that Gnus has, although there are some unsupported features and
5312 Wanderlust specifics.
5313 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5316 * Score Commands:: Score Commands
5317 * Score File Format:: Score File Format
5321 @node Score Commands, Score File Format, Scoring, Scoring
5322 @section Score Commands
5323 @cindex Score Commands
5325 @subsection Score File Specification
5327 @code{wl-score-folder-alist} specifies score files or variables in which
5328 scores are defined, corresponding to folder names.
5332 (setq wl-score-folder-alist
5341 If paths to the score files are omitted, the directory specified in the
5342 variable @code{wl-score-files-dir} is assumed.
5344 No matter what you write in @code{wl-score-folder-alist}, the default
5345 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5346 read (it does not have to exist).
5347 Therefore, in the example above, the three score files,
5348 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5349 the folders that matches @samp{^-.*}.
5351 @subsection Scored Messages
5353 Scores are attached to the messages that are specified by
5354 @code{wl-summary-score-marks} temporarily when the summary is updated;
5355 when you exit from the summary, the scores are removed and reverts to
5358 @subsection Creation of Score Files
5360 In the summary buffer, move to an appropriate message and type @kbd{L}.
5361 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5362 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5364 This makes @minus{}1000 are scored for messages with the same
5365 @samp{Subject:} as the string you entered. That is, such a score file
5366 is created automatically.
5368 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5369 The score file you just made appears.
5370 This buffer is called @dfn{score editing buffer} thereafter.
5371 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5372 as you are previously; type @kbd{a}. Then a score entry for "From"
5374 In this way, you can create a score file easily either in the summary
5375 buffer or in the score editing buffer.
5377 By the way, you might be aware the numbers of key strokes are different
5378 between @kbd{s s p} and @kbd{a}.
5379 This is determined by @code{wl-score-header-default-entry}.
5380 This variable specifies the default score entries corresponding to
5382 For example, for "subject" field, a type and a time limit are prompted,
5383 but for "from" field, they are fixed upon automatically as substring and
5384 permanent respectively.
5385 However, score values can be modified by the prefix argument.
5386 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5389 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5390 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5391 erasing contents of the buffer deletes the score file being edited.
5395 @subsubsection Selecting Score Files
5397 You can change score files to which scores are appended by
5398 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5399 @code{wl-score-change-score-file}.
5401 @subsubsection Summing Up the Score
5403 If you add the same entries by @code{wl-summary-increase-score},
5404 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5405 scores for the entry is summed up.
5407 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5408 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5409 @minus{}1200 will be created as a result.
5411 @subsubsection Creating Thread Key
5413 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5414 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5416 @subsubsection Creating Followup Key
5418 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5419 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5420 at the cursor to @samp{References} key.
5421 If @code{wl-score-auto-make-followup-entry} is non-nil,
5422 @samp{Message-ID} of all messages to be followed up within dates
5423 specified by @code{wl-score-expiry-days}.
5425 @subsection Key Bindings
5430 @findex wl-summary-increase-score
5431 Increases the score for the current message.
5432 And the score entry is appended to the score file at the same moment.
5433 You can specify the score value by a prefix argument.
5437 @findex wl-summary-lower-score
5438 Decreases the score for the current message.
5439 And the score entry is appended to the score file at the same moment.
5440 You can specify the score value by a prefix argument.
5443 @kindex h R (Summary)
5444 @findex wl-summary-rescore
5445 Re-applies the scoring.
5446 However, already scored messages are not scored anew.
5449 @kindex h c (Summary)
5450 @findex wl-score-change-score-file
5451 Changes the score file currently selected.
5454 @kindex h e (Summary)
5455 @findex wl-score-edit-current-scores
5456 Edits the score file currently selected.
5457 If there are multiple score files, the previously specified one is
5461 @kindex h f (Summary)
5462 @findex wl-score-edit-file
5463 Edits an arbitrary score file and selects it.
5466 @kindex h F (Summary)
5467 @findex wl-score-flush-cache
5468 Erases caches associated to the score files that are read.
5469 If you modified score files directly (from other than Wanderlust), you
5470 need to re-read them after erasing the cache.
5473 @kindex h m (Summary)
5474 @findex wl-score-set-mark-below
5475 Specifies the criterion for scores to be marked as read.
5476 Messages with scores less than this value are marked as read.
5479 @kindex h x (Summary)
5480 @findex wl-score-set-expunge-below
5481 Specifies the criterion for scores to be deleted from the summary.
5482 Messages with scores less than this value are deleted.
5483 "Deleted" means it is not shown; they are not removed from the summary
5484 information or the folder.
5485 The deleted messages can be shown by rescan-noscore again.
5488 @subsection Key Bindings in the Score Editing Buffer
5492 @kindex C-c C-k (Score Mode)
5493 @findex wl-score-edit-kill
5494 Abandons the file being edited.
5497 @kindex C-c C-c (Score Mode)
5498 @findex wl-score-edit-exit
5499 Saves the file being edited, and quits from the edit mode.
5502 @kindex C-c C-p (Score Mode)
5503 @findex wl-score-pretty-print
5507 @kindex C-c C-d (Score Mode)
5508 @findex wl-score-edit-insert-date
5509 Inserts the number of dates from Dec. 31, 1 B.C.
5510 It is used for creating the third factor of time-limited scores.
5513 @kindex C-c C-s (Score Mode)
5514 @findex wl-score-edit-insert-header
5515 Inserts the header of the message selected in the summary buffer.
5518 @kindex C-c C-e (Score Mode)
5519 @findex wl-score-edit-insert-entry
5520 Inserts the score entry of the message selected in the summary buffer.
5523 @subsection Customizable Variables
5526 @item wl-summary-default-score
5527 @vindex wl-summary-default-score
5528 The initial setting is 0 (zero).
5529 This variable specifies the default value of the score.
5530 The score is increased or decreased based upon this value.
5532 @item wl-summary-important-above
5533 @vindex wl-summary-important-above
5534 The initial setting is @code{nil}.
5535 Messages with scores larger than this value are attached with the
5536 important mark (@samp{$}).
5537 If @code{nil}, no important marks are attached.
5539 @item wl-summary-target-above
5540 @vindex wl-summary-target-above
5541 The initial setting is @code{nil}.
5542 Messages with scores larger than this value are attached with the target
5544 If @code{nil}, no target marks are attached.
5546 @item wl-summary-mark-below
5547 @vindex wl-summary-mark-below
5548 The initial setting is 0 (zero).
5549 Messages with scores smaller than this value are marked as read.
5551 @item wl-summary-expunge-below
5552 @vindex wl-summary-expunge-below
5553 The initial setting is @code{nil}.
5554 Messages with scores smaller than this value are deleted from the
5556 If @code{nil}, they are not deleted.
5558 @item wl-summary-score-marks
5559 @vindex wl-summary-score-marks
5560 The initial setting is the list shown below:
5564 (list wl-summary-new-mark)
5569 Messages with these marks are scored.
5571 @item wl-use-scoring
5572 @vindex wl-use-scoring
5573 The initial setting is t.
5574 If non-nil, scoring is enabled.
5576 @item wl-score-files-dir
5577 @vindex wl-score-files-dir
5578 The initial setting is @file{~/.elmo/}.
5579 The default directory for score files.
5581 @item wl-score-interactive-default-score
5582 @vindex wl-score-interactive-default-score
5583 The initial setting is 1000.
5584 This value is used as a score when a score factor is @code{nil} in the
5585 score file. It is also used in @code{wl-summary-increase-score} and
5586 @code{wl-summary-lower-score}, on condition that the value of
5587 @code{wl-score-header-default-entry} is @code{nil}.
5589 @item wl-score-expiry-days
5590 @vindex wl-score-expiry-days
5591 The initial setting is 7.
5592 This is the number of days before time-limited scores are deleted.
5594 @item wl-score-update-entry-dates
5595 @vindex wl-score-update-entry-dates
5596 The initial setting is @code{t}.
5597 If non-nil, it enables deletion of time-limited scores.
5599 @item wl-score-header-default-entry
5600 @vindex wl-score-header-default-entry
5601 Specifies the default value for each header field for score entries
5602 created by @code{wl-summary-increase-score},
5603 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5605 @item wl-score-simplify-fuzzy-regexp
5606 @vindex wl-score-simplify-fuzzy-regexp
5607 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5608 regular expression to be deleted from the string.
5609 Because this is usually used for Subject, the default is prefixes that
5610 are attached by mailing list programs.
5612 @item wl-summary-rescore-partial-threshold
5613 @vindex wl-summary-rescore-partial-threshold
5614 The initial setting is 200.
5615 When sync-all or rescan is executed, if there are messages more than
5616 this value, only the last same number of messages as this value are
5619 @item wl-summary-auto-sync-marks
5620 @vindex wl-summary-auto-sync-marks
5621 If non-nil, unread/important marks are synchronized when the summary
5623 Unread marks reflect information on the IMAP4 server.
5624 Important marks reflect information on the IMAP4 server (flagged or
5625 not), and contents of @samp{'mark} folder.
5626 The initial setting is @code{t}.
5630 @node Score File Format, , Score Commands, Scoring
5631 @section Score File Format
5632 @cindex Score File Format
5634 The format of score files are the same as Gnus, and basically you can
5635 use Gnus score files as they are. But they are not fully compatible
5636 because some keys are not supported and there are Wanderlust specifics.
5637 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5642 ("for sale" -1000 nil s)
5643 ("profit" -1000 nil s))
5645 ("spam@@spamspamspam" -10000 nil s))
5647 ("my@@address" 3001 nil s))
5649 (1000000 -10 nil >))
5659 If the key is a string, it is the name of the header to be matched.
5660 The following keys are available:
5661 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5662 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5663 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5664 @code{Chars} and @code{Lines} mean the size and the number of lines of
5665 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5666 are described later.
5667 The rest corresponds the field of the same name.
5669 Arbitrary numbers of core entries are specified after the key.
5670 Each score entry consists of these five factors:
5674 A factor that matches header. This should be a number in the cases of
5675 @code{lines} and @code{chars}, otherwise a string.
5678 A score factor. When the first item matches, the score of the message
5679 is increased or decreased by this value.
5682 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5683 of a number, the score is deleted if it does not match for days
5684 (@code{wl-score-expiry-days}) from the date specified by this.
5685 The date is since Dec. 31, 1 B.C.
5688 A type factor. This specifies the way the first factor matches.
5689 Available types depend on keys.
5692 @item From, Subject, References, Message-ID
5693 For these keys in string, @code{r} and @code{R} (regexp),
5694 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5695 as well as @code{f} and @code{F} (fuzzy) can be used.
5696 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5699 For these keys, the following five numerical relative operators can be
5700 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5703 This key matches @code{From} header, and scores all follow-ups to the
5705 For example, it would be useful for increasing scores for follow-ups to
5708 You can use the same types as @code{From} except for @code{f}.
5709 And a @samp{Followup} entry is automatically appended to the score file.
5712 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5713 A @samp{Thread} entry is automatically appended for each article that
5714 has @var{x} in the @code{References} header.
5715 You can make sure the whole thread including messages that does not have
5716 all ancestors @code{Message-ID} in @code{References} is scored.
5718 You can use the same types as @code{References} except for @code{f}.
5719 And a @samp{Thread} entry is automatically appended to the score file.
5723 A factor for extension header. This is meaningful only if the key is
5725 This specifies headers to be matched other than standard headers like
5726 @code{Subject} and @code{From}.
5727 Note that you should specify the header in
5728 @code{elmo-msgdb-extra-fields} also.
5729 Therefore it does not work in folders where extension headers cannot be
5734 The sum of these scores @emph{after all factors are applied} becomes the
5735 score of the message.
5737 @cindex Score File Atoms
5739 Messages with a score less than this value is marked as read.
5740 The default is @code{wl-summary-mark-below}.
5743 Messages with a score less than this value is deleted from the summary.
5744 The default is @code{wl-summary-expunge-below}.
5746 @item mark-and-expunge
5747 Both @code{mark} and @code{expunge} are applied,
5748 i.e. messages with a score less than this value is marked as read and
5749 deleted from the summary.
5752 Messages with a score greater than this value is attached with temp
5754 The default is @code{wl-summary-target-above}.
5757 Messages with a score greater than this value is attached with important
5759 The default is @code{wl-summary-important-above}.
5764 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5765 are used, you need to set @code{elmo-msgdb-extra-fields}.
5768 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5771 There are other restrictions as shown below:
5774 @item Because @samp{References} field in the summary information
5775 contains only the last @samp{Message-ID}, @code{references} key matches
5779 Keys that can be seen by folder of types:
5783 chars lines xref extra
5784 localdir,localnews Y E E E
5785 nntp (supporting xover) Y E E N
5791 N: cannot be seen (ignored)
5792 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5797 @node Customization, Mailing List, Scoring, Top
5798 @chapter Customizing Wanderlust
5799 @cindex Customization
5802 * Living with other packages:: Living with other packages
5803 * Highlights:: Highlights
5804 * Biff:: Notify Mail arrival
5805 * Advanced Settings:: Advanced Settings
5806 * Customizable Variables:: Customizable Variables
5811 @node Living with other packages, Highlights, Customization, Customization
5812 @section Living with other packages
5814 Examples with other packages.
5817 * imput:: imput (im-wl.el)
5819 * supercite:: supercite.el
5820 * mu-cite:: mu-cite.el
5821 * x-face-mule:: x-face-mule.el
5822 * dired-dd:: dired-dd.el
5827 @node imput, BBDB, Living with other packages, Living with other packages
5832 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5835 If @command{imput} is on the @code{exec-path} at the installation,
5836 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
5840 (autoload 'wl-draft-send-with-imput-async "im-wl")
5841 (setq wl-draft-send-func 'wl-draft-send-with-imput-async)
5846 @node BBDB, supercite, imput, Living with other packages
5850 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
5853 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
5854 byte-compiled and installed.
5862 ;; @r{enable pop-ups}
5863 (setq bbdb-use-pop-up t)
5864 ;; @r{auto collection}
5865 (setq bbdb/mail-auto-create-p t)
5866 (setq signature-use-bbdb t)
5867 (setq bbdb-north-american-phone-numbers-p nil)
5868 ;; @r{shows the name of bbdb in the summary} :-)
5869 (setq wl-summary-from-func 'bbdb-wl-from-func)
5870 ;; @r{automatically add mailing list fields}
5871 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
5872 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
5876 @node supercite, mu-cite, BBDB, Living with other packages
5877 @subsection sc.el(supercite), sc-register.el
5881 The same setting as usual mailers should be OK. The following is an
5882 example of settings:
5886 (autoload 'sc-cite-original "sc" nil t)
5887 (setq mail-yank-hooks 'sc-cite-original)
5888 (setq sc-preferred-header-style 1)
5889 (setq sc-electric-references-p nil)
5890 (setq sc-citation-leader "")
5891 (setq sc-load-hook '(lambda () (require 'sc-register)))
5892 (setq sc-preferred-attribution 'registeredname)
5897 @node mu-cite, x-face-mule, supercite, Living with other packages
5898 @subsection mu-cite.el
5901 The same setting as usual mailers should be OK. The following is an
5902 example of settings.
5904 If you use mu-cite version 8.0 or earlier:
5908 (autoload 'mu-cite/cite-original "mu-cite" nil t)
5909 (setq mail-citation-hook 'mu-cite/cite-original)
5913 If you use mu-cite version 8.1 or later:
5917 (autoload 'mu-cite-original "mu-cite" nil t)
5918 (add-hook 'mail-citation-hook (function mu-cite-original))
5922 @node x-face-mule, dired-dd, mu-cite, Living with other packages
5923 @subsection x-face-mule.el
5927 It depends on the version of x-face-mule.
5928 If you use x-face-mule 0.19 or older, do the following:
5932 (setq wl-highlight-x-face-func
5934 (lambda (&optional beg end)
5935 (x-face-mule:x-face-decode-message-header))))
5936 (require 'x-face-mule)
5940 If you use x-face-mule 0.20 or later, try the following:
5944 (setq wl-highlight-x-face-func
5946 (lambda (&optional beg end)
5947 (x-face-mule-x-face-decode-message-header))))
5948 (require 'x-face-mule)
5952 Use these settings when you use @file{x-face-mule.el} attached to
5953 bitmap-mule 8.0 or later:
5957 (autoload 'x-face-decode-message-header "x-face-mule")
5958 (setq wl-highlight-x-face-func 'x-face-decode-message-header)
5962 If there is an encoded X-Face string in a file @file{~/.xface} (the
5963 value of the variable @code{wl-x-face-file}), it is inserted as a
5964 @samp{X-Face:} field in the draft buffer (if
5965 @code{wl-auto-insert-x-face} is non-nil).
5968 @node dired-dd, MHC, x-face-mule, Living with other packages
5969 @subsection dired-dd(Dired-DragDrop)
5970 @pindex Dired-DragDrop
5972 @cindex Drag and Drop
5974 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
5975 compose multi-part by simple Drag-and-Drop from dired to the draft
5976 buffer being edited in GNU Emacs (this feature is not Wanderlust
5977 specific, but general-purpose for tm/SEMI).
5981 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
5987 ;; @r{Set dired-x variables here.}
5988 ;; @r{To and flo@dots{}}
5990 (progn (require 'dired-dd)
5991 (require 'dired-dd-mime))))))
5995 @node MHC, , dired-dd, Living with other packages
5999 Message Harmonized Calendaring system
6000 (@uref{http://www.quickhack.net/mhc/})
6002 By using MHC, you can make a calendar from the messages.
6008 (setq mhc-mailer-package 'wl)
6009 (autoload 'mhc-mode "mhc" nil t)
6010 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6011 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6019 (autoload 'mhc-wl-setup "mhc-wl")
6020 (add-hook 'wl-init-hook 'mhc-wl-setup)
6024 @node Highlights, Biff, Living with other packages, Customization
6027 @subsection Customizable Variables
6030 @item wl-summary-highlight
6031 @vindex wl-summary-highlight
6032 The initial setting is @code{t}.
6033 If non-nil, the summary is highlighted.
6035 @item wl-highlight-max-summary-lines
6036 @vindex wl-highlight-max-summary-lines
6037 The initial setting is 10000.
6038 The summary is not highlighted if it has more lines than this value.
6040 @item wl-summary-highlight-partial-threshold
6041 @vindex wl-summary-highlight-partial-threshold
6042 The initial setting is 1000.
6043 This is a threshold whether the whole summary is highlighted.
6044 If there are more lines of messages in the summary, it is partially
6047 @item wl-summary-partial-highlight-above-lines
6048 @vindex wl-summary-partial-highlight-above-lines
6049 The initial setting is 30. If there are more lines of messages than
6050 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6051 after the point that is the same number of lines as this value above the
6052 cursor line are highlighted partially. (If this value is @code{nil},
6053 the last same number of lines as the value of
6054 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6056 @item wl-highlight-body-too
6057 @vindex wl-highlight-body-too
6058 The initial setting is @code{t}.
6059 If non-nil, bodies of drafts and messages are also highlighted.
6061 @item wl-highlight-message-header-alist
6062 @vindex wl-highlight-message-header-alist
6063 When highlighting headers of drafts and messages, this variable
6064 specifies which faces are allocated to important
6065 (@code{wl-highlight-message-important-header-contents}), secondly
6066 important (@code{wl-highlight-message-important-header-contents2}), and
6067 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6069 Similarly, it can be used for allocating arbitrary faces to arbitrary
6070 regular expressions.
6072 @item wl-highlight-citation-prefix-regexp
6073 @vindex wl-highlight-citation-prefix-regexp
6074 Specifies a regular expression to which quoted lines in bodies of
6075 drafts and messages match.
6076 Bodies matching to this regular expression are highlighted by the faces
6077 specified by (@code{wl-highlight-message-cited-text-*}).
6079 @item wl-highlight-highlight-citation-too
6080 @vindex wl-highlight-highlight-citation-too
6081 The initial setting is @code{nil}.
6082 If non-nil, the quoting regular expression itself given by
6083 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6085 @item wl-highlight-citation-header-regexp
6086 @vindex wl-highlight-citation-header-regexp
6087 Specifies a regular expression that denotes beginning of quotation.
6088 Bodies matching to this regular expression are highlighted by the face
6089 specified by @code{wl-highlight-message-headers}.
6091 @item wl-highlight-max-header-size
6092 @vindex wl-highlight-max-header-size
6093 The initial setting is @code{nil}. If a header size is larger than this
6094 value, it will not be highlighted. If @code{nil}, always highlighted
6095 (ignore header size).
6097 @item wl-highlight-max-message-size
6098 @vindex wl-highlight-max-message-size
6099 The initial setting is 10000.
6100 If a message is larger than this value, it will not be highlighted.
6101 With this variable, highlight is suppressed for uuencode or huge digest
6104 @item wl-highlight-signature-separator
6105 @vindex wl-highlight-signature-separator
6106 Specifies regular expressions that denotes the boundary of a signature.
6107 It can be a regular expression, or a list of ones.
6108 Messages after the place that matches this regular expression are
6109 highlighted by the face specified by
6110 @code{wl-highlight-message-signature}.
6112 @item wl-max-signature-size
6113 @vindex wl-max-signature-size
6114 The initial setting is 400.
6115 This is the largest size for a signature to be highlighted.
6117 @item wl-use-highlight-mouse-line
6118 @vindex wl-use-highlight-mouse-line
6119 The initial setting is @code{t}.
6120 If non-nil, the line pointed by the mouse is highlighted in the folder
6121 mode, summary mode, and the like.
6124 @subsection Setting Colors and Fonts of the Characters
6126 If you want to change colors or fonts of the characters, you need to
6127 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6128 want to change fonts, and @code{set-face-foreground} for colors, and so
6129 on. You cannot write face settings in @file{.emacs}; write in
6132 For example, if you want to change the color for signatures to yellow,
6136 (set-face-foreground 'wl-highlight-message-signature "yellow")
6142 Faces defined in Wanderlust:
6145 @item wl-highlight-message-headers
6146 The face for field names of message headers.
6148 @item wl-highlight-message-header-contents
6149 The face for field bodies of message headers.
6151 @item wl-highlight-message-important-header-contents
6152 The face for important parts of message headers.
6153 Per default, this face is used for a body of @samp{Subject:} field.
6154 You can change its value by editing
6155 @code{wl-highlight-message-header-alist}.
6157 @item wl-highlight-message-important-header-contents2
6158 The face for secondly important parts of message headers.
6159 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6160 fields. You can change its value by editing
6161 @code{wl-highlight-message-header-alist}.
6163 @item wl-highlight-message-unimportant-header-contents
6164 The face for unimportant parts of message headers.
6165 Per default, this face is used for bodies of @samp{X-} fields
6166 @samp{User-Agent:} fields. You can change its value by editing
6167 @code{wl-highlight-message-header-alist}.
6169 @item wl-highlight-message-citation-header
6170 The face for headers of quoted messages.
6172 @item wl-highlight-message-cited-text-*
6173 The face for texts of quoted messages. The last @samp{*} is a
6174 @var{single figure} so that 10 different colors can be used according to
6177 @item wl-highlight-message-signature
6178 The face for signatures of messages. The initial settings are
6179 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6180 dark background colors.
6182 @item wl-highlight-header-separator-face
6183 The face for header separators of draft messages.
6185 @item wl-highlight-summary-important-face
6186 The face for message lines with important marks in the summary.
6188 @item wl-highlight-summary-new-face
6189 The face for message lines with new marks in the summary.
6191 @item wl-highlight-summary-displaying-face
6192 The face for the message line that is currently displayed.
6193 This face is overlaid.
6195 @item wl-highlight-thread-indent-face
6196 The face for the threads that is currently displayed.
6198 @item wl-highlight-summary-unread-face
6199 The face for message lines with unread marks in the summary.
6201 @item wl-highlight-summary-deleted-face
6202 The face for message lines with delete marks in the summary.
6204 @item wl-highlight-summary-refiled-face
6205 The face for message lines with re-file marks in the summary.
6207 @item wl-highlight-refile-destination-face
6208 The face for re-file information part of message lines with re-file
6209 marks in the summary.
6211 @item wl-highlight-summary-copied-face
6212 The face for message lines with copy marks in the summary.
6214 @item wl-highlight-summary-target-face
6215 The face for message lines with target marks @samp{*} in the summary.
6217 @item wl-highlight-summary-thread-top-face
6218 The face for message lines that are on the top of the thread in the
6221 @item wl-highlight-summary-normal-face
6222 The face for message lines that are not on top of the thread in the
6225 @item wl-highlight-folder-unknown-face
6226 The face for folders that are not known to have how many unsync messages
6229 @item wl-highlight-folder-zero-face
6230 The face for folders that have no unsync messages in the folder mode.
6232 @item wl-highlight-folder-few-face
6233 The face for folders that have some unsync messages in the folder mode.
6235 @item wl-highlight-folder-many-face
6236 The face for folders that have many unsync messages in the folder mode.
6237 The boundary between `some' and `many' is specified by the variable
6238 @code{wl-folder-many-unsync-threshold}.
6240 @item wl-highlight-folder-unread-face
6241 The face for folders that have no unsync but unread messages in the
6244 @item wl-highlight-folder-killed-face
6245 The face for folders that are deleted from the access group in the
6248 @item wl-highlight-folder-opened-face
6249 The face for open groups in the folder mode.
6250 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6251 @code{nil} or a @var{number}.
6253 @item wl-highlight-folder-closed-face
6254 The face for close groups in the folder mode.
6255 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6256 @code{nil} or a @var{number}.
6258 @item wl-highlight-folder-path-face
6259 The face for the path to the currently selected folder in the folder
6262 @item wl-highlight-logo-face
6263 The face for logo in the demo.
6265 @item wl-highlight-demo-face
6266 The face for strings (for example, a version number) in the demo.
6270 @node Biff, Advanced Settings, Highlights, Customization
6271 @section Notify Mail arrival
6274 Following setting is to notify mail arrival of @samp{%inbox}
6275 by the indicator on the modeline
6278 (setq wl-biff-check-folder-list '("%inbox"))
6281 @subsection Customizable Variables
6283 @item wl-biff-check-folder-list
6284 @vindex wl-biff-check-folder-list
6285 The initial setting is @code{nil}.
6286 This is the list of folders to check mail arrival.
6287 If @code{nil}, wl doesn't check mail arrival.
6289 @item wl-biff-check-interval
6290 @vindex wl-biff-check-interval
6291 The initial setting is 40 (in seconds).
6292 Check mail arrival in this period.
6294 @item wl-biff-notify-hook
6295 @vindex wl-biff-notify-hook
6296 The initial setting is @code{nil}.
6297 This is a hook run at the arrival of the new mail.
6300 (setq wl-biff-notify-hook '(beep))
6305 @node Advanced Settings, Customizable Variables, Biff, Customization
6306 @section Advanced Settings
6309 * Draft for Reply:: Draft for Reply
6310 * Thread Format:: Appearance of Thread
6311 * User-Agent Field:: @samp{User-Agent:} Header Field
6315 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6316 @subsection Draft for Replay
6317 @vindex wl-draft-reply-with-argument-list
6318 @vindex wl-draft-reply-without-argument-list
6319 @vindex wl-draft-reply-myself-with-argument-list
6320 @vindex wl-draft-reply-myself-without-argument-list
6322 If you want, when you replying to articles in mailing lists, the address
6323 in Reply-To field of the original message to be prepared to To field of
6324 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6329 (setq wl-draft-reply-without-argument-list
6330 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6331 ("Followup-To" . (nil nil ("Followup-To")))
6332 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6333 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6338 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6339 in the original message, @samp{Reply-To:} field in the original is
6340 copied to @samp{To:} field.)
6342 Moreover, the behavior of @kbd{a} with prefix argument can
6343 be directed by @code{wl-draft-reply-with-argument-list} as well.
6345 Note: To set the behavior when you reply to the message written by yourself, use
6346 @code{wl-draft-reply-myself-without-argument-list} and
6347 @code{wl-draft-reply-myself-with-argument-list}
6350 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6351 @subsection Appearance of Threads
6355 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6356 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6357 391 09/18(Fri)19:24 +-[ Murata-san ]
6358 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6359 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6360 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6361 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6362 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6363 412 09/22(Tue)09:28 | +-[ Teranishi ]
6364 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6365 416 09/22(Tue)12:38 | +-[ Teranishi ]
6366 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6367 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6371 Settings to make appearance of threads like shown above:
6375 (setq wl-thread-indent-level 2)
6376 (setq wl-thread-have-younger-brother-str "+")
6377 (setq wl-thread-youngest-child-str "+")
6378 (setq wl-thread-vertical-str "|")
6379 (setq wl-thread-horizontal-str "-")
6380 (setq wl-thread-space-str " ")
6384 If you do not want to see branches, do the following:
6388 (setq wl-thread-indent-level 2)
6389 (setq wl-thread-have-younger-brother-str " ")
6390 (setq wl-thread-youngest-child-str " ")
6391 (setq wl-thread-vertical-str " ")
6392 (setq wl-thread-horizontal-str " ")
6393 (setq wl-thread-space-str " ")
6398 @node User-Agent Field, , Thread Format, Advanced Settings
6399 @subsection User-Agent Field
6403 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6404 @samp{User-Agent:} fields, define a function that generate appropriate
6405 strings as you like, and set it to variable
6406 @code{wl-generate-mailer-string-func}.
6408 If you do not want verbose @samp{User-Agent:} field, do the following:
6412 (setq wl-generate-mailer-string-func
6415 (concat "User-Agent: "
6416 (wl-generate-user-agent-string-1 nil)))))
6420 The following is a example:
6424 (setq mime-edit-insert-user-agent-field nil)
6425 (setq wl-generate-mailer-string-func
6428 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6433 @node Customizable Variables, Hooks, Advanced Settings, Customization
6434 @section Customizable Variables
6436 Customizable variables that have not been described yet:
6439 @item wl-default-folder
6440 @vindex wl-default-folder
6441 The initial setting is @samp{%inbox}. This is the default value for moving to
6442 a folder and the like.
6444 @item wl-draft-folder
6445 @vindex wl-draft-folder
6446 The initial setting is @samp{+draft}. It is the folder to which drafts are
6447 saved. It must be a localdir folder.
6449 @item wl-trash-folder
6450 @vindex wl-trash-folder
6451 The initial setting is @samp{+trash}. It is the wastebasket folder.
6452 If you changed this variable, you had better restart Wanderlust.
6454 @item wl-interactive-exit
6455 @vindex wl-interactive-exit
6456 The initial setting is @code{t}.
6457 If non-nil, you are asked for confirmation when Wanderlust terminates.
6459 @item wl-interactive-send
6460 @vindex wl-interactive-send
6461 The initial setting is @code{nil}.
6462 If non-nil, you are asked for confirmation when mail is sent.
6464 @item wl-folder-sync-range-alist
6465 @vindex wl-folder-sync-range-alist
6466 The initial setting is the alist shown below:
6471 ("^\\+draft$\\|^\\+queue$" . "all"))
6476 This is an associative list of regular expressions of folder names and
6477 update range of the summary. Update range is one of the @samp{all},
6478 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6479 @samp{last}. If a folder do not match, @samp{update} is used.
6482 @vindex wl-ask-range
6483 The initial setting is @code{t}.
6484 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6485 for updating the summary when you changed folders.
6487 @item wl-mime-charset
6488 @vindex wl-mime-charset
6489 The initial setting is @code{x-ctext}.
6490 This is the MIME charset for messages that are not MIME (e.g. without
6491 @samp{Content-Type:}). This value also used as default charset for
6492 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6493 this value as @code{iso-2022-jp}.)
6495 @item wl-highlight-folder-with-icon
6496 @vindex wl-highlight-folder-with-icon
6497 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6498 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6500 @item wl-strict-diff-folders
6501 @vindex wl-strict-diff-folders
6502 This is a list of regular expressions of folders.
6503 Unread messages are checked, for example when you press @kbd{s} in
6504 the folder mode, usually in a brief way (rapidly processed but not
6506 The folders matching this variable are seriously checked.
6507 You may want to set this variable so as to match conditional filter
6508 folders for IMAP4 folders.
6509 The initial setting is @code{nil}.
6511 @item wl-folder-use-server-diff
6512 @vindex wl-folder-use-server-diff
6513 When unread messages are checked, for example when you press @kbd{s} in
6514 the folder mode, usually (the number of messages on the server) @minus{}
6515 (the number of local messages) will be the number of unread messages.
6516 However, if this variable is non-nil, the number of unread messages on
6517 the server is checked. This affects IMAP4 folders only, but IMAP4
6518 folders in mail boxes matching
6519 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6520 the number of unread messages on the server, even if they matches this
6521 variable. The initial setting is @code{t}.
6523 @item wl-auto-check-folder-name
6524 @vindex wl-auto-check-folder-name
6525 The initial setting is @code{nil}.
6526 If non-nil, the folder with the name of the value is checked for unread
6527 messages at the start.
6528 If it is @code{none}, no folders are checked.
6529 If it is a list, all folders in the list are checked at the start.
6531 @item wl-auto-uncheck-folder-list
6532 @vindex wl-auto-uncheck-folder-list
6533 The initial setting is the list shown below:
6542 Folders with the name matching this variable are not checked for unread
6543 messages at the start, even if they are included in the groups in
6544 @code{wl-auto-check-folder-name}.
6546 @item wl-auto-check-folder-list
6547 @vindex wl-auto-check-folder-list
6548 The initial setting is @code{nil}.
6549 Folders with the name matching this variable are always checked for
6550 unread messages at the start, if they are included in the groups in
6551 @code{wl-auto-check-folder-name}.
6552 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6554 @item wl-no-save-folder-list
6555 @vindex wl-no-save-folder-list
6556 The initial setting is the list shown below:
6565 This is a list of regular expressions of folders not to be saved.
6567 @item wl-save-folder-list
6568 @vindex wl-save-folder-list
6569 The initial setting is @code{nil}.
6570 This is a list of regular expressions of folders to be saved.
6571 This takes precedence over @code{wl-no-save-folder-list}.
6573 @item wl-folder-mime-charset-alist
6574 @vindex wl-folder-mime-charset-alist
6575 The initial setting is the alist shown below:
6579 (("^-alt\\.chinese" . big5)
6580 ("^-relcom\\." . koi8-r)
6582 ("^-han\\." . euc-kr))
6587 This is an associative list of regular expressions of folder names and
6589 If a folder do not match, @code{wl-mime-charset} is used.
6591 @item wl-folder-init-load-access-folders
6592 @vindex wl-folder-init-load-access-folders
6593 The initial setting is @code{nil}.
6594 This is a list of access groups to be loaded specifically at the start.
6595 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6597 @item wl-folder-init-no-load-access-folders
6598 @vindex wl-folder-init-no-load-access-folders
6599 The initial setting is @code{nil}.
6600 This is a list of access groups not to be loaded specifically at the
6602 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6604 @item wl-delete-folder-alist
6605 @vindex wl-delete-folder-alist
6606 The initial setting is the alist shown below:
6615 This list determines disposition of messages with delete marks.
6616 Each item in the list is a folder and destination; you can specify any
6617 one of the following in the place of destination:
6620 @code{remove} or @code{null} : deletes the messages instantly.
6621 string : moves the messages to the specific folder.
6622 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
6625 @item wl-refile-policy-alist
6626 @vindex wl-refile-policy-alist
6627 The initial setting is the list shown below:
6637 This list determines whether messages with re-file marks are moved or
6638 copied. Each item in the list is a cons cell of a folder and
6639 @code{copy} or @code{move}.
6641 @item wl-x-face-file
6642 @vindex wl-x-face-file
6643 The initial setting is @file{~/.xface}.
6644 The name of the file that contains encoded X-Face strings.
6647 @item wl-demo-display-logo
6648 @vindex wl-demo-display-logo
6649 If non-nil, bitmap image is shown on the opening demo. If you set
6650 @code{xpm} or @code{xbm}, (if possible) display selected image type
6653 @item elmo-use-database
6654 @vindex elmo-use-database
6655 This is meaningful for XEmacs only. The initial setting depends on
6656 XEmacs (@code{t} for XEmacs with dbm).
6657 If non-nil, Message-ID is controlled by dbm.
6659 @item elmo-passwd-alist-file-name
6660 @vindex elmo-passwd-alist-file-name
6661 The initial setting is @file{passwd}.
6662 This is the name of the file in which passwords are saved.
6663 @code{elmo-passwd-alist-save} saves current passwords to the file.
6665 @item elmo-nntp-list-folders-use-cache
6666 @vindex elmo-nntp-list-folders-use-cache
6667 The initial setting is 600 (in seconds).
6668 This is period in seconds during which results of @samp{list} and
6669 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6672 @item elmo-nntp-max-number-precedes-list-active
6673 @vindex elmo-nntp-max-number-precedes-list-active
6674 The initial setting is @code{nil}.
6675 If non-nil, the number of article obtained by @samp{list active} in NNTP
6676 are used as the maximum article number of the folder.
6677 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6678 and if the number of read messages is not correct.
6680 @item elmo-nntp-default-use-listgroup
6681 @vindex elmo-nntp-default-use-listgroup
6682 The initial setting is @code{t}.
6683 If non-nil, @samp{listgroup} is used for checking the total number of
6684 articles. If it is @code{nil}, @samp{group} is used. In the latter
6685 case, the processing will be a little faster at the sacrifice of
6688 @item elmo-pop3-send-command-synchronously
6689 @vindex elmo-pop3-send-command-synchronously
6690 The initial setting is @code{nil}.
6691 If non-nil, POP3 commands are issued synchronously. Some implementation
6692 of POP3 server fails to get summary information without this setting.
6693 You may have to set this variable to @code{t}, if the process hangs
6694 while looking up POP3.
6696 @item elmo-dop-flush-confirm
6697 @vindex elmo-dop-flush-confirm
6698 The initial setting is @code{t}.
6699 If non-nil, you are asked for confirmation if accumulated off-line
6700 operations are executed.
6702 @item elmo-display-progress-threshold
6703 @vindex elmo-display-progress-threshold
6704 The initial setting is 20.
6705 Threshold for display of progress gauge. If number of renewal is more than
6706 this value, display progress gauge.
6710 @node Hooks, , Customizable Variables, Customization
6716 @node Mailing List, Addition, Customization, Top
6717 @chapter Wanderlust Mailing List
6722 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6725 Topics related to Wanderlust are discussed in the mailing list.
6726 The latest version is also announced there (in Japanese, sorry).
6728 A guide can be obtained automatically by sending mail to
6729 @t{wl-ctl@@lists.airs.net} with the body
6734 Please send bug reports or patches to the mailing list. You can post to
6735 the mailing list even though you are not a member of it.
6737 If you send a bug report, please attach Backtrace with it.
6738 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
6741 I would like to express my thanks to the members of the mailing list for
6742 valuable advice and many pieces of code they contributed.
6745 @node Addition, Index, Mailing List, Top
6746 @chapter Additional Information
6748 @section Brief History
6751 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6752 3/10 Made a msgdb mechanism by elisp.
6753 3/26 IMAP and NNTP can be displayed in threads.
6754 4/13 Began to assemble thread display modules as elmo.
6755 5/01 Finished 0.1.0, initial version with many defects.
6756 6/12 I made a slip of the tongue and said I was writing elisp
6757 mailer supporting IMAP
6758 6/16 0.1.3 was announced at tm-ja, elisp ML.
6759 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6760 7/01 Support for mm-backend (0.3.0).
6761 8/25 multi folder added (0.5.0).
6762 8/28 filter folder added (0.5.1).
6763 9/10 You can open/close threads (0.6.0).
6764 9/11 fldmgr by Murata-san made editing folders easy.
6765 9/18 lha folders added by Okunishi-san (0.6.3).
6766 9/24 Display of branches of threads (0.6.5).
6767 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6768 10/28 Off-line operations (0.7.4).
6769 12/09 Becomes beta version.
6770 12/21 wl-expire by Murata-san.
6771 1999 2/03 auto-refile by Tsumura-san.
6772 4/28 wl-template by Murata-san.
6773 5/18 Released 1.0.0 stable.
6774 7/05 Scoring by Murata-san (2.1.0).
6775 9/26 New plugged system by Murata-san (2.2.2).
6776 12/20 Support Modified UTF7.
6777 2000 3/24 Released 1.1.0 stable.
6778 4/03 CVS development started.
6779 5/07 Thread restoration & Its speed up with Murata-san.
6780 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6781 7/11 killed message feature.
6782 7/18 Use UIDL in POP3.
6783 9/12 biff feature with Satata-san & Yamaoka-san.
6784 10/17 expire-hide by Okada-san.
6785 11/08 Released 2.4.0 stable.
6788 See @file{ChangeLog} for details.
6792 According to a dictionary, Wanderlust has the meaning:
6796 n eager longing for or impulse towards travelling in distant lands
6797 [Ger, fr wandern to wander + lust desire, pleasure]
6801 but I had no profound intention. (if farfetched, IMAP @result{} you can
6802 read mail anywhere @result{} desire to wander ?)
6804 Elmo is the abbreviation of @samp{Elisp Library for Message
6805 Orchestration}. At first I meant the red puppet in the Sesame Street,
6806 but you may associate it with Wandering @result{} Drifting @result{}
6807 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6811 Each versions has code names (they are almost jokes).
6812 Currently they are picked up alphabetically from the top 40 hits of
6813 U.S. Billboard magazines in 1980s.
6815 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
6818 @node Index, , Addition, Top
6822 * Concept Index:: Concept Index
6823 * Key Index:: Key Index
6824 * Variable Index:: Variable Index
6825 * Function Index:: Function Index
6828 @node Concept Index, Key Index, Index, Index
6829 @unnumberedsec Concept Index
6832 @node Key Index, Variable Index, Concept Index, Index
6833 @unnumberedsec Key Index
6836 @node Variable Index, Function Index, Key Index, Index
6837 @unnumberedsec Variable Index
6840 @node Function Index, , Variable Index, Index
6841 @unnumberedsec Function Index