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 In the offline mode, cursor is not moved to the messages which are not cached
2825 If there are messages which have target mark @samp{*} in the summary,
2826 cursor is moved to the downward message which have a target mark.
2827 This behavior is changed according to the value of @code{wl-summary-move-order}.
2828 (@code{wl-summary-down})
2832 @findex wl-summary-up
2833 Move cursor to the upward message which is unread or marked
2835 In the offline mode, cursor is not moved to the messages which are not cached
2837 If there are messages which have target mark @samp{*} in the summary,
2838 cursor is moved to the downward message which have a target mark.
2839 This behavior is changed according to the value of @code{wl-summary-move-order}.
2840 (@code{wl-summary-up})
2844 @findex wl-summary-write
2845 Prepare a new draft.
2846 (@code{wl-summary-write})
2850 @findex wl-summary-write-current-folder
2851 Prepare a new draft. If the current folder is NNTP folder,
2852 @samp{Newsgroups:} field is completed. If the current folder is mailing
2853 list folder (refile destination), guess @samp{To:} field and completed
2854 (If @code{wl-subscribed-mailing-list} is valid list)
2855 (@code{wl-summary-write-current-folder})
2859 @findex wl-summary-redisplay-all-header
2860 Redisplay the message at current cursor point with all header fields.
2861 (@code{wl-summary-redisplay-all-header})
2865 @findex wl-summary-redisplay-no-mime
2866 Redisplay the message at current cursor point without MIME analysis.
2867 (@code{wl-summary-redisplay-no-mime})
2871 @findex wl-summary-burst
2872 If the message at current cursor point has
2873 encapsulates multiple messages using MIME,
2874 de-capsulate and extract them on the current folder.
2875 (@code{wl-summary-burst})
2878 @kindex @@ (Summary)
2879 @findex wl-summary-edit-addresses
2880 Append/change/delete the message's sender information to the address
2881 book @file{~/.addresses} interactively. If this command is called with
2882 prefix argument, arbitrary address can be edited.
2883 (@code{wl-summary-edit-petname})
2887 @findex wl-status-update
2888 Sync up address book status with @file{~/.addresses}'s content.
2889 (@code{wl-status-update})
2893 @findex wl-summary-pipe-message
2894 Pipe current message's content to the external process.
2895 (@code{wl-summary-pipe-message})
2899 @findex wl-summary-print-message
2900 Print out current message's content.
2901 It uses @code{ps-print} module in Emacs 20.x.
2902 If you don't use color printer, you might want to set
2903 @code{wl-ps-print-buffer-func} to @code{ps-print-buffer}.
2906 (setq wl-ps-print-buffer-func 'ps-print-buffer)
2909 (@code{wl-summary-print-message})
2913 @findex wl-summary-exit
2914 Exit current folder.
2915 (@code{wl-summary-exit})
2919 @findex wl-summary-jump-to-current-message
2920 Jump cursor to the currently displayed message's window.
2921 (@code{wl-summary-jump-to-current-message})
2925 Jump cursor to the other message.
2926 @findex wl-summary-jump-to-msg
2927 (@code{wl-summary-jump-to-msg})
2931 Update summary status and
2932 prefetch all messages which have marks included in the
2933 @code{wl-summary-incorporate-marks}.
2934 @findex wl-summary-incorporate
2935 (@code{wl-summary-incorporate})
2938 @kindex M-j (Summary)
2939 @findex wl-summary-jump-to-msg-by-message-id
2940 Jump cursor to the message which have specified @samp{Message-Id:}. If
2941 @code{elmo-use-database} is non-nil, other folder is also searched.
2942 (@code{wl-summary-jump-to-msg-by-message-id})
2946 Jump to parent message.
2947 @findex wl-summary-jump-to-parent-message
2948 (@code{wl-summary-jump-to-parent-message})
2952 @findex wl-summary-mark-as-unread
2953 Mark as unread the message at current cursor point.
2954 (@code{wl-summary-mark-as-unread})
2958 @findex wl-summary-sync
2959 Synchronize summary view after prompting the update range
2960 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
2964 all ...Discard current summary and update all message.
2965 update ...Update the difference between summary and the folder itself.
2966 rescan ...Rescan the msgdb and display again.
2967 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2968 first, last ...Move to the filter folder(partial filter).
2973 (@code{wl-summary-sync})
2977 @findex wl-summary-sort
2979 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
2980 (@code{wl-summary-sort})
2984 @findex wl-summary-toggle-thread
2985 Toggle the threading.
2986 Threading status is displayed on the modeline.
2987 @samp{@{S@}} means threading is off (Sequence) and
2988 @samp{@{T@}} means threading is on (Thread).
2989 (@code{wl-summary-toggle-thread})
2993 @findex wl-summary-toggle-disp-folder
2994 Toggle displaying of folder window.
2995 (@code{wl-summary-toggle-disp-folder})
2999 Toggle displaying of message window.
3000 @findex wl-summary-toggle-disp-msg
3001 (@code{wl-summary-toggle-disp-msg})
3005 Move to the virtual folder with the condition specified.
3006 If called with prefix argument and current folder is virtual, exit it.
3007 @findex wl-summary-virtual
3008 (@code{wl-summary-virtual})
3011 @kindex @key{TAB} (Summary)
3012 @findex wl-summary-goto-last-displayed-msg
3013 Jump to the message which is displayed last.
3014 (@code{wl-summary-goto-last-displayed-msg})
3018 Put @samp{*} mark on the messages that satisfies the specified condition.
3019 @findex wl-summary-pick
3020 (@code{wl-summary-pick})
3024 @findex wl-summary-mark-as-read
3025 Mark as read the message at the current cursor point.
3026 (@code{wl-summary-mark-as-read})
3030 Prefetch the message at the current cursor point.
3031 With prefix argument, prefetch the message even if it is cached.
3032 @findex wl-summary-prefetch
3033 (@code{wl-summary-prefetch})
3037 Execute @samp{D}, @samp{o} and @samp{O} marks.
3038 @findex wl-summary-exec
3039 (@code{wl-summary-exec})
3043 @findex wl-summary-target-mark-line
3044 Put target mark on the message at the current cursor point.
3045 (@code{wl-summary-target-mark-line})
3049 Put refile mark on the message at the current cursor point.
3050 @findex wl-summary-refile
3051 (@code{wl-summary-refile})
3054 @kindex C-o (Summary)
3055 Execute auto refile.
3056 @findex wl-summary-auto-refile
3057 (@code{wl-summary-auto-refile})
3061 Put copy mark on the message at the current cursor point.
3062 @findex wl-summary-copy
3063 (@code{wl-summary-copy})
3066 @kindex M-o (Summary)
3067 Put refile mark on the message at the current cursor point with the destination
3068 previously specified.
3069 @findex wl-summary-refile-prev-destination
3070 (@code{wl-summary-refile-prev-destination})
3074 @findex wl-summary-delete
3075 Put delete mark on the message at the current cursor point.
3076 (@code{wl-summary-delete})
3080 @findex wl-summary-unmark
3081 Unmark the temporal mark on the message at the current cursor point.
3082 (@code{wl-summary-unmark})
3086 Unmark all the temporal marks.
3087 @findex wl-summary-unmark-all
3088 (@code{wl-summary-unmark-all})
3091 @kindex r R (Summary)
3092 @findex wl-summary-mark-as-read-region
3093 Mark as read messages in the specified region.
3094 (@code{wl-summary-mark-as-read-region})
3097 @kindex r $ (Summary)
3098 @findex wl-summary-mark-as-important-region
3099 Mark as important @samp{$} messages in the specified region.
3100 If @samp{$} already exists, it is deleted.
3101 (@code{wl-summary-mark-as-important-region})
3104 @kindex r ! (Summary)
3105 @findex wl-summary-mark-as-unread-region
3106 Mark as unread messages in the specified region.
3107 (@code{wl-summary-mark-as-unread-region})
3110 @kindex r i (Summary)
3111 @findex wl-summary-prefetch-region
3112 Prefetch messages in the specified region.
3113 (@code{wl-summary-prefetch-region})
3116 @kindex r x (Summary)
3117 @findex wl-summary-exec-region
3118 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3120 (@code{wl-summary-exec-region})
3123 @kindex r * (Summary)
3124 @findex wl-summary-target-mark-region
3125 Put target mark on the messages in the specified region.
3126 (@code{wl-summary-target-mark-region})
3129 @kindex r o (Summary)
3130 @findex wl-summary-refile-region
3131 Put refile mark on the messages in the specified region.
3132 (@code{wl-summary-refile-region})
3135 @kindex r O (Summary)
3136 @findex wl-summary-copy-region
3137 Put copy mark on the messages in the specified region.
3138 (@code{wl-summary-copy-region})
3141 @kindex r d (Summary)
3142 @findex wl-summary-delete-region
3143 Put delete mark on the messages in the specified region.
3144 (@code{wl-summary-delete-region})
3147 @kindex r u (Summary)
3148 @findex wl-summary-unmark-region
3149 Delete temporal mark on the messages in the specified region.
3150 (@code{wl-summary-unmark-region})
3153 @kindex r y (Summary)
3154 Save messages in the specified region.
3155 @findex wl-summary-save-region
3156 (@code{wl-summary-save-region})
3159 @kindex t R (Summary)
3160 @findex wl-thread-mark-as-read
3161 Mark as read messages which are the descendant of the current thread.
3162 With prefix argument, it affects on the all messages in the thread tree.
3163 (@code{wl-thread-mark-as-read})
3166 @kindex t $ (Summary)
3167 @findex wl-thread-mark-as-important
3168 Put important mark @samp{$} on the messages which are the
3169 descendant of the current thread.
3170 If @samp{$} mark exists, it is deleted.
3171 With prefix argument, it affects on the all messages in the thread tree.
3172 (@code{wl-thread-mark-as-important})
3175 @kindex t ! (Summary)
3176 @findex wl-thread-mark-as-unread
3177 Mark as unread messages which are the descendant of the current thread.
3178 With prefix argument, it affects on the all messages in the thread tree.
3179 (@code{wl-thread-mark-as-unread})
3182 @kindex t i (Summary)
3183 @findex wl-thread-prefetch
3184 Prefetch messages which are the descendant of the current thread.
3185 With prefix argument, it affects on the all messages in the thread tree.
3186 (@code{wl-thread-prefetch})
3189 @kindex t x (Summary)
3190 @findex wl-thread-exec
3191 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3192 the descendant of the current thread. With prefix argument, it affects
3193 on the all messages in the thread tree.
3194 (@code{wl-thread-exec})
3197 @kindex t * (Summary)
3198 @findex wl-thread-target-mark
3199 Put target mark @samp{*} on the messages which are the descendant of the
3200 current thread. With prefix argument, it affects on the all messages in
3202 (@code{wl-thread-target-mark})
3205 @kindex t o (Summary)
3206 @findex wl-thread-refile
3207 Put refile mark on the messages which are the descendant of the current thread.
3208 With prefix argument, it affects on the all messages in the thread tree.
3209 (@code{wl-thread-refile})
3212 @kindex t O (Summary)
3213 @findex wl-thread-copy
3214 Put copy mark on the messages which are the descendant of the current thread.
3215 With prefix argument, it affects on the all messages in the thread tree.
3216 (@code{wl-thread-copy})
3219 @kindex t d (Summary)
3220 @findex wl-thread-delete
3221 Put delete mar on the messages which are the descendant of the current thread.
3222 With prefix argument, it affects on the all messages in the thread tree.
3223 (@code{wl-thread-delete})
3226 @kindex t u (Summary)
3227 @findex wl-thread-unmark
3228 Unmark temporal mark on the messages which are the descendant of the
3229 current thread. With prefix argument, it affects on the all messages in
3231 (@code{wl-thread-unmark})
3234 @kindex t y (Summary)
3235 @findex wl-thread-save
3236 Save messages which are the descendant of the current thread.
3237 With prefix argument, it affects on the all messages in the thread tree.
3238 (@code{wl-thread-save})
3241 @kindex m i (Summary)
3242 @findex wl-summary-target-mark-prefetch
3243 Prefetch all messages which have target mark @samp{*}.
3244 (@code{wl-summary-target-mark-prefetch})
3247 @kindex m R (Summary)
3248 @findex wl-summary-target-mark-mark-as-read
3249 Mark as read all messages which have target mark @samp{*}.
3250 (@code{wl-summary-target-mark-mark-as-read})
3253 @kindex m $ (Summary)
3254 @findex wl-summary-target-mark-mark-as-important
3255 Mark as important all messages which have target mark @samp{*}.
3256 If already marked as @samp{$}, it is deleted.
3257 (@code{wl-summary-target-mark-mark-as-important})
3260 @kindex m ! (Summary)
3261 @findex wl-summary-target-mark-mark-as-unread
3262 Mark as unread all messages which have target mark @samp{*}.
3263 (@code{wl-summary-target-mark-mark-as-unread})
3266 @kindex m o (Summary)
3267 @findex wl-summary-target-mark-refile
3268 Put refile mark on the messages which have target mark @samp{*}.
3269 (@code{wl-summary-target-mark-refile})
3272 @kindex m O (Summary)
3273 @findex wl-summary-target-mark-copy
3274 Put copy mark on the messages which have target mark @samp{*}.
3275 (@code{wl-summary-target-mark-copy})
3278 @kindex m d (Summary)
3279 @findex wl-summary-target-mark-delete
3280 Put delete mark on the messages which have target mark @samp{*}.
3281 (@code{wl-summary-target-mark-delete})
3284 @kindex m y (Summary)
3285 @findex wl-summary-target-mark-save
3286 Save messages which have target mark @samp{*}.
3287 (@code{wl-summary-target-mark-save})
3290 @kindex m u (Summary)
3291 Unmark all temporal marks.
3292 (@code{wl-summary-delete-all-temp-marks})
3293 @findex wl-summary-delete-all-temp-marks
3296 @kindex m a (Summary)
3297 Put target mark @samp{*} on the all messages.
3298 (@code{wl-summary-target-mark-all})
3299 @findex wl-summary-target-mark-all
3302 @kindex m t (Summary)
3303 Put target mark @samp{*} on the messages in the current thread.
3304 @findex wl-summary-target-mark-thread
3305 (@code{wl-summary-target-mark-thread})
3308 @kindex m r (Summary)
3309 @findex wl-summary-target-mark-region
3310 Put target mark @samp{*} on the messages in the specified region.
3311 (@code{wl-summary-target-mark-region})
3314 @kindex m A (Summary)
3315 @findex wl-summary-target-mark-reply-with-citation
3316 Prepare a draft which cites all messages which have target mark @samp{*}.
3317 (@code{wl-summary-target-mark-reply-with-citation})
3320 @kindex m f (Summary)
3321 @findex wl-summary-target-mark-forward
3322 Prepare a draft which forwards all messages which have target mark @samp{*}.
3323 (@code{wl-summary-target-mark-forward})
3326 @kindex m U (Summary)
3327 @findex wl-summary-target-mark-uudecode
3328 Uudecode the messages which have target mark @samp{*}.
3329 (@code{wl-summary-target-mark-uudecode})
3332 @kindex m ? (Summary)
3333 @findex wl-summary-target-mark-pick
3334 Pick messages from the @samp{*} marked messages.
3335 That is, @samp{*} marks on the messages are remained
3336 if the specified condition is satisfied.
3337 (@code{wl-summary-target-mark-pick})
3340 @kindex M-t (Summary)
3341 @findex wl-toggle-plugged
3342 Toggle offline/online status of Wanderlust.
3343 (@code{wl-toggle-plugged})
3346 @kindex C-t (Summary)
3347 Start Wanderlust's plug-status manager.
3348 (@code{wl-plugged-change})
3351 @kindex C-c C-o (Summary)
3352 @findex wl-jump-to-draft-buffer
3353 Move to the draft buffer if available. If multiple draft buffer exists,
3354 moved to one after another. If prefix argument is specified, load draft
3355 folder's message to the draft buffer and jump to it.
3356 (@code{wl-jump-to-draft-buffer})
3359 @kindex M-w (Summary)
3360 @findex wl-summary-save-current-message
3361 Save the message at the current cursor point.
3362 (@code{wl-summary-save-current-message})
3365 @kindex C-y (Summary)
3366 @findex wl-summary-yank-saved-message
3367 Regard the message at the current cursor point as
3368 parent, connect the message saved by
3369 @code{wl-summary-save-current-message}
3371 (@code{wl-summary-yank-saved-message})
3375 @node Variables of Summary, , Key Bindings of Summary, Summary
3376 @section Customiziable variables
3379 @item wl-summary-move-order
3380 @vindex wl-summary-move-order
3381 The initial setting is @code{unread}. Specify cursor moving policy. If
3382 you want to precede new messages, set @code{new}. If you want to
3383 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3386 @item wl-auto-select-first
3387 @vindex wl-auto-select-first
3388 The initial setting is @code{nil}.
3389 If non-nil, first message is automatically displayed.
3391 @item wl-auto-select-next
3392 @vindex wl-auto-select-next
3393 The initial setting is @code{nil}. If non-nil, jump to next summary
3394 automatically. If @code{unread}, jump to next unread folder's summary
3395 after confirmation. If @code{skip-no-unread}, unread folders are
3396 automatically skipped.
3398 @item wl-thread-insert-opened
3399 @vindex wl-thread-insert-opened
3400 The initial setting is @code{nil}.
3401 If non-nil, thread is inserted as opened.
3403 @item wl-thread-open-reading-thread
3404 @vindex wl-thread-open-reading-thread
3405 The initial setting is @code{t}. If non-nil, reading thread is
3406 automatically opened though it is closed thread.
3408 @item wl-summary-exit-next-move
3409 @vindex wl-summary-exit-next-move
3410 The initial setting is @code{t}. If non-nil, move to next folder at
3413 @item wl-folder-move-cur-folder
3414 @vindex wl-folder-move-cur-folder
3415 The initial setting is @code{nil}. If non-nil, cursor position on the
3418 @item wl-summary-weekday-name-lang
3419 @vindex wl-summary-weekday-name-lang
3420 The initial setting is @samp{ja}. Specify language of the weekday.
3421 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3424 @item wl-summary-fix-timezone
3425 @vindex wl-summary-fix-timezone
3426 The initial setting is @samp{JST}. Timezone to adjust summary's
3427 timezone. If @code{nil}, adjust to GMT.
3429 @item wl-use-petname
3430 @vindex wl-use-petname
3431 The initial setting is @code{t}.
3432 If non-nil, sender part displays nickname.
3434 @item wl-break-pages
3435 @vindex wl-break-pages
3436 The initial setting is @code{t}.
3437 If non-nil, message is splitted as pages by @samp{^L}.
3439 @item wl-message-window-size
3440 @vindex wl-message-window-size
3441 The initial setting is '(1 . 4).
3442 A cons cell to specify the rate of summary and message window.
3443 car:cdr corresponds summary:message.
3445 @item wl-summary-recenter
3446 @vindex wl-summary-recenter
3447 The initial setting is t.
3448 If non-nil, cursor point is moved to the center of the summary window.
3450 @item wl-summary-indent-length-limit
3451 @vindex wl-summary-indent-length-limit
3452 The initial setting is 46.
3453 Specify the limit of thread indent level.
3454 If nil, max indent level is unlimited.
3456 @item wl-summary-no-from-message
3457 @vindex wl-summary-no-from-message
3458 The initial setting is @samp{nobody@@nowhere?}. A string which is
3459 displayed when there's no @samp{From:} field in the message.
3461 @item wl-summary-no-subject-message
3462 @vindex wl-summary-no-subject-message
3463 The initial setting is @samp{(WL:No Subject in original.)}. A string
3464 which is displayed when there's no @samp{Subject:} field in the message.
3466 @item wl-summary-width
3467 @vindex wl-summary-width
3468 The initial setting is 80.
3469 Width of summary line. If @code{nil}, summary line's width is as is.
3471 @item wl-use-folder-petname
3472 @vindex wl-use-folder-petname
3473 The initial setting is the list shown below:
3482 A list of display policy (symbol) of folder nickname. Available symbols
3487 Display folder petname on modeline.
3489 Destination folder is notified as nickname if
3490 @code{wl-auto-select-next} is non-nil.
3492 You can input folder name by nickname in the function
3493 @code{wl-summary-read-folder}.
3496 @item wl-summary-move-direction-toggle
3497 @vindex wl-summary-move-direction-toggle
3498 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3499 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3500 want to aware of reading direction, set this to @code{t}.
3503 @vindex wl-from-width
3504 The initial setting is 17.
3505 Width of sender part of summary line.
3507 @item wl-summary-divide-thread-when-subject-changed
3508 @vindex wl-summary-divide-thread-when-subject-changed
3509 The initial setting is @code{nil}. If non-nil, thread is splitted if
3510 the subject is changed.
3512 @item wl-summary-search-via-nntp
3513 @vindex wl-summary-search-via-nntp
3514 The initial setting is @code{confirm}.
3516 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3517 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3518 from the NNTP server @code{elmo-default-nntp-server}. The value of
3519 @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
3520 @code{elmo-default-nntp-stream-type} are used.
3522 If @code{confirm}, server name can be specified. You can specify NNTP
3523 folder format like @samp{-:username@@servername:119!}.
3525 @item wl-summary-keep-cursor-command
3526 @vindex wl-summary-keep-cursor-command
3527 The initial setting is the list shown below:
3531 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3536 When you entered to summary by these commands and the target summary
3537 buffer already exists, summary status is not automatically updated and
3538 cursor position is saved.
3540 @item wl-summary-update-confirm-threshold
3541 @vindex wl-summary-update-confirm-threshold
3542 The initial setting is 500. If updated message number is larger than
3543 this value, confirm whether drop them or not.
3545 @item wl-summary-always-sticky-folder-list
3546 @vindex wl-summary-always-sticky-folder-list
3547 The initial setting is @code{nil}.
3548 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3549 are automatically sticked. Each element is regexp of folder name.
3551 @item wl-summary-reserve-mark-list
3552 @vindex wl-summary-reserve-mark-list
3553 The initial setting is the list shown below:
3562 If a message is already marked as temporal marks in this list, the
3563 message is not marked by any mark command.
3565 @item wl-summary-skip-mark-list
3566 @vindex wl-summary-skip-mark-list
3567 The initial setting is the list shown below:
3576 If a message is already marked as temporal marks in this list, the
3577 message is skipped at cursor move.
3579 @item wl-fetch-confirm-threshold
3580 @vindex wl-fetch-confirm-threshold
3581 The initial setting is 30000 (bytes). If displaying message has larger
3582 size than this value, Wanderlust confirms whether fetch the message or
3583 not. If @code{nil}, the message is fetched without confirmation.
3585 @item wl-prefetch-threshold
3586 @vindex wl-prefetch-threshold
3587 The initial setting is 30000 (bytes). If prefetching message has larger
3588 size than this value and @code{wl-prefetch-confirm} is non-nil,
3589 Wanderlust confirms whether prefetch the message or not. If
3590 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3591 without confirmation.
3593 @item wl-prefetch-confirm
3594 @vindex wl-prefetch-confirm
3595 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3596 prefetch the message or not if the message has larger size than
3597 @code{wl-prefetch-threshold}.
3599 @item wl-cache-fetch-threshold
3600 @vindex wl-cache-fetch-threshold
3601 The initial setting is 30000 (bytes). The messages which have larger
3602 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3603 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3606 @item elmo-imap4-use-cache
3607 @vindex elmo-imap4-use-cache
3608 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3611 @item elmo-nntp-use-cache
3612 @vindex elmo-nntp-use-cache
3613 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3616 @item elmo-pop3-use-cache
3617 @vindex elmo-pop3-use-cache
3618 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3623 @node Message, Draft, Summary, Top
3624 @chapter Message Buffer
3626 Message Buffers utilize MIME-View mode of SEMI/tm. For operational
3627 procedures and key bindings, refer to respective documents.
3628 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3630 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3631 brings you back to Summary mode. @kbd{l} toggles display of Summary
3634 @section Key Bindings
3640 @findex wl-message-toggle-disp-summary
3641 Toggles display of Summary mode buffer.
3642 (@code{wl-message-toggle-disp-summary})
3645 @findex wl-message-refer-article-or-url
3646 @kindex Button-2 (Message)
3647 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3648 corresponding message if found.
3649 (@code{wl-message-refer-article-or-url})
3651 @item Button-4 (upward movement of a wheel)
3652 @kindex Button-4 (Message)
3653 @findex wl-message-wheel-down
3654 Scrolls the message backwards. When the top of the message is hit,
3655 moves to the previous message.
3656 (@code{wl-message-wheel-down})
3658 @item Button-5 (downward movement of a wheel)
3659 @kindex Button-5 (Message)
3660 @findex wl-message-wheel-up
3661 Scrolls the message forward. When the bottom of the message is hit,
3662 moves to the next message.
3663 (@code{wl-message-wheel-up})
3666 @section Customizable Variables
3669 @item wl-message-window-size
3670 @vindex wl-message-window-size
3671 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3672 its car and cdr value corresponds to the ratio of Summary and Message
3674 @item wl-message-ignored-field-list
3675 @vindex wl-message-ignored-field-list
3676 (SEMI only) Initial setting is nil.
3677 All fields that match this list will be hidden in message buffer.
3678 Each elements are regexp of field-name.
3679 If nil, the value of mime-view-ignored-field-list is used.
3680 @item wl-message-visible-field-list
3681 @vindex wl-message-visible-field-list
3682 (SEMI only) Initial setting is nil.
3683 All fields that match this list will be hidden in message buffer.
3684 Each elements are regexp of field-name. This value precedes
3685 wl-message-ignored-field-list.
3686 If nil, the value of mime-view-visible-field-list is used.
3687 @item wl-message-sort-field-list
3688 @vindex wl-message-sort-field-list
3689 (SEMI only) Initial setting is
3690 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3691 Header fields in message buffer are orderd by this value.
3692 Each elements are regexp of field-name.
3695 @node Draft, Disconnected Operations, Message, Top
3696 @chapter Draft Buffer
3698 At Summary mode, pressing @kbd{w} and the like creates a new draft
3699 buffer. You can edit and send mail and news articles in this buffer.
3703 Basically it is Emacs-standard mail mode.
3705 @subsection Address Completion
3707 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3708 addresses. @kbd{@key{TAB}} completes them.
3710 If you want to submit a news article, add @samp{Newsgroups:} field by
3711 yourself. Field names can be completed by @kbd{@key{TAB}}.
3713 If you save the draft buffer you are editing, it is appended to the
3714 folder specified by @code{wl-draft-folder}.
3716 Using @samp{FCC:} field, you can specify the folder to which a copy of
3717 the message is saved when it is sent.
3719 @subsection Editing Messages
3721 Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
3722 editing, refer to respective documents.
3723 @xref{MIME-Edit, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3725 @subsection Dynamic Modification of Messages
3726 @vindex wl-draft-config-alist
3727 @c @cindex Change Message
3728 @c @cindex Message, Change Dynamic
3730 You can set @code{wl-draft-config-alist} so that header and body of the
3731 message will automatically modified depending on information of header
3734 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3736 In the example below, the header is modified when
3737 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3738 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3739 before sending the message.
3743 (setq wl-draft-config-alist
3744 '(((string-match "aaa.example.com$" (system-name))
3745 ;; @r{applied if the expression is non-nil}
3746 (wl-smtp-posting-server . "mailserver-B")
3747 (wl-nntp-posting-server . "newsserver-B")
3748 ;; @r{settings of temporary variables}
3750 ("^To: .*user@@aaa.bbb.example.com"
3751 ;; @r{applied if it matches the header of the draft buffer}
3752 ("Organization" . (format "Go %s" my-webpage)))
3753 ;; @r{you can write elisp expressions here (eval only)}
3754 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3755 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3760 The format of @code{wl-draft-config-alist} is:
3764 '(("@var{regexp of the header}" or @var{elisp expression}
3765 ("@var{Field}" . value(@var{elisp expression}))
3766 (@var{variable} . value(@var{elisp expression}))
3767 (@var{sub-function} . value(@var{elisp expression}))
3770 ("@var{regexp of the header}" or @var{elisp expression}
3771 ("@var{Field}" . value(@var{elisp expression}))
3776 Per default, there are 10 following sub-functions.
3779 'header: Inserts the specified string at the bottom of the header.
3780 'header-file: Inserts the specified file at the bottom of the header.
3781 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3782 'top: Inserts the specified string at the top of the body.
3783 'top-file: Inserts the specified file at the top of the body.
3784 'body: Replaces the body with the specified string.
3785 Specifying @code{nil} deletes the entire body string.
3786 'body-file: Replaces the body with the content of the specified file.
3787 'bottom: Inserts the specified string at the bottom of the body.
3788 'bottom-file: Inserts the specified file at the top of the body.
3789 'template: Applies the specified template.
3790 (refer to the next subsection)
3793 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3794 change them or add your own functions. If you read the code, you can
3795 easily find how to write the functions.
3797 At the first of each item, @var{a regular expression of the header} or
3798 an @var{elisp expression} should be specified. In the case of an elisp
3799 expression, the item is applied when the expression is evaluated
3802 Per default, when multiple items match or are evaluated non-nil, all
3803 such items are applied, but if you set a variable
3804 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3807 At the second of the item, a cons or a list of functions should be
3808 specified. The car part of the cons should be a header field, a
3809 variable, or a sub-function. When a header field is specified, the
3810 field will be modified. If a variable is specified, the value of the
3811 variable will be modified temporarily.
3813 In the cdr part of a cons, not only a variable but also an elisp
3814 expression can be specified as is. If the car part is a header field
3815 and the cdr part is @code{nil}, the field will be deleted.
3817 See the next example as well:
3821 (setq wl-draft-config-alist
3823 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3824 ;; @r{applied if it matches the header of the buffer being replied}
3825 (body . " Hello.\n")
3826 (template . "default")
3831 As in the (1) above, if a header regexp is prepended with @code{reply},
3832 it is applied when the draft is prepared by @code{wl-summary-reply} for
3833 example, and when it matches the header being replied. It is ignored
3834 when there is no buffer being replied, like after @code{wl-draft} was
3837 Note that @code{wl-draft-config-alist} is applied only once when
3838 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3839 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3840 aborting transmission, execute @kbd{C-c C-e}
3841 (@code{wl-draft-config-exec}) explicitly.
3843 If you don't want to apply @code{wl-draft-config-alist} when
3844 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
3848 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
3851 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3852 prepared, do the following:
3855 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3858 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
3859 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
3863 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
3866 @subsection Inserting Templates
3868 @cindex Apply Template
3870 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3871 @kbd{M-x wl-template-select} in the draft buffer.
3873 The format of @code{wl-template-alist} is almost the same as
3874 @code{wl-draft-config-alist}.
3878 (setq wl-template-alist
3881 ("Organization" . "~/.wl sample")
3882 (body . "Hello.\n"))
3884 (template . "default") ;; @r{(a)}
3885 ("To" . "boss@@example.com")
3886 ("Subject" . "Report")
3887 (body-file . "~/work/report.txt")
3893 As you can see, the only difference is item (template) names such as
3894 @samp{default} and @samp{report}, instead of a regexp of header.
3895 Because definition of each item is the same as
3896 @code{wl-draft-config-alist}, you can call another template, like (a).
3898 Executing the command @code{wl-template-select} results in template
3899 selection, but the result differs depending on variable
3900 @code{wl-template-visible-select}.
3902 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3903 window is shown below the draft buffer. You can select a template by
3904 @kbd{n} and @kbd{p} seeing the buffer window.
3906 Press the @key{RET} key and the template is actually applied to the draft
3907 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3908 adjust the window size by @code{wl-template-buffer-lines}.
3910 If @code{wl-template-visible-select} is @code{nil}, you should type the
3911 name of the template in the mini buffer.
3913 As shown in the example in @code{wl-draft-config-alist}, you can select
3914 @samp{default} template by writing:
3917 (template . "default")
3920 @subsection Sending mail by POP-before-SMTP
3921 @cindex POP-before-SMTP
3923 You can send mail by POP-before-SMTP with this single line:
3926 (setq wl-draft-send-mail-func 'wl-draft-send-mail-with-pop-before-smtp)
3930 Configure the following variables if you need.
3933 @item wl-pop-before-smtp-user
3934 The POP user name for POP-before-SMTP authentication.
3935 If unset, @code{elmo-default-pop3-user} is used.
3937 @item wl-pop-before-smtp-server
3938 The POP server name for POP-before-SMTP authentication.
3939 If unset, @code{elmo-default-pop3-server} is used.
3941 @item wl-pop-before-smtp-authenticate-type
3942 The POP authentication method for POP-before-SMTP authentication.
3943 If unset, @code{elmo-default-pop3-authenticate-type} is used.
3945 @item wl-pop-before-smtp-port
3946 The POP port number for POP-before-SMTP authentication.
3947 If unset, @code{elmo-default-pop3-port} is used.
3949 @item wl-pop-before-smtp-stream-type
3950 If non-nil, POP connection is established using SSL. If
3951 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
3952 unset, @code{elmo-default-pop3-stream-type} is used.
3955 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
3956 unset, settings for POP folders (@code{elmo-default-pop3-*}) are
3958 Therefore, if SMTP server and POP server are actually the same, and if
3959 POP folder per default (such as @samp{&}) is available, no settings are
3962 Refer to the following URL about POP-before-SMTP.
3966 http://spam.ayamura.org/tools/smPbS.html
3967 http://www.iecc.com/pop-before-smtp.html
3971 @section Key Bindings
3972 @cindex Keybind, Draft Mode
3973 @cindex Keybind, Draft Buffer
3978 @kindex C-c C-y (Draft)
3979 @findex wl-draft-yank-original
3980 Cites the content of the current message buffer.
3981 (@code{wl-draft-yank-original})
3984 @kindex C-c C-p (Draft)
3985 @findex wl-draft-preview-message
3986 Previews the content of the current draft.
3987 This is useful for previewing MIME multi-part messages.
3988 (@code{wl-draft-preview-message})
3991 @kindex C-c C-s (Draft)
3992 @findex wl-draft-send
3993 Sends the content of the current draft. Does not erase the draft buffer.
3994 This is useful for sending multiple messages, which are a little different
3996 (@code{wl-draft-send})
3999 @kindex C-c C-c (Draft)
4000 @findex wl-draft-send-and-exit
4001 Sends the content of the current draft and erases the draft buffer.
4002 (@code{wl-draft-send-and-exit})
4005 @kindex C-x C-s (Draft)
4006 @findex wl-draft-save
4007 Save the current draft.
4008 (@code{wl-draft-save})
4011 @kindex C-c C-k (Draft)
4012 @findex wl-draft-kill
4013 Kills the current draft.
4014 (@code{wl-draft-kill})
4017 @kindex C-x k (Draft)
4018 @findex wl-draft-mimic-kill-buffer
4019 Kills the current draft.
4020 (@code{wl-draft-mimic-kill-buffer})
4023 @kindex C-c C-z (Draft)
4024 @findex wl-draft-save-and-exit
4025 Saves the current draft, and erases the draft buffer.
4026 This is useful if you want to suspend editing of the draft.
4027 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4028 the @samp{+draft} folder.
4029 (@code{wl-draft-save-and-exit})
4032 @kindex C-c C-r (Draft)
4033 @findex wl-caesar-region
4034 Encodes or decodes the specified region in Caesar cipher.
4035 (@code{wl-caesar-region})
4039 @findex wl-toggle-plugged
4040 Toggles off-line/on-line states of Wanderlust.
4041 (@code{wl-toggle-plugged})
4044 @kindex C-c C-o (Draft)
4045 @findex wl-jump-to-draft-buffer
4046 Jumps to the other draft buffer, if exists.
4047 With prefix argument, reads a file (if any) from the draft folder when
4048 there is no such buffer.
4049 (@code{wl-jump-to-draft-buffer})
4052 @kindex C-c C-e (Draft)
4053 @findex wl-draft-config-exec
4054 Applies @code{wl-draft-config-alist}.
4055 (@code{wl-draft-config-exec})
4058 @kindex C-c C-j (Draft)
4059 @findex wl-template-select
4061 (@code{wl-template-select})
4064 @kindex C-c C-a (Draft)
4065 @findex wl-draft-insert-x-face-field
4066 Inserts the content of a file @file{~/.xface} (the value of the variable
4067 @code{wl-x-face-file}) as an @samp{X-Face:} field in the draft buffer.
4069 There should be encoded X-Face strings as a content of a file @file{~/.xface}.
4070 (@code{wl-draft-insert-x-face-field})
4073 @section Customizable Variables
4076 @item wl-subscribed-mailing-list
4077 @vindex wl-subscribed-mailing-list
4078 The initial setting is @code{nil}. Mailing lists to which you
4079 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4080 field of a reply draft, removes your own address from
4081 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4082 contained in @samp{To:} or @samp{Cc:} field of a message to be
4083 automatically re-filed, the destination folder will be leaned in
4084 connection with the address.
4090 (setq wl-subscribed-mailing-list
4091 '("wl@@lists.airs.net"
4093 "emacs-mime-ja@@m17n.org"))
4097 @item wl-insert-mail-followup-to
4098 @vindex wl-insert-mail-followup-to
4099 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4100 field is automatically inserted in the draft buffer.
4102 @item wl-insert-mail-reply-to
4103 @vindex wl-insert-mail-reply-to
4104 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4105 field is automatically inserted in the draft buffer.
4107 @item wl-auto-insert-x-face
4108 @vindex wl-auto-insert-x-face
4109 The initial setting is @code{t}. If non-nil and there is an encoded
4110 X-Face string in a file @file{~/.xface} (the value of the variable
4111 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4112 draft buffer. If @code{nil}, it is not automatically inserted. Press
4113 @kbd{C-c C-a} to insert.
4115 @item wl-insert-message-id
4116 @vindex wl-insert-message-id
4117 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4118 is automatically inserted on the transmission.
4120 @item wl-local-domain
4121 @vindex wl-local-domain
4122 The initial setting is @code{nil}. If @code{nil}, the return value of
4123 the function @code{system-name} will be used as the domain part of
4126 If @code{system-name} does not return FQDN (i.e. the full name of the
4127 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4128 to the string of the local domain name without hostname (like
4129 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4130 @samp{.} @code{wl-local-domain} is used as domain part of the
4133 If your terminal does not have global IP, set the value of
4134 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4135 you use invalid @samp{Message-ID:}.)
4137 Moreover, concatenation of @code{system-name} @samp{.}
4138 @code{wl-local-domain} will be used as an argument to the HELO command
4141 @item wl-message-id-domain
4142 @vindex wl-message-id-domain
4143 The initial setting is @code{nil}. If non-nil, this value is used as a
4144 domain part of the @samp{Message-ID:}. If your terminal does not have
4145 global IP address, set unique string to this value (e.x. your e-mail
4148 @item wl-message-id-domain
4149 @vindex wl-message-id-domain
4150 The initial setting is @code{nil}. If @code{nil}, the return value of
4151 the function @code{system-name} will be used as the domain part of
4152 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4153 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4154 @strong{must} set this variable to the string of the full name of the
4155 host. Otherwise, you might be beaten up on the Net News.
4157 @item wl-draft-config-alist
4158 @vindex wl-draft-config-alist
4159 The initial setting is @code{nil}. Modifies the draft message just
4160 before the transmission. The content of @code{wl-draft-config-alist}
4161 will be automatically applied only once on the transmission. If you
4162 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4165 @item wl-template-alist
4166 @vindex wl-template-alist
4167 The initial setting is @code{nil}.
4168 This variable specifies the template to be applied in the draft buffer.
4170 @item wl-draft-config-matchone
4171 @vindex wl-draft-config-matchone
4172 The initial setting is @code{nil}. If non-nil, only the first matching
4173 item is used when @code{wl-draft-config-alist} is applied. If
4174 @code{nil}, all matching items are used.
4176 @item wl-template-visible-select
4177 @vindex wl-template-visible-select
4178 The initial setting is @code{t}.
4179 If non-nil, you can preview the result of the template selection in
4182 @item wl-template-confirm
4183 @vindex wl-template-confirm
4184 The initial setting is @code{nil}.
4185 If non-nil, asks for confirmation when you press the enter key to select
4186 template while previewing.
4188 @item wl-template-buffer-lines
4189 @vindex wl-template-buffer-lines
4190 The initial setting is 7.
4191 If @code{wl-template-visible-select} is non-nil, this variable specifies
4192 the size of the preview window.
4194 @item wl-draft-reply-buffer-style
4195 @vindex wl-draft-reply-buffer-style
4196 The initial setting is @code{split}. @code{split} or @code{full} can be
4197 specified. In the case of @code{full}, the whole frame will be used for
4198 a reply draft buffer when it is prepared.
4200 @item wl-draft-use-frame
4201 @vindex wl-draft-use-frame
4202 The initial setting is @code{nil}.
4203 If non-nil, use new frame for the draft.
4207 The initial setting is the value of the variable
4208 @code{user-mail-address}. The value of this variable is inserted as a
4209 @samp{From:} field of the draft when it is prepared.
4211 @item wl-envelope-from
4212 @vindex wl-envelope-from
4213 The initial setting is @code{nil}.
4214 The value of this variable is used for envelope from (MAIL FROM).
4215 If @code{nil}, the address part of @code{wl-from} is used.
4217 @item wl-user-mail-address-list
4218 @vindex wl-user-mail-address-list
4219 The initial setting is @code{nil}.
4220 This is the User's address list. If you have multiple addresses,
4225 The initial setting is @code{nil}.
4226 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4227 the draft when it is prepared. If function is specified, its return
4232 The initial setting is @code{nil}.
4233 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4234 the draft when it is prepared.
4236 @item wl-reply-subject-prefix
4237 @vindex wl-reply-subject-prefix
4238 The initial setting is @samp{Re: }.
4239 In the @samp{Subject:} of the reply draft, this string is prepended to
4240 the @samp{Subject:} of being replied.
4242 @item wl-draft-reply-use-address-with-full-name
4243 @vindex wl-draft-reply-use-address-with-full-name
4244 The initial setting is @code{t}.
4245 If non-nil, insert her full name with address when prepare a draft for
4246 reply a message. If it is @code{nil}, insert her address only.
4248 @item wl-draft-enable-queuing
4249 @vindex wl-draft-enable-queuing
4250 The initial setting is @code{t}.
4251 This flag controls off-line transmission. If non-nil, the draft is
4254 @item wl-draft-use-cache
4255 @vindex wl-draft-use-cache
4256 The initial setting is @code{nil}. If the value is non-nil and
4257 @code{wl-insert-message-id} is non-nil, cache the message which is sent.
4259 @item wl-auto-flush-queue
4260 @vindex wl-auto-flush-queue
4261 The initial setting is t.
4262 This flag controls automatic transmission of the queue when Wanderlust
4263 becomes on-line. If non-nil, the queue is automatically transmitted
4264 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4265 manually, press @kbd{F} in the folder mode.
4267 @item wl-ignored-forwarded-headers
4268 @vindex wl-ignored-forwarded-headers
4269 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4270 All headers that match this regexp will be deleted when forwarding a message.
4272 @item wl-ignored-resent-headers
4273 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4274 All headers that match this regexp will be deleted when resending a message.
4276 @item wl-draft-always-delete-myself
4277 @vindex wl-draft-always-delete-myself
4278 If non-nil, always removes your own address from @samp{To:} and
4279 @samp{Cc:} when you are replying to the mail addressed to you.
4281 @item wl-draft-delete-myself-from-bcc-fcc
4282 @vindex wl-draft-delete-myself-from-bcc-fcc
4283 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4284 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4286 @item wl-smtp-posting-server
4287 @vindex wl-smtp-posting-server
4288 The initial setting is @code{nil}.
4289 This is the SMTP server name for mail transmission.
4291 @item wl-smtp-posting-user
4292 @vindex wl-smtp-posting-user
4293 The initial setting is @code{nil}.
4294 This is the user name for SMTP AUTH authentication. If @code{nil},
4295 @code{smtp-authenticate-user} is used.
4297 @item wl-smtp-authenticate-type
4298 @vindex wl-smtp-authenticate-type
4299 The initial setting is @code{nil}.
4300 This is the authentication method for SMTP AUTH authentication. If
4301 @code{nil}, @code{smtp-authenticate-type} is used. If
4302 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4305 @item wl-smtp-connection-type
4306 @vindex wl-smtp-connection-type
4307 The initial setting is @code{nil}.
4308 This variable specifies how to establish SMTP connections.
4309 If @code{nil}, @code{smtp-connection-type} is used.
4310 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4312 @item wl-nntp-posting-server
4313 @vindex wl-nntp-posting-server
4314 The initial setting is @code{nil}.
4315 This is the NNTP server name used for news submission.
4316 If @code{nil}, @code{elmo-default-nntp-server} is used.
4318 @item wl-nntp-posting-user
4319 @vindex wl-nntp-posting-user
4320 The initial setting is @code{nil}.
4321 This is the user name for AUTHINFO authentication on news submission.
4322 If @code{nil}, @code{elmo-default-nntp-user} is used.
4323 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4325 @item wl-nntp-posting-port
4326 @vindex wl-nntp-posting-port
4327 The initial setting is @code{nil}.
4328 This is the port number of the NNTP server used for news submission.
4329 If @code{nil}, @code{elmo-default-nntp-server} is used.
4331 @item wl-nntp-posting-stream-type
4332 @vindex wl-nntp-posting-stream-type
4333 The initial setting is @code{nil}.
4334 If @code{nil}, @code{elmo-default-nntp-stream-type} is evaluated. If non-nil,
4335 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4336 connection will be established.
4338 @item wl-pop-before-smtp-user
4339 @vindex wl-pop-before-smtp-user
4340 The initial setting is @code{nil}.
4341 This is the POP user name for POP-before-SMTP.
4342 If it is @code{nil}, @code{elmo-default-pop3-user} is used.
4344 @item wl-pop-before-smtp-server
4345 @vindex wl-pop-before-smtp-server
4346 The initial setting is @code{nil}.
4347 This is the POP server name for POP-before-SMTP.
4348 If it is @code{nil}, @code{elmo-default-pop3-server} is used.
4350 @item wl-pop-before-smtp-authenticate-type
4351 @vindex wl-pop-before-smtp-authenticate-type
4352 The initial setting is @code{nil}.
4353 This is the authentication method for POP-before-SMTP authentication.
4354 If it is @code{nil}, @code{elmo-default-pop3-authenticate} is used.
4356 @item wl-pop-before-smtp-port
4357 @vindex wl-pop-before-smtp-port
4358 The initial setting is @code{nil}.
4359 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4360 @code{elmo-default-pop3-port} is used.
4362 @item wl-pop-before-smtp-stream-type
4363 @vindex wl-pop-before-smtp-stream-type
4364 The initial setting is @code{nil}.
4365 This flag controls the use of SSL for POP-before-SMTP. If it is
4366 @code{nil}, @code{elmo-default-pop3-stream-type} is used. If @code{starttls},
4367 STARTTLS (RFC2595) connection will be established.
4369 @item wl-draft-queue-save-variables
4370 @vindex wl-draft-queue-save-variables
4371 Specifies a list of variable to which queued messages are saved on the
4372 off-line transmission.
4374 @item wl-draft-sendlog
4375 @vindex wl-draft-sendlog
4376 The initial setting is @code{t}.
4377 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4381 @item drafts are sent by smtp or qmail
4382 @item saved into folders by fcc
4383 @item saved into folders by queuing
4386 (it is written even if the transmission fails).
4387 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4388 and left to the logging function of @command{imput}.
4391 @item wl-draft-sendlog-max-size
4392 @vindex wl-draft-sendlog-max-size
4393 The initial setting is 20000 (in bytes).
4394 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4395 beyond the size specified by this variable.
4399 The initial setting is @code{nil}.
4400 If non-nil, address completion uses LDAP.
4402 @item wl-ldap-server
4403 @vindex wl-ldap-server
4404 The initial setting is @samp{localhost}.
4405 LDAP server name for address completion.
4408 @vindex wl-ldap-port
4409 The initial setting is @code{nil}.
4410 If non-nil, the value is used as port number.
4413 @vindex wl-ldap-base
4414 The initial setting is @samp{c=US}.
4415 LDAP search starting point (base) for address completion.
4417 @item wl-draft-remove-group-list-contents
4418 @vindex wl-draft-remove-group-list-contents
4419 The initial setting is @code{t}.
4420 If non-nil, remove the group-lists' members in the recipients when
4421 sending the message (group-list means the description such as
4422 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4425 @node Disconnected Operations, Expire and Archive, Draft, Top
4426 @chapter Off-line Management
4427 @cindex Disconnected Operations
4429 Wanderlust has on-line and off-line states.
4432 * Off-line State:: Wanderlust has on-line and off-line states.
4433 * Enable Operations:: Enable Disconeected Operations.
4434 * Plugged Mode:: Switching On-line/Off-line per Server/Port.
4435 * Off-line State settings:: Invoking Wanderlust in the Off-line State.
4436 * Variables of Plugged Mode:: Customize Plugged Mode.
4440 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4441 @section Off-line State
4443 Wanderlust has on-line and off-line states. In the off-line state, you
4444 cannot access messages via network, unless they are cached.
4446 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4447 in the mode line indicates the off-line state. In folder or summary
4448 modes, press @kbd{M-t} to switch between off- and on-line.
4450 You can invoke Wanderlust in the off-line state by setting
4451 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4453 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4454 ignores uncached messages.
4457 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4458 @section Enable Disconeected Operations
4460 Even in the off-line state, provided that relevant messages are cached,
4461 and the variable @code{elmo-enable-disconnected-operation} (described
4462 later) is non-nil, you can following operations:
4463 @xref{Plugged Mode}, @xref{Off-line State settings}.
4466 * Send Messages off-line:: Transmit Messages.
4467 * Re-file and Copy queue:: Re-file and Copy (IMAP4).
4468 * Creation of Folders:: Create Folders off-line (IMAP4).
4469 * Marking:: Mark (IMAP4).
4470 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP).
4473 As soon as Wanderlust becomes on-line, such operations invoked off-line
4474 are reflected in the servers via network.
4477 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4478 @subsection Transmission of Messages
4480 You can send mail/news messages off-line (if you are using
4481 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4482 accumulated in the queue folder, @samp{+queue}. These messages are
4483 transmitted at once when Wanderlust becomes on-line.
4485 You can visit @samp{+queue} in the off-line state and confirm content of
4486 messages in the queue. You can also remove messages. Removed messages
4487 are not transmitted even in the on-line state.
4490 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4491 @subsection Re-file and Copy (IMAP4)
4493 Re-file and copy operations to IMAP folders invoked during the off-line
4494 state are accumulated in the queue, and reflected in the server side
4495 when Wanderlust becomes on-line. If you visit destination folders after
4496 off-line re-file or copy, it looks as if messages were appended even in
4499 For the safety reasons, messages re-filed off-line are removed from
4500 source folders only if their @samp{Message-ID:} match messages on the
4501 servers. While the queue is processed, messages that failed to be
4502 re-filed or copied to the specified folders are appended to the folder
4506 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4507 @subsection Creation of Folders (IMAP4)
4509 You can create IMAP folders off-line. The creation of folders are
4510 reflected in the servers when Wanderlust becomes on-line. At that time,
4511 if folders failed to be created on the servers for any reasons, messages
4512 re-filed to such folders are appended to the folder @samp{+lost+found}.
4515 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4516 @subsection Marking (IMAP4)
4518 Off-line changes in unread/read and importance mark @samp{$} information
4519 are also reflected in the servers when Wanderlust becomes on-line.
4522 @node Pre-fetching Reservations, , Marking, Enable Operations
4523 @subsection Pre-fetching (IMAP4, NNTP)
4525 You can make reservations for pre-fetching messages in IMAP or NNTP
4526 folders. Reserved messages are marked with @samp{!} but not cached
4527 yet. When Wanderlust becomes on-line, they are pre-fetched from
4530 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4531 these off-line operations for IMAP4 and NNTP do not take place, and
4532 off-line re-file, copy or suchlike simply results in error.
4534 Because off-line operations use cache files, it is a bad idea to erase
4535 them by hand; it may cause Wanderlust to malfunction.
4537 If you want to remove caches, be sure to execute @kbd{M-x
4538 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4539 remove caches for messages relevant to off-line operations.
4542 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4543 @section Switching On-line/Off-line per Server/Port
4545 @kbd{M-t} described above switches networking states as a whole, but you
4546 can switch on-line/off-line per server/port.
4548 Pressing @kbd{C-t} in the folder or summary modes brings you in
4549 wl-plugged-mode shown below, in which you can change the plugged state
4554 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4557 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4558 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4560 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4561 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4567 The first line indicates status of the following three variables, and
4568 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
4569 column modifies the values of these variables.
4573 "Queuing" @code{wl-draft-enable-queuing}
4574 "AutoFlushQueue" @code{wl-auto-flush-queue}
4575 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4579 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4582 The second and after lines indicate on-line/off-line states of servers
4583 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4584 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4585 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4587 @dfn{sending queue} means messages accumulated in the folder
4588 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4589 off-line operations when @code{elmo-enable-disconnected-operation} is
4591 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4592 @c off-line operations are enabled.
4594 They are displayed if there are any of them. In the example above, in
4595 the sending queue there are two messages (the first and the second in
4596 the queue folder) for smtp to hosta and one (the third) for nntp to
4597 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4600 If you change @samp{(wl-plugged)} in the second line, the variable
4601 @code{wl-plugged} is changed, so that the mode line indicator and
4602 plugged states of all ports are affected. If you change plugged states
4603 of any servers or ports, @samp{(wl-plugged)} in the second line is
4604 affected depending on @code{elmo-plugged-condition} settings and the
4605 plugged state of each port.
4608 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4609 @section Invoking Wanderlust in the Off-line State
4611 As described before, if you set @code{wl-plugged} to @code{nil} in
4612 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4613 off-line state. You can specify off-line state on a per server or port
4614 basis. Refer to @code{wl-reset-plugged-alist} also.
4616 Usually, when Wanderlust starts up, the plugged state of each port is
4617 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4618 @code{wl-nntp-posting-server} and so on. If you want to change the
4619 plugged state of these ports or to add other ports, configure
4620 @code{wl-make-plugged-hook} with a function.
4624 (add-hook 'wl-make-plugged-hook
4626 (elmo-set-plugged plugged-value(t/nil) server port)
4627 ;; @r{add or change plugged states of the port of the server}
4628 (elmo-set-plugged plugged-value(t/nil) server)
4629 ;; @r{if the port is omitted, all ports are affected}
4630 ;; @r{(you cannot omit the port if you newly add the server)}
4636 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4637 @section Customizable Variables
4642 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4643 mode from the beginning.
4645 @item wl-queue-folder
4646 @vindex wl-queue-folder
4647 The initial setting is @samp{+queue}.
4648 This is the folder in which messages in the transmission queue are
4651 @item wl-auto-flush-queue
4652 @vindex wl-auto-flush-queue
4653 The initial setting is @code{t}.
4654 This flag controls automatic transmission of the queue when Wanderlust
4655 becomes on-line. If non-nil, the queue is automatically transmitted
4656 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4657 manually, press @kbd{F} in the folder mode.
4659 @item elmo-enable-disconnected-operation
4660 @vindex elmo-enable-disconnected-operation
4661 The initial setting is @code{nil}. Controls off-line operations
4662 regarding IMAP4. If non-nil, off-line operations are carried out.
4664 @item elmo-lost+found-folder
4665 @vindex elmo-lost+found-folder
4666 The initial setting is @samp{+lost+found}.
4667 This is the folder to which messages are saved when they fails to be
4668 appended while the off-line re-file/copy queue is processed.
4670 @item elmo-plugged-condition
4671 @vindex elmo-plugged-condition
4672 The initial setting is @code{one}.
4673 The value of @code{wl-plugged} reflects the return value of the function
4674 @code{elmo-plugged-p} (without arguments).
4675 This variable @code{elmo-plugged-condition} specifies the condition on
4676 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4677 plugged state of each port.
4680 'one : plugged if one or more ports are plugged.
4681 'all : plugged if all ports are plugged.
4682 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4683 states of the ports.
4684 @var{function} : reflects the return value of the @var{function}
4685 functions available per default
4686 'elmo-plug-on-by-servers
4687 : reflects the plugged state of the servers specified by the
4688 variable elmo-plug-on-servers.
4689 'elmo-plug-on-by-exclude-servers
4690 : reflects the plugged state of the servers that are not
4691 in elmo-plug-on-exclude-servers.
4692 elmo-plug-on-exclude-servers defaults to
4695 (system-name)without the domain part)
4701 (setq elmo-plugged-condition 'all)
4703 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4704 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4706 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4707 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4711 @item wl-reset-plugged-alist
4712 @vindex wl-reset-plugged-alist
4713 The initial setting is @code{t}. If non-nil, plugged states are
4714 initialized on a per server or port basis when Wanderlust starts up.
4716 If @code{nil}, plugged states are retained while Emacs is running. In
4717 other words, they are initialized when Emacs is restarted even if the
4718 value is @code{nil}.
4722 @node Expire and Archive, Scoring, Disconnected Operations, Top
4723 @chapter Automatic Expiration and Archiving of Messages
4724 @cindex Expire and Archive
4727 * Expire:: Expiration and Archiving
4728 * Archive:: Archiving All Messages
4732 @node Expire, Archive, Expire and Archive, Expire and Archive
4734 @cindex Expire Message
4736 Expiration means deletion of old messages which have outlasted a
4737 certain period of time.
4739 @code{wl-expire} supports not only simple deletion, but also moving to
4740 specified archiving folders.
4744 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4745 or @kbd{M-e} in the summary mode.
4747 @subsection Configuring @code{wl-expire-alist}
4749 An example configuration of @code{wl-expire-alist} is shown below.
4750 Everything in this @code{wl-expire-alist} makes a great difference in
4751 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4752 to @code{t}, especially in the initial stage.
4756 (setq wl-expire-alist
4757 '(("^\\+trash$" (date 14) remove)
4759 ("^\\+tmp$" (date 7) trash)
4760 ;; @r{re-file to @code{wl-trash-folder}}
4761 ("^\\+outbox$" (number 300) "$outbox;lha")
4762 ;; @r{re-file to the specific folder}
4764 ;; @r{do not expire}
4765 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4766 ;; @r{archive by message number (retaining numbers)}
4767 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4768 ;; @r{archive by a fixed number (retaining numbers)}
4769 ("^\\+diary$" (date 30) wl-expire-archive-date)
4770 ;; @r{archive by year and month (numbers discarded)}
4775 Items in the list has the format of:
4778 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4782 The folder is examined if it matches @var{regexp-for-folders} from the
4783 beginning of the list. If you invoke expiration on the folder that does
4784 not match any of them, nothing will happen. And if either the second or
4785 the third element of the item is @code{nil}, expiration will not take
4788 You can use any one of the following for
4789 @var{specification-of-message-to-be-deleted}:
4792 @item (number @var{n1} [@var{n2}])
4793 deletes messages depending on the number of messages in the folder.
4795 @var{n1} is the number of messages which should survive deletion, for example
4796 if its value is 500, the newest 500 messages survive and the rests are
4799 @var{n2} is the number of messages in the folder on which expiration should
4800 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4801 folders with 510 or more messages are expired.
4802 If you configured automatic expiration, frequently used folders may
4803 expire every time it receive messages, and you may be annoyed with the
4804 long delay in reading mail.
4805 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4806 expiration would not take place until a certain number of messages
4809 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4810 with important/new/unread) are not deleted.
4811 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4812 will expire so as to have 500 messages including such ones.
4813 Otherwise, it will have 500 messages except such ones.
4815 @item (date @var{d1})
4816 deletes messages depending on the dates.
4818 Messages dated @var{d1} or more days ago are deleted, for example if its
4819 value is seven, messages seven days old or more are deleted. Note that
4820 the date is the one in the @samp{Date:} field of the message, not when
4821 the message entered the folder.
4823 Messages with no or invalid @samp{Date:} field does not expire; you
4824 might have to delete them by hand.
4827 You can use any one of the following in the place of @var{destination}:
4831 deletes the messages instantly.
4834 hide the messages from summary (messages are not deleted).
4837 moves the messages to @code{wl-trash-folder}.
4839 @item @var{string}(folder)
4840 moves the messages to the folder specified with @var{string}.
4842 It would be useful for specifying an archiving folder, but because this
4843 does not move important messages, it might be better to use the
4844 standard functions described below.
4846 @item @var{function}
4847 invokes the specified @var{function}.
4849 To the @var{function}, three arguments are passed: a folder name, a list
4850 of messages to be deleted, and msgdb information of the summary. You
4851 can specify function-specific arguments after the name of the
4852 @var{function}. Note that the list contains messages with marks in
4853 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4856 These are three standard functions; they moves messages to an archive
4857 folder in the specified way. This means old messages can be compressed
4858 and saved in a file, being deleted from the original folder.
4861 @item wl-expire-archive-number1
4862 re-files to archiving folders corresponding to the message numbers of
4863 the messages being deleted. For example, a message numbered 102 will be
4864 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4865 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4866 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4868 The archiving folders to which messages are re-filed are determined by
4869 the name of the folder as follows (in this case, archiving folders are
4870 handled as if @code{elmo-archive-treat-file} were non-nil).
4873 @item If the folder type is localdir:
4874 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4876 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4877 (@file{~/Mail/ml/wl-00100.zip}).
4879 @item The folder type is other than localdir:
4880 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4882 For example, @samp{%#mh/ml/wl} corresponds to
4883 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4886 As you can see, in the case of localdir, the folder type is not included
4887 in the path name, but otherwise it is included.
4888 And you can control the prefix to the archiving folder name by
4889 @code{wl-expire-archive-folder-prefix}.
4890 Refer to @code{wl-expire-archive-folder-prefix} for details.
4892 @item wl-expire-archive-number2
4893 re-files every certain number of messages to archiving folders.
4895 This differs from @samp{wl-expire-archive-number1} in that this re-files
4896 to the folder up to the specified number regardless of message numbers.
4897 The archiving folders to which messages are re-filed are determined in the
4898 same way as @code{wl-expire-archive-number1}.
4900 @item wl-expire-archive-date
4901 re-files messages depending on its date (year and month) to archive
4904 For example, a message dated December 1998 is re-filed to
4905 @code{$folder-199812;zip}. The name of the archiving folders except the
4906 date part are determined in the same way as
4907 @code{wl-expire-archive-number1}.
4910 You can set the first argument to these three standard functions to non-nil
4911 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4912 For example, it can be specified just after the name of the function:
4915 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4918 If you omit the argument, consecutive numbers from 1 are assigned for
4919 each archiving folder.
4922 @subsection Treatment for Important or Unread Messages
4924 If you specify any of @code{remove}, @code{trash}, a folder name, or a
4925 standard function, messages with marks in
4926 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
4927 messages} thereafter) are retained.
4929 Per default, this variable include the important, new, and unread marks,
4930 so that messages with these marks are not removed.
4931 Note that you cannot include the temporary mark (i.e. temporary marks
4932 are removed anyway), and be sure to process temporary marks before you
4935 @subsection Auto Expiration
4937 The following setup invokes expiration when you move into the summary
4938 mode. There will be no confirmation, so make sure you made no mistake
4939 in regexp and other settings before you set up this.
4943 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4947 In the folder mode, you can invoke expiration per group as well as per
4948 folder. Therefore, if you specify @samp{Desktop} group, all folders
4949 matching @code{wl-expire-alist} expire.
4953 @subsection Treating archive folders.
4954 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
4955 you must set non-nil value to @code{elmo-archive-treat-file}.
4957 @subsection Confirming
4959 If you are to use @code{remove}, try @code{trash} at first and see
4960 messages move to @code{wl-trash-folder} as expected, then replace it
4961 with @code{remove}. It would be dangerous to use @code{remove} from the
4964 If you are to use @code{wl-expire-archive-number1} and the like, try to
4965 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
4966 you can append messages to it. Even if settings in
4967 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
4968 would not be saved anywhere and disappeared in case the archiver program
4971 After you make sure you can archive to the folder correctly, you can
4972 invoke expiration and utilize the log.
4974 If you set @code{wl-expire-use-log} to @code{t},
4975 @file{~/.elmo/expired-log} should contain the log, for example:
4979 delete +ml/wl (593 594 595 596 597 598 599)
4980 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
4984 The first column indicates the operation, i.e. @samp{delete},
4985 @samp{copy}, or @samp{move}. The next is the name of the folder that
4986 expired. In the case of @samp{copy} and @samp{move}, the destination
4987 folder is recorded after @samp{->}. The last is the list of message
4988 numbers that are actually deleted or moved (in the case of @samp{copy}
4989 and @samp{move}, the number is the one in the source folder, rather than
4990 the destination folder).
4992 @subsection Re-filing Reserved Messages
4994 The three standard functions copy reserved messages to the archive
4995 folder, but do not delete them from the source folder. Because
4996 reserved messages and the like always remain, they are recorded in
4997 @file{~/.elmo/expired-alist} so that they are not copied over and over
4998 again. They are not recorded if copied by @code{wl-summary-archive}.
5000 If you enabled logging, usually @samp{move} is recorded for re-filing,
5001 but instead @samp{copy} and @samp{delete} are recorded separately if
5002 reserved messages are involved. This is because it actually copies
5003 messages including reserved, then deletes ones except reserved in that
5006 @section Customizable Variables
5009 @item wl-expire-alist
5010 @vindex wl-expire-alist
5011 The initial setting is @code{nil}.
5012 This variable specifies folders and methods to expire. For details,
5013 refer to @code{wl-expire-alist} settings above.
5015 @item wl-summary-expire-reserve-marks
5016 @vindex wl-summary-expire-reserve-marks
5017 The initial setting is the list below.
5021 (list wl-summary-important-mark
5023 wl-summary-unread-mark
5024 wl-summary-unread-uncached-mark
5025 wl-summary-unread-cached-mark)
5029 Messages with these marks are retained in the folder, even after
5031 Only permanent marks can be listed, not temporary marks.
5033 You can list marks one by one as in the default; you can use the
5034 following settings as well:
5038 All messages with permanent marks are retained,
5039 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5043 All messages are handled as usual ones that are already read, no matter
5044 what marks they have; even important messages are deleted.
5047 @item wl-expire-archive-files
5048 @vindex wl-expire-archive-files
5049 The initial setting is 100.
5050 This variable specifies the number of messages to be retained in one
5053 @item wl-expire-number-with-reserve-marks
5054 @vindex wl-expire-number-with-reserve-marks
5055 The initial setting is @code{nil}.
5056 If non-nil, if expiring messages are specified by @code{number},
5057 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5059 @item wl-expire-archive-get-folder-func
5060 @vindex wl-expire-archive-get-folder-func
5061 The initial setting is @code{wl-expire-archive-get-folder}.
5063 This variable specifies a function that returns the name of an archiving
5064 folder for standard functions in the place of @var{destination}.
5065 You can use the following three variables for simple modification of
5066 folder names; if you want more complex settings, define your own
5067 function in this variable.
5069 @code{wl-expire-archive-get-folder} can be customized by these
5072 @item @code{wl-expire-archive-folder-name-fmt}
5073 @item @code{wl-expire-archive-folder-type}
5074 @item @code{wl-expire-archive-folder-prefix}
5077 @item wl-expire-archive-folder-name-fmt
5078 @vindex wl-expire-archive-folder-name-fmt
5079 The initial setting is @samp{%s-%%05d;%s}.
5080 This is a @code{format} string for archiving folders used in
5081 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5082 Note that you must specify the message number by @samp{%%d}, because it
5083 is parsed twice by @code{format}.
5085 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5088 @item wl-expire-archive-date-folder-name-fmt
5089 @vindex wl-expire-archive-date-folder-name-fmt
5090 The initial setting is @samp{%s-%%04d%%02d;%s}.
5091 This is a @code{format} string for archiving folders used in
5092 @code{wl-expire-archive-date}. Note that you must specify the message
5093 number by @samp{%%d}, because it is parsed twice by @code{format}.
5094 There should be @samp{%%d} twice, one for the year and the other for the
5097 If you modify this, adjust
5098 @code{wl-expire-archive-date-folder-num-regexp} as well.
5100 @item wl-expire-archive-folder-type
5101 @vindex wl-expire-archive-folder-type
5102 The initial setting is @code{zip}.
5103 This variable specifies an archiver type of the archiving folders.
5105 @item wl-expire-archive-folder-prefix
5106 @vindex wl-expire-archive-folder-prefix
5107 The initial setting is @code{nil}.
5108 This variable specifies the prefix (directory structure) to archiving
5110 Exercise extreme caution in using this feature, as it has not been
5112 In the worst case, there is a fear of destructing archiving folders.
5116 There will be no prefix.
5119 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5120 @samp{$ml/wl-00000;zip;wl}.
5123 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5126 @samp{$ml/wl-00000;zip;ml/wl}.
5129 @item wl-expire-archive-folder-num-regexp
5130 @vindex wl-expire-archive-folder-num-regexp
5131 The initial setting is @samp{-\\([-0-9]+\\);}.
5132 This variable specifies the regular expression to be used for getting
5133 message numbers from multiple archiving folders specified by
5134 @code{elmo-list-folders}.
5135 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5137 @item wl-expire-archive-date-folder-num-regexp
5138 @vindex wl-expire-archive-date-folder-num-regexp
5139 The initial setting is @samp{-\\([-0-9]+\\);}.
5140 This is the regular expression to be used for getting message numbers
5141 from multiple archiving folders specified by @code{elmo-list-folders}.
5142 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5144 @item wl-expire-delete-oldmsg-confirm
5145 @vindex wl-expire-delete-oldmsg-confirm
5146 The initial setting is @code{t}.
5147 If non-nil, messages older than the one with the largest number will be
5148 deleted with confirmation.
5149 If @code{nil}, they are deleted without confirmation.
5151 This feature is valid only if non-nil is specified as a argument to the
5152 standard functions so as to retain numbers.
5154 @item wl-expire-use-log
5155 @vindex wl-expire-use-log
5156 The initial setting is @code{nil}.
5157 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5158 They are appended but not truncated or rotated automatically; you might
5159 need to remove it manually.
5161 @item wl-expire-add-seen-list
5162 @vindex wl-expire-add-seen-list
5163 The initial setting is @code{t}.
5165 If non-nil, when messages are re-filed by expiration, read/unread
5166 information is passed to the destination folder.
5168 However if you do not read the destination folder from Wanderlust,
5169 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5170 want to set this to @code{nil} if you are simply saving to some
5171 archiving folders. Even if its value is @code{nil}, messages in the
5172 archiving folders are simply treated as unread; it does not affect
5175 @item wl-expire-folder-update-msgdb
5176 @vindex wl-expire-folder-update-msgdb
5177 The initial setting is @code{t}.
5178 If @code{t}, in the folder mode, expiration is carried out after
5179 updating summary information. If you specified a list of regular
5180 expressions of folder names, summary information is updated for matching
5185 @node Archive, , Expire, Expire and Archive
5186 @section Archiving Messages
5188 @subsection Archiving Messages
5189 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5190 folders. If there are the archiving folders already, only new messages
5193 You can use @code{wl-archive-alist} in order to specify how messages are
5194 archived according to their folder names, as in @code{wl-expire-alist}.
5199 (setq wl-archive-alist
5200 '(("^\\+tmp$" wl-archive-date)
5201 ("^\\+outbox$" wl-archive-number2)
5202 (".*" wl-archive-number1)))
5206 Each item in the list has the following format:
5209 (@var{folders-regexp} @var{deleting-function})
5212 As you can see, you can only use a function after @var{folders-regexp}.
5213 Per default, there are three functions:
5216 @item @code{wl-archive-number1}
5217 @item @code{wl-archive-number2}
5218 @item @code{wl-archive-date}
5221 As inferred from their names, they work similarly to "expire" versions,
5222 other than the following points:
5225 @item No messages are deleted
5226 @item Message numbers are retained even if invoked without arguments
5229 These functions are good to archive all messages in a folder by their
5230 numbers or by their dates.
5231 These are also useful for backup or confirmation purposes before
5233 If you try to re-file them after they are archived, they are deleted but
5236 Per default, the archiving folders to which messages are copied are
5237 determined automatically by @code{wl-expire-archive-get-folder-func}.
5238 You can copy to a specific folder by invoking with a prefix argument,
5239 i.e. @kbd{C-u M-x wl-summary-archive}.
5241 Note that this feature has not been seriously tested, because you can
5242 simply copy to an archiving folder, for example by
5243 @code{wl-summary-copy-region}.
5245 The archiving folders are determined by the same logic as in
5246 @code{wl-summary-expire}; the following customizable variables are
5250 @item @code{wl-expire-archive-files}
5251 @item @code{wl-expire-archive-get-folder-func}
5252 @item @code{wl-expire-archive-folder-name-fmt}
5253 @item @code{wl-expire-archive-folder-type}
5254 @item @code{wl-expire-archive-folder-prefix}
5255 @item @code{wl-expire-archive-folder-num-regexp}
5258 @subsection Customizable Variables
5261 @item wl-archive-alist
5262 @vindex wl-archive-alist
5263 The initial setting is the list shown below:
5267 ((".*" wl-archive-number1))
5272 This variable specifies a function that copies to archiving folders.
5273 To the function, three arguments are passed: a folder name, a list of
5274 messages in the folder, and msgdb information of the summary.
5275 Needless to say, you can use your own function.
5279 @node Scoring, Customization, Expire and Archive, Top
5280 @chapter Score of the Messages
5282 @c @cindex Kill File
5284 Scoring is the function that associates a score (value) with each
5285 message, and marks as read or deletes from the summary according to it.
5287 You can put target or important marks on essential messages, or read marks
5288 on the ones you do not want to read, for example spam articles.
5290 This scoring function has a capability and a format similar to the one
5291 that Gnus has, although there are some unsupported features and
5292 Wanderlust specifics.
5293 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5296 * Score Commands:: Score Commands
5297 * Score File Format:: Score File Format
5301 @node Score Commands, Score File Format, Scoring, Scoring
5302 @section Score Commands
5303 @cindex Score Commands
5305 @subsection Score File Specification
5307 @code{wl-score-folder-alist} specifies score files or variables in which
5308 scores are defined, corresponding to folder names.
5312 (setq wl-score-folder-alist
5321 If paths to the score files are omitted, the directory specified in the
5322 variable @code{wl-score-files-dir} is assumed.
5324 No matter what you write in @code{wl-score-folder-alist}, the default
5325 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5326 read (it does not have to exist).
5327 Therefore, in the example above, the three score files,
5328 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5329 the folders that matches @samp{^-.*}.
5331 @subsection Scored Messages
5333 Scores are attached to the messages that are specified by
5334 @code{wl-summary-score-marks} temporarily when the summary is updated;
5335 when you exit from the summary, the scores are removed and reverts to
5338 @subsection Creation of Score Files
5340 In the summary buffer, move to an appropriate message and type @kbd{L}.
5341 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5342 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5344 This makes @minus{}1000 are scored for messages with the same
5345 @samp{Subject:} as the string you entered. That is, such a score file
5346 is created automatically.
5348 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5349 The score file you just made appears.
5350 This buffer is called @dfn{score editing buffer} thereafter.
5351 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5352 as you are previously; type @kbd{a}. Then a score entry for "From"
5354 In this way, you can create a score file easily either in the summary
5355 buffer or in the score editing buffer.
5357 By the way, you might be aware the numbers of key strokes are different
5358 between @kbd{s s p} and @kbd{a}.
5359 This is determined by @code{wl-score-header-default-entry}.
5360 This variable specifies the default score entries corresponding to
5362 For example, for "subject" field, a type and a time limit are prompted,
5363 but for "from" field, they are fixed upon automatically as substring and
5364 permanent respectively.
5365 However, score values can be modified by the prefix argument.
5366 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5369 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5370 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5371 erasing contents of the buffer deletes the score file being edited.
5375 @subsubsection Selecting Score Files
5377 You can change score files to which scores are appended by
5378 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5379 @code{wl-score-change-score-file}.
5381 @subsubsection Summing Up the Score
5383 If you add the same entries by @code{wl-summary-increase-score},
5384 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5385 scores for the entry is summed up.
5387 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5388 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5389 @minus{}1200 will be created as a result.
5391 @subsubsection Creating Thread Key
5393 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5394 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5396 @subsubsection Creating Followup Key
5398 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5399 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5400 at the cursor to @samp{References} key.
5401 If @code{wl-score-auto-make-followup-entry} is non-nil,
5402 @samp{Message-ID} of all messages to be followed up within dates
5403 specified by @code{wl-score-expiry-days}.
5405 @subsection Key Bindings
5410 @findex wl-summary-increase-score
5411 Increases the score for the current message.
5412 And the score entry is appended to the score file at the same moment.
5413 You can specify the score value by a prefix argument.
5417 @findex wl-summary-lower-score
5418 Decreases the score for the current message.
5419 And the score entry is appended to the score file at the same moment.
5420 You can specify the score value by a prefix argument.
5423 @kindex h R (Summary)
5424 @findex wl-summary-rescore
5425 Re-applies the scoring.
5426 However, already scored messages are not scored anew.
5429 @kindex h c (Summary)
5430 @findex wl-score-change-score-file
5431 Changes the score file currently selected.
5434 @kindex h e (Summary)
5435 @findex wl-score-edit-current-scores
5436 Edits the score file currently selected.
5437 If there are multiple score files, the previously specified one is
5441 @kindex h f (Summary)
5442 @findex wl-score-edit-file
5443 Edits an arbitrary score file and selects it.
5446 @kindex h F (Summary)
5447 @findex wl-score-flush-cache
5448 Erases caches associated to the score files that are read.
5449 If you modified score files directly (from other than Wanderlust), you
5450 need to re-read them after erasing the cache.
5453 @kindex h m (Summary)
5454 @findex wl-score-set-mark-below
5455 Specifies the criterion for scores to be marked as read.
5456 Messages with scores less than this value are marked as read.
5459 @kindex h x (Summary)
5460 @findex wl-score-set-expunge-below
5461 Specifies the criterion for scores to be deleted from the summary.
5462 Messages with scores less than this value are deleted.
5463 "Deleted" means it is not shown; they are not removed from the summary
5464 information or the folder.
5465 The deleted messages can be shown by rescan-noscore again.
5468 @subsection Key Bindings in the Score Editing Buffer
5472 @kindex C-c C-k (Score Mode)
5473 @findex wl-score-edit-kill
5474 Abandons the file being edited.
5477 @kindex C-c C-c (Score Mode)
5478 @findex wl-score-edit-exit
5479 Saves the file being edited, and quits from the edit mode.
5482 @kindex C-c C-p (Score Mode)
5483 @findex wl-score-pretty-print
5487 @kindex C-c C-d (Score Mode)
5488 @findex wl-score-edit-insert-date
5489 Inserts the number of dates from Dec. 31, 1 B.C.
5490 It is used for creating the third factor of time-limited scores.
5493 @kindex C-c C-s (Score Mode)
5494 @findex wl-score-edit-insert-header
5495 Inserts the header of the message selected in the summary buffer.
5498 @kindex C-c C-e (Score Mode)
5499 @findex wl-score-edit-insert-entry
5500 Inserts the score entry of the message selected in the summary buffer.
5503 @subsection Customizable Variables
5506 @item wl-summary-default-score
5507 @vindex wl-summary-default-score
5508 The initial setting is 0 (zero).
5509 This variable specifies the default value of the score.
5510 The score is increased or decreased based upon this value.
5512 @item wl-summary-important-above
5513 @vindex wl-summary-important-above
5514 The initial setting is @code{nil}.
5515 Messages with scores larger than this value are attached with the
5516 important mark (@samp{$}).
5517 If @code{nil}, no important marks are attached.
5519 @item wl-summary-target-above
5520 @vindex wl-summary-target-above
5521 The initial setting is @code{nil}.
5522 Messages with scores larger than this value are attached with the target
5524 If @code{nil}, no target marks are attached.
5526 @item wl-summary-mark-below
5527 @vindex wl-summary-mark-below
5528 The initial setting is 0 (zero).
5529 Messages with scores smaller than this value are marked as read.
5531 @item wl-summary-expunge-below
5532 @vindex wl-summary-expunge-below
5533 The initial setting is @code{nil}.
5534 Messages with scores smaller than this value are deleted from the
5536 If @code{nil}, they are not deleted.
5538 @item wl-summary-score-marks
5539 @vindex wl-summary-score-marks
5540 The initial setting is the list shown below:
5544 (list wl-summary-new-mark)
5549 Messages with these marks are scored.
5551 @item wl-use-scoring
5552 @vindex wl-use-scoring
5553 The initial setting is t.
5554 If non-nil, scoring is enabled.
5556 @item wl-score-files-dir
5557 @vindex wl-score-files-dir
5558 The initial setting is @file{~/.elmo/}.
5559 The default directory for score files.
5561 @item wl-score-interactive-default-score
5562 @vindex wl-score-interactive-default-score
5563 The initial setting is 1000.
5564 This value is used as a score when a score factor is @code{nil} in the
5565 score file. It is also used in @code{wl-summary-increase-score} and
5566 @code{wl-summary-lower-score}, on condition that the value of
5567 @code{wl-score-header-default-entry} is @code{nil}.
5569 @item wl-score-expiry-days
5570 @vindex wl-score-expiry-days
5571 The initial setting is 7.
5572 This is the number of days before time-limited scores are deleted.
5574 @item wl-score-update-entry-dates
5575 @vindex wl-score-update-entry-dates
5576 The initial setting is @code{t}.
5577 If non-nil, it enables deletion of time-limited scores.
5579 @item wl-score-header-default-entry
5580 @vindex wl-score-header-default-entry
5581 Specifies the default value for each header field for score entries
5582 created by @code{wl-summary-increase-score},
5583 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5585 @item wl-score-simplify-fuzzy-regexp
5586 @vindex wl-score-simplify-fuzzy-regexp
5587 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5588 regular expression to be deleted from the string.
5589 Because this is usually used for Subject, the default is prefixes that
5590 are attached by mailing list programs.
5592 @item wl-summary-rescore-partial-threshold
5593 @vindex wl-summary-rescore-partial-threshold
5594 The initial setting is 200.
5595 When sync-all or rescan is executed, if there are messages more than
5596 this value, only the last same number of messages as this value are
5599 @item wl-summary-auto-sync-marks
5600 @vindex wl-summary-auto-sync-marks
5601 If non-nil, unread/important marks are synchronized when the summary
5603 Unread marks reflect information on the IMAP4 server.
5604 Important marks reflect information on the IMAP4 server (flagged or
5605 not), and contents of @samp{'mark} folder.
5606 The initial setting is @code{t}.
5610 @node Score File Format, , Score Commands, Scoring
5611 @section Score File Format
5612 @cindex Score File Format
5614 The format of score files are the same as Gnus, and basically you can
5615 use Gnus score files as they are. But they are not fully compatible
5616 because some keys are not supported and there are Wanderlust specifics.
5617 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5622 ("for sale" -1000 nil s)
5623 ("profit" -1000 nil s))
5625 ("spam@@spamspamspam" -10000 nil s))
5627 ("my@@address" 3001 nil s))
5629 (1000000 -10 nil >))
5639 If the key is a string, it is the name of the header to be matched.
5640 The following keys are available:
5641 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5642 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5643 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5644 @code{Chars} and @code{Lines} mean the size and the number of lines of
5645 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5646 are described later.
5647 The rest corresponds the field of the same name.
5649 Arbitrary numbers of core entries are specified after the key.
5650 Each score entry consists of these five factors:
5654 A factor that matches header. This should be a number in the cases of
5655 @code{lines} and @code{chars}, otherwise a string.
5658 A score factor. When the first item matches, the score of the message
5659 is increased or decreased by this value.
5662 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5663 of a number, the score is deleted if it does not match for days
5664 (@code{wl-score-expiry-days}) from the date specified by this.
5665 The date is since Dec. 31, 1 B.C.
5668 A type factor. This specifies the way the first factor matches.
5669 Available types depend on keys.
5672 @item From, Subject, References, Message-ID
5673 For these keys in string, @code{r} and @code{R} (regexp),
5674 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5675 as well as @code{f} and @code{F} (fuzzy) can be used.
5676 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5679 For these keys, the following five numerical relative operators can be
5680 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5683 This key matches @code{From} header, and scores all follow-ups to the
5685 For example, it would be useful for increasing scores for follow-ups to
5688 You can use the same types as @code{From} except for @code{f}.
5689 And a @samp{Followup} entry is automatically appended to the score file.
5692 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5693 A @samp{Thread} entry is automatically appended for each article that
5694 has @var{x} in the @code{References} header.
5695 You can make sure the whole thread including messages that does not have
5696 all ancestors @code{Message-ID} in @code{References} is scored.
5698 You can use the same types as @code{References} except for @code{f}.
5699 And a @samp{Thread} entry is automatically appended to the score file.
5703 A factor for extension header. This is meaningful only if the key is
5705 This specifies headers to be matched other than standard headers like
5706 @code{Subject} and @code{From}.
5707 Note that you should specify the header in
5708 @code{elmo-msgdb-extra-fields} also.
5709 Therefore it does not work in folders where extension headers cannot be
5714 The sum of these scores @emph{after all factors are applied} becomes the
5715 score of the message.
5717 @cindex Score File Atoms
5719 Messages with a score less than this value is marked as read.
5720 The default is @code{wl-summary-mark-below}.
5723 Messages with a score less than this value is deleted from the summary.
5724 The default is @code{wl-summary-expunge-below}.
5726 @item mark-and-expunge
5727 Both @code{mark} and @code{expunge} are applied,
5728 i.e. messages with a score less than this value is marked as read and
5729 deleted from the summary.
5732 Messages with a score greater than this value is attached with temp
5734 The default is @code{wl-summary-target-above}.
5737 Messages with a score greater than this value is attached with important
5739 The default is @code{wl-summary-important-above}.
5744 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5745 are used, you need to set @code{elmo-msgdb-extra-fields}.
5748 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5751 There are other restrictions as shown below:
5754 @item Because @samp{References} field in the summary information
5755 contains only the last @samp{Message-ID}, @code{references} key matches
5759 Keys that can be seen by folder of types:
5763 chars lines xref extra
5764 localdir,localnews Y E E E
5765 nntp (supporting xover) Y E E N
5771 N: cannot be seen (ignored)
5772 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5777 @node Customization, Mailing List, Scoring, Top
5778 @chapter Customizing Wanderlust
5779 @cindex Customization
5782 * Living with other packages:: Living with other packages
5783 * Highlights:: Highlights
5784 * Biff:: Notify Mail arrival
5785 * Advanced Settings:: Advanced Settings
5786 * Customizable Variables:: Customizable Variables
5791 @node Living with other packages, Highlights, Customization, Customization
5792 @section Living with other packages
5794 Examples with other packages.
5797 * imput:: imput (im-wl.el)
5799 * supercite:: supercite.el
5800 * mu-cite:: mu-cite.el
5801 * x-face-mule:: x-face-mule.el
5802 * dired-dd:: dired-dd.el
5807 @node imput, BBDB, Living with other packages, Living with other packages
5812 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5815 If @command{imput} is on the @code{exec-path} at the installation,
5816 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
5820 (autoload 'wl-draft-send-with-imput-async "im-wl")
5821 (setq wl-draft-send-func 'wl-draft-send-with-imput-async)
5826 @node BBDB, supercite, imput, Living with other packages
5830 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
5833 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
5834 byte-compiled and installed.
5842 ;; @r{enable pop-ups}
5843 (setq bbdb-use-pop-up t)
5844 ;; @r{auto collection}
5845 (setq bbdb/mail-auto-create-p t)
5846 (setq signature-use-bbdb t)
5847 (setq bbdb-north-american-phone-numbers-p nil)
5848 ;; @r{shows the name of bbdb in the summary} :-)
5849 (setq wl-summary-from-func 'bbdb-wl-from-func)
5850 ;; @r{automatically add mailing list fields}
5851 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
5852 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
5856 @node supercite, mu-cite, BBDB, Living with other packages
5857 @subsection sc.el(supercite), sc-register.el
5861 The same setting as usual mailers should be OK. The following is an
5862 example of settings:
5866 (autoload 'sc-cite-original "sc" nil t)
5867 (setq mail-yank-hooks 'sc-cite-original)
5868 (setq sc-preferred-header-style 1)
5869 (setq sc-electric-references-p nil)
5870 (setq sc-citation-leader "")
5871 (setq sc-load-hook '(lambda () (require 'sc-register)))
5872 (setq sc-preferred-attribution 'registeredname)
5877 @node mu-cite, x-face-mule, supercite, Living with other packages
5878 @subsection mu-cite.el
5881 The same setting as usual mailers should be OK. The following is an
5882 example of settings.
5884 If you use mu-cite version 8.0 or earlier:
5888 (autoload 'mu-cite/cite-original "mu-cite" nil t)
5889 (setq mail-citation-hook 'mu-cite/cite-original)
5893 If you use mu-cite version 8.1 or later:
5897 (autoload 'mu-cite-original "mu-cite" nil t)
5898 (add-hook 'mail-citation-hook (function mu-cite-original))
5902 @node x-face-mule, dired-dd, mu-cite, Living with other packages
5903 @subsection x-face-mule.el
5907 It depends on the version of x-face-mule.
5908 If you use x-face-mule 0.19 or older, do the following:
5912 (setq wl-highlight-x-face-func
5914 (lambda (&optional beg end)
5915 (x-face-mule:x-face-decode-message-header))))
5916 (require 'x-face-mule)
5920 If you use x-face-mule 0.20 or later, try the following:
5924 (setq wl-highlight-x-face-func
5926 (lambda (&optional beg end)
5927 (x-face-mule-x-face-decode-message-header))))
5928 (require 'x-face-mule)
5932 Use these settings when you use @file{x-face-mule.el} attached to
5933 bitmap-mule 8.0 or later:
5937 (autoload 'x-face-decode-message-header "x-face-mule")
5938 (setq wl-highlight-x-face-func 'x-face-decode-message-header)
5942 If there is an encoded X-Face string in a file @file{~/.xface} (the
5943 value of the variable @code{wl-x-face-file}), it is inserted as a
5944 @samp{X-Face:} field in the draft buffer (if
5945 @code{wl-auto-insert-x-face} is non-nil).
5948 @node dired-dd, MHC, x-face-mule, Living with other packages
5949 @subsection dired-dd(Dired-DragDrop)
5950 @pindex Dired-DragDrop
5952 @cindex Drag and Drop
5954 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
5955 compose multi-part by simple Drag-and-Drop from dired to the draft
5956 buffer being edited in GNU Emacs (this feature is not Wanderlust
5957 specific, but general-purpose for tm/SEMI).
5961 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
5967 ;; @r{Set dired-x variables here.}
5968 ;; @r{To and flo@dots{}}
5970 (progn (require 'dired-dd)
5971 (require 'dired-dd-mime))))))
5975 @node MHC, , dired-dd, Living with other packages
5979 Message Harmonized Calendaring system
5980 (@uref{http://www.quickhack.net/mhc/})
5982 By using MHC, you can make a calendar from the messages.
5988 (setq mhc-mailer-package 'wl)
5989 (autoload 'mhc-mode "mhc" nil t)
5990 (add-hook 'wl-summary-mode-hook 'mhc-mode)
5991 (add-hook 'wl-folder-mode-hook 'mhc-mode)
5999 (autoload 'mhc-wl-setup "mhc-wl")
6000 (add-hook 'wl-init-hook 'mhc-wl-setup)
6004 @node Highlights, Biff, Living with other packages, Customization
6007 @subsection Customizable Variables
6010 @item wl-summary-highlight
6011 @vindex wl-summary-highlight
6012 The initial setting is @code{t}.
6013 If non-nil, the summary is highlighted.
6015 @item wl-highlight-max-summary-lines
6016 @vindex wl-highlight-max-summary-lines
6017 The initial setting is 10000.
6018 The summary is not highlighted if it has more lines than this value.
6020 @item wl-summary-highlight-partial-threshold
6021 @vindex wl-summary-highlight-partial-threshold
6022 The initial setting is 1000.
6023 This is a threshold whether the whole summary is highlighted.
6024 If there are more lines of messages in the summary, it is partially
6027 @item wl-summary-partial-highlight-above-lines
6028 @vindex wl-summary-partial-highlight-above-lines
6029 The initial setting is 30. If there are more lines of messages than
6030 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6031 after the point that is the same number of lines as this value above the
6032 cursor line are highlighted partially. (If this value is @code{nil},
6033 the last same number of lines as the value of
6034 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6036 @item wl-highlight-body-too
6037 @vindex wl-highlight-body-too
6038 The initial setting is @code{t}.
6039 If non-nil, bodies of drafts and messages are also highlighted.
6041 @item wl-highlight-message-header-alist
6042 @vindex wl-highlight-message-header-alist
6043 When highlighting headers of drafts and messages, this variable
6044 specifies which faces are allocated to important
6045 (@code{wl-highlight-message-important-header-contents}), secondly
6046 important (@code{wl-highlight-message-important-header-contents2}), and
6047 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6049 Similarly, it can be used for allocating arbitrary faces to arbitrary
6050 regular expressions.
6052 @item wl-highlight-citation-prefix-regexp
6053 @vindex wl-highlight-citation-prefix-regexp
6054 Specifies a regular expression to which quoted lines in bodies of
6055 drafts and messages match.
6056 Bodies matching to this regular expression are highlighted by the faces
6057 specified by (@code{wl-highlight-message-cited-text-*}).
6059 @item wl-highlight-highlight-citation-too
6060 @vindex wl-highlight-highlight-citation-too
6061 The initial setting is @code{nil}.
6062 If non-nil, the quoting regular expression itself given by
6063 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6065 @item wl-highlight-citation-header-regexp
6066 @vindex wl-highlight-citation-header-regexp
6067 Specifies a regular expression that denotes beginning of quotation.
6068 Bodies matching to this regular expression are highlighted by the face
6069 specified by @code{wl-highlight-message-headers}.
6071 @item wl-highlight-max-header-size
6072 @vindex wl-highlight-max-header-size
6073 The initial setting is @code{nil}. If a header size is larger than this
6074 value, it will not be highlighted. If @code{nil}, always highlighted
6075 (ignore header size).
6077 @item wl-highlight-max-message-size
6078 @vindex wl-highlight-max-message-size
6079 The initial setting is 10000.
6080 If a message is larger than this value, it will not be highlighted.
6081 With this variable, highlight is suppressed for uuencode or huge digest
6084 @item wl-highlight-signature-separator
6085 @vindex wl-highlight-signature-separator
6086 Specifies regular expressions that denotes the boundary of a signature.
6087 It can be a regular expression, or a list of ones.
6088 Messages after the place that matches this regular expression are
6089 highlighted by the face specified by
6090 @code{wl-highlight-message-signature}.
6092 @item wl-max-signature-size
6093 @vindex wl-max-signature-size
6094 The initial setting is 400.
6095 This is the largest size for a signature to be highlighted.
6097 @item wl-use-highlight-mouse-line
6098 @vindex wl-use-highlight-mouse-line
6099 The initial setting is @code{t}.
6100 If non-nil, the line pointed by the mouse is highlighted in the folder
6101 mode, summary mode, and the like.
6104 @subsection Setting Colors and Fonts of the Characters
6106 If you want to change colors or fonts of the characters, you need to
6107 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6108 want to change fonts, and @code{set-face-foreground} for colors, and so
6109 on. You cannot write face settings in @file{.emacs}; write in
6112 For example, if you want to change the color for signatures to yellow,
6116 (set-face-foreground 'wl-highlight-message-signature "yellow")
6122 Faces defined in Wanderlust:
6125 @item wl-highlight-message-headers
6126 The face for field names of message headers.
6128 @item wl-highlight-message-header-contents
6129 The face for field bodies of message headers.
6131 @item wl-highlight-message-important-header-contents
6132 The face for important parts of message headers.
6133 Per default, this face is used for a body of @samp{Subject:} field.
6134 You can change its value by editing
6135 @code{wl-highlight-message-header-alist}.
6137 @item wl-highlight-message-important-header-contents2
6138 The face for secondly important parts of message headers.
6139 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6140 fields. You can change its value by editing
6141 @code{wl-highlight-message-header-alist}.
6143 @item wl-highlight-message-unimportant-header-contents
6144 The face for unimportant parts of message headers.
6145 Per default, this face is used for bodies of @samp{X-} fields
6146 @samp{User-Agent:} fields. You can change its value by editing
6147 @code{wl-highlight-message-header-alist}.
6149 @item wl-highlight-message-citation-header
6150 The face for headers of quoted messages.
6152 @item wl-highlight-message-cited-text-*
6153 The face for texts of quoted messages. The last @samp{*} is a
6154 @var{single figure} so that 10 different colors can be used according to
6157 @item wl-highlight-message-signature
6158 The face for signatures of messages. The initial settings are
6159 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6160 dark background colors.
6162 @item wl-highlight-header-separator-face
6163 The face for header separators of draft messages.
6165 @item wl-highlight-summary-important-face
6166 The face for message lines with important marks in the summary.
6168 @item wl-highlight-summary-new-face
6169 The face for message lines with new marks in the summary.
6171 @item wl-highlight-summary-displaying-face
6172 The face for the message line that is currently displayed.
6173 This face is overlaid.
6175 @item wl-highlight-thread-indent-face
6176 The face for the threads that is currently displayed.
6178 @item wl-highlight-summary-unread-face
6179 The face for message lines with unread marks in the summary.
6181 @item wl-highlight-summary-deleted-face
6182 The face for message lines with delete marks in the summary.
6184 @item wl-highlight-summary-refiled-face
6185 The face for message lines with re-file marks in the summary.
6187 @item wl-highlight-refile-destination-face
6188 The face for re-file information part of message lines with re-file
6189 marks in the summary.
6191 @item wl-highlight-summary-copied-face
6192 The face for message lines with copy marks in the summary.
6194 @item wl-highlight-summary-target-face
6195 The face for message lines with target marks @samp{*} in the summary.
6197 @item wl-highlight-summary-thread-top-face
6198 The face for message lines that are on the top of the thread in the
6201 @item wl-highlight-summary-normal-face
6202 The face for message lines that are not on top of the thread in the
6205 @item wl-highlight-folder-unknown-face
6206 The face for folders that are not known to have how many unsync messages
6209 @item wl-highlight-folder-zero-face
6210 The face for folders that have no unsync messages in the folder mode.
6212 @item wl-highlight-folder-few-face
6213 The face for folders that have some unsync messages in the folder mode.
6215 @item wl-highlight-folder-many-face
6216 The face for folders that have many unsync messages in the folder mode.
6217 The boundary between `some' and `many' is specified by the variable
6218 @code{wl-folder-many-unsync-threshold}.
6220 @item wl-highlight-folder-unread-face
6221 The face for folders that have no unsync but unread messages in the
6224 @item wl-highlight-folder-killed-face
6225 The face for folders that are deleted from the access group in the
6228 @item wl-highlight-folder-opened-face
6229 The face for open groups in the folder mode.
6230 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6231 @code{nil} or a @var{number}.
6233 @item wl-highlight-folder-closed-face
6234 The face for close groups in the folder mode.
6235 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6236 @code{nil} or a @var{number}.
6238 @item wl-highlight-folder-path-face
6239 The face for the path to the currently selected folder in the folder
6242 @item wl-highlight-logo-face
6243 The face for logo in the demo.
6245 @item wl-highlight-demo-face
6246 The face for strings (for example, a version number) in the demo.
6250 @node Biff, Advanced Settings, Highlights, Customization
6251 @section Notify Mail arrival
6254 Following setting is to notify mail arrival of @samp{%inbox}
6255 by the indicator on the modeline
6258 (setq wl-biff-check-folder-list '("%inbox"))
6261 @subsection Customizable Variables
6263 @item wl-biff-check-folder-list
6264 @vindex wl-biff-check-folder-list
6265 The initial setting is @code{nil}.
6266 This is the list of folders to check mail arrival.
6267 If @code{nil}, wl doesn't check mail arrival.
6269 @item wl-biff-check-interval
6270 @vindex wl-biff-check-interval
6271 The initial setting is 40 (in seconds).
6272 Check mail arrival in this period.
6274 @item wl-biff-notify-hook
6275 @vindex wl-biff-notify-hook
6276 The initial setting is @code{nil}.
6277 This is a hook run at the arrival of the new mail.
6280 (setq wl-biff-notify-hook '(beep))
6285 @node Advanced Settings, Customizable Variables, Biff, Customization
6286 @section Advanced Settings
6289 * Draft for Reply:: Draft for Reply
6290 * Thread Format:: Appearance of Thread
6291 * User-Agent Field:: @samp{User-Agent:} Header Field
6295 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6296 @subsection Draft for Replay
6297 @vindex wl-draft-reply-with-argument-list
6298 @vindex wl-draft-reply-without-argument-list
6299 @vindex wl-draft-reply-myself-with-argument-list
6300 @vindex wl-draft-reply-myself-without-argument-list
6302 If you want, when you replying to articles in mailing lists, the address
6303 in Reply-To field of the original message to be prepared to To field of
6304 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6309 (setq wl-draft-reply-without-argument-list
6310 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6311 ("Followup-To" . (nil nil ("Followup-To")))
6312 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6313 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6318 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6319 in the original message, @samp{Reply-To:} field in the original is
6320 copied to @samp{To:} field.)
6322 Moreover, the behavior of @kbd{a} with prefix argument can
6323 be directed by @code{wl-draft-reply-with-argument-list} as well.
6325 Note: To set the behavior when you reply to the message written by yourself, use
6326 @code{wl-draft-reply-myself-without-argument-list} and
6327 @code{wl-draft-reply-myself-with-argument-list}
6330 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6331 @subsection Appearance of Threads
6335 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6336 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6337 391 09/18(Fri)19:24 +-[ Murata-san ]
6338 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6339 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6340 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6341 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6342 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6343 412 09/22(Tue)09:28 | +-[ Teranishi ]
6344 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6345 416 09/22(Tue)12:38 | +-[ Teranishi ]
6346 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6347 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6351 Settings to make appearance of threads like shown above:
6355 (setq wl-thread-indent-level 2)
6356 (setq wl-thread-have-younger-brother-str "+")
6357 (setq wl-thread-youngest-child-str "+")
6358 (setq wl-thread-vertical-str "|")
6359 (setq wl-thread-horizontal-str "-")
6360 (setq wl-thread-space-str " ")
6364 If you do not want to see branches, do the following:
6368 (setq wl-thread-indent-level 2)
6369 (setq wl-thread-have-younger-brother-str " ")
6370 (setq wl-thread-youngest-child-str " ")
6371 (setq wl-thread-vertical-str " ")
6372 (setq wl-thread-horizontal-str " ")
6373 (setq wl-thread-space-str " ")
6378 @node User-Agent Field, , Thread Format, Advanced Settings
6379 @subsection User-Agent Field
6383 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6384 @samp{User-Agent:} fields, define a function that generate appropriate
6385 strings as you like, and set it to variable
6386 @code{wl-generate-mailer-string-func}.
6388 If you do not want verbose @samp{User-Agent:} field, do the following:
6392 (setq wl-generate-mailer-string-func
6395 (concat "User-Agent: "
6396 (wl-generate-user-agent-string-1 nil)))))
6400 The following is a example:
6404 (setq mime-edit-insert-user-agent-field nil)
6405 (setq wl-generate-mailer-string-func
6408 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6413 @node Customizable Variables, Hooks, Advanced Settings, Customization
6414 @section Customizable Variables
6416 Customizable variables that have not been described yet:
6419 @item wl-default-folder
6420 @vindex wl-default-folder
6421 The initial setting is @samp{%inbox}. This is the default value for moving to
6422 a folder and the like.
6424 @item wl-draft-folder
6425 @vindex wl-draft-folder
6426 The initial setting is @samp{+draft}. It is the folder to which drafts are
6427 saved. It must be a localdir folder.
6429 @item wl-trash-folder
6430 @vindex wl-trash-folder
6431 The initial setting is @samp{+trash}. It is the wastebasket folder.
6432 If you changed this variable, you had better restart Wanderlust.
6434 @item wl-interactive-exit
6435 @vindex wl-interactive-exit
6436 The initial setting is @code{t}.
6437 If non-nil, you are asked for confirmation when Wanderlust terminates.
6439 @item wl-interactive-send
6440 @vindex wl-interactive-send
6441 The initial setting is @code{nil}.
6442 If non-nil, you are asked for confirmation when mail is sent.
6444 @item wl-folder-sync-range-alist
6445 @vindex wl-folder-sync-range-alist
6446 The initial setting is the alist shown below:
6451 ("^\\+draft$\\|^\\+queue$" . "all"))
6456 This is an associative list of regular expressions of folder names and
6457 update range of the summary. Update range is one of the @samp{all},
6458 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6459 @samp{last}. If a folder do not match, @samp{update} is used.
6462 @vindex wl-ask-range
6463 The initial setting is @code{t}.
6464 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6465 for updating the summary when you changed folders.
6467 @item wl-mime-charset
6468 @vindex wl-mime-charset
6469 The initial setting is @code{x-ctext}.
6470 This is the MIME charset for messages that are not MIME (e.g. without
6471 @samp{Content-Type:}). This value also used as default charset for
6472 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6473 this value as @code{iso-2022-jp}.)
6475 @item wl-highlight-folder-with-icon
6476 @vindex wl-highlight-folder-with-icon
6477 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6478 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6480 @item wl-strict-diff-folders
6481 @vindex wl-strict-diff-folders
6482 This is a list of regular expressions of folders.
6483 Unread messages are checked, for example when you press @kbd{s} in
6484 the folder mode, usually in a brief way (rapidly processed but not
6486 The folders matching this variable are seriously checked.
6487 You may want to set this variable so as to match conditional filter
6488 folders for IMAP4 folders.
6489 The initial setting is @code{nil}.
6491 @item wl-folder-use-server-diff
6492 @vindex wl-folder-use-server-diff
6493 When unread messages are checked, for example when you press @kbd{s} in
6494 the folder mode, usually (the number of messages on the server) @minus{}
6495 (the number of local messages) will be the number of unread messages.
6496 However, if this variable is non-nil, the number of unread messages on
6497 the server is checked. This affects IMAP4 folders only, but IMAP4
6498 folders in mail boxes matching
6499 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6500 the number of unread messages on the server, even if they matches this
6501 variable. The initial setting is @code{t}.
6503 @item wl-auto-check-folder-name
6504 @vindex wl-auto-check-folder-name
6505 The initial setting is @code{nil}.
6506 If non-nil, the folder with the name of the value is checked for unread
6507 messages at the start.
6508 If it is @code{none}, no folders are checked.
6509 If it is a list, all folders in the list are checked at the start.
6511 @item wl-auto-uncheck-folder-list
6512 @vindex wl-auto-uncheck-folder-list
6513 The initial setting is the list shown below:
6522 Folders with the name matching this variable are not checked for unread
6523 messages at the start, even if they are included in the groups in
6524 @code{wl-auto-check-folder-name}.
6526 @item wl-auto-check-folder-list
6527 @vindex wl-auto-check-folder-list
6528 The initial setting is @code{nil}.
6529 Folders with the name matching this variable are always checked for
6530 unread messages at the start, if they are included in the groups in
6531 @code{wl-auto-check-folder-name}.
6532 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6534 @item wl-no-save-folder-list
6535 @vindex wl-no-save-folder-list
6536 The initial setting is the list shown below:
6545 This is a list of regular expressions of folders not to be saved.
6547 @item wl-save-folder-list
6548 @vindex wl-save-folder-list
6549 The initial setting is @code{nil}.
6550 This is a list of regular expressions of folders to be saved.
6551 This takes precedence over @code{wl-no-save-folder-list}.
6553 @item wl-folder-mime-charset-alist
6554 @vindex wl-folder-mime-charset-alist
6555 The initial setting is the alist shown below:
6559 (("^-alt\\.chinese" . big5)
6560 ("^-relcom\\." . koi8-r)
6562 ("^-han\\." . euc-kr))
6567 This is an associative list of regular expressions of folder names and
6569 If a folder do not match, @code{wl-mime-charset} is used.
6571 @item wl-folder-init-load-access-folders
6572 @vindex wl-folder-init-load-access-folders
6573 The initial setting is @code{nil}.
6574 This is a list of access groups to be loaded specifically at the start.
6575 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6577 @item wl-folder-init-no-load-access-folders
6578 @vindex wl-folder-init-no-load-access-folders
6579 The initial setting is @code{nil}.
6580 This is a list of access groups not to be loaded specifically at the
6582 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6584 @item wl-delete-folder-alist
6585 @vindex wl-delete-folder-alist
6586 The initial setting is the alist shown below:
6595 This list determines disposition of messages with delete marks.
6596 Each item in the list is a folder and destination; you can specify any
6597 one of the following in the place of destination:
6600 @code{remove} or @code{null} : deletes the messages instantly.
6601 string : moves the messages to the specific folder.
6602 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
6605 @item wl-refile-policy-alist
6606 @vindex wl-refile-policy-alist
6607 The initial setting is the list shown below:
6617 This list determines whether messages with re-file marks are moved or
6618 copied. Each item in the list is a cons cell of a folder and
6619 @code{copy} or @code{move}.
6621 @item wl-x-face-file
6622 @vindex wl-x-face-file
6623 The initial setting is @file{~/.xface}.
6624 The name of the file that contains encoded X-Face strings.
6627 @item wl-demo-display-logo
6628 @vindex wl-demo-display-logo
6629 If non-nil, bitmap image is shown on the opening demo. If you set
6630 @code{xpm} or @code{xbm}, (if possible) display selected image type
6633 @item elmo-use-database
6634 @vindex elmo-use-database
6635 This is meaningful for XEmacs only. The initial setting depends on
6636 XEmacs (@code{t} for XEmacs with dbm).
6637 If non-nil, Message-ID is controlled by dbm.
6639 @item elmo-passwd-alist-file-name
6640 @vindex elmo-passwd-alist-file-name
6641 The initial setting is @file{passwd}.
6642 This is the name of the file in which passwords are saved.
6643 @code{elmo-passwd-alist-save} saves current passwords to the file.
6645 @item elmo-nntp-list-folders-use-cache
6646 @vindex elmo-nntp-list-folders-use-cache
6647 The initial setting is 600 (in seconds).
6648 This is period in seconds during which results of @samp{list} and
6649 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6652 @item elmo-nntp-max-number-precedes-list-active
6653 @vindex elmo-nntp-max-number-precedes-list-active
6654 The initial setting is @code{nil}.
6655 If non-nil, the number of article obtained by @samp{list active} in NNTP
6656 are used as the maximum article number of the folder.
6657 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6658 and if the number of read messages is not correct.
6660 @item elmo-nntp-default-use-listgroup
6661 @vindex elmo-nntp-default-use-listgroup
6662 The initial setting is @code{t}.
6663 If non-nil, @samp{listgroup} is used for checking the total number of
6664 articles. If it is @code{nil}, @samp{group} is used. In the latter
6665 case, the processing will be a little faster at the sacrifice of
6668 @item elmo-pop3-send-command-synchronously
6669 @vindex elmo-pop3-send-command-synchronously
6670 The initial setting is @code{nil}.
6671 If non-nil, POP3 commands are issued synchronously. Some implementation
6672 of POP3 server fails to get summary information without this setting.
6673 You may have to set this variable to @code{t}, if the process hangs
6674 while looking up POP3.
6676 @item elmo-dop-flush-confirm
6677 @vindex elmo-dop-flush-confirm
6678 The initial setting is @code{t}.
6679 If non-nil, you are asked for confirmation if accumulated off-line
6680 operations are executed.
6682 @item elmo-display-progress-threshold
6683 @vindex elmo-display-progress-threshold
6684 The initial setting is 20.
6685 Threshold for display of progress gauge. If number of renewal is more than
6686 this value, display progress gauge.
6690 @node Hooks, , Customizable Variables, Customization
6696 @node Mailing List, Addition, Customization, Top
6697 @chapter Wanderlust Mailing List
6702 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6705 Topics related to Wanderlust are discussed in the mailing list.
6706 The latest version is also announced there (in Japanese, sorry).
6708 A guide can be obtained automatically by sending mail to
6709 @t{wl-ctl@@lists.airs.net} with the body
6714 Please send bug reports or patches to the mailing list. You can post to
6715 the mailing list even though you are not a member of it.
6717 If you send a bug report, please attach Backtrace with it.
6718 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
6721 I would like to express my thanks to the members of the mailing list for
6722 valuable advice and many pieces of code they contributed.
6725 @node Addition, Index, Mailing List, Top
6726 @chapter Additional Information
6728 @section Brief History
6731 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6732 3/10 Made a msgdb mechanism by elisp.
6733 3/26 IMAP and NNTP can be displayed in threads.
6734 4/13 Began to assemble thread display modules as elmo.
6735 5/01 Finished 0.1.0, initial version with many defects.
6736 6/12 I made a slip of the tongue and said I was writing elisp
6737 mailer supporting IMAP
6738 6/16 0.1.3 was announced at tm-ja, elisp ML.
6739 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6740 7/01 Support for mm-backend (0.3.0).
6741 8/25 multi folder added (0.5.0).
6742 8/28 filter folder added (0.5.1).
6743 9/10 You can open/close threads (0.6.0).
6744 9/11 fldmgr by Murata-san made editing folders easy.
6745 9/18 lha folders added by Okunishi-san (0.6.3).
6746 9/24 Display of branches of threads (0.6.5).
6747 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6748 10/28 Off-line operations (0.7.4).
6749 12/09 Becomes beta version.
6750 12/21 wl-expire by Murata-san.
6751 1999 2/03 auto-refile by Tsumura-san.
6752 4/28 wl-template by Murata-san.
6753 5/18 Released 1.0.0 stable.
6754 7/05 Scoring by Murata-san (2.1.0).
6755 9/26 New plugged system by Murata-san (2.2.2).
6756 12/20 Support Modified UTF7.
6757 2000 3/24 Released 1.1.0 stable.
6758 4/03 CVS development started.
6759 5/07 Thread restoration & Its speed up with Murata-san.
6760 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6761 7/11 killed message feature.
6762 7/18 Use UIDL in POP3.
6763 9/12 biff feature with Satata-san & Yamaoka-san.
6764 10/17 expire-hide by Okada-san.
6765 11/08 Released 2.4.0 stable.
6768 See @file{ChangeLog} for details.
6772 According to a dictionary, Wanderlust has the meaning:
6776 n eager longing for or impulse towards travelling in distant lands
6777 [Ger, fr wandern to wander + lust desire, pleasure]
6781 but I had no profound intention. (if farfetched, IMAP @result{} you can
6782 read mail anywhere @result{} desire to wander ?)
6784 Elmo is the abbreviation of @samp{Elisp Library for Message
6785 Orchestration}. At first I meant the red puppet in the Sesame Street,
6786 but you may associate it with Wandering @result{} Drifting @result{}
6787 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6791 Each versions has code names (they are almost jokes).
6792 Currently they are picked up alphabetically from the top 40 hits of
6793 U.S. Billboard magazines in 1980s.
6795 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
6798 @node Index, , Addition, Top
6802 * Concept Index:: Concept Index
6803 * Key Index:: Key Index
6804 * Variable Index:: Variable Index
6805 * Function Index:: Function Index
6808 @node Concept Index, Key Index, Index, Index
6809 @unnumberedsec Concept Index
6812 @node Key Index, Variable Index, Concept Index, Index
6813 @unnumberedsec Key Index
6816 @node Variable Index, Function Index, Key Index, Index
6817 @unnumberedsec Variable Index
6820 @node Function Index, , Variable Index, Index
6821 @unnumberedsec Function Index