1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
26 This edition is for Wanderlust version @value{VERSION}.
28 Permission is granted to make and distribute verbatim copies of this
29 manual provided the copyright notice and this permission notice are
30 preserved on all copies.
33 Permission is granted to process this file through TeX and print the
34 results, provided the printed document carries copying permission notice
35 identical to this one except for the removal of this paragraph (this
36 paragraph not being relevant to the printed manual).
39 Permission is granted to copy and distribute modified versions of this
40 manual under the conditions for verbatim copying, provided that the
41 entire resulting derived work is distributed under the terms of a
42 permission notice identical to this one.
44 Permission is granted to copy and distribute translations of this manual
45 into another language, under the above conditions for modified versions.
51 @title Wanderlust User's Manual
52 @subtitle Yet another message interface on Emacsen
53 @subtitle for Wanderlust version @value{VERSION}
54 @author Yuuichi Teranishi
55 @author Fujikazu Okunishi
56 @author Masahiro Murata
58 @author Kaoru Takahashi
60 @author Masayuki Osada
63 @vskip 0pt plus 1filll
64 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
65 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
66 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
68 This manual is for Wanderlust version @value{VERSION}.
70 Permission is granted to make and distribute verbatim copies of this
71 manual provided the copyright notice and this permission notice are
72 preserved on all copies.
74 Permission is granted to copy and distribute modified versions of this
75 manual under the conditions for verbatim copying, provided that the
76 entire resulting derived work is distributed under the terms of a
77 permission notice identical to this one.
79 Permission is granted to copy and distribute translations of this manual
80 into another language, under the above conditions for modified versions.
86 @node Top, Introduction, (dir), (dir)
87 @top Wanderlust User's Manual
99 This manual is for Wanderlust @value{VERSION}.
104 * Introduction:: Read this first.
105 * Start Me Up:: Invoking Wanderlust.
106 * Folders:: How to specify folders.
107 * Folder:: Selecting and editing folders.
108 * Summary:: Reading and refiling messages.
109 * Message:: Saving and playing MIME multipart entities.
110 * Draft:: Draft buffer, sending mail and news.
111 * Disconnected Operations:: Off-Line management
112 * Expire and Archive:: Automatic expiration and archiving of messages.
113 * Scoring:: Score of the messages.
114 * Customization:: Customizing Wanderlust.
115 * Mailing List:: Wanderlust mailing list
116 * Addition:: Additional Information
121 @node Introduction, Start Me Up, Top, Top
122 @chapter Introduction of Wanderlust
125 Wanderlust is an mail/news management system on Emacsen.
126 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
128 The main features of Wanderlust:
131 @item Pure elisp implementation.
132 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
133 @item Unified access method to messages based on Mew-like Folder Specification.
134 @item Mew-like Key-bind and mark handling.
135 @item Manages unread messages.
136 @item Interactive thread display.
137 @item Folder Mode shows the list of subscribed folders.
138 @item Message Cache, Disconnected Operation (Read Only).
139 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
140 @item MIME compliant (by SEMI or tm).
141 @item Transmission of news and mail are unified by Message transmitting draft.
142 @item Graphical list of folders (XEmacs and Emacs 21).
143 @item View a part of message without retrieving the whole message (IMAP4).
144 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
145 @item Virtual Folders.
146 @item Supports compressed folder using common archiving utilities.
147 @item Old articles in folders are automatically removed/archived (Expiration).
148 @item Automatic re-file.
149 @item Template function makes it convenient to send fixed form messages.
155 Wanderlust is supposed to run on following Emacsen:
156 @c Wanderlust runs even on Nemacs 3.3.2 based on Emacs 18.55, 18.59 (with
157 @c limited functionality).
160 @item Nemacs 3.3.2 (Caution: limited functionality)
161 @item Mule 2.3 based on Emacs 19.28
162 @item Mule 2.3 based on Emacs 19.34
163 @item Emacs 20.2 or later
164 @item XEmacs 20.4 or later
165 @item Meadow 1.00 or later
166 @item Mule for Windows v1.22
167 @item NTEmacs 20.4 or later
171 IMAP4 connectivity with following imapd are confirmed to work with
175 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
176 @item Cyrus imapd 1.4, 1.5.19, 1.6.22, 2.0.5 or later
177 @item AIR MAIL (AIRC imapd release 2.00)
179 @item Microsoft Exchange Server 5.5
180 @item Sun Internet Mail Server 4.0
183 @c LDAP connectivity with following LDAPd are confirmed to work with
187 @node Start Me Up, Folders, Introduction, Top
188 @chapter Start up Wanderlust
191 The necessary procedure for starting Wanderlust is explained in steps
194 (Of course, you need a mail/news readable environment in advance)
197 * MIME Modules:: Installing the MIME modules.
198 * Download:: Download and extract the packages.
199 * Install:: Byte-compile and install.
200 * Minimal Settings:: @file{.emacs} setup.
201 * Mail Addresses:: Address book definition.
202 * Folder Definition:: Folder definition.
203 * Start Wanderlust:: Starting Wanderlust
207 @node MIME Modules, Download, Start Me Up, Start Me Up
208 @section Installing MIME modules
215 SEMI or tm must be installed to make Wanderlust work correctly.
217 SEMI does not run on Emacs 19.28 or earlier
218 @footnote{SEMI runs on Emacs 19.34. @*
219 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} describes how to.},
220 so you must install tm, the predecessor of SEMI. (tm version 8.7 or later
223 However, SEMI is recommended because of its wider functionality.
225 Refer to the documents of each package for detailed installation procedure.
227 SEMI and tm can be downloaded from these sites:
231 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
232 tm: http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
236 You need packages named APEL and FLIM to use SEMI.
237 You can download APEL and FLIM from following URLs:
241 APEL: ftp://ftp.m17n.org/pub/mule/apel/
242 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
246 You have to install APEL, FLIM and SEMI in this order. Generally,
247 @samp{make install} will do the job. (In XEmacs 21, @samp{make
250 Recommended combination of APEL, FLIM and SEMI are following:
253 @item APEL 10.3, FLIM 1.14.2 and SEMI 1.14.3
256 You can also use many other FLIM/SEMI variants. Combination of the
257 latest versions should work. For example, the following combination are
261 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
262 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
265 You have to re-install Wanderlust if you upgraded APEL, FLIM, SEMI or
269 @node Download, Install, MIME Modules, Start Me Up
270 @section Download and Extract the Package
273 You can download Wanderlust package from following sites:
277 ftp://ftp.gohome.org/wl/
280 Mirrored ftp/http sites:
284 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
285 http://www.jpl.org/elips/wl/
286 http://www.ring.gr.jp/archives/text/elisp/wl/
287 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
288 ftp://opaopa.org/pub/mirror/elisp/wl/
289 @c ftp://roguelife.org/pub/tsumura/wl/
293 Extract the obtained package to your working directory:
298 % tar zxvf wl-@var{version}.tar.gz
299 % cd wl-@var{version}
303 @subsection To use SSL (Secure Socket Layer)
308 SSL (Secure Socket Layer) can be used for
309 SMTP, IMAP, NNTP and POP connections in Wanderlust.
311 There are two ways to use SSL. One is to start SSL negotiation just
312 after the connection establishment (generic way). The other one is to
313 start SSL negotiation by invoking STARTTLS command in the each session.
315 To use the formal SSL (generic SSL), you must install @file{ssl.el} in
316 the @file{utils} directory. OpenSSL command @command{openssl} is also
317 required to use @file{ssl.el}. You must set @env{PATH} to the directory
318 that OpenSSL commands are installed.
320 To use the latter SSL(STARTTLS), you must install starttls package in
322 You can download starttls package from the following site.
325 ftp://opaopa.org/pub/elisp/
328 @node Install, Minimal Settings, Download, Start Me Up
329 @section Byte-compile and install
336 @subsection Installation
338 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
339 Set the Emacs's command name to @code{EMACS}.
340 Set package installation directory to @code{LISPDIR}.
341 Then, please execute following commands.
350 Destination directory is auto-probed if you leave @code{LISPDIR}
351 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
353 If you are using an Emacs variant which does not merge specified directory
354 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
355 then you will see the error message:
358 Cannot open load file: mime-setup
362 In this case, either add destination directories of custom, APEL, FLIM
363 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
364 @code{load-path} in @file{WL-CFG} in extracted directory.
366 If you want to use BBDB, then the necessary modules are byte-compiled
367 and installed when BBDB directory is added to @code{load-path}.
370 @subsection @file{WL-CFG}
372 Contents of the file @file{WL-CFG} is loaded under installation if a file
373 with that name exists in extracted directory. You can use @file{WL-CFG} to
374 configure @code{load-path} to extra packages such as SEMI if needed.
376 If you want to specify the install directory of Wanderlust related
377 files, then set following variables in @file{WL-CFG}
381 A directory to install WL modules.
382 This directory is relative directory from @code{LISPDIR}.
383 WL modules include @file{wl*.el}, @file{wl*.elc} files.
384 @c Modules under the directory @file{util/} are also installed if
385 @c it detected as necessary.
388 A directory to install ELMO modules.
389 This directory is relative directory from @code{LISPDIR}.
390 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
391 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
395 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
397 If you want to install ELMO related files under a sub-directory
398 such as "elmo" then add following to @file{WL-CFG}:
401 (setq ELMO_PREFIX "elmo")
404 @subsection Install as a XEmacs package
405 @cindex XEmacs package
406 @cindex XEmacs package install
407 @cindex Package, XEmacs
408 @cindex Package install, XEmacs
409 @c @cindex install-package
411 It is possible to install Wanderlust as one of packages of XEmacs (21.0
412 or later). Configuration for autoload and icon-path in local
413 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
416 Follow the next example to install Wanderlust as an XEmacs package.
422 % make install-package
426 package directory is auto-probed, if SEMI is installed.
427 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
429 @subsection Run in place
431 If wl and elmo directories are defined in @code{load-path}, then
432 byte-compilation and installation are not necessary to start Wanderlust.
433 For example, if package is extracted in @file{~/work}, Wanderlust can be
434 invoked with following setting in @file{~/.emacs}.
438 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
439 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
445 Manual is described in Info format. Please do following.
454 If you install Wanderlust as a XEmacs package, Info file is already
455 installed too, so there are no need of these commands.
457 Manual directory is automatically detected. Of course, it can be
458 configured by @code{INFODIR} in @file{Makefile}.
460 You can read manual at the following URL:
463 http://www.gohome.org/wl/doc/wl-euc_toc.html
466 @node Minimal Settings, Mail Addresses, Install, Start Me Up
467 @section Set up .emacs
468 @cindex Minimal Settings
470 @cindex Configuration
474 The Wanderlust package contains two module groups.
477 @item ELMO (elmo-*.el)
478 These modules show everything as folders. This is the back-end for WL.
480 These modules controls the behavior of main body of Wanderlust.
481 They are also the front-end for ELMO.
484 You can customize the behavior of Wanderlust by changing the value
485 of environmental variables which begins with @code{elmo-} and @code{wl-}.
487 The minimal requirement for settings is as the following.
491 ;; @r{The setting to use SEMI/tm}
494 ;; @r{autoload configuration}
495 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
496 (autoload 'wl "wl" "Wanderlust" t)
497 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
499 ;; @r{Directory where icons are placed (XEmacs or Emacs 21).}
500 ;; @r{Default: @code{nil}.}
501 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
502 (setq wl-icon-dir "~/work/wl/etc")
504 ;; @r{SMTP server for mail posting. Default: @code{nil}}
505 (setq wl-smtp-posting-server "your.smtp.example.com")
506 ;; @r{NNTP server for news posting. Default: @code{nil}}
507 (setq wl-nntp-posting-server "your.nntp.example.com")
511 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
512 file exists). So it is convenient to gather Wanderlust specific settings
513 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
514 because you can't write them in @file{.emacs}
515 (if you write it to @file{.emacs}, you'll get an error).
518 All above described settings except (load "mime-setup") and autoload
519 configuration can be written in
522 @subsection @code{mail-user-agent}
523 @cindex Default Mailer
524 @cindex Mailer, Default
525 @vindex mail-user-agent
528 If you write following setting in you @file{.emacs}, you can
529 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
530 This means it enables you to run Wanderlust as a default mail composer
533 It is effective only when your Emacs can define @code{mail-user-agent}.
534 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
538 (autoload 'wl-user-agent-compose "wl-draft" nil t)
539 (if (boundp 'mail-user-agent)
540 (setq mail-user-agent 'wl-user-agent))
541 (if (fboundp 'define-mail-user-agent)
542 (define-mail-user-agent
544 'wl-user-agent-compose
552 @node Mail Addresses, Folder Definition, Minimal Settings, Start Me Up
553 @section Address book
554 @cindex Address book Definition
556 @cindex Alias, Address
558 The file @file{~/.addresses} is a simple address book for Wanderlust.
559 Make address file @file{~/.addresses}, and edit to suit your requirement.
561 The data written in @file{~/.addresses} are used for address completion
562 under draft editing mode. Furthermore, they are used when showing names
563 in summary display mode. You can safely skip this section, if you don't
564 want to customize address completion and summary display.
565 It is possible to add/change/remove addresses from @file{~/.addresses} in
566 summary buffer after Wanderlust is invoked. @refill
568 The format is very simple. Like this. @refill
573 # @r{Lines begin with @samp{#} are comment.}
574 # @r{Empty lines are ignored}
576 # @r{Format of each line:}
577 # @var{email-address} "@var{nickname} "@var{realname}"
579 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
580 foo@@bar.gohome.org "Mr. Foo" "John Foo"
581 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
586 One line defines one persons description.
588 Actually, in default setup, @var{nickname} is used in summary-mode and
589 @var{realname} is used in draft preparation mode. This behavior is
590 better understood if you try it and confirmed the function first. You
591 can write and try a small definition, so you will know the idea of the
592 address book before writing a big one.
594 And, if MH alias file is specified in variable @code{wl-alias-file},
595 it is used as an address information in the draft preparation mode.
597 If variable @code{wl-use-ldap} is non-nil (initial setting is
598 @code{nil}), address completion in draft mode uses LDAP information.
600 If you use LDAP, you have to set @code{wl-ldap-server},
601 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
602 not have LDAP feature as built-in feature (Currently only XEmacs can
603 have built-in LDAP feature), you have to set command exec @env{PATH} to
604 the program @command{ldapsearch}.
606 @node Folder Definition, Start Wanderlust, Mail Addresses, Start Me Up
607 @section Folder Definition
608 @cindex Folder Definition
611 You can skip this section because it is possible to add/edit the
612 subscribe folders from the buffer for list of folders.
613 @xref{Folder Manager}.
615 Define the folders you want to subscribe in file @file{~/.folders}. The
616 contents written in @file{~/.folders} become the folders which you
617 subscribe to as it is.
619 Format for @file{~/.folders} is very simple. Here is an example:
624 # @r{Lines begin with @samp{#} are comment.}
625 # @r{Empty lines are ignored}
627 # @var{folder name} "@var{folder nickname}"
628 # @r{(nicknames are not necessary)}
633 %#mh/Backup@@my.imap.example.com "Sent"
636 %#mh/spool/wl "Wanderlust ML"
637 %#mh/spool/elips "ELIPS ML"
638 %#mh/spool/apel-ja "APEL Japanese ML"
639 %#mh/spool/xemacs-beta "XEmacs beta"
640 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
641 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
644 # @r{If folder name ends with @samp{/}, that means an `access group',}
645 # @r{all subfolders automatically included in one folder group.}
647 %#mh/expire@@localhost /
648 # @r{All MH folders are included in one folder group.}
653 Each line contains one folder you want to read. The definition of
654 folders will be explained in detail in the next section.
656 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
657 become one folder group. One folder group is treated as a directory
658 which can bed opened and closed in folder mode. It is convenient for
659 collecting some folders and putting them in order.
661 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
662 line and you have to write it that way (It is because the parser sucks).
664 There are two types of groups. One is like @samp{Emacsen} from above
665 example which the user chooses his favorite folders as a group.
667 The other one is @dfn{access group} like @samp{+} from above example.
668 It makes all the sub-folders in a folder to a group. (It differs from
669 the type of the folder. For example, @samp{+} makes entire MH
670 sub-directories to one group)
672 This behavior is better understood if you try it and confirmed the
673 function first. You can write and try a small folder definition, so you
674 will know the idea of the folder function before writing the real one.
676 @node Start Wanderlust, , Folder Definition, Start Me Up
677 @section Start Wanderlust
678 @cindex Start Wanderlust
680 If installation and configuration worked well, you can invoke Wanderlust by
681 typing following command in Emacs.
688 After initialization, Folder Mode which shows the list of folders will appear.
689 That means the folders you defined in the @file{~/.folders} are listed
690 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
691 can skip folder checking.
694 @node Folders, Folder, Start Me Up, Top
695 @chapter Wanderlust's folders
698 This chapter describes the folder types which Wanderlust is able to handle.
700 Wanderlust uses ELMO as it's interface, so every folder types supported
701 by ELMO is usable in Wanderlust.
703 As of version @value{VERSION}, 10 types of folders are predefined. These are
704 IMAP, NNTP, LocalDir(MH), News Spool, POP, Archive, Multi, Filter, Pipe
705 and Internal folder types.
708 * IMAP Folder:: @samp{%} -- IMAP folder
709 * NNTP Folder:: @samp{-} -- NNTP folder
710 * MH Folder:: @samp{+} -- MH folder
711 * Maildir Folder:: @samp{.} -- Maildir folder
712 * News Spool Folder:: @samp{=} -- News spool folder
713 * Archive Folder:: @samp{$} -- Archive folder
714 * POP Folder:: @samp{&} -- POP folder
715 * Multi Folder:: @samp{*} -- Multi folder
716 * Filter Folder:: @samp{/} -- Filter folder
717 * Pipe Folder:: @samp{|} -- Pipe folder
718 * Internal Folder:: @samp{'} -- Internal folder
722 @node IMAP Folder, NNTP Folder, Folders, Folders
729 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
735 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
739 You can specify @code{login} (encoded password transmission),
740 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
741 authentication) or @code{clear} (or @code{nil}, plain password
742 transmission) as @var{authenticate-type}. (To use CRAM-MD5 or
743 DIGEST-MD5 authentication, you must install @file{utils/sasl} package 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})
748 @var{username} -> The value of @code{elmo-default-imap4-user}.
749 Initial setting is @env{USER} environment variable or
750 @env{LOGNAME} environment variable or return value of
751 @code{(user-login-name)}.
752 @var{authenticate-type} -> The value of @code{elmo-default-imap4-authenticate-type}.
753 Initial setting is "auth".
754 @var{hostname} -> The value of @code{elmo-default-imap4-server}.
755 Initial setting is "localhost".
756 @var{port} -> The value of @code{elmo-default-imap4-port}.
757 Initial setting is 143.
760 You can omit the @var{hostname} from folder names if you set
761 @code{elmo-default-imap4-server} as your main IMAP server.
762 For example, you can specify a folder as @samp{foo%imap@@gateway} even
763 if you have to go through a firewall.
765 SSL (Secure Socket Layer) connection will be used if a folder name ends
766 with @samp{!}. Or, if the value of @code{elmo-default-imap4-stream-type}
767 is non-nil, SSL will be the default connection. If a folder name ends
768 with @samp{!!}, STARTTLS connection will be established. If the value
769 of @code{elmo-default-imap4-stream-type} is @code{starttls}, STARTTLS
770 will be the default connection.
772 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
773 authentication method, the password is sent in encoded form. But, if
774 your server is unable to receive an encoded password, authentication
775 will fall back to @code{clear} (that is, sending password in raw format)
776 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
777 authentication will fall back to @code{clear} without confirmation
778 (default value is @code{nil}).
784 %inbox -> IMAP mailbox "inbox"
785 %#mh/inbox -> IMAP mailbox "#mh/inbox"
787 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
788 %inbox:hoge/clear@@server1
789 -> server1's IMAP mailbox "inbox"
790 of user "hoge", with plain password authentication
795 @subsection International mailbox names (Modified UTF7)
796 @cindex Modified UTF7
803 You can use international mailbox names in @var{mailbox} part, if you
804 are using Emacs which can treat unicode and
805 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
806 value is @code{nil}).
808 Currently, following Emacsen can treat unicode.
811 @item Emacs 20.3 or later + Mule-UCS
813 If you installed Mule-UCS package, Emacs can treat unicode.
814 You can obtain Mule-UCS package from following URL.
817 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
820 @item XEmacs 21.2.13 or later + ucs-conv package
822 By default, XEmacs 21 cannot treat unicodes, but if you installed
823 ucs-conv package, it can.
824 You can obtain ucs-conv package from following anonymous CVS.
828 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
829 Password: @var{NULL} (Just enter return key)
830 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
834 You also need utf7 conversion programs, @command{u7tou8} and
835 @command{u8tou7} to use international mailbox name in the current
836 XEmacs. These programs are included in the UTF7 package which can be
837 obtained from following URL.
840 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
844 @node NNTP Folder, MH Folder, IMAP Folder, Folders
849 A folder to access USENET news via NNTP protocol (RFC 977).
850 One newsgroup is treated as a folder.
856 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
862 @var{hostname} -> The value of @code{elmo-default-nntp-server}.
863 Initial setting is @samp{localhost}.
864 @var{username} -> The value of @code{elmo-default-nntp-user}.
865 Initial setting is @code{nil}.
866 @var{port} -> The value of @code{elmo-default-nntp-port}.
867 Initial setting is 119.
870 AUTHINFO is used as authentication method if the @var{username} is non-nil.
871 SSL will be default method if @code{elmo-default-nntp-stream-type} is non-nil even
872 if the folder name doesn't end with @samp{!}.
873 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
874 if the value of @code{elmo-default-nntp-stream-type} is @code{starttls},
875 STARTTLS will be the default connection.
881 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
882 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
886 @node MH Folder, Maildir Folder, NNTP Folder, Folders
892 A folder to access MH format mail (1 file is 1 mail).
897 @samp{+} @var{directory-name}
900 Normally, @var{directory-name} is an relative path to the variable
901 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
902 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
903 (this is also true for drive-letters).
905 Message number is used for the name of the message file.
911 +inbox -> @file{~/Mail/inbox}
912 +from/teranisi -> @file{~/Mail/from/teranisi}
913 +~/test -> @file{~/test}
917 @node Maildir Folder, News Spool Folder, MH Folder, Folders
918 @section Maildir Folder
919 @cindex Maildir Folder
923 A folder to access to Maildir format (1 file is 1 mail).
928 @samp{.} [@var{directory-name}]
931 Normally, @var{directory-name} is a relative path to the variable
932 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
933 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
934 (this is also true for drive-letters).
936 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
937 Messages are contained in the @file{cur} directory. All message files
938 in the @file{new} directory are moved to @file{cur} directory when you
939 access to the folder. All message files contained in the @file{tmp}
940 directory and not accessed for 36 hours are deleted.
942 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
948 . -> @file{~/Maildir}
949 .inbox -> @file{~/Maildir/inbox}
950 .from/teranisi -> @file{~/Maildir/from/teranisi}
951 .~/test -> @file{~/test}
956 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
957 @section News Spool Folder
958 @cindex News spool Folder
962 This folder handles locally saved news articles which are proposed by
963 Mew/IM. You can also read articles directly from a spool-file which is
964 retrieved by an utility like @command{gnspool}.
969 @samp{=} @var{directory-name}
972 @var{directory-name} is a sub-directory to the directory defined by
973 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
974 You can use @samp{.} as directory delimiter as well as @samp{/}.
980 =fj/os/os2 -> @file{~/News/fj/os/os2}
981 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
986 @node Archive Folder, POP Folder, News Spool Folder, Folders
987 @section Archive Folder
988 @cindex Archive Folder
992 This method can handle archive files, which are compressed by utilities
993 such as Info-ZIP or LHA, as one folder.
999 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1003 @var{path-name} is the relative path from
1004 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1005 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1006 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1007 also permitted under the environment of ange-ftp, efs.
1009 The actual file name of the archive folder is
1010 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1011 under the @var{path-name}. If a file named @var{path-name} exists, it is
1012 treated as folder. The suffix is automatically decided for
1013 @var{archiver-type}.
1015 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1016 (Initial setting is @code{zip}) is referred.
1018 @var{prefix} specifies the internal directory structure of the archive.
1019 For example, if the ML server is fml, @file{msend.tar.gz} has a
1020 structure like @file{spool/1}, so you have to specify @samp{spool} as
1027 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1028 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1029 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1030 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1035 * Archiver:: Archivers supported
1036 * Archive Tips:: TIPS
1037 * Archive Vars:: Customization
1041 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1042 @subsection Supported Archives
1052 By default, following archives are supported.
1056 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1057 GNU TAR('tgz, 'tar) ;; read-only
1061 If your archiver can include multiple files in one archive, you have a
1062 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1063 of the candidate. TAR is supported read-only because it cannot delete
1064 file in the archive (@code{mv})).
1066 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1067 archiver of Wanderlust because they cannot include multiple
1068 files. Archivers that cannot extract files to standard output are also
1071 @subsection OS specific information about archiver.
1073 Behaviors of the following archivers are confirmed by further experiences.
1074 (@samp{*} mark means recommended archiver).
1077 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1078 LHA OS/2 version Rel.2.06b Feb 18, 1998
1079 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1080 *Zip 2.2 (November 3rd 1997).
1081 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1082 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1083 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1085 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1086 LHa for UNIX V 1.14c
1087 UnZip 5.32 of 3 November 1997
1088 Zip 2.2 (November 3rd 1997)
1089 GNU tar 1.12 (1.11.x is no good)
1090 gzip 1.2.4 (18 Aug 93)
1092 [Win32] Win.98/Meadow
1096 GNU tar 1.11.8 + 1.5(WIN32)
1103 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1104 Hiramatsu version of LHA is only supported.
1105 In Win32, LHa32 is only supported (DOS version is no good).
1107 * Caution about GNU tar
1109 You have to take care about GNU tar's version because many version has
1110 problem on deleting file from archive.
1112 Please test @option{--delete} @option{-f} options work. Otherwise, your
1113 archive will be destroyed. No problem is reported on above versions of
1117 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1119 @cindex Archive Tips
1121 For comfortable migration, usage of @code{wl-summary-archive}
1122 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1123 archive folders created by expiration, you must set non-nil value to
1124 @code{elmo-archive-treat-file}.
1126 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1127 in processing speed. For comfortable use, Emacs20 is recommended.
1128 (If re-search's performance is the problem, 19.3x or later may be okay.)
1130 If many files are included in one archive,
1131 it takes long time to access to the archive folder because
1132 archiver starting overhead is increased (especially LHA).
1133 150-200 messages in one archive is recommended.
1135 Of course, following is possible @t{:-)}
1136 (meanings of these variables are described later.)
1140 (setq wl-fcc "$backup")
1141 (setq wl-trash-folder "$trash;lha")
1145 @node Archive Vars, , Archive Tips, Archive Folder
1146 @subsection Variables About Archive Folder
1147 @cindex Archive variables
1150 @item elmo-archive-default-type
1151 @vindex elmo-archive-default-type
1152 The initial setting is @code{zip}.
1153 Set archiver type by symbol.
1155 @item elmo-archive-@var{type}-method-alist
1156 @vindex elmo-archive-TYPE-method-alist
1157 Define archiver @var{type}'s methods.
1158 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1159 Each element of the alist is following.
1163 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1164 (@var{action} . @var{function}) ;; function
1168 Currently available actions are following.
1172 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1173 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1180 actions enclosed with braces are optional (They are used for better
1183 @item elmo-archive-suffix-alist
1184 @vindex elmo-archive-suffix-alist
1185 An alist of archiver-type (symbol) and suffix.
1187 @item elmo-archive-file-regexp-alist
1188 @vindex elmo-archive-file-regexp-alist
1189 An alist of a regexp to get file number from list output of archiver
1190 and archiver-type (symbol).
1192 @item elmo-archive-method-list
1193 @vindex elmo-archive-method-list
1194 A list of elmo-archive-@var{type}-method-alist
1195 (@var{type} is a symbol of archiver-type).
1197 @item elmo-archive-lha-dos-compatible
1198 @vindex elmo-archive-lha-dos-compatible
1199 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1200 DOS (Mr. Yoshizaki original) compatible.
1202 @item elmo-archive-cmdstr-max-length
1203 @vindex elmo-archive-cmdstr-max-length
1204 The initial setting is 8000.
1206 Max length of command line argument for external archiver program.
1207 Emacs does not have a limit of command line byte length, but some OS
1208 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1209 this limit because it calls external archiver program directly (not
1210 called via shell). For example, you cannot delete messages if archiver
1211 program must receive larger bytes of arguments to delete. OS/2 have a
1212 command line argument limit of 8190 bytes, so we defined default as 8000
1215 However, you don't have an influence of command line argument limit
1216 if the archiver has `actions' to receive target file information from
1217 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1220 @node POP Folder, Multi Folder, Archive Folder, Folders
1228 A folder to access e-mails via POP3 protocol (RFC 1939).
1234 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1239 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1240 as @var{authenticate-type}.
1244 @var{username} -> The value of @code{elmo-default-pop3-user}.
1245 Initial setting is @env{USER} environment variable or
1246 @env{LOGNAME} environment variable or return value of
1247 @code{(user-login-name)}.
1248 @var{authenticate-type} -> The value of @code{elmo-default-pop3-authenticate-type}.
1249 Initial setting is @samp{user}.
1250 @var{hostname} -> The value of @code{elmo-default-pop3-server}.
1251 Initial setting is @samp{localhost}.
1252 @var{port} -> The value of @code{elmo-default-pop3-port}.
1253 Initial setting is 110.
1260 &hoge@@localhost -> access to localhost as user @samp{hoge}.
1261 &hoge@@popserver:109 -> access to the server "popserver" on port 109
1262 as user @samp{hoge}.
1266 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1267 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1268 @file{utils/sasl/lisp/} or Emacs/W3 package
1269 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1272 If the last character of the folder name is @samp{!}, Wanderlust
1273 connects to the POP server via SSL (Secure Socket Layer). If you set
1274 non-nil value to @code{elmo-default-pop3-stream-type}, you don't have to put
1275 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1276 with @samp{!!}, STARTTLS connection will be established. if the value
1277 of @code{elmo-default-pop3-stream-type} is @code{starttls}, STARTTLS will be the
1280 @node Multi Folder, Filter Folder, POP Folder, Folders
1281 @section Multi Folder
1282 @cindex Multi Folder
1284 @cindex Folder, Multiple
1285 @cindex Folder, Marge
1287 A folder to access to a folder which collects messages from
1288 multiple folders virtually.
1294 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1298 After @samp{*} character, specify multiple folders you want to collect
1299 separated by @samp{,} like
1300 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1306 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1307 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1308 treated as one folder.
1310 *+inbox,-fj.rec.tv,%inbox
1311 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1316 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1317 @section Filter Folder
1318 @cindex Filter Folder
1320 @cindex Folder, Filtering
1321 @cindex Folder, Virtual
1323 A folder to access to a folder which collects all messages that
1324 satisfy a condition virtually.
1329 @samp{/} @var{condition} @samp{/} @var{target-folder}
1332 In the @var{condition} part, you can specify following.
1336 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1338 first: @var{number} messages are picked from top of folder.
1339 last: @var{number} messages are picked from bottom of folder.
1345 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1346 /first:20/%inbox -> First 20 messages from %inbox are picked.
1351 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1353 since: only messages arrived since @var{date} are picked.
1354 before: only messages arrived before @var{date} are picked.
1356 You can specify following as @var{date}.
1360 yesterday -> a day before today.
1361 lastweek -> same day of last week.
1362 lastmonth -> same day of last month.
1363 lastyear -> same day of last year.
1364 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1365 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1373 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1375 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1381 Field filter: @samp{@var{field}:@var{value}}
1383 All messages that have @var{field} and its value is @var{value} are picked.
1384 @var{field} and @var{value} are case insensitive.
1390 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1391 and its value includes "teranisi" string are picked.
1392 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1400 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1401 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1403 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1404 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1410 /from:teranisi&!to:teranisi/+inbox
1411 -> In +inbox, messages are picked if the message's
1412 From: field includes "teranisi" and
1413 To: field doesn't include "teranisi".
1415 /tocc:"Yuuichi Teranishi"/+inbox
1416 -> In +inbox, messages are picked if the
1417 message's To: field or Cc: field includes
1418 "Yuuichi Teranishi".
1420 /(from:yt|from:teranisi)&subject:report/+inbox
1421 -> In +inbox, messages are picked if the message's
1422 From: field includes "yt" or "teranisi", and
1423 Subject includes "report".
1429 Tip for string description:
1431 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1432 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1433 should be escaped with @samp{\} in it). You can enclose the string with
1434 @samp{"} even it does not contain these characters.
1440 *%inbox,/from:teranisi/%inbox@@server
1441 -> Messages in %inbox or
1442 message is in the %inbox@@server folder and it's From field
1443 includes "teranisi" are collected.
1445 /last:100//to:teranisi/*+inbox,%inbox
1446 -> Latest 100 messages which is in the +inbox or %inbox folder
1447 and To: field matches "teranisi".
1449 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1450 -> Pick messages which have From: field and it includes "hogehoge"
1451 from latest 20 messages in the %#mh/inbox@@localhost
1452 and To: or Cc: field includes "teranisi".
1455 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1456 @section Pipe Folder
1460 @cindex Download Message
1461 @cindex Incorporate Message
1463 In the pipe folder, messages are automatically transferred from the source
1464 folder to destination folder.
1469 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1472 When you access to the pipe folder, messages are automatically transferred
1473 from @var{source-folder} to @var{destination-folder}.
1474 It is convenient if you want to download messages to local disk via POP.
1475 For example, if you specify following
1478 |&username@@popserver|+inbox
1482 and access to it, messages are downloaded automatically from
1483 @samp{&username@@popserver} to @samp{+inbox}.
1489 %inbox|%myinbox -> Download %inbox to %myinbox.
1490 *&user@@popserver1,&user@@popserver2|+inbox
1491 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1495 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1497 @node Internal Folder, , Pipe Folder, Folders
1498 @section Internal folder
1499 @cindex Internal Folder
1501 @cindex Folder, @samp{$} mark
1503 A folder to access to internal messages of Wanderlust.
1515 A folder named @samp{'mark} is a special virtual folder which collects
1516 messages which have important mark @samp{$}.
1518 You can review important messages at once after you put important marks
1519 on the messages in the different folders.
1521 In this folder, if you delete message, important mark @samp{$} put on
1522 the message is removed. If you append messages to this folder, the
1523 message will have @samp{$} mark.
1525 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1526 folder. If you want IMAP folder's message remove from @samp{'mark}
1527 folder, remove important mark at IMAP Folder.)
1529 You can access to the cached messages fetched via network by accessing
1530 to the folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1531 the name of the subdirectories of the cache directory
1532 (@file{~/.elmo/cache}).
1535 @node Folder, Summary, Folders, Top
1536 @chapter Folder mode
1539 After you start Wanderlust, folder mode is appeared firstly.
1540 It contains folder list you subscribed.
1541 You can select and edit folders in this mode.
1544 * Selecting Folder:: Select folder you want to read.
1545 * Folder Manager:: Editing folders.
1549 @node Selecting Folder, Folder Manager, Folder, Folder
1550 @section Selecting Folder
1551 @cindex Selecting Folder
1553 @subsection Usage (TIPS)
1555 @subsubsection Check new, unread number
1557 Folder mode looks like this.
1558 (In XEmacs, it looks much nicer @t{;-)})
1562 [-]Desktop:14186/35580/67263
1567 [-]Emacsen:0/34/4837
1568 Wanderlust ML:0/0/558
1571 XEmacs Beta:0/29/255
1582 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1586 @kbd{s} key on the folder line updates these numbers.
1587 It changes its color if it has many new messages.
1589 The whole folder mode is a folder group named @samp{Desktop}.
1590 Folder group open/close by return key.
1591 A operation to a folder group is treated as operations on the
1593 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1594 six children folders update its unread number status.
1596 @subsubsection Select Folder
1598 To enter summary mode of the folder, type return (or space) key on
1600 If the variable @code{wl-stay-folder-window} has non-nil value,
1601 summary window appears on the right of the folder mode window.
1603 @subsection Key bindings
1605 Folder mode's key binding (related to selecting folders) is following.
1610 @kindex @key{SPC} (Folder)
1611 @kindex @key{RET} (Folder)
1612 @findex wl-folder-jump-to-current-entity
1613 Enter to the summary mode of the folder at the current cursor point.
1614 If the cursor is on the top of folder group line,
1615 the folder group is opened or closed.
1616 When the cursor is on the access group and this command is called
1617 with prefix argument, folder children list is updated to the newest one.
1618 (Children list is updated recursively if the access folder has hierarchical
1620 (@code{wl-folder-jump-to-current-entity})
1623 @kindex M-@key{RET} (Folder)
1624 @findex wl-folder-update-recursive-current-entity
1625 Folder children list of the access group at the current cursor point
1626 is updated to the newest one.
1627 (Children list is updated recursively if the access folder has hierarchical
1629 (@code{wl-folder-update-recursive-current-entity})
1634 Create a new draft message.
1639 @findex wl-folder-write-current-folder
1640 If the current cursor point is on the NNTP folder, create a new draft
1641 message which already has @samp{Newsgroups:} field. If the current
1642 cursor point is on the folder for mailing list (refile destination),
1643 create a new draft message which already has @samp{To:} field with
1644 guessed mailing list adderss (If @code{wl-subscribed-mailing-list} is
1646 (@code{wl-folder-write-current-folder})
1649 @kindex C-c C-o (Folder)
1650 @findex wl-jump-to-draft-buffer
1651 Move to the draft buffer if available. If multiple draft buffer exists,
1652 moved to one after another. If prefix argument is specified, load draft
1653 folder's message to the draft buffer and jump to it.
1654 (@code{wl-jump-to-draft-buffer})
1658 @findex wl-folder-check-current-entity
1659 Update new and unread number information of the folder at the current
1661 (@code{wl-folder-check-current-entity})
1665 @findex wl-folder-sync-current-entity
1666 Update summary information of the folder at the current cursor point.
1667 (@code{wl-folder-sync-current-entity})
1670 @kindex r s (Folder)
1671 @findex wl-folder-check-region
1672 Update new and unread number information of the folders in the currently
1674 (@code{wl-folder-check-region})
1677 @kindex r S (Folder)
1678 @findex wl-folder-sync-region
1679 Update summary information of the folders in the currently selected region.
1680 (@code{wl-folder-sync-region})
1684 @findex wl-status-update
1685 Sync up address book status with @file{~/.addresses}'s content.
1686 (@code{wl-status-update})
1690 @findex wl-folder-prev-unread
1691 Jump cursor to the folder which have unread messages on the upward from
1692 current cursor point.
1693 (@code{wl-folder-prev-unread})
1697 Jump cursor to the folder which have unread messages on the downward
1698 from current cursor point.
1699 (@code{wl-folder-next-unread})
1703 Move cursor to the folder on the previous line.
1704 (@code{wl-folder-prev-entity})
1708 Move cursor to the folder on the next line.
1709 (@code{wl-folder-next-entity})
1713 Jump to the folder specified by the user input.
1714 (@code{wl-folder-jump-folder})
1718 @findex wl-folder-prefetch-current-entity
1719 Prefetch new messages of the folder at the current cursor point by
1720 @code{wl-summary-incorporate}.
1721 If the cursor is on the folder group, it is executed recursively.
1722 (@code{wl-folder-prefetch-current-entity})
1726 @findex wl-folder-mark-as-read-all-current-entity
1727 Mark all unread messages of the folder at the current cursor point as read.
1728 If the cursor is on the folder group, it is executed recursively.
1729 (@code{wl-folder-mark-as-read-all-current-entity})
1733 @findex wl-folder-goto-first-unread-folder
1734 Enter summary mode of the first unread folder.
1735 (@code{wl-folder-goto-first-unread-folder})
1739 @findex wl-folder-empty-trash
1741 (@code{wl-folder-empty-trash})
1745 @findex wl-folder-open-all-unread-folder
1746 All unread folder is opened.
1747 (@code{wl-folder-open-all-unread-folder})
1751 @findex wl-folder-open-close
1752 Folder group is opened/closed.
1753 (@code{wl-thread-open-close})
1757 All folder group is opened.
1758 (@code{wl-folder-open-all})
1762 All folder group is closed.
1763 (@code{wl-folder-close-all})
1773 (@code{wl-folder-suspend})
1776 @kindex M-s (Folder)
1777 Save current folder status.
1781 @kindex M-t (Folder)
1782 Toggle Wanderlust's offline/online status.
1783 (@code{wl-toggle-plugged})
1786 @kindex C-t (Folder)
1787 Start Wanderlust's plug-status manager.
1788 (@code{wl-plugged-change})
1791 @subsection Customize variables
1794 @item wl-folders-file
1795 @vindex wl-folders-file
1796 The initial setting is @file{~/.folders}.
1797 Subscribed folders are described (saved) in this file.
1799 @item wl-folder-info-save
1800 @vindex wl-folder-info-save
1801 The initial setting is @code{t}. If non-nil, unread information is
1802 saved and used in the next Wanderlust session.
1804 @item wl-stay-folder-window
1805 @vindex wl-stay-folder-window
1806 The initial setting is @code{nil}.
1807 If non-nil, summary window is appeared on the right side of the folder buffer.
1809 @item wl-folder-window-width
1810 @vindex wl-folder-window-width
1811 The initial setting is 20.
1812 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1814 @item wl-folder-many-unsync-threshold
1815 @vindex wl-folder-many-unsync-threshold
1816 The initial setting is 70.
1817 If the number of unread messages is more than this value,
1818 folder color is changed.
1820 @item wl-highlight-folder-by-numbers
1821 @vindex wl-highlight-folder-by-numbers
1822 This option controls how to highlight each line in the folder buffer.
1823 The default value is @code{t}, highlighting with various colors based on
1824 the message numbers. If it is @code{nil}, highlighting with various
1825 colors based on the folder status. In addition, if it is a number
1826 (e.g. 1), highlighting will be done based on both the message numbers
1827 and the folder status.
1829 @item wl-folder-desktop-name
1830 @vindex wl-folder-desktop-name
1831 The initial setting is @samp{Desktop}.
1832 The name of top folder group.
1834 @item wl-folder-petname-alist
1835 @vindex wl-folder-petname-alist
1836 The initial setting is @code{nil}.
1837 An alist of folder's realname and its nickname.
1839 @item wl-folder-access-subscribe-alist
1840 @vindex wl-folder-access-subscribe-alist
1841 The initial setting is @code{nil}.
1843 Control automatic subscribing and unsubscribing of the children list
1849 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1853 If @var{subscribe-flag} is non-nil, folders which have name matched to
1854 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1855 already unsubscribed folder is not displayed even when the
1856 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1863 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1864 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1865 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1866 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1870 @item wl-folder-hierarchy-access-folders
1871 @vindex wl-folder-hierarchy-access-folders
1872 The initial setting is the list shown below:
1881 A list of access groups which creates children folder list hierarchically.
1883 For example, if you specify
1884 @code{wl-folder-hierarchy-access-folders} like following,
1888 (setq wl-folder-hierarchy-access-folders
1889 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1894 such access group hierarchy is obtained.
1900 -fj.comp.announce:0/0/2
1901 -fj.comp.dev.cdrom:0/0/0
1903 [+]-japan:238/238/1688
1906 -comp.unix.admin:0/0/0
1907 -comp.unix.dos-under-unix:0/0/0
1908 -comp.unix.programmer:0/0/0
1909 [-]-comp.unix.bsd:0/0/23
1910 -comp.unix.bsd.freebsd.announce:0/0/0
1915 If you opened @samp{-} in this example, only the direct children is created
1916 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1917 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1918 is not created until the children access group is opened.
1922 @node Folder Manager, , Selecting Folder, Folder
1923 @section Editing Folders
1924 @cindex Folder Manager
1925 @cindex Folder, Edit
1926 @cindex Folder, Subscribe
1927 @cindex Folder, Unsubscribe
1929 As described before, subscribed folder list is saved in @file{~/.folders} file.
1930 But you don't have to edit @file{~/.folders} directly.
1931 You can append, delete, edit folders from folder mode.
1933 @subsection Usage (Tips)
1935 @subsubsection Append Folder
1937 @kbd{m a} appends new folder to the folder mode.
1938 @kbd{m g} appends new folder group.
1939 To append new folder to this group, firstly open it,
1940 then execute append command in the next line.
1942 @subsubsection Edit Folder
1944 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1945 Thus, you can change folder position as if you were editing a normal file.
1947 @subsubsection Create Multi Folder.
1951 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
1953 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
1955 Type @kbd{m m}, then you can create multi folder.
1958 @subsubsection Delete Nickname, Filter
1960 You can delete nickname or filter by putting ``''(@var{NULL}) from the
1961 minibuffer while appending.
1963 @subsubsection Append Folder to Empty Group
1965 To append new folder to the empty folder group
1966 (after you create folder group by typing @kbd{m g}),
1967 firstly open it, then execute append command in the next line.
1968 If it is closed, folder is appended on the same level with
1969 the above folder group. It is difficult to explain by words so try it.
1970 In other words, appended position depends on the
1971 above folder group's open/close status.
1973 @subsubsection Charset of the Folders File.
1975 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
1977 @subsubsection Create Filter
1979 @kbd{m f} adds filter to the folder at the current cursor point. To
1980 create new filter folder and leave the current folder unchanged, copy it
1981 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
1982 filter can be specified while appending filter. If you put
1983 ``''(@var{NULL}), filter is deleted.
1985 @subsubsection Sort Folders
1987 Sorting of the folders is executed by the function specified by
1988 @code{wl-fldmgr-sort-func}.
1989 The initial setting is @code{wl-fldmgr-sort-standard},
1990 which sorts alphabetically.
1991 Sorting affects only on the current folder group. It does not
1992 affect on the child groups.
1994 @subsubsection Hiding Folders in the Access Group
1996 Usually, access group displays all children folders, but you can set
1997 some folders hidden. Following operations are only available on access
2000 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2001 (subscribe/unsubscribe) of the folder at current cursor point. Against
2002 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2005 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2006 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2007 argument and if the argument has positive number, the unsubscribe it.
2008 If the prefix argument has negative value, folder becomes visible and if
2009 zero, folder visibility is toggled.
2011 The other commands, @code{wl-fldmgr-subscribe} and
2012 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2015 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2016 executed in the access group, they have a same effect with
2017 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2018 The difference is that cut commands deletes folders from the current
2021 @subsubsection Operations in the Access Group
2023 You can insert and delete folders in the access group like usual folder
2024 group. But insert and delete commands can be only available for the
2025 children folders of the access group and they only sets the subscribe
2026 status. In other words, insertion of the folder means subscribing,
2027 deletion means unsubscribing.
2028 @footnote{In the current implementation,
2029 it is faster to delete region than to unsubscribe region.}
2031 To update the access group when children folders are inserted or deleted
2032 by other way (other than Wanderlust),
2033 open the access group by typing @kbd{C-u @key{RET}}.
2034 @xref{Selecting Folder}.
2036 The order of children folders of access group is saved after
2037 insertion/deletion/sorting.
2038 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2039 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2040 newly created folders are inserted on the top of the access group.
2042 @subsection Key bindings
2043 @cindex Keybind, Folder Mode
2044 @cindex Keybind, Folder Buffer
2046 Key bindings on the folder mode related to folder editing are shown below.
2047 All bindings starts with @kbd{m}, and primary commands are binded to
2048 one stroke key binding.
2052 @kindex m a (Folder)
2053 @findex wl-fldmgr-add
2055 (@code{wl-fldmgr-add})
2060 @kindex m g (Folder)
2061 @findex wl-fldmgr-make-group
2062 Create a folder group.
2063 (@code{wl-fldmgr-make-group})
2066 @kindex m A (Folder)
2067 @findex wl-fldmgr-make-access-group
2068 Create an access group.
2069 (@code{wl-fldmgr-make-access-group})
2072 @kindex m d (Folder)
2073 @findex wl-fldmgr-delete
2074 Delete folder itself and msgdb.
2075 If the folder itself cannot be deleted like NNTP folder,
2076 only msgdb is deleted.
2077 (@code{wl-fldmgr-delete})
2082 @kindex m R (Folder)
2083 @findex wl-fldmgr-rename
2084 Change the name of folder or folder group.
2085 msgdb's path is also changed.
2086 (@code{wl-fldmgr-rename})
2092 @findex wl-fldmgr-make-multi
2093 Create a multi folders in the cutlist (cut, copied folders).
2094 (@code{wl-fldmgr-make-multi})
2099 @kindex m f (Folder)
2100 @findex wl-fldmgr-make-filter
2101 Create a filter folder. (Put a filter on the folder).
2102 (@code{wl-fldmgr-make-filter})
2106 @kindex M-c (Folder)
2107 @kindex m c (Folder)
2108 @findex wl-fldmgr-copy
2109 Copy folder (it is not available on folder group).
2110 (@code{wl-fldmgr-copy})
2114 @kindex M-w (Folder)
2115 @kindex m W (Folder)
2116 @findex wl-fldmgr-copy-region
2117 Copy folders in the specified region.
2118 (@code{wl-fldmgr-copy-region})
2122 @kindex C-k (Folder)
2123 @kindex m k (Folder)
2124 @findex wl-fldmgr-cut
2125 Cut folder. Folder itself is not deleted.
2126 (@code{wl-fldmgr-cut})
2130 @kindex C-w (Folder)
2131 @kindex m C-w (Folder)
2132 @findex wl-fldmgr-cut-region
2133 Cut folders in the specified region.
2134 (@code{wl-fldmgr-cut-region})
2138 @kindex C-y (Folder)
2139 @kindex m y (Folder)
2140 @findex wl-fldmgr-yank
2141 Paste folders that are copied or cut (folders in the cut-list).
2142 (@code{wl-fldmgr-yank})
2145 @kindex m p (Folder)
2146 @findex wl-fldmgr-set-petname
2147 Put nickname on the folder.
2148 (@code{wl-fldmgr-set-petname})
2151 @kindex m q (Folder)
2152 @findex wl-fldmgr-clear-cut-entity-list
2153 Clear the cut-list. (cut, copied folder information is cleared,
2154 you cannot paste after this)
2155 (@code{wl-fldmgr-clear-cut-entity-list})
2158 @kindex m s (Folder)
2159 @findex wl-fldmgr-sort
2160 Sort folders in the current folder group.
2161 (@code{wl-fldmgr-sort})
2164 @kindex m C-s (Folder)
2165 @findex wl-fldmgr-save
2166 Save current folder view to the @file{wl-folders-file}.
2167 (@code{wl-fldmgr-save})
2170 [Following commands are only available on the access groups]
2176 @kindex m u (Folder)
2177 @findex wl-fldmgr-unsubscribe
2178 Set the visibility of folder (subscribe/unsubscribe).
2179 (@code{wl-fldmgr-unsubscribe})
2184 @kindex r u (Folder)
2185 @findex wl-fldmgr-unsubscribe-region
2186 Set the visibility of the folders (subscribe/unsubscribe) in the
2188 (@code{wl-fldmgr-unsubscribe-region})
2193 @kindex m l (Folder)
2194 @findex wl-fldmgr-access-display-normal
2195 List folders that are currently available.
2196 (@code{wl-fldmgr-access-display-normal})
2201 @kindex m L (Folder)
2202 @findex wl-fldmgr-access-display-all
2203 List all folders regardless of the subscription status.
2204 (@code{wl-fldmgr-access-display-all})
2208 @subsection Customize variables
2211 @item wl-interactive-save-folders
2212 @vindex wl-interactive-save-folders
2213 The initial setting is @code{t}. If non-nil and folder view is
2214 modified, confirm saving it before Wanderlust or Emacs exits. If
2215 @code{nil}, save without confirmation.
2217 @item wl-fldmgr-make-backup
2218 @vindex wl-fldmgr-make-backup
2219 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2220 created before saving the folder status.
2222 @item wl-fldmgr-sort-func
2223 @vindex wl-fldmgr-sort-func
2224 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2225 sort folders. By default function, folders are sorted alphabetically
2226 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2229 @item wl-fldmgr-sort-group-first
2230 @vindex wl-fldmgr-sort-group-first
2231 The initial setting is @code{t}. If non-nil,
2232 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2233 does not care whether it is folder group or not.
2235 @item wl-folder-check-async
2236 @vindex wl-folder-check-async
2237 The initial setting is @code{t}. If non-nil, check folder's unread
2238 status asynchronously. It boosts newsgroup checking.
2240 @item wl-folder-check-fast
2241 @vindex wl-folder-check-fast
2242 The initial setting is @code{nil}.
2243 If non-nil, it does not update folder status while checking.
2245 @item wl-folder-notify-deleted
2246 @vindex wl-folder-notify-deleted
2247 The initial setting is @code{nil}.
2249 If non-nil, negative value is displayed when the message is deleted. If
2250 @code{sync}, folder is synchronized when the message is deleted. If
2251 @code{nil}, message deletion is ignored.
2254 @subsection Miscellanea
2256 Following is a note for folder editing.
2260 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2261 paste(yank) command pastes the folders on one cut or copy command
2262 (If copy command is executed by region, folders in the region are pasted
2263 by one paste command)
2266 You cannot cut @samp{Desktop} group.
2267 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2270 You cannot copy folder group.
2273 Operations on the access group are only available for the folders
2274 in the same access group.
2277 You cannot create a folder which has same name with the folders already exist.
2280 You cannot insert folders which have same name in one group.
2281 You can insert them in the different groups.
2282 You cannot put same nickname to the different folders.
2286 @node Summary, Message, Folder, Top
2287 @chapter Summary Mode
2289 After you select the folder via folder mode, you enter to the summary
2293 * Usage of Summary Mode:: TIPS.
2294 * Thread Operations:: Thread operations.
2295 * Cache:: File cache, Buffer cache, and Prefetch.
2296 * Auto Refile:: Auto refile settings.
2297 * Sticky Summary:: Summary make sticky.
2298 * Key Bindings of Summary:: Key bindings.
2299 * Variables of Summary:: Customize Summary Mode.
2303 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2304 @section Usage (Tips)
2306 @subsection Summary Content
2308 In the summary mode, messages are displayed like following.
2312 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2313 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2314 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2315 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2322 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2326 You cannot change this in the current version.
2328 @var{Message number} is the message's unique number in the folder. In
2329 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2330 in the MH folder, it is the filename of the message.
2332 @var{Temporal mark} and @var{Persistent mark} are described later.
2334 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2335 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2336 Japanese, but if you want to display it in English, set the value of
2337 @code{wl-summary-weekday-name-lang} as @samp{en}.
2339 @var{Sender}'s indentation corresponds to the depth of the thread.
2340 Sender name is displayed as nickname if it is defined in the address
2341 book. Set @code{wl-use-petname} as @samp{nil}, if you want to quit
2342 displaying with nickname.
2344 If number is printed at the head of @var{Sender} part like @samp{+2},
2345 that means the message have 2 follow messages.
2347 @var{Subject} is the @samp{Subject:} header field of the message. If
2348 the message have same @samp{Subject:} with the parent message, it is not
2349 displayed. Some mailing list puts its sequence number in the
2350 @samp{Subject:} field, but it is
2351 ignored. @code{wl-summary-no-subject-message} is displayed when the
2352 message has empty subject field.
2354 @subsection Temporary Marks
2355 @cindex Mark, Temporary
2357 There are four temporary marks,
2358 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2359 Temporary marks indicates message operations.
2364 You can execute a command on the all messages that have @samp{*} mark,
2365 with the key bindings which begins with @kbd{m}.
2368 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2372 After you type @kbd{o} key, prompt appears to input refile destination.
2373 Your answer is printed in the summary line.
2377 You can put this mark by typing @kbd{O} key.
2378 The difference between this mark and refile mark is,
2379 this mark does not delete the message while latter does.
2382 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2384 @subsection Persistent Marks
2386 There are five persistent marks,
2387 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2389 The persistent mark indicates the message's status and it is saved.
2390 Each persistent mark indicates:
2396 It is unread message.
2398 It is unread but cached message.
2400 It is read but it is not cached.
2402 It is important message. You can put @samp{$} mark by typing @kbd{$}
2403 key (if already exists, the mark is deleted). It is convenient to put
2404 this mark on the messages to remember (If you want to remember to write
2405 a reply for the message, for example) because this mark remains after
2406 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2407 even the message itself is deleted in the actual folder.
2410 If the message is read and cached (or local message),there are no
2414 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2415 cache. Messages with the marks other than these, you can read them in
2416 the offline status even they are in the IMAP folder or netnews folder.
2418 @subsection How To Read
2420 Basically, you can read messages only typing space key again and again.
2422 To update summary status to the newest status (synchronize),
2425 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2426 moves cursor to the next message.
2427 Enter message buffer by typing @kbd{j} key.
2428 To operate multipart, you have to enter to the message buffer.
2431 @subsection Pack the Message Numbers
2432 You can pack the message numbers in Summary by
2433 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2434 News Spool Folder and Maildir Folder are supported folder types.
2437 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2438 @section Thread Operations
2440 For example, the following line indicates one thread (a context of a topic).
2443 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2447 If you type @kbd{/} on this line, the thread is opened and it changes
2448 the appearance like following.
2452 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2453 388 09/17(Thu)22:34 +-[ Murata san ]
2457 (Message 388 is the replied message to the message 384.)
2458 If you type @kbd{/} key once again, the thread is closed.
2459 With prefix argument, @kbd{/} opens all children threads.
2461 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2464 Commands with the key binding that begins with @kbd{t} executes commands
2465 on the messages in the thread.
2466 @xref{Key Bindings of Summary}.
2468 @subsection reconstruct thread by hand
2470 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2471 (@code{wl-summary-save-current-message}) at the corresponding message,
2472 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2473 message then you have the reconstructed thread.
2476 @node Cache, Auto Refile, Thread Operations, Summary
2479 @subsection Cache File
2481 The messages which have to access via network (e.x. IMAP, NNTP folder)
2482 are cached as a local file. The cache file is saved under the directory
2483 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2484 elmo-cache-expire-by-size}. The command deletes cache files to the
2485 specified size by the order of last accessed time.
2487 @subsection Buffer Cache and Prefetching
2489 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2490 that are read are kept in the cache buffer. It is called `buffer
2491 cache'. The number of cache buffer is specified by
2492 @code{elmo-buffer-cache-size}.
2494 There are message prefetching mechanism in the Wanderlust that
2495 prefetches next message while you are reading. This function requires
2496 that the value of @code{elmo-use-buffer-cache} is non-nil.
2498 You can control the message prefetching mechanism by these two
2502 @item wl-cache-prefetch-folder-type-list
2503 @vindex wl-cache-prefetch-folder-type-list
2504 The initial setting is the list shown below:
2512 It specifies the folder types in which message prefetching is enabled.
2513 In the initial setting, multi folder that contains localdir and imap4
2514 prefetches only imap4 messages. This variable precedes the value of
2515 @code{wl-cache-prefetch-folder-list}.
2517 If you want to prefetch localdir and localnews also, following setting
2522 (setq wl-cache-prefetch-folder-type-list
2523 '(nntp imap4 localdir localnews))
2527 @item wl-cache-prefetch-folder-list
2528 @vindex wl-cache-prefetch-folder-list
2529 The initial setting is @code{nil}.
2530 A list of regexp of folders to enable message prefetching.
2534 @node Auto Refile, Sticky Summary, Cache, Summary
2535 @section Auto Refile
2536 @vindex elmo-msgdb-extra-fields
2537 @vindex wl-refile-rule-alist
2538 @findex wl-summary-auto-refile
2540 You can refile messages automatically, by typing @kbd{C-o}
2541 (@code{wl-summary-auto-refile}). It decides destination of refile by
2542 the content of the message header information (information in the msgdb).
2544 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2545 available. If you want to decide destination by other header fields,
2546 set the variable @code{elmo-msgdb-extra-fields} like following.
2550 (setq elmo-msgdb-extra-fields
2560 By this setting, Wanderlust saves extra fields in the msgdb. You have
2561 to type @kbd{s all} to get extra fields for the messages that are
2562 already exists in the summary.
2564 Then, specify the refile rule. The refile target folder of auto
2565 refiling is decided by the value of @code{wl-refile-rule-alist}.
2566 @code{wl-refile-rule-alist} is a list of a rule:
2570 (@var{field} (@var{regexp} . @var{target})
2571 (@var{regexp} . @var{target})
2576 Each rule means `if @var{field} value matches @var{regexp},
2577 then refile to @var{target} folder'.
2578 The rule matched first is applied.
2580 @var{field} is a string of field name. You can specify a list of field name
2581 string, too. In this case, if one of these fields is matched, then the
2582 rule is fired (i.e. OR condition).
2584 @var{regexp} is a regular expression for field value. @var{target} is a target
2585 folder string. You can specify a rule at @var{target} part, too. In this
2586 case, If the field value of the rule and the current rule is matched,
2587 then the current rule is fired (i.e. AND condition).
2589 In @var{target} part, you can refer matched substring of @var{regexp}.
2590 To refer substring, specify following in @var{target}:
2594 means substitute original matched text.
2597 means substitute what matched the @var{N}th `\(@dots{}\)'.
2598 (@var{N} is a number.)
2601 Following is an example of @code{wl-refile-rule-alist}.
2605 (setq wl-refile-rule-alist
2607 ("^Wanderlust" . "+wl")
2608 ("^Elisp" . "+elisp"))
2610 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2612 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2613 "+from-me-to-you"))))))
2617 After these settings, refile marks are automatically put on the condition
2618 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2620 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2622 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2623 with these persistent marks are not automatically refiled.
2624 It means Wanderlust does not execute auto refile on unread messages by
2625 the default setting.
2626 To execute auto refile on all messages, set following.
2629 (setq wl-summary-auto-refile-skip-marks nil)
2633 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2634 @section Sticky Summary
2635 @cindex Summary, Sticky
2636 @cindex Sticky Summary
2638 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2640 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2641 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2643 The buffer name of the sticky summary becomes like
2644 @samp{Summary:@var{folder-name}}.
2646 You can visit the sticky summary at any time by @kbd{C-x b}
2647 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2648 q}. Other operations in the sticky summary are same as normal summary.
2650 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2651 are automatically sticked.
2654 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2655 @section Key bindings
2656 @cindex Keybind, Summary Mode
2657 @cindex Keybind, Summary Buffer
2659 Key bindings of the summary mode are shown below.
2663 @kindex @key{SPC} (Summary)
2664 @findex wl-summary-read
2665 Proceed reading a message at the current cursor point.
2666 (@code{wl-summary-read})
2670 @findex wl-summary-redisplay
2671 Redisplay a message at the current cursor point.
2672 If this command is called with prefix argument,
2673 Redisplay message regardless of the message cache (message is re-loaded
2675 (@code{wl-summary-redisplay})
2679 @findex wl-summary-display-top
2680 Display the top message in the folder.
2681 (@code{wl-summary-display-top})
2685 @findex wl-summary-display-bottom
2686 Display the bottom message in the folder.
2687 (@code{wl-summary-display-bottom})
2691 @kindex @key{BS} (Summary)
2692 @kindex @key{DEL} (Summary)
2693 Display the previous page of the message at the current cursor point.
2694 @findex wl-summary-prev-page
2695 (@code{wl-summary-prev-page})
2698 @kindex @key{RET} (Summary)
2699 @findex wl-summary-next-line-content
2700 Display the next line of the message at the current cursor point.
2701 Display the message at the current cursor point if it is not displayed yet.
2702 (@code{wl-summary-next-line-content})
2707 @kindex M-@key{RET} (Summary)
2708 @findex wl-summary-prev-line-content
2709 Display the previous line of the message at the current cursor point.
2710 Display the message at the current cursor point if it is not displayed yet.
2711 (@code{wl-summary-prev-line-content})
2715 @findex wl-thread-open-close
2716 Toggle open or close the thread at the current cursor point.
2717 (@code{wl-thread-open-close})
2722 @findex wl-thread-open-all
2723 (@code{wl-thread-open-all})
2728 @findex wl-thread-close-all
2729 (@code{wl-thread-close-all})
2733 @findex wl-summary-goto-folder
2735 (@code{wl-summary-goto-folder})
2739 Mark all messages in the folder as read.
2740 @findex wl-summary-mark-as-read-all
2741 (@code{wl-summary-mark-as-read-all})
2745 @findex wl-summary-reply
2746 Prepare a draft for reply the message at the current cursor point.
2747 (@code{wl-summary-reply})
2751 @findex wl-summary-reply-with-citation
2752 Prepare a draft for reply the message at the current cursor point.
2753 (@code{wl-summary-reply-with-citation})
2757 @findex wl-summary-cancel-message
2758 If the message at current cursor point is your own netnews article,
2760 (@code{wl-summary-cancel-message})
2764 @findex wl-summary-reedit
2765 Prepare a draft for re-editing the message at current cursor point.
2766 If the message at current cursor point is your own netnews article,
2767 a draft for `supersedes message' for the message is prepared.
2768 (@code{wl-summary-reedit})
2771 @kindex M-e (Summary)
2772 @findex wl-summary-resend-bounced-mail
2773 If the message at current cursor point is a bounced message,
2774 a draft for re-sending original message is prepared.
2775 (@code{wl-summary-resend-bounced-mail})
2779 @findex wl-summary-forward
2780 A draft for forwarding the message at current cursor point is prepared.
2781 (@code{wl-summary-forward})
2785 @findex wl-summary-mark-as-important
2786 Put @samp{$} mark on the message at current cursor point.
2787 If already marked as @samp{$}, delete it.
2788 (@code{wl-summary-mark-as-important})
2794 Save the message at current cursor point.
2795 @findex wl-summary-save
2796 (@code{wl-summary-save})
2800 @findex wl-summary-next
2801 Move cursor to the next message.
2802 If message is marked with a temporal mark in
2803 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2804 In the offline mode, cursor is not moved to the messages which are not cached
2806 (@code{wl-summary-next})
2810 @findex wl-summary-prev
2811 Move cursor to the previous message.
2812 If message is marked with a temporal mark in
2813 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2814 In the offline mode, cursor is not moved to the messages which are not cached
2816 (@code{wl-summary-prev})
2820 @findex wl-summary-down
2821 Move cursor to the downward message which is unread or marked
2823 (@code{wl-summary-down})
2827 @findex wl-summary-up
2828 Move cursor to the upward message which is unread or marked
2830 (@code{wl-summary-up})
2834 @findex wl-summary-write
2835 Prepare a new draft.
2836 (@code{wl-summary-write})
2840 @findex wl-summary-write-current-folder
2841 Prepare a new draft. If the current folder is NNTP folder,
2842 @samp{Newsgroups:} field is completed. If the current folder is mailing
2843 list folder (refile destination), guess @samp{To:} field and completed
2844 (If @code{wl-subscribed-mailing-list} is valid list)
2845 (@code{wl-summary-write-current-folder})
2849 @findex wl-summary-redisplay-all-header
2850 Redisplay the message at current cursor point with all header fields.
2851 (@code{wl-summary-redisplay-all-header})
2855 @findex wl-summary-redisplay-no-mime
2856 Redisplay the message at current cursor point without MIME analysis.
2857 (@code{wl-summary-redisplay-no-mime})
2861 @findex wl-summary-burst
2862 If the message at current cursor point has
2863 encapsulates multiple messages using MIME,
2864 de-capsulate and extract them on the current folder.
2865 (@code{wl-summary-burst})
2868 @kindex @@ (Summary)
2869 @findex wl-summary-edit-addresses
2870 Append/change/delete the message's sender information to the address
2871 book @file{~/.addresses} interactively. If this command is called with
2872 prefix argument, arbitrary address can be edited.
2873 (@code{wl-summary-edit-petname})
2877 @findex wl-status-update
2878 Sync up address book status with @file{~/.addresses}'s content.
2879 (@code{wl-status-update})
2883 @findex wl-summary-pipe-message
2884 Pipe current message's content to the external process.
2885 (@code{wl-summary-pipe-message})
2889 @findex wl-summary-print-message
2890 Print out current message's content.
2891 It uses @code{ps-print} module in Emacs 20.x.
2892 If you don't use color printer, you might want to set
2893 @code{wl-ps-print-buffer-func} to @code{ps-print-buffer}.
2896 (setq wl-ps-print-buffer-func 'ps-print-buffer)
2899 (@code{wl-summary-print-message})
2903 @findex wl-summary-exit
2904 Exit current folder.
2905 (@code{wl-summary-exit})
2909 @findex wl-summary-jump-to-current-message
2910 Jump cursor to the currently displayed message's window.
2911 (@code{wl-summary-jump-to-current-message})
2915 Jump cursor to the other message.
2916 @findex wl-summary-jump-to-msg
2917 (@code{wl-summary-jump-to-msg})
2921 Update summary status and
2922 prefetch all messages which have marks included in the
2923 @code{wl-summary-incorporate-marks}.
2924 @findex wl-summary-incorporate
2925 (@code{wl-summary-incorporate})
2928 @kindex M-j (Summary)
2929 @findex wl-summary-jump-to-msg-by-message-id
2930 Jump cursor to the message which have specified @samp{Message-Id:}. If
2931 @code{elmo-use-database} is non-nil, other folder is also searched.
2932 (@code{wl-summary-jump-to-msg-by-message-id})
2936 Jump to parent message.
2937 @findex wl-summary-jump-to-parent-message
2938 (@code{wl-summary-jump-to-parent-message})
2942 @findex wl-summary-mark-as-unread
2943 Mark as unread the message at current cursor point.
2944 (@code{wl-summary-mark-as-unread})
2948 @findex wl-summary-sync
2949 Synchronize summary view after prompting the update range
2950 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
2954 all ...Discard current summary and update all message.
2955 update ...Update the difference between summary and the folder itself.
2956 rescan ...Rescan the msgdb and display again.
2957 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2958 first, last ...Move to the filter folder(partial filter).
2963 (@code{wl-summary-sync})
2967 @findex wl-summary-sort
2969 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
2970 (@code{wl-summary-sort})
2974 @findex wl-summary-toggle-thread
2975 Toggle the threading.
2976 Threading status is displayed on the modeline.
2977 @samp{@{S@}} means threading is off (Sequence) and
2978 @samp{@{T@}} means threading is on (Thread).
2979 (@code{wl-summary-toggle-thread})
2983 @findex wl-summary-toggle-disp-folder
2984 Toggle displaying of folder window.
2985 (@code{wl-summary-toggle-disp-folder})
2989 Toggle displaying of message window.
2990 @findex wl-summary-toggle-disp-msg
2991 (@code{wl-summary-toggle-disp-msg})
2995 Move to the virtual folder with the condition specified.
2996 If called with prefix argument and current folder is virtual, exit it.
2997 @findex wl-summary-virtual
2998 (@code{wl-summary-virtual})
3001 @kindex @key{TAB} (Summary)
3002 @findex wl-summary-goto-last-displayed-msg
3003 Jump to the message which is displayed last.
3004 (@code{wl-summary-goto-last-displayed-msg})
3008 Put @samp{*} mark on the messages that satisfies the specified condition.
3009 @findex wl-summary-pick
3010 (@code{wl-summary-pick})
3014 @findex wl-summary-mark-as-read
3015 Mark as read the message at the current cursor point.
3016 (@code{wl-summary-mark-as-read})
3020 Prefetch the message at the current cursor point.
3021 With prefix argument, prefetch the message even if it is cached.
3022 @findex wl-summary-prefetch
3023 (@code{wl-summary-prefetch})
3027 Execute @samp{D}, @samp{o} and @samp{O} marks.
3028 @findex wl-summary-exec
3029 (@code{wl-summary-exec})
3033 @findex wl-summary-target-mark-line
3034 Put target mark on the message at the current cursor point.
3035 (@code{wl-summary-target-mark-line})
3039 Put refile mark on the message at the current cursor point.
3040 @findex wl-summary-refile
3041 (@code{wl-summary-refile})
3044 @kindex C-o (Summary)
3045 Execute auto refile.
3046 @findex wl-summary-auto-refile
3047 (@code{wl-summary-auto-refile})
3051 Put copy mark on the message at the current cursor point.
3052 @findex wl-summary-copy
3053 (@code{wl-summary-copy})
3056 @kindex M-o (Summary)
3057 Put refile mark on the message at the current cursor point with the destination
3058 previously specified.
3059 @findex wl-summary-refile-prev-destination
3060 (@code{wl-summary-refile-prev-destination})
3064 @findex wl-summary-delete
3065 Put delete mark on the message at the current cursor point.
3066 (@code{wl-summary-delete})
3070 @findex wl-summary-unmark
3071 Unmark the temporal mark on the message at the current cursor point.
3072 (@code{wl-summary-unmark})
3076 Unmark all the temporal marks.
3077 @findex wl-summary-unmark-all
3078 (@code{wl-summary-unmark-all})
3081 @kindex r R (Summary)
3082 @findex wl-summary-mark-as-read-region
3083 Mark as read messages in the specified region.
3084 (@code{wl-summary-mark-as-read-region})
3087 @kindex r $ (Summary)
3088 @findex wl-summary-mark-as-important-region
3089 Mark as important @samp{$} messages in the specified region.
3090 If @samp{$} already exists, it is deleted.
3091 (@code{wl-summary-mark-as-important-region})
3094 @kindex r ! (Summary)
3095 @findex wl-summary-mark-as-unread-region
3096 Mark as unread messages in the specified region.
3097 (@code{wl-summary-mark-as-unread-region})
3100 @kindex r i (Summary)
3101 @findex wl-summary-prefetch-region
3102 Prefetch messages in the specified region.
3103 (@code{wl-summary-prefetch-region})
3106 @kindex r x (Summary)
3107 @findex wl-summary-exec-region
3108 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3110 (@code{wl-summary-exec-region})
3113 @kindex r * (Summary)
3114 @findex wl-summary-target-mark-region
3115 Put target mark on the messages in the specified region.
3116 (@code{wl-summary-target-mark-region})
3119 @kindex r o (Summary)
3120 @findex wl-summary-refile-region
3121 Put refile mark on the messages in the specified region.
3122 (@code{wl-summary-refile-region})
3125 @kindex r O (Summary)
3126 @findex wl-summary-copy-region
3127 Put copy mark on the messages in the specified region.
3128 (@code{wl-summary-copy-region})
3131 @kindex r d (Summary)
3132 @findex wl-summary-delete-region
3133 Put delete mark on the messages in the specified region.
3134 (@code{wl-summary-delete-region})
3137 @kindex r u (Summary)
3138 @findex wl-summary-unmark-region
3139 Delete temporal mark on the messages in the specified region.
3140 (@code{wl-summary-unmark-region})
3143 @kindex r y (Summary)
3144 Save messages in the specified region.
3145 @findex wl-summary-save-region
3146 (@code{wl-summary-save-region})
3149 @kindex t R (Summary)
3150 @findex wl-thread-mark-as-read
3151 Mark as read messages which are the descendant of the current thread.
3152 With prefix argument, it affects on the all messages in the thread tree.
3153 (@code{wl-thread-mark-as-read})
3156 @kindex t $ (Summary)
3157 @findex wl-thread-mark-as-important
3158 Put important mark @samp{$} on the messages which are the
3159 descendant of the current thread.
3160 If @samp{$} mark exists, it is deleted.
3161 With prefix argument, it affects on the all messages in the thread tree.
3162 (@code{wl-thread-mark-as-important})
3165 @kindex t ! (Summary)
3166 @findex wl-thread-mark-as-unread
3167 Mark as unread messages which are the descendant of the current thread.
3168 With prefix argument, it affects on the all messages in the thread tree.
3169 (@code{wl-thread-mark-as-unread})
3172 @kindex t i (Summary)
3173 @findex wl-thread-prefetch
3174 Prefetch messages which are the descendant of the current thread.
3175 With prefix argument, it affects on the all messages in the thread tree.
3176 (@code{wl-thread-prefetch})
3179 @kindex t x (Summary)
3180 @findex wl-thread-exec
3181 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3182 the descendant of the current thread. With prefix argument, it affects
3183 on the all messages in the thread tree.
3184 (@code{wl-thread-exec})
3187 @kindex t * (Summary)
3188 @findex wl-thread-target-mark
3189 Put target mark @samp{*} on the messages which are the descendant of the
3190 current thread. With prefix argument, it affects on the all messages in
3192 (@code{wl-thread-target-mark})
3195 @kindex t o (Summary)
3196 @findex wl-thread-refile
3197 Put refile mark on the messages which are the descendant of the current thread.
3198 With prefix argument, it affects on the all messages in the thread tree.
3199 (@code{wl-thread-refile})
3202 @kindex t O (Summary)
3203 @findex wl-thread-copy
3204 Put copy mark on the messages which are the descendant of the current thread.
3205 With prefix argument, it affects on the all messages in the thread tree.
3206 (@code{wl-thread-copy})
3209 @kindex t d (Summary)
3210 @findex wl-thread-delete
3211 Put delete mar on the messages which are the descendant of the current thread.
3212 With prefix argument, it affects on the all messages in the thread tree.
3213 (@code{wl-thread-delete})
3216 @kindex t u (Summary)
3217 @findex wl-thread-unmark
3218 Unmark temporal mark on the messages which are the descendant of the
3219 current thread. With prefix argument, it affects on the all messages in
3221 (@code{wl-thread-unmark})
3224 @kindex t y (Summary)
3225 @findex wl-thread-save
3226 Save messages which are the descendant of the current thread.
3227 With prefix argument, it affects on the all messages in the thread tree.
3228 (@code{wl-thread-save})
3231 @kindex m i (Summary)
3232 @findex wl-summary-target-mark-prefetch
3233 Prefetch all messages which have target mark @samp{*}.
3234 (@code{wl-summary-target-mark-prefetch})
3237 @kindex m R (Summary)
3238 @findex wl-summary-target-mark-mark-as-read
3239 Mark as read all messages which have target mark @samp{*}.
3240 (@code{wl-summary-target-mark-mark-as-read})
3243 @kindex m $ (Summary)
3244 @findex wl-summary-target-mark-mark-as-important
3245 Mark as important all messages which have target mark @samp{*}.
3246 If already marked as @samp{$}, it is deleted.
3247 (@code{wl-summary-target-mark-mark-as-important})
3250 @kindex m ! (Summary)
3251 @findex wl-summary-target-mark-mark-as-unread
3252 Mark as unread all messages which have target mark @samp{*}.
3253 (@code{wl-summary-target-mark-mark-as-unread})
3256 @kindex m o (Summary)
3257 @findex wl-summary-target-mark-refile
3258 Put refile mark on the messages which have target mark @samp{*}.
3259 (@code{wl-summary-target-mark-refile})
3262 @kindex m O (Summary)
3263 @findex wl-summary-target-mark-copy
3264 Put copy mark on the messages which have target mark @samp{*}.
3265 (@code{wl-summary-target-mark-copy})
3268 @kindex m d (Summary)
3269 @findex wl-summary-target-mark-delete
3270 Put delete mark on the messages which have target mark @samp{*}.
3271 (@code{wl-summary-target-mark-delete})
3274 @kindex m y (Summary)
3275 @findex wl-summary-target-mark-save
3276 Save messages which have target mark @samp{*}.
3277 (@code{wl-summary-target-mark-save})
3280 @kindex m u (Summary)
3281 Unmark all temporal marks.
3282 (@code{wl-summary-delete-all-temp-marks})
3283 @findex wl-summary-delete-all-temp-marks
3286 @kindex m a (Summary)
3287 Put target mark @samp{*} on the all messages.
3288 (@code{wl-summary-target-mark-all})
3289 @findex wl-summary-target-mark-all
3292 @kindex m t (Summary)
3293 Put target mark @samp{*} on the messages in the current thread.
3294 @findex wl-summary-target-mark-thread
3295 (@code{wl-summary-target-mark-thread})
3298 @kindex m r (Summary)
3299 @findex wl-summary-target-mark-region
3300 Put target mark @samp{*} on the messages in the specified region.
3301 (@code{wl-summary-target-mark-region})
3304 @kindex m A (Summary)
3305 @findex wl-summary-target-mark-reply-with-citation
3306 Prepare a draft which cites all messages which have target mark @samp{*}.
3307 (@code{wl-summary-target-mark-reply-with-citation})
3310 @kindex m f (Summary)
3311 @findex wl-summary-target-mark-forward
3312 Prepare a draft which forwards all messages which have target mark @samp{*}.
3313 (@code{wl-summary-target-mark-forward})
3316 @kindex m U (Summary)
3317 @findex wl-summary-target-mark-uudecode
3318 Uudecode the messages which have target mark @samp{*}.
3319 (@code{wl-summary-target-mark-uudecode})
3322 @kindex m ? (Summary)
3323 @findex wl-summary-target-mark-pick
3324 Pick messages from the @samp{*} marked messages.
3325 That is, @samp{*} marks on the messages are remained
3326 if the specified condition is satisfied.
3327 (@code{wl-summary-target-mark-pick})
3330 @kindex M-t (Summary)
3331 @findex wl-toggle-plugged
3332 Toggle offline/online status of Wanderlust.
3333 (@code{wl-toggle-plugged})
3336 @kindex C-t (Summary)
3337 Start Wanderlust's plug-status manager.
3338 (@code{wl-plugged-change})
3341 @kindex C-c C-o (Summary)
3342 @findex wl-jump-to-draft-buffer
3343 Move to the draft buffer if available. If multiple draft buffer exists,
3344 moved to one after another. If prefix argument is specified, load draft
3345 folder's message to the draft buffer and jump to it.
3346 (@code{wl-jump-to-draft-buffer})
3349 @kindex M-w (Summary)
3350 @findex wl-summary-save-current-message
3351 Save the message at the current cursor point.
3352 (@code{wl-summary-save-current-message})
3355 @kindex C-y (Summary)
3356 @findex wl-summary-yank-saved-message
3357 Regard the message at the current cursor point as
3358 parent, connect the message saved by
3359 @code{wl-summary-save-current-message}
3361 (@code{wl-summary-yank-saved-message})
3365 @node Variables of Summary, , Key Bindings of Summary, Summary
3366 @section Customiziable variables
3369 @item wl-summary-move-order
3370 @vindex wl-summary-move-order
3371 The initial setting is @code{unread}. Specify cursor moving policy. If
3372 you want to precede new messages, set @code{new}. If you want to
3373 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3376 @item wl-auto-select-first
3377 @vindex wl-auto-select-first
3378 The initial setting is @code{nil}.
3379 If non-nil, first message is automatically displayed.
3381 @item wl-auto-select-next
3382 @vindex wl-auto-select-next
3383 The initial setting is @code{nil}. If non-nil, jump to next summary
3384 automatically. If @code{unread}, jump to next unread folder's summary
3385 after confirmation. If @code{skip-no-unread}, unread folders are
3386 automatically skipped.
3388 @item wl-thread-insert-opened
3389 @vindex wl-thread-insert-opened
3390 The initial setting is @code{nil}.
3391 If non-nil, thread is inserted as opened.
3393 @item wl-thread-open-reading-thread
3394 @vindex wl-thread-open-reading-thread
3395 The initial setting is @code{t}. If non-nil, reading thread is
3396 automatically opened though it is closed thread.
3398 @item wl-summary-exit-next-move
3399 @vindex wl-summary-exit-next-move
3400 The initial setting is @code{t}. If non-nil, move to next folder at
3403 @item wl-folder-move-cur-folder
3404 @vindex wl-folder-move-cur-folder
3405 The initial setting is @code{nil}. If non-nil, cursor position on the
3408 @item wl-summary-weekday-name-lang
3409 @vindex wl-summary-weekday-name-lang
3410 The initial setting is @samp{ja}. Specify language of the weekday.
3411 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3414 @item wl-summary-fix-timezone
3415 @vindex wl-summary-fix-timezone
3416 The initial setting is @samp{JST}. Timezone to adjust summary's
3417 timezone. If @code{nil}, adjust to GMT.
3419 @item wl-use-petname
3420 @vindex wl-use-petname
3421 The initial setting is @code{t}.
3422 If non-nil, sender part displays nickname.
3424 @item wl-break-pages
3425 @vindex wl-break-pages
3426 The initial setting is @code{t}.
3427 If non-nil, message is splitted as pages by @samp{^L}.
3429 @item wl-message-window-size
3430 @vindex wl-message-window-size
3431 The initial setting is '(1 . 4).
3432 A cons cell to specify the rate of summary and message window.
3433 car:cdr corresponds summary:message.
3435 @item wl-summary-recenter
3436 @vindex wl-summary-recenter
3437 The initial setting is t.
3438 If non-nil, cursor point is moved to the center of the summary window.
3440 @item wl-summary-indent-length-limit
3441 @vindex wl-summary-indent-length-limit
3442 The initial setting is 46.
3443 Specify the limit of thread indent level.
3444 If nil, max indent level is unlimited.
3446 @item wl-summary-no-from-message
3447 @vindex wl-summary-no-from-message
3448 The initial setting is @samp{nobody@@nowhere?}. A string which is
3449 displayed when there's no @samp{From:} field in the message.
3451 @item wl-summary-no-subject-message
3452 @vindex wl-summary-no-subject-message
3453 The initial setting is @samp{(WL:No Subject in original.)}. A string
3454 which is displayed when there's no @samp{Subject:} field in the message.
3456 @item wl-summary-width
3457 @vindex wl-summary-width
3458 The initial setting is 80.
3459 Width of summary line. If @code{nil}, summary line's width is as is.
3461 @item wl-use-folder-petname
3462 @vindex wl-use-folder-petname
3463 The initial setting is the list shown below:
3472 A list of display policy (symbol) of folder nickname. Available symbols
3477 Display folder petname on modeline.
3479 Destination folder is notified as nickname if
3480 @code{wl-auto-select-next} is non-nil.
3482 You can input folder name by nickname in the function
3483 @code{wl-summary-read-folder}.
3486 @item wl-summary-move-direction-toggle
3487 @vindex wl-summary-move-direction-toggle
3488 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3489 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3490 want to aware of reading direction, set this to @code{t}.
3493 @vindex wl-from-width
3494 The initial setting is 17.
3495 Width of sender part of summary line.
3497 @item wl-summary-divide-thread-when-subject-changed
3498 @vindex wl-summary-divide-thread-when-subject-changed
3499 The initial setting is @code{nil}. If non-nil, thread is splitted if
3500 the subject is changed.
3502 @item wl-summary-search-via-nntp
3503 @vindex wl-summary-search-via-nntp
3504 The initial setting is @code{confirm}.
3506 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3507 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3508 from the NNTP server @code{elmo-default-nntp-server}. The value of
3509 @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
3510 @code{elmo-default-nntp-stream-type} are used.
3512 If @code{confirm}, server name can be specified. You can specify NNTP
3513 folder format like @samp{-:username@@servername:119!}.
3515 @item wl-summary-keep-cursor-command
3516 @vindex wl-summary-keep-cursor-command
3517 The initial setting is the list shown below:
3521 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3526 When you entered to summary by these commands and the target summary
3527 buffer already exists, summary status is not automatically updated and
3528 cursor position is saved.
3530 @item wl-summary-update-confirm-threshold
3531 @vindex wl-summary-update-confirm-threshold
3532 The initial setting is 500. If updated message number is larger than
3533 this value, confirm whether drop them or not.
3535 @item wl-summary-always-sticky-folder-list
3536 @vindex wl-summary-always-sticky-folder-list
3537 The initial setting is @code{nil}.
3538 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3539 are automatically sticked. Each element is regexp of folder name.
3541 @item wl-summary-reserve-mark-list
3542 @vindex wl-summary-reserve-mark-list
3543 The initial setting is the list shown below:
3552 If a message is already marked as temporal marks in this list, the
3553 message is not marked by any mark command.
3555 @item wl-summary-skip-mark-list
3556 @vindex wl-summary-skip-mark-list
3557 The initial setting is the list shown below:
3566 If a message is already marked as temporal marks in this list, the
3567 message is skipped at cursor move.
3569 @item wl-fetch-confirm-threshold
3570 @vindex wl-fetch-confirm-threshold
3571 The initial setting is 30000 (bytes). If displaying message has larger
3572 size than this value, Wanderlust confirms whether fetch the message or
3573 not. If @code{nil}, the message is fetched without confirmation.
3575 @item wl-prefetch-threshold
3576 @vindex wl-prefetch-threshold
3577 The initial setting is 30000 (bytes). If prefetching message has larger
3578 size than this value and @code{wl-prefetch-confirm} is non-nil,
3579 Wanderlust confirms whether prefetch the message or not. If
3580 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3581 without confirmation.
3583 @item wl-prefetch-confirm
3584 @vindex wl-prefetch-confirm
3585 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3586 prefetch the message or not if the message has larger size than
3587 @code{wl-prefetch-threshold}.
3589 @item wl-cache-fetch-threshold
3590 @vindex wl-cache-fetch-threshold
3591 The initial setting is 30000 (bytes). The messages which have larger
3592 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3593 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3596 @item elmo-imap4-use-cache
3597 @vindex elmo-imap4-use-cache
3598 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3601 @item elmo-nntp-use-cache
3602 @vindex elmo-nntp-use-cache
3603 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3606 @item elmo-pop3-use-cache
3607 @vindex elmo-pop3-use-cache
3608 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3613 @node Message, Draft, Summary, Top
3614 @chapter Message Buffer
3616 Message Buffers utilize MIME-View mode of SEMI/tm. For operational
3617 procedures and key bindings, refer to respective documents.
3618 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3620 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3621 brings you back to Summary mode. @kbd{l} toggles display of Summary
3624 @section Key Bindings
3630 @findex wl-message-toggle-disp-summary
3631 Toggles display of Summary mode buffer.
3632 (@code{wl-message-toggle-disp-summary})
3635 @findex wl-message-refer-article-or-url
3636 @kindex Button-2 (Message)
3637 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3638 corresponding message if found.
3639 (@code{wl-message-refer-article-or-url})
3641 @item Button-4 (upward movement of a wheel)
3642 @kindex Button-4 (Message)
3643 @findex wl-message-wheel-down
3644 Scrolls the message backwards. When the top of the message is hit,
3645 moves to the previous message.
3646 (@code{wl-message-wheel-down})
3648 @item Button-5 (downward movement of a wheel)
3649 @kindex Button-5 (Message)
3650 @findex wl-message-wheel-up
3651 Scrolls the message forward. When the bottom of the message is hit,
3652 moves to the next message.
3653 (@code{wl-message-wheel-up})
3656 @section Customizable Variables
3659 @item wl-message-window-size
3660 @vindex wl-message-window-size
3661 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3662 its car and cdr value corresponds to the ratio of Summary and Message
3664 @item wl-message-ignored-field-list
3665 @vindex wl-message-ignored-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.
3669 If nil, the value of mime-view-ignored-field-list is used.
3670 @item wl-message-visible-field-list
3671 @vindex wl-message-visible-field-list
3672 (SEMI only) Initial setting is nil.
3673 All fields that match this list will be hidden in message buffer.
3674 Each elements are regexp of field-name. This value precedes
3675 wl-message-ignored-field-list.
3676 If nil, the value of mime-view-visible-field-list is used.
3677 @item wl-message-sort-field-list
3678 @vindex wl-message-sort-field-list
3679 (SEMI only) Initial setting is
3680 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3681 Header fields in message buffer are orderd by this value.
3682 Each elements are regexp of field-name.
3685 @node Draft, Disconnected Operations, Message, Top
3686 @chapter Draft Buffer
3688 At Summary mode, pressing @kbd{w} and the like creates a new draft
3689 buffer. You can edit and send mail and news articles in this buffer.
3693 Basically it is Emacs-standard mail mode.
3695 @subsection Address Completion
3697 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3698 addresses. @kbd{@key{TAB}} completes them.
3700 If you want to submit a news article, add @samp{Newsgroups:} field by
3701 yourself. Field names can be completed by @kbd{@key{TAB}}.
3703 If you save the draft buffer you are editing, it is appended to the
3704 folder specified by @code{wl-draft-folder}.
3706 Using @samp{FCC:} field, you can specify the folder to which a copy of
3707 the message is saved when it is sent.
3709 @subsection Editing Messages
3711 Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
3712 editing, refer to respective documents.
3713 @xref{MIME-Edit, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3715 @subsection Dynamic Modification of Messages
3716 @vindex wl-draft-config-alist
3717 @c @cindex Change Message
3718 @c @cindex Message, Change Dynamic
3720 You can set @code{wl-draft-config-alist} so that header and body of the
3721 message will automatically modified depending on information of header
3724 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3726 In the example below, the header is modified when
3727 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3728 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3729 before sending the message.
3733 (setq wl-draft-config-alist
3734 '(((string-match "aaa.example.com$" (system-name))
3735 ;; @r{applied if the expression is non-nil}
3736 (wl-smtp-posting-server . "mailserver-B")
3737 (wl-nntp-posting-server . "newsserver-B")
3738 ;; @r{settings of temporary variables}
3740 ("^To: .*user@@aaa.bbb.example.com"
3741 ;; @r{applied if it matches the header of the draft buffer}
3742 ("Organization" . (format "Go %s" my-webpage)))
3743 ;; @r{you can write elisp expressions here (eval only)}
3744 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3745 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3750 The format of @code{wl-draft-config-alist} is:
3754 '(("@var{regexp of the header}" or @var{elisp expression}
3755 ("@var{Field}" . value(@var{elisp expression}))
3756 (@var{variable} . value(@var{elisp expression}))
3757 (@var{sub-function} . value(@var{elisp expression}))
3760 ("@var{regexp of the header}" or @var{elisp expression}
3761 ("@var{Field}" . value(@var{elisp expression}))
3766 Per default, there are 10 following sub-functions.
3769 'header: Inserts the specified string at the bottom of the header.
3770 'header-file: Inserts the specified file at the bottom of the header.
3771 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3772 'top: Inserts the specified string at the top of the body.
3773 'top-file: Inserts the specified file at the top of the body.
3774 'body: Replaces the body with the specified string.
3775 Specifying @code{nil} deletes the entire body string.
3776 'body-file: Replaces the body with the content of the specified file.
3777 'bottom: Inserts the specified string at the bottom of the body.
3778 'bottom-file: Inserts the specified file at the top of the body.
3779 'template: Applies the specified template.
3780 (refer to the next subsection)
3783 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3784 change them or add your own functions. If you read the code, you can
3785 easily find how to write the functions.
3787 At the first of each item, @var{a regular expression of the header} or
3788 an @var{elisp expression} should be specified. In the case of an elisp
3789 expression, the item is applied when the expression is evaluated
3792 Per default, when multiple items match or are evaluated non-nil, all
3793 such items are applied, but if you set a variable
3794 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3797 At the second of the item, a cons or a list of functions should be
3798 specified. The car part of the cons should be a header field, a
3799 variable, or a sub-function. When a header field is specified, the
3800 field will be modified. If a variable is specified, the value of the
3801 variable will be modified temporarily.
3803 In the cdr part of a cons, not only a variable but also an elisp
3804 expression can be specified as is. If the car part is a header field
3805 and the cdr part is @code{nil}, the field will be deleted.
3807 See the next example as well:
3811 (setq wl-draft-config-alist
3813 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3814 ;; @r{applied if it matches the header of the buffer being replied}
3815 (body . " Hello.\n")
3816 (template . "default")
3821 As in the (1) above, if a header regexp is prepended with @code{reply},
3822 it is applied when the draft is prepared by @code{wl-summary-reply} for
3823 example, and when it matches the header being replied. It is ignored
3824 when there is no buffer being replied, like after @code{wl-draft} was
3827 Note that @code{wl-draft-config-alist} is applied only once when
3828 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3829 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3830 aborting transmission, execute @kbd{C-c C-e}
3831 (@code{wl-draft-config-exec}) explicitly.
3833 If you don't want to apply @code{wl-draft-config-alist} when
3834 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
3838 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
3841 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3842 prepared, do the following:
3845 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3848 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
3849 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
3853 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
3856 @subsection Inserting Templates
3858 @cindex Apply Template
3860 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3861 @kbd{M-x wl-template-select} in the draft buffer.
3863 The format of @code{wl-template-alist} is almost the same as
3864 @code{wl-draft-config-alist}.
3868 (setq wl-template-alist
3871 ("Organization" . "~/.wl sample")
3872 (body . "Hello.\n"))
3874 (template . "default") ;; @r{(a)}
3875 ("To" . "boss@@example.com")
3876 ("Subject" . "Report")
3877 (body-file . "~/work/report.txt")
3883 As you can see, the only difference is item (template) names such as
3884 @samp{default} and @samp{report}, instead of a regexp of header.
3885 Because definition of each item is the same as
3886 @code{wl-draft-config-alist}, you can call another template, like (a).
3888 Executing the command @code{wl-template-select} results in template
3889 selection, but the result differs depending on variable
3890 @code{wl-template-visible-select}.
3892 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3893 window is shown below the draft buffer. You can select a template by
3894 @kbd{n} and @kbd{p} seeing the buffer window.
3896 Press the @key{RET} key and the template is actually applied to the draft
3897 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3898 adjust the window size by @code{wl-template-buffer-lines}.
3900 If @code{wl-template-visible-select} is @code{nil}, you should type the
3901 name of the template in the mini buffer.
3903 As shown in the example in @code{wl-draft-config-alist}, you can select
3904 @samp{default} template by writing:
3907 (template . "default")
3910 @subsection Sending mail by POP-before-SMTP
3911 @cindex POP-before-SMTP
3913 You can send mail by POP-before-SMTP with this single line:
3916 (setq wl-draft-send-mail-func 'wl-draft-send-mail-with-pop-before-smtp)
3920 Configure the following variables if you need.
3923 @item wl-pop-before-smtp-user
3924 The POP user name for POP-before-SMTP authentication.
3925 If unset, @code{elmo-default-pop3-user} is used.
3927 @item wl-pop-before-smtp-server
3928 The POP server name for POP-before-SMTP authentication.
3929 If unset, @code{elmo-default-pop3-server} is used.
3931 @item wl-pop-before-smtp-authenticate-type
3932 The POP authentication method for POP-before-SMTP authentication.
3933 If unset, @code{elmo-default-pop3-authenticate-type} is used.
3935 @item wl-pop-before-smtp-port
3936 The POP port number for POP-before-SMTP authentication.
3937 If unset, @code{elmo-default-pop3-port} is used.
3939 @item wl-pop-before-smtp-stream-type
3940 If non-nil, POP connection is established using SSL. If
3941 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
3942 unset, @code{elmo-default-pop3-stream-type} is used.
3945 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
3946 unset, settings for POP folders (@code{elmo-default-pop3-*}) are
3948 Therefore, if SMTP server and POP server are actually the same, and if
3949 POP folder per default (such as @samp{&}) is available, no settings are
3952 Refer to the following URL about POP-before-SMTP.
3956 http://spam.ayamura.org/tools/smPbS.html
3957 http://www.iecc.com/pop-before-smtp.html
3961 @section Key Bindings
3962 @cindex Keybind, Draft Mode
3963 @cindex Keybind, Draft Buffer
3968 @kindex C-c C-y (Draft)
3969 @findex wl-draft-yank-original
3970 Cites the content of the current message buffer.
3971 (@code{wl-draft-yank-original})
3974 @kindex C-c C-p (Draft)
3975 @findex wl-draft-preview-message
3976 Previews the content of the current draft.
3977 This is useful for previewing MIME multi-part messages.
3978 (@code{wl-draft-preview-message})
3981 @kindex C-c C-s (Draft)
3982 @findex wl-draft-send
3983 Sends the content of the current draft. Does not erase the draft buffer.
3984 This is useful for sending multiple messages, which are a little different
3986 (@code{wl-draft-send})
3989 @kindex C-c C-c (Draft)
3990 @findex wl-draft-send-and-exit
3991 Sends the content of the current draft and erases the draft buffer.
3992 (@code{wl-draft-send-and-exit})
3995 @kindex C-x C-s (Draft)
3996 @findex wl-draft-save
3997 Save the current draft.
3998 (@code{wl-draft-save})
4001 @kindex C-c C-k (Draft)
4002 @findex wl-draft-kill
4003 Kills the current draft.
4004 (@code{wl-draft-kill})
4007 @kindex C-x k (Draft)
4008 @findex wl-draft-mimic-kill-buffer
4009 Kills the current draft.
4010 (@code{wl-draft-mimic-kill-buffer})
4013 @kindex C-c C-z (Draft)
4014 @findex wl-draft-save-and-exit
4015 Saves the current draft, and erases the draft buffer.
4016 This is useful if you want to suspend editing of the draft.
4017 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4018 the @samp{+draft} folder.
4019 (@code{wl-draft-save-and-exit})
4022 @kindex C-c C-r (Draft)
4023 @findex wl-caesar-region
4024 Encodes or decodes the specified region in Caesar cipher.
4025 (@code{wl-caesar-region})
4029 @findex wl-toggle-plugged
4030 Toggles off-line/on-line states of Wanderlust.
4031 (@code{wl-toggle-plugged})
4034 @kindex C-c C-o (Draft)
4035 @findex wl-jump-to-draft-buffer
4036 Jumps to the other draft buffer, if exists.
4037 With prefix argument, reads a file (if any) from the draft folder when
4038 there is no such buffer.
4039 (@code{wl-jump-to-draft-buffer})
4042 @kindex C-c C-e (Draft)
4043 @findex wl-draft-config-exec
4044 Applies @code{wl-draft-config-alist}.
4045 (@code{wl-draft-config-exec})
4048 @kindex C-c C-j (Draft)
4049 @findex wl-template-select
4051 (@code{wl-template-select})
4054 @kindex C-c C-a (Draft)
4055 @findex wl-draft-insert-x-face-field
4056 Inserts the content of a file @file{~/.xface} (the value of the variable
4057 @code{wl-x-face-file}) as an @samp{X-Face:} field in the draft buffer.
4059 There should be encoded X-Face strings as a content of a file @file{~/.xface}.
4060 (@code{wl-draft-insert-x-face-field})
4063 @section Customizable Variables
4066 @item wl-subscribed-mailing-list
4067 @vindex wl-subscribed-mailing-list
4068 The initial setting is @code{nil}. Mailing lists to which you
4069 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4070 field of a reply draft, removes your own address from
4071 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4072 contained in @samp{To:} or @samp{Cc:} field of a message to be
4073 automatically re-filed, the destination folder will be leaned in
4074 connection with the address.
4080 (setq wl-subscribed-mailing-list
4081 '("wl@@lists.airs.net"
4083 "emacs-mime-ja@@m17n.org"))
4087 @item wl-insert-mail-followup-to
4088 @vindex wl-insert-mail-followup-to
4089 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4090 field is automatically inserted in the draft buffer.
4092 @item wl-insert-mail-reply-to
4093 @vindex wl-insert-mail-reply-to
4094 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4095 field is automatically inserted in the draft buffer.
4097 @item wl-auto-insert-x-face
4098 @vindex wl-auto-insert-x-face
4099 The initial setting is @code{t}. If non-nil and there is an encoded
4100 X-Face string in a file @file{~/.xface} (the value of the variable
4101 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4102 draft buffer. If @code{nil}, it is not automatically inserted. Press
4103 @kbd{C-c C-a} to insert.
4105 @item wl-insert-message-id
4106 @vindex wl-insert-message-id
4107 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4108 is automatically inserted on the transmission.
4110 @item wl-local-domain
4111 @vindex wl-local-domain
4112 The initial setting is @code{nil}. If @code{nil}, the return value of
4113 the function @code{system-name} will be used as the domain part of
4116 If @code{system-name} does not return FQDN (i.e. the full name of the
4117 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4118 to the string of the local domain name without hostname (like
4119 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4120 @samp{.} @code{wl-local-domain} is used as domain part of the
4123 If your terminal does not have global IP, set the value of
4124 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4125 you use invalid @samp{Message-ID:}.)
4127 Moreover, concatenation of @code{system-name} @samp{.}
4128 @code{wl-local-domain} will be used as an argument to the HELO command
4131 @item wl-message-id-domain
4132 @vindex wl-message-id-domain
4133 The initial setting is @code{nil}. If non-nil, this value is used as a
4134 domain part of the @samp{Message-ID:}. If your terminal does not have
4135 global IP address, set unique string to this value (e.x. your e-mail
4138 @item wl-message-id-domain
4139 @vindex wl-message-id-domain
4140 The initial setting is @code{nil}. If @code{nil}, the return value of
4141 the function @code{system-name} will be used as the domain part of
4142 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4143 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4144 @strong{must} set this variable to the string of the full name of the
4145 host. Otherwise, you might be beaten up on the Net News.
4147 @item wl-draft-config-alist
4148 @vindex wl-draft-config-alist
4149 The initial setting is @code{nil}. Modifies the draft message just
4150 before the transmission. The content of @code{wl-draft-config-alist}
4151 will be automatically applied only once on the transmission. If you
4152 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4155 @item wl-template-alist
4156 @vindex wl-template-alist
4157 The initial setting is @code{nil}.
4158 This variable specifies the template to be applied in the draft buffer.
4160 @item wl-draft-config-matchone
4161 @vindex wl-draft-config-matchone
4162 The initial setting is @code{nil}. If non-nil, only the first matching
4163 item is used when @code{wl-draft-config-alist} is applied. If
4164 @code{nil}, all matching items are used.
4166 @item wl-template-visible-select
4167 @vindex wl-template-visible-select
4168 The initial setting is @code{t}.
4169 If non-nil, you can preview the result of the template selection in
4172 @item wl-template-confirm
4173 @vindex wl-template-confirm
4174 The initial setting is @code{nil}.
4175 If non-nil, asks for confirmation when you press the enter key to select
4176 template while previewing.
4178 @item wl-template-buffer-lines
4179 @vindex wl-template-buffer-lines
4180 The initial setting is 7.
4181 If @code{wl-template-visible-select} is non-nil, this variable specifies
4182 the size of the preview window.
4184 @item wl-draft-reply-buffer-style
4185 @vindex wl-draft-reply-buffer-style
4186 The initial setting is @code{split}. @code{split} or @code{full} can be
4187 specified. In the case of @code{full}, the whole frame will be used for
4188 a reply draft buffer when it is prepared.
4190 @item wl-draft-use-frame
4191 @vindex wl-draft-use-frame
4192 The initial setting is @code{nil}.
4193 If non-nil, use new frame for the draft.
4197 The initial setting is the value of the variable
4198 @code{user-mail-address}. The value of this variable is inserted as a
4199 @samp{From:} field of the draft when it is prepared.
4201 @item wl-envelope-from
4202 @vindex wl-envelope-from
4203 The initial setting is @code{nil}.
4204 The value of this variable is used for envelope from (MAIL FROM).
4205 If @code{nil}, the address part of @code{wl-from} is used.
4207 @item wl-user-mail-address-list
4208 @vindex wl-user-mail-address-list
4209 The initial setting is @code{nil}.
4210 This is the User's address list. If you have multiple addresses,
4215 The initial setting is @code{nil}.
4216 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4217 the draft when it is prepared. If function is specified, its return
4222 The initial setting is @code{nil}.
4223 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4224 the draft when it is prepared.
4226 @item wl-reply-subject-prefix
4227 @vindex wl-reply-subject-prefix
4228 The initial setting is @samp{Re: }.
4229 In the @samp{Subject:} of the reply draft, this string is prepended to
4230 the @samp{Subject:} of being replied.
4232 @item wl-draft-reply-use-address-with-full-name
4233 @vindex wl-draft-reply-use-address-with-full-name
4234 The initial setting is @code{t}.
4235 If non-nil, insert her full name with address when prepare a draft for
4236 reply a message. If it is @code{nil}, insert her address only.
4238 @item wl-draft-enable-queuing
4239 @vindex wl-draft-enable-queuing
4240 The initial setting is @code{t}.
4241 This flag controls off-line transmission. If non-nil, the draft is
4244 @item wl-draft-use-cache
4245 @vindex wl-draft-use-cache
4246 The initial setting is @code{t}.
4247 If non-nil, cache the message which is sent.
4249 @item wl-auto-flush-queue
4250 @vindex wl-auto-flush-queue
4251 The initial setting is t.
4252 This flag controls automatic transmission of the queue when Wanderlust
4253 becomes on-line. If non-nil, the queue is automatically transmitted
4254 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4255 manually, press @kbd{F} in the folder mode.
4257 @item wl-ignored-forwarded-headers
4258 @vindex wl-ignored-forwarded-headers
4259 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4260 All headers that match this regexp will be deleted when forwarding a message.
4262 @item wl-ignored-resent-headers
4263 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4264 All headers that match this regexp will be deleted when resending a message.
4266 @item wl-draft-always-delete-myself
4267 @vindex wl-draft-always-delete-myself
4268 If non-nil, always removes your own address from @samp{To:} and
4269 @samp{Cc:} when you are replying to the mail addressed to you.
4271 @item wl-draft-delete-myself-from-bcc-fcc
4272 @vindex wl-draft-delete-myself-from-bcc-fcc
4273 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4274 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4276 @item wl-smtp-posting-server
4277 @vindex wl-smtp-posting-server
4278 The initial setting is @code{nil}.
4279 This is the SMTP server name for mail transmission.
4281 @item wl-smtp-posting-user
4282 @vindex wl-smtp-posting-user
4283 The initial setting is @code{nil}.
4284 This is the user name for SMTP AUTH authentication. If @code{nil},
4285 @code{smtp-authenticate-user} is used.
4287 @item wl-smtp-authenticate-type
4288 @vindex wl-smtp-authenticate-type
4289 The initial setting is @code{nil}.
4290 This is the authentication method for SMTP AUTH authentication. If
4291 @code{nil}, @code{smtp-authenticate-type} is used. If
4292 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4295 @item wl-smtp-connection-type
4296 @vindex wl-smtp-connection-type
4297 The initial setting is @code{nil}.
4298 This variable specifies how to establish SMTP connections.
4299 If @code{nil}, @code{smtp-connection-type} is used.
4300 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4302 @item wl-nntp-posting-server
4303 @vindex wl-nntp-posting-server
4304 The initial setting is @code{nil}.
4305 This is the NNTP server name used for news submission.
4306 If @code{nil}, @code{elmo-default-nntp-server} is used.
4308 @item wl-nntp-posting-user
4309 @vindex wl-nntp-posting-user
4310 The initial setting is @code{nil}.
4311 This is the user name for AUTHINFO authentication on news submission.
4312 If @code{nil}, @code{elmo-default-nntp-user} is used.
4313 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4315 @item wl-nntp-posting-port
4316 @vindex wl-nntp-posting-port
4317 The initial setting is @code{nil}.
4318 This is the port number of the NNTP server used for news submission.
4319 If @code{nil}, @code{elmo-default-nntp-server} is used.
4321 @item wl-nntp-posting-stream-type
4322 @vindex wl-nntp-posting-stream-type
4323 The initial setting is @code{nil}.
4324 If @code{nil}, @code{elmo-default-nntp-stream-type} is evaluated. If non-nil,
4325 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4326 connection will be established.
4328 @item wl-pop-before-smtp-user
4329 @vindex wl-pop-before-smtp-user
4330 The initial setting is @code{nil}.
4331 This is the POP user name for POP-before-SMTP.
4332 If it is @code{nil}, @code{elmo-default-pop3-user} is used.
4334 @item wl-pop-before-smtp-server
4335 @vindex wl-pop-before-smtp-server
4336 The initial setting is @code{nil}.
4337 This is the POP server name for POP-before-SMTP.
4338 If it is @code{nil}, @code{elmo-default-pop3-server} is used.
4340 @item wl-pop-before-smtp-authenticate-type
4341 @vindex wl-pop-before-smtp-authenticate-type
4342 The initial setting is @code{nil}.
4343 This is the authentication method for POP-before-SMTP authentication.
4344 If it is @code{nil}, @code{elmo-default-pop3-authenticate} is used.
4346 @item wl-pop-before-smtp-port
4347 @vindex wl-pop-before-smtp-port
4348 The initial setting is @code{nil}.
4349 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4350 @code{elmo-default-pop3-port} is used.
4352 @item wl-pop-before-smtp-stream-type
4353 @vindex wl-pop-before-smtp-stream-type
4354 The initial setting is @code{nil}.
4355 This flag controls the use of SSL for POP-before-SMTP. If it is
4356 @code{nil}, @code{elmo-default-pop3-stream-type} is used. If @code{starttls},
4357 STARTTLS (RFC2595) connection will be established.
4359 @item wl-draft-queue-save-variables
4360 @vindex wl-draft-queue-save-variables
4361 Specifies a list of variable to which queued messages are saved on the
4362 off-line transmission.
4364 @item wl-draft-sendlog
4365 @vindex wl-draft-sendlog
4366 The initial setting is @code{t}.
4367 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4371 @item drafts are sent by smtp or qmail
4372 @item saved into folders by fcc
4373 @item saved into folders by queuing
4376 (it is written even if the transmission fails).
4377 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4378 and left to the logging function of @command{imput}.
4381 @item wl-draft-sendlog-max-size
4382 @vindex wl-draft-sendlog-max-size
4383 The initial setting is 20000 (in bytes).
4384 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4385 beyond the size specified by this variable.
4389 The initial setting is @code{nil}.
4390 If non-nil, address completion uses LDAP.
4392 @item wl-ldap-server
4393 @vindex wl-ldap-server
4394 The initial setting is @samp{localhost}.
4395 LDAP server name for address completion.
4398 @vindex wl-ldap-port
4399 The initial setting is @code{nil}.
4400 If non-nil, the value is used as port number.
4403 @vindex wl-ldap-base
4404 The initial setting is @samp{c=US}.
4405 LDAP search starting point (base) for address completion.
4407 @item wl-draft-remove-group-list-contents
4408 @vindex wl-draft-remove-group-list-contents
4409 The initial setting is @code{t}.
4410 If non-nil, remove the group-lists' members in the recipients when
4411 sending the message (group-list means the description such as
4412 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4415 @node Disconnected Operations, Expire and Archive, Draft, Top
4416 @chapter Off-line Management
4417 @cindex Disconnected Operations
4419 Wanderlust has on-line and off-line states.
4422 * Off-line State:: Wanderlust has on-line and off-line states.
4423 * Enable Operations:: Enable Disconeected Operations.
4424 * Plugged Mode:: Switching On-line/Off-line per Server/Port.
4425 * Off-line State settings:: Invoking Wanderlust in the Off-line State.
4426 * Variables of Plugged Mode:: Customize Plugged Mode.
4430 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4431 @section Off-line State
4433 Wanderlust has on-line and off-line states. In the off-line state, you
4434 cannot access messages via network, unless they are cached.
4436 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4437 in the mode line indicates the off-line state. In folder or summary
4438 modes, press @kbd{M-t} to switch between off- and on-line.
4440 You can invoke Wanderlust in the off-line state by setting
4441 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4443 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4444 ignores uncached messages.
4447 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4448 @section Enable Disconeected Operations
4450 Even in the off-line state, provided that relevant messages are cached,
4451 and the variable @code{elmo-enable-disconnected-operation} (described
4452 later) is non-nil, you can following operations:
4453 @xref{Plugged Mode}, @xref{Off-line State settings}.
4456 * Send Messages off-line:: Transmit Messages.
4457 * Re-file and Copy queue:: Re-file and Copy (IMAP4).
4458 * Creation of Folders:: Create Folders off-line (IMAP4).
4459 * Marking:: Mark (IMAP4).
4460 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP).
4463 As soon as Wanderlust becomes on-line, such operations invoked off-line
4464 are reflected in the servers via network.
4467 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4468 @subsection Transmission of Messages
4470 You can send mail/news messages off-line (if you are using
4471 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4472 accumulated in the queue folder, @samp{+queue}. These messages are
4473 transmitted at once when Wanderlust becomes on-line.
4475 You can visit @samp{+queue} in the off-line state and confirm content of
4476 messages in the queue. You can also remove messages. Removed messages
4477 are not transmitted even in the on-line state.
4480 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4481 @subsection Re-file and Copy (IMAP4)
4483 Re-file and copy operations to IMAP folders invoked during the off-line
4484 state are accumulated in the queue, and reflected in the server side
4485 when Wanderlust becomes on-line. If you visit destination folders after
4486 off-line re-file or copy, it looks as if messages were appended even in
4489 For the safety reasons, messages re-filed off-line are removed from
4490 source folders only if their @samp{Message-ID:} match messages on the
4491 servers. While the queue is processed, messages that failed to be
4492 re-filed or copied to the specified folders are appended to the folder
4496 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4497 @subsection Creation of Folders (IMAP4)
4499 You can create IMAP folders off-line. The creation of folders are
4500 reflected in the servers when Wanderlust becomes on-line. At that time,
4501 if folders failed to be created on the servers for any reasons, messages
4502 re-filed to such folders are appended to the folder @samp{+lost+found}.
4505 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4506 @subsection Marking (IMAP4)
4508 Off-line changes in unread/read and importance mark @samp{$} information
4509 are also reflected in the servers when Wanderlust becomes on-line.
4512 @node Pre-fetching Reservations, , Marking, Enable Operations
4513 @subsection Pre-fetching (IMAP4, NNTP)
4515 You can make reservations for pre-fetching messages in IMAP or NNTP
4516 folders. Reserved messages are marked with @samp{!} but not cached
4517 yet. When Wanderlust becomes on-line, they are pre-fetched from
4520 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4521 these off-line operations for IMAP4 and NNTP do not take place, and
4522 off-line re-file, copy or suchlike simply results in error.
4524 Because off-line operations use cache files, it is a bad idea to erase
4525 them by hand; it may cause Wanderlust to malfunction.
4527 If you want to remove caches, be sure to execute @kbd{M-x
4528 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4529 remove caches for messages relevant to off-line operations.
4532 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4533 @section Switching On-line/Off-line per Server/Port
4535 @kbd{M-t} described above switches networking states as a whole, but you
4536 can switch on-line/off-line per server/port.
4538 Pressing @kbd{C-t} in the folder or summary modes brings you in
4539 wl-plugged-mode shown below, in which you can change the plugged state
4544 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4547 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4548 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4550 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4551 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4557 The first line indicates status of the following three variables, and
4558 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
4559 column modifies the values of these variables.
4563 "Queuing" @code{wl-draft-enable-queuing}
4564 "AutoFlushQueue" @code{wl-auto-flush-queue}
4565 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4569 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4572 The second and after lines indicate on-line/off-line states of servers
4573 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4574 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4575 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4577 @dfn{sending queue} means messages accumulated in the folder
4578 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4579 off-line operations when @code{elmo-enable-disconnected-operation} is
4581 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4582 @c off-line operations are enabled.
4584 They are displayed if there are any of them. In the example above, in
4585 the sending queue there are two messages (the first and the second in
4586 the queue folder) for smtp to hosta and one (the third) for nntp to
4587 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4590 If you change @samp{(wl-plugged)} in the second line, the variable
4591 @code{wl-plugged} is changed, so that the mode line indicator and
4592 plugged states of all ports are affected. If you change plugged states
4593 of any servers or ports, @samp{(wl-plugged)} in the second line is
4594 affected depending on @code{elmo-plugged-condition} settings and the
4595 plugged state of each port.
4598 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4599 @section Invoking Wanderlust in the Off-line State
4601 As described before, if you set @code{wl-plugged} to @code{nil} in
4602 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4603 off-line state. You can specify off-line state on a per server or port
4604 basis. Refer to @code{wl-reset-plugged-alist} also.
4606 Usually, when Wanderlust starts up, the plugged state of each port is
4607 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4608 @code{wl-nntp-posting-server} and so on. If you want to change the
4609 plugged state of these ports or to add other ports, configure
4610 @code{wl-make-plugged-hook} with a function.
4614 (add-hook 'wl-make-plugged-hook
4616 (elmo-set-plugged plugged-value(t/nil) server port)
4617 ;; @r{add or change plugged states of the port of the server}
4618 (elmo-set-plugged plugged-value(t/nil) server)
4619 ;; @r{if the port is omitted, all ports are affected}
4620 ;; @r{(you cannot omit the port if you newly add the server)}
4626 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4627 @section Customizable Variables
4632 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4633 mode from the beginning.
4635 @item wl-queue-folder
4636 @vindex wl-queue-folder
4637 The initial setting is @samp{+queue}.
4638 This is the folder in which messages in the transmission queue are
4641 @item wl-auto-flush-queue
4642 @vindex wl-auto-flush-queue
4643 The initial setting is @code{t}.
4644 This flag controls automatic transmission of the queue when Wanderlust
4645 becomes on-line. If non-nil, the queue is automatically transmitted
4646 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4647 manually, press @kbd{F} in the folder mode.
4649 @item elmo-enable-disconnected-operation
4650 @vindex elmo-enable-disconnected-operation
4651 The initial setting is @code{nil}. Controls off-line operations
4652 regarding IMAP4. If non-nil, off-line operations are carried out.
4654 @item elmo-lost+found-folder
4655 @vindex elmo-lost+found-folder
4656 The initial setting is @samp{+lost+found}.
4657 This is the folder to which messages are saved when they fails to be
4658 appended while the off-line re-file/copy queue is processed.
4660 @item elmo-plugged-condition
4661 @vindex elmo-plugged-condition
4662 The initial setting is @code{one}.
4663 The value of @code{wl-plugged} reflects the return value of the function
4664 @code{elmo-plugged-p} (without arguments).
4665 This variable @code{elmo-plugged-condition} specifies the condition on
4666 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4667 plugged state of each port.
4670 'one : plugged if one or more ports are plugged.
4671 'all : plugged if all ports are plugged.
4672 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4673 states of the ports.
4674 @var{function} : reflects the return value of the @var{function}
4675 functions available per default
4676 'elmo-plug-on-by-servers
4677 : reflects the plugged state of the servers specified by the
4678 variable elmo-plug-on-servers.
4679 'elmo-plug-on-by-exclude-servers
4680 : reflects the plugged state of the servers that are not
4681 in elmo-plug-on-exclude-servers.
4682 elmo-plug-on-exclude-servers defaults to
4685 (system-name)without the domain part)
4691 (setq elmo-plugged-condition 'all)
4693 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4694 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4696 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4697 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4701 @item wl-reset-plugged-alist
4702 @vindex wl-reset-plugged-alist
4703 The initial setting is @code{t}. If non-nil, plugged states are
4704 initialized on a per server or port basis when Wanderlust starts up.
4706 If @code{nil}, plugged states are retained while Emacs is running. In
4707 other words, they are initialized when Emacs is restarted even if the
4708 value is @code{nil}.
4712 @node Expire and Archive, Scoring, Disconnected Operations, Top
4713 @chapter Automatic Expiration and Archiving of Messages
4714 @cindex Expire and Archive
4717 * Expire:: Expiration and Archiving
4718 * Archive:: Archiving All Messages
4722 @node Expire, Archive, Expire and Archive, Expire and Archive
4724 @cindex Expire Message
4726 Expiration means deletion of old messages which have outlasted a
4727 certain period of time.
4729 @code{wl-expire} supports not only simple deletion, but also moving to
4730 specified archiving folders.
4734 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4735 or @kbd{M-e} in the summary mode.
4737 @subsection Configuring @code{wl-expire-alist}
4739 An example configuration of @code{wl-expire-alist} is shown below.
4740 Everything in this @code{wl-expire-alist} makes a great difference in
4741 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4742 to @code{t}, especially in the initial stage.
4746 (setq wl-expire-alist
4747 '(("^\\+trash$" (date 14) remove)
4749 ("^\\+tmp$" (date 7) trash)
4750 ;; @r{re-file to @code{wl-trash-folder}}
4751 ("^\\+outbox$" (number 300) "$outbox;lha")
4752 ;; @r{re-file to the specific folder}
4754 ;; @r{do not expire}
4755 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4756 ;; @r{archive by message number (retaining numbers)}
4757 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4758 ;; @r{archive by a fixed number (retaining numbers)}
4759 ("^\\+diary$" (date 30) wl-expire-archive-date)
4760 ;; @r{archive by year and month (numbers discarded)}
4765 Items in the list has the format of:
4768 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4772 The folder is examined if it matches @var{regexp-for-folders} from the
4773 beginning of the list. If you invoke expiration on the folder that does
4774 not match any of them, nothing will happen. And if either the second or
4775 the third element of the item is @code{nil}, expiration will not take
4778 You can use any one of the following for
4779 @var{specification-of-message-to-be-deleted}:
4782 @item (number @var{n1} [@var{n2}])
4783 deletes messages depending on the number of messages in the folder.
4785 @var{n1} is the number of messages which should survive deletion, for example
4786 if its value is 500, the newest 500 messages survive and the rests are
4789 @var{n2} is the number of messages in the folder on which expiration should
4790 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4791 folders with 510 or more messages are expired.
4792 If you configured automatic expiration, frequently used folders may
4793 expire every time it receive messages, and you may be annoyed with the
4794 long delay in reading mail.
4795 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4796 expiration would not take place until a certain number of messages
4799 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4800 with important/new/unread) are not deleted.
4801 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4802 will expire so as to have 500 messages including such ones.
4803 Otherwise, it will have 500 messages except such ones.
4805 @item (date @var{d1})
4806 deletes messages depending on the dates.
4808 Messages dated @var{d1} or more days ago are deleted, for example if its
4809 value is seven, messages seven days old or more are deleted. Note that
4810 the date is the one in the @samp{Date:} field of the message, not when
4811 the message entered the folder.
4813 Messages with no or invalid @samp{Date:} field does not expire; you
4814 might have to delete them by hand.
4817 You can use any one of the following in the place of @var{destination}:
4821 deletes the messages instantly.
4824 hide the messages from summary (messages are not deleted).
4827 moves the messages to @code{wl-trash-folder}.
4829 @item @var{string}(folder)
4830 moves the messages to the folder specified with @var{string}.
4832 It would be useful for specifying an archiving folder, but because this
4833 does not move important messages, it might be better to use the
4834 standard functions described below.
4836 @item @var{function}
4837 invokes the specified @var{function}.
4839 To the @var{function}, three arguments are passed: a folder name, a list
4840 of messages to be deleted, and msgdb information of the summary. You
4841 can specify function-specific arguments after the name of the
4842 @var{function}. Note that the list contains messages with marks in
4843 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4846 These are three standard functions; they moves messages to an archive
4847 folder in the specified way. This means old messages can be compressed
4848 and saved in a file, being deleted from the original folder.
4851 @item wl-expire-archive-number1
4852 re-files to archiving folders corresponding to the message numbers of
4853 the messages being deleted. For example, a message numbered 102 will be
4854 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4855 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4856 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4858 The archiving folders to which messages are re-filed are determined by
4859 the name of the folder as follows (in this case, archiving folders are
4860 handled as if @code{elmo-archive-treat-file} were non-nil).
4863 @item If the folder type is localdir:
4864 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4866 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4867 (@file{~/Mail/ml/wl-00100.zip}).
4869 @item The folder type is other than localdir:
4870 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4872 For example, @samp{%#mh/ml/wl} corresponds to
4873 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4876 As you can see, in the case of localdir, the folder type is not included
4877 in the path name, but otherwise it is included.
4878 And you can control the prefix to the archiving folder name by
4879 @code{wl-expire-archive-folder-prefix}.
4880 Refer to @code{wl-expire-archive-folder-prefix} for details.
4882 @item wl-expire-archive-number2
4883 re-files every certain number of messages to archiving folders.
4885 This differs from @samp{wl-expire-archive-number1} in that this re-files
4886 to the folder up to the specified number regardless of message numbers.
4887 The archiving folders to which messages are re-filed are determined in the
4888 same way as @code{wl-expire-archive-number1}.
4890 @item wl-expire-archive-date
4891 re-files messages depending on its date (year and month) to archive
4894 For example, a message dated December 1998 is re-filed to
4895 @code{$folder-199812;zip}. The name of the archiving folders except the
4896 date part are determined in the same way as
4897 @code{wl-expire-archive-number1}.
4900 You can set the first argument to these three standard functions to non-nil
4901 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4902 For example, it can be specified just after the name of the function:
4905 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4908 If you omit the argument, consecutive numbers from 1 are assigned for
4909 each archiving folder.
4912 @subsection Treatment for Important or Unread Messages
4914 If you specify any of @code{remove}, @code{trash}, a folder name, or a
4915 standard function, messages with marks in
4916 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
4917 messages} thereafter) are retained.
4919 Per default, this variable include the important, new, and unread marks,
4920 so that messages with these marks are not removed.
4921 Note that you cannot include the temporary mark (i.e. temporary marks
4922 are removed anyway), and be sure to process temporary marks before you
4925 @subsection Auto Expiration
4927 The following setup invokes expiration when you move into the summary
4928 mode. There will be no confirmation, so make sure you made no mistake
4929 in regexp and other settings before you set up this.
4933 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4937 In the folder mode, you can invoke expiration per group as well as per
4938 folder. Therefore, if you specify @samp{Desktop} group, all folders
4939 matching @code{wl-expire-alist} expire.
4943 @subsection Treating archive folders.
4944 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
4945 you must set non-nil value to @code{elmo-archive-treat-file}.
4947 @subsection Confirming
4949 If you are to use @code{remove}, try @code{trash} at first and see
4950 messages move to @code{wl-trash-folder} as expected, then replace it
4951 with @code{remove}. It would be dangerous to use @code{remove} from the
4954 If you are to use @code{wl-expire-archive-number1} and the like, try to
4955 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
4956 you can append messages to it. Even if settings in
4957 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
4958 would not be saved anywhere and disappeared in case the archiver program
4961 After you make sure you can archive to the folder correctly, you can
4962 invoke expiration and utilize the log.
4964 If you set @code{wl-expire-use-log} to @code{t},
4965 @file{~/.elmo/expired-log} should contain the log, for example:
4969 delete +ml/wl (593 594 595 596 597 598 599)
4970 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
4974 The first column indicates the operation, i.e. @samp{delete},
4975 @samp{copy}, or @samp{move}. The next is the name of the folder that
4976 expired. In the case of @samp{copy} and @samp{move}, the destination
4977 folder is recorded after @samp{->}. The last is the list of message
4978 numbers that are actually deleted or moved (in the case of @samp{copy}
4979 and @samp{move}, the number is the one in the source folder, rather than
4980 the destination folder).
4982 @subsection Re-filing Reserved Messages
4984 The three standard functions copy reserved messages to the archive
4985 folder, but do not delete them from the source folder. Because
4986 reserved messages and the like always remain, they are recorded in
4987 @file{~/.elmo/expired-alist} so that they are not copied over and over
4988 again. They are not recorded if copied by @code{wl-summary-archive}.
4990 If you enabled logging, usually @samp{move} is recorded for re-filing,
4991 but instead @samp{copy} and @samp{delete} are recorded separately if
4992 reserved messages are involved. This is because it actually copies
4993 messages including reserved, then deletes ones except reserved in that
4996 @section Customizable Variables
4999 @item wl-expire-alist
5000 @vindex wl-expire-alist
5001 The initial setting is @code{nil}.
5002 This variable specifies folders and methods to expire. For details,
5003 refer to @code{wl-expire-alist} settings above.
5005 @item wl-summary-expire-reserve-marks
5006 @vindex wl-summary-expire-reserve-marks
5007 The initial setting is the list below.
5011 (list wl-summary-important-mark
5013 wl-summary-unread-mark
5014 wl-summary-unread-uncached-mark
5015 wl-summary-unread-cached-mark)
5019 Messages with these marks are retained in the folder, even after
5021 Only permanent marks can be listed, not temporary marks.
5023 You can list marks one by one as in the default; you can use the
5024 following settings as well:
5028 All messages with permanent marks are retained,
5029 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5033 All messages are handled as usual ones that are already read, no matter
5034 what marks they have; even important messages are deleted.
5037 @item wl-expire-archive-files
5038 @vindex wl-expire-archive-files
5039 The initial setting is 100.
5040 This variable specifies the number of messages to be retained in one
5043 @item wl-expire-number-with-reserve-marks
5044 @vindex wl-expire-number-with-reserve-marks
5045 The initial setting is @code{nil}.
5046 If non-nil, if expiring messages are specified by @code{number},
5047 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5049 @item wl-expire-archive-get-folder-func
5050 @vindex wl-expire-archive-get-folder-func
5051 The initial setting is @code{wl-expire-archive-get-folder}.
5053 This variable specifies a function that returns the name of an archiving
5054 folder for standard functions in the place of @var{destination}.
5055 You can use the following three variables for simple modification of
5056 folder names; if you want more complex settings, define your own
5057 function in this variable.
5059 @code{wl-expire-archive-get-folder} can be customized by these
5062 @item @code{wl-expire-archive-folder-name-fmt}
5063 @item @code{wl-expire-archive-folder-type}
5064 @item @code{wl-expire-archive-folder-prefix}
5067 @item wl-expire-archive-folder-name-fmt
5068 @vindex wl-expire-archive-folder-name-fmt
5069 The initial setting is @samp{%s-%%05d;%s}.
5070 This is a @code{format} string for archiving folders used in
5071 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5072 Note that you must specify the message number by @samp{%%d}, because it
5073 is parsed twice by @code{format}.
5075 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5078 @item wl-expire-archive-date-folder-name-fmt
5079 @vindex wl-expire-archive-date-folder-name-fmt
5080 The initial setting is @samp{%s-%%04d%%02d;%s}.
5081 This is a @code{format} string for archiving folders used in
5082 @code{wl-expire-archive-date}. Note that you must specify the message
5083 number by @samp{%%d}, because it is parsed twice by @code{format}.
5084 There should be @samp{%%d} twice, one for the year and the other for the
5087 If you modify this, adjust
5088 @code{wl-expire-archive-date-folder-num-regexp} as well.
5090 @item wl-expire-archive-folder-type
5091 @vindex wl-expire-archive-folder-type
5092 The initial setting is @code{zip}.
5093 This variable specifies an archiver type of the archiving folders.
5095 @item wl-expire-archive-folder-prefix
5096 @vindex wl-expire-archive-folder-prefix
5097 The initial setting is @code{nil}.
5098 This variable specifies the prefix (directory structure) to archiving
5100 Exercise extreme caution in using this feature, as it has not been
5102 In the worst case, there is a fear of destructing archiving folders.
5106 There will be no prefix.
5109 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5110 @samp{$ml/wl-00000;zip;wl}.
5113 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5116 @samp{$ml/wl-00000;zip;ml/wl}.
5119 @item wl-expire-archive-folder-num-regexp
5120 @vindex wl-expire-archive-folder-num-regexp
5121 The initial setting is @samp{-\\([-0-9]+\\);}.
5122 This variable specifies the regular expression to be used for getting
5123 message numbers from multiple archiving folders specified by
5124 @code{elmo-list-folders}.
5125 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5127 @item wl-expire-archive-date-folder-num-regexp
5128 @vindex wl-expire-archive-date-folder-num-regexp
5129 The initial setting is @samp{-\\([-0-9]+\\);}.
5130 This is the regular expression to be used for getting message numbers
5131 from multiple archiving folders specified by @code{elmo-list-folders}.
5132 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5134 @item wl-expire-delete-oldmsg-confirm
5135 @vindex wl-expire-delete-oldmsg-confirm
5136 The initial setting is @code{t}.
5137 If non-nil, messages older than the one with the largest number will be
5138 deleted with confirmation.
5139 If @code{nil}, they are deleted without confirmation.
5141 This feature is valid only if non-nil is specified as a argument to the
5142 standard functions so as to retain numbers.
5144 @item wl-expire-use-log
5145 @vindex wl-expire-use-log
5146 The initial setting is @code{nil}.
5147 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5148 They are appended but not truncated or rotated automatically; you might
5149 need to remove it manually.
5151 @item wl-expire-add-seen-list
5152 @vindex wl-expire-add-seen-list
5153 The initial setting is @code{t}.
5155 If non-nil, when messages are re-filed by expiration, read/unread
5156 information is passed to the destination folder.
5158 However if you do not read the destination folder from Wanderlust,
5159 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5160 want to set this to @code{nil} if you are simply saving to some
5161 archiving folders. Even if its value is @code{nil}, messages in the
5162 archiving folders are simply treated as unread; it does not affect
5165 @item wl-expire-folder-update-msgdb
5166 @vindex wl-expire-folder-update-msgdb
5167 The initial setting is @code{t}.
5168 If @code{t}, in the folder mode, expiration is carried out after
5169 updating summary information. If you specified a list of regular
5170 expressions of folder names, summary information is updated for matching
5175 @node Archive, , Expire, Expire and Archive
5176 @section Archiving Messages
5178 @subsection Archiving Messages
5179 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5180 folders. If there are the archiving folders already, only new messages
5183 You can use @code{wl-archive-alist} in order to specify how messages are
5184 archived according to their folder names, as in @code{wl-expire-alist}.
5189 (setq wl-archive-alist
5190 '(("^\\+tmp$" wl-archive-date)
5191 ("^\\+outbox$" wl-archive-number2)
5192 (".*" wl-archive-number1)))
5196 Each item in the list has the following format:
5199 (@var{folders-regexp} @var{deleting-function})
5202 As you can see, you can only use a function after @var{folders-regexp}.
5203 Per default, there are three functions:
5206 @item @code{wl-archive-number1}
5207 @item @code{wl-archive-number2}
5208 @item @code{wl-archive-date}
5211 As inferred from their names, they work similarly to "expire" versions,
5212 other than the following points:
5215 @item No messages are deleted
5216 @item Message numbers are retained even if invoked without arguments
5219 These functions are good to archive all messages in a folder by their
5220 numbers or by their dates.
5221 These are also useful for backup or confirmation purposes before
5223 If you try to re-file them after they are archived, they are deleted but
5226 Per default, the archiving folders to which messages are copied are
5227 determined automatically by @code{wl-expire-archive-get-folder-func}.
5228 You can copy to a specific folder by invoking with a prefix argument,
5229 i.e. @kbd{C-u M-x wl-summary-archive}.
5231 Note that this feature has not been seriously tested, because you can
5232 simply copy to an archiving folder, for example by
5233 @code{wl-summary-copy-region}.
5235 The archiving folders are determined by the same logic as in
5236 @code{wl-summary-expire}; the following customizable variables are
5240 @item @code{wl-expire-archive-files}
5241 @item @code{wl-expire-archive-get-folder-func}
5242 @item @code{wl-expire-archive-folder-name-fmt}
5243 @item @code{wl-expire-archive-folder-type}
5244 @item @code{wl-expire-archive-folder-prefix}
5245 @item @code{wl-expire-archive-folder-num-regexp}
5248 @subsection Customizable Variables
5251 @item wl-archive-alist
5252 @vindex wl-archive-alist
5253 The initial setting is the list shown below:
5257 ((".*" wl-archive-number1))
5262 This variable specifies a function that copies to archiving folders.
5263 To the function, three arguments are passed: a folder name, a list of
5264 messages in the folder, and msgdb information of the summary.
5265 Needless to say, you can use your own function.
5269 @node Scoring, Customization, Expire and Archive, Top
5270 @chapter Score of the Messages
5272 @c @cindex Kill File
5274 Scoring is the function that associates a score (value) with each
5275 message, and marks as read or deletes from the summary according to it.
5277 You can put target or important marks on essential messages, or read marks
5278 on the ones you do not want to read, for example spam articles.
5280 This scoring function has a capability and a format similar to the one
5281 that Gnus has, although there are some unsupported features and
5282 Wanderlust specifics.
5283 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5286 * Score Commands:: Score Commands
5287 * Score File Format:: Score File Format
5291 @node Score Commands, Score File Format, Scoring, Scoring
5292 @section Score Commands
5293 @cindex Score Commands
5295 @subsection Score File Specification
5297 @code{wl-score-folder-alist} specifies score files or variables in which
5298 scores are defined, corresponding to folder names.
5302 (setq wl-score-folder-alist
5311 If paths to the score files are omitted, the directory specified in the
5312 variable @code{wl-score-files-dir} is assumed.
5314 No matter what you write in @code{wl-score-folder-alist}, the default
5315 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5316 read (it does not have to exist).
5317 Therefore, in the example above, the three score files,
5318 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5319 the folders that matches @samp{^-.*}.
5321 @subsection Scored Messages
5323 Scores are attached to the messages that are specified by
5324 @code{wl-summary-score-marks} temporarily when the summary is updated;
5325 when you exit from the summary, the scores are removed and reverts to
5328 @subsection Creation of Score Files
5330 In the summary buffer, move to an appropriate message and type @kbd{L}.
5331 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5332 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5334 This makes @minus{}1000 are scored for messages with the same
5335 @samp{Subject:} as the string you entered. That is, such a score file
5336 is created automatically.
5338 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5339 The score file you just made appears.
5340 This buffer is called @dfn{score editing buffer} thereafter.
5341 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5342 as you are previously; type @kbd{a}. Then a score entry for "From"
5344 In this way, you can create a score file easily either in the summary
5345 buffer or in the score editing buffer.
5347 By the way, you might be aware the numbers of key strokes are different
5348 between @kbd{s s p} and @kbd{a}.
5349 This is determined by @code{wl-score-header-default-entry}.
5350 This variable specifies the default score entries corresponding to
5352 For example, for "subject" field, a type and a time limit are prompted,
5353 but for "from" field, they are fixed upon automatically as substring and
5354 permanent respectively.
5355 However, score values can be modified by the prefix argument.
5356 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5359 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5360 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5361 erasing contents of the buffer deletes the score file being edited.
5365 @subsubsection Selecting Score Files
5367 You can change score files to which scores are appended by
5368 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5369 @code{wl-score-change-score-file}.
5371 @subsubsection Summing Up the Score
5373 If you add the same entries by @code{wl-summary-increase-score},
5374 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5375 scores for the entry is summed up.
5377 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5378 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5379 @minus{}1200 will be created as a result.
5381 @subsubsection Creating Thread Key
5383 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5384 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5386 @subsubsection Creating Followup Key
5388 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5389 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5390 at the cursor to @samp{References} key.
5391 If @code{wl-score-auto-make-followup-entry} is non-nil,
5392 @samp{Message-ID} of all messages to be followed up within dates
5393 specified by @code{wl-score-expiry-days}.
5395 @subsection Key Bindings
5400 @findex wl-summary-increase-score
5401 Increases the score for the current message.
5402 And the score entry is appended to the score file at the same moment.
5403 You can specify the score value by a prefix argument.
5407 @findex wl-summary-lower-score
5408 Decreases the score for the current message.
5409 And the score entry is appended to the score file at the same moment.
5410 You can specify the score value by a prefix argument.
5413 @kindex h R (Summary)
5414 @findex wl-summary-rescore
5415 Re-applies the scoring.
5416 However, already scored messages are not scored anew.
5419 @kindex h c (Summary)
5420 @findex wl-score-change-score-file
5421 Changes the score file currently selected.
5424 @kindex h e (Summary)
5425 @findex wl-score-edit-current-scores
5426 Edits the score file currently selected.
5427 If there are multiple score files, the previously specified one is
5431 @kindex h f (Summary)
5432 @findex wl-score-edit-file
5433 Edits an arbitrary score file and selects it.
5436 @kindex h F (Summary)
5437 @findex wl-score-flush-cache
5438 Erases caches associated to the score files that are read.
5439 If you modified score files directly (from other than Wanderlust), you
5440 need to re-read them after erasing the cache.
5443 @kindex h m (Summary)
5444 @findex wl-score-set-mark-below
5445 Specifies the criterion for scores to be marked as read.
5446 Messages with scores less than this value are marked as read.
5449 @kindex h x (Summary)
5450 @findex wl-score-set-expunge-below
5451 Specifies the criterion for scores to be deleted from the summary.
5452 Messages with scores less than this value are deleted.
5453 "Deleted" means it is not shown; they are not removed from the summary
5454 information or the folder.
5455 The deleted messages can be shown by rescan-noscore again.
5458 @subsection Key Bindings in the Score Editing Buffer
5462 @kindex C-c C-k (Score Mode)
5463 @findex wl-score-edit-kill
5464 Abandons the file being edited.
5467 @kindex C-c C-c (Score Mode)
5468 @findex wl-score-edit-exit
5469 Saves the file being edited, and quits from the edit mode.
5472 @kindex C-c C-p (Score Mode)
5473 @findex wl-score-pretty-print
5477 @kindex C-c C-d (Score Mode)
5478 @findex wl-score-edit-insert-date
5479 Inserts the number of dates from Dec. 31, 1 B.C.
5480 It is used for creating the third factor of time-limited scores.
5483 @kindex C-c C-s (Score Mode)
5484 @findex wl-score-edit-insert-header
5485 Inserts the header of the message selected in the summary buffer.
5488 @kindex C-c C-e (Score Mode)
5489 @findex wl-score-edit-insert-entry
5490 Inserts the score entry of the message selected in the summary buffer.
5493 @subsection Customizable Variables
5496 @item wl-summary-default-score
5497 @vindex wl-summary-default-score
5498 The initial setting is 0 (zero).
5499 This variable specifies the default value of the score.
5500 The score is increased or decreased based upon this value.
5502 @item wl-summary-important-above
5503 @vindex wl-summary-important-above
5504 The initial setting is @code{nil}.
5505 Messages with scores larger than this value are attached with the
5506 important mark (@samp{$}).
5507 If @code{nil}, no important marks are attached.
5509 @item wl-summary-target-above
5510 @vindex wl-summary-target-above
5511 The initial setting is @code{nil}.
5512 Messages with scores larger than this value are attached with the target
5514 If @code{nil}, no target marks are attached.
5516 @item wl-summary-mark-below
5517 @vindex wl-summary-mark-below
5518 The initial setting is 0 (zero).
5519 Messages with scores smaller than this value are marked as read.
5521 @item wl-summary-expunge-below
5522 @vindex wl-summary-expunge-below
5523 The initial setting is @code{nil}.
5524 Messages with scores smaller than this value are deleted from the
5526 If @code{nil}, they are not deleted.
5528 @item wl-summary-score-marks
5529 @vindex wl-summary-score-marks
5530 The initial setting is the list shown below:
5534 (list wl-summary-new-mark)
5539 Messages with these marks are scored.
5541 @item wl-use-scoring
5542 @vindex wl-use-scoring
5543 The initial setting is t.
5544 If non-nil, scoring is enabled.
5546 @item wl-score-files-dir
5547 @vindex wl-score-files-dir
5548 The initial setting is @file{~/.elmo/}.
5549 The default directory for score files.
5551 @item wl-score-interactive-default-score
5552 @vindex wl-score-interactive-default-score
5553 The initial setting is 1000.
5554 This value is used as a score when a score factor is @code{nil} in the
5555 score file. It is also used in @code{wl-summary-increase-score} and
5556 @code{wl-summary-lower-score}, on condition that the value of
5557 @code{wl-score-header-default-entry} is @code{nil}.
5559 @item wl-score-expiry-days
5560 @vindex wl-score-expiry-days
5561 The initial setting is 7.
5562 This is the number of days before time-limited scores are deleted.
5564 @item wl-score-update-entry-dates
5565 @vindex wl-score-update-entry-dates
5566 The initial setting is @code{t}.
5567 If non-nil, it enables deletion of time-limited scores.
5569 @item wl-score-header-default-entry
5570 @vindex wl-score-header-default-entry
5571 Specifies the default value for each header field for score entries
5572 created by @code{wl-summary-increase-score},
5573 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5575 @item wl-score-simplify-fuzzy-regexp
5576 @vindex wl-score-simplify-fuzzy-regexp
5577 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5578 regular expression to be deleted from the string.
5579 Because this is usually used for Subject, the default is prefixes that
5580 are attached by mailing list programs.
5582 @item wl-summary-rescore-partial-threshold
5583 @vindex wl-summary-rescore-partial-threshold
5584 The initial setting is 200.
5585 When sync-all or rescan is executed, if there are messages more than
5586 this value, only the last same number of messages as this value are
5589 @item wl-summary-auto-sync-marks
5590 @vindex wl-summary-auto-sync-marks
5591 If non-nil, unread/important marks are synchronized when the summary
5593 Unread marks reflect information on the IMAP4 server.
5594 Important marks reflect information on the IMAP4 server (flagged or
5595 not), and contents of @samp{'mark} folder.
5596 The initial setting is @code{t}.
5600 @node Score File Format, , Score Commands, Scoring
5601 @section Score File Format
5602 @cindex Score File Format
5604 The format of score files are the same as Gnus, and basically you can
5605 use Gnus score files as they are. But they are not fully compatible
5606 because some keys are not supported and there are Wanderlust specifics.
5607 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5612 ("for sale" -1000 nil s)
5613 ("profit" -1000 nil s))
5615 ("spam@@spamspamspam" -10000 nil s))
5617 ("my@@address" 3001 nil s))
5619 (1000000 -10 nil >))
5629 If the key is a string, it is the name of the header to be matched.
5630 The following keys are available:
5631 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5632 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5633 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5634 @code{Chars} and @code{Lines} mean the size and the number of lines of
5635 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5636 are described later.
5637 The rest corresponds the field of the same name.
5639 Arbitrary numbers of core entries are specified after the key.
5640 Each score entry consists of these five factors:
5644 A factor that matches header. This should be a number in the cases of
5645 @code{lines} and @code{chars}, otherwise a string.
5648 A score factor. When the first item matches, the score of the message
5649 is increased or decreased by this value.
5652 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5653 of a number, the score is deleted if it does not match for days
5654 (@code{wl-score-expiry-days}) from the date specified by this.
5655 The date is since Dec. 31, 1 B.C.
5658 A type factor. This specifies the way the first factor matches.
5659 Available types depend on keys.
5662 @item From, Subject, References, Message-ID
5663 For these keys in string, @code{r} and @code{R} (regexp),
5664 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5665 as well as @code{f} and @code{F} (fuzzy) can be used.
5666 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5669 For these keys, the following five numerical relative operators can be
5670 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5673 This key matches @code{From} header, and scores all follow-ups to the
5675 For example, it would be useful for increasing scores for follow-ups to
5678 You can use the same types as @code{From} except for @code{f}.
5679 And a @samp{Followup} entry is automatically appended to the score file.
5682 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5683 A @samp{Thread} entry is automatically appended for each article that
5684 has @var{x} in the @code{References} header.
5685 You can make sure the whole thread including messages that does not have
5686 all ancestors @code{Message-ID} in @code{References} is scored.
5688 You can use the same types as @code{References} except for @code{f}.
5689 And a @samp{Thread} entry is automatically appended to the score file.
5693 A factor for extension header. This is meaningful only if the key is
5695 This specifies headers to be matched other than standard headers like
5696 @code{Subject} and @code{From}.
5697 Note that you should specify the header in
5698 @code{elmo-msgdb-extra-fields} also.
5699 Therefore it does not work in folders where extension headers cannot be
5704 The sum of these scores @emph{after all factors are applied} becomes the
5705 score of the message.
5707 @cindex Score File Atoms
5709 Messages with a score less than this value is marked as read.
5710 The default is @code{wl-summary-mark-below}.
5713 Messages with a score less than this value is deleted from the summary.
5714 The default is @code{wl-summary-expunge-below}.
5716 @item mark-and-expunge
5717 Both @code{mark} and @code{expunge} are applied,
5718 i.e. messages with a score less than this value is marked as read and
5719 deleted from the summary.
5722 Messages with a score greater than this value is attached with temp
5724 The default is @code{wl-summary-target-above}.
5727 Messages with a score greater than this value is attached with important
5729 The default is @code{wl-summary-important-above}.
5734 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5735 are used, you need to set @code{elmo-msgdb-extra-fields}.
5738 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5741 There are other restrictions as shown below:
5744 @item Because @samp{References} field in the summary information
5745 contains only the last @samp{Message-ID}, @code{references} key matches
5749 Keys that can be seen by folder of types:
5753 chars lines xref extra
5754 localdir,localnews Y E E E
5755 nntp (supporting xover) Y E E N
5761 N: cannot be seen (ignored)
5762 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5767 @node Customization, Mailing List, Scoring, Top
5768 @chapter Customizing Wanderlust
5769 @cindex Customization
5772 * Living with other packages:: Living with other packages
5773 * Highlights:: Highlights
5774 * Biff:: Notify Mail arrival
5775 * Advanced Settings:: Advanced Settings
5776 * Customizable Variables:: Customizable Variables
5781 @node Living with other packages, Highlights, Customization, Customization
5782 @section Living with other packages
5784 Examples with other packages.
5787 * imput:: imput (im-wl.el)
5789 * supercite:: supercite.el
5790 * mu-cite:: mu-cite.el
5791 * x-face-mule:: x-face-mule.el
5792 * dired-dd:: dired-dd.el
5797 @node imput, BBDB, Living with other packages, Living with other packages
5802 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5805 If @command{imput} is on the @code{exec-path} at the installation,
5806 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
5810 (autoload 'wl-draft-send-with-imput-async "im-wl")
5811 (setq wl-draft-send-func 'wl-draft-send-with-imput-async)
5816 @node BBDB, supercite, imput, Living with other packages
5820 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
5823 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
5824 byte-compiled and installed.
5832 ;; @r{enable pop-ups}
5833 (setq bbdb-use-pop-up t)
5834 ;; @r{auto collection}
5835 (setq bbdb/mail-auto-create-p t)
5836 (setq signature-use-bbdb t)
5837 (setq bbdb-north-american-phone-numbers-p nil)
5838 ;; @r{shows the name of bbdb in the summary} :-)
5839 (setq wl-summary-from-func 'bbdb-wl-from-func)
5840 ;; @r{automatically add mailing list fields}
5841 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
5842 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
5846 @node supercite, mu-cite, BBDB, Living with other packages
5847 @subsection sc.el(supercite), sc-register.el
5851 The same setting as usual mailers should be OK. The following is an
5852 example of settings:
5856 (autoload 'sc-cite-original "sc" nil t)
5857 (setq mail-yank-hooks 'sc-cite-original)
5858 (setq sc-preferred-header-style 1)
5859 (setq sc-electric-references-p nil)
5860 (setq sc-citation-leader "")
5861 (setq sc-load-hook '(lambda () (require 'sc-register)))
5862 (setq sc-preferred-attribution 'registeredname)
5867 @node mu-cite, x-face-mule, supercite, Living with other packages
5868 @subsection mu-cite.el
5871 The same setting as usual mailers should be OK. The following is an
5872 example of settings.
5874 If you use mu-cite version 8.0 or earlier:
5878 (autoload 'mu-cite/cite-original "mu-cite" nil t)
5879 (setq mail-citation-hook 'mu-cite/cite-original)
5883 If you use mu-cite version 8.1 or later:
5887 (autoload 'mu-cite-original "mu-cite" nil t)
5888 (add-hook 'mail-citation-hook (function mu-cite-original))
5892 @node x-face-mule, dired-dd, mu-cite, Living with other packages
5893 @subsection x-face-mule.el
5897 It depends on the version of x-face-mule.
5898 If you use x-face-mule 0.19 or older, do the following:
5902 (setq wl-highlight-x-face-func
5904 (lambda (&optional beg end)
5905 (x-face-mule:x-face-decode-message-header))))
5906 (require 'x-face-mule)
5910 If you use x-face-mule 0.20 or later, try the following:
5914 (setq wl-highlight-x-face-func
5916 (lambda (&optional beg end)
5917 (x-face-mule-x-face-decode-message-header))))
5918 (require 'x-face-mule)
5922 Use these settings when you use @file{x-face-mule.el} attached to
5923 bitmap-mule 8.0 or later:
5927 (autoload 'x-face-decode-message-header "x-face-mule")
5928 (setq wl-highlight-x-face-func 'x-face-decode-message-header)
5932 If there is an encoded X-Face string in a file @file{~/.xface} (the
5933 value of the variable @code{wl-x-face-file}), it is inserted as a
5934 @samp{X-Face:} field in the draft buffer (if
5935 @code{wl-auto-insert-x-face} is non-nil).
5938 @node dired-dd, MHC, x-face-mule, Living with other packages
5939 @subsection dired-dd(Dired-DragDrop)
5940 @pindex Dired-DragDrop
5942 @cindex Drag and Drop
5944 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
5945 compose multi-part by simple Drag-and-Drop from dired to the draft
5946 buffer being edited in GNU Emacs (this feature is not Wanderlust
5947 specific, but general-purpose for tm/SEMI).
5951 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
5957 ;; @r{Set dired-x variables here.}
5958 ;; @r{To and flo@dots{}}
5960 (progn (require 'dired-dd)
5961 (require 'dired-dd-mime))))))
5965 @node MHC, , dired-dd, Living with other packages
5969 Message Harmonized Calendaring system
5970 (@uref{http://www.quickhack.net/mhc/})
5972 By using MHC, you can make a calendar from the messages.
5978 (setq mhc-mailer-package 'wl)
5979 (autoload 'mhc-mode "mhc" nil t)
5980 (add-hook 'wl-summary-mode-hook 'mhc-mode)
5981 (add-hook 'wl-folder-mode-hook 'mhc-mode)
5989 (autoload 'mhc-wl-setup "mhc-wl")
5990 (add-hook 'wl-init-hook 'mhc-wl-setup)
5994 @node Highlights, Biff, Living with other packages, Customization
5997 @subsection Customizable Variables
6000 @item wl-summary-highlight
6001 @vindex wl-summary-highlight
6002 The initial setting is @code{t}.
6003 If non-nil, the summary is highlighted.
6005 @item wl-highlight-max-summary-lines
6006 @vindex wl-highlight-max-summary-lines
6007 The initial setting is 10000.
6008 The summary is not highlighted if it has more lines than this value.
6010 @item wl-summary-highlight-partial-threshold
6011 @vindex wl-summary-highlight-partial-threshold
6012 The initial setting is 1000.
6013 This is a threshold whether the whole summary is highlighted.
6014 If there are more lines of messages in the summary, it is partially
6017 @item wl-summary-partial-highlight-above-lines
6018 @vindex wl-summary-partial-highlight-above-lines
6019 The initial setting is 30. If there are more lines of messages than
6020 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6021 after the point that is the same number of lines as this value above the
6022 cursor line are highlighted partially. (If this value is @code{nil},
6023 the last same number of lines as the value of
6024 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6026 @item wl-highlight-body-too
6027 @vindex wl-highlight-body-too
6028 The initial setting is @code{t}.
6029 If non-nil, bodies of drafts and messages are also highlighted.
6031 @item wl-highlight-message-header-alist
6032 @vindex wl-highlight-message-header-alist
6033 When highlighting headers of drafts and messages, this variable
6034 specifies which faces are allocated to important
6035 (@code{wl-highlight-message-important-header-contents}), secondly
6036 important (@code{wl-highlight-message-important-header-contents2}), and
6037 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6039 Similarly, it can be used for allocating arbitrary faces to arbitrary
6040 regular expressions.
6042 @item wl-highlight-citation-prefix-regexp
6043 @vindex wl-highlight-citation-prefix-regexp
6044 Specifies a regular expression to which quoted lines in bodies of
6045 drafts and messages match.
6046 Bodies matching to this regular expression are highlighted by the faces
6047 specified by (@code{wl-highlight-message-cited-text-*}).
6049 @item wl-highlight-highlight-citation-too
6050 @vindex wl-highlight-highlight-citation-too
6051 The initial setting is @code{nil}.
6052 If non-nil, the quoting regular expression itself given by
6053 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6055 @item wl-highlight-citation-header-regexp
6056 @vindex wl-highlight-citation-header-regexp
6057 Specifies a regular expression that denotes beginning of quotation.
6058 Bodies matching to this regular expression are highlighted by the face
6059 specified by @code{wl-highlight-message-headers}.
6061 @item wl-highlight-max-header-size
6062 @vindex wl-highlight-max-header-size
6063 The initial setting is @code{nil}. If a header size is larger than this
6064 value, it will not be highlighted. If @code{nil}, always highlighted
6065 (ignore header size).
6067 @item wl-highlight-max-message-size
6068 @vindex wl-highlight-max-message-size
6069 The initial setting is 10000.
6070 If a message is larger than this value, it will not be highlighted.
6071 With this variable, highlight is suppressed for uuencode or huge digest
6074 @item wl-highlight-signature-separator
6075 @vindex wl-highlight-signature-separator
6076 Specifies regular expressions that denotes the boundary of a signature.
6077 It can be a regular expression, or a list of ones.
6078 Messages after the place that matches this regular expression are
6079 highlighted by the face specified by
6080 @code{wl-highlight-message-signature}.
6082 @item wl-max-signature-size
6083 @vindex wl-max-signature-size
6084 The initial setting is 400.
6085 This is the largest size for a signature to be highlighted.
6087 @item wl-use-highlight-mouse-line
6088 @vindex wl-use-highlight-mouse-line
6089 The initial setting is @code{t}.
6090 If non-nil, the line pointed by the mouse is highlighted in the folder
6091 mode, summary mode, and the like.
6094 @subsection Setting Colors and Fonts of the Characters
6096 If you want to change colors or fonts of the characters, you need to
6097 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6098 want to change fonts, and @code{set-face-foreground} for colors, and so
6099 on. You cannot write face settings in @file{.emacs}; write in
6102 For example, if you want to change the color for signatures to yellow,
6106 (set-face-foreground 'wl-highlight-message-signature "yellow")
6112 Faces defined in Wanderlust:
6115 @item wl-highlight-message-headers
6116 The face for field names of message headers.
6118 @item wl-highlight-message-header-contents
6119 The face for field bodies of message headers.
6121 @item wl-highlight-message-important-header-contents
6122 The face for important parts of message headers.
6123 Per default, this face is used for a body of @samp{Subject:} field.
6124 You can change its value by editing
6125 @code{wl-highlight-message-header-alist}.
6127 @item wl-highlight-message-important-header-contents2
6128 The face for secondly important parts of message headers.
6129 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6130 fields. You can change its value by editing
6131 @code{wl-highlight-message-header-alist}.
6133 @item wl-highlight-message-unimportant-header-contents
6134 The face for unimportant parts of message headers.
6135 Per default, this face is used for bodies of @samp{X-} fields
6136 @samp{User-Agent:} fields. You can change its value by editing
6137 @code{wl-highlight-message-header-alist}.
6139 @item wl-highlight-message-citation-header
6140 The face for headers of quoted messages.
6142 @item wl-highlight-message-cited-text-*
6143 The face for texts of quoted messages. The last @samp{*} is a
6144 @var{single figure} so that 10 different colors can be used according to
6147 @item wl-highlight-message-signature
6148 The face for signatures of messages. The initial settings are
6149 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6150 dark background colors.
6152 @item wl-highlight-header-separator-face
6153 The face for header separators of draft messages.
6155 @item wl-highlight-summary-important-face
6156 The face for message lines with important marks in the summary.
6158 @item wl-highlight-summary-new-face
6159 The face for message lines with new marks in the summary.
6161 @item wl-highlight-summary-displaying-face
6162 The face for the message line that is currently displayed.
6163 This face is overlaid.
6165 @item wl-highlight-thread-indent-face
6166 The face for the threads that is currently displayed.
6168 @item wl-highlight-summary-unread-face
6169 The face for message lines with unread marks in the summary.
6171 @item wl-highlight-summary-deleted-face
6172 The face for message lines with delete marks in the summary.
6174 @item wl-highlight-summary-refiled-face
6175 The face for message lines with re-file marks in the summary.
6177 @item wl-highlight-refile-destination-face
6178 The face for re-file information part of message lines with re-file
6179 marks in the summary.
6181 @item wl-highlight-summary-copied-face
6182 The face for message lines with copy marks in the summary.
6184 @item wl-highlight-summary-target-face
6185 The face for message lines with target marks @samp{*} in the summary.
6187 @item wl-highlight-summary-thread-top-face
6188 The face for message lines that are on the top of the thread in the
6191 @item wl-highlight-summary-normal-face
6192 The face for message lines that are not on top of the thread in the
6195 @item wl-highlight-folder-unknown-face
6196 The face for folders that are not known to have how many unsync messages
6199 @item wl-highlight-folder-zero-face
6200 The face for folders that have no unsync messages in the folder mode.
6202 @item wl-highlight-folder-few-face
6203 The face for folders that have some unsync messages in the folder mode.
6205 @item wl-highlight-folder-many-face
6206 The face for folders that have many unsync messages in the folder mode.
6207 The boundary between `some' and `many' is specified by the variable
6208 @code{wl-folder-many-unsync-threshold}.
6210 @item wl-highlight-folder-unread-face
6211 The face for folders that have no unsync but unread messages in the
6214 @item wl-highlight-folder-killed-face
6215 The face for folders that are deleted from the access group in the
6218 @item wl-highlight-folder-opened-face
6219 The face for open groups in the folder mode.
6220 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6221 @code{nil} or a @var{number}.
6223 @item wl-highlight-folder-closed-face
6224 The face for close groups in the folder mode.
6225 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6226 @code{nil} or a @var{number}.
6228 @item wl-highlight-folder-path-face
6229 The face for the path to the currently selected folder in the folder
6232 @item wl-highlight-logo-face
6233 The face for logo in the demo.
6235 @item wl-highlight-demo-face
6236 The face for strings (for example, a version number) in the demo.
6240 @node Biff, Advanced Settings, Highlights, Customization
6241 @section Notify Mail arrival
6244 Following setting is to notify mail arrival of @samp{%inbox}
6245 by the indicator on the modeline
6248 (setq wl-biff-check-folder-list '("%inbox"))
6251 @subsection Customizable Variables
6253 @item wl-biff-check-folder-list
6254 @vindex wl-biff-check-folder-list
6255 The initial setting is @code{nil}.
6256 This is the list of folders to check mail arrival.
6257 If @code{nil}, wl doesn't check mail arrival.
6259 @item wl-biff-check-interval
6260 @vindex wl-biff-check-interval
6261 The initial setting is 40 (in seconds).
6262 Check mail arrival in this period.
6264 @item wl-biff-notify-hook
6265 @vindex wl-biff-notify-hook
6266 The initial setting is @code{nil}.
6267 This is a hook run at the arrival of the new mail.
6270 (setq wl-biff-notify-hook '(beep))
6275 @node Advanced Settings, Customizable Variables, Biff, Customization
6276 @section Advanced Settings
6279 * Draft for Reply:: Draft for Reply
6280 * Thread Format:: Appearance of Thread
6281 * User-Agent Field:: @samp{User-Agent:} Header Field
6285 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6286 @subsection Draft for Replay
6287 @vindex wl-draft-reply-with-argument-list
6288 @vindex wl-draft-reply-without-argument-list
6289 @vindex wl-draft-reply-myself-with-argument-list
6290 @vindex wl-draft-reply-myself-without-argument-list
6292 If you want, when you replying to articles in mailing lists, the address
6293 in Reply-To field of the original message to be prepared to To field of
6294 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6299 (setq wl-draft-reply-without-argument-list
6300 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6301 ("Followup-To" . (nil nil ("Followup-To")))
6302 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6303 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6308 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6309 in the original message, @samp{Reply-To:} field in the original is
6310 copied to @samp{To:} field.)
6312 Moreover, the behavior of @kbd{a} with prefix argument can
6313 be directed by @code{wl-draft-reply-with-argument-list} as well.
6315 Note: To set the behavior when you reply to the message written by yourself, use
6316 @code{wl-draft-reply-myself-without-argument-list} and
6317 @code{wl-draft-reply-myself-with-argument-list}
6320 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6321 @subsection Appearance of Threads
6325 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6326 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6327 391 09/18(Fri)19:24 +-[ Murata-san ]
6328 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6329 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6330 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6331 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6332 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6333 412 09/22(Tue)09:28 | +-[ Teranishi ]
6334 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6335 416 09/22(Tue)12:38 | +-[ Teranishi ]
6336 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6337 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6341 Settings to make appearance of threads like shown above:
6345 (setq wl-thread-indent-level 2)
6346 (setq wl-thread-have-younger-brother-str "+")
6347 (setq wl-thread-youngest-child-str "+")
6348 (setq wl-thread-vertical-str "|")
6349 (setq wl-thread-horizontal-str "-")
6350 (setq wl-thread-space-str " ")
6354 If you do not want to see branches, do the following:
6358 (setq wl-thread-indent-level 2)
6359 (setq wl-thread-have-younger-brother-str " ")
6360 (setq wl-thread-youngest-child-str " ")
6361 (setq wl-thread-vertical-str " ")
6362 (setq wl-thread-horizontal-str " ")
6363 (setq wl-thread-space-str " ")
6368 @node User-Agent Field, , Thread Format, Advanced Settings
6369 @subsection User-Agent Field
6373 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6374 @samp{User-Agent:} fields, define a function that generate appropriate
6375 strings as you like, and set it to variable
6376 @code{wl-generate-mailer-string-func}.
6378 If you do not want verbose @samp{User-Agent:} field, do the following:
6382 (setq wl-generate-mailer-string-func
6385 (concat "User-Agent: "
6386 (wl-generate-user-agent-string-1 nil)))))
6390 The following is a example:
6394 (setq mime-edit-insert-user-agent-field nil)
6395 (setq wl-generate-mailer-string-func
6398 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6403 @node Customizable Variables, Hooks, Advanced Settings, Customization
6404 @section Customizable Variables
6406 Customizable variables that have not been described yet:
6409 @item wl-default-folder
6410 @vindex wl-default-folder
6411 The initial setting is @samp{%inbox}. This is the default value for moving to
6412 a folder and the like.
6414 @item wl-draft-folder
6415 @vindex wl-draft-folder
6416 The initial setting is @samp{+draft}. It is the folder to which drafts are
6417 saved. It must be a localdir folder.
6419 @item wl-trash-folder
6420 @vindex wl-trash-folder
6421 The initial setting is @samp{+trash}. It is the wastebasket folder.
6422 If you changed this variable, you had better restart Wanderlust.
6424 @item wl-interactive-exit
6425 @vindex wl-interactive-exit
6426 The initial setting is @code{t}.
6427 If non-nil, you are asked for confirmation when Wanderlust terminates.
6429 @item wl-interactive-send
6430 @vindex wl-interactive-send
6431 The initial setting is @code{nil}.
6432 If non-nil, you are asked for confirmation when mail is sent.
6434 @item wl-folder-sync-range-alist
6435 @vindex wl-folder-sync-range-alist
6436 The initial setting is the alist shown below:
6441 ("^\\+draft$\\|^\\+queue$" . "all"))
6446 This is an associative list of regular expressions of folder names and
6447 update range of the summary. Update range is one of the @samp{all},
6448 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6449 @samp{last}. If a folder do not match, @samp{update} is used.
6452 @vindex wl-ask-range
6453 The initial setting is @code{t}.
6454 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6455 for updating the summary when you changed folders.
6457 @item wl-mime-charset
6458 @vindex wl-mime-charset
6459 The initial setting is @code{x-ctext}.
6460 This is the MIME charset for messages that are not MIME (e.g. without
6461 @samp{Content-Type:}). This value also used as default charset for
6462 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6463 this value as @code{iso-2022-jp}.)
6465 @item wl-highlight-folder-with-icon
6466 @vindex wl-highlight-folder-with-icon
6467 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6468 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6470 @item wl-strict-diff-folders
6471 @vindex wl-strict-diff-folders
6472 This is a list of regular expressions of folders.
6473 Unread messages are checked, for example when you press @kbd{s} in
6474 the folder mode, usually in a brief way (rapidly processed but not
6476 The folders matching this variable are seriously checked.
6477 You may want to set this variable so as to match conditional filter
6478 folders for IMAP4 folders.
6479 The initial setting is @code{nil}.
6481 @item wl-folder-use-server-diff
6482 @vindex wl-folder-use-server-diff
6483 When unread messages are checked, for example when you press @kbd{s} in
6484 the folder mode, usually (the number of messages on the server) @minus{}
6485 (the number of local messages) will be the number of unread messages.
6486 However, if this variable is non-nil, the number of unread messages on
6487 the server is checked. This affects IMAP4 folders only, but IMAP4
6488 folders in mail boxes matching
6489 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6490 the number of unread messages on the server, even if they matches this
6491 variable. The initial setting is @code{t}.
6493 @item wl-auto-check-folder-name
6494 @vindex wl-auto-check-folder-name
6495 The initial setting is @code{nil}.
6496 If non-nil, the folder with the name of the value is checked for unread
6497 messages at the start.
6498 If it is @code{none}, no folders are checked.
6499 If it is a list, all folders in the list are checked at the start.
6501 @item wl-auto-uncheck-folder-list
6502 @vindex wl-auto-uncheck-folder-list
6503 The initial setting is the list shown below:
6512 Folders with the name matching this variable are not checked for unread
6513 messages at the start, even if they are included in the groups in
6514 @code{wl-auto-check-folder-name}.
6516 @item wl-auto-check-folder-list
6517 @vindex wl-auto-check-folder-list
6518 The initial setting is @code{nil}.
6519 Folders with the name matching this variable are always checked for
6520 unread messages at the start, if they are included in the groups in
6521 @code{wl-auto-check-folder-name}.
6522 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6524 @item wl-no-save-folder-list
6525 @vindex wl-no-save-folder-list
6526 The initial setting is the list shown below:
6535 This is a list of regular expressions of folders not to be saved.
6537 @item wl-save-folder-list
6538 @vindex wl-save-folder-list
6539 The initial setting is @code{nil}.
6540 This is a list of regular expressions of folders to be saved.
6541 This takes precedence over @code{wl-no-save-folder-list}.
6543 @item wl-folder-mime-charset-alist
6544 @vindex wl-folder-mime-charset-alist
6545 The initial setting is the alist shown below:
6549 (("^-alt\\.chinese" . big5)
6550 ("^-relcom\\." . koi8-r)
6552 ("^-han\\." . euc-kr))
6557 This is an associative list of regular expressions of folder names and
6559 If a folder do not match, @code{wl-mime-charset} is used.
6561 @item wl-folder-init-load-access-folders
6562 @vindex wl-folder-init-load-access-folders
6563 The initial setting is @code{nil}.
6564 This is a list of access groups to be loaded specifically at the start.
6565 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6567 @item wl-folder-init-no-load-access-folders
6568 @vindex wl-folder-init-no-load-access-folders
6569 The initial setting is @code{nil}.
6570 This is a list of access groups not to be loaded specifically at the
6572 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6574 @item wl-delete-folder-alist
6575 @vindex wl-delete-folder-alist
6576 The initial setting is the alist shown below:
6585 This list determines disposition of messages with delete marks.
6586 Each item in the list is a folder and destination; you can specify any
6587 one of the following in the place of destination:
6590 @code{remove} or @code{null} : deletes the messages instantly.
6591 string : moves the messages to the specific folder.
6592 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
6595 @item wl-refile-policy-alist
6596 @vindex wl-refile-policy-alist
6597 The initial setting is the list shown below:
6607 This list determines whether messages with re-file marks are moved or
6608 copied. Each item in the list is a cons cell of a folder and
6609 @code{copy} or @code{move}.
6611 @item wl-x-face-file
6612 @vindex wl-x-face-file
6613 The initial setting is @file{~/.xface}.
6614 The name of the file that contains encoded X-Face strings.
6617 @item wl-demo-display-logo
6618 @vindex wl-demo-display-logo
6619 If non-nil, bitmap image is shown on the opening demo. If you set
6620 @code{xpm} or @code{xbm}, (if possible) display selected image type
6623 @item elmo-use-database
6624 @vindex elmo-use-database
6625 This is meaningful for XEmacs only. The initial setting depends on
6626 XEmacs (@code{t} for XEmacs with dbm).
6627 If non-nil, Message-ID is controlled by dbm.
6629 @item elmo-passwd-alist-file-name
6630 @vindex elmo-passwd-alist-file-name
6631 The initial setting is @file{passwd}.
6632 This is the name of the file in which passwords are saved.
6633 @code{elmo-passwd-alist-save} saves current passwords to the file.
6635 @item elmo-nntp-list-folders-use-cache
6636 @vindex elmo-nntp-list-folders-use-cache
6637 The initial setting is 600 (in seconds).
6638 This is period in seconds during which results of @samp{list} and
6639 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6642 @item elmo-nntp-max-number-precedes-list-active
6643 @vindex elmo-nntp-max-number-precedes-list-active
6644 The initial setting is @code{nil}.
6645 If non-nil, the number of article obtained by @samp{list active} in NNTP
6646 are used as the maximum article number of the folder.
6647 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6648 and if the number of read messages is not correct.
6650 @item elmo-nntp-default-use-listgroup
6651 @vindex elmo-nntp-default-use-listgroup
6652 The initial setting is @code{t}.
6653 If non-nil, @samp{listgroup} is used for checking the total number of
6654 articles. If it is @code{nil}, @samp{group} is used. In the latter
6655 case, the processing will be a little faster at the sacrifice of
6658 @item elmo-pop3-send-command-synchronously
6659 @vindex elmo-pop3-send-command-synchronously
6660 The initial setting is @code{nil}.
6661 If non-nil, POP3 commands are issued synchronously. Some implementation
6662 of POP3 server fails to get summary information without this setting.
6663 You may have to set this variable to @code{t}, if the process hangs
6664 while looking up POP3.
6666 @item elmo-dop-flush-confirm
6667 @vindex elmo-dop-flush-confirm
6668 The initial setting is @code{t}.
6669 If non-nil, you are asked for confirmation if accumulated off-line
6670 operations are executed.
6672 @item elmo-display-progress-threshold
6673 @vindex elmo-display-progress-threshold
6674 The initial setting is 20.
6675 Threshold for display of progress gauge. If number of renewal is more than
6676 this value, display progress gauge.
6680 @node Hooks, , Customizable Variables, Customization
6686 @node Mailing List, Addition, Customization, Top
6687 @chapter Wanderlust Mailing List
6692 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6695 Topics related to Wanderlust are discussed in the mailing list.
6696 The latest version is also announced there (in Japanese, sorry).
6698 A guide can be obtained automatically by sending mail to
6699 @t{wl-ctl@@lists.airs.net} with the body
6704 Please send bug reports or patches to the mailing list. You can post to
6705 the mailing list even though you are not a member of it.
6707 If you send a bug report, please attach Backtrace with it.
6708 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
6711 I would like to express my thanks to the members of the mailing list for
6712 valuable advice and many pieces of code they contributed.
6715 @node Addition, Index, Mailing List, Top
6716 @chapter Additional Information
6718 @section Brief History
6721 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6722 3/10 Made a msgdb mechanism by elisp.
6723 3/26 IMAP and NNTP can be displayed in threads.
6724 4/13 Began to assemble thread display modules as elmo.
6725 5/01 Finished 0.1.0, initial version with many defects.
6726 6/12 I made a slip of the tongue and said I was writing elisp
6727 mailer supporting IMAP
6728 6/16 0.1.3 was announced at tm-ja, elisp ML.
6729 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6730 7/01 Support for mm-backend (0.3.0).
6731 8/25 multi folder added (0.5.0).
6732 8/28 filter folder added (0.5.1).
6733 9/10 You can open/close threads (0.6.0).
6734 9/11 fldmgr by Murata-san made editing folders easy.
6735 9/18 lha folders added by Okunishi-san (0.6.3).
6736 9/24 Display of branches of threads (0.6.5).
6737 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6738 10/28 Off-line operations (0.7.4).
6739 12/09 Becomes beta version.
6740 12/21 wl-expire by Murata-san.
6741 1999 2/03 auto-refile by Tsumura-san.
6742 4/28 wl-template by Murata-san.
6743 5/18 Released 1.0.0 stable.
6744 7/05 Scoring by Murata-san (2.1.0).
6745 9/26 New plugged system by Murata-san (2.2.2).
6746 12/20 Support Modified UTF7.
6747 2000 3/24 Released 1.1.0 stable.
6748 4/03 CVS development started.
6749 5/07 Thread restoration & Its speed up with Murata-san.
6750 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6751 7/11 killed message feature.
6752 7/18 Use UIDL in POP3.
6753 9/12 biff feature with Satata-san & Yamaoka-san.
6754 10/17 expire-hide by Okada-san.
6755 11/08 Released 2.4.0 stable.
6758 See @file{ChangeLog} for details.
6762 According to a dictionary, Wanderlust has the meaning:
6766 n eager longing for or impulse towards travelling in distant lands
6767 [Ger, fr wandern to wander + lust desire, pleasure]
6771 but I had no profound intention. (if farfetched, IMAP @result{} you can
6772 read mail anywhere @result{} desire to wander ?)
6774 Elmo is the abbreviation of @samp{Elisp Library for Message
6775 Orchestration}. At first I meant the red puppet in the Sesame Street,
6776 but you may associate it with Wandering @result{} Drifting @result{}
6777 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6781 Each versions has code names (they are almost jokes).
6782 Currently they are picked up alphabetically from the top 40 hits of
6783 U.S. Billboard magazines in 1980s.
6785 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
6788 @node Index, , Addition, Top
6792 * Concept Index:: Concept Index
6793 * Key Index:: Key Index
6794 * Variable Index:: Variable Index
6795 * Function Index:: Function Index
6798 @node Concept Index, Key Index, Index, Index
6799 @unnumberedsec Concept Index
6802 @node Key Index, Variable Index, Concept Index, Index
6803 @unnumberedsec Key Index
6806 @node Variable Index, Function Index, Key Index, Index
6807 @unnumberedsec Variable Index
6810 @node Function Index, , Variable Index, Index
6811 @unnumberedsec Function Index