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 @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 @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, 2.0.5 or later
177 @item AIR MAIL (AIRC imapd release 2.00)
179 @item Microsoft Exchange Server 5.5
180 @item Sun Internet Mail Server 4.0
183 @c LDAP connectivity with following LDAPd are confirmed to work with
187 @node Start Me Up, Folders, Introduction, Top
188 @chapter Start up Wanderlust
191 The necessary procedure for starting Wanderlust is explained in steps
194 (Of course, you need a mail/news readable environment in advance)
197 * MIME Modules:: Installing the MIME modules.
198 * Download:: Download and extract the packages.
199 * Install:: Byte-compile and install.
200 * Minimal Settings:: @file{.emacs} setup.
201 * Mail Addresses:: Address book definition.
202 * Folder Definition:: Folder definition.
203 * Start Wanderlust:: Starting Wanderlust
207 @node MIME Modules, Download, Start Me Up, Start Me Up
208 @section Installing MIME modules
215 SEMI or tm must be installed to make Wanderlust work correctly.
217 SEMI does not run on Emacs 19.28 or earlier
218 @footnote{SEMI runs on Emacs 19.34. @*
219 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} describes how to.},
220 so you must install tm, the predecessor of SEMI. (tm version 8.7 or later
223 However, SEMI is recommended because of its wider functionality.
225 Refer to the documents of each package for detailed installation procedure.
227 SEMI and tm can be downloaded from these sites:
231 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
232 tm: http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
236 You need packages named APEL and FLIM to use SEMI.
237 You can download APEL and FLIM from following URLs:
241 APEL: ftp://ftp.m17n.org/pub/mule/apel/
242 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
246 You have to install APEL, FLIM and SEMI in this order. Generally
247 @samp{make install} will do the job. (In XEmacs 21, @samp{make
250 Recommended combination of APEL, FLIM and SEMI are following:
253 @item APEL 10.2, FLIM 1.13.2 and SEMI 1.13.7
256 You can also use many other FLIM/SEMI variants. Combination of the
257 latest versions should work. For example, following combination is
261 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
262 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
265 You have to re-install Wanderlust if you upgraded APEL, FLIM, SEMI or
269 @node Download, Install, MIME Modules, Start Me Up
270 @section Download and Extract the Package
273 You can download Wanderlust package from following sites:
277 ftp://ftp.gohome.org/wl/
280 Mirrored ftp/http sites:
284 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
285 http://www.jpl.org/elips/wl/
286 http://www.ring.gr.jp/archives/text/elisp/wl/
287 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
288 ftp://opaopa.org/pub/mirror/elisp/wl/
289 @c ftp://roguelife.org/pub/tsumura/wl/
293 Extract the obtained package to your working directory:
298 % tar zxvf wl-@var{version}.tar.gz
299 % cd wl-@var{version}
303 @subsection To use SSL (Secure Socket Layer)
308 SSL (Secure Socket Layer) can be used for
309 SMTP, IMAP, NNTP and POP connections in Wanderlust.
311 There are two ways to use SSL. One is to start SSL negotiation just
312 after the connection establishment (generic way). The other one is to
313 start SSL negotiation by invoking STARTTLS command in the each session.
315 To use the formal SSL (generic SSL), you must install @file{ssl.el} in
316 the @file{utils} directory. OpenSSL command @command{openssl} is also
317 required to use @file{ssl.el}. You must set @env{PATH} to the directory
318 that OpenSSL commands are installed.
320 To use the latter SSL(STARTTLS), you must install starttls package in
322 You can download starttls package from the following site.
325 ftp://opaopa.org/pub/elisp/
328 @node Install, Minimal Settings, Download, Start Me Up
329 @section Byte-compile and install
336 @subsection Installation
338 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
339 Set the Emacs's command name to @code{EMACS}.
340 Set package installation directory to @code{LISPDIR}.
341 Then, please execute following commands.
350 Destination directory is auto-probed if you leave @code{LISPDIR}
351 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
353 If you are using an Emacs variant which does not merge specified directory
354 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
355 then you will see the error message:
358 Cannot open load file: mime-setup
362 In this case, either add destination directories of custom, APEL, FLIM
363 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
364 @code{load-path} in @file{WL-CFG} in extracted directory.
366 If you want to use BBDB, then the necessary modules are byte-compiled
367 and installed when BBDB directory is added to @code{load-path}.
370 @subsection @file{WL-CFG}
372 Contents of the file @file{WL-CFG} is loaded under installation if a file
373 with that name exists in extracted directory. You can use @file{WL-CFG} to
374 configure @code{load-path} to extra packages such as SEMI if needed.
376 If you want to specify the install directory of Wanderlust related
377 files, then set following variables in @file{WL-CFG}
381 A directory to install WL modules.
382 This directory is relative directory from @code{LISPDIR}.
383 WL modules include @file{wl*.el}, @file{wl*.elc} files.
384 @c Modules under the directory @file{util/} are also installed if
385 @c it detected as necessary.
388 A directory to install ELMO modules.
389 This directory is relative directory from @code{LISPDIR}.
390 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
391 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
395 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
397 If you want to install ELMO related files under a sub-directory
398 such as "elmo" then add following to @file{WL-CFG}:
401 (setq ELMO_PREFIX "elmo")
404 @subsection Install as a XEmacs package
405 @cindex XEmacs package
406 @cindex XEmacs package install
407 @cindex Package, XEmacs
408 @cindex Package install, XEmacs
409 @c @cindex install-package
411 It is possible to install Wanderlust as one of packages of XEmacs (21.0
412 or later). Configuration for autoload and icon-path in local
413 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
416 Follow the next example to install Wanderlust as an XEmacs package.
422 % make install-package
426 package directory is auto-probed, if SEMI is installed.
427 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
429 @subsection Run in place
431 If wl and elmo directories are defined in @code{load-path}, then
432 byte-compilation and installation are not necessary to start Wanderlust.
433 For example, if package is extracted in @file{~/work}, Wanderlust can be
434 invoked with following setting in @file{~/.emacs}.
438 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
439 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
445 Manual is described in Info format. Please do following.
454 If you install Wanderlust as a XEmacs package, Info file is already
455 installed too, so there are no need of these commands.
457 Manual directory is automatically detected. Of course, it can be
458 configured by @code{INFODIR} in @file{Makefile}.
460 You can read manual at the following URL:
463 http://www.gohome.org/wl/doc/wl-euc_toc.html
466 @node Minimal Settings, Mail Addresses, Install, Start Me Up
467 @section Set up .emacs
468 @cindex Minimal Settings
470 @cindex Configuration
474 The Wanderlust package contains two module groups.
477 @item ELMO (elmo-*.el)
478 These modules show everything as folders. This is the back-end for WL.
480 These modules controls the behavior of main body of Wanderlust.
481 They are also the front-end for ELMO.
484 You can customize the behavior of Wanderlust by changing the value
485 of environmental variables which begins with @code{elmo-} and @code{wl-}.
487 The minimal requirement for settings is as the following.
491 ;; @r{The setting to use SEMI/tm}
494 ;; @r{autoload configuration}
495 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
496 (autoload 'wl "wl" "Wanderlust" t)
497 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
499 ;; @r{Directory where icons are placed (XEmacs or Emacs 21).}
500 ;; @r{Default: @code{nil}.}
501 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
502 (setq wl-icon-dir "~/work/wl/etc")
504 ;; @r{SMTP server for mail posting. Default: @code{nil}}
505 (setq wl-smtp-posting-server "your.smtp.server.com")
506 ;; @r{NNTP server for news posting. Default: @code{nil}}
507 (setq wl-nntp-posting-server "your.nntp.server.com")
511 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
512 file exists). So it is convenient to gather Wanderlust specific settings
513 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
514 because you can't write them in @file{.emacs}
515 (if you write it to @file{.emacs}, you'll get an error).
518 All above described settings except (load "mime-setup") and autoload
519 configuration can be written in
522 @subsection @code{mail-user-agent}
523 @cindex Default Mailer
524 @cindex Mailer, Default
525 @vindex mail-user-agent
528 If you write following setting in you @file{.emacs}, you can
529 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
530 This means it enables you to run Wanderlust as a default mail composer
533 It is effective only when your Emacs can define @code{mail-user-agent}.
534 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
538 (autoload 'wl-user-agent-compose "wl-draft" nil t)
539 (if (boundp 'mail-user-agent)
540 (setq mail-user-agent 'wl-user-agent))
541 (if (fboundp 'define-mail-user-agent)
542 (define-mail-user-agent
544 'wl-user-agent-compose
552 @node Mail Addresses, Folder Definition, Minimal Settings, Start Me Up
553 @section Address book
554 @cindex Address book Definition
556 @cindex Alias, Address
558 The file @file{~/.addresses} is a simple address book for Wanderlust.
559 Make address file @file{~/.addresses}, and edit to suit your requirement.
561 The data written in @file{~/.addresses} are used for address completion
562 under draft editing mode. Furthermore, they are used when showing names
563 in summary display mode. You can safely skip this section, if you don't
564 want to customize address completion and summary display.
565 It is possible to add/change/remove addresses from @file{~/.addresses} in
566 summary buffer after Wanderlust is invoked. @refill
568 The format is very simple. Like this. @refill
573 # @r{Lines begin with @samp{#} are comment.}
574 # @r{Empty lines are ignored}
576 # @r{Format of each line:}
577 # @var{email-address} "@var{nickname} "@var{realname}"
579 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
580 foo@@bar.gohome.org "Mr. Foo" "John Foo"
581 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
586 One line defines one persons description.
588 Actually, in default setup, @var{nickname} is used in summary-mode and
589 @var{realname} is used in draft preparation mode. This behavior is
590 better understood if you try it and confirmed the function first. You
591 can write and try a small definition, so you will know the idea of the
592 address book before writing a big one.
594 And, if MH alias file is specified in variable @code{wl-alias-file},
595 it is used as an address information in the draft preparation mode.
597 If variable @code{wl-use-ldap} is non-nil (initial setting is
598 @code{nil}), address completion in draft mode uses LDAP information.
600 If you use LDAP, you have to set @code{wl-ldap-server},
601 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
602 not have LDAP feature as built-in feature (Currently only XEmacs can
603 have built-in LDAP feature), you have to set command exec @env{PATH} to
604 the program @command{ldapsearch}.
606 @node Folder Definition, Start Wanderlust, Mail Addresses, Start Me Up
607 @section Folder Definition
608 @cindex Folder Definition
611 You can skip this section because it is possible to add/edit the
612 subscribe folders from the buffer for list of folders.
614 Define the folders you want to subscribe in file @file{~/.folders}. The
615 contents written in @file{~/.folders} become the folders which you
616 subscribe to as it is.
618 Format for @file{~/.folders} is very simple. Here is an example:
623 # @r{Lines begin with @samp{#} are comment.}
624 # @r{Empty lines are ignored}
626 # @var{folder name} "@var{folder nickname}"
627 # @r{(nicknames are not necessary)}
632 %#mh/Backup@@my.imap.server.com "Sent"
635 %#mh/spool/wl "Wanderlust ML"
636 %#mh/spool/elips "ELIPS ML"
637 %#mh/spool/apel-ja "APEL Japanese ML"
638 %#mh/spool/xemacs-beta "XEmacs beta"
639 -fj.news.reader.gnus@@other.nntp.server.com "Gnus Net news"
640 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
643 # @r{If folder name ends with @samp{/}, that means an `access group',}
644 # @r{all subfolders automatically included in one folder group.}
646 %#mh/expire@@localhost /
647 # @r{All MH folders are included in one folder group.}
652 Each line contains one folder you want to read. The definition of
653 folders will be explained in detail in the next section.
655 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
656 become one folder group. One folder group is treated as a directory
657 which can bed opened and closed in folder mode. It is convenient for
658 collecting some folders and putting them in order.
660 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
661 line and you have to write it that way (It is because the parser sucks).
663 There are two types of groups. One is like @samp{Emacsen} from above
664 example which the user chooses his favorite folders as a group.
666 The other one is @dfn{access group} like @samp{+} from above example.
667 It makes all the sub-folders in a folder to a group. (It differs from
668 the type of the folder. For example, @samp{+} makes entire MH
669 sub-directories to one group)
671 This behavior is better understood if you try it and confirmed the
672 function first. You can write and try a small folder definition, so you
673 will know the idea of the folder function before writing the real one.
675 @node Start Wanderlust, , Folder Definition, Start Me Up
676 @section Start Wanderlust
677 @cindex Start Wanderlust
679 If installation and configuration worked well, you can invoke Wanderlust by
680 typing following command in Emacs.
687 After initialization, Folder Mode which shows the list of folders will appear.
688 That means the folders you defined in the @file{~/.folders} are listed
689 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
690 can skip folder checking.
693 @node Folders, Folder, Start Me Up, Top
694 @chapter Wanderlust's folders
697 This chapter describes the folder types which Wanderlust is able to handle.
699 Wanderlust uses ELMO as it's interface, so every folder types supported
700 by ELMO is usable in Wanderlust.
702 As of version @value{VERSION}, 10 types of folders are predefined. These are
703 IMAP, NNTP, LocalDir(MH), News Spool, POP, Archive, Multi, Filter, Pipe
704 and Internal folder types.
707 * IMAP Folder:: @samp{%} -- IMAP folder
708 * NNTP Folder:: @samp{-} -- NNTP folder
709 * MH Folder:: @samp{+} -- MH folder
710 * Maildir Folder:: @samp{.} -- Maildir folder
711 * News Spool Folder:: @samp{=} -- News spool folder
712 * Archive Folder:: @samp{$} -- Archive folder
713 * POP Folder:: @samp{&} -- POP folder
714 * Multi Folder:: @samp{*} -- Multi folder
715 * Filter Folder:: @samp{/} -- Filter folder
716 * Pipe Folder:: @samp{|} -- Pipe folder
717 * Internal Folder:: @samp{'} -- Internal folder
721 @node IMAP Folder, NNTP Folder, Folders, Folders
728 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
734 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
738 You can specify @code{login} (encoded password transmission),
739 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
740 authentication) or @code{plain} (or @code{nil}, plain password
741 transmission) as @var{authenticate-type}. (To use CRAM-MD5 or
742 DIGEST-MD5 authentication, you must install @file{utils/sasl} package.)
747 @var{username} -> The value of @code{elmo-default-imap4-user}.
748 Initial setting is @env{USER} environment variable or
749 @env{LOGNAME} environment variable or return value of
750 @code{(user-login-name)}.
751 @var{authenticate-type} -> The value of @code{elmo-default-imap4-authenticate-type}.
752 Initial setting is "auth".
753 @var{hostname} -> The value of @code{elmo-default-imap4-server}.
754 Initial setting is "localhost".
755 @var{port} -> The value of @code{elmo-default-imap4-port}.
756 Initial setting is 143.
759 You can omit the @var{hostname} from folder names if you set
760 @code{elmo-default-imap4-server} as your main IMAP server.
761 For example, you can specify a folder as @samp{foo%imap@@gateway} even
762 if you have to go through a firewall.
764 SSL (Secure Socket Layer) connection will be used if a folder name
765 ends with @samp{!}. Or, if the value of @code{elmo-default-imap4-ssl} is non-nil,
766 SSL will be the default connection.
767 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
768 If the value of @code{elmo-default-imap4-ssl} is 'starttls,
769 STARTTLS will be the default connection.
771 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
772 authentication method, the password is sent in encoded form. But, if
773 your server is unable to receive an encoded password, authentication
774 will fall back to @code{plain} (that is, sending password in raw format)
775 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
776 authentication will fall back to @code{plain} without confirmation
777 (default value is @code{nil}).
783 %inbox -> IMAP mailbox "inbox"
784 %#mh/inbox -> IMAP mailbox "#mh/inbox"
786 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
787 %inbox:hoge/login@@server1
788 -> server1's IMAP mailbox "inbox"
789 of user "hoge", with plain password authentication
794 @subsection International mailbox names (Modified UTF7)
795 @cindex Modified UTF7
802 You can use international mailbox names in @var{mailbox} part, if you
803 are using Emacs which can treat unicode and
804 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
805 value is @code{nil}).
807 Currently, following Emacsen can treat unicode.
810 @item Emacs 20.3 or later + Mule-UCS
812 If you installed Mule-UCS package, Emacs can treat unicode.
813 You can obtain Mule-UCS package from following URL.
816 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
819 @item XEmacs 21.2.13 or later + ucs-conv package
821 By default, XEmacs 21 cannot treat unicodes, but if you installed
822 ucs-conv package, it can.
823 You can obtain ucs-conv package from following anonymous CVS.
827 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
828 Password: @var{NULL} (Just enter return key)
829 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
833 You also need utf7 conversion programs, @command{u7tou8} and
834 @command{u8tou7} to use international mailbox name in the current
835 XEmacs. These programs are included in the UTF7 package which can be
836 obtained from following URL.
839 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
843 @node NNTP Folder, MH Folder, IMAP Folder, Folders
848 A folder to access USENET news via NNTP protocol (RFC 977).
849 One newsgroup is treated as a folder.
855 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
861 @var{hostname} -> The value of @code{elmo-default-nntp-server}.
862 Initial setting is @samp{localhost}.
863 @var{username} -> The value of @code{elmo-default-nntp-user}.
864 Initial setting is @code{nil}.
865 @var{port} -> The value of @code{elmo-default-nntp-port}.
866 Initial setting is 119.
869 AUTHINFO is used as authentication method if the @var{username} is non-nil.
870 SSL will be default method if @code{elmo-default-nntp-ssl} is non-nil even
871 if the folder name doesn't end with @samp{!}.
872 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
873 if the value of @code{elmo-default-nntp-ssl} is @code{starttls},
874 STARTTLS will be the default connection.
880 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
881 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
885 @node MH Folder, Maildir Folder, NNTP Folder, Folders
891 A folder to access MH format mail (1 file is 1 mail).
896 @samp{+} @var{directory-name}
899 Normally, @var{directory-name} is an relative path to the variable
900 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
901 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
902 (this is also true for drive-letters).
904 Message number is used for the name of the message file.
910 +inbox -> @file{~/Mail/inbox}
911 +from/teranisi -> @file{~/Mail/from/teranisi}
912 +~/test -> @file{~/test}
916 @node Maildir Folder, News Spool Folder, MH Folder, Folders
917 @section Maildir Folder
918 @cindex Maildir Folder
922 A folder to access to Maildir format (1 file is 1 mail).
927 @samp{.} [@var{directory-name}]
930 Normally, @var{directory-name} is a relative path to the variable
931 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
932 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
933 (this is also true for drive-letters).
935 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
936 Messages are contained in the @file{cur} directory. All message files
937 in the @file{new} directory are moved to @file{cur} directory when you
938 access to the folder. All message files contained in the @file{tmp}
939 directory and not accessed for 36 hours are deleted.
941 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
947 . -> @file{~/Maildir}
948 .inbox -> @file{~/Maildir/inbox}
949 .from/teranisi -> @file{~/Maildir/from/teranisi}
950 .~/test -> @file{~/test}
955 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
956 @section News Spool Folder
957 @cindex News spool Folder
961 This folder handles locally saved news articles which are proposed by
962 Mew/IM. You can also read articles directly from a spool-file which is
963 retrieved by an utility like @command{gnspool}.
968 @samp{=} @var{directory-name}
971 @var{directory-name} is a sub-directory to the directory defined by
972 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
973 You can use @samp{.} as directory delimiter as well as @samp{/}.
979 =fj/os/os2 -> @file{~/News/fj/os/os2}
980 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
985 @node Archive Folder, POP Folder, News Spool Folder, Folders
986 @section Archive Folder
987 @cindex Archive Folder
991 This method can handle archive files, which are compressed by utilities
992 such as Info-ZIP or LHA, as one folder.
998 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1002 @var{path-name} is the relative path from
1003 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1004 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1005 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1006 also permitted under the environment of ange-ftp, efs.
1008 The actual file name of the archive folder is
1009 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1010 under the @var{path-name}. If a file named @var{path-name} exists, it is
1011 treated as folder. The suffix is automatically decided for
1012 @var{archiver-type}.
1014 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1015 (Initial setting is @code{zip}) is referred.
1017 @var{prefix} specifies the internal directory structure of the archive.
1018 For example, if the ML server is fml, @file{msend.tar.gz} has a
1019 structure like @file{spool/1}, so you have to specify @samp{spool} as
1026 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1027 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1028 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1029 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1034 * Archiver:: Archivers supported
1035 * Archive Tips:: TIPS
1036 * Archive Vars:: Customization
1040 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1041 @subsection Supported Archives
1051 By default, following archives are supported.
1055 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1056 GNU TAR('tgz, 'tar) ;; read-only
1060 If your archiver can include multiple files in one archive, you have a
1061 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1062 of the candidate. TAR is supported read-only because it cannot delete
1063 file in the archive (@code{mv})).
1065 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1066 archiver of Wanderlust because they cannot include multiple
1067 files. Archivers that cannot extract files to standard output are also
1070 @subsection OS specific information about archiver.
1072 Behaviors of the following archivers are confirmed by further experiences.
1073 (@samp{*} mark means recommended archiver).
1076 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1077 LHA OS/2 version Rel.2.06b Feb 18, 1998
1078 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1079 *Zip 2.2 (November 3rd 1997).
1080 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1081 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1082 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1084 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1085 LHa for UNIX V 1.14c
1086 UnZip 5.32 of 3 November 1997
1087 Zip 2.2 (November 3rd 1997)
1088 GNU tar 1.12 (1.11.x is no good)
1089 gzip 1.2.4 (18 Aug 93)
1091 [Win32] Win.98/Meadow
1095 GNU tar 1.11.8 + 1.5(WIN32)
1102 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1103 Hiramatsu version of LHA is only supported.
1104 In Win32, LHa32 is only supported (DOS version is no good).
1106 * Caution about GNU tar
1108 You have to take care about GNU tar's version because many version has
1109 problem on deleting file from archive.
1111 Please test @option{--delete} @option{-f} options work. Otherwise, your
1112 archive will be destroyed. No problem is reported on above versions of
1116 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1118 @cindex Archive Tips
1120 For comfortable migration, usage of @code{wl-summary-archive}
1121 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1122 archive folders created by expiration, you must set non-nil value to
1123 @code{elmo-archive-treat-file}.
1125 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1126 in processing speed. For comfortable use, Emacs20 is recommended.
1127 (If re-search's performance is the problem, 19.3x or later may be okay.)
1129 If many files are included in one archive,
1130 it takes long time to access to the archive folder because
1131 archiver starting overhead is increased (especially LHA).
1132 150-200 messages in one archive is recommended.
1134 Of course, following is possible @t{:-)}
1135 (meanings of these variables are described later.)
1139 (setq wl-fcc "$backup")
1140 (setq wl-trash-folder "$trash;lha")
1144 @node Archive Vars, , Archive Tips, Archive Folder
1145 @subsection Variables About Archive Folder
1146 @cindex Archive variables
1149 @item elmo-archive-default-type
1150 @vindex elmo-archive-default-type
1151 The initial setting is @code{zip}.
1152 Set archiver type by symbol.
1154 @item elmo-archive-@var{type}-method-alist
1155 @vindex elmo-archive-TYPE-method-alist
1156 Define archiver @var{type}'s methods.
1157 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1158 Each element of the alist is following.
1162 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1163 (@var{action} . @var{function}) ;; function
1167 Currently available actions are following.
1171 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1172 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1179 actions enclosed with braces are optional (They are used for better
1182 @item elmo-archive-suffix-alist
1183 @vindex elmo-archive-suffix-alist
1184 An alist of archiver-type (symbol) and suffix.
1186 @item elmo-archive-file-regexp-alist
1187 @vindex elmo-archive-file-regexp-alist
1188 An alist of a regexp to get file number from list output of archiver
1189 and archiver-type (symbol).
1191 @item elmo-archive-method-list
1192 @vindex elmo-archive-method-list
1193 A list of elmo-archive-@var{type}-method-alist
1194 (@var{type} is a symbol of archiver-type).
1196 @item elmo-archive-lha-dos-compatible
1197 @vindex elmo-archive-lha-dos-compatible
1198 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1199 DOS (Mr. Yoshizaki original) compatible.
1201 @item elmo-archive-cmdstr-max-length
1202 @vindex elmo-archive-cmdstr-max-length
1203 The initial setting is 8000.
1205 Max length of command line argument for external archiver program.
1206 Emacs does not have a limit of command line byte length, but some OS
1207 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1208 this limit because it calls external archiver program directly (not
1209 called via shell). For example, you cannot delete messages if archiver
1210 program must receive larger bytes of arguments to delete. OS/2 have a
1211 command line argument limit of 8190 bytes, so we defined default as 8000
1214 However, you don't have an influence of command line argument limit
1215 if the archiver has `actions' to receive target file information from
1216 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1219 @node POP Folder, Multi Folder, Archive Folder, Folders
1227 A folder to access e-mails via POP3 protocol (RFC 1939).
1233 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1238 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1239 as @var{authenticate-type}.
1243 @var{username} -> The value of @code{elmo-default-pop3-user}.
1244 Initial setting is @env{USER} environment variable or
1245 @env{LOGNAME} environment variable or return value of
1246 @code{(user-login-name)}.
1247 @var{authenticate-type} -> The value of @code{elmo-default-pop3-authenticate-type}.
1248 Initial setting is @samp{user}.
1249 @var{hostname} -> The value of @code{elmo-default-pop3-server}.
1250 Initial setting is @samp{localhost}.
1251 @var{port} -> The value of @code{elmo-default-pop3-port}.
1252 Initial setting is 110.
1259 &hoge@@localhost -> access to localhost as user @samp{hoge}.
1260 &hoge@@popserver:109 -> access to the server "popserver" on port 109
1261 as user @samp{hoge}.
1265 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1266 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1267 @file{utils/sasl/lisp/} or Emacs/W3 package
1268 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1271 If the last character of the folder name is @samp{!}, Wanderlust
1272 connects to the POP server via SSL (Secure Socket Layer). If you set
1273 non-nil value to @code{elmo-default-pop-ssl}, you don't have to put
1274 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1275 with @samp{!!}, STARTTLS connection will be established. if the value
1276 of @code{elmo-default-pop-ssl} is @code{starttls}, STARTTLS will be the
1279 @node Multi Folder, Filter Folder, POP Folder, Folders
1280 @section Multi Folder
1281 @cindex Multi Folder
1283 @cindex Folder, Multiple
1284 @cindex Folder, Marge
1286 A folder to access to a folder which collects messages from
1287 multiple folders virtually.
1293 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1297 After @samp{*} character, specify multiple folders you want to collect
1298 separated by @samp{,} like
1299 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1305 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1306 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1307 treated as one folder.
1309 *+inbox,-fj.rec.tv,%inbox
1310 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1315 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1316 @section Filter Folder
1317 @cindex Filter Folder
1319 @cindex Folder, Filtering
1320 @cindex Folder, Virtual
1322 A folder to access to a folder which collects all messages that
1323 satisfy a condition virtually.
1328 @samp{/} @var{condition} @samp{/} @var{target-folder}
1331 In the @var{condition} part, you can specify following.
1335 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1337 first: @var{number} messages are picked from top of folder.
1338 last: @var{number} messages are picked from bottom of folder.
1344 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1345 /first:20/%inbox -> First 20 messages from %inbox are picked.
1350 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1352 since: only messages arrived since @var{date} are picked.
1353 before: only messages arrived before @var{date} are picked.
1355 You can specify following as @var{date}.
1359 yesterday -> a day before today.
1360 lastweek -> same day of last week.
1361 lastmonth -> same day of last month.
1362 lastyear -> same day of last year.
1363 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1364 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1372 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1374 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1380 Field filter: @samp{@var{field}:@var{value}}
1382 All messages that have @var{field} and its value is @var{value} are picked.
1383 @var{field} and @var{value} are case insensitive.
1389 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1390 and its value includes "teranisi" string are picked.
1391 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1399 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1400 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1402 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1403 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1409 /from:teranisi&!to:teranisi/+inbox
1410 -> In +inbox, messages are picked if the message's
1411 From: field includes "teranisi" and
1412 To: field doesn't include "teranisi".
1414 /tocc:"Yuuichi Teranishi"/+inbox
1415 -> In +inbox, messages are picked if the
1416 message's To: field or Cc: field includes
1417 "Yuuichi Teranishi".
1419 /(from:yt|from:teranisi)&subject:report/+inbox
1420 -> In +inbox, messages are picked if the message's
1421 From: field includes "yt" or "teranisi", and
1422 Subject includes "report".
1428 Tip for string description:
1430 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1431 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1432 should be escaped with @samp{\} in it). You can enclose the string with
1433 @samp{"} even it does not contain these characters.
1439 *%inbox,/from:teranisi/%inbox@@server
1440 -> Messages in %inbox or
1441 message is in the %inbox@@server folder and it's From field
1442 includes "teranisi" are collected.
1444 /last:100//to:teranisi/*+inbox,%inbox
1445 -> Latest 100 messages which is in the +inbox or %inbox folder
1446 and To: field matches "teranisi".
1448 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1449 -> Pick messages which have From: field and it includes "hogehoge"
1450 from latest 20 messages in the %#mh/inbox@@localhost
1451 and To: or Cc: field includes "teranisi".
1454 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1455 @section Pipe Folder
1459 @cindex Download Message
1460 @cindex Incorporate Message
1462 In the pipe folder, messages are automatically transferred from the source
1463 folder to destination folder.
1468 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1471 When you access to the pipe folder, messages are automatically transferred
1472 from @var{source-folder} to @var{destination-folder}.
1473 It is convenient if you want to download messages to local disk via POP.
1474 For example, if you specify following
1477 |&username@@popserver|+inbox
1481 and access to it, messages are downloaded automatically from
1482 @samp{&username@@popserver} to @samp{+inbox}.
1488 %inbox|%myinbox -> Download %inbox to %myinbox.
1489 *&user@@popserver1,&user@@popserver2|+inbox
1490 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1494 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1496 @node Internal Folder, , Pipe Folder, Folders
1497 @section Internal folder
1498 @cindex Internal Folder
1500 @cindex Folder, @samp{$} mark
1502 A folder to access to internal messages of Wanderlust.
1514 A folder named @samp{'mark} is a special virtual folder which collects
1515 messages which have important mark @samp{$}.
1517 You can review important messages at once after you put important marks
1518 on the messages in the different folders.
1520 In this folder, if you delete message, important mark @samp{$} put on
1521 the message is removed. If you append messages to this folder, the
1522 message will have @samp{$} mark.
1524 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1525 folder. If you want IMAP folder's message remove from @samp{'mark}
1526 folder, remove important mark at IMAP Folder.)
1528 You can access to the cached messages fetched via network by accessing
1529 to the folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1530 the name of the subdirectories of the cache directory
1531 (@file{~/.elmo/cache}).
1534 @node Folder, Summary, Folders, Top
1535 @chapter Folder mode
1538 After you start Wanderlust, folder mode is appeared firstly.
1539 It contains folder list you subscribed.
1540 You can select and edit folders in this mode.
1543 * Selecting Folder:: Select folder you want to read.
1544 * Folder Manager:: Editing folders.
1548 @node Selecting Folder, Folder Manager, Folder, Folder
1549 @section Selecting Folder
1550 @cindex Selecting Folder
1552 @subsection Usage (TIPS)
1554 @subsubsection Check new, unread number
1556 Folder mode looks like this.
1557 (In XEmacs, it looks much nicer @t{;-)})
1561 [-]Desktop:14186/35580/67263
1566 [-]Emacsen:0/34/4837
1567 Wanderlust ML:0/0/558
1570 XEmacs Beta:0/29/255
1581 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1585 @kbd{s} key on the folder line updates these numbers.
1586 It changes its color if it has many new messages.
1588 The whole folder mode is a folder group named @samp{Desktop}.
1589 Folder group open/close by return key.
1590 A operation to a folder group is treated as operations on the
1592 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1593 six children folders update its unread number status.
1595 @subsubsection Select Folder
1597 To enter summary mode of the folder, type return (or space) key on
1599 If the variable @code{wl-stay-folder-window} has non-nil value,
1600 summary window appears on the right of the folder mode window.
1602 @subsection Key bindings
1604 Folder mode's key binding (related to selecting folders) is following.
1609 @kindex @key{SPC} (Folder)
1610 @kindex @key{RET} (Folder)
1611 @findex wl-folder-jump-to-current-entity
1612 Enter to the summary mode of the folder at the current cursor point.
1613 If the cursor is on the top of folder group line,
1614 the folder group is opened or closed.
1615 When the cursor is on the access group and this command is called
1616 with prefix argument, folder children list is updated to the newest one.
1617 (Children list is updated recursively if the access folder has hierarchical
1619 (@code{wl-folder-jump-to-current-entity})
1622 @kindex M-@key{RET} (Folder)
1623 @findex wl-folder-update-recursive-current-entity
1624 Folder children list of the access group at the current cursor point
1625 is updated to the newest one.
1626 (Children list is updated recursively if the access folder has hierarchical
1628 (@code{wl-folder-update-recursive-current-entity})
1633 Create a new draft message.
1638 @findex wl-folder-write-current-newsgroup
1639 If the current cursor point is on the NNTP folder,
1640 create a new draft message which already has newsgroups field.
1641 (@code{wl-folder-write-current-newsgroup})
1644 @kindex C-c C-o (Folder)
1645 @findex wl-jump-to-draft-buffer
1646 Move to the draft buffer if available. If multiple draft buffer exists,
1647 moved to one after another. If prefix argument is specified, load draft
1648 folder's message to the draft buffer and jump to it.
1649 (@code{wl-jump-to-draft-buffer})
1653 @findex wl-folder-check-current-entity
1654 Update new and unread number information of the folder at the current
1656 (@code{wl-folder-check-current-entity})
1660 @findex wl-folder-sync-current-entity
1661 Update summary information of the folder at the current cursor point.
1662 (@code{wl-folder-sync-current-entity})
1665 @kindex r s (Folder)
1666 @findex wl-folder-check-region
1667 Update new and unread number information of the folders in the currently
1669 (@code{wl-folder-check-region})
1672 @kindex r S (Folder)
1673 @findex wl-folder-sync-region
1674 Update summary information of the folders in the currently selected region.
1675 (@code{wl-folder-sync-region})
1679 @findex wl-status-update
1680 Sync up address book status with @file{~/.addresses}'s content.
1681 (@code{wl-status-update})
1685 @findex wl-folder-prev-unread
1686 Jump cursor to the folder which have unread messages on the upward from
1687 current cursor point.
1688 (@code{wl-folder-prev-unread})
1692 Jump cursor to the folder which have unread messages on the downward
1693 from current cursor point.
1694 (@code{wl-folder-next-unread})
1698 Move cursor to the folder on the previous line.
1699 (@code{wl-folder-prev-entity})
1703 Move cursor to the folder on the next line.
1704 (@code{wl-folder-next-entity})
1708 Jump to the folder specified by the user input.
1709 (@code{wl-folder-jump-folder})
1713 @findex wl-folder-prefetch-current-entity
1714 Prefetch new messages of the folder at the current cursor point by
1715 @code{wl-summary-incorporate}.
1716 If the cursor is on the folder group, it is executed recursively.
1717 (@code{wl-folder-prefetch-current-entity})
1721 @findex wl-folder-mark-as-read-all-current-entity
1722 Mark all unread messages of the folder at the current cursor point as read.
1723 If the cursor is on the folder group, it is executed recursively.
1724 (@code{wl-folder-mark-as-read-all-current-entity})
1728 @findex wl-folder-goto-first-unread-folder
1729 Enter summary mode of the first unread folder.
1730 (@code{wl-folder-goto-first-unread-folder})
1734 @findex wl-folder-empty-trash
1736 (@code{wl-folder-empty-trash})
1740 @findex wl-folder-open-all-unread-folder
1741 All unread folder is opened.
1742 (@code{wl-folder-open-all-unread-folder})
1746 @findex wl-folder-open-close
1747 Folder group is opened/closed.
1748 (@code{wl-thread-open-close})
1752 All folder group is opened.
1753 (@code{wl-folder-open-all})
1757 All folder group is closed.
1758 (@code{wl-folder-close-all})
1768 (@code{wl-folder-suspend})
1771 @kindex M-s (Folder)
1772 Save current folder status.
1776 @kindex M-t (Folder)
1777 Toggle Wanderlust's offline/online status.
1778 (@code{wl-toggle-plugged})
1781 @kindex C-t (Folder)
1782 Start Wanderlust's plug-status manager.
1783 (@code{wl-plugged-change})
1786 @subsection Customize variables
1789 @item wl-folders-file
1790 @vindex wl-folders-file
1791 The initial setting is @file{~/.folders}.
1792 Subscribed folders are described (saved) in this file.
1794 @item wl-folder-info-save
1795 @vindex wl-folder-info-save
1796 The initial setting is @code{t}. If non-nil, unread information is
1797 saved and used in the next Wanderlust session.
1799 @item wl-stay-folder-window
1800 @vindex wl-stay-folder-window
1801 The initial setting is @code{nil}.
1802 If non-nil, summary window is appeared on the right side of the folder buffer.
1804 @item wl-folder-window-width
1805 @vindex wl-folder-window-width
1806 The initial setting is 20.
1807 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1809 @item wl-folder-many-unsync-threshold
1810 @vindex wl-folder-many-unsync-threshold
1811 The initial setting is 70.
1812 If the number of unread messages is more than this value,
1813 folder color is changed.
1815 @item wl-highlight-folder-by-numbers
1816 @vindex wl-highlight-folder-by-numbers
1817 This option controls how to highlight each line in the folder buffer.
1818 The default value is @code{t}, highlighting with various colors based on
1819 the message numbers. If it is @code{nil}, highlighting with various
1820 colors based on the folder status. In addition, if it is a number
1821 (e.g. 1), highlighting will be done based on both the message numbers
1822 and the folder status.
1824 @item wl-folder-desktop-name
1825 @vindex wl-folder-desktop-name
1826 The initial setting is @samp{Desktop}.
1827 The name of top folder group.
1829 @item wl-folder-petname-alist
1830 @vindex wl-folder-petname-alist
1831 The initial setting is @code{nil}.
1832 An alist of folder's realname and its nickname.
1834 @item wl-folder-access-subscribe-alist
1835 @vindex wl-folder-access-subscribe-alist
1836 The initial setting is @code{nil}.
1838 Control automatic subscribing and unsubscribing of the children list
1844 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1848 If @var{subscribe-flag} is non-nil, folders which have name matched to
1849 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1850 already unsubscribed folder is not displayed even when the
1851 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1858 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1859 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1860 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1861 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1865 @item wl-folder-hierarchy-access-folders
1866 @vindex wl-folder-hierarchy-access-folders
1867 The initial setting is the list shown below:
1876 A list of access groups which creates children folder list hierarchically.
1878 For example, if you specify
1879 @code{wl-folder-hierarchy-access-folders} like following,
1883 (setq wl-folder-hierarchy-access-folders
1884 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1889 such access group hierarchy is obtained.
1895 -fj.comp.announce:0/0/2
1896 -fj.comp.dev.cdrom:0/0/0
1898 [+]-japan:238/238/1688
1901 -comp.unix.admin:0/0/0
1902 -comp.unix.dos-under-unix:0/0/0
1903 -comp.unix.programmer:0/0/0
1904 [-]-comp.unix.bsd:0/0/23
1905 -comp.unix.bsd.freebsd.announce:0/0/0
1910 If you opened @samp{-} in this example, only the direct children is created
1911 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1912 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1913 is not created until the children access group is opened.
1917 @node Folder Manager, , Selecting Folder, Folder
1918 @section Editing Folders
1919 @cindex Folder Manager
1920 @cindex Folder, Edit
1921 @cindex Folder, Subscribe
1922 @cindex Folder, Unsubscribe
1924 As described before, subscribed folder list is saved in @file{~/.folders} file.
1925 But you don't have to edit @file{~/.folders} directly.
1926 You can append, delete, edit folders from folder mode.
1928 @subsection Usage (Tips)
1930 @subsubsection Append Folder
1932 @kbd{m a} appends new folder to the folder mode.
1933 @kbd{m g} appends new folder group.
1934 To append new folder to this group, firstly open it,
1935 then execute append command in the next line.
1937 @subsubsection Edit Folder
1939 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1940 Thus, you can change folder position as if you were editing a normal file.
1942 @subsubsection Create Multi Folder.
1946 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
1948 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
1950 Type @kbd{m m}, then you can create multi folder.
1953 @subsubsection Delete Nickname, Filter
1955 You can delete nickname or filter by putting ``''(@var{NULL}) from the
1956 minibuffer while appending.
1958 @subsubsection Append Folder to Empty Group
1960 To append new folder to the empty folder group
1961 (after you create folder group by typing @kbd{m g}),
1962 firstly open it, then execute append command in the next line.
1963 If it is closed, folder is appended on the same level with
1964 the above folder group. It is difficult to explain by words so try it.
1965 In other words, appended position depends on the
1966 above folder group's open/close status.
1968 @subsubsection Charset of the Folders File.
1970 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
1972 @subsubsection Create Filter
1974 @kbd{m f} adds filter to the folder at the current cursor point. To
1975 create new filter folder and leave the current folder unchanged, copy it
1976 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
1977 filter can be specified while appending filter. If you put
1978 ``''(@var{NULL}), filter is deleted.
1980 @subsubsection Sort Folders
1982 Sorting of the folders is executed by the function specified by
1983 @code{wl-fldmgr-sort-func}.
1984 The initial setting is @code{wl-fldmgr-sort-standard},
1985 which sorts alphabetically.
1986 Sorting affects only on the current folder group. It does not
1987 affect on the child groups.
1989 @subsubsection Hiding Folders in the Access Group
1991 Usually, access group displays all children folders, but you can set
1992 some folders hidden. Following operations are only available on access
1995 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
1996 (subscribe/unsubscribe) of the folder at current cursor point. Against
1997 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2000 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2001 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2002 argument and if the argument has positive number, the unsubscribe it.
2003 If the prefix argument has negative value, folder becomes visible and if
2004 zero, folder visibility is toggled.
2006 The other commands, @code{wl-fldmgr-subscribe} and
2007 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2010 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2011 executed in the access group, they have a same effect with
2012 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2013 The difference is that cut commands deletes folders from the current
2016 @subsubsection Operations in the Access Group
2018 You can insert and delete folders in the access group like usual folder
2019 group. But insert and delete commands can be only available for the
2020 children folders of the access group and they only sets the subscribe
2021 status. In other words, insertion of the folder means subscribing,
2022 deletion means unsubscribing.
2023 @footnote{In the current implementation,
2024 it is faster to delete region than to unsubscribe region.}
2026 To update the access group when children folders are inserted or deleted
2027 by other way (other than Wanderlust),
2028 open the access group by typing @kbd{C-u @key{RET}}.
2029 @xref{Selecting Folder}.
2031 The order of children folders of access group is saved after
2032 insertion/deletion/sorting.
2033 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2034 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2035 newly created folders are inserted on the top of the access group.
2037 @subsection Key bindings
2038 @cindex Keybind, Folder Mode
2039 @cindex Keybind, Folder Buffer
2041 Key bindings on the folder mode related to folder editing are shown below.
2042 All bindings starts with @kbd{m}, and primary commands are binded to
2043 one stroke key binding.
2047 @kindex m a (Folder)
2048 @findex wl-fldmgr-add
2050 (@code{wl-fldmgr-add})
2055 @kindex m g (Folder)
2056 @findex wl-fldmgr-make-group
2057 Create a folder group.
2058 (@code{wl-fldmgr-make-group})
2061 @kindex m A (Folder)
2062 @findex wl-fldmgr-make-access-group
2063 Create an access group.
2064 (@code{wl-fldmgr-make-access-group})
2067 @kindex m d (Folder)
2068 @findex wl-fldmgr-delete
2069 Delete folder itself and msgdb.
2070 If the folder itself cannot be deleted like NNTP folder,
2071 only msgdb is deleted.
2072 (@code{wl-fldmgr-delete})
2077 @kindex m R (Folder)
2078 @findex wl-fldmgr-rename
2079 Change the name of folder or folder group.
2080 msgdb's path is also changed.
2081 (@code{wl-fldmgr-rename})
2087 @findex wl-fldmgr-make-multi
2088 Create a multi folders in the cutlist (cut, copied folders).
2089 (@code{wl-fldmgr-make-multi})
2094 @kindex m f (Folder)
2095 @findex wl-fldmgr-make-filter
2096 Create a filter folder. (Put a filter on the folder).
2097 (@code{wl-fldmgr-make-filter})
2101 @kindex M-c (Folder)
2102 @kindex m c (Folder)
2103 @findex wl-fldmgr-copy
2104 Copy folder (it is not available on folder group).
2105 (@code{wl-fldmgr-copy})
2109 @kindex M-w (Folder)
2110 @kindex m W (Folder)
2111 @findex wl-fldmgr-copy-region
2112 Copy folders in the specified region.
2113 (@code{wl-fldmgr-copy-region})
2117 @kindex C-k (Folder)
2118 @kindex m k (Folder)
2119 @findex wl-fldmgr-cut
2120 Cut folder. Folder itself is not deleted.
2121 (@code{wl-fldmgr-cut})
2125 @kindex C-w (Folder)
2126 @kindex m C-w (Folder)
2127 @findex wl-fldmgr-cut-region
2128 Cut folders in the specified region.
2129 (@code{wl-fldmgr-cut-region})
2133 @kindex C-y (Folder)
2134 @kindex m y (Folder)
2135 @findex wl-fldmgr-yank
2136 Paste folders that are copied or cut (folders in the cut-list).
2137 (@code{wl-fldmgr-yank})
2140 @kindex m p (Folder)
2141 @findex wl-fldmgr-set-petname
2142 Put nickname on the folder.
2143 (@code{wl-fldmgr-set-petname})
2146 @kindex m q (Folder)
2147 @findex wl-fldmgr-clear-cut-entity-list
2148 Clear the cut-list. (cut, copied folder information is cleared,
2149 you cannot paste after this)
2150 (@code{wl-fldmgr-clear-cut-entity-list})
2153 @kindex m s (Folder)
2154 @findex wl-fldmgr-sort
2155 Sort folders in the current folder group.
2156 (@code{wl-fldmgr-sort})
2159 @kindex m C-s (Folder)
2160 @findex wl-fldmgr-save
2161 Save current folder view to the @file{wl-folders-file}.
2162 (@code{wl-fldmgr-save})
2165 [Following commands are only available on the access groups]
2171 @kindex m u (Folder)
2172 @findex wl-fldmgr-unsubscribe
2173 Set the visibility of folder (subscribe/unsubscribe).
2174 (@code{wl-fldmgr-unsubscribe})
2179 @kindex r u (Folder)
2180 @findex wl-fldmgr-unsubscribe-region
2181 Set the visibility of the folders (subscribe/unsubscribe) in the
2183 (@code{wl-fldmgr-unsubscribe-region})
2188 @kindex m l (Folder)
2189 @findex wl-fldmgr-access-display-normal
2190 List folders that are currently available.
2191 (@code{wl-fldmgr-access-display-normal})
2196 @kindex m L (Folder)
2197 @findex wl-fldmgr-access-display-all
2198 List all folders regardless of the subscription status.
2199 (@code{wl-fldmgr-access-display-all})
2203 @subsection Customize variables
2206 @item wl-interactive-save-folders
2207 @vindex wl-interactive-save-folders
2208 The initial setting is @code{t}. If non-nil and folder view is
2209 modified, confirm saving it before Wanderlust or Emacs exits. If
2210 @code{nil}, save without confirmation.
2212 @item wl-fldmgr-make-backup
2213 @vindex wl-fldmgr-make-backup
2214 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2215 created before saving the folder status.
2217 @item wl-fldmgr-sort-func
2218 @vindex wl-fldmgr-sort-func
2219 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2220 sort folders. By default function, folders are sorted alphabetically
2221 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2224 @item wl-fldmgr-sort-group-first
2225 @vindex wl-fldmgr-sort-group-first
2226 The initial setting is @code{t}. If non-nil,
2227 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2228 does not care whether it is folder group or not.
2230 @item wl-folder-check-async
2231 @vindex wl-folder-check-async
2232 The initial setting is @code{t}. If non-nil, check folder's unread
2233 status asynchronously. It boosts newsgroup checking.
2235 @item wl-folder-check-fast
2236 @vindex wl-folder-check-fast
2237 The initial setting is @code{nil}.
2238 If non-nil, it does not update folder status while checking.
2240 @item wl-folder-notify-deleted
2241 @vindex wl-folder-notify-deleted
2242 The initial setting is @code{nil}.
2244 If non-nil, negative value is displayed when the message is deleted. If
2245 @code{sync}, folder is synchronized when the message is deleted. If
2246 @code{nil}, message deletion is ignored.
2249 @subsection Miscellanea
2251 Following is a note for folder editing.
2255 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2256 paste(yank) command pastes the folders on one cut or copy command
2257 (If copy command is executed by region, folders in the region are pasted
2258 by one paste command)
2261 You cannot cut @samp{Desktop} group.
2262 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2265 You cannot copy folder group.
2268 Operations on the access group are only available for the folders
2269 in the same access group.
2272 You cannot create a folder which has same name with the folders already exist.
2275 You cannot insert folders which have same name in one group.
2276 You can insert them in the different groups.
2277 You cannot put same nickname to the different folders.
2281 @node Summary, Message, Folder, Top
2282 @chapter Summary Mode
2284 After you select the folder via folder mode, you enter to the summary
2288 * Usage of Summary Mode:: TIPS.
2289 * Thread Operations:: Thread operations.
2290 * Cache:: File cache, Buffer cache, and Prefetch.
2291 * Auto Refile:: Auto refile settings.
2292 * Sticky Summary:: Summary make sticky.
2293 * Key Bindings of Summary:: Key bindings.
2294 * Variables of Summary:: Customize Summary Mode.
2298 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2299 @section Usage (Tips)
2301 @subsection Summary Content
2303 In the summary mode, messages are displayed like following.
2307 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2308 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2309 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2310 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2317 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2321 You cannot change this in the current version.
2323 @var{Message number} is the message's unique number in the folder. In
2324 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2325 in the MH folder, it is the filename of the message.
2327 @var{Temporal mark} and @var{Persistent mark} are described later.
2329 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2330 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2331 Japanese, but if you want to display it in English, set the value of
2332 @code{wl-summary-weekday-name-lang} as @samp{en}.
2334 @var{Sender}'s indentation corresponds to the depth of the thread.
2335 Sender name is displayed as nickname if it is defined in the address
2336 book. Set @code{wl-use-petname} as @samp{nil}, if you want to quit
2337 displaying with nickname.
2339 If number is printed at the head of @var{Sender} part like @samp{+2},
2340 that means the message have 2 follow messages.
2342 @var{Subject} is the @samp{Subject:} header field of the message. If
2343 the message have same @samp{Subject:} with the parent message, it is not
2344 displayed. Some mailing list puts its sequence number in the
2345 @samp{Subject:} field, but it is
2346 ignored. @code{wl-summary-no-subject-message} is displayed when the
2347 message has empty subject field.
2349 @subsection Temporary Marks
2350 @cindex Mark, Temporary
2352 There are four temporary marks,
2353 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2354 Temporary marks indicates message operations.
2359 You can execute a command on the all messages that have @samp{*} mark,
2360 with the key bindings which begins with @kbd{m}.
2363 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2367 After you type @kbd{o} key, prompt appears to input refile destination.
2368 Your answer is printed in the summary line.
2372 You can put this mark by typing @kbd{O} key.
2373 The difference between this mark and refile mark is,
2374 this mark does not delete the message while latter does.
2377 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2379 @subsection Persistent Marks
2381 There are five persistent marks,
2382 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2384 The persistent mark indicates the message's status and it is saved.
2385 Each persistent mark indicates:
2391 It is unread message.
2393 It is unread but cached message.
2395 It is read but it is not cached.
2397 It is important message. You can put @samp{$} mark by typing @kbd{$}
2398 key (if already exists, the mark is deleted). It is convenient to put
2399 this mark on the messages to remember (If you want to remember to write
2400 a reply for the message, for example) because this mark remains after
2401 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2402 even the message itself is deleted in the actual folder.
2405 If the message is read and cached (or local message),there are no
2409 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2410 cache. Messages with the marks other than these, you can read them in
2411 the offline status even they are in the IMAP folder or netnews folder.
2413 @subsection How To Read
2415 Basically, you can read messages only typing space key again and again.
2417 To update summary status to the newest status (synchronize),
2420 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2421 moves cursor to the next message.
2422 Enter message buffer by typing @kbd{j} key.
2423 To operate multipart, you have to enter to the message buffer.
2427 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2428 @section Thread Operations
2430 For example, the following line indicates one thread (a context of a topic).
2433 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2437 If you type @kbd{/} on this line, the thread is opened and it changes
2438 the appearance like following.
2442 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2443 388 09/17(Thu)22:34 +-[ Murata san ]
2447 (Message 388 is the replied message to the message 384.)
2448 If you type @kbd{/} key once again, the thread is closed.
2449 With prefix argument, @kbd{/} opens all children threads.
2451 Commands with the key binding that begins with @kbd{t} executes commands
2452 on the messages in the thread.
2455 @node Cache, Auto Refile, Thread Operations, Summary
2458 @subsection Cache File
2460 The messages which have to access via network (e.x. IMAP, NNTP folder)
2461 are cached as a local file. The cache file is saved under the directory
2462 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2463 elmo-cache-expire-by-size}. The command deletes cache files to the
2464 specified size by the order of last accessed time.
2466 @subsection Buffer Cache and Prefetching
2468 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2469 that are read are kept in the cache buffer. It is called `buffer
2470 cache'. The number of cache buffer is specified by
2471 @code{elmo-buffer-cache-size}.
2473 There are message prefetching mechanism in the Wanderlust that
2474 prefetches next message while you are reading. This function requires
2475 that the value of @code{elmo-use-buffer-cache} is non-nil.
2477 You can control the message prefetching mechanism by these two
2481 @item wl-cache-prefetch-folder-type-list
2482 @vindex wl-cache-prefetch-folder-type-list
2483 The initial setting is the list shown below:
2491 It specifies the folder types in which message prefetching is enabled.
2492 In the initial setting, multi folder that contains localdir and imap4
2493 prefetches only imap4 messages. This variable precedes the value of
2494 @code{wl-cache-prefetch-folder-list}.
2496 If you want to prefetch localdir and localnews also, following setting
2501 (setq wl-cache-prefetch-folder-type-list
2502 '(nntp imap4 localdir localnews))
2506 @item wl-cache-prefetch-folder-list
2507 @vindex wl-cache-prefetch-folder-list
2508 The initial setting is @code{nil}.
2509 A list of regexp of folders to enable message prefetching.
2513 @node Auto Refile, Sticky Summary, Cache, Summary
2514 @section Auto Refile
2515 @vindex elmo-msgdb-extra-fields
2516 @vindex wl-refile-rule-alist
2517 @findex wl-summary-auto-refile
2519 You can refile messages automatically, by typing @kbd{C-o}
2520 (@code{wl-summary-auto-refile}). It decides destination of refile by
2521 the content of the message header information (information in the msgdb).
2523 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2524 available. If you want to decide destination by other header fields,
2525 set the variable @code{elmo-msgdb-extra-fields} like following.
2529 (setq elmo-msgdb-extra-fields
2539 By this setting, Wanderlust saves extra fields in the msgdb. You have
2540 to type @kbd{s all} to get extra fields for the messages that are
2541 already exists in the summary.
2543 Then, specify the refile rule. The refile target folder of auto
2544 refiling is decided by the value of @code{wl-refile-rule-alist}.
2545 @code{wl-refile-rule-alist} is a list of a rule:
2549 (@var{field} (@var{regexp} . @var{target})
2550 (@var{regexp} . @var{target})
2555 Each rule means `if @var{field} value matches @var{regexp},
2556 then refile to @var{target} folder'.
2557 The rule matched first is applied.
2559 @var{field} is a string of field name. You can specify a list of field name
2560 string, too. In this case, if one of these fields is matched, then the
2561 rule is fired (i.e. OR condition).
2563 @var{regexp} is a regular expression for field value. @var{target} is a target
2564 folder string. You can specify a rule at @var{target} part, too. In this
2565 case, If the field value of the rule and the current rule is matched,
2566 then the current rule is fired (i.e. AND condition).
2568 In @var{target} part, you can refer matched substring of @var{regexp}.
2569 To refer substring, specify following in @var{target}:
2573 means substitute original matched text.
2576 means substitute what matched the @var{N}th `\(@dots{}\)'.
2577 (@var{N} is a number.)
2580 Following is an example of @code{wl-refile-rule-alist}.
2584 (setq wl-refile-rule-alist
2586 ("^Wanderlust" . "+wl")
2587 ("^Elisp" . "+elisp"))
2589 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2591 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2592 "+from-me-to-you"))))))
2596 After these settings, refile marks are automatically put on the condition
2597 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2599 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2601 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2602 with these persistent marks are not automatically refiled.
2603 It means Wanderlust does not execute auto refile on unread messages by
2604 the default setting.
2605 To execute auto refile on all messages, set following.
2608 (setq wl-summary-auto-refile-skip-marks nil)
2612 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2613 @section Sticky Summary
2614 @cindex Summary, Sticky
2615 @cindex Sticky Summary
2617 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2619 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2620 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2622 The buffer name of the sticky summary becomes like
2623 @samp{Summary:@var{folder-name}}.
2625 You can visit the sticky summary at any time by @kbd{C-x b}
2626 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2627 q}. Other operations in the sticky summary are same as normal summary.
2629 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2630 are automatically sticked.
2633 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2634 @section Key bindings
2635 @cindex Keybind, Summary Mode
2636 @cindex Keybind, Summary Buffer
2638 Key bindings of the summary mode are shown below.
2642 @kindex @key{SPC} (Summary)
2643 @findex wl-summary-read
2644 Proceed reading a message at the current cursor point.
2645 (@code{wl-summary-read})
2649 @findex wl-summary-redisplay
2650 Redisplay a message at the current cursor point.
2651 If this command is called with prefix argument,
2652 Redisplay message regardless of the message cache (message is re-loaded
2654 (@code{wl-summary-redisplay})
2658 @findex wl-summary-display-top
2659 Display the top message in the folder.
2660 (@code{wl-summary-display-top})
2664 @findex wl-summary-display-bottom
2665 Display the bottom message in the folder.
2666 (@code{wl-summary-display-bottom})
2670 @kindex @key{BS} (Summary)
2671 @kindex @key{DEL} (Summary)
2672 Display the previous page of the message at the current cursor point.
2673 @findex wl-summary-prev-page
2674 (@code{wl-summary-prev-page})
2677 @kindex @key{RET} (Summary)
2678 @findex wl-summary-next-line-content
2679 Display the next line of the message at the current cursor point.
2680 Display the message at the current cursor point if it is not displayed yet.
2681 (@code{wl-summary-next-line-content})
2686 @kindex M-@key{RET} (Summary)
2687 @findex wl-summary-prev-line-content
2688 Display the previous line of the message at the current cursor point.
2689 Display the message at the current cursor point if it is not displayed yet.
2690 (@code{wl-summary-prev-line-content})
2694 @findex wl-thread-open-close
2695 Toggle open or close the thread at the current cursor point.
2696 (@code{wl-thread-open-close})
2701 @findex wl-thread-open-all
2702 (@code{wl-thread-open-all})
2707 @findex wl-thread-close-all
2708 (@code{wl-thread-close-all})
2712 @findex wl-summary-goto-folder
2714 (@code{wl-summary-goto-folder})
2718 Mark all messages in the folder as read.
2719 @findex wl-summary-mark-as-read-all
2720 (@code{wl-summary-mark-as-read-all})
2724 @findex wl-summary-reply
2725 Prepare a draft for reply the message at the current cursor point.
2726 (@code{wl-summary-reply})
2730 @findex wl-summary-reply-with-citation
2731 Prepare a draft for reply the message at the current cursor point.
2732 (@code{wl-summary-reply-with-citation})
2736 @findex wl-summary-cancel-message
2737 If the message at current cursor point is your own netnews article,
2739 (@code{wl-summary-cancel-message})
2743 @findex wl-summary-reedit
2744 Prepare a draft for re-editing the message at current cursor point.
2745 If the message at current cursor point is your own netnews article,
2746 a draft for `supersedes message' for the message is prepared.
2747 (@code{wl-summary-reedit})
2750 @kindex M-e (Summary)
2751 @findex wl-summary-resend-bounced-mail
2752 If the message at current cursor point is a bounced message,
2753 a draft for re-sending original message is prepared.
2754 (@code{wl-summary-resend-bounced-mail})
2758 @findex wl-summary-forward
2759 A draft for forwarding the message at current cursor point is prepared.
2760 (@code{wl-summary-forward})
2764 @findex wl-summary-mark-as-important
2765 Put @samp{$} mark on the message at current cursor point.
2766 If already marked as @samp{$}, delete it.
2767 (@code{wl-summary-mark-as-important})
2773 Save the message at current cursor point.
2774 @findex wl-summary-save
2775 (@code{wl-summary-save})
2779 @findex wl-summary-next
2780 Move cursor to the next message.
2781 If message is marked with a temporal mark in
2782 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2783 In the offline mode, cursor is not moved to the messages which are not cached
2785 (@code{wl-summary-next})
2789 @findex wl-summary-prev
2790 Move cursor to the previous message.
2791 If message is marked with a temporal mark in
2792 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2793 In the offline mode, cursor is not moved to the messages which are not cached
2795 (@code{wl-summary-prev})
2799 @findex wl-summary-down
2800 Move cursor to the downward message which is unread or marked
2802 (@code{wl-summary-down})
2806 @findex wl-summary-up
2807 Move cursor to the upward message which is unread or marked
2809 (@code{wl-summary-up})
2813 @findex wl-summary-write
2814 Prepare a new draft.
2815 (@code{wl-summary-write})
2819 @findex wl-summary-write-current-newsgroup
2820 Prepare a new draft. If the current folder is netnews folder,
2821 @samp{Newsgroups:} field is completed.
2822 (@code{wl-summary-write-current-newsgroup})
2826 @findex wl-summary-redisplay-all-header
2827 Redisplay the message at current cursor point with all header fields.
2828 (@code{wl-summary-redisplay-all-header})
2832 @findex wl-summary-redisplay-no-mime
2833 Redisplay the message at current cursor point without MIME analysis.
2834 (@code{wl-summary-redisplay-no-mime})
2838 @findex wl-summary-burst
2839 If the message at current cursor point has
2840 encapsulates multiple messages using MIME,
2841 de-capsulate and extract them on the current folder.
2842 (@code{wl-summary-burst})
2845 @kindex @@ (Summary)
2846 @findex wl-summary-edit-addresses
2847 Append/change/delete the message's sender information to the address
2848 book @file{~/.addresses} interactively. If this command is called with
2849 prefix argument, arbitrary address can be edited.
2850 (@code{wl-summary-edit-petname})
2854 @findex wl-status-update
2855 Sync up address book status with @file{~/.addresses}'s content.
2856 (@code{wl-status-update})
2860 @findex wl-summary-pipe-message
2861 Pipe current message's content to the external process.
2862 (@code{wl-summary-pipe-message})
2866 @findex wl-summary-print-message
2867 Print out current message's content.
2868 It uses @code{ps-print} module in Emacs 20.x.
2869 If you don't use color printer, you might want to set
2870 @code{wl-ps-print-buffer-func} to @code{ps-print-buffer}.
2873 (setq wl-ps-print-buffer-func 'ps-print-buffer)
2876 (@code{wl-summary-print-message})
2880 @findex wl-summary-exit
2881 Exit current folder.
2882 (@code{wl-summary-exit})
2886 @findex wl-summary-jump-to-current-message
2887 Jump cursor to the currently displayed message's window.
2888 (@code{wl-summary-jump-to-current-message})
2892 Jump cursor to the other message.
2893 @findex wl-summary-jump-to-msg
2894 (@code{wl-summary-jump-to-msg})
2898 Update summary status and
2899 prefetch all messages which have marks included in the
2900 @code{wl-summary-incorporate-marks}.
2901 @findex wl-summary-incorporate
2902 (@code{wl-summary-incorporate})
2905 @kindex M-j (Summary)
2906 @findex wl-summary-jump-to-msg-by-message-id
2907 Jump cursor to the message which have specified @samp{Message-Id:}. If
2908 @code{elmo-use-database} is non-nil, other folder is also searched.
2909 (@code{wl-summary-jump-to-msg-by-message-id})
2913 Jump to parent message.
2914 @findex wl-summary-jump-to-parent-message
2915 (@code{wl-summary-jump-to-parent-message})
2919 @findex wl-summary-mark-as-unread
2920 Mark as unread the message at current cursor point.
2921 (@code{wl-summary-mark-as-unread})
2925 @findex wl-summary-sync
2926 Synchronize summary view after prompting the update range
2927 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
2931 all ...Discard current summary and update all message.
2932 update ...Update the difference between summary and the folder itself.
2933 rescan ...Rescan the msgdb and display again.
2934 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2935 first, last ...Move to the filter folder(partial filter).
2940 (@code{wl-summary-sync})
2944 @findex wl-summary-sort
2946 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
2947 (@code{wl-summary-sort})
2951 @findex wl-summary-toggle-thread
2952 Toggle the threading.
2953 Threading status is displayed on the modeline.
2954 @samp{@{S@}} means threading is off (Sequence) and
2955 @samp{@{T@}} means threading is on (Thread).
2956 (@code{wl-summary-toggle-thread})
2960 @findex wl-summary-toggle-disp-folder
2961 Toggle displaying of folder window.
2962 (@code{wl-summary-toggle-disp-folder})
2966 Toggle displaying of message window.
2967 @findex wl-summary-toggle-disp-msg
2968 (@code{wl-summary-toggle-disp-msg})
2972 Move to the virtual folder with the condition specified.
2973 If called with prefix argument and current folder is virtual, exit it.
2974 @findex wl-summary-virtual
2975 (@code{wl-summary-virtual})
2978 @kindex @key{TAB} (Summary)
2979 @findex wl-summary-goto-last-displayed-msg
2980 Jump to the message which is displayed last.
2981 (@code{wl-summary-goto-last-displayed-msg})
2985 Put @samp{*} mark on the messages that satisfies the specified condition.
2986 @findex wl-summary-pick
2987 (@code{wl-summary-pick})
2991 @findex wl-summary-mark-as-read
2992 Mark as read the message at the current cursor point.
2993 (@code{wl-summary-mark-as-read})
2997 Prefetch the message at the current cursor point.
2998 With prefix argument, prefetch the message even if it is cached.
2999 @findex wl-summary-prefetch
3000 (@code{wl-summary-prefetch})
3004 Execute @samp{D}, @samp{o} and @samp{O} marks.
3005 @findex wl-summary-exec
3006 (@code{wl-summary-exec})
3010 @findex wl-summary-target-mark-line
3011 Put target mark on the message at the current cursor point.
3012 (@code{wl-summary-target-mark-line})
3016 Put refile mark on the message at the current cursor point.
3017 @findex wl-summary-refile
3018 (@code{wl-summary-refile})
3021 @kindex C-o (Summary)
3022 Execute auto refile.
3023 @findex wl-summary-auto-refile
3024 (@code{wl-summary-auto-refile})
3028 Put copy mark on the message at the current cursor point.
3029 @findex wl-summary-copy
3030 (@code{wl-summary-copy})
3033 @kindex M-o (Summary)
3034 Put refile mark on the message at the current cursor point with the destination
3035 previously specified.
3036 @findex wl-summary-refile-prev-destination
3037 (@code{wl-summary-refile-prev-destination})
3041 @findex wl-summary-delete
3042 Put delete mark on the message at the current cursor point.
3043 (@code{wl-summary-delete})
3047 @findex wl-summary-unmark
3048 Unmark the temporal mark on the message at the current cursor point.
3049 (@code{wl-summary-unmark})
3053 Unmark all the temporal marks.
3054 @findex wl-summary-unmark-all
3055 (@code{wl-summary-unmark-all})
3058 @kindex r R (Summary)
3059 @findex wl-summary-mark-as-read-region
3060 Mark as read messages in the specified region.
3061 (@code{wl-summary-mark-as-read-region})
3064 @kindex r $ (Summary)
3065 @findex wl-summary-mark-as-important-region
3066 Mark as important @samp{$} messages in the specified region.
3067 If @samp{$} already exists, it is deleted.
3068 (@code{wl-summary-mark-as-important-region})
3071 @kindex r ! (Summary)
3072 @findex wl-summary-mark-as-unread-region
3073 Mark as unread messages in the specified region.
3074 (@code{wl-summary-mark-as-unread-region})
3077 @kindex r i (Summary)
3078 @findex wl-summary-prefetch-region
3079 Prefetch messages in the specified region.
3080 (@code{wl-summary-prefetch-region})
3083 @kindex r x (Summary)
3084 @findex wl-summary-exec-region
3085 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3087 (@code{wl-summary-exec-region})
3090 @kindex r * (Summary)
3091 @findex wl-summary-target-mark-region
3092 Put target mark on the messages in the specified region.
3093 (@code{wl-summary-target-mark-region})
3096 @kindex r o (Summary)
3097 @findex wl-summary-refile-region
3098 Put refile mark on the messages in the specified region.
3099 (@code{wl-summary-refile-region})
3102 @kindex r O (Summary)
3103 @findex wl-summary-copy-region
3104 Put copy mark on the messages in the specified region.
3105 (@code{wl-summary-copy-region})
3108 @kindex r d (Summary)
3109 @findex wl-summary-delete-region
3110 Put delete mark on the messages in the specified region.
3111 (@code{wl-summary-delete-region})
3114 @kindex r u (Summary)
3115 @findex wl-summary-unmark-region
3116 Delete temporal mark on the messages in the specified region.
3117 (@code{wl-summary-unmark-region})
3120 @kindex r y (Summary)
3121 Save messages in the specified region.
3122 @findex wl-summary-save-region
3123 (@code{wl-summary-save-region})
3126 @kindex t R (Summary)
3127 @findex wl-thread-mark-as-read
3128 Mark as read messages which are the descendant of the current thread.
3129 With prefix argument, it affects on the all messages in the thread tree.
3130 (@code{wl-thread-mark-as-read})
3133 @kindex t $ (Summary)
3134 @findex wl-thread-mark-as-important
3135 Put important mark @samp{$} on the messages which are the
3136 descendant of the current thread.
3137 If @samp{$} mark exists, it is deleted.
3138 With prefix argument, it affects on the all messages in the thread tree.
3139 (@code{wl-thread-mark-as-important})
3142 @kindex t ! (Summary)
3143 @findex wl-thread-mark-as-unread
3144 Mark as unread messages which are the descendant of the current thread.
3145 With prefix argument, it affects on the all messages in the thread tree.
3146 (@code{wl-thread-mark-as-unread})
3149 @kindex t i (Summary)
3150 @findex wl-thread-prefetch
3151 Prefetch messages which are the descendant of the current thread.
3152 With prefix argument, it affects on the all messages in the thread tree.
3153 (@code{wl-thread-prefetch})
3156 @kindex t x (Summary)
3157 @findex wl-thread-exec
3158 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3159 the descendant of the current thread. With prefix argument, it affects
3160 on the all messages in the thread tree.
3161 (@code{wl-thread-exec})
3164 @kindex t * (Summary)
3165 @findex wl-thread-target-mark
3166 Put target mark @samp{*} on the messages which are the descendant of the
3167 current thread. With prefix argument, it affects on the all messages in
3169 (@code{wl-thread-target-mark})
3172 @kindex t o (Summary)
3173 @findex wl-thread-refile
3174 Put refile mark on the messages which are the descendant of the current thread.
3175 With prefix argument, it affects on the all messages in the thread tree.
3176 (@code{wl-thread-refile})
3179 @kindex t O (Summary)
3180 @findex wl-thread-copy
3181 Put copy mark on the 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-copy})
3186 @kindex t d (Summary)
3187 @findex wl-thread-delete
3188 Put delete mar on the messages which are the descendant of the current thread.
3189 With prefix argument, it affects on the all messages in the thread tree.
3190 (@code{wl-thread-delete})
3193 @kindex t u (Summary)
3194 @findex wl-thread-unmark
3195 Unmark temporal mark on the messages which are the descendant of the
3196 current thread. With prefix argument, it affects on the all messages in
3198 (@code{wl-thread-unmark})
3201 @kindex t y (Summary)
3202 @findex wl-thread-save
3203 Save messages which are the descendant of the current thread.
3204 With prefix argument, it affects on the all messages in the thread tree.
3205 (@code{wl-thread-save})
3208 @kindex m i (Summary)
3209 @findex wl-summary-target-mark-prefetch
3210 Prefetch all messages which have target mark @samp{*}.
3211 (@code{wl-summary-target-mark-prefetch})
3214 @kindex m R (Summary)
3215 @findex wl-summary-target-mark-mark-as-read
3216 Mark as read all messages which have target mark @samp{*}.
3217 (@code{wl-summary-target-mark-mark-as-read})
3220 @kindex m $ (Summary)
3221 @findex wl-summary-target-mark-mark-as-important
3222 Mark as important all messages which have target mark @samp{*}.
3223 If already marked as @samp{$}, it is deleted.
3224 (@code{wl-summary-target-mark-mark-as-important})
3227 @kindex m ! (Summary)
3228 @findex wl-summary-target-mark-mark-as-unread
3229 Mark as unread all messages which have target mark @samp{*}.
3230 (@code{wl-summary-target-mark-mark-as-unread})
3233 @kindex m o (Summary)
3234 @findex wl-summary-target-mark-refile
3235 Put refile mark on the messages which have target mark @samp{*}.
3236 (@code{wl-summary-target-mark-refile})
3239 @kindex m O (Summary)
3240 @findex wl-summary-target-mark-copy
3241 Put copy mark on the messages which have target mark @samp{*}.
3242 (@code{wl-summary-target-mark-copy})
3245 @kindex m d (Summary)
3246 @findex wl-summary-target-mark-delete
3247 Put delete mark on the messages which have target mark @samp{*}.
3248 (@code{wl-summary-target-mark-delete})
3251 @kindex m y (Summary)
3252 @findex wl-summary-target-mark-save
3253 Save messages which have target mark @samp{*}.
3254 (@code{wl-summary-target-mark-save})
3257 @kindex m u (Summary)
3258 Unmark all temporal marks.
3259 (@code{wl-summary-delete-all-temp-marks})
3260 @findex wl-summary-delete-all-temp-marks
3263 @kindex m a (Summary)
3264 Put target mark @samp{*} on the all messages.
3265 (@code{wl-summary-target-mark-all})
3266 @findex wl-summary-target-mark-all
3269 @kindex m t (Summary)
3270 Put target mark @samp{*} on the messages in the current thread.
3271 @findex wl-summary-target-mark-thread
3272 (@code{wl-summary-target-mark-thread})
3275 @kindex m r (Summary)
3276 @findex wl-summary-target-mark-region
3277 Put target mark @samp{*} on the messages in the specified region.
3278 (@code{wl-summary-target-mark-region})
3281 @kindex m A (Summary)
3282 @findex wl-summary-target-mark-reply-with-citation
3283 Prepare a draft which cites all messages which have target mark @samp{*}.
3284 (@code{wl-summary-target-mark-reply-with-citation})
3287 @kindex m f (Summary)
3288 @findex wl-summary-target-mark-forward
3289 Prepare a draft which forwards all messages which have target mark @samp{*}.
3290 (@code{wl-summary-target-mark-forward})
3293 @kindex m U (Summary)
3294 @findex wl-summary-target-mark-uudecode
3295 Uudecode the messages which have target mark @samp{*}.
3296 (@code{wl-summary-target-mark-uudecode})
3299 @kindex m ? (Summary)
3300 @findex wl-summary-target-mark-pick
3301 Pick messages from the @samp{*} marked messages.
3302 That is, @samp{*} marks on the messages are remained
3303 if the specified condition is satisfied.
3304 (@code{wl-summary-target-mark-pick})
3307 @kindex M-t (Summary)
3308 @findex wl-toggle-plugged
3309 Toggle offline/online status of Wanderlust.
3310 (@code{wl-toggle-plugged})
3313 @kindex C-t (Summary)
3314 Start Wanderlust's plug-status manager.
3315 (@code{wl-plugged-change})
3318 @kindex C-c C-o (Summary)
3319 @findex wl-jump-to-draft-buffer
3320 Move to the draft buffer if available. If multiple draft buffer exists,
3321 moved to one after another. If prefix argument is specified, load draft
3322 folder's message to the draft buffer and jump to it.
3323 (@code{wl-jump-to-draft-buffer})
3327 @node Variables of Summary, , Key Bindings of Summary, Summary
3328 @section Customiziable variables
3331 @item wl-summary-move-order
3332 @vindex wl-summary-move-order
3333 The initial setting is @code{unread}. Specify cursor moving policy. If
3334 you want to precede new messages, set @code{new}. If you want to
3335 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3338 @item wl-auto-select-first
3339 @vindex wl-auto-select-first
3340 The initial setting is @code{nil}.
3341 If non-nil, first message is automatically displayed.
3343 @item wl-auto-select-next
3344 @vindex wl-auto-select-next
3345 The initial setting is @code{nil}. If non-nil, jump to next summary
3346 automatically. If @code{unread}, jump to next unread folder's summary
3347 after confirmation. If @code{skip-no-unread}, unread folders are
3348 automatically skipped.
3350 @item wl-thread-insert-opened
3351 @vindex wl-thread-insert-opened
3352 The initial setting is @code{nil}.
3353 If non-nil, thread is inserted as opened.
3355 @item wl-thread-open-reading-thread
3356 @vindex wl-thread-open-reading-thread
3357 The initial setting is @code{t}. If non-nil, reading thread is
3358 automatically opened though it is closed thread.
3360 @item wl-summary-exit-next-move
3361 @vindex wl-summary-exit-next-move
3362 The initial setting is @code{t}. If non-nil, move to next folder at
3365 @item wl-folder-move-cur-folder
3366 @vindex wl-folder-move-cur-folder
3367 The initial setting is @code{nil}. If non-nil, cursor position on the
3370 @item wl-summary-weekday-name-lang
3371 @vindex wl-summary-weekday-name-lang
3372 The initial setting is @samp{ja}. Specify language of the weekday.
3373 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3376 @item wl-summary-fix-timezone
3377 @vindex wl-summary-fix-timezone
3378 The initial setting is @samp{JST}. Timezone to adjust summary's
3379 timezone. If @code{nil}, adjust to GMT.
3381 @item wl-use-petname
3382 @vindex wl-use-petname
3383 The initial setting is @code{t}.
3384 If non-nil, sender part displays nickname.
3386 @item wl-break-pages
3387 @vindex wl-break-pages
3388 The initial setting is @code{t}.
3389 If non-nil, message is splitted as pages by @samp{^L}.
3391 @item wl-message-window-size
3392 @vindex wl-message-window-size
3393 The initial setting is '(1 . 4).
3394 A cons cell to specify the rate of summary and message window.
3395 car:cdr corresponds summary:message.
3397 @item wl-summary-recenter
3398 @vindex wl-summary-recenter
3399 The initial setting is t.
3400 If non-nil, cursor point is moved to the center of the summary window.
3402 @item wl-summary-indent-length-limit
3403 @vindex wl-summary-indent-length-limit
3404 The initial setting is 46.
3405 Specify the limit of thread indent level.
3406 If nil, max indent level is unlimited.
3408 @item wl-summary-no-from-message
3409 @vindex wl-summary-no-from-message
3410 The initial setting is @samp{nobody@@nowhere?}. A string which is
3411 displayed when there's no @samp{From:} field in the message.
3413 @item wl-summary-no-subject-message
3414 @vindex wl-summary-no-subject-message
3415 The initial setting is @samp{(WL:No Subject in original.)}. A string
3416 which is displayed when there's no @samp{Subject:} field in the message.
3418 @item wl-summary-width
3419 @vindex wl-summary-width
3420 The initial setting is 80.
3421 Width of summary line. If @code{nil}, summary line's width is as is.
3423 @item wl-use-folder-petname
3424 @vindex wl-use-folder-petname
3425 The initial setting is the list shown below:
3434 A list of display policy (symbol) of folder nickname. Available symbols
3439 Display folder petname on modeline.
3441 Destination folder is notified as nickname if
3442 @code{wl-auto-select-next} is non-nil.
3444 You can input folder name by nickname in the function
3445 @code{wl-summary-read-folder}.
3448 @item wl-summary-move-direction-toggle
3449 @vindex wl-summary-move-direction-toggle
3450 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3451 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3452 want to aware of reading direction, set this to @code{t}.
3455 @vindex wl-from-width
3456 The initial setting is 17.
3457 Width of sender part of summary line.
3459 @item wl-summary-divide-thread-when-subject-changed
3460 @vindex wl-summary-divide-thread-when-subject-changed
3461 The initial setting is @code{nil}. If non-nil, thread is splitted if
3462 the subject is changed.
3464 @item wl-summary-search-via-nntp
3465 @vindex wl-summary-search-via-nntp
3466 The initial setting is @code{confirm}.
3468 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3469 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3470 from the NNTP server @code{elmo-default-nntp-server}. The value of
3471 @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
3472 @code{elmo-default-nntp-ssl} are used.
3474 If @code{confirm}, server name can be specified. You can specify NNTP
3475 folder format like @samp{-:username@@servername:119!}.
3477 @item wl-summary-keep-cursor-command
3478 @vindex wl-summary-keep-cursor-command
3479 The initial setting is the list shown below:
3483 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3488 When you entered to summary by these commands and the target summary
3489 buffer already exists, summary status is not automatically updated and
3490 cursor position is saved.
3492 @item wl-summary-update-confirm-threshold
3493 @vindex wl-summary-update-confirm-threshold
3494 The initial setting is 500. If updated message number is larger than
3495 this value, confirm whether drop them or not.
3497 @item wl-summary-always-sticky-folder-list
3498 @vindex wl-summary-always-sticky-folder-list
3499 The initial setting is @code{nil}.
3500 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3501 are automatically sticked. Each element is regexp of folder name.
3503 @item wl-summary-reserve-mark-list
3504 @vindex wl-summary-reserve-mark-list
3505 The initial setting is the list shown below:
3514 If a message is already marked as temporal marks in this list, the
3515 message is not marked by any mark command.
3517 @item wl-summary-skip-mark-list
3518 @vindex wl-summary-skip-mark-list
3519 The initial setting is the list shown below:
3528 If a message is already marked as temporal marks in this list, the
3529 message is skipped at cursor move.
3531 @item wl-fetch-confirm-threshold
3532 @vindex wl-fetch-confirm-threshold
3533 The initial setting is 30000 (bytes). If displaying message has larger
3534 size than this value, Wanderlust confirms whether fetch the message or
3535 not. If @code{nil}, the message is fetched without confirmation.
3537 @item wl-prefetch-threshold
3538 @vindex wl-prefetch-threshold
3539 The initial setting is 30000 (bytes). If prefetching message has larger
3540 size than this value and @code{wl-prefetch-confirm} is non-nil,
3541 Wanderlust confirms whether prefetch the message or not. If
3542 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3543 without confirmation.
3545 @item wl-prefetch-confirm
3546 @vindex wl-prefetch-confirm
3547 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3548 prefetch the message or not if the message has larger size than
3549 @code{wl-prefetch-threshold}.
3551 @item wl-cache-fetch-threshold
3552 @vindex wl-cache-fetch-threshold
3553 The initial setting is 30000 (bytes). The messages which have larger
3554 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3555 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3558 @item elmo-imap4-use-cache
3559 @vindex elmo-imap4-use-cache
3560 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3563 @item elmo-nntp-use-cache
3564 @vindex elmo-nntp-use-cache
3565 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3568 @item elmo-pop3-use-cache
3569 @vindex elmo-pop3-use-cache
3570 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3575 @node Message, Draft, Summary, Top
3576 @chapter Message Buffer
3578 Message Buffers utilize MIME-View mode of SEMI/tm. For operational
3579 procedures and key bindings, refer to respective documents.
3580 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3582 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3583 brings you back to Summary mode. @kbd{l} toggles display of Summary
3586 @section Key Bindings
3592 @findex wl-message-toggle-disp-summary
3593 Toggles display of Summary mode buffer.
3594 (@code{wl-message-toggle-disp-summary})
3597 @findex wl-message-refer-article-or-url
3598 @kindex Button-2 (Message)
3599 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3600 corresponding message if found.
3601 (@code{wl-message-refer-article-or-url})
3603 @item Button-4 (upward movement of a wheel)
3604 @kindex Button-4 (Message)
3605 @findex wl-message-wheel-down
3606 Scrolls the message backwards. When the top of the message is hit,
3607 moves to the previous message.
3608 (@code{wl-message-wheel-down})
3610 @item Button-5 (downward movement of a wheel)
3611 @kindex Button-5 (Message)
3612 @findex wl-message-wheel-up
3613 Scrolls the message forward. When the bottom of the message is hit,
3614 moves to the next message.
3615 (@code{wl-message-wheel-up})
3618 @section Customizable Variables
3621 @item wl-message-window-size
3622 @vindex wl-message-window-size
3623 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3624 its car and cdr value corresponds to the ratio of Summary and Message
3629 @node Draft, Disconnected Operations, Message, Top
3630 @chapter Draft Buffer
3632 At Summary mode, pressing @kbd{w} and the like creates a new draft
3633 buffer. You can edit and send mail and news articles in this buffer.
3637 Basically it is Emacs-standard mail mode.
3639 @subsection Address Completion
3641 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3642 addresses. @kbd{@key{TAB}} completes them.
3644 If you want to submit a news article, add @samp{Newsgroups:} field by
3645 yourself. Field names can be completed by @kbd{@key{TAB}}.
3647 If you save the draft buffer you are editing, it is appended to the
3648 folder specified by @code{wl-draft-folder}.
3650 Using @samp{FCC:} field, you can specify the folder to which a copy of
3651 the message is saved when it is sent.
3653 @subsection Editing Messages
3655 Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
3656 editing, refer to respective documents.
3657 @xref{MIME-Edit, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3659 @subsection Dynamic Modification of Messages
3660 @vindex wl-draft-config-alist
3661 @c @cindex Change Message
3662 @c @cindex Message, Change Dynamic
3664 You can set @code{wl-draft-config-alist} so that header and body of the
3665 message will automatically modified depending on information of header
3668 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3670 In the example below, the header is modified when
3671 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3672 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3673 before sending the message.
3677 (setq wl-draft-config-alist
3678 '(((string-match "aaa.ne.jp$" (system-name))
3679 ;; @r{applied if the expression is non-nil}
3680 (wl-smtp-posting-server . "mailserver-B")
3681 (wl-nntp-posting-server . "newsserver-B")
3682 ;; @r{settings of temporary variables}
3684 ("^To: .*user@@aaa.bbb.com"
3685 ;; @r{applied if it matches the header of the draft buffer}
3686 ("Organization" . (format "Go %s" my-webpage)))
3687 ;; @r{you can write elisp expressions here (eval only)}
3688 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3689 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3694 The format of @code{wl-draft-config-alist} is:
3698 '(("@var{regexp of the header}" or @var{elisp expression}
3699 ("@var{Field}" . value(@var{elisp expression}))
3700 (@var{variable} . value(@var{elisp expression}))
3701 (@var{sub-function} . value(@var{elisp expression}))
3704 ("@var{regexp of the header}" or @var{elisp expression}
3705 ("@var{Field}" . value(@var{elisp expression}))
3710 Per default, there are 10 following sub-functions.
3713 'header: Inserts the specified string at the bottom of the header.
3714 'header-file: Inserts the specified file at the bottom of the header.
3715 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3716 'top: Inserts the specified string at the top of the body.
3717 'top-file: Inserts the specified file at the top of the body.
3718 'body: Replaces the body with the specified string.
3719 Specifying @code{nil} deletes the entire body string.
3720 'body-file: Replaces the body with the content of the specified file.
3721 'bottom: Inserts the specified string at the bottom of the body.
3722 'bottom-file: Inserts the specified file at the top of the body.
3723 'template: Applies the specified template.
3724 (refer to the next subsection)
3727 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3728 change them or add your own functions. If you read the code, you can
3729 easily find how to write the functions.
3731 At the first of each item, @var{a regular expression of the header} or
3732 an @var{elisp expression} should be specified. In the case of an elisp
3733 expression, the item is applied when the expression is evaluated
3736 Per default, when multiple items match or are evaluated non-nil, all
3737 such items are applied, but if you set a variable
3738 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3741 At the second of the item, a cons or a list of functions should be
3742 specified. The car part of the cons should be a header field, a
3743 variable, or a sub-function. When a header field is specified, the
3744 field will be modified. If a variable is specified, the value of the
3745 variable will be modified temporarily.
3747 In the cdr part of a cons, not only a variable but also an elisp
3748 expression can be specified as is. If the car part is a header field
3749 and the cdr part is @code{nil}, the field will be deleted.
3751 See the next example as well:
3755 (setq wl-draft-config-alist
3757 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3758 ;; @r{applied if it matches the header of the buffer being replied}
3759 (body . " Hello.\n")
3760 (template . "default")
3765 As in the (1) above, if a header regexp is prepended with @code{reply},
3766 it is applied when the draft is prepared by @code{wl-summary-reply} for
3767 example, and when it matches the header being replied. It is ignored
3768 when there is no buffer being replied, like after @code{wl-draft} was
3771 Note that @code{wl-draft-config-alist} is applied only once when
3772 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3773 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3774 aborting transmission, execute @kbd{C-c C-e}
3775 (@code{wl-draft-config-exec}) explicitly.
3777 If you don't want to apply @code{wl-draft-config-alist} when
3778 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
3782 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
3785 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3786 prepared, do the following:
3789 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3792 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
3793 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
3797 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
3800 @subsection Inserting Templates
3802 @cindex Apply Template
3804 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3805 @kbd{M-x wl-template-select} in the draft buffer.
3807 The format of @code{wl-template-alist} is almost the same as
3808 @code{wl-draft-config-alist}.
3812 (setq wl-template-alist
3815 ("Organization" . "~/.wl sample")
3816 (body . "Hello.\n"))
3818 (template . "default") ;; @r{(a)}
3819 ("To" . "jousi@@kaisha.jp")
3820 ("Subject" . "Report")
3821 (body-file . "~/work/report.txt")
3827 As you can see, the only difference is item (template) names such as
3828 @samp{default} and @samp{report}, instead of a regexp of header.
3829 Because definition of each item is the same as
3830 @code{wl-draft-config-alist}, you can call another template, like (a).
3832 Executing the command @code{wl-template-select} results in template
3833 selection, but the result differs depending on variable
3834 @code{wl-template-visible-select}.
3836 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3837 window is shown below the draft buffer. You can select a template by
3838 @kbd{n} and @kbd{p} seeing the buffer window.
3840 Press the @key{RET} key and the template is actually applied to the draft
3841 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3842 adjust the window size by @code{wl-template-buffer-lines}.
3844 If @code{wl-template-visible-select} is @code{nil}, you should type the
3845 name of the template in the mini buffer.
3847 As shown in the example in @code{wl-draft-config-alist}, you can select
3848 @samp{default} template by writing:
3851 (template . "default")
3854 @subsection Sending mail by POP-before-SMTP
3855 @cindex POP-before-SMTP
3857 You can send mail by POP-before-SMTP with this single line:
3860 (setq wl-draft-send-mail-func 'wl-draft-send-mail-with-pop-before-smtp)
3864 Configure the following variables if you need.
3867 @item wl-pop-before-smtp-user
3868 The POP user name for POP-before-SMTP authentication.
3869 If unset, @code{elmo-default-pop3-user} is used.
3871 @item wl-pop-before-smtp-server
3872 The POP server name for POP-before-SMTP authentication.
3873 If unset, @code{elmo-default-pop3-server} is used.
3875 @item wl-pop-before-smtp-authenticate-type
3876 The POP authentication method for POP-before-SMTP authentication.
3877 If unset, @code{elmo-default-pop3-authenticate-type} is used.
3879 @item wl-pop-before-smtp-port
3880 The POP port number for POP-before-SMTP authentication.
3881 If unset, @code{elmo-default-pop3-port} is used.
3883 @item wl-pop-before-smtp-ssl
3884 If non-nil, POP connection is established using SSL. If
3885 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
3886 unset, @code{elmo-default-pop3-ssl} is used.
3889 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
3890 unset, settings for POP folders (@code{elmo-default-pop3-*}) are
3892 Therefore, if SMTP server and POP server are actually the same, and if
3893 POP folder per default (such as @samp{&}) is available, no settings are
3896 Refer to the following URL about POP-before-SMTP.
3900 http://spam.ayamura.org/tools/smPbS.html
3901 http://www.iecc.com/pop-before-smtp.html
3905 @section Key Bindings
3906 @cindex Keybind, Draft Mode
3907 @cindex Keybind, Draft Buffer
3912 @kindex C-c C-y (Draft)
3913 @findex wl-draft-yank-original
3914 Cites the content of the current message buffer.
3915 (@code{wl-draft-yank-original})
3918 @kindex C-c C-p (Draft)
3919 @findex wl-draft-preview-message
3920 Previews the content of the current draft.
3921 This is useful for previewing MIME multi-part messages.
3922 (@code{wl-draft-preview-message})
3925 @kindex C-c C-s (Draft)
3926 @findex wl-draft-send
3927 Sends the content of the current draft. Does not erase the draft buffer.
3928 This is useful for sending multiple messages, which are a little different
3930 (@code{wl-draft-send})
3933 @kindex C-c C-c (Draft)
3934 @findex wl-draft-send-and-exit
3935 Sends the content of the current draft and erases the draft buffer.
3936 (@code{wl-draft-send-and-exit})
3939 @kindex C-x C-s (Draft)
3940 @findex wl-draft-save
3941 Save the current draft.
3942 (@code{wl-draft-save})
3945 @kindex C-c C-k (Draft)
3946 @findex wl-draft-kill
3947 Kills the current draft.
3948 (@code{wl-draft-kill})
3951 @kindex C-x k (Draft)
3952 @findex wl-draft-mimic-kill-buffer
3953 Kills the current draft.
3954 (@code{wl-draft-mimic-kill-buffer})
3957 @kindex C-c C-z (Draft)
3958 @findex wl-draft-save-and-exit
3959 Saves the current draft, and erases the draft buffer.
3960 This is useful if you want to suspend editing of the draft.
3961 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
3962 the @samp{+draft} folder.
3963 (@code{wl-draft-save-and-exit})
3966 @kindex C-c C-r (Draft)
3967 @findex wl-caesar-region
3968 Encodes or decodes the specified region in Caesar cipher.
3969 (@code{wl-caesar-region})
3973 @findex wl-toggle-plugged
3974 Toggles off-line/on-line states of Wanderlust.
3975 (@code{wl-toggle-plugged})
3978 @kindex C-c C-o (Draft)
3979 @findex wl-jump-to-draft-buffer
3980 Jumps to the other draft buffer, if exists.
3981 With prefix argument, reads a file (if any) from the draft folder when
3982 there is no such buffer.
3983 (@code{wl-jump-to-draft-buffer})
3986 @kindex C-c C-e (Draft)
3987 @findex wl-draft-config-exec
3988 Applies @code{wl-draft-config-alist}.
3989 (@code{wl-draft-config-exec})
3992 @kindex C-c C-j (Draft)
3993 @findex wl-template-select
3995 (@code{wl-template-select})
3998 @kindex C-c C-a (Draft)
3999 @findex wl-draft-insert-x-face-field
4000 Inserts the content of a file @file{~/.xface} (the value of the variable
4001 @code{wl-x-face-file}) as an @samp{X-Face:} field in the draft buffer.
4003 There should be encoded X-Face strings as a content of a file @file{~/.xface}.
4004 (@code{wl-draft-insert-x-face-field})
4007 @section Customizable Variables
4010 @item wl-subscribed-mailing-list
4011 @vindex wl-subscribed-mailing-list
4012 The initial setting is @code{nil}. Mailing lists to which you
4013 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4014 field of a reply draft, removes your own address from
4015 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4016 contained in @samp{To:} or @samp{Cc:} field of a message to be
4017 automatically re-filed, the destination folder will be leaned in
4018 connection with the address.
4024 (setq wl-subscribed-mailing-list
4025 '("wl@@lists.airs.net"
4027 "emacs-mime-ja@@m17n.org"))
4031 @item wl-insert-mail-followup-to
4032 @vindex wl-insert-mail-followup-to
4033 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4034 field is automatically inserted in the draft buffer.
4036 @item wl-insert-mail-reply-to
4037 @vindex wl-insert-mail-reply-to
4038 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4039 field is automatically inserted in the draft buffer.
4041 @item wl-auto-insert-x-face
4042 @vindex wl-auto-insert-x-face
4043 The initial setting is @code{t}. If non-nil and there is an encoded
4044 X-Face string in a file @file{~/.xface} (the value of the variable
4045 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4046 draft buffer. If @code{nil}, it is not automatically inserted. Press
4047 @kbd{C-c C-a} to insert.
4049 @item wl-insert-message-id
4050 @vindex wl-insert-message-id
4051 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4052 is automatically inserted on the transmission.
4054 @item wl-local-domain
4055 @vindex wl-local-domain
4056 The initial setting is @code{nil}. If @code{nil}, the return value of
4057 the function @code{system-name} will be used as the domain part of
4060 If @code{system-name} does not return FQDN (i.e. the full name of the
4061 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4062 to the string of the local domain name without hostname (like
4063 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4064 @samp{.} @code{wl-local-domain} is used as domain part of the
4067 If your terminal does not have global IP, set the value of
4068 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4069 you use invalid @samp{Message-ID:}.)
4071 Moreover, concatenation of @code{system-name} @samp{.}
4072 @code{wl-local-domain} will be used as an argument to the HELO command
4075 @item wl-message-id-domain
4076 @vindex wl-message-id-domain
4077 The initial setting is @code{nil}. If non-nil, this value is used as a
4078 domain part of the @samp{Message-ID:}. If your terminal does not have
4079 global IP address, set unique string to this value (e.x. your e-mail
4082 @item wl-message-id-domain
4083 @vindex wl-message-id-domain
4084 The initial setting is @code{nil}. If @code{nil}, the return value of
4085 the function @code{system-name} will be used as the domain part of
4086 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4087 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4088 @strong{must} set this variable to the string of the full name of the
4089 host. Otherwise, you might be beaten up on the Net News.
4091 @item wl-draft-config-alist
4092 @vindex wl-draft-config-alist
4093 The initial setting is @code{nil}. Modifies the draft message just
4094 before the transmission. The content of @code{wl-draft-config-alist}
4095 will be automatically applied only once on the transmission. If you
4096 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4099 @item wl-template-alist
4100 @vindex wl-template-alist
4101 The initial setting is @code{nil}.
4102 This variable specifies the template to be applied in the draft buffer.
4104 @item wl-draft-config-matchone
4105 @vindex wl-draft-config-matchone
4106 The initial setting is @code{nil}. If non-nil, only the first matching
4107 item is used when @code{wl-draft-config-alist} is applied. If
4108 @code{nil}, all matching items are used.
4110 @item wl-template-visible-select
4111 @vindex wl-template-visible-select
4112 The initial setting is @code{t}.
4113 If non-nil, you can preview the result of the template selection in
4116 @item wl-template-confirm
4117 @vindex wl-template-confirm
4118 The initial setting is @code{nil}.
4119 If non-nil, asks for confirmation when you press the enter key to select
4120 template while previewing.
4122 @item wl-template-buffer-lines
4123 @vindex wl-template-buffer-lines
4124 The initial setting is 7.
4125 If @code{wl-template-visible-select} is non-nil, this variable specifies
4126 the size of the preview window.
4128 @item wl-draft-reply-buffer-style
4129 @vindex wl-draft-reply-buffer-style
4130 The initial setting is @code{split}. @code{split} or @code{full} can be
4131 specified. In the case of @code{full}, the whole frame will be used for
4132 a reply draft buffer when it is prepared.
4134 @item wl-draft-use-frame
4135 @vindex wl-draft-use-frame
4136 The initial setting is @code{nil}.
4137 If non-nil, use new frame for the draft.
4141 The initial setting is the value of the variable
4142 @code{user-mail-address}. The value of this variable is inserted as a
4143 @samp{From:} field of the draft when it is prepared.
4145 @item wl-envelope-from
4146 @vindex wl-envelope-from
4147 The initial setting is @code{nil}.
4148 The value of this variable is used for envelope from (MAIL FROM).
4149 If @code{nil}, the address part of @code{wl-from} is used.
4151 @item wl-user-mail-address-list
4152 @vindex wl-user-mail-address-list
4153 The initial setting is @code{nil}.
4154 This is the User's address list. If you have multiple addresses,
4159 The initial setting is @code{nil}.
4160 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4161 the draft when it is prepared. If function is specified, its return
4166 The initial setting is @code{nil}.
4167 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4168 the draft when it is prepared.
4170 @item wl-reply-subject-prefix
4171 @vindex wl-reply-subject-prefix
4172 The initial setting is @samp{Re: }.
4173 In the @samp{Subject:} of the reply draft, this string is prepended to
4174 the @samp{Subject:} of being replied.
4176 @item wl-draft-reply-use-address-with-full-name
4177 @vindex wl-draft-reply-use-address-with-full-name
4178 The initial setting is @code{t}.
4179 If non-nil, insert her full name with address when prepare a draft for
4180 reply a message. If it is @code{nil}, insert her address only.
4182 @item wl-draft-enable-queuing
4183 @vindex wl-draft-enable-queuing
4184 The initial setting is @code{t}.
4185 This flag controls off-line transmission. If non-nil, the draft is
4188 @item wl-draft-use-cache
4189 @vindex wl-draft-use-cache
4190 The initial setting is @code{t}.
4191 If non-nil, cache the message which is sent.
4193 @item wl-auto-flush-queue
4194 @vindex wl-auto-flush-queue
4195 The initial setting is t.
4196 This flag controls automatic transmission of the queue when Wanderlust
4197 becomes on-line. If non-nil, the queue is automatically transmitted
4198 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4199 manually, press @kbd{F} in the folder mode.
4201 @item wl-draft-always-delete-myself
4202 @vindex wl-draft-always-delete-myself
4203 If non-nil, always removes your own address from @samp{To:} and
4204 @samp{Cc:} when you are replying to the mail addressed to you.
4206 @item wl-smtp-posting-server
4207 @vindex wl-smtp-posting-server
4208 The initial setting is @code{nil}.
4209 This is the SMTP server name for mail transmission.
4211 @item wl-smtp-posting-user
4212 @vindex wl-smtp-posting-user
4213 The initial setting is @code{nil}.
4214 This is the user name for SMTP AUTH authentication. If @code{nil},
4215 @code{smtp-authenticate-user} is used.
4217 @item wl-smtp-authenticate-type
4218 @vindex wl-smtp-authenticate-type
4219 The initial setting is @code{nil}.
4220 This is the authentication method for SMTP AUTH authentication. If
4221 @code{nil}, @code{smtp-authenticate-type} is used. If
4222 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4225 @item wl-smtp-connection-type
4226 @vindex wl-smtp-connection-type
4227 The initial setting is @code{nil}.
4228 This variable specifies how to establish SMTP connections.
4229 If @code{nil}, @code{smtp-connection-type} is used.
4230 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4232 @item wl-nntp-posting-server
4233 @vindex wl-nntp-posting-server
4234 The initial setting is @code{nil}.
4235 This is the NNTP server name used for news submission.
4236 If @code{nil}, @code{elmo-default-nntp-server} is used.
4238 @item wl-nntp-posting-user
4239 @vindex wl-nntp-posting-user
4240 The initial setting is @code{nil}.
4241 This is the user name for AUTHINFO authentication on news submission.
4242 If @code{nil}, @code{elmo-default-nntp-user} is used.
4243 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4245 @item wl-nntp-posting-port
4246 @vindex wl-nntp-posting-port
4247 The initial setting is @code{nil}.
4248 This is the port number of the NNTP server used for news submission.
4249 If @code{nil}, @code{elmo-default-nntp-server} is used.
4251 @item wl-nntp-posting-ssl
4252 @vindex wl-nntp-posting-ssl
4253 The initial setting is @code{nil}.
4254 If @code{nil}, @code{elmo-default-nntp-ssl} is evaluated. If non-nil,
4255 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4256 connection will be established.
4258 @item wl-pop-before-smtp-user
4259 @vindex wl-pop-before-smtp-user
4260 The initial setting is @code{nil}.
4261 This is the POP user name for POP-before-SMTP.
4262 If it is @code{nil}, @code{elmo-default-pop3-user} is used.
4264 @item wl-pop-before-smtp-server
4265 @vindex wl-pop-before-smtp-server
4266 The initial setting is @code{nil}.
4267 This is the POP server name for POP-before-SMTP.
4268 If it is @code{nil}, @code{elmo-default-pop3-server} is used.
4270 @item wl-pop-before-smtp-authenticate-type
4271 @vindex wl-pop-before-smtp-authenticate-type
4272 The initial setting is @code{nil}.
4273 This is the authentication method for POP-before-SMTP authentication.
4274 If it is @code{nil}, @code{elmo-default-pop3-authenticate} is used.
4276 @item wl-pop-before-smtp-port
4277 @vindex wl-pop-before-smtp-port
4278 The initial setting is @code{nil}.
4279 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4280 @code{elmo-default-pop3-port} is used.
4282 @item wl-pop-before-smtp-ssl
4283 @vindex wl-pop-before-smtp-ssl
4284 The initial setting is @code{nil}.
4285 This flag controls the use of SSL for POP-before-SMTP. If it is
4286 @code{nil}, @code{elmo-default-pop3-ssl} is used. If @code{starttls},
4287 STARTTLS (RFC2595) connection will be established.
4289 @item wl-draft-queue-save-variables
4290 @vindex wl-draft-queue-save-variables
4291 Specifies a list of variable to which queued messages are saved on the
4292 off-line transmission.
4294 @item wl-draft-sendlog
4295 @vindex wl-draft-sendlog
4296 The initial setting is @code{t}.
4297 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4301 @item drafts are sent by smtp or qmail
4302 @item saved into folders by fcc
4303 @item saved into folders by queuing
4306 (it is written even if the transmission fails).
4307 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4308 and left to the logging function of @command{imput}.
4311 @item wl-draft-sendlog-max-size
4312 @vindex wl-draft-sendlog-max-size
4313 The initial setting is 20000 (in bytes).
4314 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4315 beyond the size specified by this variable.
4319 The initial setting is @code{nil}.
4320 If non-nil, address completion uses LDAP.
4322 @item wl-ldap-server
4323 @vindex wl-ldap-server
4324 The initial setting is @samp{localhost}.
4325 LDAP server name for address completion.
4328 @vindex wl-ldap-port
4329 The initial setting is @code{nil}.
4330 If non-nil, the value is used as port number.
4333 @vindex wl-ldap-base
4334 The initial setting is @samp{c=US}.
4335 LDAP search starting point (base) for address completion.
4338 @node Disconnected Operations, Expire and Archive, Draft, Top
4339 @chapter Off-line Management
4340 @cindex Disconnected Operations
4342 Wanderlust has on-line and off-line states.
4345 * Off-line State:: Wanderlust has on-line and off-line states.
4346 * Enable Operations:: Enable Disconeected Operations.
4347 * Plugged Mode:: Switching On-line/Off-line per Server/Port.
4348 * Off-line State settings:: Invoking Wanderlust in the Off-line State.
4349 * Variables of Plugged Mode:: Customize Plugged Mode.
4353 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4354 @section Off-line State
4356 Wanderlust has on-line and off-line states. In the off-line state, you
4357 cannot access messages via network, unless they are cached.
4359 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4360 in the mode line indicates the off-line state. In folder or summary
4361 modes, press @kbd{M-t} to switch between off- and on-line.
4363 You can invoke Wanderlust in the off-line state by setting
4364 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4366 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4367 ignores uncached messages.
4370 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4371 @section Enable Disconeected Operations
4373 Even in the off-line state, provided that relevant messages are cached,
4374 and the variable @code{elmo-enable-disconnected-operation} (described
4375 later) is non-nil, you can following operations:
4376 @xref{Plugged Mode}, @xref{Off-line State settings}.
4379 * Send Messages off-line:: Transmit Messages.
4380 * Re-file and Copy queue:: Re-file and Copy (IMAP4).
4381 * Creation of Folders:: Create Folders off-line (IMAP4).
4382 * Marking:: Mark (IMAP4).
4383 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP).
4386 As soon as Wanderlust becomes on-line, such operations invoked off-line
4387 are reflected in the servers via network.
4390 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4391 @subsection Transmission of Messages
4393 You can send mail/news messages off-line (if you are using
4394 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4395 accumulated in the queue folder, @samp{+queue}. These messages are
4396 transmitted at once when Wanderlust becomes on-line.
4398 You can visit @samp{+queue} in the off-line state and confirm content of
4399 messages in the queue. You can also remove messages. Removed messages
4400 are not transmitted even in the on-line state.
4403 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4404 @subsection Re-file and Copy (IMAP4)
4406 Re-file and copy operations to IMAP folders invoked during the off-line
4407 state are accumulated in the queue, and reflected in the server side
4408 when Wanderlust becomes on-line. If you visit destination folders after
4409 off-line re-file or copy, it looks as if messages were appended even in
4412 For the safety reasons, messages re-filed off-line are removed from
4413 source folders only if their @samp{Message-ID:} match messages on the
4414 servers. While the queue is processed, messages that failed to be
4415 re-filed or copied to the specified folders are appended to the folder
4419 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4420 @subsection Creation of Folders (IMAP4)
4422 You can create IMAP folders off-line. The creation of folders are
4423 reflected in the servers when Wanderlust becomes on-line. At that time,
4424 if folders failed to be created on the servers for any reasons, messages
4425 re-filed to such folders are appended to the folder @samp{+lost+found}.
4428 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4429 @subsection Marking (IMAP4)
4431 Off-line changes in unread/read and importance mark @samp{$} information
4432 are also reflected in the servers when Wanderlust becomes on-line.
4435 @node Pre-fetching Reservations, , Marking, Enable Operations
4436 @subsection Pre-fetching (IMAP4, NNTP)
4438 You can make reservations for pre-fetching messages in IMAP or NNTP
4439 folders. Reserved messages are marked with @samp{!} but not cached
4440 yet. When Wanderlust becomes on-line, they are pre-fetched from
4443 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4444 these off-line operations for IMAP4 and NNTP do not take place, and
4445 off-line re-file, copy or suchlike simply results in error.
4447 Because off-line operations use cache files, it is a bad idea to erase
4448 them by hand; it may cause Wanderlust to malfunction.
4450 If you want to remove caches, be sure to execute @kbd{M-x
4451 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4452 remove caches for messages relevant to off-line operations.
4455 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4456 @section Switching On-line/Off-line per Server/Port
4458 @kbd{M-t} described above switches networking states as a whole, but you
4459 can switch on-line/off-line per server/port.
4461 Pressing @kbd{C-t} in the folder or summary modes brings you in
4462 wl-plugged-mode shown below, in which you can change the plugged state
4467 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4470 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4471 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4473 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4474 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4480 The first line indicates status of the following three variables, and
4481 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
4482 column modifies the values of these variables.
4486 "Queuing" @code{wl-draft-enable-queuing}
4487 "AutoFlushQueue" @code{wl-auto-flush-queue}
4488 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4492 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4495 The second and after lines indicate on-line/off-line states of servers
4496 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4497 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4498 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4500 @dfn{sending queue} means messages accumulated in the folder
4501 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4502 off-line operations when @code{elmo-enable-disconnected-operation} is
4504 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4505 @c off-line operations are enabled.
4507 They are displayed if there are any of them. In the example above, in
4508 the sending queue there are two messages (the first and the second in
4509 the queue folder) for smtp to hosta and one (the third) for nntp to
4510 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4513 If you change @samp{(wl-plugged)} in the second line, the variable
4514 @code{wl-plugged} is changed, so that the mode line indicator and
4515 plugged states of all ports are affected. If you change plugged states
4516 of any servers or ports, @samp{(wl-plugged)} in the second line is
4517 affected depending on @code{elmo-plugged-condition} settings and the
4518 plugged state of each port.
4521 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4522 @section Invoking Wanderlust in the Off-line State
4524 As described before, if you set @code{wl-plugged} to @code{nil} in
4525 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4526 off-line state. You can specify off-line state on a per server or port
4527 basis. Refer to @code{wl-reset-plugged-alist} also.
4529 Usually, when Wanderlust starts up, the plugged state of each port is
4530 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4531 @code{wl-nntp-posting-server} and so on. If you want to change the
4532 plugged state of these ports or to add other ports, configure
4533 @code{wl-make-plugged-hook} with a function.
4537 (add-hook 'wl-make-plugged-hook
4539 (elmo-set-plugged plugged-value(t/nil) server port)
4540 ;; @r{add or change plugged states of the port of the server}
4541 (elmo-set-plugged plugged-value(t/nil) server)
4542 ;; @r{if the port is omitted, all ports are affected}
4543 ;; @r{(you cannot omit the port if you newly add the server)}
4549 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4550 @section Customizable Variables
4555 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4556 mode from the beginning.
4558 @item wl-queue-folder
4559 @vindex wl-queue-folder
4560 The initial setting is @samp{+queue}.
4561 This is the folder in which messages in the transmission queue are
4564 @item wl-auto-flush-queue
4565 @vindex wl-auto-flush-queue
4566 The initial setting is @code{t}.
4567 This flag controls automatic transmission of the queue when Wanderlust
4568 becomes on-line. If non-nil, the queue is automatically transmitted
4569 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4570 manually, press @kbd{F} in the folder mode.
4572 @item elmo-enable-disconnected-operation
4573 @vindex elmo-enable-disconnected-operation
4574 The initial setting is @code{nil}. Controls off-line operations
4575 regarding IMAP4. If non-nil, off-line operations are carried out.
4577 @item elmo-lost+found-folder
4578 @vindex elmo-lost+found-folder
4579 The initial setting is @samp{+lost+found}.
4580 This is the folder to which messages are saved when they fails to be
4581 appended while the off-line re-file/copy queue is processed.
4583 @item elmo-plugged-condition
4584 @vindex elmo-plugged-condition
4585 The initial setting is @code{one}.
4586 The value of @code{wl-plugged} reflects the return value of the function
4587 @code{elmo-plugged-p} (without arguments).
4588 This variable @code{elmo-plugged-condition} specifies the condition on
4589 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4590 plugged state of each port.
4593 'one : plugged if one or more ports are plugged.
4594 'all : plugged if all ports are plugged.
4595 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4596 states of the ports.
4597 @var{function} : reflects the return value of the @var{function}
4598 functions available per default
4599 'elmo-plug-on-by-servers
4600 : reflects the plugged state of the servers specified by the
4601 variable elmo-plug-on-servers.
4602 'elmo-plug-on-by-exclude-servers
4603 : reflects the plugged state of the servers that are not
4604 in elmo-plug-on-exclude-servers.
4605 elmo-plug-on-exclude-servers defaults to
4608 (system-name)without the domain part)
4614 (setq elmo-plugged-condition 'all)
4616 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4617 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4619 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4620 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4624 @item wl-reset-plugged-alist
4625 @vindex wl-reset-plugged-alist
4626 The initial setting is @code{t}. If non-nil, plugged states are
4627 initialized on a per server or port basis when Wanderlust starts up.
4629 If @code{nil}, plugged states are retained while Emacs is running. In
4630 other words, they are initialized when Emacs is restarted even if the
4631 value is @code{nil}.
4635 @node Expire and Archive, Scoring, Disconnected Operations, Top
4636 @chapter Automatic Expiration and Archiving of Messages
4637 @cindex Expire and Archive
4640 * Expire:: Expiration and Archiving
4641 * Archive:: Archiving All Messages
4645 @node Expire, Archive, Expire and Archive, Expire and Archive
4647 @cindex Expire Message
4649 Expiration means deletion of old messages which have outlasted a
4650 certain period of time.
4652 @code{wl-expire} supports not only simple deletion, but also moving to
4653 specified archiving folders.
4657 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4658 or @kbd{M-e} in the summary mode.
4660 @subsection Configuring @code{wl-expire-alist}
4662 An example configuration of @code{wl-expire-alist} is shown below.
4663 Everything in this @code{wl-expire-alist} makes a great difference in
4664 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4665 to @code{t}, especially in the initial stage.
4669 (setq wl-expire-alist
4670 '(("^\\+trash$" (date 14) remove)
4672 ("^\\+tmp$" (date 7) trash)
4673 ;; @r{re-file to @code{wl-trash-folder}}
4674 ("^\\+outbox$" (number 300) "$outbox;lha")
4675 ;; @r{re-file to the specific folder}
4677 ;; @r{do not expire}
4678 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4679 ;; @r{archive by message number (retaining numbers)}
4680 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4681 ;; @r{archive by a fixed number (retaining numbers)}
4682 ("^\\+diary$" (date 30) wl-expire-archive-date)
4683 ;; @r{archive by year and month (numbers discarded)}
4688 Items in the list has the format of:
4691 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4695 The folder is examined if it matches @var{regexp-for-folders} from the
4696 beginning of the list. If you invoke expiration on the folder that does
4697 not match any of them, nothing will happen. And if either the second or
4698 the third element of the item is @code{nil}, expiration will not take
4701 You can use any one of the following for
4702 @var{specification-of-message-to-be-deleted}:
4705 @item (number @var{n1} [@var{n2}])
4706 deletes messages depending on the number of messages in the folder.
4708 @var{n1} is the number of messages which should survive deletion, for example
4709 if its value is 500, the newest 500 messages survive and the rests are
4712 @var{n2} is the number of messages in the folder on which expiration should
4713 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4714 folders with 510 or more messages are expired.
4715 If you configured automatic expiration, frequently used folders may
4716 expire every time it receive messages, and you may be annoyed with the
4717 long delay in reading mail.
4718 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4719 expiration would not take place until a certain number of messages
4722 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4723 with important/new/unread) are not deleted.
4724 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4725 will expire so as to have 500 messages including such ones.
4726 Otherwise, it will have 500 messages except such ones.
4728 @item (date @var{d1})
4729 deletes messages depending on the dates.
4731 Messages dated @var{d1} or more days ago are deleted, for example if its
4732 value is seven, messages seven days old or more are deleted. Note that
4733 the date is the one in the @samp{Date:} field of the message, not when
4734 the message entered the folder.
4736 Messages with no or invalid @samp{Date:} field does not expire; you
4737 might have to delete them by hand.
4740 You can use any one of the following in the place of @var{destination}:
4744 deletes the messages instantly.
4747 moves the messages to @code{wl-trash-folder}.
4749 @item @var{string}(folder)
4750 moves the messages to the folder specified with @var{string}.
4752 It would be useful for specifying an archiving folder, but because this
4753 does not move important messages, it might be better to use the
4754 standard functions described below.
4756 @item @var{function}
4757 invokes the specified @var{function}.
4759 To the @var{function}, three arguments are passed: a folder name, a list
4760 of messages to be deleted, and msgdb information of the summary. You
4761 can specify function-specific arguments after the name of the
4762 @var{function}. Note that the list contains messages with marks in
4763 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4766 These are three standard functions; they moves messages to an archive
4767 folder in the specified way. This means old messages can be compressed
4768 and saved in a file, being deleted from the original folder.
4771 @item wl-expire-archive-number1
4772 re-files to archiving folders corresponding to the message numbers of
4773 the messages being deleted. For example, a message numbered 102 will be
4774 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4775 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4776 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4778 The archiving folders to which messages are re-filed are determined by
4779 the name of the folder as follows (in this case, archiving folders are
4780 handled as if @code{elmo-archive-treat-file} were non-nil).
4783 @item If the folder type is localdir:
4784 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4786 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4787 (@file{~/Mail/ml/wl-00100.zip}).
4789 @item The folder type is other than localdir:
4790 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4792 For example, @samp{%#mh/ml/wl} corresponds to
4793 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4796 As you can see, in the case of localdir, the folder type is not included
4797 in the path name, but otherwise it is included.
4798 And you can control the prefix to the archiving folder name by
4799 @code{wl-expire-archive-folder-prefix}.
4800 Refer to @code{wl-expire-archive-folder-prefix} for details.
4802 @item wl-expire-archive-number2
4803 re-files every certain number of messages to archiving folders.
4805 This differs from @samp{wl-expire-archive-number1} in that this re-files
4806 to the folder up to the specified number regardless of message numbers.
4807 The archiving folders to which messages are re-filed are determined in the
4808 same way as @code{wl-expire-archive-number1}.
4810 @item wl-expire-archive-date
4811 re-files messages depending on its date (year and month) to archive
4814 For example, a message dated December 1998 is re-filed to
4815 @code{$folder-199812;zip}. The name of the archiving folders except the
4816 date part are determined in the same way as
4817 @code{wl-expire-archive-number1}.
4820 You can set the first argument to these three standard functions to non-nil
4821 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4822 For example, it can be specified just after the name of the function:
4825 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4828 If you omit the argument, consecutive numbers from 1 are assigned for
4829 each archiving folder.
4832 @subsection Treatment for Important or Unread Messages
4834 If you specify any of @code{remove}, @code{trash}, a folder name, or a
4835 standard function, messages with marks in
4836 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
4837 messages} thereafter) are retained.
4839 Per default, this variable include the important, new, and unread marks,
4840 so that messages with these marks are not removed.
4841 Note that you cannot include the temporary mark (i.e. temporary marks
4842 are removed anyway), and be sure to process temporary marks before you
4845 @subsection Auto Expiration
4847 The following setup invokes expiration when you move into the summary
4848 mode. There will be no confirmation, so make sure you made no mistake
4849 in regexp and other settings before you set up this.
4853 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4857 In the folder mode, you can invoke expiration per group as well as per
4858 folder. Therefore, if you specify @samp{Desktop} group, all folders
4859 matching @code{wl-expire-alist} expire.
4863 @subsection Treating archive folders.
4864 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
4865 you must set non-nil value to @code{elmo-archive-treat-file}.
4867 @subsection Confirming
4869 If you are to use @code{remove}, try @code{trash} at first and see
4870 messages move to @code{wl-trash-folder} as expected, then replace it
4871 with @code{remove}. It would be dangerous to use @code{remove} from the
4874 If you are to use @code{wl-expire-archive-number1} and the like, try to
4875 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
4876 you can append messages to it. Even if settings in
4877 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
4878 would not be saved anywhere and disappeared in case the archiver program
4881 After you make sure you can archive to the folder correctly, you can
4882 invoke expiration and utilize the log.
4884 If you set @code{wl-expire-use-log} to @code{t},
4885 @file{~/.elmo/expired-log} should contain the log, for example:
4889 delete +ml/wl (593 594 595 596 597 598 599)
4890 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
4894 The first column indicates the operation, i.e. @samp{delete},
4895 @samp{copy}, or @samp{move}. The next is the name of the folder that
4896 expired. In the case of @samp{copy} and @samp{move}, the destination
4897 folder is recorded after @samp{->}. The last is the list of message
4898 numbers that are actually deleted or moved (in the case of @samp{copy}
4899 and @samp{move}, the number is the one in the source folder, rather than
4900 the destination folder).
4902 @subsection Re-filing Reserved Messages
4904 The three standard functions copy reserved messages to the archive
4905 folder, but do not delete them from the source folder. Because
4906 reserved messages and the like always remain, they are recorded in
4907 @file{~/.elmo/expired-alist} so that they are not copied over and over
4908 again. They are not recorded if copied by @code{wl-summary-archive}.
4910 If you enabled logging, usually @samp{move} is recorded for re-filing,
4911 but instead @samp{copy} and @samp{delete} are recorded separately if
4912 reserved messages are involved. This is because it actually copies
4913 messages including reserved, then deletes ones except reserved in that
4916 @section Customizable Variables
4919 @item wl-expire-alist
4920 @vindex wl-expire-alist
4921 The initial setting is @code{nil}.
4922 This variable specifies folders and methods to expire. For details,
4923 refer to @code{wl-expire-alist} settings above.
4925 @item wl-summary-expire-reserve-marks
4926 @vindex wl-summary-expire-reserve-marks
4927 The initial setting is the list below.
4931 (list wl-summary-important-mark
4933 wl-summary-unread-mark
4934 wl-summary-unread-uncached-mark
4935 wl-summary-unread-cached-mark)
4939 Messages with these marks are retained in the folder, even after
4941 Only permanent marks can be listed, not temporary marks.
4943 You can list marks one by one as in the default; you can use the
4944 following settings as well:
4948 All messages with permanent marks are retained,
4949 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
4953 All messages are handled as usual ones that are already read, no matter
4954 what marks they have; even important messages are deleted.
4957 @item wl-expire-archive-files
4958 @vindex wl-expire-archive-files
4959 The initial setting is 100.
4960 This variable specifies the number of messages to be retained in one
4963 @item wl-expire-number-with-reserve-marks
4964 @vindex wl-expire-number-with-reserve-marks
4965 The initial setting is @code{nil}.
4966 If non-nil, if expiring messages are specified by @code{number},
4967 messages with @code{wl-summary-expire-reserve-marks} are also retained.
4969 @item wl-expire-archive-get-folder-func
4970 @vindex wl-expire-archive-get-folder-func
4971 The initial setting is @code{wl-expire-archive-get-folder}.
4973 This variable specifies a function that returns the name of an archiving
4974 folder for standard functions in the place of @var{destination}.
4975 You can use the following three variables for simple modification of
4976 folder names; if you want more complex settings, define your own
4977 function in this variable.
4979 @code{wl-expire-archive-get-folder} can be customized by these
4982 @item @code{wl-expire-archive-folder-name-fmt}
4983 @item @code{wl-expire-archive-folder-type}
4984 @item @code{wl-expire-archive-folder-prefix}
4987 @item wl-expire-archive-folder-name-fmt
4988 @vindex wl-expire-archive-folder-name-fmt
4989 The initial setting is @samp{%s-%%05d;%s}.
4990 This is a @code{format} string for archiving folders used in
4991 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
4992 Note that you must specify the message number by @samp{%%d}, because it
4993 is parsed twice by @code{format}.
4995 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
4998 @item wl-expire-archive-date-folder-name-fmt
4999 @vindex wl-expire-archive-date-folder-name-fmt
5000 The initial setting is @samp{%s-%%04d%%02d;%s}.
5001 This is a @code{format} string for archiving folders used in
5002 @code{wl-expire-archive-date}. Note that you must specify the message
5003 number by @samp{%%d}, because it is parsed twice by @code{format}.
5004 There should be @samp{%%d} twice, one for the year and the other for the
5007 If you modify this, adjust
5008 @code{wl-expire-archive-date-folder-num-regexp} as well.
5010 @item wl-expire-archive-folder-type
5011 @vindex wl-expire-archive-folder-type
5012 The initial setting is @code{zip}.
5013 This variable specifies an archiver type of the archiving folders.
5015 @item wl-expire-archive-folder-prefix
5016 @vindex wl-expire-archive-folder-prefix
5017 The initial setting is @code{nil}.
5018 This variable specifies the prefix (directory structure) to archiving
5020 Exercise extreme caution in using this feature, as it has not been
5022 In the worst case, there is a fear of destructing archiving folders.
5026 There will be no prefix.
5029 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5030 @samp{$ml/wl-00000;zip;wl}.
5033 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5036 @samp{$ml/wl-00000;zip;ml/wl}.
5039 @item wl-expire-archive-folder-num-regexp
5040 @vindex wl-expire-archive-folder-num-regexp
5041 The initial setting is @samp{-\\([-0-9]+\\);}.
5042 This variable specifies the regular expression to be used for getting
5043 message numbers from multiple archiving folders specified by
5044 @code{elmo-list-folders}.
5045 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5047 @item wl-expire-archive-date-folder-num-regexp
5048 @vindex wl-expire-archive-date-folder-num-regexp
5049 The initial setting is @samp{-\\([-0-9]+\\);}.
5050 This is the regular expression to be used for getting message numbers
5051 from multiple archiving folders specified by @code{elmo-list-folders}.
5052 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5054 @item wl-expire-delete-oldmsg-confirm
5055 @vindex wl-expire-delete-oldmsg-confirm
5056 The initial setting is @code{t}.
5057 If non-nil, messages older than the one with the largest number will be
5058 deleted with confirmation.
5059 If @code{nil}, they are deleted without confirmation.
5061 This feature is valid only if non-nil is specified as a argument to the
5062 standard functions so as to retain numbers.
5064 @item wl-expire-use-log
5065 @vindex wl-expire-use-log
5066 The initial setting is @code{nil}.
5067 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5068 They are appended but not truncated or rotated automatically; you might
5069 need to remove it manually.
5071 @item wl-expire-add-seen-list
5072 @vindex wl-expire-add-seen-list
5073 The initial setting is @code{t}.
5075 If non-nil, when messages are re-filed by expiration, read/unread
5076 information is passed to the destination folder.
5078 However if you do not read the destination folder from Wanderlust,
5079 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5080 want to set this to @code{nil} if you are simply saving to some
5081 archiving folders. Even if its value is @code{nil}, messages in the
5082 archiving folders are simply treated as unread; it does not affect
5085 @item wl-expire-folder-update-msgdb
5086 @vindex wl-expire-folder-update-msgdb
5087 The initial setting is @code{t}.
5088 If @code{t}, in the folder mode, expiration is carried out after
5089 updating summary information. If you specified a list of regular
5090 expressions of folder names, summary information is updated for matching
5095 @node Archive, , Expire, Expire and Archive
5096 @section Archiving Messages
5098 @subsection Archiving Messages
5099 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5100 folders. If there are the archiving folders already, only new messages
5103 You can use @code{wl-archive-alist} in order to specify how messages are
5104 archived according to their folder names, as in @code{wl-expire-alist}.
5109 (setq wl-archive-alist
5110 '(("^\\+tmp$" wl-archive-date)
5111 ("^\\+outbox$" wl-archive-number2)
5112 (".*" wl-archive-number1)))
5116 Each item in the list has the following format:
5119 (@var{folders-regexp} @var{deleting-function})
5122 As you can see, you can only use a function after @var{folders-regexp}.
5123 Per default, there are three functions:
5126 @item @code{wl-archive-number1}
5127 @item @code{wl-archive-number2}
5128 @item @code{wl-archive-date}
5131 As inferred from their names, they work similarly to "expire" versions,
5132 other than the following points:
5135 @item No messages are deleted
5136 @item Message numbers are retained even if invoked without arguments
5139 These functions are good to archive all messages in a folder by their
5140 numbers or by their dates.
5141 These are also useful for backup or confirmation purposes before
5143 If you try to re-file them after they are archived, they are deleted but
5146 Per default, the archiving folders to which messages are copied are
5147 determined automatically by @code{wl-expire-archive-get-folder-func}.
5148 You can copy to a specific folder by invoking with a prefix argument,
5149 i.e. @kbd{C-u M-x wl-summary-archive}.
5151 Note that this feature has not been seriously tested, because you can
5152 simply copy to an archiving folder, for example by
5153 @code{wl-summary-copy-region}.
5155 The archiving folders are determined by the same logic as in
5156 @code{wl-summary-expire}; the following customizable variables are
5160 @item @code{wl-expire-archive-files}
5161 @item @code{wl-expire-archive-get-folder-func}
5162 @item @code{wl-expire-archive-folder-name-fmt}
5163 @item @code{wl-expire-archive-folder-type}
5164 @item @code{wl-expire-archive-folder-prefix}
5165 @item @code{wl-expire-archive-folder-num-regexp}
5168 @subsection Customizable Variables
5171 @item wl-archive-alist
5172 @vindex wl-archive-alist
5173 The initial setting is the list shown below:
5177 ((".*" wl-archive-number1))
5182 This variable specifies a function that copies to archiving folders.
5183 To the function, three arguments are passed: a folder name, a list of
5184 messages in the folder, and msgdb information of the summary.
5185 Needless to say, you can use your own function.
5189 @node Scoring, Customization, Expire and Archive, Top
5190 @chapter Score of the Messages
5192 @c @cindex Kill File
5194 Scoring is the function that associates a score (value) with each
5195 message, and marks as read or deletes from the summary according to it.
5197 You can put target or important marks on essential messages, or read marks
5198 on the ones you do not want to read, for example spam articles.
5200 This scoring function has a capability and a format similar to the one
5201 that Gnus has, although there are some unsupported features and
5202 Wanderlust specifics.
5203 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5206 * Score Commands:: Score Commands
5207 * Score File Format:: Score File Format
5211 @node Score Commands, Score File Format, Scoring, Scoring
5212 @section Score Commands
5213 @cindex Score Commands
5215 @subsection Score File Specification
5217 @code{wl-score-folder-alist} specifies score files or variables in which
5218 scores are defined, corresponding to folder names.
5222 (setq wl-score-folder-alist
5231 If paths to the score files are omitted, the directory specified in the
5232 variable @code{wl-score-files-dir} is assumed.
5234 No matter what you write in @code{wl-score-folder-alist}, the default
5235 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5236 read (it does not have to exist).
5237 Therefore, in the example above, the three score files,
5238 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5239 the folders that matches @samp{^-.*}.
5241 @subsection Scored Messages
5243 Scores are attached to the messages that are specified by
5244 @code{wl-summary-score-marks} temporarily when the summary is updated;
5245 when you exit from the summary, the scores are removed and reverts to
5248 @subsection Creation of Score Files
5250 In the summary buffer, move to an appropriate message and type @kbd{L}.
5251 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5252 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5254 This makes @minus{}1000 are scored for messages with the same
5255 @samp{Subject:} as the string you entered. That is, such a score file
5256 is created automatically.
5258 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5259 The score file you just made appears.
5260 This buffer is called @dfn{score editing buffer} thereafter.
5261 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5262 as you are previously; type @kbd{a}. Then a score entry for "From"
5264 In this way, you can create a score file easily either in the summary
5265 buffer or in the score editing buffer.
5267 By the way, you might be aware the numbers of key strokes are different
5268 between @kbd{s s p} and @kbd{a}.
5269 This is determined by @code{wl-score-header-default-entry}.
5270 This variable specifies the default score entries corresponding to
5272 For example, for "subject" field, a type and a time limit are prompted,
5273 but for "from" field, they are fixed upon automatically as substring and
5274 permanent respectively.
5275 However, score values can be modified by the prefix argument.
5276 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5279 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5280 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5281 erasing contents of the buffer deletes the score file being edited.
5285 @subsubsection Selecting Score Files
5287 You can change score files to which scores are appended by
5288 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5289 @code{wl-score-change-score-file}.
5291 @subsubsection Summing Up the Score
5293 If you add the same entries by @code{wl-summary-increase-score},
5294 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5295 scores for the entry is summed up.
5297 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5298 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5299 @minus{}1200 will be created as a result.
5301 @subsubsection Creating Thread Key
5303 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5304 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5306 @subsubsection Creating Followup Key
5308 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5309 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5310 at the cursor to @samp{References} key.
5311 If @code{wl-score-auto-make-followup-entry} is non-nil,
5312 @samp{Message-ID} of all messages to be followed up within dates
5313 specified by @code{wl-score-expiry-days}.
5315 @subsection Key Bindings
5320 @findex wl-summary-increase-score
5321 Increases the score for the current message.
5322 And the score entry is appended to the score file at the same moment.
5323 You can specify the score value by a prefix argument.
5327 @findex wl-summary-lower-score
5328 Decreases the score for the current message.
5329 And the score entry is appended to the score file at the same moment.
5330 You can specify the score value by a prefix argument.
5333 @kindex h R (Summary)
5334 @findex wl-summary-rescore
5335 Re-applies the scoring.
5336 However, already scored messages are not scored anew.
5339 @kindex h c (Summary)
5340 @findex wl-score-change-score-file
5341 Changes the score file currently selected.
5344 @kindex h e (Summary)
5345 @findex wl-score-edit-current-scores
5346 Edits the score file currently selected.
5347 If there are multiple score files, the previously specified one is
5351 @kindex h f (Summary)
5352 @findex wl-score-edit-file
5353 Edits an arbitrary score file and selects it.
5356 @kindex h F (Summary)
5357 @findex wl-score-flush-cache
5358 Erases caches associated to the score files that are read.
5359 If you modified score files directly (from other than Wanderlust), you
5360 need to re-read them after erasing the cache.
5363 @kindex h m (Summary)
5364 @findex wl-score-set-mark-below
5365 Specifies the criterion for scores to be marked as read.
5366 Messages with scores less than this value are marked as read.
5369 @kindex h x (Summary)
5370 @findex wl-score-set-expunge-below
5371 Specifies the criterion for scores to be deleted from the summary.
5372 Messages with scores less than this value are deleted.
5373 "Deleted" means it is not shown; they are not removed from the summary
5374 information or the folder.
5375 The deleted messages can be shown by rescan-noscore again.
5378 @subsection Key Bindings in the Score Editing Buffer
5382 @kindex C-c C-k (Score Mode)
5383 @findex wl-score-edit-kill
5384 Abandons the file being edited.
5387 @kindex C-c C-c (Score Mode)
5388 @findex wl-score-edit-exit
5389 Saves the file being edited, and quits from the edit mode.
5392 @kindex C-c C-p (Score Mode)
5393 @findex wl-score-pretty-print
5397 @kindex C-c C-d (Score Mode)
5398 @findex wl-score-edit-insert-date
5399 Inserts the number of dates from Dec. 31, 1 B.C.
5400 It is used for creating the third factor of time-limited scores.
5403 @kindex C-c C-s (Score Mode)
5404 @findex wl-score-edit-insert-header
5405 Inserts the header of the message selected in the summary buffer.
5408 @kindex C-c C-e (Score Mode)
5409 @findex wl-score-edit-insert-entry
5410 Inserts the score entry of the message selected in the summary buffer.
5413 @subsection Customizable Variables
5416 @item wl-summary-default-score
5417 @vindex wl-summary-default-score
5418 The initial setting is 0 (zero).
5419 This variable specifies the default value of the score.
5420 The score is increased or decreased based upon this value.
5422 @item wl-summary-important-above
5423 @vindex wl-summary-important-above
5424 The initial setting is @code{nil}.
5425 Messages with scores larger than this value are attached with the
5426 important mark (@samp{$}).
5427 If @code{nil}, no important marks are attached.
5429 @item wl-summary-target-above
5430 @vindex wl-summary-target-above
5431 The initial setting is @code{nil}.
5432 Messages with scores larger than this value are attached with the target
5434 If @code{nil}, no target marks are attached.
5436 @item wl-summary-mark-below
5437 @vindex wl-summary-mark-below
5438 The initial setting is 0 (zero).
5439 Messages with scores smaller than this value are marked as read.
5441 @item wl-summary-expunge-below
5442 @vindex wl-summary-expunge-below
5443 The initial setting is @code{nil}.
5444 Messages with scores smaller than this value are deleted from the
5446 If @code{nil}, they are not deleted.
5448 @item wl-summary-score-marks
5449 @vindex wl-summary-score-marks
5450 The initial setting is the list shown below:
5454 (list wl-summary-new-mark)
5459 Messages with these marks are scored.
5461 @item wl-use-scoring
5462 @vindex wl-use-scoring
5463 The initial setting is t.
5464 If non-nil, scoring is enabled.
5466 @item wl-score-files-dir
5467 @vindex wl-score-files-dir
5468 The initial setting is @file{~/.elmo/}.
5469 The default directory for score files.
5471 @item wl-score-interactive-default-score
5472 @vindex wl-score-interactive-default-score
5473 The initial setting is 1000.
5474 This value is used as a score when a score factor is @code{nil} in the
5475 score file. It is also used in @code{wl-summary-increase-score} and
5476 @code{wl-summary-lower-score}, on condition that the value of
5477 @code{wl-score-header-default-entry} is @code{nil}.
5479 @item wl-score-expiry-days
5480 @vindex wl-score-expiry-days
5481 The initial setting is 7.
5482 This is the number of days before time-limited scores are deleted.
5484 @item wl-score-update-entry-dates
5485 @vindex wl-score-update-entry-dates
5486 The initial setting is @code{t}.
5487 If non-nil, it enables deletion of time-limited scores.
5489 @item wl-score-header-default-entry
5490 @vindex wl-score-header-default-entry
5491 Specifies the default value for each header field for score entries
5492 created by @code{wl-summary-increase-score},
5493 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5495 @item wl-score-simplify-fuzzy-regexp
5496 @vindex wl-score-simplify-fuzzy-regexp
5497 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5498 regular expression to be deleted from the string.
5499 Because this is usually used for Subject, the default is prefixes that
5500 are attached by mailing list programs.
5502 @item wl-summary-rescore-partial-threshold
5503 @vindex wl-summary-rescore-partial-threshold
5504 The initial setting is 200.
5505 When sync-all or rescan is executed, if there are messages more than
5506 this value, only the last same number of messages as this value are
5509 @item wl-summary-auto-sync-marks
5510 @vindex wl-summary-auto-sync-marks
5511 If non-nil, unread/important marks are synchronized when the summary
5513 Unread marks reflect information on the IMAP4 server.
5514 Important marks reflect information on the IMAP4 server (flagged or
5515 not), and contents of @samp{'mark} folder.
5516 The initial setting is @code{t}.
5520 @node Score File Format, , Score Commands, Scoring
5521 @section Score File Format
5522 @cindex Score File Format
5524 The format of score files are the same as Gnus, and basically you can
5525 use Gnus score files as they are. But they are not fully compatible
5526 because some keys are not supported and there are Wanderlust specifics.
5527 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5532 ("for sale" -1000 nil s)
5533 ("profit" -1000 nil s))
5535 ("spam@@spamspamspam" -10000 nil s))
5537 ("my@@address" 3001 nil s))
5539 (1000000 -10 nil >))
5549 If the key is a string, it is the name of the header to be matched.
5550 The following keys are available:
5551 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5552 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5553 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5554 @code{Chars} and @code{Lines} mean the size and the number of lines of
5555 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5556 are described later.
5557 The rest corresponds the field of the same name.
5559 Arbitrary numbers of core entries are specified after the key.
5560 Each score entry consists of these five factors:
5564 A factor that matches header. This should be a number in the cases of
5565 @code{lines} and @code{chars}, otherwise a string.
5568 A score factor. When the first item matches, the score of the message
5569 is increased or decreased by this value.
5572 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5573 of a number, the score is deleted if it does not match for days
5574 (@code{wl-score-expiry-days}) from the date specified by this.
5575 The date is since Dec. 31, 1 B.C.
5578 A type factor. This specifies the way the first factor matches.
5579 Available types depend on keys.
5582 @item From, Subject, References, Message-ID
5583 For these keys in string, @code{r} and @code{R} (regexp),
5584 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5585 as well as @code{f} and @code{F} (fuzzy) can be used.
5586 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5589 For these keys, the following five numerical relative operators can be
5590 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5593 This key matches @code{From} header, and scores all follow-ups to the
5595 For example, it would be useful for increasing scores for follow-ups to
5598 You can use the same types as @code{From} except for @code{f}.
5599 And a @samp{Followup} entry is automatically appended to the score file.
5602 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5603 A @samp{Thread} entry is automatically appended for each article that
5604 has @var{x} in the @code{References} header.
5605 You can make sure the whole thread including messages that does not have
5606 all ancestors @code{Message-ID} in @code{References} is scored.
5608 You can use the same types as @code{References} except for @code{f}.
5609 And a @samp{Thread} entry is automatically appended to the score file.
5613 A factor for extension header. This is meaningful only if the key is
5615 This specifies headers to be matched other than standard headers like
5616 @code{Subject} and @code{From}.
5617 Note that you should specify the header in
5618 @code{elmo-msgdb-extra-fields} also.
5619 Therefore it does not work in folders where extension headers cannot be
5624 The sum of these scores @emph{after all factors are applied} becomes the
5625 score of the message.
5627 @cindex Score File Atoms
5629 Messages with a score less than this value is marked as read.
5630 The default is @code{wl-summary-mark-below}.
5633 Messages with a score less than this value is deleted from the summary.
5634 The default is @code{wl-summary-expunge-below}.
5636 @item mark-and-expunge
5637 Both @code{mark} and @code{expunge} are applied,
5638 i.e. messages with a score less than this value is marked as read and
5639 deleted from the summary.
5642 Messages with a score greater than this value is attached with temp
5644 The default is @code{wl-summary-target-above}.
5647 Messages with a score greater than this value is attached with important
5649 The default is @code{wl-summary-important-above}.
5654 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5655 are used, you need to set @code{elmo-msgdb-extra-fields}.
5658 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5661 There are other restrictions as shown below:
5664 @item Because @samp{References} field in the summary information
5665 contains only the last @samp{Message-ID}, @code{references} key matches
5669 Keys that can be seen by folder of types:
5673 chars lines xref extra
5674 localdir,localnews Y E E E
5675 nntp (supporting xover) Y E E N
5681 N: cannot be seen (ignored)
5682 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5687 @node Customization, Mailing List, Scoring, Top
5688 @chapter Customizing Wanderlust
5689 @cindex Customization
5692 * Living with other packages:: Living with other packages
5693 * Highlights:: Highlights
5694 * Biff:: Notify Mail arrival
5695 * Advanced Settings:: Advanced Settings
5696 * Customizable Variables:: Customizable Variables
5701 @node Living with other packages, Highlights, Customization, Customization
5702 @section Living with other packages
5704 Examples with other packages.
5707 * imput:: imput (im-wl.el)
5709 * supercite:: supercite.el
5710 * mu-cite:: mu-cite.el
5711 * x-face-mule:: x-face-mule.el
5712 * dired-dd:: dired-dd.el
5716 @node imput, BBDB, Living with other packages, Living with other packages
5721 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5724 If @command{imput} is on the @code{exec-path} at the installation,
5725 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
5729 (autoload 'wl-draft-send-with-imput-async "im-wl")
5730 (setq wl-draft-send-func 'wl-draft-send-with-imput-async)
5735 @node BBDB, supercite, imput, Living with other packages
5739 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
5742 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
5743 byte-compiled and installed.
5751 ;; @r{enable pop-ups}
5752 (setq bbdb-use-pop-up t)
5753 ;; @r{auto collection}
5754 (setq bbdb/mail-auto-create-p t)
5755 (setq signature-use-bbdb t)
5756 (setq bbdb-north-american-phone-numbers-p nil)
5757 ;; @r{shows the name of bbdb in the summary} :-)
5758 (setq wl-summary-from-func 'bbdb-wl-from-func)
5759 ;; @r{automatically add mailing list fields}
5760 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
5761 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
5765 @node supercite, mu-cite, BBDB, Living with other packages
5766 @subsection sc.el(supercite), sc-register.el
5770 The same setting as usual mailers should be OK. The following is an
5771 example of settings:
5775 (autoload 'sc-cite-original "sc" nil t)
5776 (setq mail-yank-hooks 'sc-cite-original)
5777 (setq sc-preferred-header-style 1)
5778 (setq sc-electric-references-p nil)
5779 (setq sc-citation-leader "")
5780 (setq sc-load-hook '(lambda () (require 'sc-register)))
5781 (setq sc-preferred-attribution 'registeredname)
5786 @node mu-cite, x-face-mule, supercite, Living with other packages
5787 @subsection mu-cite.el
5790 The same setting as usual mailers should be OK. The following is an
5791 example of settings.
5793 If you use mu-cite version 8.0 or earlier:
5797 (autoload 'mu-cite/cite-original "mu-cite" nil t)
5798 (setq mail-citation-hook 'mu-cite/cite-original)
5802 If you use mu-cite version 8.1 or later:
5806 (autoload 'mu-cite-original "mu-cite" nil t)
5807 (add-hook 'mail-citation-hook (function mu-cite-original))
5811 @node x-face-mule, dired-dd, mu-cite, Living with other packages
5812 @subsection x-face-mule.el
5816 It depends on the version of x-face-mule.
5817 If you use x-face-mule 0.19 or older, do the following:
5821 (setq wl-highlight-x-face-func
5824 (x-face-mule:x-face-decode-message-header))))
5828 If you use x-face-mule 0.20 or later, try the following:
5832 (setq wl-highlight-x-face-func
5835 (x-face-mule-x-face-decode-message-header))))
5836 (require 'x-face-mule)
5840 Use these settings when you use @file{x-face-mule.el} attached to
5841 bitmap-mule 8.0 or later:
5845 (autoload 'x-face-decode-message-header "x-face-mule")
5846 (setq wl-highlight-x-face-func 'x-face-decode-message-header)
5850 If there is an encoded X-Face string in a file @file{~/.xface} (the
5851 value of the variable @code{wl-x-face-file}), it is inserted as a
5852 @samp{X-Face:} field in the draft buffer (if
5853 @code{wl-auto-insert-x-face} is non-nil).
5856 @node dired-dd, , x-face-mule, Living with other packages
5857 @subsection dired-dd(Dired-DragDrop)
5858 @pindex Dired-DragDrop
5860 @cindex Drag and Drop
5862 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
5863 compose multi-part by simple Drag-and-Drop from dired to the draft
5864 buffer being edited in GNU Emacs (this feature is not Wanderlust
5865 specific, but general-purpose for tm/SEMI).
5869 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
5875 ;; @r{Set dired-x variables here.}
5876 ;; @r{To and flo@dots{}}
5878 (progn (require 'dired-dd)
5879 (require 'dired-dd-mime))))))
5884 @node Highlights, Biff, Living with other packages, Customization
5887 @subsection Customizable Variables
5890 @item wl-summary-highlight
5891 @vindex wl-summary-highlight
5892 The initial setting is @code{t}.
5893 If non-nil, the summary is highlighted.
5895 @item wl-highlight-max-summary-lines
5896 @vindex wl-highlight-max-summary-lines
5897 The initial setting is 10000.
5898 The summary is not highlighted if it has more lines than this value.
5900 @item wl-summary-highlight-partial-threshold
5901 @vindex wl-summary-highlight-partial-threshold
5902 The initial setting is 1000.
5903 This is a threshold whether the whole summary is highlighted.
5904 If there are more lines of messages in the summary, it is partially
5907 @item wl-summary-partial-highlight-above-lines
5908 @vindex wl-summary-partial-highlight-above-lines
5909 The initial setting is 30. If there are more lines of messages than
5910 @code{wl-summary-highlight-partial-threshold} in the summary, messages
5911 after the point that is the same number of lines as this value above the
5912 cursor line are highlighted partially. (If this value is @code{nil},
5913 the last same number of lines as the value of
5914 @code{wl-summary-highlight-partial-threshold} are highlighted.)
5916 @item wl-highlight-body-too
5917 @vindex wl-highlight-body-too
5918 The initial setting is @code{t}.
5919 If non-nil, bodies of drafts and messages are also highlighted.
5921 @item wl-highlight-message-header-alist
5922 @vindex wl-highlight-message-header-alist
5923 When highlighting headers of drafts and messages, this variable
5924 specifies which faces are allocated to important
5925 (@code{wl-highlight-message-important-header-contents}), secondly
5926 important (@code{wl-highlight-message-important-header-contents2}), and
5927 unimportant (@code{wl-highlight-message-unimportant-header-contents})
5929 Similarly, it can be used for allocating arbitrary faces to arbitrary
5930 regular expressions.
5932 @item wl-highlight-citation-prefix-regexp
5933 @vindex wl-highlight-citation-prefix-regexp
5934 Specifies a regular expression to which quoted lines in bodies of
5935 drafts and messages match.
5936 Bodies matching to this regular expression are highlighted by the faces
5937 specified by (@code{wl-highlight-message-cited-text-*}).
5939 @item wl-highlight-highlight-citation-too
5940 @vindex wl-highlight-highlight-citation-too
5941 The initial setting is @code{nil}.
5942 If non-nil, the quoting regular expression itself given by
5943 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
5945 @item wl-highlight-citation-header-regexp
5946 @vindex wl-highlight-citation-header-regexp
5947 Specifies a regular expression that denotes beginning of quotation.
5948 Bodies matching to this regular expression are highlighted by the face
5949 specified by @code{wl-highlight-message-headers}.
5951 @item wl-highlight-max-header-size
5952 @vindex wl-highlight-max-header-size
5953 The initial setting is @code{nil}. If a header size is larger than this
5954 value, it will not be highlighted. If @code{nil}, always highlighted
5955 (ignore header size).
5957 @item wl-highlight-max-message-size
5958 @vindex wl-highlight-max-message-size
5959 The initial setting is 10000.
5960 If a message is larger than this value, it will not be highlighted.
5961 With this variable, highlight is suppressed for uuencode or huge digest
5964 @item wl-highlight-signature-separator
5965 @vindex wl-highlight-signature-separator
5966 Specifies regular expressions that denotes the boundary of a signature.
5967 It can be a regular expression, or a list of ones.
5968 Messages after the place that matches this regular expression are
5969 highlighted by the face specified by
5970 @code{wl-highlight-message-signature}.
5972 @item wl-max-signature-size
5973 @vindex wl-max-signature-size
5974 The initial setting is 400.
5975 This is the largest size for a signature to be highlighted.
5977 @item wl-use-highlight-mouse-line
5978 @vindex wl-use-highlight-mouse-line
5979 The initial setting is @code{t}.
5980 If non-nil, the line pointed by the mouse is highlighted in the folder
5981 mode, summary mode, and the like.
5984 @subsection Setting Colors and Fonts of the Characters
5986 If you want to change colors or fonts of the characters, you need to
5987 modify faces defined in Wanderlust. Use @code{set-face-font} if you
5988 want to change fonts, and @code{set-face-foreground} for colors, and so
5989 on. You cannot write face settings in @file{.emacs}; write in
5992 For example, if you want to change the color for signatures to yellow,
5996 (set-face-foreground 'wl-highlight-message-signature "yellow")
6002 Faces defined in Wanderlust:
6005 @item wl-highlight-message-headers
6006 The face for field names of message headers.
6008 @item wl-highlight-message-header-contents
6009 The face for field bodies of message headers.
6011 @item wl-highlight-message-important-header-contents
6012 The face for important parts of message headers.
6013 Per default, this face is used for a body of @samp{Subject:} field.
6014 You can change its value by editing
6015 @code{wl-highlight-message-header-alist}.
6017 @item wl-highlight-message-important-header-contents2
6018 The face for secondly important parts of message headers.
6019 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6020 fields. You can change its value by editing
6021 @code{wl-highlight-message-header-alist}.
6023 @item wl-highlight-message-unimportant-header-contents
6024 The face for unimportant parts of message headers.
6025 Per default, this face is used for bodies of @samp{X-} fields
6026 @samp{User-Agent:} fields. You can change its value by editing
6027 @code{wl-highlight-message-header-alist}.
6029 @item wl-highlight-message-citation-header
6030 The face for headers of quoted messages.
6032 @item wl-highlight-message-cited-text-*
6033 The face for texts of quoted messages. The last @samp{*} is a
6034 @var{single figure} so that 10 different colors can be used according to
6037 @item wl-highlight-message-signature
6038 The face for signatures of messages. The initial settings are
6039 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6040 dark background colors.
6042 @item wl-highlight-header-separator-face
6043 The face for header separators of draft messages.
6045 @item wl-highlight-summary-important-face
6046 The face for message lines with important marks in the summary.
6048 @item wl-highlight-summary-new-face
6049 The face for message lines with new marks in the summary.
6051 @item wl-highlight-summary-displaying-face
6052 The face for the message line that is currently displayed.
6053 This face is overlaid.
6055 @item wl-highlight-thread-indent-face
6056 The face for the threads that is currently displayed.
6058 @item wl-highlight-summary-unread-face
6059 The face for message lines with unread marks in the summary.
6061 @item wl-highlight-summary-deleted-face
6062 The face for message lines with delete marks in the summary.
6064 @item wl-highlight-summary-refiled-face
6065 The face for message lines with re-file marks in the summary.
6067 @item wl-highlight-refile-destination-face
6068 The face for re-file information part of message lines with re-file
6069 marks in the summary.
6071 @item wl-highlight-summary-copied-face
6072 The face for message lines with copy marks in the summary.
6074 @item wl-highlight-summary-target-face
6075 The face for message lines with target marks @samp{*} in the summary.
6077 @item wl-highlight-summary-thread-top-face
6078 The face for message lines that are on the top of the thread in the
6081 @item wl-highlight-summary-normal-face
6082 The face for message lines that are not on top of the thread in the
6085 @item wl-highlight-folder-unknown-face
6086 The face for folders that are not known to have how many unsync messages
6089 @item wl-highlight-folder-zero-face
6090 The face for folders that have no unsync messages in the folder mode.
6092 @item wl-highlight-folder-few-face
6093 The face for folders that have some unsync messages in the folder mode.
6095 @item wl-highlight-folder-many-face
6096 The face for folders that have many unsync messages in the folder mode.
6097 The boundary between `some' and `many' is specified by the variable
6098 @code{wl-folder-many-unsync-threshold}.
6100 @item wl-highlight-folder-unread-face
6101 The face for folders that have no unsync but unread messages in the
6104 @item wl-highlight-folder-killed-face
6105 The face for folders that are deleted from the access group in the
6108 @item wl-highlight-folder-opened-face
6109 The face for open groups in the folder mode.
6110 It is meaningful when @code{wl-highlight-group-folder-by-numbers} is
6111 @code{nil} or a @var{number}.
6113 @item wl-highlight-folder-closed-face
6114 The face for close groups in the folder mode.
6115 It is meaningful when @code{wl-highlight-group-folder-by-numbers} is
6116 @code{nil} or a @var{number}.
6118 @item wl-highlight-folder-path-face
6119 The face for the path to the currently selected folder in the folder
6122 @item wl-highlight-logo-face
6123 The face for logo in the demo.
6125 @item wl-highlight-demo-face
6126 The face for strings (for example, a version number) in the demo.
6130 @node Biff, Advanced Settings, Highlights, Customization
6131 @section Notify Mail arrival
6134 Following setting is to notify mail arrival of @samp{%inbox}
6135 by the indicator on the modeline
6138 (setq wl-biff-check-folder-list '("%inbox"))
6141 @subsection Customizable Variables
6143 @item wl-biff-check-folder-list
6144 @vindex wl-biff-check-folder-list
6145 The initial setting is @code{nil}.
6146 This is the list of folders to check mail arrival.
6147 If @code{nil}, wl doesn't check mail arrival.
6149 @item wl-biff-check-interval
6150 @vindex wl-biff-check-interval
6151 The initial setting is 40 (in seconds).
6152 Check mail arrival in this period.
6156 @node Advanced Settings, Customizable Variables, Biff, Customization
6157 @section Advanced Settings
6160 * Draft for Reply:: Draft for Reply
6161 * Thread Format:: Appearance of Thread
6162 * User-Agent Field:: @samp{User-Agent:} Header Field
6166 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6167 @subsection Draft for Replay
6169 If you want, when you replying to articles in mailing lists, the address
6170 in Reply-To field of the original message to be prepared to To field of
6171 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6176 (setq wl-draft-reply-without-argument-list
6177 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6178 ("Followup-To" . (nil nil ("Followup-To")))
6179 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6180 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6185 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6186 in the original message, @samp{Reply-To:} field in the original is
6187 copied to @samp{To:} field.)
6189 Moreover, the behavior of @kbd{a} with prefix argument can
6190 be directed by @code{wl-draft-reply-with-argument-list} as well.
6192 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6193 @subsection Appearance of Threads
6197 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6198 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6199 391 09/18(Fri)19:24 +-[ Murata-san ]
6200 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6201 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6202 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6203 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6204 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6205 412 09/22(Tue)09:28 | +-[ Teranishi ]
6206 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6207 416 09/22(Tue)12:38 | +-[ Teranishi ]
6208 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6209 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6213 Settings to make appearance of threads like shown above:
6217 (setq wl-thread-indent-level 2)
6218 (setq wl-thread-have-younger-brother-str "+")
6219 (setq wl-thread-youngest-child-str "+")
6220 (setq wl-thread-vertical-str "|")
6221 (setq wl-thread-horizontal-str "-")
6222 (setq wl-thread-space-str " ")
6226 If you do not want to see branches, do the following:
6230 (setq wl-thread-indent-level 2)
6231 (setq wl-thread-have-younger-brother-str " ")
6232 (setq wl-thread-youngest-child-str " ")
6233 (setq wl-thread-vertical-str " ")
6234 (setq wl-thread-horizontal-str " ")
6235 (setq wl-thread-space-str " ")
6240 @node User-Agent Field, , Thread Format, Advanced Settings
6241 @subsection User-Agent Field
6245 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6246 @samp{User-Agent:} fields, define a function that generate appropriate
6247 strings as you like, and set it to variable
6248 @code{wl-generate-mailer-string-func}.
6250 If you do not want verbose @samp{User-Agent:} field, do the following:
6254 (setq wl-generate-mailer-string-func
6257 (concat "User-Agent: "
6258 (wl-generate-user-agent-string-1 nil)))))
6262 The following is a example:
6266 (setq mime-edit-insert-user-agent-field nil)
6267 (setq wl-generate-mailer-string-func
6270 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6275 @node Customizable Variables, Hooks, Advanced Settings, Customization
6276 @section Customizable Variables
6278 Customizable variables that have not been described yet:
6281 @item wl-default-folder
6282 @vindex wl-default-folder
6283 The initial setting is @samp{%inbox}. This is the default value for moving to
6284 a folder and the like.
6286 @item wl-draft-folder
6287 @vindex wl-draft-folder
6288 The initial setting is @samp{+draft}. It is the folder to which drafts are
6289 saved. It must be a localdir folder.
6291 @item wl-trash-folder
6292 @vindex wl-trash-folder
6293 The initial setting is @samp{+trash}. It is the wastebasket folder.
6294 If you changed this variable, you had better restart Wanderlust.
6296 @item wl-interactive-exit
6297 @vindex wl-interactive-exit
6298 The initial setting is @code{t}.
6299 If non-nil, you are asked for confirmation when Wanderlust terminates.
6301 @item wl-interactive-send
6302 @vindex wl-interactive-send
6303 The initial setting is @code{nil}.
6304 If non-nil, you are asked for confirmation when mail is sent.
6306 @item wl-folder-sync-range-alist
6307 @vindex wl-folder-sync-range-alist
6308 The initial setting is the alist shown below:
6313 ("^\\+draft$\\|^\\+queue$" . "all"))
6318 This is an associative list of regular expressions of folder names and
6319 update range of the summary. Update range is one of the @samp{all},
6320 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6321 @samp{last}. If a folder do not match, @samp{update} is used.
6324 @vindex wl-ask-range
6325 The initial setting is @code{t}.
6326 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6327 for updating the summary when you changed folders.
6329 @item wl-mime-charset
6330 @vindex wl-mime-charset
6331 The initial setting is @code{x-ctext}.
6332 This is the MIME charset for messages that are not MIME (e.g. without
6333 @samp{Content-Type:}). This value also used as default charset for
6334 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6335 this value as @code{iso-2022-jp}.)
6337 @item wl-highlight-folder-with-icon
6338 @vindex wl-highlight-folder-with-icon
6339 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6340 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6342 @item wl-strict-diff-folders
6343 @vindex wl-strict-diff-folders
6344 This is a list of regular expressions of folders.
6345 Unread messages are checked, for example when you press @kbd{s} in
6346 the folder mode, usually in a brief way (rapidly processed but not
6348 The folders matching this variable are seriously checked.
6349 You may want to set this variable so as to match conditional filter
6350 folders for IMAP4 folders.
6351 The initial setting is @code{nil}.
6353 @item wl-folder-use-server-diff
6354 @vindex wl-folder-use-server-diff
6355 When unread messages are checked, for example when you press @kbd{s} in
6356 the folder mode, usually (the number of messages on the server) @minus{}
6357 (the number of local messages) will be the number of unread messages.
6358 However, if this variable is non-nil, the number of unread messages on
6359 the server is checked. This affects IMAP4 folders only, but IMAP4
6360 folders in mail boxes matching
6361 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6362 the number of unread messages on the server, even if they matches this
6363 variable. The initial setting is @code{t}.
6365 @item wl-auto-check-folder-name
6366 @vindex wl-auto-check-folder-name
6367 The initial setting is @code{nil}.
6368 If non-nil, the folder with the name of the value is checked for unread
6369 messages at the start.
6370 If it is @code{none}, no folders are checked.
6371 If it is a list, all folders in the list are checked at the start.
6373 @item wl-auto-uncheck-folder-list
6374 @vindex wl-auto-uncheck-folder-list
6375 The initial setting is the list shown below:
6384 Folders with the name matching this variable are not checked for unread
6385 messages at the start, even if they are included in the groups in
6386 @code{wl-auto-check-folder-name}.
6388 @item wl-auto-check-folder-list
6389 @vindex wl-auto-check-folder-list
6390 The initial setting is @code{nil}.
6391 Folders with the name matching this variable are always checked for
6392 unread messages at the start, if they are included in the groups in
6393 @code{wl-auto-check-folder-name}.
6394 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6396 @item wl-no-save-folder-list
6397 @vindex wl-no-save-folder-list
6398 The initial setting is the list shown below:
6407 This is a list of regular expressions of folders not to be saved.
6409 @item wl-save-folder-list
6410 @vindex wl-save-folder-list
6411 The initial setting is @code{nil}.
6412 This is a list of regular expressions of folders to be saved.
6413 This takes precedence over @code{wl-no-save-folder-list}.
6415 @item wl-folder-mime-charset-alist
6416 @vindex wl-folder-mime-charset-alist
6417 The initial setting is the alist shown below:
6421 (("^-alt\\.chinese" . big5)
6422 ("^-relcom\\." . koi8-r)
6424 ("^-han\\." . euc-kr))
6429 This is an associative list of regular expressions of folder names and
6431 If a folder do not match, @code{wl-mime-charset} is used.
6433 @item wl-folder-init-load-access-folders
6434 @vindex wl-folder-init-load-access-folders
6435 The initial setting is @code{nil}.
6436 This is a list of access groups to be loaded specifically at the start.
6437 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6439 @item wl-folder-init-no-load-access-folders
6440 @vindex wl-folder-init-no-load-access-folders
6441 The initial setting is @code{nil}.
6442 This is a list of access groups not to be loaded specifically at the
6444 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6446 @item wl-delete-folder-alist
6447 @vindex wl-delete-folder-alist
6448 The initial setting is the alist shown below:
6457 This list determines disposition of messages with delete marks.
6458 Each item in the list is a folder and destination; you can specify any
6459 one of the following in the place of destination:
6462 @code{remove} or @code{null} : deletes the messages instantly.
6463 string : moves the messages to the specific folder.
6464 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
6467 @item wl-refile-policy-alist
6468 @vindex wl-refile-policy-alist
6469 The initial setting is the list shown below:
6479 This list determines whether messages with re-file marks are moved or
6480 copied. Each item in the list is a cons cell of a folder and
6481 @code{copy} or @code{move}.
6483 @item wl-x-face-file
6484 @vindex wl-x-face-file
6485 The initial setting is @file{~/.xface}.
6486 The name of the file that contains encoded X-Face strings.
6489 @item wl-demo-display-logo
6490 @vindex wl-demo-display-logo
6491 If non-nil, bitmap image is shown on the opening demo. If you set
6492 @code{xpm} or @code{xbm}, (if possible) display selected image type
6495 @item elmo-use-database
6496 @vindex elmo-use-database
6497 This is meaningful for XEmacs only. The initial setting depends on
6498 XEmacs (@code{t} for XEmacs with dbm).
6499 If non-nil, Message-ID is controlled by dbm.
6501 @item elmo-passwd-alist-file-name
6502 @vindex elmo-passwd-alist-file-name
6503 The initial setting is @file{passwd}.
6504 This is the name of the file in which passwords are saved.
6505 @code{elmo-passwd-alist-save} saves current passwords to the file.
6507 @item elmo-nntp-list-folders-use-cache
6508 @vindex elmo-nntp-list-folders-use-cache
6509 The initial setting is 600 (in seconds).
6510 This is period in seconds during which results of @samp{list} and
6511 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6514 @item elmo-nntp-max-number-precedes-list-active
6515 @vindex elmo-nntp-max-number-precedes-list-active
6516 The initial setting is @code{nil}.
6517 If non-nil, the number of article obtained by @samp{list active} in NNTP
6518 are used as the maximum article number of the folder.
6519 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6520 and if the number of read messages is not correct.
6522 @item elmo-nntp-default-use-listgroup
6523 @vindex elmo-nntp-default-use-listgroup
6524 The initial setting is @code{t}.
6525 If non-nil, @samp{listgroup} is used for checking the total number of
6526 articles. If it is @code{nil}, @samp{group} is used. In the latter
6527 case, the processing will be a little faster at the sacrifice of
6530 @item elmo-pop3-send-command-synchronously
6531 @vindex elmo-pop3-send-command-synchronously
6532 The initial setting is @code{nil}.
6533 If non-nil, POP3 commands are issued synchronously. Some implementation
6534 of POP3 server fails to get summary information without this setting.
6535 You may have to set this variable to @code{t}, if the process hangs
6536 while looking up POP3.
6538 @item elmo-dop-flush-confirm
6539 @vindex elmo-dop-flush-confirm
6540 The initial setting is @code{t}.
6541 If non-nil, you are asked for confirmation if accumulated off-line
6542 operations are executed.
6544 @item elmo-display-progress-threshold
6545 @vindex elmo-display-progress-threshold
6546 The initial setting is 20.
6547 Threshold for display of progress gauge. If number of renewal is more than
6548 this value, display progress gauge.
6552 @node Hooks, , Customizable Variables, Customization
6558 @node Mailing List, Addition, Customization, Top
6559 @chapter Wanderlust Mailing List
6564 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6567 Topics related to Wanderlust are discussed in the mailing list.
6568 The latest version is also announced there (in Japanese, sorry).
6570 A guide can be obtained automatically by sending mail to
6571 @t{wl-ctl@@lists.airs.net} with the body
6576 Please send bug reports or patches to the mailing list. You can post to
6577 the mailing list even though you are not a member of it.
6579 If you send a bug report, please attach Backtrace with it.
6580 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
6583 I would like to express my thanks to the members of the mailing list for
6584 valuable advice and many pieces of code they contributed.
6587 @node Addition, Index, Mailing List, Top
6588 @chapter Additional Information
6590 @section Brief History
6593 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6594 3/10 Made a msgdb mechanism by elisp.
6595 3/26 IMAP and NNTP can be displayed in threads.
6596 4/13 Began to assemble thread display modules as elmo.
6597 5/01 Finished 0.1.0, initial version with many defects.
6598 6/12 I made a slip of the tongue and said I was writing elisp
6599 mailer supporting IMAP
6600 6/16 0.1.3 was announced at tm-ja, elisp ML.
6601 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6602 7/01 Support for mm-backend (0.3.0).
6603 8/25 multi folder added (0.5.0).
6604 8/28 filter folder added (0.5.1).
6605 9/10 You can open/close threads (0.6.0).
6606 9/11 fldmgr by Murata-san made editing folders easy.
6607 9/18 lha folders added by Okunishi-san (0.6.3).
6608 9/24 Display of branches of threads (0.6.5).
6609 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6610 10/28 Off-line operations (0.7.4).
6611 12/09 Becomes beta version.
6612 12/21 wl-expire by Murata-san.
6613 1999 2/03 auto-refile by Tsumura-san.
6614 4/28 wl-template by Murata-san.
6615 5/18 Released 1.0.0 stable.
6616 7/05 Scoring by Murata-san (2.1.0).
6617 9/26 New plugged system by Murata-san (2.2.2).
6618 12/20 Support Modified UTF7.
6619 2000 3/24 Released 1.1.0 stable.
6620 4/03 CVS development started.
6621 5/07 Thread restoration & Its speed up with Murata-san.
6622 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6623 7/11 killed message feature.
6624 7/18 Use UIDL in POP3.
6625 9/12 biff feature with Satata-san & Yamaoka-san.
6628 See @file{ChangeLog} for details.
6632 According to a dictionary, Wanderlust has the meaning:
6636 n eager longing for or impulse towards travelling in distant lands
6637 [Ger, fr wandern to wander + lust desire, pleasure]
6641 but I had no profound intention. (if farfetched, IMAP @result{} you can
6642 read mail anywhere @result{} desire to wander ?)
6644 Elmo is the abbreviation of @samp{Elisp Library for Message
6645 Orchestration}. At first I meant the red puppet in the Sesame Street,
6646 but you may associate it with Wandering @result{} Drifting @result{}
6647 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6651 Each versions has code names (they are almost jokes).
6652 Currently they are picked up alphabetically from the top 40 hits of
6653 U.S. Billboard magazines in 1980s.
6655 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
6658 @node Index, , Addition, Top
6662 * Concept Index:: Concept Index
6663 * Key Index:: Key Index
6664 * Variable Index:: Variable Index
6665 * Function Index:: Function Index
6668 @node Concept Index, Key Index, Index, Index
6669 @unnumberedsec Concept Index
6672 @node Key Index, Variable Index, Concept Index, Index
6673 @unnumberedsec Key Index
6676 @node Variable Index, Function Index, Key Index, Index
6677 @unnumberedsec Variable Index
6680 @node Function Index, , Variable Index, Index
6681 @unnumberedsec Function Index