1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
26 This edition is for Wanderlust version @value{VERSION}.
28 Permission is granted to make and distribute verbatim copies of this
29 manual provided the copyright notice and this permission notice are
30 preserved on all copies.
33 Permission is granted to process this file through TeX and print the
34 results, provided the printed document carries copying permission notice
35 identical to this one except for the removal of this paragraph (this
36 paragraph not being relevant to the printed manual).
39 Permission is granted to copy and distribute modified versions of this
40 manual under the conditions for verbatim copying, provided that the
41 entire resulting derived work is distributed under the terms of a
42 permission notice identical to this one.
44 Permission is granted to copy and distribute translations of this manual
45 into another language, under the above conditions for modified versions.
51 @title Wanderlust User's Manual
52 @subtitle Yet another message interface on Emacsen
53 @subtitle for Wanderlust version @value{VERSION}
54 @author Yuuichi Teranishi
55 @author Fujikazu Okunishi
56 @author Masahiro Murata
58 @author Kaoru Takahashi
60 @author Masayuki Osada
63 @vskip 0pt plus 1filll
64 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
65 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
66 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
68 This manual is for Wanderlust version @value{VERSION}.
70 Permission is granted to make and distribute verbatim copies of this
71 manual provided the copyright notice and this permission notice are
72 preserved on all copies.
74 Permission is granted to copy and distribute modified versions of this
75 manual under the conditions for verbatim copying, provided that the
76 entire resulting derived work is distributed under the terms of a
77 permission notice identical to this one.
79 Permission is granted to copy and distribute translations of this manual
80 into another language, under the above conditions for modified versions.
86 @node Top, Introduction, (dir), (dir)
87 @top Wanderlust User's Manual
99 This manual is for Wanderlust @value{VERSION}.
104 * Introduction:: Read this first.
105 * Start Me Up:: Invoking Wanderlust.
106 * Folders:: How to specify folders.
107 * Folder:: Selecting and editing folders.
108 * Summary:: Reading and refiling messages.
109 * Message:: Saving and playing MIME multipart entities.
110 * Draft:: Draft buffer, sending mail and news.
111 * Disconnected Operations:: Off-Line management
112 * Expire and Archive:: Automatic expiration and archiving of messages.
113 * Scoring:: Score of the messages.
114 * Address Book:: Management Address Book.
115 * Customization:: Customizing Wanderlust.
116 * Mailing List:: Wanderlust mailing list
117 * Addition:: Additional Information
122 @node Introduction, Start Me Up, Top, Top
123 @chapter Introduction of Wanderlust
126 Wanderlust is an mail/news management system on Emacsen.
127 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
129 The main features of Wanderlust:
132 @item Pure elisp implementation.
133 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
134 @item Unified access method to messages based on Mew-like Folder Specification.
135 @item Mew-like Key-bind and mark handling.
136 @item Manages unread messages.
137 @item Interactive thread display.
138 @item Folder Mode shows the list of subscribed folders.
139 @item Message Cache, Disconnected Operation (Read Only).
140 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
141 @item MIME compliant (by SEMI or tm).
142 @item Transmission of news and mail are unified by Message transmitting draft.
143 @item Graphical list of folders (XEmacs and Emacs 21).
144 @item View a part of message without retrieving the whole message (IMAP4).
145 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
146 @item Virtual Folders.
147 @item Supports compressed folder using common archiving utilities.
148 @item Old articles in folders are automatically removed/archived (Expiration).
149 @item Automatic re-file.
150 @item Template function makes it convenient to send fixed form messages.
156 Wanderlust is supposed to run on following Emacsen:
159 @item Mule 2.3 based on Emacs 19.34
160 @item Emacs 20.2 or later
161 @item XEmacs 20.4 or later
162 @item Meadow 1.00 or later
163 @item Mule for Windows v1.22
164 @item NTEmacs 20.4 or later
168 IMAP4 connectivity with following imapd are confirmed to work with
172 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
173 @item Cyrus imapd 1.4, 1.5.19, 1.6.22, 2.0.5 or later
174 @item AIR MAIL (AIRC imapd release 2.00)
176 @item Microsoft Exchange Server 5.5
177 @item Sun Internet Mail Server 4.0
180 @c LDAP connectivity with following LDAPd are confirmed to work with
184 @node Start Me Up, Folders, Introduction, Top
185 @chapter Start up Wanderlust
188 The necessary procedure for starting Wanderlust is explained in steps
191 (Of course, you need a mail/news readable environment in advance)
194 * MIME Modules:: Installing the MIME modules.
195 * Download:: Download and extract the packages.
196 * Install:: Byte-compile and install.
197 * Minimal Settings:: @file{.emacs} setup.
198 * Folder Definition:: Folder definition.
199 * Start Wanderlust:: Starting Wanderlust
203 @node MIME Modules, Download, Start Me Up, Start Me Up
204 @section Installing MIME modules
211 SEMI or tm must be installed to make Wanderlust work correctly.
213 SEMI does not run on Emacs 19.28 or earlier
214 @footnote{SEMI runs on Emacs 19.34. @*
215 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} describes how to.},
216 so you must install tm, the predecessor of SEMI. (tm version 8.7 or later
219 However, SEMI is recommended because of its wider functionality.
221 Refer to the documents of each package for detailed installation procedure.
223 SEMI and tm can be downloaded from these sites:
227 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
228 tm: http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
232 You need packages named APEL and FLIM to use SEMI.
233 You can download APEL and FLIM from following URLs:
237 APEL: ftp://ftp.m17n.org/pub/mule/apel/
238 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
242 You have to install APEL, FLIM and SEMI in this order. Generally,
243 @samp{make install} will do the job. (In XEmacs 21, @samp{make
246 Recommended combination of APEL, FLIM and SEMI are following:
249 @item APEL 10.3, FLIM 1.14.2 and SEMI 1.14.3
252 You can also use many other FLIM/SEMI variants. Combination of the
253 latest versions should work. For example, the following combination are
257 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
258 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
261 You have to re-install Wanderlust if you upgraded APEL, FLIM, SEMI or
265 @node Download, Install, MIME Modules, Start Me Up
266 @section Download and Extract the Package
269 You can download Wanderlust package from following sites:
273 ftp://ftp.gohome.org/wl/
276 Mirrored ftp/http sites:
280 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
281 http://www.jpl.org/elips/wl/
282 http://www.ring.gr.jp/archives/text/elisp/wl/
283 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
284 ftp://opaopa.org/pub/mirror/elisp/wl/
285 @c ftp://roguelife.org/pub/tsumura/wl/
289 Extract the obtained package to your working directory:
294 % tar zxvf wl-@var{version}.tar.gz
295 % cd wl-@var{version}
299 @subsection To use SSL (Secure Socket Layer)
304 SSL (Secure Socket Layer) can be used for
305 SMTP, IMAP, NNTP and POP connections in Wanderlust.
307 There are two ways to use SSL. One is to start SSL negotiation just
308 after the connection establishment (generic way). The other one is to
309 start SSL negotiation by invoking STARTTLS command in the each session.
311 To use the formal SSL (generic SSL), you must install @file{ssl.el} in
312 the @file{utils} directory. OpenSSL command @command{openssl} is also
313 required to use @file{ssl.el}. You must set @env{PATH} to the directory
314 that OpenSSL commands are installed.
316 To use the latter SSL(STARTTLS), you must install starttls package in
318 You can download starttls package from the following site.
321 ftp://opaopa.org/pub/elisp/
324 @node Install, Minimal Settings, Download, Start Me Up
325 @section Byte-compile and install
332 @subsection Installation
334 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
335 Set the Emacs's command name to @code{EMACS}.
336 Set package installation directory to @code{LISPDIR}.
337 Then, please execute following commands.
346 Destination directory is auto-probed if you leave @code{LISPDIR}
347 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
349 If you are using an Emacs variant which does not merge specified directory
350 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
351 then you will see the error message:
354 Cannot open load file: mime-setup
358 In this case, either add destination directories of custom, APEL, FLIM
359 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
360 @code{load-path} in @file{WL-CFG} in extracted directory.
362 If you want to use BBDB, then the necessary modules are byte-compiled
363 and installed when BBDB directory is added to @code{load-path}.
366 @subsection @file{WL-CFG}
368 Contents of the file @file{WL-CFG} is loaded under installation if a file
369 with that name exists in extracted directory. You can use @file{WL-CFG} to
370 configure @code{load-path} to extra packages such as SEMI if needed.
372 If you want to specify the install directory of Wanderlust related
373 files, then set following variables in @file{WL-CFG}
377 A directory to install WL modules.
378 This directory is relative directory from @code{LISPDIR}.
379 WL modules include @file{wl*.el}, @file{wl*.elc} files.
380 @c Modules under the directory @file{util/} are also installed if
381 @c it detected as necessary.
384 A directory to install ELMO modules.
385 This directory is relative directory from @code{LISPDIR}.
386 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
387 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
391 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
393 If you want to install ELMO related files under a sub-directory
394 such as "elmo" then add following to @file{WL-CFG}:
397 (setq ELMO_PREFIX "elmo")
400 @subsection Install as a XEmacs package
401 @cindex XEmacs package
402 @cindex XEmacs package install
403 @cindex Package, XEmacs
404 @cindex Package install, XEmacs
405 @c @cindex install-package
407 It is possible to install Wanderlust as one of packages of XEmacs (21.0
408 or later). Configuration for autoload and icon-path in local
409 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
412 Follow the next example to install Wanderlust as an XEmacs package.
418 % make install-package
422 package directory is auto-probed, if SEMI is installed.
423 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
425 @subsection Run in place
427 If wl and elmo directories are defined in @code{load-path}, then
428 byte-compilation and installation are not necessary to start Wanderlust.
429 For example, if package is extracted in @file{~/work}, Wanderlust can be
430 invoked with following setting in @file{~/.emacs}.
434 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
435 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
441 Manual is described in Info format. Please do following.
450 If you install Wanderlust as a XEmacs package, Info file is already
451 installed too, so there are no need of these commands.
453 Manual directory is automatically detected. Of course, it can be
454 configured by @code{INFODIR} in @file{Makefile}.
456 You can read manual at the following URL:
459 http://www.gohome.org/wl/doc/wl-euc_toc.html
462 @node Minimal Settings, Folder Definition, Install, Start Me Up
463 @section Set up .emacs
464 @cindex Minimal Settings
466 @cindex Configuration
470 The Wanderlust package contains two module groups.
473 @item ELMO (elmo-*.el)
474 These modules show everything as folders. This is the back-end for WL.
476 These modules controls the behavior of main body of Wanderlust.
477 They are also the front-end for ELMO.
480 You can customize the behavior of Wanderlust by changing the value
481 of environmental variables which begins with @code{elmo-} and @code{wl-}.
483 The minimal requirement for settings is as the following.
487 ;; @r{The setting to use SEMI/tm}
490 ;; @r{autoload configuration}
491 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
492 (autoload 'wl "wl" "Wanderlust" t)
493 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
495 ;; @r{Directory where icons are placed (XEmacs or Emacs 21).}
496 ;; @r{Default: @code{nil}.}
497 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
498 (setq wl-icon-dir "~/work/wl/etc")
500 ;; @r{SMTP server for mail posting. Default: @code{nil}}
501 (setq wl-smtp-posting-server "your.smtp.example.com")
502 ;; @r{NNTP server for news posting. Default: @code{nil}}
503 (setq wl-nntp-posting-server "your.nntp.example.com")
507 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
508 file exists). So it is convenient to gather Wanderlust specific settings
509 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
510 because you can't write them in @file{.emacs}
511 (if you write it to @file{.emacs}, you'll get an error).
514 All above described settings except (load "mime-setup") and autoload
515 configuration can be written in
518 @subsection @code{mail-user-agent}
519 @cindex Default Mailer
520 @cindex Mailer, Default
521 @vindex mail-user-agent
524 If you write following setting in you @file{.emacs}, you can
525 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
526 This means it enables you to run Wanderlust as a default mail composer
529 It is effective only when your Emacs can define @code{mail-user-agent}.
530 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
534 (autoload 'wl-user-agent-compose "wl-draft" nil t)
535 (if (boundp 'mail-user-agent)
536 (setq mail-user-agent 'wl-user-agent))
537 (if (fboundp 'define-mail-user-agent)
538 (define-mail-user-agent
540 'wl-user-agent-compose
549 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
550 @section Folder Definition
551 @cindex Folder Definition
554 You can skip this section because it is possible to add/edit the
555 subscribe folders from the buffer for list of folders.
556 @xref{Folder Manager}.
558 Define the folders you want to subscribe in file @file{~/.folders}. The
559 contents written in @file{~/.folders} become the folders which you
560 subscribe to as it is.
562 Format for @file{~/.folders} is very simple. Here is an example:
567 # @r{Lines begin with @samp{#} are comment.}
568 # @r{Empty lines are ignored}
570 # @var{folder name} "@var{folder nickname}"
571 # @r{(nicknames are not necessary)}
576 %#mh/Backup@@my.imap.example.com "Sent"
579 %#mh/spool/wl "Wanderlust ML"
580 %#mh/spool/elips "ELIPS ML"
581 %#mh/spool/apel-ja "APEL Japanese ML"
582 %#mh/spool/xemacs-beta "XEmacs beta"
583 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
584 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
587 # @r{If folder name ends with @samp{/}, that means an `access group',}
588 # @r{all subfolders automatically included in one folder group.}
590 %#mh/expire@@localhost /
591 # @r{All MH folders are included in one folder group.}
596 Each line contains one folder you want to read. The definition of
597 folders will be explained in detail in the next section.
599 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
600 become one folder group. One folder group is treated as a directory
601 which can bed opened and closed in folder mode. It is convenient for
602 collecting some folders and putting them in order.
604 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
605 line and you have to write it that way (It is because the parser sucks).
607 There are two types of groups. One is like @samp{Emacsen} from above
608 example which the user chooses his favorite folders as a group.
610 The other one is @dfn{access group} like @samp{+} from above example.
611 It makes all the sub-folders in a folder to a group. (It differs from
612 the type of the folder. For example, @samp{+} makes entire MH
613 sub-directories to one group)
615 This behavior is better understood if you try it and confirmed the
616 function first. You can write and try a small folder definition, so you
617 will know the idea of the folder function before writing the real one.
619 @node Start Wanderlust, , Folder Definition, Start Me Up
620 @section Start Wanderlust
621 @cindex Start Wanderlust
623 If installation and configuration worked well, you can invoke Wanderlust by
624 typing following command in Emacs.
631 After initialization, Folder Mode which shows the list of folders will appear.
632 That means the folders you defined in the @file{~/.folders} are listed
633 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
634 can skip folder checking.
637 @node Folders, Folder, Start Me Up, Top
638 @chapter Wanderlust's folders
641 This chapter describes the folder types which Wanderlust is able to handle.
643 Wanderlust uses ELMO as it's interface, so every folder types supported
644 by ELMO is usable in Wanderlust.
646 As of version @value{VERSION}, 11 types of folders are predefined. These are
647 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
648 Pipe and Internal folder types.
651 * IMAP Folder:: @samp{%} -- IMAP folder
652 * NNTP Folder:: @samp{-} -- NNTP folder
653 * MH Folder:: @samp{+} -- MH folder
654 * Maildir Folder:: @samp{.} -- Maildir folder
655 * News Spool Folder:: @samp{=} -- News spool folder
656 * Archive Folder:: @samp{$} -- Archive folder
657 * POP Folder:: @samp{&} -- POP folder
658 * Multi Folder:: @samp{*} -- Multi folder
659 * Filter Folder:: @samp{/} -- Filter folder
660 * Pipe Folder:: @samp{|} -- Pipe folder
661 * Internal Folder:: @samp{'} -- Internal folder
665 @node IMAP Folder, NNTP Folder, Folders, Folders
672 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
678 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
682 You can specify @code{login} (encoded password transmission),
683 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
684 authentication) or @code{clear} (or @code{nil}, plain password
685 transmission) as @var{authenticate-type}. (To use CRAM-MD5 or
686 DIGEST-MD5 authentication, you must install @file{utils/sasl} package if FLIM version is earlier than 1.14.0. If FLIM version is 1.14.0 or later, you need not install @file{utils/sasl})
691 @var{username} -> The value of @code{elmo-default-imap4-user}.
692 Initial setting is @env{USER} environment variable or
693 @env{LOGNAME} environment variable or return value of
694 @code{(user-login-name)}.
695 @var{authenticate-type} -> The value of @code{elmo-default-imap4-authenticate-type}.
696 Initial setting is "auth".
697 @var{hostname} -> The value of @code{elmo-default-imap4-server}.
698 Initial setting is "localhost".
699 @var{port} -> The value of @code{elmo-default-imap4-port}.
700 Initial setting is 143.
703 You can omit the @var{hostname} from folder names if you set
704 @code{elmo-default-imap4-server} as your main IMAP server.
705 For example, you can specify a folder as @samp{foo%imap@@gateway} even
706 if you have to go through a firewall.
709 ;; Example: imap4.exaple.org as main IMAP server
710 (setq elmo-default-imap4-server "imap4.example.org")
713 SSL (Secure Socket Layer) connection will be used if a folder name ends
714 with @samp{!}. Or, if the value of @code{elmo-default-imap4-stream-type}
715 is @code{ssl}, SSL will be the default connection. If a folder name
716 ends with @samp{!!}, STARTTLS connection will be established. If the
717 value of @code{elmo-default-imap4-stream-type} is @code{starttls},
718 STARTTLS will be the default connection.
721 ;; Example: Use SSL connection
722 (setq elmo-default-imap4-stream-type 'ssl)
725 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
726 authentication method, the password is sent in encoded form. But, if
727 your server is unable to receive an encoded password, authentication
728 will fall back to @code{clear} (that is, sending password in raw format)
729 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
730 authentication will fall back to @code{clear} without confirmation
731 (default value is @code{nil}).
734 ;; Example: password in raw format
735 (setq elmo-default-imap4-authenticate-type 'clear)
742 %inbox -> IMAP mailbox "inbox"
743 %#mh/inbox -> IMAP mailbox "#mh/inbox"
745 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
746 %inbox:hoge/clear@@server1
747 -> server1's IMAP mailbox "inbox"
748 of user "hoge", with plain password authentication
753 @subsection International mailbox names (Modified UTF7)
754 @cindex Modified UTF7
761 You can use international mailbox names in @var{mailbox} part, if you
762 are using Emacs which can treat unicode and
763 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
764 value is @code{nil}).
766 Currently, following Emacsen can treat unicode.
769 @item Emacs 20.3 or later + Mule-UCS
771 If you installed Mule-UCS package, Emacs can treat unicode.
772 You can obtain Mule-UCS package from following URL.
775 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
778 @item XEmacs 21.2.13 or later + ucs-conv package
780 By default, XEmacs 21 cannot treat unicodes, but if you installed
781 ucs-conv package, it can.
782 You can obtain ucs-conv package from following anonymous CVS.
786 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
787 Password: @var{NULL} (Just enter return key)
788 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
792 You also need utf7 conversion programs, @command{u7tou8} and
793 @command{u8tou7} to use international mailbox name in the current
794 XEmacs. These programs are included in the UTF7 package which can be
795 obtained from following URL.
798 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
802 @node NNTP Folder, MH Folder, IMAP Folder, Folders
807 A folder to access USENET news via NNTP protocol (RFC 977).
808 One newsgroup is treated as a folder.
814 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
820 @var{hostname} -> The value of @code{elmo-default-nntp-server}.
821 Initial setting is @samp{localhost}.
822 @var{username} -> The value of @code{elmo-default-nntp-user}.
823 Initial setting is @code{nil}.
824 @var{port} -> The value of @code{elmo-default-nntp-port}.
825 Initial setting is 119.
828 AUTHINFO is used as authentication method if the @var{username} is non-nil.
829 SSL will be default method if @code{elmo-default-nntp-stream-type} is non-nil even
830 if the folder name doesn't end with @samp{!}.
831 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
832 if the value of @code{elmo-default-nntp-stream-type} is @code{starttls},
833 STARTTLS will be the default connection.
839 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
840 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
844 @node MH Folder, Maildir Folder, NNTP Folder, Folders
850 A folder to access MH format mail (1 file is 1 mail).
855 @samp{+} @var{directory-name}
858 Normally, @var{directory-name} is an relative path to the variable
859 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
860 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
861 (this is also true for drive-letters).
863 Message number is used for the name of the message file.
869 +inbox -> @file{~/Mail/inbox}
870 +from/teranisi -> @file{~/Mail/from/teranisi}
871 +~/test -> @file{~/test}
875 @node Maildir Folder, News Spool Folder, MH Folder, Folders
876 @section Maildir Folder
877 @cindex Maildir Folder
881 A folder to access to Maildir format (1 file is 1 mail).
886 @samp{.} [@var{directory-name}]
889 Normally, @var{directory-name} is a relative path to the variable
890 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
891 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
892 (this is also true for drive-letters).
894 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
895 Messages are contained in the @file{cur} directory. All message files
896 in the @file{new} directory are moved to @file{cur} directory when you
897 access to the folder. All message files contained in the @file{tmp}
898 directory and not accessed for 36 hours are deleted.
900 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
906 . -> @file{~/Maildir}
907 .inbox -> @file{~/Maildir/inbox}
908 .from/teranisi -> @file{~/Maildir/from/teranisi}
909 .~/test -> @file{~/test}
914 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
915 @section News Spool Folder
916 @cindex News spool Folder
920 This folder handles locally saved news articles which are proposed by
921 Mew/IM. You can also read articles directly from a spool-file which is
922 retrieved by an utility like @command{gnspool}.
927 @samp{=} @var{directory-name}
930 @var{directory-name} is a sub-directory to the directory defined by
931 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
932 You can use @samp{.} as directory delimiter as well as @samp{/}.
938 =fj/os/os2 -> @file{~/News/fj/os/os2}
939 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
944 @node Archive Folder, POP Folder, News Spool Folder, Folders
945 @section Archive Folder
946 @cindex Archive Folder
950 This method can handle archive files, which are compressed by utilities
951 such as Info-ZIP or LHA, as one folder.
957 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
961 @var{path-name} is the relative path from
962 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
963 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
964 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
965 also permitted under the environment of ange-ftp, efs.
967 The actual file name of the archive folder is
968 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
969 under the @var{path-name}. If a file named @var{path-name} exists, it is
970 treated as folder. The suffix is automatically decided for
973 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
974 (Initial setting is @code{zip}) is referred.
976 @var{prefix} specifies the internal directory structure of the archive.
977 For example, if the ML server is fml, @file{msend.tar.gz} has a
978 structure like @file{spool/1}, so you have to specify @samp{spool} as
985 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
986 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
987 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
988 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
993 * Archiver:: Archivers supported
994 * Archive Tips:: TIPS
995 * Archive Vars:: Customization
999 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1000 @subsection Supported Archives
1010 By default, following archives are supported.
1014 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1015 GNU TAR('tgz, 'tar) ;; read-only
1019 If your archiver can include multiple files in one archive, you have a
1020 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1021 of the candidate. TAR is supported read-only because it cannot delete
1022 file in the archive (@code{mv})).
1024 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1025 archiver of Wanderlust because they cannot include multiple
1026 files. Archivers that cannot extract files to standard output are also
1029 @subsection OS specific information about archiver.
1031 Behaviors of the following archivers are confirmed by further experiences.
1032 (@samp{*} mark means recommended archiver).
1035 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1036 LHA OS/2 version Rel.2.06b Feb 18, 1998
1037 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1038 *Zip 2.2 (November 3rd 1997).
1039 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1040 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1041 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1043 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1044 LHa for UNIX V 1.14c
1045 UnZip 5.32 of 3 November 1997
1046 Zip 2.2 (November 3rd 1997)
1047 GNU tar 1.12 (1.11.x is no good)
1048 gzip 1.2.4 (18 Aug 93)
1050 [Win32] Win.98/Meadow
1054 GNU tar 1.11.8 + 1.5(WIN32)
1061 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1062 Hiramatsu version of LHA is only supported.
1063 In Win32, LHa32 is only supported (DOS version is no good).
1065 * Caution about GNU tar
1067 You have to take care about GNU tar's version because many version has
1068 problem on deleting file from archive.
1070 Please test @option{--delete} @option{-f} options work. Otherwise, your
1071 archive will be destroyed. No problem is reported on above versions of
1075 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1077 @cindex Archive Tips
1079 For comfortable migration, usage of @code{wl-summary-archive}
1080 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1081 archive folders created by expiration, you must set non-nil value to
1082 @code{elmo-archive-treat-file}.
1084 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1085 in processing speed. For comfortable use, Emacs20 is recommended.
1086 (If re-search's performance is the problem, 19.3x or later may be okay.)
1088 If many files are included in one archive,
1089 it takes long time to access to the archive folder because
1090 archiver starting overhead is increased (especially LHA).
1091 150-200 messages in one archive is recommended.
1093 Of course, following is possible @t{:-)}
1094 (meanings of these variables are described later.)
1098 (setq wl-fcc "$backup")
1099 (setq wl-trash-folder "$trash;lha")
1103 @node Archive Vars, , Archive Tips, Archive Folder
1104 @subsection Variables About Archive Folder
1105 @cindex Archive variables
1108 @item elmo-archive-default-type
1109 @vindex elmo-archive-default-type
1110 The initial setting is @code{zip}.
1111 Set archiver type by symbol.
1113 @item elmo-archive-@var{type}-method-alist
1114 @vindex elmo-archive-TYPE-method-alist
1115 Define archiver @var{type}'s methods.
1116 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1117 Each element of the alist is following.
1121 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1122 (@var{action} . @var{function}) ;; function
1126 Currently available actions are following.
1130 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1131 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1138 actions enclosed with braces are optional (They are used for better
1141 @item elmo-archive-suffix-alist
1142 @vindex elmo-archive-suffix-alist
1143 An alist of archiver-type (symbol) and suffix.
1145 @item elmo-archive-file-regexp-alist
1146 @vindex elmo-archive-file-regexp-alist
1147 An alist of a regexp to get file number from list output of archiver
1148 and archiver-type (symbol).
1150 @item elmo-archive-method-list
1151 @vindex elmo-archive-method-list
1152 A list of elmo-archive-@var{type}-method-alist
1153 (@var{type} is a symbol of archiver-type).
1155 @item elmo-archive-lha-dos-compatible
1156 @vindex elmo-archive-lha-dos-compatible
1157 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1158 DOS (Mr. Yoshizaki original) compatible.
1160 @item elmo-archive-cmdstr-max-length
1161 @vindex elmo-archive-cmdstr-max-length
1162 The initial setting is 8000.
1164 Max length of command line argument for external archiver program.
1165 Emacs does not have a limit of command line byte length, but some OS
1166 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1167 this limit because it calls external archiver program directly (not
1168 called via shell). For example, you cannot delete messages if archiver
1169 program must receive larger bytes of arguments to delete. OS/2 have a
1170 command line argument limit of 8190 bytes, so we defined default as 8000
1173 However, you don't have an influence of command line argument limit
1174 if the archiver has `actions' to receive target file information from
1175 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1178 @node POP Folder, Multi Folder, Archive Folder, Folders
1186 A folder to access e-mails via POP3 protocol (RFC 1939).
1192 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1197 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1198 as @var{authenticate-type}.
1202 @var{username} -> The value of @code{elmo-default-pop3-user}.
1203 Initial setting is @env{USER} environment variable or
1204 @env{LOGNAME} environment variable or return value of
1205 @code{(user-login-name)}.
1206 @var{authenticate-type} -> The value of @code{elmo-default-pop3-authenticate-type}.
1207 Initial setting is @samp{user}.
1208 @var{hostname} -> The value of @code{elmo-default-pop3-server}.
1209 Initial setting is @samp{localhost}.
1210 @var{port} -> The value of @code{elmo-default-pop3-port}.
1211 Initial setting is 110.
1218 &hoge@@localhost -> access to localhost as user @samp{hoge}.
1219 &hoge@@popserver:109 -> access to the server "popserver" on port 109
1220 as user @samp{hoge}.
1224 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1225 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1226 @file{utils/sasl/lisp/} or Emacs/W3 package
1227 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1230 If the last character of the folder name is @samp{!}, Wanderlust
1231 connects to the POP server via SSL (Secure Socket Layer). If you set
1232 non-nil value to @code{elmo-default-pop3-stream-type}, you don't have to put
1233 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1234 with @samp{!!}, STARTTLS connection will be established. if the value
1235 of @code{elmo-default-pop3-stream-type} is @code{starttls}, STARTTLS will be the
1238 @node Multi Folder, Filter Folder, POP Folder, Folders
1239 @section Multi Folder
1240 @cindex Multi Folder
1242 @cindex Folder, Multiple
1243 @cindex Folder, Marge
1245 A folder to access to a folder which collects messages from
1246 multiple folders virtually.
1252 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1256 After @samp{*} character, specify multiple folders you want to collect
1257 separated by @samp{,} like
1258 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1264 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1265 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1266 treated as one folder.
1268 *+inbox,-fj.rec.tv,%inbox
1269 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1274 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1275 @section Filter Folder
1276 @cindex Filter Folder
1278 @cindex Folder, Filtering
1279 @cindex Folder, Virtual
1281 A folder to access to a folder which collects all messages that
1282 satisfy a condition virtually.
1287 @samp{/} @var{condition} @samp{/} @var{target-folder}
1290 In the @var{condition} part, you can specify following.
1294 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1296 first: @var{number} messages are picked from top of folder.
1297 last: @var{number} messages are picked from bottom of folder.
1303 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1304 /first:20/%inbox -> First 20 messages from %inbox are picked.
1309 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1311 since: only messages arrived since @var{date} are picked.
1312 before: only messages arrived before @var{date} are picked.
1314 You can specify following as @var{date}.
1318 yesterday -> a day before today.
1319 lastweek -> same day of last week.
1320 lastmonth -> same day of last month.
1321 lastyear -> same day of last year.
1322 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1323 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1331 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1333 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1339 Field filter: @samp{@var{field}:@var{value}}
1341 All messages that have @var{field} and its value is @var{value} are picked.
1342 @var{field} and @var{value} are case insensitive.
1348 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1349 and its value includes "teranisi" string are picked.
1350 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1358 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1359 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1361 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1362 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1368 /from:teranisi&!to:teranisi/+inbox
1369 -> In +inbox, messages are picked if the message's
1370 From: field includes "teranisi" and
1371 To: field doesn't include "teranisi".
1373 /tocc:"Yuuichi Teranishi"/+inbox
1374 -> In +inbox, messages are picked if the
1375 message's To: field or Cc: field includes
1376 "Yuuichi Teranishi".
1378 /(from:yt|from:teranisi)&subject:report/+inbox
1379 -> In +inbox, messages are picked if the message's
1380 From: field includes "yt" or "teranisi", and
1381 Subject includes "report".
1387 Tip for string description:
1389 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1390 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1391 should be escaped with @samp{\} in it). You can enclose the string with
1392 @samp{"} even it does not contain these characters.
1398 *%inbox,/from:teranisi/%inbox@@server
1399 -> Messages in %inbox or
1400 message is in the %inbox@@server folder and it's From field
1401 includes "teranisi" are collected.
1403 /last:100//to:teranisi/*+inbox,%inbox
1404 -> Latest 100 messages which is in the +inbox or %inbox folder
1405 and To: field matches "teranisi".
1407 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1408 -> Pick messages which have From: field and it includes "hogehoge"
1409 from latest 20 messages in the %#mh/inbox@@localhost
1410 and To: or Cc: field includes "teranisi".
1413 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1414 @section Pipe Folder
1418 @cindex Download Message
1419 @cindex Incorporate Message
1421 In the pipe folder, messages are automatically transferred from the source
1422 folder to destination folder.
1427 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1430 When you access to the pipe folder, messages are automatically transferred
1431 from @var{source-folder} to @var{destination-folder}.
1432 It is convenient if you want to download messages to local disk via POP.
1433 For example, if you specify following
1436 |&username@@popserver|+inbox
1440 and access to it, messages are downloaded automatically from
1441 @samp{&username@@popserver} to @samp{+inbox}.
1447 %inbox|%myinbox -> Download %inbox to %myinbox.
1448 *&user@@popserver1,&user@@popserver2|+inbox
1449 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1453 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1455 @node Internal Folder, , Pipe Folder, Folders
1456 @section Internal folder
1457 @cindex Internal Folder
1459 @cindex Folder, @samp{$} mark
1461 A folder to access to internal messages of Wanderlust.
1473 A folder named @samp{'mark} is a special virtual folder which collects
1474 messages which have important mark @samp{$}.
1476 You can review important messages at once after you put important marks
1477 on the messages in the different folders.
1479 In this folder, if you delete message, important mark @samp{$} put on
1480 the message is removed. If you append messages to this folder, the
1481 message will have @samp{$} mark.
1483 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1484 folder. If you want IMAP folder's message remove from @samp{'mark}
1485 folder, remove important mark at IMAP Folder.)
1487 You can access to the cached messages fetched via network by accessing
1488 to the folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1489 the name of the subdirectories of the cache directory
1490 (@file{~/.elmo/cache}).
1493 @node Folder, Summary, Folders, Top
1494 @chapter Folder mode
1497 After you start Wanderlust, folder mode is appeared firstly.
1498 It contains folder list you subscribed.
1499 You can select and edit folders in this mode.
1502 * Selecting Folder:: Select folder you want to read.
1503 * Folder Manager:: Editing folders.
1507 @node Selecting Folder, Folder Manager, Folder, Folder
1508 @section Selecting Folder
1509 @cindex Selecting Folder
1511 @subsection Usage (TIPS)
1513 @subsubsection Check new, unread number
1515 Folder mode looks like this.
1516 (In XEmacs, it looks much nicer @t{;-)})
1520 [-]Desktop:14186/35580/67263
1525 [-]Emacsen:0/34/4837
1526 Wanderlust ML:0/0/558
1529 XEmacs Beta:0/29/255
1540 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1544 @kbd{s} key on the folder line updates these numbers.
1545 It changes its color if it has many new messages.
1547 The whole folder mode is a folder group named @samp{Desktop}.
1548 Folder group open/close by return key.
1549 A operation to a folder group is treated as operations on the
1551 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1552 six children folders update its unread number status.
1554 @subsubsection Select Folder
1556 To enter summary mode of the folder, type return (or space) key on
1558 If the variable @code{wl-stay-folder-window} has non-nil value,
1559 summary window appears on the right of the folder mode window.
1561 @subsection Key bindings
1563 Folder mode's key binding (related to selecting folders) is following.
1568 @kindex @key{SPC} (Folder)
1569 @kindex @key{RET} (Folder)
1570 @findex wl-folder-jump-to-current-entity
1571 Enter to the summary mode of the folder at the current cursor point.
1572 If the cursor is on the top of folder group line,
1573 the folder group is opened or closed.
1574 When the cursor is on the access group and this command is called
1575 with prefix argument, folder children list is updated to the newest one.
1576 (Children list is updated recursively if the access folder has hierarchical
1578 (@code{wl-folder-jump-to-current-entity})
1581 @kindex M-@key{RET} (Folder)
1582 @findex wl-folder-update-recursive-current-entity
1583 Folder children list of the access group at the current cursor point
1584 is updated to the newest one.
1585 (Children list is updated recursively if the access folder has hierarchical
1587 (@code{wl-folder-update-recursive-current-entity})
1592 Create a new draft message.
1597 @findex wl-folder-write-current-folder
1598 If the current cursor point is on the NNTP folder, create a new draft
1599 message which already has @samp{Newsgroups:} field. If the current
1600 cursor point is on the folder for mailing list (refile destination),
1601 create a new draft message which already has @samp{To:} field with
1602 guessed mailing list adderss (If @code{wl-subscribed-mailing-list} is
1604 (@code{wl-folder-write-current-folder})
1607 @kindex C-c C-o (Folder)
1608 @findex wl-jump-to-draft-buffer
1609 Move to the draft buffer if available. If multiple draft buffer exists,
1610 moved to one after another. If prefix argument is specified, load draft
1611 folder's message to the draft buffer and jump to it.
1612 (@code{wl-jump-to-draft-buffer})
1616 @findex wl-folder-check-current-entity
1617 Update new and unread number information of the folder at the current
1619 (@code{wl-folder-check-current-entity})
1623 @findex wl-folder-sync-current-entity
1624 Update summary information of the folder at the current cursor point.
1625 (@code{wl-folder-sync-current-entity})
1628 @kindex r s (Folder)
1629 @findex wl-folder-check-region
1630 Update new and unread number information of the folders in the currently
1632 (@code{wl-folder-check-region})
1635 @kindex r S (Folder)
1636 @findex wl-folder-sync-region
1637 Update summary information of the folders in the currently selected region.
1638 (@code{wl-folder-sync-region})
1642 @findex wl-status-update
1643 Sync up address book status with @file{~/.addresses}'s content.
1644 (@code{wl-status-update})
1648 @findex wl-folder-prev-unread
1649 Jump cursor to the folder which have unread messages on the upward from
1650 current cursor point.
1651 (@code{wl-folder-prev-unread})
1655 Jump cursor to the folder which have unread messages on the downward
1656 from current cursor point.
1657 (@code{wl-folder-next-unread})
1661 Move cursor to the folder on the previous line.
1662 (@code{wl-folder-prev-entity})
1666 Move cursor to the folder on the next line.
1667 (@code{wl-folder-next-entity})
1671 Jump to the folder specified by the user input.
1672 (@code{wl-folder-jump-folder})
1676 @findex wl-folder-prefetch-current-entity
1677 Prefetch new messages of the folder at the current cursor point by
1678 @code{wl-summary-incorporate}.
1679 If the cursor is on the folder group, it is executed recursively.
1680 (@code{wl-folder-prefetch-current-entity})
1684 @findex wl-folder-mark-as-read-all-current-entity
1685 Mark all unread messages of the folder at the current cursor point as read.
1686 If the cursor is on the folder group, it is executed recursively.
1687 (@code{wl-folder-mark-as-read-all-current-entity})
1691 @findex wl-folder-goto-first-unread-folder
1692 Enter summary mode of the first unread folder.
1693 (@code{wl-folder-goto-first-unread-folder})
1697 @findex wl-folder-empty-trash
1699 (@code{wl-folder-empty-trash})
1703 @findex wl-folder-open-all-unread-folder
1704 All unread folder is opened.
1705 (@code{wl-folder-open-all-unread-folder})
1709 @findex wl-folder-open-close
1710 Folder group is opened/closed.
1711 (@code{wl-thread-open-close})
1715 All folder group is opened.
1716 (@code{wl-folder-open-all})
1720 All folder group is closed.
1721 (@code{wl-folder-close-all})
1731 (@code{wl-folder-suspend})
1734 @kindex M-s (Folder)
1735 Save current folder status.
1739 @kindex M-t (Folder)
1740 Toggle Wanderlust's offline/online status.
1741 (@code{wl-toggle-plugged})
1744 @kindex C-t (Folder)
1745 Start Wanderlust's plug-status manager.
1746 (@code{wl-plugged-change})
1749 @subsection Customize variables
1752 @item wl-folders-file
1753 @vindex wl-folders-file
1754 The initial setting is @file{~/.folders}.
1755 Subscribed folders are described (saved) in this file.
1757 @item wl-folder-info-save
1758 @vindex wl-folder-info-save
1759 The initial setting is @code{t}. If non-nil, unread information is
1760 saved and used in the next Wanderlust session.
1762 @item wl-stay-folder-window
1763 @vindex wl-stay-folder-window
1764 The initial setting is @code{nil}.
1765 If non-nil, summary window is appeared on the right side of the folder buffer.
1767 @item wl-folder-window-width
1768 @vindex wl-folder-window-width
1769 The initial setting is 20.
1770 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1772 @item wl-folder-many-unsync-threshold
1773 @vindex wl-folder-many-unsync-threshold
1774 The initial setting is 70.
1775 If the number of unread messages is more than this value,
1776 folder color is changed.
1778 @item wl-highlight-folder-by-numbers
1779 @vindex wl-highlight-folder-by-numbers
1780 This option controls how to highlight each line in the folder buffer.
1781 The default value is @code{t}, highlighting with various colors based on
1782 the message numbers. If it is @code{nil}, highlighting with various
1783 colors based on the folder status. In addition, if it is a number
1784 (e.g. 1), highlighting will be done based on both the message numbers
1785 and the folder status.
1787 @item wl-folder-desktop-name
1788 @vindex wl-folder-desktop-name
1789 The initial setting is @samp{Desktop}.
1790 The name of top folder group.
1792 @item wl-folder-petname-alist
1793 @vindex wl-folder-petname-alist
1794 The initial setting is @code{nil}.
1795 An alist of folder's realname and its nickname.
1797 @item wl-folder-access-subscribe-alist
1798 @vindex wl-folder-access-subscribe-alist
1799 The initial setting is @code{nil}.
1801 Control automatic subscribing and unsubscribing of the children list
1807 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1811 If @var{subscribe-flag} is non-nil, folders which have name matched to
1812 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1813 already unsubscribed folder is not displayed even when the
1814 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1821 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1822 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1823 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1824 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1828 @item wl-folder-hierarchy-access-folders
1829 @vindex wl-folder-hierarchy-access-folders
1830 The initial setting is the list shown below:
1839 A list of access groups which creates children folder list hierarchically.
1841 For example, if you specify
1842 @code{wl-folder-hierarchy-access-folders} like following,
1846 (setq wl-folder-hierarchy-access-folders
1847 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1852 such access group hierarchy is obtained.
1858 -fj.comp.announce:0/0/2
1859 -fj.comp.dev.cdrom:0/0/0
1861 [+]-japan:238/238/1688
1864 -comp.unix.admin:0/0/0
1865 -comp.unix.dos-under-unix:0/0/0
1866 -comp.unix.programmer:0/0/0
1867 [-]-comp.unix.bsd:0/0/23
1868 -comp.unix.bsd.freebsd.announce:0/0/0
1873 If you opened @samp{-} in this example, only the direct children is created
1874 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1875 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1876 is not created until the children access group is opened.
1880 @node Folder Manager, , Selecting Folder, Folder
1881 @section Editing Folders
1882 @cindex Folder Manager
1883 @cindex Folder, Edit
1884 @cindex Folder, Subscribe
1885 @cindex Folder, Unsubscribe
1887 As described before, subscribed folder list is saved in @file{~/.folders} file.
1888 But you don't have to edit @file{~/.folders} directly.
1889 You can append, delete, edit folders from folder mode.
1891 @subsection Usage (Tips)
1893 @subsubsection Append Folder
1895 @kbd{m a} appends new folder to the folder mode.
1896 @kbd{m g} appends new folder group.
1897 To append new folder to this group, firstly open it,
1898 then execute append command in the next line.
1900 @subsubsection Edit Folder
1902 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1903 Thus, you can change folder position as if you were editing a normal file.
1905 @subsubsection Create Multi Folder.
1909 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
1911 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
1913 Type @kbd{m m}, then you can create multi folder.
1916 @subsubsection Delete Nickname, Filter
1918 You can delete nickname or filter by putting ``''(@var{NULL}) from the
1919 minibuffer while appending.
1921 @subsubsection Append Folder to Empty Group
1923 To append new folder to the empty folder group
1924 (after you create folder group by typing @kbd{m g}),
1925 firstly open it, then execute append command in the next line.
1926 If it is closed, folder is appended on the same level with
1927 the above folder group. It is difficult to explain by words so try it.
1928 In other words, appended position depends on the
1929 above folder group's open/close status.
1931 @subsubsection Charset of the Folders File.
1933 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
1935 @subsubsection Create Filter
1937 @kbd{m f} adds filter to the folder at the current cursor point. To
1938 create new filter folder and leave the current folder unchanged, copy it
1939 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
1940 filter can be specified while appending filter. If you put
1941 ``''(@var{NULL}), filter is deleted.
1943 @subsubsection Sort Folders
1945 Sorting of the folders is executed by the function specified by
1946 @code{wl-fldmgr-sort-function}.
1947 The initial setting is @code{wl-fldmgr-sort-standard},
1948 which sorts alphabetically.
1949 Sorting affects only on the current folder group. It does not
1950 affect on the child groups.
1952 @subsubsection Hiding Folders in the Access Group
1954 Usually, access group displays all children folders, but you can set
1955 some folders hidden. Following operations are only available on access
1958 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
1959 (subscribe/unsubscribe) of the folder at current cursor point. Against
1960 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
1963 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
1964 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
1965 argument and if the argument has positive number, the unsubscribe it.
1966 If the prefix argument has negative value, folder becomes visible and if
1967 zero, folder visibility is toggled.
1969 The other commands, @code{wl-fldmgr-subscribe} and
1970 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
1973 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
1974 executed in the access group, they have a same effect with
1975 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
1976 The difference is that cut commands deletes folders from the current
1979 @subsubsection Operations in the Access Group
1981 You can insert and delete folders in the access group like usual folder
1982 group. But insert and delete commands can be only available for the
1983 children folders of the access group and they only sets the subscribe
1984 status. In other words, insertion of the folder means subscribing,
1985 deletion means unsubscribing.
1986 @footnote{In the current implementation,
1987 it is faster to delete region than to unsubscribe region.}
1989 To update the access group when children folders are inserted or deleted
1990 by other way (other than Wanderlust),
1991 open the access group by typing @kbd{C-u @key{RET}}.
1992 @xref{Selecting Folder}.
1994 The order of children folders of access group is saved after
1995 insertion/deletion/sorting.
1996 If you set @code{wl-force-fetch-folders} to non-nil or open access group
1997 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
1998 newly created folders are inserted on the top of the access group.
2000 @subsection Key bindings
2001 @cindex Keybind, Folder Mode
2002 @cindex Keybind, Folder Buffer
2004 Key bindings on the folder mode related to folder editing are shown below.
2005 All bindings starts with @kbd{m}, and primary commands are binded to
2006 one stroke key binding.
2010 @kindex m a (Folder)
2011 @findex wl-fldmgr-add
2013 (@code{wl-fldmgr-add})
2018 @kindex m g (Folder)
2019 @findex wl-fldmgr-make-group
2020 Create a folder group.
2021 (@code{wl-fldmgr-make-group})
2024 @kindex m A (Folder)
2025 @findex wl-fldmgr-make-access-group
2026 Create an access group.
2027 (@code{wl-fldmgr-make-access-group})
2030 @kindex m d (Folder)
2031 @findex wl-fldmgr-delete
2032 Delete folder itself and msgdb.
2033 If the folder itself cannot be deleted like NNTP folder,
2034 only msgdb is deleted.
2035 (@code{wl-fldmgr-delete})
2040 @kindex m R (Folder)
2041 @findex wl-fldmgr-rename
2042 Change the name of folder or folder group.
2043 msgdb's path is also changed.
2044 (@code{wl-fldmgr-rename})
2050 @findex wl-fldmgr-make-multi
2051 Create a multi folders in the cutlist (cut, copied folders).
2052 (@code{wl-fldmgr-make-multi})
2057 @kindex m f (Folder)
2058 @findex wl-fldmgr-make-filter
2059 Create a filter folder. (Put a filter on the folder).
2060 (@code{wl-fldmgr-make-filter})
2064 @kindex M-c (Folder)
2065 @kindex m c (Folder)
2066 @findex wl-fldmgr-copy
2067 Copy folder (it is not available on folder group).
2068 (@code{wl-fldmgr-copy})
2072 @kindex M-w (Folder)
2073 @kindex m W (Folder)
2074 @findex wl-fldmgr-copy-region
2075 Copy folders in the specified region.
2076 (@code{wl-fldmgr-copy-region})
2080 @kindex C-k (Folder)
2081 @kindex m k (Folder)
2082 @findex wl-fldmgr-cut
2083 Cut folder. Folder itself is not deleted.
2084 (@code{wl-fldmgr-cut})
2088 @kindex C-w (Folder)
2089 @kindex m C-w (Folder)
2090 @findex wl-fldmgr-cut-region
2091 Cut folders in the specified region.
2092 (@code{wl-fldmgr-cut-region})
2096 @kindex C-y (Folder)
2097 @kindex m y (Folder)
2098 @findex wl-fldmgr-yank
2099 Paste folders that are copied or cut (folders in the cut-list).
2100 (@code{wl-fldmgr-yank})
2103 @kindex m p (Folder)
2104 @findex wl-fldmgr-set-petname
2105 Put nickname on the folder.
2106 (@code{wl-fldmgr-set-petname})
2109 @kindex m q (Folder)
2110 @findex wl-fldmgr-clear-cut-entity-list
2111 Clear the cut-list. (cut, copied folder information is cleared,
2112 you cannot paste after this)
2113 (@code{wl-fldmgr-clear-cut-entity-list})
2116 @kindex m s (Folder)
2117 @findex wl-fldmgr-sort
2118 Sort folders in the current folder group.
2119 (@code{wl-fldmgr-sort})
2122 @kindex m C-s (Folder)
2123 @findex wl-fldmgr-save
2124 Save current folder view to the @file{wl-folders-file}.
2125 (@code{wl-fldmgr-save})
2128 [Following commands are only available on the access groups]
2134 @kindex m u (Folder)
2135 @findex wl-fldmgr-unsubscribe
2136 Set the visibility of folder (subscribe/unsubscribe).
2137 (@code{wl-fldmgr-unsubscribe})
2142 @kindex r u (Folder)
2143 @findex wl-fldmgr-unsubscribe-region
2144 Set the visibility of the folders (subscribe/unsubscribe) in the
2146 (@code{wl-fldmgr-unsubscribe-region})
2151 @kindex m l (Folder)
2152 @findex wl-fldmgr-access-display-normal
2153 List folders that are currently available.
2154 (@code{wl-fldmgr-access-display-normal})
2159 @kindex m L (Folder)
2160 @findex wl-fldmgr-access-display-all
2161 List all folders regardless of the subscription status.
2162 (@code{wl-fldmgr-access-display-all})
2166 @subsection Customize variables
2169 @item wl-interactive-save-folders
2170 @vindex wl-interactive-save-folders
2171 The initial setting is @code{t}. If non-nil and folder view is
2172 modified, confirm saving it before Wanderlust or Emacs exits. If
2173 @code{nil}, save without confirmation.
2175 @item wl-fldmgr-make-backup
2176 @vindex wl-fldmgr-make-backup
2177 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2178 created before saving the folder status.
2180 @item wl-fldmgr-sort-function
2181 @vindex wl-fldmgr-sort-function
2182 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2183 sort folders. By default function, folders are sorted alphabetically
2184 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2187 @item wl-fldmgr-sort-group-first
2188 @vindex wl-fldmgr-sort-group-first
2189 The initial setting is @code{t}. If non-nil,
2190 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2191 does not care whether it is folder group or not.
2193 @item wl-folder-check-async
2194 @vindex wl-folder-check-async
2195 The initial setting is @code{t}. If non-nil, check folder's unread
2196 status asynchronously. It boosts newsgroup checking.
2198 @item wl-folder-check-fast
2199 @vindex wl-folder-check-fast
2200 The initial setting is @code{nil}.
2201 If non-nil, it does not update folder status while checking.
2203 @item wl-folder-notify-deleted
2204 @vindex wl-folder-notify-deleted
2205 The initial setting is @code{nil}.
2207 If non-nil, negative value is displayed when the message is deleted. If
2208 @code{sync}, folder is synchronized when the message is deleted. If
2209 @code{nil}, message deletion is ignored.
2212 @subsection Miscellanea
2214 Following is a note for folder editing.
2218 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2219 paste(yank) command pastes the folders on one cut or copy command
2220 (If copy command is executed by region, folders in the region are pasted
2221 by one paste command)
2224 You cannot cut @samp{Desktop} group.
2225 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2228 You cannot copy folder group.
2231 Operations on the access group are only available for the folders
2232 in the same access group.
2235 You cannot create a folder which has same name with the folders already exist.
2238 You cannot insert folders which have same name in one group.
2239 You can insert them in the different groups.
2240 You cannot put same nickname to the different folders.
2244 @node Summary, Message, Folder, Top
2245 @chapter Summary Mode
2247 After you select the folder via folder mode, you enter to the summary
2251 * Usage of Summary Mode:: TIPS.
2252 * Thread Operations:: Thread operations.
2253 * Cache:: File cache, Buffer cache, and Prefetch.
2254 * Auto Refile:: Auto refile settings.
2255 * Sticky Summary:: Summary make sticky.
2256 * Key Bindings of Summary:: Key bindings.
2257 * Variables of Summary:: Customize Summary Mode.
2261 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2262 @section Usage (Tips)
2264 @subsection Summary Content
2266 In the summary mode, messages are displayed like following.
2270 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2271 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2272 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2273 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2280 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2284 You cannot change this in the current version.
2286 @var{Message number} is the message's unique number in the folder. In
2287 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2288 in the MH folder, it is the filename of the message.
2290 @var{Temporal mark} and @var{Persistent mark} are described later.
2292 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2293 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2294 Japanese, but if you want to display it in English, set the value of
2295 @code{wl-summary-weekday-name-lang} as @samp{en}.
2297 @var{Sender}'s indentation corresponds to the depth of the thread.
2298 Sender name is displayed as nickname if it is defined in the address
2299 book. Set @code{wl-use-petname} as @samp{nil}, if you want to quit
2300 displaying with nickname.
2302 If number is printed at the head of @var{Sender} part like @samp{+2},
2303 that means the message have 2 follow messages.
2305 @var{Subject} is the @samp{Subject:} header field of the message. If
2306 the message have same @samp{Subject:} with the parent message, it is not
2307 displayed. Some mailing list puts its sequence number in the
2308 @samp{Subject:} field, but it is
2309 ignored. @code{wl-summary-no-subject-message} is displayed when the
2310 message has empty subject field.
2312 @subsection Temporary Marks
2313 @cindex Mark, Temporary
2315 There are four temporary marks,
2316 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2317 Temporary marks indicates message operations.
2322 You can execute a command on the all messages that have @samp{*} mark,
2323 with the key bindings which begins with @kbd{m}.
2326 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2330 After you type @kbd{o} key, prompt appears to input refile destination.
2331 Your answer is printed in the summary line.
2335 You can put this mark by typing @kbd{O} key.
2336 The difference between this mark and refile mark is,
2337 this mark does not delete the message while latter does.
2340 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2342 @subsection Persistent Marks
2344 There are five persistent marks,
2345 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2347 The persistent mark indicates the message's status and it is saved.
2348 Each persistent mark indicates:
2354 It is unread message.
2356 It is unread but cached message.
2358 It is read but it is not cached.
2360 It is important message. You can put @samp{$} mark by typing @kbd{$}
2361 key (if already exists, the mark is deleted). It is convenient to put
2362 this mark on the messages to remember (If you want to remember to write
2363 a reply for the message, for example) because this mark remains after
2364 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2365 even the message itself is deleted in the actual folder.
2368 If the message is read and cached (or local message),there are no
2372 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2373 cache. Messages with the marks other than these, you can read them in
2374 the offline status even they are in the IMAP folder or netnews folder.
2376 @subsection How To Read
2378 Basically, you can read messages only typing space key again and again.
2380 To update summary status to the newest status (synchronize),
2383 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2384 moves cursor to the next message.
2385 Enter message buffer by typing @kbd{j} key.
2386 To operate multipart, you have to enter to the message buffer.
2389 @subsection Pack the Message Numbers
2390 You can pack the message numbers in Summary by
2391 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2392 News Spool Folder and Maildir Folder are supported folder types.
2395 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2396 @section Thread Operations
2398 For example, the following line indicates one thread (a context of a topic).
2401 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2405 If you type @kbd{/} on this line, the thread is opened and it changes
2406 the appearance like following.
2410 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2411 388 09/17(Thu)22:34 +-[ Murata san ]
2415 (Message 388 is the replied message to the message 384.)
2416 If you type @kbd{/} key once again, the thread is closed.
2417 With prefix argument, @kbd{/} opens all children threads.
2419 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2422 Commands with the key binding that begins with @kbd{t} executes commands
2423 on the messages in the thread.
2424 @xref{Key Bindings of Summary}.
2426 @subsection reconstruct thread by hand
2428 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2429 (@code{wl-summary-save-current-message}) at the corresponding message,
2430 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2431 message then you have the reconstructed thread.
2434 @node Cache, Auto Refile, Thread Operations, Summary
2437 @subsection Cache File
2439 The messages which have to access via network (e.x. IMAP, NNTP folder)
2440 are cached as a local file. The cache file is saved under the directory
2441 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2442 elmo-cache-expire-by-size}. The command deletes cache files to the
2443 specified size by the order of last accessed time.
2445 @subsection Buffer Cache and Prefetching
2447 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2448 that are read are kept in the cache buffer. It is called `buffer
2449 cache'. The number of cache buffer is specified by
2450 @code{elmo-buffer-cache-size}.
2452 There are message prefetching mechanism in the Wanderlust that
2453 prefetches next message while you are reading. This function requires
2454 that the value of @code{elmo-use-buffer-cache} is non-nil.
2456 You can control the message prefetching mechanism by these two
2460 @item wl-cache-prefetch-folder-type-list
2461 @vindex wl-cache-prefetch-folder-type-list
2462 The initial setting is the list shown below:
2470 It specifies the folder types in which message prefetching is enabled.
2471 In the initial setting, multi folder that contains localdir and imap4
2472 prefetches only imap4 messages. This variable precedes the value of
2473 @code{wl-cache-prefetch-folder-list}.
2475 If you want to prefetch localdir and localnews also, following setting
2480 (setq wl-cache-prefetch-folder-type-list
2481 '(nntp imap4 localdir localnews))
2485 @item wl-cache-prefetch-folder-list
2486 @vindex wl-cache-prefetch-folder-list
2487 The initial setting is @code{nil}.
2488 A list of regexp of folders to enable message prefetching.
2492 @node Auto Refile, Sticky Summary, Cache, Summary
2493 @section Auto Refile
2494 @vindex elmo-msgdb-extra-fields
2495 @vindex wl-refile-rule-alist
2496 @findex wl-summary-auto-refile
2498 You can refile messages automatically, by typing @kbd{C-o}
2499 (@code{wl-summary-auto-refile}). It decides destination of refile by
2500 the content of the message header information (information in the msgdb).
2502 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2503 available. If you want to decide destination by other header fields,
2504 set the variable @code{elmo-msgdb-extra-fields} like following.
2508 (setq elmo-msgdb-extra-fields
2518 By this setting, Wanderlust saves extra fields in the msgdb. You have
2519 to type @kbd{s all} to get extra fields for the messages that are
2520 already exists in the summary.
2522 Then, specify the refile rule. The refile target folder of auto
2523 refiling is decided by the value of @code{wl-refile-rule-alist}.
2524 @code{wl-refile-rule-alist} is a list of a rule:
2528 (@var{field} (@var{regexp} . @var{target})
2529 (@var{regexp} . @var{target})
2534 Each rule means `if @var{field} value matches @var{regexp},
2535 then refile to @var{target} folder'.
2536 The rule matched first is applied.
2538 @var{field} is a string of field name. You can specify a list of field name
2539 string, too. In this case, if one of these fields is matched, then the
2540 rule is fired (i.e. OR condition).
2542 @var{regexp} is a regular expression for field value. @var{target} is a target
2543 folder string. You can specify a rule at @var{target} part, too. In this
2544 case, If the field value of the rule and the current rule is matched,
2545 then the current rule is fired (i.e. AND condition).
2547 In @var{target} part, you can refer matched substring of @var{regexp}.
2548 To refer substring, specify following in @var{target}:
2552 means substitute original matched text.
2555 means substitute what matched the @var{N}th `\(@dots{}\)'.
2556 (@var{N} is a number.)
2559 Following is an example of @code{wl-refile-rule-alist}.
2563 (setq wl-refile-rule-alist
2565 ("^Wanderlust" . "+wl")
2566 ("^Elisp" . "+elisp"))
2568 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2570 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2571 "+from-me-to-you"))))))
2575 After these settings, refile marks are automatically put on the condition
2576 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2578 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2580 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2581 with these persistent marks are not automatically refiled.
2582 It means Wanderlust does not execute auto refile on unread messages by
2583 the default setting.
2584 To execute auto refile on all messages, set following.
2587 (setq wl-summary-auto-refile-skip-marks nil)
2591 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2592 @section Sticky Summary
2593 @cindex Summary, Sticky
2594 @cindex Sticky Summary
2596 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2598 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2599 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2601 The buffer name of the sticky summary becomes like
2602 @samp{Summary:@var{folder-name}}.
2604 You can visit the sticky summary at any time by @kbd{C-x b}
2605 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2606 q}. Other operations in the sticky summary are same as normal summary.
2608 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2609 are automatically sticked.
2612 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2613 @section Key bindings
2614 @cindex Keybind, Summary Mode
2615 @cindex Keybind, Summary Buffer
2617 Key bindings of the summary mode are shown below.
2621 @kindex @key{SPC} (Summary)
2622 @findex wl-summary-read
2623 Proceed reading a message at the current cursor point.
2624 (@code{wl-summary-read})
2628 @findex wl-summary-redisplay
2629 Redisplay a message at the current cursor point.
2630 If this command is called with prefix argument,
2631 Redisplay message regardless of the message cache (message is re-loaded
2633 (@code{wl-summary-redisplay})
2637 @findex wl-summary-display-top
2638 Display the top message in the folder.
2639 (@code{wl-summary-display-top})
2643 @findex wl-summary-display-bottom
2644 Display the bottom message in the folder.
2645 (@code{wl-summary-display-bottom})
2649 @kindex @key{BS} (Summary)
2650 @kindex @key{DEL} (Summary)
2651 Display the previous page of the message at the current cursor point.
2652 @findex wl-summary-prev-page
2653 (@code{wl-summary-prev-page})
2656 @kindex @key{RET} (Summary)
2657 @findex wl-summary-next-line-content
2658 Display the next line of the message at the current cursor point.
2659 Display the message at the current cursor point if it is not displayed yet.
2660 (@code{wl-summary-next-line-content})
2665 @kindex M-@key{RET} (Summary)
2666 @findex wl-summary-prev-line-content
2667 Display the previous line of the message at the current cursor point.
2668 Display the message at the current cursor point if it is not displayed yet.
2669 (@code{wl-summary-prev-line-content})
2673 @findex wl-thread-open-close
2674 Toggle open or close the thread at the current cursor point.
2675 (@code{wl-thread-open-close})
2680 @findex wl-thread-open-all
2681 (@code{wl-thread-open-all})
2686 @findex wl-thread-close-all
2687 (@code{wl-thread-close-all})
2691 @findex wl-summary-goto-folder
2693 (@code{wl-summary-goto-folder})
2697 Mark all messages in the folder as read.
2698 @findex wl-summary-mark-as-read-all
2699 (@code{wl-summary-mark-as-read-all})
2703 @findex wl-summary-reply
2704 Prepare a draft for reply the message at the current cursor point.
2705 (@code{wl-summary-reply})
2709 @findex wl-summary-reply-with-citation
2710 Prepare a draft for reply the message at the current cursor point.
2711 (@code{wl-summary-reply-with-citation})
2715 @findex wl-summary-cancel-message
2716 If the message at current cursor point is your own netnews article,
2718 (@code{wl-summary-cancel-message})
2722 @findex wl-summary-reedit
2723 Prepare a draft for re-editing the message at current cursor point.
2724 If the message at current cursor point is your own netnews article,
2725 a draft for `supersedes message' for the message is prepared.
2726 (@code{wl-summary-reedit})
2729 @kindex M-e (Summary)
2730 @findex wl-summary-resend-bounced-mail
2731 If the message at current cursor point is a bounced message,
2732 a draft for re-sending original message is prepared.
2733 (@code{wl-summary-resend-bounced-mail})
2737 @findex wl-summary-forward
2738 A draft for forwarding the message at current cursor point is prepared.
2739 (@code{wl-summary-forward})
2743 @findex wl-summary-mark-as-important
2744 Put @samp{$} mark on the message at current cursor point.
2745 If already marked as @samp{$}, delete it.
2746 (@code{wl-summary-mark-as-important})
2752 Save the message at current cursor point.
2753 @findex wl-summary-save
2754 (@code{wl-summary-save})
2758 @findex wl-summary-next
2759 Move cursor to the next message.
2760 If message is marked with a temporal mark in
2761 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2762 In the offline mode, cursor is not moved to the messages which are not cached
2764 (@code{wl-summary-next})
2768 @findex wl-summary-prev
2769 Move cursor to the previous message.
2770 If message is marked with a temporal mark in
2771 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2772 In the offline mode, cursor is not moved to the messages which are not cached
2774 (@code{wl-summary-prev})
2778 @findex wl-summary-down
2779 Move cursor to the downward message which is unread or marked
2781 In the offline mode, cursor is not moved to the messages which are not cached
2783 If there are messages which have target mark @samp{*} in the summary,
2784 cursor is moved to the downward message which have a target mark.
2785 This behavior is changed according to the value of @code{wl-summary-move-order}.
2786 (@code{wl-summary-down})
2790 @findex wl-summary-up
2791 Move cursor to the upward message which is unread or marked
2793 In the offline mode, cursor is not moved to the messages which are not cached
2795 If there are messages which have target mark @samp{*} in the summary,
2796 cursor is moved to the downward message which have a target mark.
2797 This behavior is changed according to the value of @code{wl-summary-move-order}.
2798 (@code{wl-summary-up})
2802 @findex wl-summary-write
2803 Prepare a new draft.
2804 (@code{wl-summary-write})
2808 @findex wl-summary-write-current-folder
2809 Prepare a new draft. If the current folder is NNTP folder,
2810 @samp{Newsgroups:} field is completed. If the current folder is mailing
2811 list folder (refile destination), guess @samp{To:} field and completed
2812 (If @code{wl-subscribed-mailing-list} is valid list)
2813 (@code{wl-summary-write-current-folder})
2817 @findex wl-summary-redisplay-all-header
2818 Redisplay the message at current cursor point with all header fields.
2819 (@code{wl-summary-redisplay-all-header})
2823 @findex wl-summary-redisplay-no-mime
2824 Redisplay the message at current cursor point without MIME analysis.
2825 (@code{wl-summary-redisplay-no-mime})
2829 @findex wl-summary-burst
2830 If the message at current cursor point has
2831 encapsulates multiple messages using MIME,
2832 de-capsulate and extract them on the current folder.
2833 (@code{wl-summary-burst})
2836 @kindex @@ (Summary)
2837 @findex wl-summary-edit-addresses
2838 Append/change/delete the message's sender information to the address
2839 book @file{~/.addresses} interactively. If this command is called with
2840 prefix argument, arbitrary address can be edited.
2841 (@code{wl-summary-edit-petname})
2845 @findex wl-status-update
2846 Sync up address book status with @file{~/.addresses}'s content.
2847 (@code{wl-status-update})
2851 @findex wl-summary-pipe-message
2852 Pipe current message's content to the external process.
2853 (@code{wl-summary-pipe-message})
2857 @findex wl-summary-print-message
2858 Print out current message's content.
2859 It uses @code{ps-print} module in Emacs 20.x.
2860 If you don't use color printer, you might want to set
2861 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
2864 (setq wl-ps-print-buffer-function 'ps-print-buffer)
2867 (@code{wl-summary-print-message})
2871 @findex wl-summary-exit
2872 Exit current folder.
2873 (@code{wl-summary-exit})
2877 @findex wl-summary-jump-to-current-message
2878 Jump cursor to the currently displayed message's window.
2879 (@code{wl-summary-jump-to-current-message})
2883 Jump cursor to the other message.
2884 @findex wl-summary-jump-to-msg
2885 (@code{wl-summary-jump-to-msg})
2889 Update summary status and
2890 prefetch all messages which have marks included in the
2891 @code{wl-summary-incorporate-marks}.
2892 @findex wl-summary-incorporate
2893 (@code{wl-summary-incorporate})
2896 @kindex M-j (Summary)
2897 @findex wl-summary-jump-to-msg-by-message-id
2898 Jump cursor to the message which have specified @samp{Message-Id:}. If
2899 @code{elmo-use-database} is non-nil, other folder is also searched.
2900 (@code{wl-summary-jump-to-msg-by-message-id})
2904 Jump to parent message.
2905 @findex wl-summary-jump-to-parent-message
2906 (@code{wl-summary-jump-to-parent-message})
2910 @findex wl-summary-mark-as-unread
2911 Mark as unread the message at current cursor point.
2912 (@code{wl-summary-mark-as-unread})
2916 @findex wl-summary-sync
2917 Synchronize summary view after prompting the update range
2918 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
2922 all ...Discard current summary and update all message.
2923 update ...Update the difference between summary and the folder itself.
2924 rescan ...Rescan the msgdb and display again.
2925 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2926 first, last ...Move to the filter folder(partial filter).
2931 (@code{wl-summary-sync})
2935 @findex wl-summary-sort
2937 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
2938 (@code{wl-summary-sort})
2942 @findex wl-summary-toggle-thread
2943 Toggle the threading.
2944 Threading status is displayed on the modeline.
2945 @samp{@{S@}} means threading is off (Sequence) and
2946 @samp{@{T@}} means threading is on (Thread).
2947 (@code{wl-summary-toggle-thread})
2951 @findex wl-summary-toggle-disp-folder
2952 Toggle displaying of folder window.
2953 (@code{wl-summary-toggle-disp-folder})
2957 Toggle displaying of message window.
2958 @findex wl-summary-toggle-disp-msg
2959 (@code{wl-summary-toggle-disp-msg})
2963 Move to the virtual folder with the condition specified.
2964 If called with prefix argument and current folder is virtual, exit it.
2965 @findex wl-summary-virtual
2966 (@code{wl-summary-virtual})
2969 @kindex @key{TAB} (Summary)
2970 @findex wl-summary-goto-last-displayed-msg
2971 Jump to the message which is displayed last.
2972 (@code{wl-summary-goto-last-displayed-msg})
2976 Put @samp{*} mark on the messages that satisfies the specified condition.
2977 @findex wl-summary-pick
2978 (@code{wl-summary-pick})
2982 @findex wl-summary-mark-as-read
2983 Mark as read the message at the current cursor point.
2984 (@code{wl-summary-mark-as-read})
2988 Prefetch the message at the current cursor point.
2989 With prefix argument, prefetch the message even if it is cached.
2990 @findex wl-summary-prefetch
2991 (@code{wl-summary-prefetch})
2995 Execute @samp{D}, @samp{o} and @samp{O} marks.
2996 @findex wl-summary-exec
2997 (@code{wl-summary-exec})
3001 @findex wl-summary-target-mark-line
3002 Put target mark on the message at the current cursor point.
3003 (@code{wl-summary-target-mark-line})
3007 Put refile mark on the message at the current cursor point.
3008 @findex wl-summary-refile
3009 (@code{wl-summary-refile})
3012 @kindex C-o (Summary)
3013 Execute auto refile.
3014 @findex wl-summary-auto-refile
3015 (@code{wl-summary-auto-refile})
3019 Put copy mark on the message at the current cursor point.
3020 @findex wl-summary-copy
3021 (@code{wl-summary-copy})
3024 @kindex M-o (Summary)
3025 Put refile mark on the message at the current cursor point with the destination
3026 previously specified.
3027 @findex wl-summary-refile-prev-destination
3028 (@code{wl-summary-refile-prev-destination})
3032 @findex wl-summary-delete
3033 Put delete mark on the message at the current cursor point.
3034 (@code{wl-summary-delete})
3038 @findex wl-summary-unmark
3039 Unmark the temporal mark on the message at the current cursor point.
3040 (@code{wl-summary-unmark})
3044 Unmark all the temporal marks.
3045 @findex wl-summary-unmark-all
3046 (@code{wl-summary-unmark-all})
3049 @kindex r R (Summary)
3050 @findex wl-summary-mark-as-read-region
3051 Mark as read messages in the specified region.
3052 (@code{wl-summary-mark-as-read-region})
3055 @kindex r $ (Summary)
3056 @findex wl-summary-mark-as-important-region
3057 Mark as important @samp{$} messages in the specified region.
3058 If @samp{$} already exists, it is deleted.
3059 (@code{wl-summary-mark-as-important-region})
3062 @kindex r ! (Summary)
3063 @findex wl-summary-mark-as-unread-region
3064 Mark as unread messages in the specified region.
3065 (@code{wl-summary-mark-as-unread-region})
3068 @kindex r i (Summary)
3069 @findex wl-summary-prefetch-region
3070 Prefetch messages in the specified region.
3071 (@code{wl-summary-prefetch-region})
3074 @kindex r x (Summary)
3075 @findex wl-summary-exec-region
3076 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3078 (@code{wl-summary-exec-region})
3081 @kindex r * (Summary)
3082 @findex wl-summary-target-mark-region
3083 Put target mark on the messages in the specified region.
3084 (@code{wl-summary-target-mark-region})
3087 @kindex r o (Summary)
3088 @findex wl-summary-refile-region
3089 Put refile mark on the messages in the specified region.
3090 (@code{wl-summary-refile-region})
3093 @kindex r O (Summary)
3094 @findex wl-summary-copy-region
3095 Put copy mark on the messages in the specified region.
3096 (@code{wl-summary-copy-region})
3099 @kindex r d (Summary)
3100 @findex wl-summary-delete-region
3101 Put delete mark on the messages in the specified region.
3102 (@code{wl-summary-delete-region})
3105 @kindex r u (Summary)
3106 @findex wl-summary-unmark-region
3107 Delete temporal mark on the messages in the specified region.
3108 (@code{wl-summary-unmark-region})
3111 @kindex r y (Summary)
3112 Save messages in the specified region.
3113 @findex wl-summary-save-region
3114 (@code{wl-summary-save-region})
3117 @kindex t R (Summary)
3118 @findex wl-thread-mark-as-read
3119 Mark as read messages which are the descendant of the current thread.
3120 With prefix argument, it affects on the all messages in the thread tree.
3121 (@code{wl-thread-mark-as-read})
3124 @kindex t $ (Summary)
3125 @findex wl-thread-mark-as-important
3126 Put important mark @samp{$} on the messages which are the
3127 descendant of the current thread.
3128 If @samp{$} mark exists, it is deleted.
3129 With prefix argument, it affects on the all messages in the thread tree.
3130 (@code{wl-thread-mark-as-important})
3133 @kindex t ! (Summary)
3134 @findex wl-thread-mark-as-unread
3135 Mark as unread messages which are the descendant of the current thread.
3136 With prefix argument, it affects on the all messages in the thread tree.
3137 (@code{wl-thread-mark-as-unread})
3140 @kindex t i (Summary)
3141 @findex wl-thread-prefetch
3142 Prefetch messages which are the descendant of the current thread.
3143 With prefix argument, it affects on the all messages in the thread tree.
3144 (@code{wl-thread-prefetch})
3147 @kindex t x (Summary)
3148 @findex wl-thread-exec
3149 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3150 the descendant of the current thread. With prefix argument, it affects
3151 on the all messages in the thread tree.
3152 (@code{wl-thread-exec})
3155 @kindex t * (Summary)
3156 @findex wl-thread-target-mark
3157 Put target mark @samp{*} on the messages which are the descendant of the
3158 current thread. With prefix argument, it affects on the all messages in
3160 (@code{wl-thread-target-mark})
3163 @kindex t o (Summary)
3164 @findex wl-thread-refile
3165 Put refile mark on the messages which are the descendant of the current thread.
3166 With prefix argument, it affects on the all messages in the thread tree.
3167 (@code{wl-thread-refile})
3170 @kindex t O (Summary)
3171 @findex wl-thread-copy
3172 Put copy mark on the messages which are the descendant of the current thread.
3173 With prefix argument, it affects on the all messages in the thread tree.
3174 (@code{wl-thread-copy})
3177 @kindex t d (Summary)
3178 @findex wl-thread-delete
3179 Put delete mar on the messages which are the descendant of the current thread.
3180 With prefix argument, it affects on the all messages in the thread tree.
3181 (@code{wl-thread-delete})
3184 @kindex t u (Summary)
3185 @findex wl-thread-unmark
3186 Unmark temporal mark on the messages which are the descendant of the
3187 current thread. With prefix argument, it affects on the all messages in
3189 (@code{wl-thread-unmark})
3192 @kindex t y (Summary)
3193 @findex wl-thread-save
3194 Save messages which are the descendant of the current thread.
3195 With prefix argument, it affects on the all messages in the thread tree.
3196 (@code{wl-thread-save})
3199 @kindex m i (Summary)
3200 @findex wl-summary-target-mark-prefetch
3201 Prefetch all messages which have target mark @samp{*}.
3202 (@code{wl-summary-target-mark-prefetch})
3205 @kindex m R (Summary)
3206 @findex wl-summary-target-mark-mark-as-read
3207 Mark as read all messages which have target mark @samp{*}.
3208 (@code{wl-summary-target-mark-mark-as-read})
3211 @kindex m $ (Summary)
3212 @findex wl-summary-target-mark-mark-as-important
3213 Mark as important all messages which have target mark @samp{*}.
3214 If already marked as @samp{$}, it is deleted.
3215 (@code{wl-summary-target-mark-mark-as-important})
3218 @kindex m ! (Summary)
3219 @findex wl-summary-target-mark-mark-as-unread
3220 Mark as unread all messages which have target mark @samp{*}.
3221 (@code{wl-summary-target-mark-mark-as-unread})
3224 @kindex m o (Summary)
3225 @findex wl-summary-target-mark-refile
3226 Put refile mark on the messages which have target mark @samp{*}.
3227 (@code{wl-summary-target-mark-refile})
3230 @kindex m O (Summary)
3231 @findex wl-summary-target-mark-copy
3232 Put copy mark on the messages which have target mark @samp{*}.
3233 (@code{wl-summary-target-mark-copy})
3236 @kindex m d (Summary)
3237 @findex wl-summary-target-mark-delete
3238 Put delete mark on the messages which have target mark @samp{*}.
3239 (@code{wl-summary-target-mark-delete})
3242 @kindex m y (Summary)
3243 @findex wl-summary-target-mark-save
3244 Save messages which have target mark @samp{*}.
3245 (@code{wl-summary-target-mark-save})
3248 @kindex m u (Summary)
3249 Unmark all temporal marks.
3250 (@code{wl-summary-delete-all-temp-marks})
3251 @findex wl-summary-delete-all-temp-marks
3254 @kindex m a (Summary)
3255 Put target mark @samp{*} on the all messages.
3256 (@code{wl-summary-target-mark-all})
3257 @findex wl-summary-target-mark-all
3260 @kindex m t (Summary)
3261 Put target mark @samp{*} on the messages in the current thread.
3262 @findex wl-summary-target-mark-thread
3263 (@code{wl-summary-target-mark-thread})
3266 @kindex m r (Summary)
3267 @findex wl-summary-target-mark-region
3268 Put target mark @samp{*} on the messages in the specified region.
3269 (@code{wl-summary-target-mark-region})
3272 @kindex m A (Summary)
3273 @findex wl-summary-target-mark-reply-with-citation
3274 Prepare a draft which cites all messages which have target mark @samp{*}.
3275 (@code{wl-summary-target-mark-reply-with-citation})
3278 @kindex m f (Summary)
3279 @findex wl-summary-target-mark-forward
3280 Prepare a draft which forwards all messages which have target mark @samp{*}.
3281 (@code{wl-summary-target-mark-forward})
3284 @kindex m U (Summary)
3285 @findex wl-summary-target-mark-uudecode
3286 Uudecode the messages which have target mark @samp{*}.
3287 (@code{wl-summary-target-mark-uudecode})
3290 @kindex m ? (Summary)
3291 @findex wl-summary-target-mark-pick
3292 Pick messages from the @samp{*} marked messages.
3293 That is, @samp{*} marks on the messages are remained
3294 if the specified condition is satisfied.
3295 (@code{wl-summary-target-mark-pick})
3298 @kindex M-t (Summary)
3299 @findex wl-toggle-plugged
3300 Toggle offline/online status of Wanderlust.
3301 (@code{wl-toggle-plugged})
3304 @kindex C-t (Summary)
3305 Start Wanderlust's plug-status manager.
3306 (@code{wl-plugged-change})
3309 @kindex C-c C-o (Summary)
3310 @findex wl-jump-to-draft-buffer
3311 Move to the draft buffer if available. If multiple draft buffer exists,
3312 moved to one after another. If prefix argument is specified, load draft
3313 folder's message to the draft buffer and jump to it.
3314 (@code{wl-jump-to-draft-buffer})
3317 @kindex M-w (Summary)
3318 @findex wl-summary-save-current-message
3319 Save the message at the current cursor point.
3320 (@code{wl-summary-save-current-message})
3323 @kindex C-y (Summary)
3324 @findex wl-summary-yank-saved-message
3325 Regard the message at the current cursor point as
3326 parent, connect the message saved by
3327 @code{wl-summary-save-current-message}
3329 (@code{wl-summary-yank-saved-message})
3333 @node Variables of Summary, , Key Bindings of Summary, Summary
3334 @section Customiziable variables
3337 @item wl-summary-move-order
3338 @vindex wl-summary-move-order
3339 The initial setting is @code{unread}. Specify cursor moving policy. If
3340 you want to precede new messages, set @code{new}. If you want to
3341 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3344 @item wl-auto-select-first
3345 @vindex wl-auto-select-first
3346 The initial setting is @code{nil}.
3347 If non-nil, first message is automatically displayed.
3349 @item wl-auto-select-next
3350 @vindex wl-auto-select-next
3351 The initial setting is @code{nil}. If non-nil, jump to next summary
3352 automatically. If @code{unread}, jump to next unread folder's summary
3353 after confirmation. If @code{skip-no-unread}, unread folders are
3354 automatically skipped.
3356 @item wl-thread-insert-opened
3357 @vindex wl-thread-insert-opened
3358 The initial setting is @code{nil}.
3359 If non-nil, thread is inserted as opened.
3361 @item wl-thread-open-reading-thread
3362 @vindex wl-thread-open-reading-thread
3363 The initial setting is @code{t}. If non-nil, reading thread is
3364 automatically opened though it is closed thread.
3366 @item wl-summary-exit-next-move
3367 @vindex wl-summary-exit-next-move
3368 The initial setting is @code{t}. If non-nil, move to next folder at
3371 @item wl-folder-move-cur-folder
3372 @vindex wl-folder-move-cur-folder
3373 The initial setting is @code{nil}. If non-nil, cursor position on the
3376 @item wl-summary-weekday-name-lang
3377 @vindex wl-summary-weekday-name-lang
3378 The initial setting is @samp{ja}. Specify language of the weekday.
3379 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3382 @item wl-summary-fix-timezone
3383 @vindex wl-summary-fix-timezone
3384 The initial setting is @samp{nil}.
3385 Time zone of the date string in summary mode is adjusted using this value.
3386 If @code{nil}, it is adjust to the default time zone information
3387 (system's default time zone or environment variable @samp{TZ}).
3389 @item wl-use-petname
3390 @vindex wl-use-petname
3391 The initial setting is @code{t}.
3392 If non-nil, sender part displays nickname.
3394 @item wl-break-pages
3395 @vindex wl-break-pages
3396 The initial setting is @code{t}.
3397 If non-nil, message is splitted as pages by @samp{^L}.
3399 @item wl-message-window-size
3400 @vindex wl-message-window-size
3401 The initial setting is '(1 . 4).
3402 A cons cell to specify the rate of summary and message window.
3403 car:cdr corresponds summary:message.
3405 @item wl-summary-recenter
3406 @vindex wl-summary-recenter
3407 The initial setting is t.
3408 If non-nil, cursor point is moved to the center of the summary window.
3410 @item wl-summary-indent-length-limit
3411 @vindex wl-summary-indent-length-limit
3412 The initial setting is 46.
3413 Specify the limit of thread indent level.
3414 If nil, max indent level is unlimited.
3416 @item wl-summary-no-from-message
3417 @vindex wl-summary-no-from-message
3418 The initial setting is @samp{nobody@@nowhere?}. A string which is
3419 displayed when there's no @samp{From:} field in the message.
3421 @item wl-summary-no-subject-message
3422 @vindex wl-summary-no-subject-message
3423 The initial setting is @samp{(WL:No Subject in original.)}. A string
3424 which is displayed when there's no @samp{Subject:} field in the message.
3426 @item wl-summary-width
3427 @vindex wl-summary-width
3428 The initial setting is 80.
3429 Width of summary line. If @code{nil}, summary line's width is as is.
3431 @item wl-use-folder-petname
3432 @vindex wl-use-folder-petname
3433 The initial setting is the list shown below:
3442 A list of display policy (symbol) of folder nickname. Available symbols
3447 Display folder petname on modeline.
3449 Destination folder is notified as nickname if
3450 @code{wl-auto-select-next} is non-nil.
3452 You can input folder name by nickname in the function
3453 @code{wl-summary-read-folder}.
3456 @item wl-summary-move-direction-toggle
3457 @vindex wl-summary-move-direction-toggle
3458 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3459 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3460 want to aware of reading direction, set this to @code{t}.
3463 @vindex wl-from-width
3464 The initial setting is 17.
3465 Width of sender part of summary line.
3467 @item wl-summary-divide-thread-when-subject-changed
3468 @vindex wl-summary-divide-thread-when-subject-changed
3469 The initial setting is @code{nil}. If non-nil, thread is splitted if
3470 the subject is changed.
3472 @item wl-summary-search-via-nntp
3473 @vindex wl-summary-search-via-nntp
3474 The initial setting is @code{confirm}.
3476 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3477 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3478 from the NNTP server @code{elmo-default-nntp-server}. The value of
3479 @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
3480 @code{elmo-default-nntp-stream-type} are used.
3482 If @code{confirm}, server name can be specified. You can specify NNTP
3483 folder format like @samp{-:username@@servername:119!}.
3485 @item wl-summary-keep-cursor-command
3486 @vindex wl-summary-keep-cursor-command
3487 The initial setting is the list shown below:
3491 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3496 When you entered to summary by these commands and the target summary
3497 buffer already exists, summary status is not automatically updated and
3498 cursor position is saved.
3500 @item wl-summary-update-confirm-threshold
3501 @vindex wl-summary-update-confirm-threshold
3502 The initial setting is 500. If updated message number is larger than
3503 this value, confirm whether drop them or not.
3505 @item wl-summary-always-sticky-folder-list
3506 @vindex wl-summary-always-sticky-folder-list
3507 The initial setting is @code{nil}.
3508 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3509 are automatically sticked. Each element is regexp of folder name.
3511 @item wl-summary-reserve-mark-list
3512 @vindex wl-summary-reserve-mark-list
3513 The initial setting is the list shown below:
3522 If a message is already marked as temporal marks in this list, the
3523 message is not marked by any mark command.
3525 @item wl-summary-skip-mark-list
3526 @vindex wl-summary-skip-mark-list
3527 The initial setting is the list shown below:
3536 If a message is already marked as temporal marks in this list, the
3537 message is skipped at cursor move.
3539 @item wl-fetch-confirm-threshold
3540 @vindex wl-fetch-confirm-threshold
3541 The initial setting is 30000 (bytes). If displaying message has larger
3542 size than this value, Wanderlust confirms whether fetch the message or
3543 not. If @code{nil}, the message is fetched without confirmation.
3545 @item wl-prefetch-threshold
3546 @vindex wl-prefetch-threshold
3547 The initial setting is 30000 (bytes). If prefetching message has larger
3548 size than this value and @code{wl-prefetch-confirm} is non-nil,
3549 Wanderlust confirms whether prefetch the message or not. If
3550 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3551 without confirmation.
3553 @item wl-prefetch-confirm
3554 @vindex wl-prefetch-confirm
3555 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3556 prefetch the message or not if the message has larger size than
3557 @code{wl-prefetch-threshold}.
3559 @item wl-cache-fetch-threshold
3560 @vindex wl-cache-fetch-threshold
3561 The initial setting is 30000 (bytes). The messages which have larger
3562 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3563 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3566 @item elmo-imap4-use-cache
3567 @vindex elmo-imap4-use-cache
3568 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3571 @item elmo-nntp-use-cache
3572 @vindex elmo-nntp-use-cache
3573 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3576 @item elmo-pop3-use-cache
3577 @vindex elmo-pop3-use-cache
3578 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3581 @item wl-folder-process-duplicates-alist
3582 @vindex wl-folder-process-duplicates-alist
3583 The initial setting is @code{nil}.
3584 This list determines how to deal with duplicated messages in the same folder.
3585 Each item in the list is regexp of folder name and action; you can specify any
3586 one of the following in the place of action:
3589 @code{nil} : do nothing for duplicated messages.
3590 @code{hide} : hide duplicated messages from the summary.
3591 @code{read} : set duplicated messages as read.
3595 Following is an example (hide duplicated messages in multi folders)
3599 (setq wl-folder-process-duplicates-alist
3600 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3601 ("^\\*.*" . hide) (".*" . read)))
3607 @node Message, Draft, Summary, Top
3608 @chapter Message Buffer
3610 Message Buffers utilize MIME-View mode of SEMI/tm. For operational
3611 procedures and key bindings, refer to respective documents.
3612 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3614 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3615 brings you back to Summary mode. @kbd{l} toggles display of Summary
3618 @section Key Bindings
3624 @findex wl-message-toggle-disp-summary
3625 Toggles display of Summary mode buffer.
3626 (@code{wl-message-toggle-disp-summary})
3629 @findex wl-message-refer-article-or-url
3630 @kindex Button-2 (Message)
3631 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3632 corresponding message if found.
3633 (@code{wl-message-refer-article-or-url})
3635 @item Button-4 (upward movement of a wheel)
3636 @kindex Button-4 (Message)
3637 @findex wl-message-wheel-down
3638 Scrolls the message backwards. When the top of the message is hit,
3639 moves to the previous message.
3640 (@code{wl-message-wheel-down})
3642 @item Button-5 (downward movement of a wheel)
3643 @kindex Button-5 (Message)
3644 @findex wl-message-wheel-up
3645 Scrolls the message forward. When the bottom of the message is hit,
3646 moves to the next message.
3647 (@code{wl-message-wheel-up})
3650 @section Customizable Variables
3653 @item wl-message-window-size
3654 @vindex wl-message-window-size
3655 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3656 its car and cdr value corresponds to the ratio of Summary and Message
3658 @item wl-message-ignored-field-list
3659 @vindex wl-message-ignored-field-list
3660 (SEMI only) Initial setting is nil.
3661 All fields that match this list will be hidden in message buffer.
3662 Each elements are regexp of field-name.
3663 If nil, the value of mime-view-ignored-field-list is used.
3664 @item wl-message-visible-field-list
3665 @vindex wl-message-visible-field-list
3666 (SEMI only) Initial setting is nil.
3667 All fields that match this list will be hidden in message buffer.
3668 Each elements are regexp of field-name. This value precedes
3669 wl-message-ignored-field-list.
3670 If nil, the value of mime-view-visible-field-list is used.
3671 @item wl-message-sort-field-list
3672 @vindex wl-message-sort-field-list
3673 (SEMI only) Initial setting is
3674 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3675 Header fields in message buffer are orderd by this value.
3676 Each elements are regexp of field-name.
3679 @node Draft, Disconnected Operations, Message, Top
3680 @chapter Draft Buffer
3682 At Summary mode, pressing @kbd{w} and the like creates a new draft
3683 buffer. You can edit and send mail and news articles in this buffer.
3687 Basically it is Emacs-standard mail mode.
3689 @subsection Address Completion
3691 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3692 addresses. @kbd{@key{TAB}} completes them.
3694 If you want to submit a news article, add @samp{Newsgroups:} field by
3695 yourself. Field names can be completed by @kbd{@key{TAB}}.
3697 If you save the draft buffer you are editing, it is appended to the
3698 folder specified by @code{wl-draft-folder}.
3700 Using @samp{FCC:} field, you can specify the folder to which a copy of
3701 the message is saved when it is sent.
3703 @subsection Editing Messages
3705 Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
3706 editing, refer to respective documents.
3707 @xref{MIME-Edit, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3709 @subsection Dynamic Modification of Messages
3710 @vindex wl-draft-config-alist
3711 @c @cindex Change Message
3712 @c @cindex Message, Change Dynamic
3714 You can set @code{wl-draft-config-alist} so that header and body of the
3715 message will automatically modified depending on information of header
3718 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3720 In the example below, the header is modified when
3721 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3722 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3723 before sending the message.
3727 (setq wl-draft-config-alist
3728 '(((string-match "aaa.example.com$" (system-name))
3729 ;; @r{applied if the expression is non-nil}
3730 (wl-smtp-posting-server . "mailserver-B")
3731 (wl-nntp-posting-server . "newsserver-B")
3732 ;; @r{settings of temporary variables}
3734 ("^To: .*user@@aaa.bbb.example.com"
3735 ;; @r{applied if it matches the header of the draft buffer}
3736 ("Organization" . (format "Go %s" my-webpage)))
3737 ;; @r{you can write elisp expressions here (eval only)}
3738 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3739 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3744 The format of @code{wl-draft-config-alist} is:
3748 '(("@var{regexp of the header}" or @var{elisp expression}
3749 ("@var{Field}" . value(@var{elisp expression}))
3750 (@var{variable} . value(@var{elisp expression}))
3751 (@var{sub-function} . value(@var{elisp expression}))
3754 ("@var{regexp of the header}" or @var{elisp expression}
3755 ("@var{Field}" . value(@var{elisp expression}))
3760 Per default, there are 10 following sub-functions.
3763 'header: Inserts the specified string at the bottom of the header.
3764 'header-file: Inserts the specified file at the bottom of the header.
3765 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3766 'top: Inserts the specified string at the top of the body.
3767 'top-file: Inserts the specified file at the top of the body.
3768 'body: Replaces the body with the specified string.
3769 Specifying @code{nil} deletes the entire body string.
3770 'body-file: Replaces the body with the content of the specified file.
3771 'bottom: Inserts the specified string at the bottom of the body.
3772 'bottom-file: Inserts the specified file at the top of the body.
3773 'template: Applies the specified template.
3774 (refer to the next subsection)
3777 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3778 change them or add your own functions. If you read the code, you can
3779 easily find how to write the functions.
3781 At the first of each item, @var{a regular expression of the header} or
3782 an @var{elisp expression} should be specified. In the case of an elisp
3783 expression, the item is applied when the expression is evaluated
3786 Per default, when multiple items match or are evaluated non-nil, all
3787 such items are applied, but if you set a variable
3788 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3791 At the second of the item, a cons or a list of functions should be
3792 specified. The car part of the cons should be a header field, a
3793 variable, or a sub-function. When a header field is specified, the
3794 field will be modified. If a variable is specified, the value of the
3795 variable will be modified temporarily.
3797 In the cdr part of a cons, not only a variable but also an elisp
3798 expression can be specified as is. If the car part is a header field
3799 and the cdr part is @code{nil}, the field will be deleted.
3801 See the next example as well:
3805 (setq wl-draft-config-alist
3807 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3808 ;; @r{applied if it matches the header of the buffer being replied}
3809 (body . " Hello.\n")
3810 (template . "default")
3815 As in the (1) above, if a header regexp is prepended with @code{reply},
3816 it is applied when the draft is prepared by @code{wl-summary-reply} for
3817 example, and when it matches the header being replied. It is ignored
3818 when there is no buffer being replied, like after @code{wl-draft} was
3821 Note that @code{wl-draft-config-alist} is applied only once when
3822 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3823 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3824 aborting transmission, execute @kbd{C-c C-e}
3825 (@code{wl-draft-config-exec}) explicitly.
3827 If you don't want to apply @code{wl-draft-config-alist} when
3828 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
3832 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
3835 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3836 prepared, do the following:
3839 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3842 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
3843 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
3847 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
3850 @subsection Inserting Templates
3852 @cindex Apply Template
3854 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3855 @kbd{M-x wl-template-select} in the draft buffer.
3857 The format of @code{wl-template-alist} is almost the same as
3858 @code{wl-draft-config-alist}.
3862 (setq wl-template-alist
3865 ("Organization" . "~/.wl sample")
3866 (body . "Hello.\n"))
3868 (template . "default") ;; @r{(a)}
3869 ("To" . "boss@@example.com")
3870 ("Subject" . "Report")
3871 (body-file . "~/work/report.txt")
3877 As you can see, the only difference is item (template) names such as
3878 @samp{default} and @samp{report}, instead of a regexp of header.
3879 Because definition of each item is the same as
3880 @code{wl-draft-config-alist}, you can call another template, like (a).
3882 Executing the command @code{wl-template-select} results in template
3883 selection, but the result differs depending on variable
3884 @code{wl-template-visible-select}.
3886 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3887 window is shown below the draft buffer. You can select a template by
3888 @kbd{n} and @kbd{p} seeing the buffer window.
3890 Press the @key{RET} key and the template is actually applied to the draft
3891 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3892 adjust the window size by @code{wl-template-buffer-lines}.
3894 If @code{wl-template-visible-select} is @code{nil}, you should type the
3895 name of the template in the mini buffer.
3897 As shown in the example in @code{wl-draft-config-alist}, you can select
3898 @samp{default} template by writing:
3901 (template . "default")
3904 @subsection Sending mail by POP-before-SMTP
3905 @cindex POP-before-SMTP
3907 You can send mail by POP-before-SMTP with this single line:
3910 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
3914 Configure the following variables if you need.
3917 @item wl-pop-before-smtp-user
3918 The POP user name for POP-before-SMTP authentication.
3919 If unset, @code{elmo-default-pop3-user} is used.
3921 @item wl-pop-before-smtp-server
3922 The POP server name for POP-before-SMTP authentication.
3923 If unset, @code{elmo-default-pop3-server} is used.
3925 @item wl-pop-before-smtp-authenticate-type
3926 The POP authentication method for POP-before-SMTP authentication.
3927 If unset, @code{elmo-default-pop3-authenticate-type} is used.
3929 @item wl-pop-before-smtp-port
3930 The POP port number for POP-before-SMTP authentication.
3931 If unset, @code{elmo-default-pop3-port} is used.
3933 @item wl-pop-before-smtp-stream-type
3934 If non-nil, POP connection is established using SSL. If
3935 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
3936 unset, @code{elmo-default-pop3-stream-type} is used.
3939 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
3940 unset, settings for POP folders (@code{elmo-default-pop3-*}) are
3942 Therefore, if SMTP server and POP server are actually the same, and if
3943 POP folder per default (such as @samp{&}) is available, no settings are
3946 Refer to the following URL about POP-before-SMTP.
3950 http://spam.ayamura.org/tools/smPbS.html
3951 http://www.iecc.com/pop-before-smtp.html
3955 @section Key Bindings
3956 @cindex Keybind, Draft Mode
3957 @cindex Keybind, Draft Buffer
3962 @kindex C-c C-y (Draft)
3963 @findex wl-draft-yank-original
3964 Cites the content of the current message buffer.
3965 (@code{wl-draft-yank-original})
3968 @kindex C-c C-p (Draft)
3969 @findex wl-draft-preview-message
3970 Previews the content of the current draft.
3971 This is useful for previewing MIME multi-part messages.
3972 (@code{wl-draft-preview-message})
3975 @kindex C-c C-s (Draft)
3976 @findex wl-draft-send
3977 Sends the content of the current draft. Does not erase the draft buffer.
3978 This is useful for sending multiple messages, which are a little different
3980 (@code{wl-draft-send})
3983 @kindex C-c C-c (Draft)
3984 @findex wl-draft-send-and-exit
3985 Sends the content of the current draft and erases the draft buffer.
3986 (@code{wl-draft-send-and-exit})
3989 @kindex C-x C-s (Draft)
3990 @findex wl-draft-save
3991 Save the current draft.
3992 (@code{wl-draft-save})
3995 @kindex C-c C-k (Draft)
3996 @findex wl-draft-kill
3997 Kills the current draft.
3998 (@code{wl-draft-kill})
4001 @kindex C-x k (Draft)
4002 @findex wl-draft-mimic-kill-buffer
4003 Kills the current draft.
4004 (@code{wl-draft-mimic-kill-buffer})
4007 @kindex C-c C-z (Draft)
4008 @findex wl-draft-save-and-exit
4009 Saves the current draft, and erases the draft buffer.
4010 This is useful if you want to suspend editing of the draft.
4011 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4012 the @samp{+draft} folder.
4013 (@code{wl-draft-save-and-exit})
4016 @kindex C-c C-r (Draft)
4017 @findex wl-caesar-region
4018 Encodes or decodes the specified region in Caesar cipher.
4019 (@code{wl-caesar-region})
4023 @findex wl-toggle-plugged
4024 Toggles off-line/on-line states of Wanderlust.
4025 (@code{wl-toggle-plugged})
4028 @kindex C-c C-o (Draft)
4029 @findex wl-jump-to-draft-buffer
4030 Jumps to the other draft buffer, if exists.
4031 With prefix argument, reads a file (if any) from the draft folder when
4032 there is no such buffer.
4033 (@code{wl-jump-to-draft-buffer})
4036 @kindex C-c C-e (Draft)
4037 @findex wl-draft-config-exec
4038 Applies @code{wl-draft-config-alist}.
4039 (@code{wl-draft-config-exec})
4042 @kindex C-c C-j (Draft)
4043 @findex wl-template-select
4045 (@code{wl-template-select})
4048 @kindex C-c C-a (Draft)
4049 @findex wl-draft-insert-x-face-field
4050 Inserts the content of a file @file{~/.xface} (the value of the variable
4051 @code{wl-x-face-file}) as an @samp{X-Face:} field in the draft buffer.
4053 There should be encoded X-Face strings as a content of a file @file{~/.xface}.
4054 (@code{wl-draft-insert-x-face-field})
4057 @section Customizable Variables
4060 @item wl-subscribed-mailing-list
4061 @vindex wl-subscribed-mailing-list
4062 The initial setting is @code{nil}. Mailing lists to which you
4063 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4064 field of a reply draft, removes your own address from
4065 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4066 contained in @samp{To:} or @samp{Cc:} field of a message to be
4067 automatically re-filed, the destination folder will be leaned in
4068 connection with the address.
4074 (setq wl-subscribed-mailing-list
4075 '("wl@@lists.airs.net"
4077 "emacs-mime-ja@@m17n.org"))
4081 @item wl-insert-mail-followup-to
4082 @vindex wl-insert-mail-followup-to
4083 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4084 field is automatically inserted in the draft buffer.
4086 @item wl-insert-mail-reply-to
4087 @vindex wl-insert-mail-reply-to
4088 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4089 field is automatically inserted in the draft buffer.
4091 @item wl-auto-insert-x-face
4092 @vindex wl-auto-insert-x-face
4093 The initial setting is @code{t}. If non-nil and there is an encoded
4094 X-Face string in a file @file{~/.xface} (the value of the variable
4095 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4096 draft buffer. If @code{nil}, it is not automatically inserted. Press
4097 @kbd{C-c C-a} to insert.
4099 @item wl-insert-message-id
4100 @vindex wl-insert-message-id
4101 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4102 is automatically inserted on the transmission.
4104 @item wl-local-domain
4105 @vindex wl-local-domain
4106 The initial setting is @code{nil}. If @code{nil}, the return value of
4107 the function @code{system-name} will be used as the domain part of
4110 If @code{system-name} does not return FQDN (i.e. the full name of the
4111 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4112 to the string of the local domain name without hostname (like
4113 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4114 @samp{.} @code{wl-local-domain} is used as domain part of the
4117 If your terminal does not have global IP, set the value of
4118 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4119 you use invalid @samp{Message-ID:}.)
4121 Moreover, concatenation of @code{system-name} @samp{.}
4122 @code{wl-local-domain} will be used as an argument to the HELO command
4125 @item wl-message-id-domain
4126 @vindex wl-message-id-domain
4127 The initial setting is @code{nil}. If non-nil, this value is used as a
4128 domain part of the @samp{Message-ID:}. If your terminal does not have
4129 global IP address, set unique string to this value (e.x. your e-mail
4132 @item wl-message-id-domain
4133 @vindex wl-message-id-domain
4134 The initial setting is @code{nil}. If @code{nil}, the return value of
4135 the function @code{system-name} will be used as the domain part of
4136 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4137 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4138 @strong{must} set this variable to the string of the full name of the
4139 host. Otherwise, you might be beaten up on the Net News.
4141 @item wl-draft-config-alist
4142 @vindex wl-draft-config-alist
4143 The initial setting is @code{nil}. Modifies the draft message just
4144 before the transmission. The content of @code{wl-draft-config-alist}
4145 will be automatically applied only once on the transmission. If you
4146 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4149 @item wl-template-alist
4150 @vindex wl-template-alist
4151 The initial setting is @code{nil}.
4152 This variable specifies the template to be applied in the draft buffer.
4154 @item wl-draft-config-matchone
4155 @vindex wl-draft-config-matchone
4156 The initial setting is @code{nil}. If non-nil, only the first matching
4157 item is used when @code{wl-draft-config-alist} is applied. If
4158 @code{nil}, all matching items are used.
4160 @item wl-template-visible-select
4161 @vindex wl-template-visible-select
4162 The initial setting is @code{t}.
4163 If non-nil, you can preview the result of the template selection in
4166 @item wl-template-confirm
4167 @vindex wl-template-confirm
4168 The initial setting is @code{nil}.
4169 If non-nil, asks for confirmation when you press the enter key to select
4170 template while previewing.
4172 @item wl-template-buffer-lines
4173 @vindex wl-template-buffer-lines
4174 The initial setting is 7.
4175 If @code{wl-template-visible-select} is non-nil, this variable specifies
4176 the size of the preview window.
4178 @item wl-draft-reply-buffer-style
4179 @vindex wl-draft-reply-buffer-style
4180 The initial setting is @code{split}. @code{split} or @code{full} can be
4181 specified. In the case of @code{full}, the whole frame will be used for
4182 a reply draft buffer when it is prepared.
4184 @item wl-draft-use-frame
4185 @vindex wl-draft-use-frame
4186 The initial setting is @code{nil}.
4187 If non-nil, use new frame for the draft.
4191 The initial setting is the value of the variable
4192 @code{user-mail-address}. The value of this variable is inserted as a
4193 @samp{From:} field of the draft when it is prepared.
4195 @item wl-envelope-from
4196 @vindex wl-envelope-from
4197 The initial setting is @code{nil}.
4198 The value of this variable is used for envelope from (MAIL FROM).
4199 If @code{nil}, the address part of @code{wl-from} is used.
4201 @item wl-user-mail-address-list
4202 @vindex wl-user-mail-address-list
4203 The initial setting is @code{nil}.
4204 This is the User's address list. If you have multiple addresses,
4209 The initial setting is @code{nil}.
4210 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4211 the draft when it is prepared. If function is specified, its return
4216 The initial setting is @code{nil}.
4217 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4218 the draft when it is prepared.
4220 @item wl-reply-subject-prefix
4221 @vindex wl-reply-subject-prefix
4222 The initial setting is @samp{Re: }.
4223 In the @samp{Subject:} of the reply draft, this string is prepended to
4224 the @samp{Subject:} of being replied.
4226 @item wl-draft-reply-use-address-with-full-name
4227 @vindex wl-draft-reply-use-address-with-full-name
4228 The initial setting is @code{t}.
4229 If non-nil, insert her full name with address when prepare a draft for
4230 reply a message. If it is @code{nil}, insert her address only.
4232 @item wl-draft-enable-queuing
4233 @vindex wl-draft-enable-queuing
4234 The initial setting is @code{t}.
4235 This flag controls off-line transmission. If non-nil, the draft is
4238 @item wl-draft-use-cache
4239 @vindex wl-draft-use-cache
4240 The initial setting is @code{nil}. If the value is non-nil and
4241 @code{wl-insert-message-id} is nil, cache the message which is sent.
4243 @item wl-auto-flush-queue
4244 @vindex wl-auto-flush-queue
4245 The initial setting is t.
4246 This flag controls automatic transmission of the queue when Wanderlust
4247 becomes on-line. If non-nil, the queue is automatically transmitted
4248 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4249 manually, press @kbd{F} in the folder mode.
4251 @item wl-ignored-forwarded-headers
4252 @vindex wl-ignored-forwarded-headers
4253 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4254 All headers that match this regexp will be deleted when forwarding a message.
4256 @item wl-ignored-resent-headers
4257 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4258 All headers that match this regexp will be deleted when resending a message.
4260 @item wl-draft-always-delete-myself
4261 @vindex wl-draft-always-delete-myself
4262 If non-nil, always removes your own address from @samp{To:} and
4263 @samp{Cc:} when you are replying to the mail addressed to you.
4265 @item wl-draft-delete-myself-from-bcc-fcc
4266 @vindex wl-draft-delete-myself-from-bcc-fcc
4267 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4268 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4270 @item wl-smtp-posting-server
4271 @vindex wl-smtp-posting-server
4272 The initial setting is @code{nil}.
4273 This is the SMTP server name for mail transmission.
4275 @item wl-smtp-posting-user
4276 @vindex wl-smtp-posting-user
4277 The initial setting is @code{nil}.
4278 This is the user name for SMTP AUTH authentication. If @code{nil},
4279 @code{smtp-authenticate-user} is used.
4281 @item wl-smtp-authenticate-type
4282 @vindex wl-smtp-authenticate-type
4283 The initial setting is @code{nil}.
4284 This is the authentication method for SMTP AUTH authentication. If
4285 @code{nil}, @code{smtp-authenticate-type} is used. If
4286 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4289 @item wl-smtp-connection-type
4290 @vindex wl-smtp-connection-type
4291 The initial setting is @code{nil}.
4292 This variable specifies how to establish SMTP connections.
4293 If @code{nil}, @code{smtp-connection-type} is used.
4294 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4296 @item wl-nntp-posting-server
4297 @vindex wl-nntp-posting-server
4298 The initial setting is @code{nil}.
4299 This is the NNTP server name used for news submission.
4300 If @code{nil}, @code{elmo-default-nntp-server} is used.
4302 @item wl-nntp-posting-user
4303 @vindex wl-nntp-posting-user
4304 The initial setting is @code{nil}.
4305 This is the user name for AUTHINFO authentication on news submission.
4306 If @code{nil}, @code{elmo-default-nntp-user} is used.
4307 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4309 @item wl-nntp-posting-port
4310 @vindex wl-nntp-posting-port
4311 The initial setting is @code{nil}.
4312 This is the port number of the NNTP server used for news submission.
4313 If @code{nil}, @code{elmo-default-nntp-server} is used.
4315 @item wl-nntp-posting-stream-type
4316 @vindex wl-nntp-posting-stream-type
4317 The initial setting is @code{nil}.
4318 If @code{nil}, @code{elmo-default-nntp-stream-type} is evaluated. If non-nil,
4319 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4320 connection will be established.
4322 @item wl-pop-before-smtp-user
4323 @vindex wl-pop-before-smtp-user
4324 The initial setting is @code{nil}.
4325 This is the POP user name for POP-before-SMTP.
4326 If it is @code{nil}, @code{elmo-default-pop3-user} is used.
4328 @item wl-pop-before-smtp-server
4329 @vindex wl-pop-before-smtp-server
4330 The initial setting is @code{nil}.
4331 This is the POP server name for POP-before-SMTP.
4332 If it is @code{nil}, @code{elmo-default-pop3-server} is used.
4334 @item wl-pop-before-smtp-authenticate-type
4335 @vindex wl-pop-before-smtp-authenticate-type
4336 The initial setting is @code{nil}.
4337 This is the authentication method for POP-before-SMTP authentication.
4338 If it is @code{nil}, @code{elmo-default-pop3-authenticate} is used.
4340 @item wl-pop-before-smtp-port
4341 @vindex wl-pop-before-smtp-port
4342 The initial setting is @code{nil}.
4343 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4344 @code{elmo-default-pop3-port} is used.
4346 @item wl-pop-before-smtp-stream-type
4347 @vindex wl-pop-before-smtp-stream-type
4348 The initial setting is @code{nil}.
4349 This flag controls the use of SSL for POP-before-SMTP. If it is
4350 @code{nil}, @code{elmo-default-pop3-stream-type} is used. If @code{starttls},
4351 STARTTLS (RFC2595) connection will be established.
4353 @item wl-draft-queue-save-variables
4354 @vindex wl-draft-queue-save-variables
4355 Specifies a list of variable to which queued messages are saved on the
4356 off-line transmission.
4358 @item wl-draft-sendlog
4359 @vindex wl-draft-sendlog
4360 The initial setting is @code{t}.
4361 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4365 @item drafts are sent by smtp or qmail
4366 @item saved into folders by fcc
4367 @item saved into folders by queuing
4370 (it is written even if the transmission fails).
4371 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4372 and left to the logging function of @command{imput}.
4375 @item wl-draft-sendlog-max-size
4376 @vindex wl-draft-sendlog-max-size
4377 The initial setting is 20000 (in bytes).
4378 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4379 beyond the size specified by this variable.
4383 The initial setting is @code{nil}.
4384 If non-nil, address completion uses LDAP.
4386 @item wl-ldap-server
4387 @vindex wl-ldap-server
4388 The initial setting is @samp{localhost}.
4389 LDAP server name for address completion.
4392 @vindex wl-ldap-port
4393 The initial setting is @code{nil}.
4394 If non-nil, the value is used as port number.
4397 @vindex wl-ldap-base
4398 The initial setting is @samp{c=US}.
4399 LDAP search starting point (base) for address completion.
4401 @item wl-draft-remove-group-list-contents
4402 @vindex wl-draft-remove-group-list-contents
4403 The initial setting is @code{t}.
4404 If non-nil, remove the group-lists' members in the recipients when
4405 sending the message (group-list means the description such as
4406 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4409 @node Disconnected Operations, Expire and Archive, Draft, Top
4410 @chapter Off-line Management
4411 @cindex Disconnected Operations
4413 Wanderlust has on-line and off-line states.
4416 * Off-line State:: Wanderlust has on-line and off-line states.
4417 * Enable Operations:: Enable Disconeected Operations.
4418 * Plugged Mode:: Switching On-line/Off-line per Server/Port.
4419 * Off-line State settings:: Invoking Wanderlust in the Off-line State.
4420 * Variables of Plugged Mode:: Customize Plugged Mode.
4424 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4425 @section Off-line State
4427 Wanderlust has on-line and off-line states. In the off-line state, you
4428 cannot access messages via network, unless they are cached.
4430 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4431 in the mode line indicates the off-line state. In folder or summary
4432 modes, press @kbd{M-t} to switch between off- and on-line.
4434 You can invoke Wanderlust in the off-line state by setting
4435 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4437 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4438 ignores uncached messages.
4441 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4442 @section Enable Disconeected Operations
4444 Even in the off-line state, provided that relevant messages are cached,
4445 and the variable @code{elmo-enable-disconnected-operation} (described
4446 later) is non-nil, you can following operations:
4447 @xref{Plugged Mode}, @xref{Off-line State settings}.
4450 * Send Messages off-line:: Transmit Messages.
4451 * Re-file and Copy queue:: Re-file and Copy (IMAP4).
4452 * Creation of Folders:: Create Folders off-line (IMAP4).
4453 * Marking:: Mark (IMAP4).
4454 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP).
4457 As soon as Wanderlust becomes on-line, such operations invoked off-line
4458 are reflected in the servers via network.
4461 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4462 @subsection Transmission of Messages
4464 You can send mail/news messages off-line (if you are using
4465 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4466 accumulated in the queue folder, @samp{+queue}. These messages are
4467 transmitted at once when Wanderlust becomes on-line.
4469 You can visit @samp{+queue} in the off-line state and confirm content of
4470 messages in the queue. You can also remove messages. Removed messages
4471 are not transmitted even in the on-line state.
4474 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4475 @subsection Re-file and Copy (IMAP4)
4477 Re-file and copy operations to IMAP folders invoked during the off-line
4478 state are accumulated in the queue, and reflected in the server side
4479 when Wanderlust becomes on-line. If you visit destination folders after
4480 off-line re-file or copy, it looks as if messages were appended even in
4483 For the safety reasons, messages re-filed off-line are removed from
4484 source folders only if their @samp{Message-ID:} match messages on the
4485 servers. While the queue is processed, messages that failed to be
4486 re-filed or copied to the specified folders are appended to the folder
4490 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4491 @subsection Creation of Folders (IMAP4)
4493 You can create IMAP folders off-line. The creation of folders are
4494 reflected in the servers when Wanderlust becomes on-line. At that time,
4495 if folders failed to be created on the servers for any reasons, messages
4496 re-filed to such folders are appended to the folder @samp{+lost+found}.
4499 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4500 @subsection Marking (IMAP4)
4502 Off-line changes in unread/read and importance mark @samp{$} information
4503 are also reflected in the servers when Wanderlust becomes on-line.
4506 @node Pre-fetching Reservations, , Marking, Enable Operations
4507 @subsection Pre-fetching (IMAP4, NNTP)
4509 You can make reservations for pre-fetching messages in IMAP or NNTP
4510 folders. Reserved messages are marked with @samp{!} but not cached
4511 yet. When Wanderlust becomes on-line, they are pre-fetched from
4514 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4515 these off-line operations for IMAP4 and NNTP do not take place, and
4516 off-line re-file, copy or suchlike simply results in error.
4518 Because off-line operations use cache files, it is a bad idea to erase
4519 them by hand; it may cause Wanderlust to malfunction.
4521 If you want to remove caches, be sure to execute @kbd{M-x
4522 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4523 remove caches for messages relevant to off-line operations.
4526 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4527 @section Switching On-line/Off-line per Server/Port
4529 @kbd{M-t} described above switches networking states as a whole, but you
4530 can switch on-line/off-line per server/port.
4532 Pressing @kbd{C-t} in the folder or summary modes brings you in
4533 wl-plugged-mode shown below, in which you can change the plugged state
4538 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4541 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4542 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4544 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4545 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4551 The first line indicates status of the following three variables, and
4552 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
4553 column modifies the values of these variables.
4557 "Queuing" @code{wl-draft-enable-queuing}
4558 "AutoFlushQueue" @code{wl-auto-flush-queue}
4559 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4563 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4566 The second and after lines indicate on-line/off-line states of servers
4567 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4568 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4569 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4571 @dfn{sending queue} means messages accumulated in the folder
4572 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4573 off-line operations when @code{elmo-enable-disconnected-operation} is
4575 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4576 @c off-line operations are enabled.
4578 They are displayed if there are any of them. In the example above, in
4579 the sending queue there are two messages (the first and the second in
4580 the queue folder) for smtp to hosta and one (the third) for nntp to
4581 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4584 If you change @samp{(wl-plugged)} in the second line, the variable
4585 @code{wl-plugged} is changed, so that the mode line indicator and
4586 plugged states of all ports are affected. If you change plugged states
4587 of any servers or ports, @samp{(wl-plugged)} in the second line is
4588 affected depending on @code{elmo-plugged-condition} settings and the
4589 plugged state of each port.
4592 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4593 @section Invoking Wanderlust in the Off-line State
4595 As described before, if you set @code{wl-plugged} to @code{nil} in
4596 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4597 off-line state. You can specify off-line state on a per server or port
4598 basis. Refer to @code{wl-reset-plugged-alist} also.
4600 Usually, when Wanderlust starts up, the plugged state of each port is
4601 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4602 @code{wl-nntp-posting-server} and so on. If you want to change the
4603 plugged state of these ports or to add other ports, configure
4604 @code{wl-make-plugged-hook} with a function.
4608 (add-hook 'wl-make-plugged-hook
4610 (elmo-set-plugged plugged-value(t/nil) server port)
4611 ;; @r{add or change plugged states of the port of the server}
4612 (elmo-set-plugged plugged-value(t/nil) server)
4613 ;; @r{if the port is omitted, all ports are affected}
4614 ;; @r{(you cannot omit the port if you newly add the server)}
4620 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4621 @section Customizable Variables
4626 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4627 mode from the beginning.
4629 @item wl-queue-folder
4630 @vindex wl-queue-folder
4631 The initial setting is @samp{+queue}.
4632 This is the folder in which messages in the transmission queue are
4635 @item wl-auto-flush-queue
4636 @vindex wl-auto-flush-queue
4637 The initial setting is @code{t}.
4638 This flag controls automatic transmission of the queue when Wanderlust
4639 becomes on-line. If non-nil, the queue is automatically transmitted
4640 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4641 manually, press @kbd{F} in the folder mode.
4643 @item elmo-enable-disconnected-operation
4644 @vindex elmo-enable-disconnected-operation
4645 The initial setting is @code{nil}. Controls off-line operations
4646 regarding IMAP4. If non-nil, off-line operations are carried out.
4648 @item elmo-lost+found-folder
4649 @vindex elmo-lost+found-folder
4650 The initial setting is @samp{+lost+found}.
4651 This is the folder to which messages are saved when they fails to be
4652 appended while the off-line re-file/copy queue is processed.
4654 @item elmo-plugged-condition
4655 @vindex elmo-plugged-condition
4656 The initial setting is @code{one}.
4657 The value of @code{wl-plugged} reflects the return value of the function
4658 @code{elmo-plugged-p} (without arguments).
4659 This variable @code{elmo-plugged-condition} specifies the condition on
4660 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4661 plugged state of each port.
4664 'one : plugged if one or more ports are plugged.
4665 'all : plugged if all ports are plugged.
4666 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4667 states of the ports.
4668 @var{function} : reflects the return value of the @var{function}
4669 functions available per default
4670 'elmo-plug-on-by-servers
4671 : reflects the plugged state of the servers specified by the
4672 variable elmo-plug-on-servers.
4673 'elmo-plug-on-by-exclude-servers
4674 : reflects the plugged state of the servers that are not
4675 in elmo-plug-on-exclude-servers.
4676 elmo-plug-on-exclude-servers defaults to
4679 (system-name)without the domain part)
4685 (setq elmo-plugged-condition 'all)
4687 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4688 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4690 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4691 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4695 @item wl-reset-plugged-alist
4696 @vindex wl-reset-plugged-alist
4697 The initial setting is @code{t}. If non-nil, plugged states are
4698 initialized on a per server or port basis when Wanderlust starts up.
4700 If @code{nil}, plugged states are retained while Emacs is running. In
4701 other words, they are initialized when Emacs is restarted even if the
4702 value is @code{nil}.
4706 @node Expire and Archive, Scoring, Disconnected Operations, Top
4707 @chapter Automatic Expiration and Archiving of Messages
4708 @cindex Expire and Archive
4711 * Expire:: Expiration and Archiving
4712 * Archive:: Archiving All Messages
4716 @node Expire, Archive, Expire and Archive, Expire and Archive
4718 @cindex Expire Message
4720 Expiration means deletion of old messages which have outlasted a
4721 certain period of time.
4723 @code{wl-expire} supports not only simple deletion, but also moving to
4724 specified archiving folders.
4728 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4729 or @kbd{M-e} in the summary mode.
4731 @subsection Configuring @code{wl-expire-alist}
4733 An example configuration of @code{wl-expire-alist} is shown below.
4734 Everything in this @code{wl-expire-alist} makes a great difference in
4735 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4736 to @code{t}, especially in the initial stage.
4740 (setq wl-expire-alist
4741 '(("^\\+trash$" (date 14) remove)
4743 ("^\\+tmp$" (date 7) trash)
4744 ;; @r{re-file to @code{wl-trash-folder}}
4745 ("^\\+outbox$" (number 300) "$outbox;lha")
4746 ;; @r{re-file to the specific folder}
4748 ;; @r{do not expire}
4749 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4750 ;; @r{archive by message number (retaining numbers)}
4751 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4752 ;; @r{archive by a fixed number (retaining numbers)}
4753 ("^\\+diary$" (date 30) wl-expire-archive-date)
4754 ;; @r{archive by year and month (numbers discarded)}
4759 Items in the list has the format of:
4762 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4766 The folder is examined if it matches @var{regexp-for-folders} from the
4767 beginning of the list. If you invoke expiration on the folder that does
4768 not match any of them, nothing will happen. And if either the second or
4769 the third element of the item is @code{nil}, expiration will not take
4772 You can use any one of the following for
4773 @var{specification-of-message-to-be-deleted}:
4776 @item (number @var{n1} [@var{n2}])
4777 deletes messages depending on the number of messages in the folder.
4779 @var{n1} is the number of messages which should survive deletion, for example
4780 if its value is 500, the newest 500 messages survive and the rests are
4783 @var{n2} is the number of messages in the folder on which expiration should
4784 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4785 folders with 510 or more messages are expired.
4786 If you configured automatic expiration, frequently used folders may
4787 expire every time it receive messages, and you may be annoyed with the
4788 long delay in reading mail.
4789 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4790 expiration would not take place until a certain number of messages
4793 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4794 with important/new/unread) are not deleted.
4795 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4796 will expire so as to have 500 messages including such ones.
4797 Otherwise, it will have 500 messages except such ones.
4799 @item (date @var{d1})
4800 deletes messages depending on the dates.
4802 Messages dated @var{d1} or more days ago are deleted, for example if its
4803 value is seven, messages seven days old or more are deleted. Note that
4804 the date is the one in the @samp{Date:} field of the message, not when
4805 the message entered the folder.
4807 Messages with no or invalid @samp{Date:} field does not expire; you
4808 might have to delete them by hand.
4811 You can use any one of the following in the place of @var{destination}:
4815 deletes the messages instantly.
4818 hide the messages from summary (messages are not deleted).
4821 moves the messages to @code{wl-trash-folder}.
4823 @item @var{string}(folder)
4824 moves the messages to the folder specified with @var{string}.
4826 It would be useful for specifying an archiving folder, but because this
4827 does not move important messages, it might be better to use the
4828 standard functions described below.
4830 @item @var{function}
4831 invokes the specified @var{function}.
4833 To the @var{function}, three arguments are passed: a folder name, a list
4834 of messages to be deleted, and msgdb information of the summary. You
4835 can specify function-specific arguments after the name of the
4836 @var{function}. Note that the list contains messages with marks in
4837 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4840 These are three standard functions; they moves messages to an archive
4841 folder in the specified way. This means old messages can be compressed
4842 and saved in a file, being deleted from the original folder.
4845 @item wl-expire-archive-number1
4846 re-files to archiving folders corresponding to the message numbers of
4847 the messages being deleted. For example, a message numbered 102 will be
4848 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4849 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4850 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4852 The archiving folders to which messages are re-filed are determined by
4853 the name of the folder as follows (in this case, archiving folders are
4854 handled as if @code{elmo-archive-treat-file} were non-nil).
4857 @item If the folder type is localdir:
4858 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4860 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4861 (@file{~/Mail/ml/wl-00100.zip}).
4863 @item The folder type is other than localdir:
4864 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4866 For example, @samp{%#mh/ml/wl} corresponds to
4867 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4870 As you can see, in the case of localdir, the folder type is not included
4871 in the path name, but otherwise it is included.
4872 And you can control the prefix to the archiving folder name by
4873 @code{wl-expire-archive-folder-prefix}.
4874 Refer to @code{wl-expire-archive-folder-prefix} for details.
4876 @item wl-expire-archive-number2
4877 re-files every certain number of messages to archiving folders.
4879 This differs from @samp{wl-expire-archive-number1} in that this re-files
4880 to the folder up to the specified number regardless of message numbers.
4881 The archiving folders to which messages are re-filed are determined in the
4882 same way as @code{wl-expire-archive-number1}.
4884 @item wl-expire-archive-date
4885 re-files messages depending on its date (year and month) to archive
4888 For example, a message dated December 1998 is re-filed to
4889 @code{$folder-199812;zip}. The name of the archiving folders except the
4890 date part are determined in the same way as
4891 @code{wl-expire-archive-number1}.
4894 You can set the first argument to these three standard functions to non-nil
4895 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4896 For example, it can be specified just after the name of the function:
4899 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4902 If you omit the argument, consecutive numbers from 1 are assigned for
4903 each archiving folder.
4906 @subsection Treatment for Important or Unread Messages
4908 If you specify any of @code{remove}, @code{trash}, a folder name, or a
4909 standard function, messages with marks in
4910 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
4911 messages} thereafter) are retained.
4913 Per default, this variable include the important, new, and unread marks,
4914 so that messages with these marks are not removed.
4915 Note that you cannot include the temporary mark (i.e. temporary marks
4916 are removed anyway), and be sure to process temporary marks before you
4919 @subsection Auto Expiration
4921 The following setup invokes expiration when you move into the summary
4922 mode. There will be no confirmation, so make sure you made no mistake
4923 in regexp and other settings before you set up this.
4927 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4931 In the folder mode, you can invoke expiration per group as well as per
4932 folder. Therefore, if you specify @samp{Desktop} group, all folders
4933 matching @code{wl-expire-alist} expire.
4937 @subsection Treating archive folders.
4938 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
4939 you must set non-nil value to @code{elmo-archive-treat-file}.
4941 @subsection Confirming
4943 If you are to use @code{remove}, try @code{trash} at first and see
4944 messages move to @code{wl-trash-folder} as expected, then replace it
4945 with @code{remove}. It would be dangerous to use @code{remove} from the
4948 If you are to use @code{wl-expire-archive-number1} and the like, try to
4949 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
4950 you can append messages to it. Even if settings in
4951 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
4952 would not be saved anywhere and disappeared in case the archiver program
4955 After you make sure you can archive to the folder correctly, you can
4956 invoke expiration and utilize the log.
4958 If you set @code{wl-expire-use-log} to @code{t},
4959 @file{~/.elmo/expired-log} should contain the log, for example:
4963 delete +ml/wl (593 594 595 596 597 598 599)
4964 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
4968 The first column indicates the operation, i.e. @samp{delete},
4969 @samp{copy}, or @samp{move}. The next is the name of the folder that
4970 expired. In the case of @samp{copy} and @samp{move}, the destination
4971 folder is recorded after @samp{->}. The last is the list of message
4972 numbers that are actually deleted or moved (in the case of @samp{copy}
4973 and @samp{move}, the number is the one in the source folder, rather than
4974 the destination folder).
4976 @subsection Re-filing Reserved Messages
4978 The three standard functions copy reserved messages to the archive
4979 folder, but do not delete them from the source folder. Because
4980 reserved messages and the like always remain, they are recorded in
4981 @file{~/.elmo/expired-alist} so that they are not copied over and over
4982 again. They are not recorded if copied by @code{wl-summary-archive}.
4984 If you enabled logging, usually @samp{move} is recorded for re-filing,
4985 but instead @samp{copy} and @samp{delete} are recorded separately if
4986 reserved messages are involved. This is because it actually copies
4987 messages including reserved, then deletes ones except reserved in that
4990 @section Customizable Variables
4993 @item wl-expire-alist
4994 @vindex wl-expire-alist
4995 The initial setting is @code{nil}.
4996 This variable specifies folders and methods to expire. For details,
4997 refer to @code{wl-expire-alist} settings above.
4999 @item wl-summary-expire-reserve-marks
5000 @vindex wl-summary-expire-reserve-marks
5001 The initial setting is the list below.
5005 (list wl-summary-important-mark
5007 wl-summary-unread-mark
5008 wl-summary-unread-uncached-mark
5009 wl-summary-unread-cached-mark)
5013 Messages with these marks are retained in the folder, even after
5015 Only permanent marks can be listed, not temporary marks.
5017 You can list marks one by one as in the default; you can use the
5018 following settings as well:
5022 All messages with permanent marks are retained,
5023 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5027 All messages are handled as usual ones that are already read, no matter
5028 what marks they have; even important messages are deleted.
5031 @item wl-expire-archive-files
5032 @vindex wl-expire-archive-files
5033 The initial setting is 100.
5034 This variable specifies the number of messages to be retained in one
5037 @item wl-expire-number-with-reserve-marks
5038 @vindex wl-expire-number-with-reserve-marks
5039 The initial setting is @code{nil}.
5040 If non-nil, if expiring messages are specified by @code{number},
5041 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5043 @item wl-expire-archive-get-folder-function
5044 @vindex wl-expire-archive-get-folder-function
5045 The initial setting is @code{wl-expire-archive-get-folder}.
5047 This variable specifies a function that returns the name of an archiving
5048 folder for standard functions in the place of @var{destination}.
5049 You can use the following three variables for simple modification of
5050 folder names; if you want more complex settings, define your own
5051 function in this variable.
5053 @code{wl-expire-archive-get-folder} can be customized by these
5056 @item @code{wl-expire-archive-folder-name-fmt}
5057 @item @code{wl-expire-archive-folder-type}
5058 @item @code{wl-expire-archive-folder-prefix}
5061 @item wl-expire-archive-folder-name-fmt
5062 @vindex wl-expire-archive-folder-name-fmt
5063 The initial setting is @samp{%s-%%05d;%s}.
5064 This is a @code{format} string for archiving folders used in
5065 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5066 Note that you must specify the message number by @samp{%%d}, because it
5067 is parsed twice by @code{format}.
5069 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5072 @item wl-expire-archive-date-folder-name-fmt
5073 @vindex wl-expire-archive-date-folder-name-fmt
5074 The initial setting is @samp{%s-%%04d%%02d;%s}.
5075 This is a @code{format} string for archiving folders used in
5076 @code{wl-expire-archive-date}. Note that you must specify the message
5077 number by @samp{%%d}, because it is parsed twice by @code{format}.
5078 There should be @samp{%%d} twice, one for the year and the other for the
5081 If you modify this, adjust
5082 @code{wl-expire-archive-date-folder-num-regexp} as well.
5084 @item wl-expire-archive-folder-type
5085 @vindex wl-expire-archive-folder-type
5086 The initial setting is @code{zip}.
5087 This variable specifies an archiver type of the archiving folders.
5089 @item wl-expire-archive-folder-prefix
5090 @vindex wl-expire-archive-folder-prefix
5091 The initial setting is @code{nil}.
5092 This variable specifies the prefix (directory structure) to archiving
5094 Exercise extreme caution in using this feature, as it has not been
5096 In the worst case, there is a fear of destructing archiving folders.
5100 There will be no prefix.
5103 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5104 @samp{$ml/wl-00000;zip;wl}.
5107 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5110 @samp{$ml/wl-00000;zip;ml/wl}.
5113 @item wl-expire-archive-folder-num-regexp
5114 @vindex wl-expire-archive-folder-num-regexp
5115 The initial setting is @samp{-\\([-0-9]+\\);}.
5116 This variable specifies the regular expression to be used for getting
5117 message numbers from multiple archiving folders specified by
5118 @code{elmo-list-folders}.
5119 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5121 @item wl-expire-archive-date-folder-num-regexp
5122 @vindex wl-expire-archive-date-folder-num-regexp
5123 The initial setting is @samp{-\\([-0-9]+\\);}.
5124 This is the regular expression to be used for getting message numbers
5125 from multiple archiving folders specified by @code{elmo-list-folders}.
5126 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5128 @item wl-expire-delete-oldmsg-confirm
5129 @vindex wl-expire-delete-oldmsg-confirm
5130 The initial setting is @code{t}.
5131 If non-nil, messages older than the one with the largest number will be
5132 deleted with confirmation.
5133 If @code{nil}, they are deleted without confirmation.
5135 This feature is valid only if non-nil is specified as a argument to the
5136 standard functions so as to retain numbers.
5138 @item wl-expire-use-log
5139 @vindex wl-expire-use-log
5140 The initial setting is @code{nil}.
5141 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5142 They are appended but not truncated or rotated automatically; you might
5143 need to remove it manually.
5145 @item wl-expire-add-seen-list
5146 @vindex wl-expire-add-seen-list
5147 The initial setting is @code{t}.
5149 If non-nil, when messages are re-filed by expiration, read/unread
5150 information is passed to the destination folder.
5152 However if you do not read the destination folder from Wanderlust,
5153 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5154 want to set this to @code{nil} if you are simply saving to some
5155 archiving folders. Even if its value is @code{nil}, messages in the
5156 archiving folders are simply treated as unread; it does not affect
5159 @item wl-expire-folder-update-msgdb
5160 @vindex wl-expire-folder-update-msgdb
5161 The initial setting is @code{t}.
5162 If @code{t}, in the folder mode, expiration is carried out after
5163 updating summary information. If you specified a list of regular
5164 expressions of folder names, summary information is updated for matching
5169 @node Archive, , Expire, Expire and Archive
5170 @section Archiving Messages
5172 @subsection Archiving Messages
5173 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5174 folders. If there are the archiving folders already, only new messages
5177 You can use @code{wl-archive-alist} in order to specify how messages are
5178 archived according to their folder names, as in @code{wl-expire-alist}.
5183 (setq wl-archive-alist
5184 '(("^\\+tmp$" wl-archive-date)
5185 ("^\\+outbox$" wl-archive-number2)
5186 (".*" wl-archive-number1)))
5190 Each item in the list has the following format:
5193 (@var{folders-regexp} @var{deleting-function})
5196 As you can see, you can only use a function after @var{folders-regexp}.
5197 Per default, there are three functions:
5200 @item @code{wl-archive-number1}
5201 @item @code{wl-archive-number2}
5202 @item @code{wl-archive-date}
5205 As inferred from their names, they work similarly to "expire" versions,
5206 other than the following points:
5209 @item No messages are deleted
5210 @item Message numbers are retained even if invoked without arguments
5213 These functions are good to archive all messages in a folder by their
5214 numbers or by their dates.
5215 These are also useful for backup or confirmation purposes before
5217 If you try to re-file them after they are archived, they are deleted but
5220 Per default, the archiving folders to which messages are copied are
5221 determined automatically by @code{wl-expire-archive-get-folder-function}.
5222 You can copy to a specific folder by invoking with a prefix argument,
5223 i.e. @kbd{C-u M-x wl-summary-archive}.
5225 Note that this feature has not been seriously tested, because you can
5226 simply copy to an archiving folder, for example by
5227 @code{wl-summary-copy-region}.
5229 The archiving folders are determined by the same logic as in
5230 @code{wl-summary-expire}; the following customizable variables are
5234 @item @code{wl-expire-archive-files}
5235 @item @code{wl-expire-archive-get-folder-function}
5236 @item @code{wl-expire-archive-folder-name-fmt}
5237 @item @code{wl-expire-archive-folder-type}
5238 @item @code{wl-expire-archive-folder-prefix}
5239 @item @code{wl-expire-archive-folder-num-regexp}
5242 @subsection Customizable Variables
5245 @item wl-archive-alist
5246 @vindex wl-archive-alist
5247 The initial setting is the list shown below:
5251 ((".*" wl-archive-number1))
5256 This variable specifies a function that copies to archiving folders.
5257 To the function, three arguments are passed: a folder name, a list of
5258 messages in the folder, and msgdb information of the summary.
5259 Needless to say, you can use your own function.
5263 @node Scoring, Address Book, Expire and Archive, Top
5264 @chapter Score of the Messages
5266 @c @cindex Kill File
5268 Scoring is the function that associates a score (value) with each
5269 message, and marks as read or deletes from the summary according to it.
5271 You can put target or important marks on essential messages, or read marks
5272 on the ones you do not want to read, for example spam articles.
5274 This scoring function has a capability and a format similar to the one
5275 that Gnus has, although there are some unsupported features and
5276 Wanderlust specifics.
5277 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5280 * Score Commands:: Score Commands
5281 * Score File Format:: Score File Format
5285 @node Score Commands, Score File Format, Scoring, Scoring
5286 @section Score Commands
5287 @cindex Score Commands
5289 @subsection Score File Specification
5291 @code{wl-score-folder-alist} specifies score files or variables in which
5292 scores are defined, corresponding to folder names.
5296 (setq wl-score-folder-alist
5305 If paths to the score files are omitted, the directory specified in the
5306 variable @code{wl-score-files-dir} is assumed.
5308 No matter what you write in @code{wl-score-folder-alist}, the default
5309 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5310 read (it does not have to exist).
5311 Therefore, in the example above, the three score files,
5312 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5313 the folders that matches @samp{^-.*}.
5315 @subsection Scored Messages
5317 Scores are attached to the messages that are specified by
5318 @code{wl-summary-score-marks} temporarily when the summary is updated;
5319 when you exit from the summary, the scores are removed and reverts to
5322 @subsection Creation of Score Files
5324 In the summary buffer, move to an appropriate message and type @kbd{L}.
5325 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5326 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5328 This makes @minus{}1000 are scored for messages with the same
5329 @samp{Subject:} as the string you entered. That is, such a score file
5330 is created automatically.
5332 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5333 The score file you just made appears.
5334 This buffer is called @dfn{score editing buffer} thereafter.
5335 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5336 as you are previously; type @kbd{a}. Then a score entry for "From"
5338 In this way, you can create a score file easily either in the summary
5339 buffer or in the score editing buffer.
5341 By the way, you might be aware the numbers of key strokes are different
5342 between @kbd{s s p} and @kbd{a}.
5343 This is determined by @code{wl-score-header-default-entry}.
5344 This variable specifies the default score entries corresponding to
5346 For example, for "subject" field, a type and a time limit are prompted,
5347 but for "from" field, they are fixed upon automatically as substring and
5348 permanent respectively.
5349 However, score values can be modified by the prefix argument.
5350 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5353 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5354 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5355 erasing contents of the buffer deletes the score file being edited.
5359 @subsubsection Selecting Score Files
5361 You can change score files to which scores are appended by
5362 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5363 @code{wl-score-change-score-file}.
5365 @subsubsection Summing Up the Score
5367 If you add the same entries by @code{wl-summary-increase-score},
5368 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5369 scores for the entry is summed up.
5371 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5372 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5373 @minus{}1200 will be created as a result.
5375 @subsubsection Creating Thread Key
5377 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5378 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5380 @subsubsection Creating Followup Key
5382 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5383 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5384 at the cursor to @samp{References} key.
5385 If @code{wl-score-auto-make-followup-entry} is non-nil,
5386 @samp{Message-ID} of all messages to be followed up within dates
5387 specified by @code{wl-score-expiry-days}.
5389 @subsection Key Bindings
5394 @findex wl-summary-increase-score
5395 Increases the score for the current message.
5396 And the score entry is appended to the score file at the same moment.
5397 You can specify the score value by a prefix argument.
5401 @findex wl-summary-lower-score
5402 Decreases the score for the current message.
5403 And the score entry is appended to the score file at the same moment.
5404 You can specify the score value by a prefix argument.
5407 @kindex h R (Summary)
5408 @findex wl-summary-rescore
5409 Re-applies the scoring.
5410 However, already scored messages are not scored anew.
5413 @kindex h c (Summary)
5414 @findex wl-score-change-score-file
5415 Changes the score file currently selected.
5418 @kindex h e (Summary)
5419 @findex wl-score-edit-current-scores
5420 Edits the score file currently selected.
5421 If there are multiple score files, the previously specified one is
5425 @kindex h f (Summary)
5426 @findex wl-score-edit-file
5427 Edits an arbitrary score file and selects it.
5430 @kindex h F (Summary)
5431 @findex wl-score-flush-cache
5432 Erases caches associated to the score files that are read.
5433 If you modified score files directly (from other than Wanderlust), you
5434 need to re-read them after erasing the cache.
5437 @kindex h m (Summary)
5438 @findex wl-score-set-mark-below
5439 Specifies the criterion for scores to be marked as read.
5440 Messages with scores less than this value are marked as read.
5443 @kindex h x (Summary)
5444 @findex wl-score-set-expunge-below
5445 Specifies the criterion for scores to be deleted from the summary.
5446 Messages with scores less than this value are deleted.
5447 "Deleted" means it is not shown; they are not removed from the summary
5448 information or the folder.
5449 The deleted messages can be shown by rescan-noscore again.
5452 @subsection Key Bindings in the Score Editing Buffer
5456 @kindex C-c C-k (Score Mode)
5457 @findex wl-score-edit-kill
5458 Abandons the file being edited.
5461 @kindex C-c C-c (Score Mode)
5462 @findex wl-score-edit-exit
5463 Saves the file being edited, and quits from the edit mode.
5466 @kindex C-c C-p (Score Mode)
5467 @findex wl-score-pretty-print
5471 @kindex C-c C-d (Score Mode)
5472 @findex wl-score-edit-insert-date
5473 Inserts the number of dates from Dec. 31, 1 B.C.
5474 It is used for creating the third factor of time-limited scores.
5477 @kindex C-c C-s (Score Mode)
5478 @findex wl-score-edit-insert-header
5479 Inserts the header of the message selected in the summary buffer.
5482 @kindex C-c C-e (Score Mode)
5483 @findex wl-score-edit-insert-entry
5484 Inserts the score entry of the message selected in the summary buffer.
5487 @subsection Customizable Variables
5490 @item wl-summary-default-score
5491 @vindex wl-summary-default-score
5492 The initial setting is 0 (zero).
5493 This variable specifies the default value of the score.
5494 The score is increased or decreased based upon this value.
5496 @item wl-summary-important-above
5497 @vindex wl-summary-important-above
5498 The initial setting is @code{nil}.
5499 Messages with scores larger than this value are attached with the
5500 important mark (@samp{$}).
5501 If @code{nil}, no important marks are attached.
5503 @item wl-summary-target-above
5504 @vindex wl-summary-target-above
5505 The initial setting is @code{nil}.
5506 Messages with scores larger than this value are attached with the target
5508 If @code{nil}, no target marks are attached.
5510 @item wl-summary-mark-below
5511 @vindex wl-summary-mark-below
5512 The initial setting is 0 (zero).
5513 Messages with scores smaller than this value are marked as read.
5515 @item wl-summary-expunge-below
5516 @vindex wl-summary-expunge-below
5517 The initial setting is @code{nil}.
5518 Messages with scores smaller than this value are deleted from the
5520 If @code{nil}, they are not deleted.
5522 @item wl-summary-score-marks
5523 @vindex wl-summary-score-marks
5524 The initial setting is the list shown below:
5528 (list wl-summary-new-mark)
5533 Messages with these marks are scored.
5535 @item wl-use-scoring
5536 @vindex wl-use-scoring
5537 The initial setting is t.
5538 If non-nil, scoring is enabled.
5540 @item wl-score-files-dir
5541 @vindex wl-score-files-dir
5542 The initial setting is @file{~/.elmo/}.
5543 The default directory for score files.
5545 @item wl-score-interactive-default-score
5546 @vindex wl-score-interactive-default-score
5547 The initial setting is 1000.
5548 This value is used as a score when a score factor is @code{nil} in the
5549 score file. It is also used in @code{wl-summary-increase-score} and
5550 @code{wl-summary-lower-score}, on condition that the value of
5551 @code{wl-score-header-default-entry} is @code{nil}.
5553 @item wl-score-expiry-days
5554 @vindex wl-score-expiry-days
5555 The initial setting is 7.
5556 This is the number of days before time-limited scores are deleted.
5558 @item wl-score-update-entry-dates
5559 @vindex wl-score-update-entry-dates
5560 The initial setting is @code{t}.
5561 If non-nil, it enables deletion of time-limited scores.
5563 @item wl-score-header-default-entry
5564 @vindex wl-score-header-default-entry
5565 Specifies the default value for each header field for score entries
5566 created by @code{wl-summary-increase-score},
5567 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5569 @item wl-score-simplify-fuzzy-regexp
5570 @vindex wl-score-simplify-fuzzy-regexp
5571 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5572 regular expression to be deleted from the string.
5573 Because this is usually used for Subject, the default is prefixes that
5574 are attached by mailing list programs.
5576 @item wl-summary-rescore-partial-threshold
5577 @vindex wl-summary-rescore-partial-threshold
5578 The initial setting is 200.
5579 When sync-all or rescan is executed, if there are messages more than
5580 this value, only the last same number of messages as this value are
5583 @item wl-summary-auto-sync-marks
5584 @vindex wl-summary-auto-sync-marks
5585 If non-nil, unread/important marks are synchronized when the summary
5587 Unread marks reflect information on the IMAP4 server.
5588 Important marks reflect information on the IMAP4 server (flagged or
5589 not), and contents of @samp{'mark} folder.
5590 The initial setting is @code{t}.
5594 @node Score File Format, , Score Commands, Scoring
5595 @section Score File Format
5596 @cindex Score File Format
5598 The format of score files are the same as Gnus, and basically you can
5599 use Gnus score files as they are. But they are not fully compatible
5600 because some keys are not supported and there are Wanderlust specifics.
5601 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5606 ("for sale" -1000 nil s)
5607 ("profit" -1000 nil s))
5609 ("spam@@spamspamspam" -10000 nil s))
5611 ("my@@address" 3001 nil s))
5613 (1000000 -10 nil >))
5623 If the key is a string, it is the name of the header to be matched.
5624 The following keys are available:
5625 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5626 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5627 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5628 @code{Chars} and @code{Lines} mean the size and the number of lines of
5629 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5630 are described later.
5631 The rest corresponds the field of the same name.
5633 Arbitrary numbers of core entries are specified after the key.
5634 Each score entry consists of these five factors:
5638 A factor that matches header. This should be a number in the cases of
5639 @code{lines} and @code{chars}, otherwise a string.
5642 A score factor. When the first item matches, the score of the message
5643 is increased or decreased by this value.
5646 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5647 of a number, the score is deleted if it does not match for days
5648 (@code{wl-score-expiry-days}) from the date specified by this.
5649 The date is since Dec. 31, 1 B.C.
5652 A type factor. This specifies the way the first factor matches.
5653 Available types depend on keys.
5656 @item From, Subject, References, Message-ID
5657 For these keys in string, @code{r} and @code{R} (regexp),
5658 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5659 as well as @code{f} and @code{F} (fuzzy) can be used.
5660 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5663 For these keys, the following five numerical relative operators can be
5664 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5667 This key matches @code{From} header, and scores all follow-ups to the
5669 For example, it would be useful for increasing scores for follow-ups to
5672 You can use the same types as @code{From} except for @code{f}.
5673 And a @samp{Followup} entry is automatically appended to the score file.
5676 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5677 A @samp{Thread} entry is automatically appended for each article that
5678 has @var{x} in the @code{References} header.
5679 You can make sure the whole thread including messages that does not have
5680 all ancestors @code{Message-ID} in @code{References} is scored.
5682 You can use the same types as @code{References} except for @code{f}.
5683 And a @samp{Thread} entry is automatically appended to the score file.
5687 A factor for extension header. This is meaningful only if the key is
5689 This specifies headers to be matched other than standard headers like
5690 @code{Subject} and @code{From}.
5691 Note that you should specify the header in
5692 @code{elmo-msgdb-extra-fields} also.
5693 Therefore it does not work in folders where extension headers cannot be
5698 The sum of these scores @emph{after all factors are applied} becomes the
5699 score of the message.
5701 @cindex Score File Atoms
5703 Messages with a score less than this value is marked as read.
5704 The default is @code{wl-summary-mark-below}.
5707 Messages with a score less than this value is deleted from the summary.
5708 The default is @code{wl-summary-expunge-below}.
5710 @item mark-and-expunge
5711 Both @code{mark} and @code{expunge} are applied,
5712 i.e. messages with a score less than this value is marked as read and
5713 deleted from the summary.
5716 Messages with a score greater than this value is attached with temp
5718 The default is @code{wl-summary-target-above}.
5721 Messages with a score greater than this value is attached with important
5723 The default is @code{wl-summary-important-above}.
5728 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5729 are used, you need to set @code{elmo-msgdb-extra-fields}.
5732 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5735 There are other restrictions as shown below:
5738 @item Because @samp{References} field in the summary information
5739 contains only the last @samp{Message-ID}, @code{references} key matches
5743 Keys that can be seen by folder of types:
5747 chars lines xref extra
5748 localdir,localnews Y E E E
5749 nntp (supporting xover) Y E E N
5755 N: cannot be seen (ignored)
5756 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5761 @node Address Book, Customization, Scoring, Top
5762 @chapter Address Book
5763 @cindex Address Book
5765 Address Book support mail address and petname display on summay
5769 * Mail Addresses:: Definition Address Book
5770 * Address Manager:: Address Manager
5773 @node Mail Addresses, Address Manager, Address Book, Address Book
5774 @section Address book
5775 @cindex Address book Definition
5777 @cindex Alias, Address
5779 The file @file{~/.addresses} is a simple address book for Wanderlust.
5780 Make address file @file{~/.addresses}, and edit to suit your requirement.
5782 The data written in @file{~/.addresses} are used for address completion
5783 under draft editing mode. Furthermore, they are used when showing names
5784 in summary display mode. You can safely skip this section, if you don't
5785 want to customize address completion and summary display.
5786 It is possible to add/change/remove addresses from @file{~/.addresses} in
5787 summary buffer after Wanderlust is invoked. @refill
5789 The format is very simple. Like this. @refill
5794 # @r{Lines begin with @samp{#} are comment.}
5795 # @r{Empty lines are ignored}
5797 # @r{Format of each line:}
5798 # @var{email-address} "@var{nickname} "@var{realname}"
5800 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
5801 foo@@bar.gohome.org "Mr. Foo" "John Foo"
5802 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
5807 One line defines one persons description.
5809 Actually, in default setup, @var{nickname} is used in summary-mode and
5810 @var{realname} is used in draft preparation mode. This behavior is
5811 better understood if you try it and confirmed the function first. You
5812 can write and try a small definition, so you will know the idea of the
5813 address book before writing a big one.
5815 And, if MH alias file is specified in variable @code{wl-alias-file},
5816 it is used as an address information in the draft preparation mode.
5818 If variable @code{wl-use-ldap} is non-nil (initial setting is
5819 @code{nil}), address completion in draft mode uses LDAP information.
5821 If you use LDAP, you have to set @code{wl-ldap-server},
5822 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
5823 not have LDAP feature as built-in feature (Currently only XEmacs can
5824 have built-in LDAP feature), you have to set command exec @env{PATH} to
5825 the program @command{ldapsearch}.
5828 @node Address Manager, , Mail Addresses, Address Book
5829 @section Address Manager
5830 @cindex Address Manager
5832 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
5833 the address book and insert address to draft buffer.
5835 @subsection Key Bindings
5839 @kindex t (Address Manager)
5840 @findex wl-addrmgr-set-to
5841 Add @samp{To:} mark.
5844 @kindex c (Address Manager)
5845 @findex wl-addrmgr-set-cc
5849 @kindex b (Address Manager)
5850 @findex wl-addrmgr-set-bcc
5851 Add @samp{Bcc:} mark.
5854 @kindex u (Address Manager)
5855 @findex wl-addrmgr-unmark
5859 @kindex x (Address Manager)
5860 @findex wl-addrmgr-apply
5862 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
5863 buffer and quit address manager. When no draft buffer, make new draft
5864 with insert marked addresses.
5866 If no mark, quit address manager.
5870 @kindex q (Address Manager)
5871 @findex wl-addrmgr-quit
5872 Quit address manager.
5875 @kindex a (Address Manager)
5876 @findex wl-addrmgr-add
5880 @kindex d (Address Manager)
5881 @findex wl-addrmgr-delete
5885 @kindex e (Address Manager)
5886 @findex wl-addrmgr-edit
5891 @node Customization, Mailing List, Address Book, Top
5892 @chapter Customizing Wanderlust
5893 @cindex Customization
5896 * Living with other packages:: Living with other packages
5897 * Highlights:: Highlights
5898 * Biff:: Notify Mail arrival
5899 * Advanced Settings:: Advanced Settings
5900 * Customizable Variables:: Customizable Variables
5905 @node Living with other packages, Highlights, Customization, Customization
5906 @section Living with other packages
5908 Examples with other packages.
5911 * imput:: imput (im-wl.el)
5913 * supercite:: supercite.el
5914 * mu-cite:: mu-cite.el
5915 * x-face-mule:: x-face-mule.el
5916 * dired-dd:: dired-dd.el
5921 @node imput, BBDB, Living with other packages, Living with other packages
5926 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5929 If @command{imput} is on the @code{exec-path} at the installation,
5930 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
5934 (autoload 'wl-draft-send-with-imput-async "im-wl")
5935 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
5940 @node BBDB, supercite, imput, Living with other packages
5944 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
5947 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
5948 byte-compiled and installed.
5956 ;; @r{enable pop-ups}
5957 (setq bbdb-use-pop-up t)
5958 ;; @r{auto collection}
5959 (setq bbdb/mail-auto-create-p t)
5960 (setq signature-use-bbdb t)
5961 (setq bbdb-north-american-phone-numbers-p nil)
5962 ;; @r{shows the name of bbdb in the summary} :-)
5963 (setq wl-summary-from-function 'bbdb-wl-from-func)
5964 ;; @r{automatically add mailing list fields}
5965 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
5966 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
5970 @node supercite, mu-cite, BBDB, Living with other packages
5971 @subsection sc.el(supercite), sc-register.el
5975 The same setting as usual mailers should be OK. The following is an
5976 example of settings:
5980 (autoload 'sc-cite-original "sc" nil t)
5981 (setq mail-yank-hooks 'sc-cite-original)
5982 (setq sc-preferred-header-style 1)
5983 (setq sc-electric-references-p nil)
5984 (setq sc-citation-leader "")
5985 (setq sc-load-hook '(lambda () (require 'sc-register)))
5986 (setq sc-preferred-attribution 'registeredname)
5991 @node mu-cite, x-face-mule, supercite, Living with other packages
5992 @subsection mu-cite.el
5995 The same setting as usual mailers should be OK. The following is an
5996 example of settings.
5998 If you use mu-cite version 8.0 or earlier:
6002 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6003 (setq mail-citation-hook 'mu-cite/cite-original)
6007 If you use mu-cite version 8.1 or later:
6011 (autoload 'mu-cite-original "mu-cite" nil t)
6012 (add-hook 'mail-citation-hook (function mu-cite-original))
6016 @node x-face-mule, dired-dd, mu-cite, Living with other packages
6017 @subsection x-face-mule.el
6021 It depends on the version of x-face-mule.
6022 If you use x-face-mule 0.19 or older, do the following:
6026 (setq wl-highlight-x-face-function
6028 (lambda (&optional beg end)
6029 (x-face-mule:x-face-decode-message-header))))
6030 (require 'x-face-mule)
6034 If you use x-face-mule 0.20 or later, try the following:
6038 (setq wl-highlight-x-face-function
6040 (lambda (&optional beg end)
6041 (x-face-mule-x-face-decode-message-header))))
6042 (require 'x-face-mule)
6046 Use these settings when you use @file{x-face-mule.el} attached to
6047 bitmap-mule 8.0 or later:
6051 (autoload 'x-face-decode-message-header "x-face-mule")
6052 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6056 If there is an encoded X-Face string in a file @file{~/.xface} (the
6057 value of the variable @code{wl-x-face-file}), it is inserted as a
6058 @samp{X-Face:} field in the draft buffer (if
6059 @code{wl-auto-insert-x-face} is non-nil).
6062 @node dired-dd, MHC, x-face-mule, Living with other packages
6063 @subsection dired-dd(Dired-DragDrop)
6064 @pindex Dired-DragDrop
6066 @cindex Drag and Drop
6068 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6069 compose multi-part by simple Drag-and-Drop from dired to the draft
6070 buffer being edited in GNU Emacs (this feature is not Wanderlust
6071 specific, but general-purpose for tm/SEMI).
6075 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6081 ;; @r{Set dired-x variables here.}
6082 ;; @r{To and flo@dots{}}
6084 (progn (require 'dired-dd)
6085 (require 'dired-dd-mime))))))
6089 @node MHC, , dired-dd, Living with other packages
6093 Message Harmonized Calendaring system
6094 (@uref{http://www.quickhack.net/mhc/})
6096 By using MHC, you can make a calendar from the messages.
6102 (setq mhc-mailer-package 'wl)
6103 (autoload 'mhc-mode "mhc" nil t)
6104 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6105 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6113 (autoload 'mhc-wl-setup "mhc-wl")
6114 (add-hook 'wl-init-hook 'mhc-wl-setup)
6118 @node Highlights, Biff, Living with other packages, Customization
6121 @subsection Customizable Variables
6124 @item wl-summary-highlight
6125 @vindex wl-summary-highlight
6126 The initial setting is @code{t}.
6127 If non-nil, the summary is highlighted.
6129 @item wl-highlight-max-summary-lines
6130 @vindex wl-highlight-max-summary-lines
6131 The initial setting is 10000.
6132 The summary is not highlighted if it has more lines than this value.
6134 @item wl-summary-highlight-partial-threshold
6135 @vindex wl-summary-highlight-partial-threshold
6136 The initial setting is 1000.
6137 This is a threshold whether the whole summary is highlighted.
6138 If there are more lines of messages in the summary, it is partially
6141 @item wl-summary-partial-highlight-above-lines
6142 @vindex wl-summary-partial-highlight-above-lines
6143 The initial setting is 30. If there are more lines of messages than
6144 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6145 after the point that is the same number of lines as this value above the
6146 cursor line are highlighted partially. (If this value is @code{nil},
6147 the last same number of lines as the value of
6148 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6150 @item wl-highlight-body-too
6151 @vindex wl-highlight-body-too
6152 The initial setting is @code{t}.
6153 If non-nil, bodies of drafts and messages are also highlighted.
6155 @item wl-highlight-message-header-alist
6156 @vindex wl-highlight-message-header-alist
6157 When highlighting headers of drafts and messages, this variable
6158 specifies which faces are allocated to important
6159 (@code{wl-highlight-message-important-header-contents}), secondly
6160 important (@code{wl-highlight-message-important-header-contents2}), and
6161 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6163 Similarly, it can be used for allocating arbitrary faces to arbitrary
6164 regular expressions.
6166 @item wl-highlight-citation-prefix-regexp
6167 @vindex wl-highlight-citation-prefix-regexp
6168 Specifies a regular expression to which quoted lines in bodies of
6169 drafts and messages match.
6170 Bodies matching to this regular expression are highlighted by the faces
6171 specified by (@code{wl-highlight-message-cited-text-*}).
6173 @item wl-highlight-highlight-citation-too
6174 @vindex wl-highlight-highlight-citation-too
6175 The initial setting is @code{nil}.
6176 If non-nil, the quoting regular expression itself given by
6177 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6179 @item wl-highlight-citation-header-regexp
6180 @vindex wl-highlight-citation-header-regexp
6181 Specifies a regular expression that denotes beginning of quotation.
6182 Bodies matching to this regular expression are highlighted by the face
6183 specified by @code{wl-highlight-message-headers}.
6185 @item wl-highlight-max-header-size
6186 @vindex wl-highlight-max-header-size
6187 The initial setting is @code{nil}. If a header size is larger than this
6188 value, it will not be highlighted. If @code{nil}, always highlighted
6189 (ignore header size).
6191 @item wl-highlight-max-message-size
6192 @vindex wl-highlight-max-message-size
6193 The initial setting is 10000.
6194 If a message is larger than this value, it will not be highlighted.
6195 With this variable, highlight is suppressed for uuencode or huge digest
6198 @item wl-highlight-signature-separator
6199 @vindex wl-highlight-signature-separator
6200 Specifies regular expressions that denotes the boundary of a signature.
6201 It can be a regular expression, or a list of ones.
6202 Messages after the place that matches this regular expression are
6203 highlighted by the face specified by
6204 @code{wl-highlight-message-signature}.
6206 @item wl-max-signature-size
6207 @vindex wl-max-signature-size
6208 The initial setting is 400.
6209 This is the largest size for a signature to be highlighted.
6211 @item wl-use-highlight-mouse-line
6212 @vindex wl-use-highlight-mouse-line
6213 The initial setting is @code{t}.
6214 If non-nil, the line pointed by the mouse is highlighted in the folder
6215 mode, summary mode, and the like.
6218 @subsection Setting Colors and Fonts of the Characters
6220 If you want to change colors or fonts of the characters, you need to
6221 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6222 want to change fonts, and @code{set-face-foreground} for colors, and so
6223 on. You cannot write face settings in @file{.emacs}; write in
6226 For example, if you want to change the color for signatures to yellow,
6230 (set-face-foreground 'wl-highlight-message-signature "yellow")
6236 Faces defined in Wanderlust:
6239 @item wl-highlight-message-headers
6240 The face for field names of message headers.
6242 @item wl-highlight-message-header-contents
6243 The face for field bodies of message headers.
6245 @item wl-highlight-message-important-header-contents
6246 The face for important parts of message headers.
6247 Per default, this face is used for a body of @samp{Subject:} field.
6248 You can change its value by editing
6249 @code{wl-highlight-message-header-alist}.
6251 @item wl-highlight-message-important-header-contents2
6252 The face for secondly important parts of message headers.
6253 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6254 fields. You can change its value by editing
6255 @code{wl-highlight-message-header-alist}.
6257 @item wl-highlight-message-unimportant-header-contents
6258 The face for unimportant parts of message headers.
6259 Per default, this face is used for bodies of @samp{X-} fields
6260 @samp{User-Agent:} fields. You can change its value by editing
6261 @code{wl-highlight-message-header-alist}.
6263 @item wl-highlight-message-citation-header
6264 The face for headers of quoted messages.
6266 @item wl-highlight-message-cited-text-*
6267 The face for texts of quoted messages. The last @samp{*} is a
6268 @var{single figure} so that 10 different colors can be used according to
6271 @item wl-highlight-message-signature
6272 The face for signatures of messages. The initial settings are
6273 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6274 dark background colors.
6276 @item wl-highlight-header-separator-face
6277 The face for header separators of draft messages.
6279 @item wl-highlight-summary-important-face
6280 The face for message lines with important marks in the summary.
6282 @item wl-highlight-summary-new-face
6283 The face for message lines with new marks in the summary.
6285 @item wl-highlight-summary-displaying-face
6286 The face for the message line that is currently displayed.
6287 This face is overlaid.
6289 @item wl-highlight-thread-indent-face
6290 The face for the threads that is currently displayed.
6292 @item wl-highlight-summary-unread-face
6293 The face for message lines with unread marks in the summary.
6295 @item wl-highlight-summary-deleted-face
6296 The face for message lines with delete marks in the summary.
6298 @item wl-highlight-summary-refiled-face
6299 The face for message lines with re-file marks in the summary.
6301 @item wl-highlight-refile-destination-face
6302 The face for re-file information part of message lines with re-file
6303 marks in the summary.
6305 @item wl-highlight-summary-copied-face
6306 The face for message lines with copy marks in the summary.
6308 @item wl-highlight-summary-target-face
6309 The face for message lines with target marks @samp{*} in the summary.
6311 @item wl-highlight-summary-thread-top-face
6312 The face for message lines that are on the top of the thread in the
6315 @item wl-highlight-summary-normal-face
6316 The face for message lines that are not on top of the thread in the
6319 @item wl-highlight-folder-unknown-face
6320 The face for folders that are not known to have how many unsync messages
6323 @item wl-highlight-folder-zero-face
6324 The face for folders that have no unsync messages in the folder mode.
6326 @item wl-highlight-folder-few-face
6327 The face for folders that have some unsync messages in the folder mode.
6329 @item wl-highlight-folder-many-face
6330 The face for folders that have many unsync messages in the folder mode.
6331 The boundary between `some' and `many' is specified by the variable
6332 @code{wl-folder-many-unsync-threshold}.
6334 @item wl-highlight-folder-unread-face
6335 The face for folders that have no unsync but unread messages in the
6338 @item wl-highlight-folder-killed-face
6339 The face for folders that are deleted from the access group in the
6342 @item wl-highlight-folder-opened-face
6343 The face for open groups in the folder mode.
6344 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6345 @code{nil} or a @var{number}.
6347 @item wl-highlight-folder-closed-face
6348 The face for close groups in the folder mode.
6349 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6350 @code{nil} or a @var{number}.
6352 @item wl-highlight-folder-path-face
6353 The face for the path to the currently selected folder in the folder
6356 @item wl-highlight-logo-face
6357 The face for logo in the demo.
6359 @item wl-highlight-demo-face
6360 The face for strings (for example, a version number) in the demo.
6364 @node Biff, Advanced Settings, Highlights, Customization
6365 @section Notify Mail arrival
6368 Following setting is to notify mail arrival of @samp{%inbox}
6369 by the indicator on the modeline
6372 (setq wl-biff-check-folder-list '("%inbox"))
6375 @subsection Customizable Variables
6377 @item wl-biff-check-folder-list
6378 @vindex wl-biff-check-folder-list
6379 The initial setting is @code{nil}.
6380 This is the list of folders to check mail arrival.
6381 If @code{nil}, wl doesn't check mail arrival.
6383 @item wl-biff-check-interval
6384 @vindex wl-biff-check-interval
6385 The initial setting is 40 (in seconds).
6386 Check mail arrival in this period.
6388 @item wl-biff-notify-hook
6389 @vindex wl-biff-notify-hook
6390 The initial setting is @code{nil}.
6391 This is a hook run at the arrival of the new mail.
6394 (setq wl-biff-notify-hook '(beep))
6399 @node Advanced Settings, Customizable Variables, Biff, Customization
6400 @section Advanced Settings
6403 * Draft for Reply:: Draft for Reply
6404 * Thread Format:: Appearance of Thread
6405 * User-Agent Field:: @samp{User-Agent:} Header Field
6409 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6410 @subsection Draft for Replay
6411 @vindex wl-draft-reply-with-argument-list
6412 @vindex wl-draft-reply-without-argument-list
6413 @vindex wl-draft-reply-myself-with-argument-list
6414 @vindex wl-draft-reply-myself-without-argument-list
6416 If you want, when you replying to articles in mailing lists, the address
6417 in Reply-To field of the original message to be prepared to To field of
6418 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6423 (setq wl-draft-reply-without-argument-list
6424 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6425 ("Followup-To" . (nil nil ("Followup-To")))
6426 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6427 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6432 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6433 in the original message, @samp{Reply-To:} field in the original is
6434 copied to @samp{To:} field.)
6436 Moreover, the behavior of @kbd{a} with prefix argument can
6437 be directed by @code{wl-draft-reply-with-argument-list} as well.
6439 Note: To set the behavior when you reply to the message written by yourself, use
6440 @code{wl-draft-reply-myself-without-argument-list} and
6441 @code{wl-draft-reply-myself-with-argument-list}
6444 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6445 @subsection Appearance of Threads
6449 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6450 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6451 391 09/18(Fri)19:24 +-[ Murata-san ]
6452 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6453 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6454 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6455 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6456 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6457 412 09/22(Tue)09:28 | +-[ Teranishi ]
6458 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6459 416 09/22(Tue)12:38 | +-[ Teranishi ]
6460 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6461 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6465 Settings to make appearance of threads like shown above:
6469 (setq wl-thread-indent-level 2)
6470 (setq wl-thread-have-younger-brother-str "+")
6471 (setq wl-thread-youngest-child-str "+")
6472 (setq wl-thread-vertical-str "|")
6473 (setq wl-thread-horizontal-str "-")
6474 (setq wl-thread-space-str " ")
6478 If you do not want to see branches, do the following:
6482 (setq wl-thread-indent-level 2)
6483 (setq wl-thread-have-younger-brother-str " ")
6484 (setq wl-thread-youngest-child-str " ")
6485 (setq wl-thread-vertical-str " ")
6486 (setq wl-thread-horizontal-str " ")
6487 (setq wl-thread-space-str " ")
6492 @node User-Agent Field, , Thread Format, Advanced Settings
6493 @subsection User-Agent Field
6497 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6498 @samp{User-Agent:} fields, define a function that generate appropriate
6499 strings as you like, and set it to variable
6500 @code{wl-generate-mailer-string-function}.
6502 If you do not want verbose @samp{User-Agent:} field, do the following:
6506 (setq wl-generate-mailer-string-function
6509 (concat "User-Agent: "
6510 (wl-generate-user-agent-string-1 nil)))))
6514 The following is a example:
6518 (setq mime-edit-insert-user-agent-field nil)
6519 (setq wl-generate-mailer-string-function
6522 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6527 @node Customizable Variables, Hooks, Advanced Settings, Customization
6528 @section Customizable Variables
6530 Customizable variables that have not been described yet:
6533 @item wl-default-folder
6534 @vindex wl-default-folder
6535 The initial setting is @samp{%inbox}. This is the default value for moving to
6536 a folder and the like.
6538 @item wl-draft-folder
6539 @vindex wl-draft-folder
6540 The initial setting is @samp{+draft}. It is the folder to which drafts are
6541 saved. It must be a localdir folder.
6543 @item wl-trash-folder
6544 @vindex wl-trash-folder
6545 The initial setting is @samp{+trash}. It is the wastebasket folder.
6546 If you changed this variable, you had better restart Wanderlust.
6548 @item wl-interactive-exit
6549 @vindex wl-interactive-exit
6550 The initial setting is @code{t}.
6551 If non-nil, you are asked for confirmation when Wanderlust terminates.
6553 @item wl-interactive-send
6554 @vindex wl-interactive-send
6555 The initial setting is @code{nil}.
6556 If non-nil, you are asked for confirmation when mail is sent.
6558 @item wl-folder-sync-range-alist
6559 @vindex wl-folder-sync-range-alist
6560 The initial setting is the alist shown below:
6565 ("^\\+draft$\\|^\\+queue$" . "all"))
6570 This is an associative list of regular expressions of folder names and
6571 update range of the summary. Update range is one of the @samp{all},
6572 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6573 @samp{last}. If a folder do not match, @samp{update} is used.
6576 @vindex wl-ask-range
6577 The initial setting is @code{t}.
6578 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6579 for updating the summary when you changed folders.
6581 @item wl-mime-charset
6582 @vindex wl-mime-charset
6583 The initial setting is @code{x-ctext}.
6584 This is the MIME charset for messages that are not MIME (e.g. without
6585 @samp{Content-Type:}). This value also used as default charset for
6586 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6587 this value as @code{iso-2022-jp}.)
6589 @item wl-highlight-folder-with-icon
6590 @vindex wl-highlight-folder-with-icon
6591 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6592 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6594 @item wl-strict-diff-folders
6595 @vindex wl-strict-diff-folders
6596 This is a list of regular expressions of folders.
6597 Unread messages are checked, for example when you press @kbd{s} in
6598 the folder mode, usually in a brief way (rapidly processed but not
6600 The folders matching this variable are seriously checked.
6601 You may want to set this variable so as to match conditional filter
6602 folders for IMAP4 folders.
6603 The initial setting is @code{nil}.
6605 @item wl-folder-use-server-diff
6606 @vindex wl-folder-use-server-diff
6607 When unread messages are checked, for example when you press @kbd{s} in
6608 the folder mode, usually (the number of messages on the server) @minus{}
6609 (the number of local messages) will be the number of unread messages.
6610 However, if this variable is non-nil, the number of unread messages on
6611 the server is checked. This affects IMAP4 folders only, but IMAP4
6612 folders in mail boxes matching
6613 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6614 the number of unread messages on the server, even if they matches this
6615 variable. The initial setting is @code{t}.
6617 @item wl-auto-check-folder-name
6618 @vindex wl-auto-check-folder-name
6619 The initial setting is @code{nil}.
6620 If non-nil, the folder with the name of the value is checked for unread
6621 messages at the start.
6622 If it is @code{none}, no folders are checked.
6623 If it is a list, all folders in the list are checked at the start.
6625 @item wl-auto-uncheck-folder-list
6626 @vindex wl-auto-uncheck-folder-list
6627 The initial setting is the list shown below:
6636 Folders with the name matching this variable are not checked for unread
6637 messages at the start, even if they are included in the groups in
6638 @code{wl-auto-check-folder-name}.
6640 @item wl-auto-check-folder-list
6641 @vindex wl-auto-check-folder-list
6642 The initial setting is @code{nil}.
6643 Folders with the name matching this variable are always checked for
6644 unread messages at the start, if they are included in the groups in
6645 @code{wl-auto-check-folder-name}.
6646 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6648 @item wl-no-save-folder-list
6649 @vindex wl-no-save-folder-list
6650 The initial setting is the list shown below:
6659 This is a list of regular expressions of folders not to be saved.
6661 @item wl-save-folder-list
6662 @vindex wl-save-folder-list
6663 The initial setting is @code{nil}.
6664 This is a list of regular expressions of folders to be saved.
6665 This takes precedence over @code{wl-no-save-folder-list}.
6667 @item wl-folder-mime-charset-alist
6668 @vindex wl-folder-mime-charset-alist
6669 The initial setting is the alist shown below:
6673 (("^-alt\\.chinese" . big5)
6674 ("^-relcom\\." . koi8-r)
6676 ("^-han\\." . euc-kr))
6681 This is an associative list of regular expressions of folder names and
6683 If a folder do not match, @code{wl-mime-charset} is used.
6685 @item wl-folder-init-load-access-folders
6686 @vindex wl-folder-init-load-access-folders
6687 The initial setting is @code{nil}.
6688 This is a list of access groups to be loaded specifically at the start.
6689 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6691 @item wl-folder-init-no-load-access-folders
6692 @vindex wl-folder-init-no-load-access-folders
6693 The initial setting is @code{nil}.
6694 This is a list of access groups not to be loaded specifically at the
6696 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6698 @item wl-delete-folder-alist
6699 @vindex wl-delete-folder-alist
6700 The initial setting is the alist shown below:
6709 This list determines disposition of messages with delete marks.
6710 Each item in the list is a folder and destination; you can specify any
6711 one of the following in the place of destination:
6714 @code{remove} or @code{null} : deletes the messages instantly.
6715 string : moves the messages to the specific folder.
6716 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
6719 @item wl-refile-policy-alist
6720 @vindex wl-refile-policy-alist
6721 The initial setting is the list shown below:
6731 This list determines whether messages with re-file marks are moved or
6732 copied. Each item in the list is a cons cell of a folder and
6733 @code{copy} or @code{move}.
6735 @item wl-x-face-file
6736 @vindex wl-x-face-file
6737 The initial setting is @file{~/.xface}.
6738 The name of the file that contains encoded X-Face strings.
6741 @item wl-demo-display-logo
6742 @vindex wl-demo-display-logo
6743 If non-nil, bitmap image is shown on the opening demo. If you set
6744 @code{xpm} or @code{xbm}, (if possible) display selected image type
6747 @item elmo-use-database
6748 @vindex elmo-use-database
6749 This is meaningful for XEmacs only. The initial setting depends on
6750 XEmacs (@code{t} for XEmacs with dbm).
6751 If non-nil, Message-ID is controlled by dbm.
6753 @item elmo-passwd-alist-file-name
6754 @vindex elmo-passwd-alist-file-name
6755 The initial setting is @file{passwd}.
6756 This is the name of the file in which passwords are saved.
6757 @code{elmo-passwd-alist-save} saves current passwords to the file.
6759 @item elmo-nntp-list-folders-use-cache
6760 @vindex elmo-nntp-list-folders-use-cache
6761 The initial setting is 600 (in seconds).
6762 This is period in seconds during which results of @samp{list} and
6763 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6766 @item elmo-nntp-max-number-precedes-list-active
6767 @vindex elmo-nntp-max-number-precedes-list-active
6768 The initial setting is @code{nil}.
6769 If non-nil, the number of article obtained by @samp{list active} in NNTP
6770 are used as the maximum article number of the folder.
6771 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6772 and if the number of read messages is not correct.
6774 @item elmo-nntp-default-use-listgroup
6775 @vindex elmo-nntp-default-use-listgroup
6776 The initial setting is @code{t}.
6777 If non-nil, @samp{listgroup} is used for checking the total number of
6778 articles. If it is @code{nil}, @samp{group} is used. In the latter
6779 case, the processing will be a little faster at the sacrifice of
6782 @item elmo-pop3-send-command-synchronously
6783 @vindex elmo-pop3-send-command-synchronously
6784 The initial setting is @code{nil}.
6785 If non-nil, POP3 commands are issued synchronously. Some implementation
6786 of POP3 server fails to get summary information without this setting.
6787 You may have to set this variable to @code{t}, if the process hangs
6788 while looking up POP3.
6790 @item elmo-dop-flush-confirm
6791 @vindex elmo-dop-flush-confirm
6792 The initial setting is @code{t}.
6793 If non-nil, you are asked for confirmation if accumulated off-line
6794 operations are executed.
6796 @item elmo-display-progress-threshold
6797 @vindex elmo-display-progress-threshold
6798 The initial setting is 20.
6799 Threshold for display of progress gauge. If number of renewal is more than
6800 this value, display progress gauge.
6804 @node Hooks, , Customizable Variables, Customization
6810 @node Mailing List, Addition, Customization, Top
6811 @chapter Wanderlust Mailing List
6816 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6819 Topics related to Wanderlust are discussed in the mailing list.
6820 The latest version is also announced there (in Japanese, sorry).
6822 A guide can be obtained automatically by sending mail to
6823 @t{wl-ctl@@lists.airs.net} with the body
6828 Please send bug reports or patches to the mailing list. You can post to
6829 the mailing list even though you are not a member of it.
6831 If you send a bug report, please attach Backtrace with it.
6832 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
6835 I would like to express my thanks to the members of the mailing list for
6836 valuable advice and many pieces of code they contributed.
6839 @node Addition, Index, Mailing List, Top
6840 @chapter Additional Information
6842 @section Brief History
6845 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6846 3/10 Made a msgdb mechanism by elisp.
6847 3/26 IMAP and NNTP can be displayed in threads.
6848 4/13 Began to assemble thread display modules as elmo.
6849 5/01 Finished 0.1.0, initial version with many defects.
6850 6/12 I made a slip of the tongue and said I was writing elisp
6851 mailer supporting IMAP
6852 6/16 0.1.3 was announced at tm-ja, elisp ML.
6853 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6854 7/01 Support for mm-backend (0.3.0).
6855 8/25 multi folder added (0.5.0).
6856 8/28 filter folder added (0.5.1).
6857 9/10 You can open/close threads (0.6.0).
6858 9/11 fldmgr by Murata-san made editing folders easy.
6859 9/18 lha folders added by Okunishi-san (0.6.3).
6860 9/24 Display of branches of threads (0.6.5).
6861 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6862 10/28 Off-line operations (0.7.4).
6863 12/09 Becomes beta version.
6864 12/21 wl-expire by Murata-san.
6865 1999 2/03 auto-refile by Tsumura-san.
6866 4/28 wl-template by Murata-san.
6867 5/18 Released 1.0.0 stable.
6868 7/05 Scoring by Murata-san (2.1.0).
6869 9/26 New plugged system by Murata-san (2.2.2).
6870 12/20 Support Modified UTF7.
6871 2000 3/24 Released 1.1.0 stable.
6872 4/03 CVS development started.
6873 5/07 Thread restoration & Its speed up with Murata-san.
6874 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6875 7/11 killed message feature.
6876 7/18 Use UIDL in POP3.
6877 9/12 biff feature with Satata-san & Yamaoka-san.
6878 10/17 expire-hide by Okada-san.
6879 11/08 Released 2.4.0 stable.
6880 2001 7/04 Released 2.6.0 stable.
6881 8/21 wl-addrmgr by Kitamoto-san.
6884 See @file{ChangeLog} for details.
6888 According to a dictionary, Wanderlust has the meaning:
6892 n eager longing for or impulse towards travelling in distant lands
6893 [Ger, fr wandern to wander + lust desire, pleasure]
6897 but I had no profound intention. (if farfetched, IMAP @result{} you can
6898 read mail anywhere @result{} desire to wander ?)
6900 Elmo is the abbreviation of @samp{Elisp Library for Message
6901 Orchestration}. At first I meant the red puppet in the Sesame Street,
6902 but you may associate it with Wandering @result{} Drifting @result{}
6903 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6907 Each versions has code names (they are almost jokes).
6908 Currently they are picked up alphabetically from the top 40 hits of
6909 U.S. Billboard magazines in 1980s.
6911 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
6914 @node Index, , Addition, Top
6918 * Concept Index:: Concept Index
6919 * Key Index:: Key Index
6920 * Variable Index:: Variable Index
6921 * Function Index:: Function Index
6924 @node Concept Index, Key Index, Index, Index
6925 @unnumberedsec Concept Index
6928 @node Key Index, Variable Index, Concept Index, Index
6929 @unnumberedsec Key Index
6932 @node Variable Index, Function Index, Key Index, Index
6933 @unnumberedsec Variable Index
6936 @node Function Index, , Variable Index, Index
6937 @unnumberedsec Function Index