1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
26 This edition is for Wanderlust version @value{VERSION}.
28 Permission is granted to make and distribute verbatim copies of this
29 manual provided the copyright notice and this permission notice are
30 preserved on all copies.
33 Permission is granted to process this file through TeX and print the
34 results, provided the printed document carries copying permission notice
35 identical to this one except for the removal of this paragraph (this
36 paragraph not being relevant to the printed manual).
39 Permission is granted to copy and distribute modified versions of this
40 manual under the conditions for verbatim copying, provided that the
41 entire resulting derived work is distributed under the terms of a
42 permission notice identical to this one.
44 Permission is granted to copy and distribute translations of this manual
45 into another language, under the above conditions for modified versions.
51 @title Wanderlust User's Manual
52 @subtitle Yet another message interface on Emacsen
53 @subtitle for Wanderlust version @value{VERSION}
54 @author Yuuichi Teranishi
55 @author Fujikazu Okunishi
56 @author Masahiro Murata
58 @author Kaoru Takahashi
60 @author Masayuki Osada
63 @vskip 0pt plus 1filll
64 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
65 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
66 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
68 This manual is for Wanderlust version @value{VERSION}.
70 Permission is granted to make and distribute verbatim copies of this
71 manual provided the copyright notice and this permission notice are
72 preserved on all copies.
74 Permission is granted to copy and distribute modified versions of this
75 manual under the conditions for verbatim copying, provided that the
76 entire resulting derived work is distributed under the terms of a
77 permission notice identical to this one.
79 Permission is granted to copy and distribute translations of this manual
80 into another language, under the above conditions for modified versions.
86 @node Top, Introduction, (dir), (dir)
87 @top Wanderlust User's Manual
99 This manual is for Wanderlust @value{VERSION}.
104 * Introduction:: Read this first.
105 * Start Me Up:: Invoking Wanderlust.
106 * Folders:: How to specify folders.
107 * Folder:: Selecting and editing folders.
108 * Summary:: Reading and refiling messages.
109 * Message:: Saving and playing MIME multipart entities.
110 * Draft:: Draft buffer, sending mail and news.
111 * Disconnected Operations:: Off-Line management
112 * Expire and Archive:: Automatic expiration and archiving of messages.
113 * Scoring:: Score of the messages.
114 * Customization:: Customizing Wanderlust.
115 * Mailing List:: Wanderlust mailing list
116 * Addition:: Additional Information
121 @node Introduction, Start Me Up, Top, Top
122 @chapter Introduction of Wanderlust
125 Wanderlust is an mail/news management system on Emacsen.
126 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
128 The main features of Wanderlust:
131 @item Pure elisp implementation.
132 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
133 @item Unified access method to messages based on Mew-like Folder Specification.
134 @item Mew-like Key-bind and mark handling.
135 @item Manages unread messages.
136 @item Interactive thread display.
137 @item Folder Mode shows the list of subscribed folders.
138 @item Message Cache, Disconnected Operation (Read Only).
139 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
140 @item MIME compliant (by SEMI or tm).
141 @item Transmission of news and mail are unified by Message transmitting draft.
142 @item Graphical list of folders (XEmacs and Emacs 21).
143 @item View a part of message without retrieving the whole message (IMAP4).
144 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
145 @item Virtual Folders.
146 @item Supports compressed folder using common archiving utilities.
147 @item Old articles in folders are automatically removed/archived (Expiration).
148 @item Automatic re-file.
149 @item Template function makes it convenient to send fixed form messages.
155 Wanderlust is supposed to run on following Emacsen:
156 @c Wanderlust runs even on Nemacs 3.3.2 based on Emacs 18.55, 18.59 (with
157 @c limited functionality).
160 @item Nemacs 3.3.2 (Caution: limited functionality)
161 @item Mule 2.3 based on Emacs 19.28
162 @item Mule 2.3 based on Emacs 19.34
163 @item Emacs 20.2 or later
164 @item XEmacs 20.4 or later
165 @item Meadow 1.00 or later
166 @item Mule for Windows v1.22
167 @item NTEmacs 20.4 or later
171 IMAP4 connectivity with following imapd are confirmed to work with
175 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
176 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
177 @item Courier-IMAP 1.3.2 or later
178 @item AIR MAIL (AIRC imapd release 2.00)
180 @item Microsoft Exchange Server 5.5
181 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
184 LDAP connectivity with following LDAPd are confirmed to work with
188 @item OpenLDAP 2.0.6 or later
192 @node Start Me Up, Folders, Introduction, Top
193 @chapter Start up Wanderlust
196 The necessary procedure for starting Wanderlust is explained in steps
199 (Of course, you need a mail/news readable environment in advance)
202 * MIME Modules:: Installing the MIME modules.
203 * Download:: Download and extract the packages.
204 * Install:: Byte-compile and install.
205 * Minimal Settings:: @file{.emacs} setup.
206 * Mail Addresses:: Address book definition.
207 * Folder Definition:: Folder definition.
208 * Start Wanderlust:: Starting Wanderlust
212 @node MIME Modules, Download, Start Me Up, Start Me Up
213 @section Installing MIME modules
221 SEMI or tm must be installed to make Wanderlust work correctly. Refer
222 to the @file{INSTALL} for detailed installation procedure.
224 You have to re-install Wanderlust if you upgraded APEL, FLIM, SEMI or
228 @node Download, Install, MIME Modules, Start Me Up
229 @section Download and Extract the Package
232 You can download Wanderlust package from following sites:
236 ftp://ftp.gohome.org/wl/
239 Mirrored ftp/http sites:
243 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
244 http://www.jpl.org/elips/wl/
245 http://www.ring.gr.jp/archives/text/elisp/wl/
246 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
247 ftp://opaopa.org/pub/mirror/elisp/wl/
248 @c ftp://roguelife.org/pub/tsumura/wl/
252 Extract the obtained package to your working directory:
257 % tar zxvf wl-@var{version}.tar.gz
258 % cd wl-@var{version}
262 @subsection To use SSL (Secure Socket Layer)
267 SSL (Secure Socket Layer) can be used for SMTP, IMAP, NNTP and POP
268 connections in Wanderlust.
270 There are two ways to use SSL. One is to start SSL negotiation just
271 after the connection establishment (generic way). The other one is to
272 start SSL negotiation by invoking STARTTLS command in the each session.
274 To use the formal SSL (generic SSL), you must install @file{ssl.el} in
275 the @file{utils} directory. OpenSSL command @command{openssl} is also
276 required to use @file{ssl.el}. You must set @env{PATH} to the directory
277 that OpenSSL commands are installed.
279 To use the latter SSL(STARTTLS), you must install starttls package in
281 You can download starttls package from the following site.
284 ftp://opaopa.org/pub/elisp/
287 @node Install, Minimal Settings, Download, Start Me Up
288 @section Byte-compile and install
295 @subsection Installation
297 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
298 Set the Emacs's command name to @code{EMACS}.
299 Set package installation directory to @code{LISPDIR}.
300 Then, please execute following commands.
309 Destination directory is auto-probed if you leave @code{LISPDIR}
310 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
312 If you are using an Emacs variant which does not merge specified
313 directory to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28), then
314 you will see the error message:
317 Cannot open load file: mime-setup
321 In this case, either add destination directories of custom, APEL, FLIM
322 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
323 @code{load-path} in @file{WL-CFG} in extracted directory.
325 If you want to use BBDB, then the necessary modules are byte-compiled
326 and installed when BBDB directory is added to @code{load-path}.
329 @subsection @file{WL-CFG}
331 Contents of the file @file{WL-CFG} is loaded under installation if a file
332 with that name exists in extracted directory. You can use @file{WL-CFG} to
333 configure @code{load-path} to extra packages such as SEMI if needed.
335 If you want to specify the install directory of Wanderlust related
336 files, then set following variables in @file{WL-CFG}
340 A directory to install WL modules.
341 This directory is relative directory from @code{LISPDIR}.
342 WL modules include @file{wl*.el}, @file{wl*.elc} files.
343 @c Modules under the directory @file{util/} are also installed if
344 @c it detected as necessary.
347 A directory to install ELMO modules.
348 This directory is relative directory from @code{LISPDIR}.
349 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
350 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
354 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
356 If you want to install ELMO related files under a sub-directory
357 such as "elmo" then add following to @file{WL-CFG}:
360 (setq ELMO_PREFIX "elmo")
363 @subsection Install as a XEmacs package
364 @cindex XEmacs package
365 @cindex XEmacs package install
366 @cindex Package, XEmacs
367 @cindex Package install, XEmacs
368 @c @cindex install-package
370 It is possible to install Wanderlust as one of packages of XEmacs (21.0
371 or later). Configuration for autoload and icon-path in local
372 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
375 Follow the next example to install Wanderlust as an XEmacs package.
381 % make install-package
385 package directory is auto-probed, if SEMI is installed.
386 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
388 @subsection Run in place
390 If wl and elmo directories are defined in @code{load-path}, then
391 byte-compilation and installation are not necessary to start Wanderlust.
392 For example, if package is extracted in @file{~/work}, Wanderlust can be
393 invoked with following setting in @file{~/.emacs}.
397 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
398 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
404 Manual is described in Info format. Please do following.
413 If you install Wanderlust as a XEmacs package, Info file is already
414 installed too, so there are no need of these commands.
416 Manual directory is automatically detected. Of course, it can be
417 configured by @code{INFODIR} in @file{Makefile}.
419 You can read manual at the following URL:
422 http://www.gohome.org/wl/doc/wl-euc_toc.html
425 @node Minimal Settings, Mail Addresses, Install, Start Me Up
426 @section Set up .emacs
427 @cindex Minimal Settings
429 @cindex Configuration
433 The Wanderlust package contains two module groups.
436 @item ELMO (elmo-*.el)
437 These modules show everything as folders. This is the back-end for WL.
439 These modules controls the behavior of main body of Wanderlust.
440 They are also the front-end for ELMO.
443 You can customize the behavior of Wanderlust by changing the value
444 of environmental variables which begins with @code{elmo-} and @code{wl-}.
446 The minimal requirement for settings is as the following.
450 ;; @r{The setting to use SEMI/tm}
453 ;; @r{autoload configuration}
454 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
455 (autoload 'wl "wl" "Wanderlust" t)
456 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
458 ;; @r{Directory where icons are placed (XEmacs or Emacs 21).}
459 ;; @r{Default: @code{nil}.}
460 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
461 (setq wl-icon-dir "~/work/wl/etc")
463 ;; @r{SMTP server for mail posting. Default: @code{nil}}
464 (setq wl-smtp-posting-server "your.smtp.example.com")
465 ;; @r{NNTP server for news posting. Default: @code{nil}}
466 (setq wl-nntp-posting-server "your.nntp.example.com")
470 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
471 file exists). So it is convenient to gather Wanderlust specific settings
472 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
473 because you can't write them in @file{.emacs}
474 (if you write it to @file{.emacs}, you'll get an error).
477 All above described settings except (load "mime-setup") and autoload
478 configuration can be written in
481 @subsection @code{mail-user-agent}
482 @cindex Default Mailer
483 @cindex Mailer, Default
484 @vindex mail-user-agent
487 If you write following setting in you @file{.emacs}, you can
488 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
489 This means it enables you to run Wanderlust as a default mail composer
492 It is effective only when your Emacs can define @code{mail-user-agent}.
493 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
497 (autoload 'wl-user-agent-compose "wl-draft" nil t)
498 (if (boundp 'mail-user-agent)
499 (setq mail-user-agent 'wl-user-agent))
500 (if (fboundp 'define-mail-user-agent)
501 (define-mail-user-agent
503 'wl-user-agent-compose
511 @node Mail Addresses, Folder Definition, Minimal Settings, Start Me Up
512 @section Address book
513 @cindex Address book Definition
515 @cindex Alias, Address
517 The file @file{~/.addresses} is a simple address book for Wanderlust.
518 Make address file @file{~/.addresses}, and edit to suit your requirement.
520 The data written in @file{~/.addresses} are used for address completion
521 under draft editing mode. Furthermore, they are used when showing names
522 in summary display mode. You can safely skip this section, if you don't
523 want to customize address completion and summary display.
524 It is possible to add/change/remove addresses from @file{~/.addresses} in
525 summary buffer after Wanderlust is invoked. @refill
527 The format is very simple. Like this. @refill
532 # @r{Lines begin with @samp{#} are comment.}
533 # @r{Empty lines are ignored}
535 # @r{Format of each line:}
536 # @var{email-address} "@var{nickname} "@var{realname}"
538 teranisi@@gohome.org "YT" "Yuuichi Teranishi"
539 foo@@example.com "Mr. Foo" "John Foo"
540 bar@@example.org "Mr. Bar" "Michael Bar"
545 One line defines one persons description.
547 Actually, in default setup, @var{nickname} is used in summary-mode and
548 @var{realname} is used in draft preparation mode. This behavior is
549 better understood if you try it and confirmed the function first. You
550 can write and try a small definition, so you will know the idea of the
551 address book before writing a big one.
553 And, if MH alias file is specified in variable @code{wl-alias-file},
554 it is used as an address information in the draft preparation mode.
556 If variable @code{wl-use-ldap} is non-nil (initial setting is
557 @code{nil}), address completion in draft mode uses LDAP information.
559 If you use LDAP, you have to set @code{wl-ldap-server},
560 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
561 not have LDAP feature as built-in feature (Currently only XEmacs can
562 have built-in LDAP feature), you have to set command exec @env{PATH} to
563 the program @command{ldapsearch}.
565 @node Folder Definition, Start Wanderlust, Mail Addresses, Start Me Up
566 @section Folder Definition
567 @cindex Folder Definition
570 You can skip this section because it is possible to add/edit the
571 subscribe folders from the buffer for list of folders.
572 @xref{Folder Manager}.
574 Define the folders you want to subscribe in file @file{~/.folders}. The
575 contents written in @file{~/.folders} become the folders which you
576 subscribe to as it is.
578 Format for @file{~/.folders} is very simple. Here is an example:
583 # @r{Lines begin with @samp{#} are comment.}
584 # @r{Empty lines are ignored}
586 # @var{folder name} "@var{folder nickname}"
587 # @r{(nicknames are not necessary)}
592 %#mh/Backup@@my.imap.example.com "Sent"
595 %#mh/spool/wl "Wanderlust ML"
596 %#mh/spool/elips "ELIPS ML"
597 %#mh/spool/apel-ja "APEL Japanese ML"
598 %#mh/spool/xemacs-beta "XEmacs beta"
599 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
600 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
603 # @r{If folder name ends with @samp{/}, that means an `access group',}
604 # @r{all subfolders automatically included in one folder group.}
606 %#mh/expire@@localhost /
607 # @r{All MH folders are included in one folder group.}
612 Each line contains one folder you want to read. The definition of
613 folders will be explained in detail in the next section.
615 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
616 become one folder group. One folder group is treated as a directory
617 which can be opened and closed in folder mode. It is convenient for
618 collecting some folders and putting them in order.
620 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
621 line and you have to write it that way (It is because the parser sucks).
623 There are two types of groups. One is like @samp{Emacsen} from above
624 example which the user chooses his favorite folders as a group.
626 The other one is @dfn{access group} like @samp{+} from above example.
627 It makes all the sub-folders in a folder to a group. (It differs from
628 the type of the folder. For example, @samp{+} makes entire MH
629 sub-directories to one group)
631 This behavior is better understood if you try it and confirmed the
632 function first. You can write and try a small folder definition, so you
633 will know the idea of the folder function before writing the real one.
635 @node Start Wanderlust, , Folder Definition, Start Me Up
636 @section Start Wanderlust
637 @cindex Start Wanderlust
639 If installation and configuration worked well, you can invoke Wanderlust by
640 typing following command in Emacs.
647 After initialization, Folder Mode which shows the list of folders will appear.
648 That means the folders you defined in the @file{~/.folders} are listed
649 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
650 can skip folder checking.
653 @node Folders, Folder, Start Me Up, Top
654 @chapter Wanderlust's folders
657 This chapter describes the folder types which Wanderlust is able to handle.
659 Wanderlust uses ELMO as it's interface, so every folder types supported
660 by ELMO is usable in Wanderlust.
662 As of version @value{VERSION}, 11 types of folders are predefined. These are
663 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
664 Pipe and Internal folder types.
667 * IMAP Folder:: @samp{%} -- IMAP folder
668 * NNTP Folder:: @samp{-} -- NNTP folder
669 * MH Folder:: @samp{+} -- MH folder
670 * Maildir Folder:: @samp{.} -- Maildir folder
671 * News Spool Folder:: @samp{=} -- News spool folder
672 * Archive Folder:: @samp{$} -- Archive folder
673 * POP Folder:: @samp{&} -- POP folder
674 * Multi Folder:: @samp{*} -- Multi folder
675 * Filter Folder:: @samp{/} -- Filter folder
676 * Pipe Folder:: @samp{|} -- Pipe folder
677 * Internal Folder:: @samp{'} -- Internal folder
681 @node IMAP Folder, NNTP Folder, Folders, Folders
688 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
694 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
698 You can specify @code{login} (encoded password transmission),
699 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
700 authentication) or @code{clear} (or @code{nil}, plain password
701 transmission) as @var{authenticate-type}. (To use CRAM-MD5 or
702 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})
707 @var{username} -> The value of @code{elmo-default-imap4-user}.
708 Initial setting is @env{USER} environment variable or
709 @env{LOGNAME} environment variable or return value of
710 @code{(user-login-name)}.
711 @var{authenticate-type} -> The value of @code{elmo-default-imap4-authenticate-type}.
712 Initial setting is "auth".
713 @var{hostname} -> The value of @code{elmo-default-imap4-server}.
714 Initial setting is "localhost".
715 @var{port} -> The value of @code{elmo-default-imap4-port}.
716 Initial setting is 143.
719 You can omit the @var{hostname} from folder names if you set
720 @code{elmo-default-imap4-server} as your main IMAP server.
721 For example, you can specify a folder as @samp{foo%imap@@gateway} even
722 if you have to go through a firewall.
725 ;; Example: imap4.exaple.org as main IMAP server
726 (setq elmo-default-imap4-server "imap4.example.org")
729 SSL (Secure Socket Layer) connection will be used if a folder name ends
730 with @samp{!}. Or, if the value of @code{elmo-default-imap4-stream-type}
731 is @code{ssl}, SSL will be the default connection. If a folder name
732 ends with @samp{!!}, STARTTLS connection will be established. If the
733 value of @code{elmo-default-imap4-stream-type} is @code{starttls},
734 STARTTLS will be the default connection.
737 ;; Example: Use SSL connection
738 (setq elmo-default-imap4-stream-type 'ssl)
741 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
742 authentication method, the password is sent in encoded form. But, if
743 your server is unable to receive an encoded password, authentication
744 will fall back to @code{clear} (that is, sending password in raw format)
745 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
746 authentication will fall back to @code{clear} without confirmation
747 (default value is @code{nil}).
750 ;; Example: password in raw format
751 (setq elmo-default-imap4-authenticate-type 'clear)
758 %inbox -> IMAP mailbox "inbox"
759 %#mh/inbox -> IMAP mailbox "#mh/inbox"
761 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
762 %inbox:hoge/clear@@server1
763 -> server1's IMAP mailbox "inbox"
764 of user "hoge", with plain password authentication
769 @subsection International mailbox names (Modified UTF7)
770 @cindex Modified UTF7
777 You can use international mailbox names in @var{mailbox} part, if you
778 are using Emacs which can treat unicode and
779 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
780 value is @code{nil}).
782 Currently, following Emacsen can treat unicode.
785 @item Emacs 20.3 or later + Mule-UCS
787 If you installed Mule-UCS package, Emacs can treat unicode.
788 You can obtain Mule-UCS package from following URL.
791 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
794 @item XEmacs 21.2.13 or later + ucs-conv package
796 By default, XEmacs 21 cannot treat unicodes, but if you installed
797 ucs-conv package, it can.
798 You can obtain ucs-conv package from following anonymous CVS.
802 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
803 Password: @var{NULL} (Just enter return key)
804 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
808 You also need utf7 conversion programs, @command{u7tou8} and
809 @command{u8tou7} to use international mailbox name in the current
810 XEmacs. These programs are included in the UTF7 package which can be
811 obtained from following URL.
814 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
818 @node NNTP Folder, MH Folder, IMAP Folder, Folders
823 A folder to access USENET news via NNTP protocol (RFC 977).
824 One newsgroup is treated as a folder.
830 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
836 @var{hostname} -> The value of @code{elmo-default-nntp-server}.
837 Initial setting is @samp{localhost}.
838 @var{username} -> The value of @code{elmo-default-nntp-user}.
839 Initial setting is @code{nil}.
840 @var{port} -> The value of @code{elmo-default-nntp-port}.
841 Initial setting is 119.
844 AUTHINFO is used as authentication method if the @var{username} is non-nil.
845 SSL will be default method if @code{elmo-default-nntp-stream-type} is non-nil even
846 if the folder name doesn't end with @samp{!}.
847 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
848 if the value of @code{elmo-default-nntp-stream-type} is @code{starttls},
849 STARTTLS will be the default connection.
855 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
856 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
860 @node MH Folder, Maildir Folder, NNTP Folder, Folders
866 A folder to access MH format mail (1 file is 1 mail).
871 @samp{+} @var{directory-name}
874 Normally, @var{directory-name} is an relative path to the variable
875 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
876 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
877 (this is also true for drive-letters).
879 Message number is used for the name of the message file.
885 +inbox -> @file{~/Mail/inbox}
886 +from/teranisi -> @file{~/Mail/from/teranisi}
887 +~/test -> @file{~/test}
891 @node Maildir Folder, News Spool Folder, MH Folder, Folders
892 @section Maildir Folder
893 @cindex Maildir Folder
897 A folder to access to Maildir format (1 file is 1 mail).
902 @samp{.} [@var{directory-name}]
905 Normally, @var{directory-name} is a relative path to the variable
906 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
907 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
908 (this is also true for drive-letters).
910 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
911 Messages are contained in the @file{cur} directory. All message files
912 in the @file{new} directory are moved to @file{cur} directory when you
913 access to the folder. All message files contained in the @file{tmp}
914 directory and not accessed for 36 hours are deleted.
916 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
922 . -> @file{~/Maildir}
923 .inbox -> @file{~/Maildir/inbox}
924 .from/teranisi -> @file{~/Maildir/from/teranisi}
925 .~/test -> @file{~/test}
930 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
931 @section News Spool Folder
932 @cindex News spool Folder
936 This folder handles locally saved news articles which are proposed by
937 Mew/IM. You can also read articles directly from a spool-file which is
938 retrieved by an utility like @command{gnspool}.
943 @samp{=} @var{directory-name}
946 @var{directory-name} is a sub-directory to the directory defined by
947 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
948 You can use @samp{.} as directory delimiter as well as @samp{/}.
954 =fj/os/os2 -> @file{~/News/fj/os/os2}
955 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
960 @node Archive Folder, POP Folder, News Spool Folder, Folders
961 @section Archive Folder
962 @cindex Archive Folder
966 This method can handle archive files, which are compressed by utilities
967 such as Info-ZIP or LHA, as one folder.
973 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
977 @var{path-name} is the relative path from
978 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
979 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
980 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
981 also permitted under the environment of ange-ftp, efs.
983 The actual file name of the archive folder is
984 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
985 under the @var{path-name}. If a file named @var{path-name} exists, it is
986 treated as folder. The suffix is automatically decided for
989 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
990 (Initial setting is @code{zip}) is referred.
992 @var{prefix} specifies the internal directory structure of the archive.
993 For example, if the ML server is fml, @file{msend.tar.gz} has a
994 structure like @file{spool/1}, so you have to specify @samp{spool} as
1001 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1002 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1003 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1004 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1009 * Archiver:: Archivers supported
1010 * Archive Tips:: TIPS
1011 * Archive Vars:: Customization
1015 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1016 @subsection Supported Archives
1026 By default, following archives are supported.
1030 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1031 GNU TAR('tgz, 'tar) ;; read-only
1035 If your archiver can include multiple files in one archive, you have a
1036 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1037 of the candidate. TAR is supported read-only because it cannot delete
1038 file in the archive (@code{mv})).
1040 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1041 archiver of Wanderlust because they cannot include multiple
1042 files. Archivers that cannot extract files to standard output are also
1045 @subsection OS specific information about archiver.
1047 Behaviors of the following archivers are confirmed by further experiences.
1048 (@samp{*} mark means recommended archiver).
1051 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1052 LHA OS/2 version Rel.2.06b Feb 18, 1998
1053 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1054 *Zip 2.2 (November 3rd 1997).
1055 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1056 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1057 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1059 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1060 LHa for UNIX V 1.14c
1061 UnZip 5.32 of 3 November 1997
1062 Zip 2.2 (November 3rd 1997)
1063 GNU tar 1.12 (1.11.x is no good)
1064 gzip 1.2.4 (18 Aug 93)
1066 [Win32] Win.98/Meadow
1070 GNU tar 1.11.8 + 1.5(WIN32)
1077 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1078 Hiramatsu version of LHA is only supported.
1079 In Win32, LHa32 is only supported (DOS version is no good).
1081 * Caution about GNU tar
1083 You have to take care about GNU tar's version because many version has
1084 problem on deleting file from archive.
1086 Please test @option{--delete} @option{-f} options work. Otherwise, your
1087 archive will be destroyed. No problem is reported on above versions of
1091 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1093 @cindex Archive Tips
1095 For comfortable migration, usage of @code{wl-summary-archive}
1096 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1097 archive folders created by expiration, you must set non-nil value to
1098 @code{elmo-archive-treat-file}.
1100 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1101 in processing speed. For comfortable use, Emacs20 is recommended.
1102 (If re-search's performance is the problem, 19.3x or later may be okay.)
1104 If many files are included in one archive,
1105 it takes long time to access to the archive folder because
1106 archiver starting overhead is increased (especially LHA).
1107 150-200 messages in one archive is recommended.
1109 Of course, following is possible @t{:-)}
1110 (meanings of these variables are described later.)
1114 (setq wl-fcc "$backup")
1115 (setq wl-trash-folder "$trash;lha")
1119 @node Archive Vars, , Archive Tips, Archive Folder
1120 @subsection Variables About Archive Folder
1121 @cindex Archive variables
1124 @item elmo-archive-default-type
1125 @vindex elmo-archive-default-type
1126 The initial setting is @code{zip}.
1127 Set archiver type by symbol.
1129 @item elmo-archive-@var{type}-method-alist
1130 @vindex elmo-archive-TYPE-method-alist
1131 Define archiver @var{type}'s methods.
1132 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1133 Each element of the alist is following.
1137 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1138 (@var{action} . @var{function}) ;; function
1142 Currently available actions are following.
1146 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1147 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1154 actions enclosed with braces are optional (They are used for better
1157 @item elmo-archive-suffix-alist
1158 @vindex elmo-archive-suffix-alist
1159 An alist of archiver-type (symbol) and suffix.
1161 @item elmo-archive-file-regexp-alist
1162 @vindex elmo-archive-file-regexp-alist
1163 An alist of a regexp to get file number from list output of archiver
1164 and archiver-type (symbol).
1166 @item elmo-archive-method-list
1167 @vindex elmo-archive-method-list
1168 A list of elmo-archive-@var{type}-method-alist
1169 (@var{type} is a symbol of archiver-type).
1171 @item elmo-archive-lha-dos-compatible
1172 @vindex elmo-archive-lha-dos-compatible
1173 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1174 DOS (Mr. Yoshizaki original) compatible.
1176 @item elmo-archive-cmdstr-max-length
1177 @vindex elmo-archive-cmdstr-max-length
1178 The initial setting is 8000.
1180 Max length of command line argument for external archiver program.
1181 Emacs does not have a limit of command line byte length, but some OS
1182 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1183 this limit because it calls external archiver program directly (not
1184 called via shell). For example, you cannot delete messages if archiver
1185 program must receive larger bytes of arguments to delete. OS/2 have a
1186 command line argument limit of 8190 bytes, so we defined default as 8000
1189 However, you don't have an influence of command line argument limit
1190 if the archiver has `actions' to receive target file information from
1191 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1194 @node POP Folder, Multi Folder, Archive Folder, Folders
1202 A folder to access e-mails via POP3 protocol (RFC 1939).
1208 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1213 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1214 as @var{authenticate-type}.
1218 @var{username} -> The value of @code{elmo-default-pop3-user}.
1219 Initial setting is @env{USER} environment variable or
1220 @env{LOGNAME} environment variable or return value of
1221 @code{(user-login-name)}.
1222 @var{authenticate-type} -> The value of @code{elmo-default-pop3-authenticate-type}.
1223 Initial setting is @samp{user}.
1224 @var{hostname} -> The value of @code{elmo-default-pop3-server}.
1225 Initial setting is @samp{localhost}.
1226 @var{port} -> The value of @code{elmo-default-pop3-port}.
1227 Initial setting is 110.
1234 &hoge@@localhost -> access to localhost as user @samp{hoge}.
1235 &hoge@@popserver:109 -> access to the server "popserver" on port 109
1236 as user @samp{hoge}.
1240 To use APOP as an @var{authenticate-type}, @file{md5.el} is needed
1241 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1242 @file{utils/sasl/lisp/} or Emacs/W3 package
1243 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1246 If the last character of the folder name is @samp{!}, Wanderlust
1247 connects to the POP server via SSL (Secure Socket Layer). If you set
1248 non-nil value to @code{elmo-default-pop3-stream-type}, you don't have to put
1249 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1250 with @samp{!!}, STARTTLS connection will be established. if the value
1251 of @code{elmo-default-pop3-stream-type} is @code{starttls}, STARTTLS will be the
1254 @node Multi Folder, Filter Folder, POP Folder, Folders
1255 @section Multi Folder
1256 @cindex Multi Folder
1258 @cindex Folder, Multiple
1259 @cindex Folder, Marge
1261 A folder to access to a folder which collects messages from
1262 multiple folders virtually.
1268 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1272 After @samp{*} character, specify multiple folders you want to collect
1273 separated by @samp{,} like
1274 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1280 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1281 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1282 treated as one folder.
1284 *+inbox,-fj.rec.tv,%inbox
1285 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1290 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1291 @section Filter Folder
1292 @cindex Filter Folder
1294 @cindex Folder, Filtering
1295 @cindex Folder, Virtual
1297 A folder to access to a folder which collects all messages that
1298 satisfy a condition virtually.
1303 @samp{/} @var{condition} @samp{/} @var{target-folder}
1306 In the @var{condition} part, you can specify following.
1310 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1312 first: @var{number} messages are picked from top of folder.
1313 last: @var{number} messages are picked from bottom of folder.
1319 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1320 /first:20/%inbox -> First 20 messages from %inbox are picked.
1325 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1327 since: only messages arrived since @var{date} are picked.
1328 before: only messages arrived before @var{date} are picked.
1330 You can specify following as @var{date}.
1334 yesterday -> a day before today.
1335 lastweek -> same day of last week.
1336 lastmonth -> same day of last month.
1337 lastyear -> same day of last year.
1338 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1339 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1347 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1349 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1355 Field filter: @samp{@var{field}:@var{value}}
1357 All messages that have @var{field} and its value is @var{value} are picked.
1358 @var{field} and @var{value} are case insensitive.
1364 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1365 and its value includes "teranisi" string are picked.
1366 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1374 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1375 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1377 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1378 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1384 /from:teranisi&!to:teranisi/+inbox
1385 -> In +inbox, messages are picked if the message's
1386 From: field includes "teranisi" and
1387 To: field doesn't include "teranisi".
1389 /tocc:"Yuuichi Teranishi"/+inbox
1390 -> In +inbox, messages are picked if the
1391 message's To: field or Cc: field includes
1392 "Yuuichi Teranishi".
1394 /(from:yt|from:teranisi)&subject:report/+inbox
1395 -> In +inbox, messages are picked if the message's
1396 From: field includes "yt" or "teranisi", and
1397 Subject includes "report".
1403 Tip for string description:
1405 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1406 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1407 should be escaped with @samp{\} in it). You can enclose the string with
1408 @samp{"} even it does not contain these characters.
1414 *%inbox,/from:teranisi/%inbox@@server
1415 -> Messages in %inbox or
1416 message is in the %inbox@@server folder and it's From field
1417 includes "teranisi" are collected.
1419 /last:100//to:teranisi/*+inbox,%inbox
1420 -> Latest 100 messages which is in the +inbox or %inbox folder
1421 and To: field matches "teranisi".
1423 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1424 -> Pick messages which have From: field and it includes "hogehoge"
1425 from latest 20 messages in the %#mh/inbox@@localhost
1426 and To: or Cc: field includes "teranisi".
1429 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1430 @section Pipe Folder
1434 @cindex Download Message
1435 @cindex Incorporate Message
1437 In the pipe folder, messages are automatically transferred from the source
1438 folder to destination folder.
1443 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1446 When you access to the pipe folder, messages are automatically transferred
1447 from @var{source-folder} to @var{destination-folder}.
1448 It is convenient if you want to download messages to local disk via POP.
1449 For example, if you specify following
1452 |&username@@popserver|+inbox
1456 and access to it, messages are downloaded automatically from
1457 @samp{&username@@popserver} to @samp{+inbox}.
1463 %inbox|%myinbox -> Download %inbox to %myinbox.
1464 *&user@@popserver1,&user@@popserver2|+inbox
1465 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1469 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1471 @node Internal Folder, , Pipe Folder, Folders
1472 @section Internal folder
1473 @cindex Internal Folder
1475 @cindex Folder, @samp{$} mark
1477 A folder to access to internal messages of Wanderlust.
1489 A folder named @samp{'mark} is a special virtual folder which collects
1490 messages which have important mark @samp{$}.
1492 You can review important messages at once after you put important marks
1493 on the messages in the different folders.
1495 In this folder, if you delete message, important mark @samp{$} put on
1496 the message is removed. If you append messages to this folder, the
1497 message will have @samp{$} mark.
1499 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1500 folder. If you want IMAP folder's message remove from @samp{'mark}
1501 folder, remove important mark at IMAP Folder.)
1503 You can access to the cached messages fetched via network by accessing
1504 to the folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1505 the name of the subdirectories of the cache directory
1506 (@file{~/.elmo/cache}).
1509 @node Folder, Summary, Folders, Top
1510 @chapter Folder mode
1513 After you start Wanderlust, folder mode is appeared firstly.
1514 It contains folder list you subscribed.
1515 You can select and edit folders in this mode.
1518 * Selecting Folder:: Select folder you want to read.
1519 * Folder Manager:: Editing folders.
1523 @node Selecting Folder, Folder Manager, Folder, Folder
1524 @section Selecting Folder
1525 @cindex Selecting Folder
1527 @subsection Usage (TIPS)
1529 @subsubsection Check new, unread number
1531 Folder mode looks like this.
1532 (In XEmacs, it looks much nicer @t{;-)})
1536 [-]Desktop:14186/35580/67263
1541 [-]Emacsen:0/34/4837
1542 Wanderlust ML:0/0/558
1545 XEmacs Beta:0/29/255
1556 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1560 @kbd{s} key on the folder line updates these numbers.
1561 It changes its color if it has many new messages.
1563 The whole folder mode is a folder group named @samp{Desktop}.
1564 Folder group open/close by return key.
1565 A operation to a folder group is treated as operations on the
1567 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1568 six children folders update its unread number status.
1570 @subsubsection Select Folder
1572 To enter summary mode of the folder, type return (or space) key on
1574 If the variable @code{wl-stay-folder-window} has non-nil value,
1575 summary window appears on the right of the folder mode window.
1577 @subsection Key bindings
1579 Folder mode's key binding (related to selecting folders) is following.
1584 @kindex @key{SPC} (Folder)
1585 @kindex @key{RET} (Folder)
1586 @findex wl-folder-jump-to-current-entity
1587 Enter to the summary mode of the folder at the current cursor point.
1588 If the cursor is on the top of folder group line,
1589 the folder group is opened or closed.
1590 When the cursor is on the access group and this command is called
1591 with prefix argument, folder children list is updated to the newest one.
1592 (Children list is updated recursively if the access folder has hierarchical
1594 (@code{wl-folder-jump-to-current-entity})
1597 @kindex M-@key{RET} (Folder)
1598 @findex wl-folder-update-recursive-current-entity
1599 Folder children list of the access group at the current cursor point
1600 is updated to the newest one.
1601 (Children list is updated recursively if the access folder has hierarchical
1603 (@code{wl-folder-update-recursive-current-entity})
1608 Create a new draft message.
1613 @findex wl-folder-write-current-folder
1614 If the current cursor point is on the NNTP folder, create a new draft
1615 message which already has @samp{Newsgroups:} field. If the current
1616 cursor point is on the folder for mailing list (refile destination),
1617 create a new draft message which already has @samp{To:} field with
1618 guessed mailing list adderss (If @code{wl-subscribed-mailing-list} is
1620 (@code{wl-folder-write-current-folder})
1623 @kindex C-c C-o (Folder)
1624 @findex wl-jump-to-draft-buffer
1625 Move to the draft buffer if available. If multiple draft buffer exists,
1626 moved to one after another. If prefix argument is specified, load draft
1627 folder's message to the draft buffer and jump to it.
1628 (@code{wl-jump-to-draft-buffer})
1632 @findex wl-folder-check-current-entity
1633 Update new and unread number information of the folder at the current
1635 (@code{wl-folder-check-current-entity})
1639 @findex wl-folder-sync-current-entity
1640 Update summary information of the folder at the current cursor point.
1641 (@code{wl-folder-sync-current-entity})
1644 @kindex r s (Folder)
1645 @findex wl-folder-check-region
1646 Update new and unread number information of the folders in the currently
1648 (@code{wl-folder-check-region})
1651 @kindex r S (Folder)
1652 @findex wl-folder-sync-region
1653 Update summary information of the folders in the currently selected region.
1654 (@code{wl-folder-sync-region})
1658 @findex wl-status-update
1659 Sync up address book status with @file{~/.addresses}'s content.
1660 (@code{wl-status-update})
1664 @findex wl-folder-prev-unread
1665 Jump cursor to the folder which have unread messages on the upward from
1666 current cursor point.
1667 (@code{wl-folder-prev-unread})
1671 Jump cursor to the folder which have unread messages on the downward
1672 from current cursor point.
1673 (@code{wl-folder-next-unread})
1677 Move cursor to the folder on the previous line.
1678 (@code{wl-folder-prev-entity})
1682 Move cursor to the folder on the next line.
1683 (@code{wl-folder-next-entity})
1687 Jump to the folder specified by the user input.
1688 (@code{wl-folder-jump-folder})
1692 @findex wl-folder-prefetch-current-entity
1693 Prefetch new messages of the folder at the current cursor point by
1694 @code{wl-summary-incorporate}.
1695 If the cursor is on the folder group, it is executed recursively.
1696 (@code{wl-folder-prefetch-current-entity})
1700 @findex wl-folder-mark-as-read-all-current-entity
1701 Mark all unread messages of the folder at the current cursor point as read.
1702 If the cursor is on the folder group, it is executed recursively.
1703 (@code{wl-folder-mark-as-read-all-current-entity})
1707 @findex wl-folder-goto-first-unread-folder
1708 Enter summary mode of the first unread folder.
1709 (@code{wl-folder-goto-first-unread-folder})
1713 @findex wl-folder-empty-trash
1715 (@code{wl-folder-empty-trash})
1719 @findex wl-folder-open-all-unread-folder
1720 All unread folder is opened.
1721 (@code{wl-folder-open-all-unread-folder})
1725 @findex wl-folder-open-close
1726 Folder group is opened/closed.
1727 (@code{wl-thread-open-close})
1731 All folder group is opened.
1732 (@code{wl-folder-open-all})
1736 All folder group is closed.
1737 (@code{wl-folder-close-all})
1747 (@code{wl-folder-suspend})
1750 @kindex M-s (Folder)
1751 Save current folder status.
1755 @kindex M-t (Folder)
1756 Toggle Wanderlust's offline/online status.
1757 (@code{wl-toggle-plugged})
1760 @kindex C-t (Folder)
1761 Start Wanderlust's plug-status manager.
1762 (@code{wl-plugged-change})
1765 @subsection Customize variables
1768 @item wl-folders-file
1769 @vindex wl-folders-file
1770 The initial setting is @file{~/.folders}.
1771 Subscribed folders are described (saved) in this file.
1773 @item wl-folder-info-save
1774 @vindex wl-folder-info-save
1775 The initial setting is @code{t}. If non-nil, unread information is
1776 saved and used in the next Wanderlust session.
1778 @item wl-stay-folder-window
1779 @vindex wl-stay-folder-window
1780 The initial setting is @code{nil}.
1781 If non-nil, summary window is appeared on the right side of the folder buffer.
1783 @item wl-folder-window-width
1784 @vindex wl-folder-window-width
1785 The initial setting is 20.
1786 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1788 @item wl-folder-use-frame
1789 @vindex wl-folder-use-frame
1790 The initial setting is @code{nil}.
1791 If non-nil, use new frame for the folder window.
1793 @item wl-folder-many-unsync-threshold
1794 @vindex wl-folder-many-unsync-threshold
1795 The initial setting is 70.
1796 If the number of unread messages is more than this value,
1797 folder color is changed.
1799 @item wl-highlight-folder-by-numbers
1800 @vindex wl-highlight-folder-by-numbers
1801 This option controls how to highlight each line in the folder buffer.
1802 The default value is @code{t}, highlighting with various colors based on
1803 the message numbers. If it is @code{nil}, highlighting with various
1804 colors based on the folder status. In addition, if it is a number
1805 (e.g. 1), highlighting will be done based on both the message numbers
1806 and the folder status.
1808 @item wl-folder-desktop-name
1809 @vindex wl-folder-desktop-name
1810 The initial setting is @samp{Desktop}.
1811 The name of top folder group.
1813 @item wl-folder-petname-alist
1814 @vindex wl-folder-petname-alist
1815 The initial setting is @code{nil}.
1816 An alist of folder's realname and its nickname.
1818 @item wl-folder-access-subscribe-alist
1819 @vindex wl-folder-access-subscribe-alist
1820 The initial setting is @code{nil}.
1822 Control automatic subscribing and unsubscribing of the children list
1828 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1832 If @var{subscribe-flag} is non-nil, folders which have name matched to
1833 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1834 already unsubscribed folder is not displayed even when the
1835 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1842 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1843 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1844 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1845 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1849 @item wl-folder-hierarchy-access-folders
1850 @vindex wl-folder-hierarchy-access-folders
1851 The initial setting is the list shown below:
1860 A list of access groups which creates children folder list hierarchically.
1862 For example, if you specify
1863 @code{wl-folder-hierarchy-access-folders} like following,
1867 (setq wl-folder-hierarchy-access-folders
1868 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1873 such access group hierarchy is obtained.
1879 -fj.comp.announce:0/0/2
1880 -fj.comp.dev.cdrom:0/0/0
1882 [+]-japan:238/238/1688
1885 -comp.unix.admin:0/0/0
1886 -comp.unix.dos-under-unix:0/0/0
1887 -comp.unix.programmer:0/0/0
1888 [-]-comp.unix.bsd:0/0/23
1889 -comp.unix.bsd.freebsd.announce:0/0/0
1894 If you opened @samp{-} in this example, only the direct children is created
1895 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1896 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1897 is not created until the children access group is opened.
1901 @node Folder Manager, , Selecting Folder, Folder
1902 @section Editing Folders
1903 @cindex Folder Manager
1904 @cindex Folder, Edit
1905 @cindex Folder, Subscribe
1906 @cindex Folder, Unsubscribe
1908 As described before, subscribed folder list is saved in @file{~/.folders} file.
1909 But you don't have to edit @file{~/.folders} directly.
1910 You can append, delete, edit folders from folder mode.
1912 @subsection Usage (Tips)
1914 @subsubsection Append Folder
1916 @kbd{m a} appends new folder to the folder mode.
1917 @kbd{m g} appends new folder group.
1918 To append new folder to this group, firstly open it,
1919 then execute append command in the next line.
1921 @subsubsection Edit Folder
1923 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1924 Thus, you can change folder position as if you were editing a normal file.
1926 @subsubsection Create Multi Folder.
1930 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
1932 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
1934 Type @kbd{m m}, then you can create multi folder.
1937 @subsubsection Delete Nickname, Filter
1939 You can delete nickname or filter by putting ``''(@var{NULL}) from the
1940 minibuffer while appending.
1942 @subsubsection Append Folder to Empty Group
1944 To append new folder to the empty folder group
1945 (after you create folder group by typing @kbd{m g}),
1946 firstly open it, then execute append command in the next line.
1947 If it is closed, folder is appended on the same level with
1948 the above folder group. It is difficult to explain by words so try it.
1949 In other words, appended position depends on the
1950 above folder group's open/close status.
1952 @subsubsection Charset of the Folders File.
1954 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
1956 @subsubsection Create Filter
1958 @kbd{m f} adds filter to the folder at the current cursor point. To
1959 create new filter folder and leave the current folder unchanged, copy it
1960 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
1961 filter can be specified while appending filter. If you put
1962 ``''(@var{NULL}), filter is deleted.
1964 @subsubsection Sort Folders
1966 Sorting of the folders is executed by the function specified by
1967 @code{wl-fldmgr-sort-func}.
1968 The initial setting is @code{wl-fldmgr-sort-standard},
1969 which sorts alphabetically.
1970 Sorting affects only on the current folder group. It does not
1971 affect on the child groups.
1973 @subsubsection Hiding Folders in the Access Group
1975 Usually, access group displays all children folders, but you can set
1976 some folders hidden. Following operations are only available on access
1979 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
1980 (subscribe/unsubscribe) of the folder at current cursor point. Against
1981 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
1984 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
1985 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
1986 argument and if the argument has positive number, the unsubscribe it.
1987 If the prefix argument has negative value, folder becomes visible and if
1988 zero, folder visibility is toggled.
1990 The other commands, @code{wl-fldmgr-subscribe} and
1991 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
1994 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
1995 executed in the access group, they have a same effect with
1996 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
1997 The difference is that cut commands deletes folders from the current
2000 @subsubsection Operations in the Access Group
2002 You can insert and delete folders in the access group like usual folder
2003 group. But insert and delete commands can be only available for the
2004 children folders of the access group and they only sets the subscribe
2005 status. In other words, insertion of the folder means subscribing,
2006 deletion means unsubscribing.
2007 @footnote{In the current implementation,
2008 it is faster to delete region than to unsubscribe region.}
2010 To update the access group when children folders are inserted or deleted
2011 by other way (other than Wanderlust),
2012 open the access group by typing @kbd{C-u @key{RET}}.
2013 @xref{Selecting Folder}.
2015 The order of children folders of access group is saved after
2016 insertion/deletion/sorting.
2017 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2018 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2019 newly created folders are inserted on the top of the access group.
2021 @subsection Key bindings
2022 @cindex Keybind, Folder Mode
2023 @cindex Keybind, Folder Buffer
2025 Key bindings on the folder mode related to folder editing are shown below.
2026 All bindings starts with @kbd{m}, and primary commands are binded to
2027 one stroke key binding.
2031 @kindex m a (Folder)
2032 @findex wl-fldmgr-add
2034 (@code{wl-fldmgr-add})
2039 @kindex m g (Folder)
2040 @findex wl-fldmgr-make-group
2041 Create a folder group.
2042 (@code{wl-fldmgr-make-group})
2045 @kindex m A (Folder)
2046 @findex wl-fldmgr-make-access-group
2047 Create an access group.
2048 (@code{wl-fldmgr-make-access-group})
2051 @kindex m d (Folder)
2052 @findex wl-fldmgr-delete
2053 Delete folder itself and msgdb.
2054 If the folder itself cannot be deleted like NNTP folder,
2055 only msgdb is deleted.
2056 (@code{wl-fldmgr-delete})
2061 @kindex m R (Folder)
2062 @findex wl-fldmgr-rename
2063 Change the name of folder or folder group.
2064 msgdb's path is also changed.
2065 (@code{wl-fldmgr-rename})
2071 @findex wl-fldmgr-make-multi
2072 Create a multi folders in the cutlist (cut, copied folders).
2073 (@code{wl-fldmgr-make-multi})
2078 @kindex m f (Folder)
2079 @findex wl-fldmgr-make-filter
2080 Create a filter folder. (Put a filter on the folder).
2081 (@code{wl-fldmgr-make-filter})
2085 @kindex M-c (Folder)
2086 @kindex m c (Folder)
2087 @findex wl-fldmgr-copy
2088 Copy folder (it is not available on folder group).
2089 (@code{wl-fldmgr-copy})
2093 @kindex M-w (Folder)
2094 @kindex m W (Folder)
2095 @findex wl-fldmgr-copy-region
2096 Copy folders in the specified region.
2097 (@code{wl-fldmgr-copy-region})
2101 @kindex C-k (Folder)
2102 @kindex m k (Folder)
2103 @findex wl-fldmgr-cut
2104 Cut folder. Folder itself is not deleted.
2105 (@code{wl-fldmgr-cut})
2109 @kindex C-w (Folder)
2110 @kindex m C-w (Folder)
2111 @findex wl-fldmgr-cut-region
2112 Cut folders in the specified region.
2113 (@code{wl-fldmgr-cut-region})
2117 @kindex C-y (Folder)
2118 @kindex m y (Folder)
2119 @findex wl-fldmgr-yank
2120 Paste folders that are copied or cut (folders in the cut-list).
2121 (@code{wl-fldmgr-yank})
2124 @kindex m p (Folder)
2125 @findex wl-fldmgr-set-petname
2126 Put nickname on the folder.
2127 (@code{wl-fldmgr-set-petname})
2130 @kindex m q (Folder)
2131 @findex wl-fldmgr-clear-cut-entity-list
2132 Clear the cut-list. (cut, copied folder information is cleared,
2133 you cannot paste after this)
2134 (@code{wl-fldmgr-clear-cut-entity-list})
2137 @kindex m s (Folder)
2138 @findex wl-fldmgr-sort
2139 Sort folders in the current folder group.
2140 (@code{wl-fldmgr-sort})
2143 @kindex m C-s (Folder)
2144 @findex wl-fldmgr-save
2145 Save current folder view to the @file{wl-folders-file}.
2146 (@code{wl-fldmgr-save})
2149 [Following commands are only available on the access groups]
2155 @kindex m u (Folder)
2156 @findex wl-fldmgr-unsubscribe
2157 Set the visibility of folder (subscribe/unsubscribe).
2158 (@code{wl-fldmgr-unsubscribe})
2163 @kindex r u (Folder)
2164 @findex wl-fldmgr-unsubscribe-region
2165 Set the visibility of the folders (subscribe/unsubscribe) in the
2167 (@code{wl-fldmgr-unsubscribe-region})
2172 @kindex m l (Folder)
2173 @findex wl-fldmgr-access-display-normal
2174 List folders that are currently available.
2175 (@code{wl-fldmgr-access-display-normal})
2180 @kindex m L (Folder)
2181 @findex wl-fldmgr-access-display-all
2182 List all folders regardless of the subscription status.
2183 (@code{wl-fldmgr-access-display-all})
2187 @subsection Customize variables
2190 @item wl-interactive-save-folders
2191 @vindex wl-interactive-save-folders
2192 The initial setting is @code{t}. If non-nil and folder view is
2193 modified, confirm saving it before Wanderlust or Emacs exits. If
2194 @code{nil}, save without confirmation.
2196 @item wl-fldmgr-make-backup
2197 @vindex wl-fldmgr-make-backup
2198 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2199 created before saving the folder status.
2201 @item wl-fldmgr-sort-func
2202 @vindex wl-fldmgr-sort-func
2203 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2204 sort folders. By default function, folders are sorted alphabetically
2205 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2208 @item wl-fldmgr-sort-group-first
2209 @vindex wl-fldmgr-sort-group-first
2210 The initial setting is @code{t}. If non-nil,
2211 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2212 does not care whether it is folder group or not.
2214 @item wl-folder-check-async
2215 @vindex wl-folder-check-async
2216 The initial setting is @code{t}. If non-nil, check folder's unread
2217 status asynchronously. It boosts newsgroup checking.
2219 @item wl-folder-check-fast
2220 @vindex wl-folder-check-fast
2221 The initial setting is @code{nil}.
2222 If non-nil, it does not update folder status while checking.
2224 @item wl-folder-notify-deleted
2225 @vindex wl-folder-notify-deleted
2226 The initial setting is @code{nil}.
2228 If non-nil, negative value is displayed when the message is deleted. If
2229 @code{sync}, folder is synchronized when the message is deleted. If
2230 @code{nil}, message deletion is ignored.
2233 @subsection Miscellanea
2235 Following is a note for folder editing.
2239 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2240 paste(yank) command pastes the folders on one cut or copy command
2241 (If copy command is executed by region, folders in the region are pasted
2242 by one paste command)
2245 You cannot cut @samp{Desktop} group.
2246 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2249 You cannot copy folder group.
2252 Operations on the access group are only available for the folders
2253 in the same access group.
2256 You cannot create a folder which has same name with the folders already exist.
2259 You cannot insert folders which have same name in one group.
2260 You can insert them in the different groups.
2261 You cannot put same nickname to the different folders.
2265 @node Summary, Message, Folder, Top
2266 @chapter Summary Mode
2268 After you select the folder via folder mode, you enter to the summary
2272 * Usage of Summary Mode:: TIPS.
2273 * Thread Operations:: Thread operations.
2274 * Cache:: File cache, Buffer cache, and Prefetch.
2275 * Auto Refile:: Auto refile settings.
2276 * Sticky Summary:: Summary make sticky.
2277 * Key Bindings of Summary:: Key bindings.
2278 * Variables of Summary:: Customize Summary Mode.
2282 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2283 @section Usage (Tips)
2285 @subsection Summary Content
2287 In the summary mode, messages are displayed like following.
2291 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2292 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2293 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2294 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2301 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2305 You cannot change this in the current version.
2307 @var{Message number} is the message's unique number in the folder. In
2308 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2309 in the MH folder, it is the filename of the message.
2311 @var{Temporal mark} and @var{Persistent mark} are described later.
2313 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2314 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2315 Japanese, but if you want to display it in English, set the value of
2316 @code{wl-summary-weekday-name-lang} as @samp{en}.
2318 @var{Sender}'s indentation corresponds to the depth of the thread.
2319 Sender name is displayed as nickname if it is defined in the address
2320 book. Set @code{wl-use-petname} as @samp{nil}, if you want to quit
2321 displaying with nickname.
2323 If number is printed at the head of @var{Sender} part like @samp{+2},
2324 that means the message have 2 follow messages.
2326 @var{Subject} is the @samp{Subject:} header field of the message. If
2327 the message have same @samp{Subject:} with the parent message, it is not
2328 displayed. Some mailing list puts its sequence number in the
2329 @samp{Subject:} field, but it is
2330 ignored. @code{wl-summary-no-subject-message} is displayed when the
2331 message has empty subject field.
2333 @subsection Temporary Marks
2334 @cindex Mark, Temporary
2336 There are four temporary marks,
2337 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2338 Temporary marks indicates message operations.
2343 You can execute a command on the all messages that have @samp{*} mark,
2344 with the key bindings which begins with @kbd{m}.
2347 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2351 After you type @kbd{o} key, prompt appears to input refile destination.
2352 Your answer is printed in the summary line.
2356 You can put this mark by typing @kbd{O} key.
2357 The difference between this mark and refile mark is,
2358 this mark does not delete the message while latter does.
2361 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2363 @subsection Persistent Marks
2365 There are five persistent marks,
2366 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2368 The persistent mark indicates the message's status and it is saved.
2369 Each persistent mark indicates:
2375 It is unread message.
2377 It is unread but cached message.
2379 It is read but it is not cached.
2381 It is important message. You can put @samp{$} mark by typing @kbd{$}
2382 key (if already exists, the mark is deleted). It is convenient to put
2383 this mark on the messages to remember (If you want to remember to write
2384 a reply for the message, for example) because this mark remains after
2385 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2386 even the message itself is deleted in the actual folder.
2389 If the message is read and cached (or local message),there are no
2393 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2394 cache. Messages with the marks other than these, you can read them in
2395 the offline status even they are in the IMAP folder or netnews folder.
2397 @subsection How To Read
2399 Basically, you can read messages only typing space key again and again.
2401 To update summary status to the newest status (synchronize),
2404 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2405 moves cursor to the next message.
2406 Enter message buffer by typing @kbd{j} key.
2407 To operate multipart, you have to enter to the message buffer.
2410 @subsection Pack the Message Numbers
2411 You can pack the message numbers in Summary by
2412 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2413 News Spool Folder and Maildir Folder are supported folder types.
2416 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2417 @section Thread Operations
2419 For example, the following line indicates one thread (a context of a topic).
2422 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2426 If you type @kbd{/} on this line, the thread is opened and it changes
2427 the appearance like following.
2431 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2432 388 09/17(Thu)22:34 +-[ Murata san ]
2436 (Message 388 is the replied message to the message 384.)
2437 If you type @kbd{/} key once again, the thread is closed.
2438 With prefix argument, @kbd{/} opens all children threads.
2440 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2443 Commands with the key binding that begins with @kbd{t} executes commands
2444 on the messages in the thread.
2445 @xref{Key Bindings of Summary}.
2447 @subsection reconstruct thread by hand
2449 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2450 (@code{wl-summary-save-current-message}) at the corresponding message,
2451 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2452 message then you have the reconstructed thread.
2455 @node Cache, Auto Refile, Thread Operations, Summary
2458 @subsection Cache File
2460 The messages which have to access via network (e.x. IMAP, NNTP folder)
2461 are cached as a local file. The cache file is saved under the directory
2462 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2463 elmo-cache-expire-by-size}. The command deletes cache files to the
2464 specified size by the order of last accessed time.
2466 @subsection Buffer Cache and Prefetching
2468 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2469 that are read are kept in the cache buffer. It is called `buffer
2470 cache'. The number of cache buffer is specified by
2471 @code{elmo-buffer-cache-size}.
2473 There are message prefetching mechanism in the Wanderlust that
2474 prefetches next message while you are reading. This function requires
2475 that the value of @code{elmo-use-buffer-cache} is non-nil.
2477 You can control the message prefetching mechanism by these two
2481 @item wl-cache-prefetch-folder-type-list
2482 @vindex wl-cache-prefetch-folder-type-list
2483 The initial setting is the list shown below:
2491 It specifies the folder types in which message prefetching is enabled.
2492 In the initial setting, multi folder that contains localdir and imap4
2493 prefetches only imap4 messages. This variable precedes the value of
2494 @code{wl-cache-prefetch-folder-list}.
2496 If you want to prefetch localdir and localnews also, following setting
2501 (setq wl-cache-prefetch-folder-type-list
2502 '(nntp imap4 localdir localnews))
2506 @item wl-cache-prefetch-folder-list
2507 @vindex wl-cache-prefetch-folder-list
2508 The initial setting is @code{nil}.
2509 A list of regexp of folders to enable message prefetching.
2513 @node Auto Refile, Sticky Summary, Cache, Summary
2514 @section Auto Refile
2515 @vindex elmo-msgdb-extra-fields
2516 @vindex wl-refile-rule-alist
2517 @findex wl-summary-auto-refile
2519 You can refile messages automatically, by typing @kbd{C-o}
2520 (@code{wl-summary-auto-refile}). It decides destination of refile by
2521 the content of the message header information (information in the msgdb).
2523 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2524 available. If you want to decide destination by other header fields,
2525 set the variable @code{elmo-msgdb-extra-fields} like following.
2529 (setq elmo-msgdb-extra-fields
2539 By this setting, Wanderlust saves extra fields in the msgdb. You have
2540 to type @kbd{s all} to get extra fields for the messages that are
2541 already exists in the summary.
2543 Then, specify the refile rule. The refile target folder of auto
2544 refiling is decided by the value of @code{wl-refile-rule-alist}.
2545 @code{wl-refile-rule-alist} is a list of a rule:
2549 (@var{field} (@var{regexp} . @var{target})
2550 (@var{regexp} . @var{target})
2555 Each rule means `if @var{field} value matches @var{regexp},
2556 then refile to @var{target} folder'.
2557 The rule matched first is applied.
2559 @var{field} is a string of field name. You can specify a list of field name
2560 string, too. In this case, if one of these fields is matched, then the
2561 rule is fired (i.e. OR condition).
2563 @var{regexp} is a regular expression for field value. @var{target} is a target
2564 folder string. You can specify a rule at @var{target} part, too. In this
2565 case, If the field value of the rule and the current rule is matched,
2566 then the current rule is fired (i.e. AND condition).
2568 In @var{target} part, you can refer matched substring of @var{regexp}.
2569 To refer substring, specify following in @var{target}:
2573 means substitute original matched text.
2576 means substitute what matched the @var{N}th `\(@dots{}\)'.
2577 (@var{N} is a number.)
2580 Following is an example of @code{wl-refile-rule-alist}.
2584 (setq wl-refile-rule-alist
2586 ("^Wanderlust" . "+wl")
2587 ("^Elisp" . "+elisp"))
2589 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2591 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2592 "+from-me-to-you"))))))
2596 After these settings, refile marks are automatically put on the condition
2597 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2599 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2601 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2602 with these persistent marks are not automatically refiled.
2603 It means Wanderlust does not execute auto refile on unread messages by
2604 the default setting.
2605 To execute auto refile on all messages, set following.
2608 (setq wl-summary-auto-refile-skip-marks nil)
2612 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2613 @section Sticky Summary
2614 @cindex Summary, Sticky
2615 @cindex Sticky Summary
2617 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2619 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2620 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2622 The buffer name of the sticky summary becomes like
2623 @samp{Summary:@var{folder-name}}.
2625 You can visit the sticky summary at any time by @kbd{C-x b}
2626 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2627 q}. Other operations in the sticky summary are same as normal summary.
2629 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2630 are automatically sticked.
2633 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2634 @section Key bindings
2635 @cindex Keybind, Summary Mode
2636 @cindex Keybind, Summary Buffer
2638 Key bindings of the summary mode are shown below.
2642 @kindex @key{SPC} (Summary)
2643 @findex wl-summary-read
2644 Proceed reading a message at the current cursor point.
2645 (@code{wl-summary-read})
2649 @findex wl-summary-redisplay
2650 Redisplay a message at the current cursor point.
2651 If this command is called with prefix argument,
2652 Redisplay message regardless of the message cache (message is re-loaded
2654 (@code{wl-summary-redisplay})
2658 @findex wl-summary-display-top
2659 Display the top message in the folder.
2660 (@code{wl-summary-display-top})
2664 @findex wl-summary-display-bottom
2665 Display the bottom message in the folder.
2666 (@code{wl-summary-display-bottom})
2670 @kindex @key{BS} (Summary)
2671 @kindex @key{DEL} (Summary)
2672 Display the previous page of the message at the current cursor point.
2673 @findex wl-summary-prev-page
2674 (@code{wl-summary-prev-page})
2677 @kindex @key{RET} (Summary)
2678 @findex wl-summary-next-line-content
2679 Display the next line of the message at the current cursor point.
2680 Display the message at the current cursor point if it is not displayed yet.
2681 (@code{wl-summary-next-line-content})
2686 @kindex M-@key{RET} (Summary)
2687 @findex wl-summary-prev-line-content
2688 Display the previous line of the message at the current cursor point.
2689 Display the message at the current cursor point if it is not displayed yet.
2690 (@code{wl-summary-prev-line-content})
2694 @findex wl-thread-open-close
2695 Toggle open or close the thread at the current cursor point.
2696 (@code{wl-thread-open-close})
2701 @findex wl-thread-open-all
2702 (@code{wl-thread-open-all})
2707 @findex wl-thread-close-all
2708 (@code{wl-thread-close-all})
2712 @findex wl-summary-goto-folder
2714 (@code{wl-summary-goto-folder})
2718 Mark all messages in the folder as read.
2719 @findex wl-summary-mark-as-read-all
2720 (@code{wl-summary-mark-as-read-all})
2724 @findex wl-summary-reply
2725 Prepare a draft for reply the message at the current cursor point.
2726 (@code{wl-summary-reply})
2730 @findex wl-summary-reply-with-citation
2731 Prepare a draft for reply the message at the current cursor point.
2732 (@code{wl-summary-reply-with-citation})
2736 @findex wl-summary-cancel-message
2737 If the message at current cursor point is your own netnews article,
2739 (@code{wl-summary-cancel-message})
2743 @findex wl-summary-reedit
2744 Prepare a draft for re-editing the message at current cursor point.
2745 If the message at current cursor point is your own netnews article,
2746 a draft for `supersedes message' for the message is prepared.
2747 (@code{wl-summary-reedit})
2750 @kindex M-e (Summary)
2751 @findex wl-summary-resend-bounced-mail
2752 If the message at current cursor point is a bounced message,
2753 a draft for re-sending original message is prepared.
2754 (@code{wl-summary-resend-bounced-mail})
2758 @findex wl-summary-forward
2759 A draft for forwarding the message at current cursor point is prepared.
2760 (@code{wl-summary-forward})
2764 @findex wl-summary-mark-as-important
2765 Put @samp{$} mark on the message at current cursor point.
2766 If already marked as @samp{$}, delete it.
2767 (@code{wl-summary-mark-as-important})
2773 Save the message at current cursor point.
2774 @findex wl-summary-save
2775 (@code{wl-summary-save})
2779 @findex wl-summary-next
2780 Move cursor to the next message.
2781 If message is marked with a temporal mark in
2782 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2783 In the offline mode, cursor is not moved to the messages which are not cached
2785 (@code{wl-summary-next})
2789 @findex wl-summary-prev
2790 Move cursor to the previous message.
2791 If message is marked with a temporal mark in
2792 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2793 In the offline mode, cursor is not moved to the messages which are not cached
2795 (@code{wl-summary-prev})
2799 @findex wl-summary-down
2800 Move cursor to the downward message which is unread or marked
2802 In the offline mode, cursor is not moved to the messages which are not cached
2804 If there are messages which have target mark @samp{*} in the summary,
2805 cursor is moved to the downward message which have a target mark.
2806 This behavior is changed according to the value of @code{wl-summary-move-order}.
2807 (@code{wl-summary-down})
2811 @findex wl-summary-up
2812 Move cursor to the upward message which is unread or marked
2814 In the offline mode, cursor is not moved to the messages which are not cached
2816 If there are messages which have target mark @samp{*} in the summary,
2817 cursor is moved to the downward message which have a target mark.
2818 This behavior is changed according to the value of @code{wl-summary-move-order}.
2819 (@code{wl-summary-up})
2823 @findex wl-summary-write
2824 Prepare a new draft.
2825 (@code{wl-summary-write})
2829 @findex wl-summary-write-current-folder
2830 Prepare a new draft. If the current folder is NNTP folder,
2831 @samp{Newsgroups:} field is completed. If the current folder is mailing
2832 list folder (refile destination), guess @samp{To:} field and completed
2833 (If @code{wl-subscribed-mailing-list} is valid list)
2834 (@code{wl-summary-write-current-folder})
2838 @findex wl-summary-redisplay-all-header
2839 Redisplay the message at current cursor point with all header fields.
2840 (@code{wl-summary-redisplay-all-header})
2844 @findex wl-summary-redisplay-no-mime
2845 Redisplay the message at current cursor point without MIME analysis.
2846 (@code{wl-summary-redisplay-no-mime})
2850 @findex wl-summary-burst
2851 If the message at current cursor point has
2852 encapsulates multiple messages using MIME,
2853 de-capsulate and extract them on the current folder.
2854 (@code{wl-summary-burst})
2857 @kindex @@ (Summary)
2858 @findex wl-summary-edit-addresses
2859 Append/change/delete the message's sender information to the address
2860 book @file{~/.addresses} interactively. If this command is called with
2861 prefix argument, arbitrary address can be edited.
2862 (@code{wl-summary-edit-petname})
2866 @findex wl-status-update
2867 Sync up address book status with @file{~/.addresses}'s content.
2868 (@code{wl-status-update})
2872 @findex wl-summary-pipe-message
2873 Pipe current message's content to the external process.
2874 (@code{wl-summary-pipe-message})
2878 @findex wl-summary-print-message
2879 Print out current message's content.
2880 It uses @code{ps-print} module in Emacs 20.x.
2881 If you don't use color printer, you might want to set
2882 @code{wl-ps-print-buffer-func} to @code{ps-print-buffer}.
2885 (setq wl-ps-print-buffer-func 'ps-print-buffer)
2888 (@code{wl-summary-print-message})
2892 @findex wl-summary-exit
2893 Exit current folder.
2894 (@code{wl-summary-exit})
2898 @findex wl-summary-jump-to-current-message
2899 Jump cursor to the currently displayed message's window.
2900 (@code{wl-summary-jump-to-current-message})
2904 Jump cursor to the other message.
2905 @findex wl-summary-jump-to-msg
2906 (@code{wl-summary-jump-to-msg})
2910 Update summary status and
2911 prefetch all messages which have marks included in the
2912 @code{wl-summary-incorporate-marks}.
2913 @findex wl-summary-incorporate
2914 (@code{wl-summary-incorporate})
2917 @kindex M-j (Summary)
2918 @findex wl-summary-jump-to-msg-by-message-id
2919 Jump cursor to the message which have specified @samp{Message-Id:}. If
2920 @code{elmo-use-database} is non-nil, other folder is also searched.
2921 (@code{wl-summary-jump-to-msg-by-message-id})
2925 Jump to parent message.
2926 @findex wl-summary-jump-to-parent-message
2927 (@code{wl-summary-jump-to-parent-message})
2931 @findex wl-summary-mark-as-unread
2932 Mark as unread the message at current cursor point.
2933 (@code{wl-summary-mark-as-unread})
2937 @findex wl-summary-sync
2938 Synchronize summary view after prompting the update range
2939 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
2943 all ...Discard current summary and update all message.
2944 update ...Update the difference between summary and the folder itself.
2945 rescan ...Rescan the msgdb and display again.
2946 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2947 first, last ...Move to the filter folder(partial filter).
2952 (@code{wl-summary-sync})
2956 @findex wl-summary-sort
2958 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
2959 (@code{wl-summary-sort})
2963 @findex wl-summary-toggle-thread
2964 Toggle the threading.
2965 Threading status is displayed on the modeline.
2966 @samp{@{S@}} means threading is off (Sequence) and
2967 @samp{@{T@}} means threading is on (Thread).
2968 (@code{wl-summary-toggle-thread})
2972 @findex wl-summary-toggle-disp-folder
2973 Toggle displaying of folder window.
2974 (@code{wl-summary-toggle-disp-folder})
2978 Toggle displaying of message window.
2979 @findex wl-summary-toggle-disp-msg
2980 (@code{wl-summary-toggle-disp-msg})
2984 Move to the virtual folder with the condition specified.
2985 If called with prefix argument and current folder is virtual, exit it.
2986 @findex wl-summary-virtual
2987 (@code{wl-summary-virtual})
2990 @kindex @key{TAB} (Summary)
2991 @findex wl-summary-goto-last-displayed-msg
2992 Jump to the message which is displayed last.
2993 (@code{wl-summary-goto-last-displayed-msg})
2997 Put @samp{*} mark on the messages that satisfies the specified condition.
2998 @findex wl-summary-pick
2999 (@code{wl-summary-pick})
3003 @findex wl-summary-mark-as-read
3004 Mark as read the message at the current cursor point.
3005 (@code{wl-summary-mark-as-read})
3009 Prefetch the message at the current cursor point.
3010 With prefix argument, prefetch the message even if it is cached.
3011 @findex wl-summary-prefetch
3012 (@code{wl-summary-prefetch})
3016 Execute @samp{D}, @samp{o} and @samp{O} marks.
3017 @findex wl-summary-exec
3018 (@code{wl-summary-exec})
3022 @findex wl-summary-target-mark-line
3023 Put target mark on the message at the current cursor point.
3024 (@code{wl-summary-target-mark-line})
3028 Put refile mark on the message at the current cursor point.
3029 @findex wl-summary-refile
3030 (@code{wl-summary-refile})
3033 @kindex C-o (Summary)
3034 Execute auto refile.
3035 @findex wl-summary-auto-refile
3036 (@code{wl-summary-auto-refile})
3040 Put copy mark on the message at the current cursor point.
3041 @findex wl-summary-copy
3042 (@code{wl-summary-copy})
3045 @kindex M-o (Summary)
3046 Put refile mark on the message at the current cursor point with the destination
3047 previously specified.
3048 @findex wl-summary-refile-prev-destination
3049 (@code{wl-summary-refile-prev-destination})
3053 @findex wl-summary-delete
3054 Put delete mark on the message at the current cursor point.
3055 (@code{wl-summary-delete})
3059 @findex wl-summary-unmark
3060 Unmark the temporal mark on the message at the current cursor point.
3061 (@code{wl-summary-unmark})
3065 Unmark all the temporal marks.
3066 @findex wl-summary-unmark-all
3067 (@code{wl-summary-unmark-all})
3070 @kindex r R (Summary)
3071 @findex wl-summary-mark-as-read-region
3072 Mark as read messages in the specified region.
3073 (@code{wl-summary-mark-as-read-region})
3076 @kindex r $ (Summary)
3077 @findex wl-summary-mark-as-important-region
3078 Mark as important @samp{$} messages in the specified region.
3079 If @samp{$} already exists, it is deleted.
3080 (@code{wl-summary-mark-as-important-region})
3083 @kindex r ! (Summary)
3084 @findex wl-summary-mark-as-unread-region
3085 Mark as unread messages in the specified region.
3086 (@code{wl-summary-mark-as-unread-region})
3089 @kindex r i (Summary)
3090 @findex wl-summary-prefetch-region
3091 Prefetch messages in the specified region.
3092 (@code{wl-summary-prefetch-region})
3095 @kindex r x (Summary)
3096 @findex wl-summary-exec-region
3097 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3099 (@code{wl-summary-exec-region})
3102 @kindex r * (Summary)
3103 @findex wl-summary-target-mark-region
3104 Put target mark on the messages in the specified region.
3105 (@code{wl-summary-target-mark-region})
3108 @kindex r o (Summary)
3109 @findex wl-summary-refile-region
3110 Put refile mark on the messages in the specified region.
3111 (@code{wl-summary-refile-region})
3114 @kindex r O (Summary)
3115 @findex wl-summary-copy-region
3116 Put copy mark on the messages in the specified region.
3117 (@code{wl-summary-copy-region})
3120 @kindex r d (Summary)
3121 @findex wl-summary-delete-region
3122 Put delete mark on the messages in the specified region.
3123 (@code{wl-summary-delete-region})
3126 @kindex r u (Summary)
3127 @findex wl-summary-unmark-region
3128 Delete temporal mark on the messages in the specified region.
3129 (@code{wl-summary-unmark-region})
3132 @kindex r y (Summary)
3133 Save messages in the specified region.
3134 @findex wl-summary-save-region
3135 (@code{wl-summary-save-region})
3138 @kindex t R (Summary)
3139 @findex wl-thread-mark-as-read
3140 Mark as read messages which are the descendant of the current thread.
3141 With prefix argument, it affects on the all messages in the thread tree.
3142 (@code{wl-thread-mark-as-read})
3145 @kindex t $ (Summary)
3146 @findex wl-thread-mark-as-important
3147 Put important mark @samp{$} on the messages which are the
3148 descendant of the current thread.
3149 If @samp{$} mark exists, it is deleted.
3150 With prefix argument, it affects on the all messages in the thread tree.
3151 (@code{wl-thread-mark-as-important})
3154 @kindex t ! (Summary)
3155 @findex wl-thread-mark-as-unread
3156 Mark as unread messages which are the descendant of the current thread.
3157 With prefix argument, it affects on the all messages in the thread tree.
3158 (@code{wl-thread-mark-as-unread})
3161 @kindex t i (Summary)
3162 @findex wl-thread-prefetch
3163 Prefetch messages which are the descendant of the current thread.
3164 With prefix argument, it affects on the all messages in the thread tree.
3165 (@code{wl-thread-prefetch})
3168 @kindex t x (Summary)
3169 @findex wl-thread-exec
3170 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3171 the descendant of the current thread. With prefix argument, it affects
3172 on the all messages in the thread tree.
3173 (@code{wl-thread-exec})
3176 @kindex t * (Summary)
3177 @findex wl-thread-target-mark
3178 Put target mark @samp{*} on the messages which are the descendant of the
3179 current thread. With prefix argument, it affects on the all messages in
3181 (@code{wl-thread-target-mark})
3184 @kindex t o (Summary)
3185 @findex wl-thread-refile
3186 Put refile mark on the messages which are the descendant of the current thread.
3187 With prefix argument, it affects on the all messages in the thread tree.
3188 (@code{wl-thread-refile})
3191 @kindex t O (Summary)
3192 @findex wl-thread-copy
3193 Put copy mark on the messages which are the descendant of the current thread.
3194 With prefix argument, it affects on the all messages in the thread tree.
3195 (@code{wl-thread-copy})
3198 @kindex t d (Summary)
3199 @findex wl-thread-delete
3200 Put delete mar on the messages which are the descendant of the current thread.
3201 With prefix argument, it affects on the all messages in the thread tree.
3202 (@code{wl-thread-delete})
3205 @kindex t u (Summary)
3206 @findex wl-thread-unmark
3207 Unmark temporal mark on the messages which are the descendant of the
3208 current thread. With prefix argument, it affects on the all messages in
3210 (@code{wl-thread-unmark})
3213 @kindex t y (Summary)
3214 @findex wl-thread-save
3215 Save messages which are the descendant of the current thread.
3216 With prefix argument, it affects on the all messages in the thread tree.
3217 (@code{wl-thread-save})
3220 @kindex m i (Summary)
3221 @findex wl-summary-target-mark-prefetch
3222 Prefetch all messages which have target mark @samp{*}.
3223 (@code{wl-summary-target-mark-prefetch})
3226 @kindex m R (Summary)
3227 @findex wl-summary-target-mark-mark-as-read
3228 Mark as read all messages which have target mark @samp{*}.
3229 (@code{wl-summary-target-mark-mark-as-read})
3232 @kindex m $ (Summary)
3233 @findex wl-summary-target-mark-mark-as-important
3234 Mark as important all messages which have target mark @samp{*}.
3235 If already marked as @samp{$}, it is deleted.
3236 (@code{wl-summary-target-mark-mark-as-important})
3239 @kindex m ! (Summary)
3240 @findex wl-summary-target-mark-mark-as-unread
3241 Mark as unread all messages which have target mark @samp{*}.
3242 (@code{wl-summary-target-mark-mark-as-unread})
3245 @kindex m o (Summary)
3246 @findex wl-summary-target-mark-refile
3247 Put refile mark on the messages which have target mark @samp{*}.
3248 (@code{wl-summary-target-mark-refile})
3251 @kindex m O (Summary)
3252 @findex wl-summary-target-mark-copy
3253 Put copy mark on the messages which have target mark @samp{*}.
3254 (@code{wl-summary-target-mark-copy})
3257 @kindex m d (Summary)
3258 @findex wl-summary-target-mark-delete
3259 Put delete mark on the messages which have target mark @samp{*}.
3260 (@code{wl-summary-target-mark-delete})
3263 @kindex m y (Summary)
3264 @findex wl-summary-target-mark-save
3265 Save messages which have target mark @samp{*}.
3266 (@code{wl-summary-target-mark-save})
3269 @kindex m u (Summary)
3270 Unmark all temporal marks.
3271 (@code{wl-summary-delete-all-temp-marks})
3272 @findex wl-summary-delete-all-temp-marks
3275 @kindex m a (Summary)
3276 Put target mark @samp{*} on the all messages.
3277 (@code{wl-summary-target-mark-all})
3278 @findex wl-summary-target-mark-all
3281 @kindex m t (Summary)
3282 Put target mark @samp{*} on the messages in the current thread.
3283 @findex wl-summary-target-mark-thread
3284 (@code{wl-summary-target-mark-thread})
3287 @kindex m r (Summary)
3288 @findex wl-summary-target-mark-region
3289 Put target mark @samp{*} on the messages in the specified region.
3290 (@code{wl-summary-target-mark-region})
3293 @kindex m A (Summary)
3294 @findex wl-summary-target-mark-reply-with-citation
3295 Prepare a draft which cites all messages which have target mark @samp{*}.
3296 (@code{wl-summary-target-mark-reply-with-citation})
3299 @kindex m f (Summary)
3300 @findex wl-summary-target-mark-forward
3301 Prepare a draft which forwards all messages which have target mark @samp{*}.
3302 (@code{wl-summary-target-mark-forward})
3305 @kindex m U (Summary)
3306 @findex wl-summary-target-mark-uudecode
3307 Uudecode the messages which have target mark @samp{*}.
3308 (@code{wl-summary-target-mark-uudecode})
3311 @kindex m ? (Summary)
3312 @findex wl-summary-target-mark-pick
3313 Pick messages from the @samp{*} marked messages.
3314 That is, @samp{*} marks on the messages are remained
3315 if the specified condition is satisfied.
3316 (@code{wl-summary-target-mark-pick})
3319 @kindex M-t (Summary)
3320 @findex wl-toggle-plugged
3321 Toggle offline/online status of Wanderlust.
3322 (@code{wl-toggle-plugged})
3325 @kindex C-t (Summary)
3326 Start Wanderlust's plug-status manager.
3327 (@code{wl-plugged-change})
3330 @kindex C-c C-o (Summary)
3331 @findex wl-jump-to-draft-buffer
3332 Move to the draft buffer if available. If multiple draft buffer exists,
3333 moved to one after another. If prefix argument is specified, load draft
3334 folder's message to the draft buffer and jump to it.
3335 (@code{wl-jump-to-draft-buffer})
3338 @kindex M-w (Summary)
3339 @findex wl-summary-save-current-message
3340 Save the message at the current cursor point.
3341 (@code{wl-summary-save-current-message})
3344 @kindex C-y (Summary)
3345 @findex wl-summary-yank-saved-message
3346 Regard the message at the current cursor point as
3347 parent, connect the message saved by
3348 @code{wl-summary-save-current-message}
3350 (@code{wl-summary-yank-saved-message})
3354 @node Variables of Summary, , Key Bindings of Summary, Summary
3355 @section Customiziable variables
3358 @item wl-summary-move-order
3359 @vindex wl-summary-move-order
3360 The initial setting is @code{unread}. Specify cursor moving policy. If
3361 you want to precede new messages, set @code{new}. If you want to
3362 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3365 @item wl-auto-select-first
3366 @vindex wl-auto-select-first
3367 The initial setting is @code{nil}.
3368 If non-nil, first message is automatically displayed.
3370 @item wl-auto-select-next
3371 @vindex wl-auto-select-next
3372 The initial setting is @code{nil}. If non-nil, jump to next summary
3373 automatically. If @code{unread}, jump to next unread folder's summary
3374 after confirmation. If @code{skip-no-unread}, unread folders are
3375 automatically skipped.
3377 @item wl-thread-insert-opened
3378 @vindex wl-thread-insert-opened
3379 The initial setting is @code{nil}.
3380 If non-nil, thread is inserted as opened.
3382 @item wl-thread-open-reading-thread
3383 @vindex wl-thread-open-reading-thread
3384 The initial setting is @code{t}. If non-nil, reading thread is
3385 automatically opened though it is closed thread.
3387 @item wl-summary-exit-next-move
3388 @vindex wl-summary-exit-next-move
3389 The initial setting is @code{t}. If non-nil, move to next folder at
3392 @item wl-folder-move-cur-folder
3393 @vindex wl-folder-move-cur-folder
3394 The initial setting is @code{nil}. If non-nil, cursor position on the
3397 @item wl-summary-weekday-name-lang
3398 @vindex wl-summary-weekday-name-lang
3399 The initial setting is @samp{ja}. Specify language of the weekday.
3400 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3403 @item wl-summary-fix-timezone
3404 @vindex wl-summary-fix-timezone
3405 The initial setting is @samp{nil}.
3406 Time zone of the date string in summary mode is adjusted using this value.
3407 If @code{nil}, it is adjust to the default time zone information
3408 (system's default time zone or environment variable @samp{TZ}).
3410 @item wl-use-petname
3411 @vindex wl-use-petname
3412 The initial setting is @code{t}.
3413 If non-nil, sender part displays nickname.
3415 @item wl-break-pages
3416 @vindex wl-break-pages
3417 The initial setting is @code{t}.
3418 If non-nil, message is splitted as pages by @samp{^L}.
3420 @item wl-message-window-size
3421 @vindex wl-message-window-size
3422 The initial setting is '(1 . 4).
3423 A cons cell to specify the rate of summary and message window.
3424 car:cdr corresponds summary:message.
3426 @item wl-summary-recenter
3427 @vindex wl-summary-recenter
3428 The initial setting is t.
3429 If non-nil, cursor point is moved to the center of the summary window.
3431 @item wl-summary-indent-length-limit
3432 @vindex wl-summary-indent-length-limit
3433 The initial setting is 46.
3434 Specify the limit of thread indent level.
3435 If nil, max indent level is unlimited.
3437 @item wl-summary-no-from-message
3438 @vindex wl-summary-no-from-message
3439 The initial setting is @samp{nobody@@nowhere?}. A string which is
3440 displayed when there's no @samp{From:} field in the message.
3442 @item wl-summary-no-subject-message
3443 @vindex wl-summary-no-subject-message
3444 The initial setting is @samp{(WL:No Subject in original.)}. A string
3445 which is displayed when there's no @samp{Subject:} field in the message.
3447 @item wl-summary-width
3448 @vindex wl-summary-width
3449 The initial setting is 80.
3450 Width of summary line. If @code{nil}, summary line's width is as is.
3452 @item wl-summary-use-frame
3453 @vindex wl-summary-use-frame
3454 The initial setting is @code{nil}.
3455 If non-nil, use new frame for the summary.
3457 @item wl-use-folder-petname
3458 @vindex wl-use-folder-petname
3459 The initial setting is the list shown below:
3468 A list of display policy (symbol) of folder nickname. Available symbols
3473 Display folder petname on modeline.
3475 Destination folder is notified as nickname if
3476 @code{wl-auto-select-next} is non-nil.
3478 You can input folder name by nickname in the function
3479 @code{wl-summary-read-folder}.
3482 @item wl-summary-move-direction-toggle
3483 @vindex wl-summary-move-direction-toggle
3484 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3485 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3486 want to aware of reading direction, set this to @code{t}.
3489 @vindex wl-from-width
3490 The initial setting is 17.
3491 Width of sender part of summary line.
3493 @item wl-summary-divide-thread-when-subject-changed
3494 @vindex wl-summary-divide-thread-when-subject-changed
3495 The initial setting is @code{nil}. If non-nil, thread is splitted if
3496 the subject is changed.
3498 @item wl-summary-search-via-nntp
3499 @vindex wl-summary-search-via-nntp
3500 The initial setting is @code{confirm}.
3502 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3503 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3504 from the NNTP server @code{elmo-default-nntp-server}. The value of
3505 @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
3506 @code{elmo-default-nntp-stream-type} are used.
3508 If @code{confirm}, server name can be specified. You can specify NNTP
3509 folder format like @samp{-:username@@servername:119!}.
3511 @item wl-summary-keep-cursor-command
3512 @vindex wl-summary-keep-cursor-command
3513 The initial setting is the list shown below:
3517 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3522 When you entered to summary by these commands and the target summary
3523 buffer already exists, summary status is not automatically updated and
3524 cursor position is saved.
3526 @item wl-summary-update-confirm-threshold
3527 @vindex wl-summary-update-confirm-threshold
3528 The initial setting is 500. If updated message number is larger than
3529 this value, confirm whether drop them or not.
3531 @item wl-summary-always-sticky-folder-list
3532 @vindex wl-summary-always-sticky-folder-list
3533 The initial setting is @code{nil}.
3534 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3535 are automatically sticked. Each element is regexp of folder name.
3537 @item wl-summary-reserve-mark-list
3538 @vindex wl-summary-reserve-mark-list
3539 The initial setting is the list shown below:
3548 If a message is already marked as temporal marks in this list, the
3549 message is not marked by any mark command.
3551 @item wl-summary-skip-mark-list
3552 @vindex wl-summary-skip-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 skipped at cursor move.
3565 @item wl-fetch-confirm-threshold
3566 @vindex wl-fetch-confirm-threshold
3567 The initial setting is 30000 (bytes). If displaying message has larger
3568 size than this value, Wanderlust confirms whether fetch the message or
3569 not. If @code{nil}, the message is fetched without confirmation.
3571 @item wl-prefetch-threshold
3572 @vindex wl-prefetch-threshold
3573 The initial setting is 30000 (bytes). If prefetching message has larger
3574 size than this value and @code{wl-prefetch-confirm} is non-nil,
3575 Wanderlust confirms whether prefetch the message or not. If
3576 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3577 without confirmation.
3579 @item wl-prefetch-confirm
3580 @vindex wl-prefetch-confirm
3581 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3582 prefetch the message or not if the message has larger size than
3583 @code{wl-prefetch-threshold}.
3585 @item wl-cache-fetch-threshold
3586 @vindex wl-cache-fetch-threshold
3587 The initial setting is 30000 (bytes). The messages which have larger
3588 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3589 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3592 @item elmo-imap4-use-cache
3593 @vindex elmo-imap4-use-cache
3594 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3597 @item elmo-nntp-use-cache
3598 @vindex elmo-nntp-use-cache
3599 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3602 @item elmo-pop3-use-cache
3603 @vindex elmo-pop3-use-cache
3604 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3609 @node Message, Draft, Summary, Top
3610 @chapter Message Buffer
3612 Message Buffers utilize MIME-View mode of SEMI/tm. For operational
3613 procedures and key bindings, refer to respective documents.
3614 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3615 You can also see help by @kbd{?} in message buffer.
3617 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3618 brings you back to Summary mode. @kbd{l} toggles display of Summary
3621 @section Key Bindings
3627 @findex wl-message-toggle-disp-summary
3628 Toggles display of Summary mode buffer.
3629 (@code{wl-message-toggle-disp-summary})
3632 @findex wl-message-refer-article-or-url
3633 @kindex Button-2 (Message)
3634 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3635 corresponding message if found.
3636 (@code{wl-message-refer-article-or-url})
3638 @item Button-4 (upward movement of a wheel)
3639 @kindex Button-4 (Message)
3640 @findex wl-message-wheel-down
3641 Scrolls the message backwards. When the top of the message is hit,
3642 moves to the previous message.
3643 (@code{wl-message-wheel-down})
3645 @item Button-5 (downward movement of a wheel)
3646 @kindex Button-5 (Message)
3647 @findex wl-message-wheel-up
3648 Scrolls the message forward. When the bottom of the message is hit,
3649 moves to the next message.
3650 (@code{wl-message-wheel-up})
3653 @section Customizable Variables
3656 @item wl-message-window-size
3657 @vindex wl-message-window-size
3658 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3659 its car and cdr value corresponds to the ratio of Summary and Message
3661 @item wl-message-ignored-field-list
3662 @vindex wl-message-ignored-field-list
3663 (SEMI only) Initial setting is nil.
3664 All fields that match this list will be hidden in message buffer.
3665 Each elements are regexp of field-name.
3666 If nil, the value of mime-view-ignored-field-list is used.
3667 @item wl-message-visible-field-list
3668 @vindex wl-message-visible-field-list
3669 (SEMI only) Initial setting is nil.
3670 All fields that match this list will be hidden in message buffer.
3671 Each elements are regexp of field-name. This value precedes
3672 wl-message-ignored-field-list.
3673 If nil, the value of mime-view-visible-field-list is used.
3674 @item wl-message-sort-field-list
3675 @vindex wl-message-sort-field-list
3676 (SEMI only) Initial setting is
3677 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3678 Header fields in message buffer are orderd by this value.
3679 Each elements are regexp of field-name.
3680 @item wl-message-truncate-lines
3681 @vindex wl-message-truncate-lines
3682 The initial value is the value of @code{default-truncate-lines}.
3683 If it is non-nil, truncate long lines in message buffer.
3686 @node Draft, Disconnected Operations, Message, Top
3687 @chapter Draft Buffer
3689 At Summary mode, pressing @kbd{w} and the like creates a new draft
3690 buffer. You can edit and send mail and news articles in this buffer.
3694 Basically it is Emacs-standard mail mode.
3696 @subsection Address Completion
3698 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3699 addresses. @kbd{@key{TAB}} completes them.
3701 If you want to submit a news article, add @samp{Newsgroups:} field by
3702 yourself. Field names can be completed by @kbd{@key{TAB}}.
3704 If you save the draft buffer you are editing, it is appended to the
3705 folder specified by @code{wl-draft-folder}.
3707 Using @samp{FCC:} field, you can specify the folder to which a copy of
3708 the message is saved when it is sent.
3710 @subsection Editing Messages
3712 Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
3713 editing, refer to respective documents.
3714 @xref{MIME-Edit, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3715 You can also see help by @kbd{C-c C-x ?} in draft buffer.
3717 @subsection Dynamic Modification of Messages
3718 @vindex wl-draft-config-alist
3719 @c @cindex Change Message
3720 @c @cindex Message, Change Dynamic
3722 You can set @code{wl-draft-config-alist} so that header and body of the
3723 message will automatically modified depending on information of header
3726 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3728 In the example below, the header is modified when
3729 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3730 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3731 before sending the message.
3735 (setq wl-draft-config-alist
3736 '(((string-match "aaa.example.com$" (system-name))
3737 ;; @r{applied if the expression is non-nil}
3738 (wl-smtp-posting-server . "mailserver-B")
3739 (wl-nntp-posting-server . "newsserver-B")
3740 ;; @r{settings of temporary variables}
3742 ("^To: .*user@@aaa.bbb.example.com"
3743 ;; @r{applied if it matches the header of the draft buffer}
3744 ("Organization" . (format "Go %s" my-webpage)))
3745 ;; @r{you can write elisp expressions here (eval only)}
3746 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3747 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3752 The format of @code{wl-draft-config-alist} is:
3756 '(("@var{regexp of the header}" or @var{elisp expression}
3757 ("@var{Field}" . value(@var{elisp expression}))
3758 (@var{variable} . value(@var{elisp expression}))
3759 (@var{sub-function} . value(@var{elisp expression}))
3762 ("@var{regexp of the header}" or @var{elisp expression}
3763 ("@var{Field}" . value(@var{elisp expression}))
3768 Per default, there are 10 following sub-functions.
3771 'header: Inserts the specified string at the bottom of the header.
3772 'header-file: Inserts the specified file at the bottom of the header.
3773 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3774 'top: Inserts the specified string at the top of the body.
3775 'top-file: Inserts the specified file at the top of the body.
3776 'body: Replaces the body with the specified string.
3777 Specifying @code{nil} deletes the entire body string.
3778 'body-file: Replaces the body with the content of the specified file.
3779 'bottom: Inserts the specified string at the bottom of the body.
3780 'bottom-file: Inserts the specified file at the top of the body.
3781 'template: Applies the specified template.
3782 (refer to the next subsection)
3785 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3786 change them or add your own functions. If you read the code, you can
3787 easily find how to write the functions.
3789 At the first of each item, @var{a regular expression of the header} or
3790 an @var{elisp expression} should be specified. In the case of an elisp
3791 expression, the item is applied when the expression is evaluated
3794 Per default, when multiple items match or are evaluated non-nil, all
3795 such items are applied, but if you set a variable
3796 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3799 At the second of the item, a cons or a list of functions should be
3800 specified. The car part of the cons should be a header field, a
3801 variable, or a sub-function. When a header field is specified, the
3802 field will be modified. If a variable is specified, the value of the
3803 variable will be modified temporarily.
3805 In the cdr part of a cons, not only a variable but also an elisp
3806 expression can be specified as is. If the car part is a header field
3807 and the cdr part is @code{nil}, the field will be deleted.
3809 See the next example as well:
3813 (setq wl-draft-config-alist
3815 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3816 ;; @r{applied if it matches the header of the buffer being replied}
3817 (body . " Hello.\n")
3818 (template . "default")
3823 As in the (1) above, if a header regexp is prepended with @code{reply},
3824 it is applied when the draft is prepared by @code{wl-summary-reply} for
3825 example, and when it matches the header being replied. It is ignored
3826 when there is no buffer being replied, like after @code{wl-draft} was
3829 Note that @code{wl-draft-config-alist} is applied only once when
3830 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3831 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3832 aborting transmission, execute @kbd{C-c C-e}
3833 (@code{wl-draft-config-exec}) explicitly.
3835 If you don't want to apply @code{wl-draft-config-alist} when
3836 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
3840 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
3843 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3844 prepared, do the following:
3847 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3850 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
3851 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
3855 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
3858 @subsection Inserting Templates
3860 @cindex Apply Template
3862 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3863 @kbd{M-x wl-template-select} in the draft buffer.
3865 The format of @code{wl-template-alist} is almost the same as
3866 @code{wl-draft-config-alist}.
3870 (setq wl-template-alist
3873 ("Organization" . "~/.wl sample")
3874 (body . "Hello.\n"))
3876 (template . "default") ;; @r{(a)}
3877 ("To" . "boss@@example.com")
3878 ("Subject" . "Report")
3879 (body-file . "~/work/report.txt")
3885 As you can see, the only difference is item (template) names such as
3886 @samp{default} and @samp{report}, instead of a regexp of header.
3887 Because definition of each item is the same as
3888 @code{wl-draft-config-alist}, you can call another template, like (a).
3890 Executing the command @code{wl-template-select} results in template
3891 selection, but the result differs depending on variable
3892 @code{wl-template-visible-select}.
3894 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3895 window is shown below the draft buffer. You can select a template by
3896 @kbd{n} and @kbd{p} seeing the buffer window.
3898 Press the @key{RET} key and the template is actually applied to the draft
3899 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3900 adjust the window size by @code{wl-template-buffer-lines}.
3902 If @code{wl-template-visible-select} is @code{nil}, you should type the
3903 name of the template in the mini buffer.
3905 As shown in the example in @code{wl-draft-config-alist}, you can select
3906 @samp{default} template by writing:
3909 (template . "default")
3912 @subsection Sending mail by POP-before-SMTP
3913 @cindex POP-before-SMTP
3915 You can send mail by POP-before-SMTP with this single line:
3918 (setq wl-draft-send-mail-func 'wl-draft-send-mail-with-pop-before-smtp)
3922 Configure the following variables if you need.
3925 @item wl-pop-before-smtp-user
3926 The POP user name for POP-before-SMTP authentication.
3927 If unset, @code{elmo-default-pop3-user} is used.
3929 @item wl-pop-before-smtp-server
3930 The POP server name for POP-before-SMTP authentication.
3931 If unset, @code{elmo-default-pop3-server} is used.
3933 @item wl-pop-before-smtp-authenticate-type
3934 The POP authentication method for POP-before-SMTP authentication.
3935 If unset, @code{elmo-default-pop3-authenticate-type} is used.
3937 @item wl-pop-before-smtp-port
3938 The POP port number for POP-before-SMTP authentication.
3939 If unset, @code{elmo-default-pop3-port} is used.
3941 @item wl-pop-before-smtp-stream-type
3942 If non-nil, POP connection is established using SSL. If
3943 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
3944 unset, @code{elmo-default-pop3-stream-type} is used.
3947 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
3948 unset, settings for POP folders (@code{elmo-default-pop3-*}) are
3950 Therefore, if SMTP server and POP server are actually the same, and if
3951 POP folder per default (such as @samp{&}) is available, no settings are
3954 Refer to the following URL about POP-before-SMTP.
3958 http://spam.ayamura.org/tools/smPbS.html
3959 http://www.iecc.com/pop-before-smtp.html
3963 @section Key Bindings
3964 @cindex Keybind, Draft Mode
3965 @cindex Keybind, Draft Buffer
3970 @kindex C-c C-y (Draft)
3971 @findex wl-draft-yank-original
3972 Cites the content of the current message buffer.
3973 (@code{wl-draft-yank-original})
3976 @kindex C-c C-p (Draft)
3977 @findex wl-draft-preview-message
3978 Previews the content of the current draft.
3979 This is useful for previewing MIME multi-part messages.
3980 (@code{wl-draft-preview-message})
3983 @kindex C-c C-s (Draft)
3984 @findex wl-draft-send
3985 Sends the content of the current draft. Does not erase the draft buffer.
3986 This is useful for sending multiple messages, which are a little different
3988 (@code{wl-draft-send})
3991 @kindex C-c C-c (Draft)
3992 @findex wl-draft-send-and-exit
3993 Sends the content of the current draft and erases the draft buffer.
3994 (@code{wl-draft-send-and-exit})
3997 @kindex C-x C-s (Draft)
3998 @findex wl-draft-save
3999 Save the current draft.
4000 (@code{wl-draft-save})
4003 @kindex C-c C-k (Draft)
4004 @findex wl-draft-kill
4005 Kills the current draft.
4006 (@code{wl-draft-kill})
4009 @kindex C-x k (Draft)
4010 @findex wl-draft-mimic-kill-buffer
4011 Kills the current draft.
4012 (@code{wl-draft-mimic-kill-buffer})
4015 @kindex C-c C-z (Draft)
4016 @findex wl-draft-save-and-exit
4017 Saves the current draft, and erases the draft buffer.
4018 This is useful if you want to suspend editing of the draft.
4019 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4020 the @samp{+draft} folder.
4021 (@code{wl-draft-save-and-exit})
4024 @kindex C-c C-r (Draft)
4025 @findex wl-caesar-region
4026 Encodes or decodes the specified region in Caesar cipher.
4027 (@code{wl-caesar-region})
4031 @findex wl-draft-highlight-and-recenter
4032 Recenter and rehighlight current draft.
4033 (@code{wl-draft-highlight-and-recenter})
4037 @findex wl-toggle-plugged
4038 Toggles off-line/on-line states of Wanderlust.
4039 (@code{wl-toggle-plugged})
4042 @kindex C-c C-o (Draft)
4043 @findex wl-jump-to-draft-buffer
4044 Jumps to the other draft buffer, if exists.
4045 With prefix argument, reads a file (if any) from the draft folder when
4046 there is no such buffer.
4047 (@code{wl-jump-to-draft-buffer})
4050 @kindex C-c C-e (Draft)
4051 @findex wl-draft-config-exec
4052 Applies @code{wl-draft-config-alist}.
4053 (@code{wl-draft-config-exec})
4056 @kindex C-c C-j (Draft)
4057 @findex wl-template-select
4059 (@code{wl-template-select})
4062 @kindex C-c C-a (Draft)
4063 @findex wl-draft-insert-x-face-field
4064 Inserts the content of a file @file{~/.xface} (the value of the variable
4065 @code{wl-x-face-file}) as an @samp{X-Face:} field in the draft buffer.
4067 There should be encoded X-Face strings as a content of a file @file{~/.xface}.
4068 (@code{wl-draft-insert-x-face-field})
4071 @section Customizable Variables
4074 @item wl-subscribed-mailing-list
4075 @vindex wl-subscribed-mailing-list
4076 The initial setting is @code{nil}. Mailing lists to which you
4077 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4078 field of a reply draft, removes your own address from
4079 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4080 contained in @samp{To:} or @samp{Cc:} field of a message to be
4081 automatically re-filed, the destination folder will be leaned in
4082 connection with the address.
4088 (setq wl-subscribed-mailing-list
4089 '("wl@@lists.airs.net"
4091 "emacs-mime-ja@@m17n.org"))
4095 @item wl-insert-mail-followup-to
4096 @vindex wl-insert-mail-followup-to
4097 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4098 field is automatically inserted in the draft buffer.
4100 @item wl-insert-mail-reply-to
4101 @vindex wl-insert-mail-reply-to
4102 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4103 field is automatically inserted in the draft buffer.
4105 @item wl-auto-insert-x-face
4106 @vindex wl-auto-insert-x-face
4107 The initial setting is @code{t}. If non-nil and there is an encoded
4108 X-Face string in a file @file{~/.xface} (the value of the variable
4109 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4110 draft buffer. If @code{nil}, it is not automatically inserted. Press
4111 @kbd{C-c C-a} to insert.
4113 @item wl-insert-message-id
4114 @vindex wl-insert-message-id
4115 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4116 is automatically inserted on the transmission.
4118 @item wl-local-domain
4119 @vindex wl-local-domain
4120 The initial setting is @code{nil}. If @code{nil}, the return value of
4121 the function @code{system-name} will be used as the domain part of
4124 If @code{system-name} does not return FQDN (i.e. the full name of the
4125 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4126 to the string of the local domain name without hostname (like
4127 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4128 @samp{.} @code{wl-local-domain} is used as domain part of the
4131 If your terminal does not have global IP, set the value of
4132 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4133 you use invalid @samp{Message-ID:}.)
4135 Moreover, concatenation of @code{system-name} @samp{.}
4136 @code{wl-local-domain} will be used as an argument to the HELO command
4139 @item wl-message-id-domain
4140 @vindex wl-message-id-domain
4141 The initial setting is @code{nil}. If non-nil, this value is used as a
4142 domain part of the @samp{Message-ID:}. If your terminal does not have
4143 global IP address, set unique string to this value (e.x. your e-mail
4146 @item wl-message-id-domain
4147 @vindex wl-message-id-domain
4148 The initial setting is @code{nil}. If @code{nil}, the return value of
4149 the function @code{system-name} will be used as the domain part of
4150 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4151 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4152 @strong{must} set this variable to the string of the full name of the
4153 host. Otherwise, you might be beaten up on the Net News.
4155 @item wl-draft-config-alist
4156 @vindex wl-draft-config-alist
4157 The initial setting is @code{nil}. Modifies the draft message just
4158 before the transmission. The content of @code{wl-draft-config-alist}
4159 will be automatically applied only once on the transmission. If you
4160 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4163 @item wl-template-alist
4164 @vindex wl-template-alist
4165 The initial setting is @code{nil}.
4166 This variable specifies the template to be applied in the draft buffer.
4168 @item wl-draft-config-matchone
4169 @vindex wl-draft-config-matchone
4170 The initial setting is @code{nil}. If non-nil, only the first matching
4171 item is used when @code{wl-draft-config-alist} is applied. If
4172 @code{nil}, all matching items are used.
4174 @item wl-template-visible-select
4175 @vindex wl-template-visible-select
4176 The initial setting is @code{t}.
4177 If non-nil, you can preview the result of the template selection in
4180 @item wl-template-confirm
4181 @vindex wl-template-confirm
4182 The initial setting is @code{nil}.
4183 If non-nil, asks for confirmation when you press the enter key to select
4184 template while previewing.
4186 @item wl-template-buffer-lines
4187 @vindex wl-template-buffer-lines
4188 The initial setting is 7.
4189 If @code{wl-template-visible-select} is non-nil, this variable specifies
4190 the size of the preview window.
4192 @item wl-draft-reply-buffer-style
4193 @vindex wl-draft-reply-buffer-style
4194 The initial setting is @code{split}. @code{split} or @code{full} can be
4195 specified. In the case of @code{full}, the whole frame will be used for
4196 a reply draft buffer when it is prepared.
4198 @item wl-draft-use-frame
4199 @vindex wl-draft-use-frame
4200 The initial setting is @code{nil}.
4201 If non-nil, use new frame for the draft.
4203 @item wl-draft-truncate-lines
4204 @vindex wl-draft-truncate-lines
4205 The initial value is the value of @code{default-truncate-lines}.
4206 If it is non-nil, truncate long lines in draft buffer.
4210 The initial setting is the value of the variable
4211 @code{user-mail-address}. The value of this variable is inserted as a
4212 @samp{From:} field of the draft when it is prepared.
4214 @item wl-envelope-from
4215 @vindex wl-envelope-from
4216 The initial setting is @code{nil}.
4217 The value of this variable is used for envelope from (MAIL FROM).
4218 If @code{nil}, the address part of @code{wl-from} is used.
4220 @item wl-user-mail-address-list
4221 @vindex wl-user-mail-address-list
4222 The initial setting is @code{nil}.
4223 This is the User's address list. If you have multiple addresses,
4228 The initial setting is @code{nil}.
4229 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4230 the draft when it is prepared. If function is specified, its return
4235 The initial setting is @code{nil}.
4236 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4237 the draft when it is prepared.
4239 @item wl-reply-subject-prefix
4240 @vindex wl-reply-subject-prefix
4241 The initial setting is @samp{Re: }.
4242 In the @samp{Subject:} of the reply draft, this string is prepended to
4243 the @samp{Subject:} of being replied.
4245 @item wl-draft-reply-use-address-with-full-name
4246 @vindex wl-draft-reply-use-address-with-full-name
4247 The initial setting is @code{t}.
4248 If non-nil, insert her full name with address when prepare a draft for
4249 reply a message. If it is @code{nil}, insert her address only.
4251 @item wl-draft-enable-queuing
4252 @vindex wl-draft-enable-queuing
4253 The initial setting is @code{t}.
4254 This flag controls off-line transmission. If non-nil, the draft is
4257 @item wl-draft-use-cache
4258 @vindex wl-draft-use-cache
4259 The initial setting is @code{nil}. If the value is non-nil and
4260 @code{wl-insert-message-id} is nil, cache the message which is sent.
4262 @item wl-auto-flush-queue
4263 @vindex wl-auto-flush-queue
4264 The initial setting is t.
4265 This flag controls automatic transmission of the queue when Wanderlust
4266 becomes on-line. If non-nil, the queue is automatically transmitted
4267 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4268 manually, press @kbd{F} in the folder mode.
4270 @item wl-ignored-forwarded-headers
4271 @vindex wl-ignored-forwarded-headers
4272 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4273 All headers that match this regexp will be deleted when forwarding a message.
4275 @item wl-ignored-resent-headers
4276 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4277 All headers that match this regexp will be deleted when resending a message.
4279 @item wl-draft-always-delete-myself
4280 @vindex wl-draft-always-delete-myself
4281 If non-nil, always removes your own address from @samp{To:} and
4282 @samp{Cc:} when you are replying to the mail addressed to you.
4284 @item wl-draft-delete-myself-from-bcc-fcc
4285 @vindex wl-draft-delete-myself-from-bcc-fcc
4286 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4287 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4289 @item wl-smtp-posting-server
4290 @vindex wl-smtp-posting-server
4291 The initial setting is @code{nil}.
4292 This is the SMTP server name for mail transmission.
4294 @item wl-smtp-posting-user
4295 @vindex wl-smtp-posting-user
4296 The initial setting is @code{nil}.
4297 This is the user name for SMTP AUTH authentication. If @code{nil},
4298 @code{smtp-authenticate-user} is used.
4300 @item wl-smtp-authenticate-type
4301 @vindex wl-smtp-authenticate-type
4302 The initial setting is @code{nil}.
4303 This is the authentication method for SMTP AUTH authentication. If
4304 @code{nil}, @code{smtp-authenticate-type} is used. If
4305 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4308 @item wl-smtp-connection-type
4309 @vindex wl-smtp-connection-type
4310 The initial setting is @code{nil}.
4311 This variable specifies how to establish SMTP connections.
4312 If @code{nil}, @code{smtp-connection-type} is used.
4313 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4315 @item wl-nntp-posting-server
4316 @vindex wl-nntp-posting-server
4317 The initial setting is @code{nil}.
4318 This is the NNTP server name used for news submission.
4319 If @code{nil}, @code{elmo-default-nntp-server} is used.
4321 @item wl-nntp-posting-user
4322 @vindex wl-nntp-posting-user
4323 The initial setting is @code{nil}.
4324 This is the user name for AUTHINFO authentication on news submission.
4325 If @code{nil}, @code{elmo-default-nntp-user} is used.
4326 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4328 @item wl-nntp-posting-port
4329 @vindex wl-nntp-posting-port
4330 The initial setting is @code{nil}.
4331 This is the port number of the NNTP server used for news submission.
4332 If @code{nil}, @code{elmo-default-nntp-server} is used.
4334 @item wl-nntp-posting-stream-type
4335 @vindex wl-nntp-posting-stream-type
4336 The initial setting is @code{nil}.
4337 If @code{nil}, @code{elmo-default-nntp-stream-type} is evaluated. If non-nil,
4338 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4339 connection will be established.
4341 @item wl-pop-before-smtp-user
4342 @vindex wl-pop-before-smtp-user
4343 The initial setting is @code{nil}.
4344 This is the POP user name for POP-before-SMTP.
4345 If it is @code{nil}, @code{elmo-default-pop3-user} is used.
4347 @item wl-pop-before-smtp-server
4348 @vindex wl-pop-before-smtp-server
4349 The initial setting is @code{nil}.
4350 This is the POP server name for POP-before-SMTP.
4351 If it is @code{nil}, @code{elmo-default-pop3-server} is used.
4353 @item wl-pop-before-smtp-authenticate-type
4354 @vindex wl-pop-before-smtp-authenticate-type
4355 The initial setting is @code{nil}.
4356 This is the authentication method for POP-before-SMTP authentication.
4357 If it is @code{nil}, @code{elmo-default-pop3-authenticate} is used.
4359 @item wl-pop-before-smtp-port
4360 @vindex wl-pop-before-smtp-port
4361 The initial setting is @code{nil}.
4362 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4363 @code{elmo-default-pop3-port} is used.
4365 @item wl-pop-before-smtp-stream-type
4366 @vindex wl-pop-before-smtp-stream-type
4367 The initial setting is @code{nil}.
4368 This flag controls the use of SSL for POP-before-SMTP. If it is
4369 @code{nil}, @code{elmo-default-pop3-stream-type} is used. If @code{starttls},
4370 STARTTLS (RFC2595) connection will be established.
4372 @item wl-draft-queue-save-variables
4373 @vindex wl-draft-queue-save-variables
4374 Specifies a list of variable to which queued messages are saved on the
4375 off-line transmission.
4377 @item wl-draft-sendlog
4378 @vindex wl-draft-sendlog
4379 The initial setting is @code{t}.
4380 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4384 @item drafts are sent by smtp or qmail
4385 @item saved into folders by fcc
4386 @item saved into folders by queuing
4389 (it is written even if the transmission fails).
4390 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4391 and left to the logging function of @command{imput}.
4394 @item wl-draft-sendlog-max-size
4395 @vindex wl-draft-sendlog-max-size
4396 The initial setting is 20000 (in bytes).
4397 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4398 beyond the size specified by this variable.
4402 The initial setting is @code{nil}.
4403 If non-nil, address completion uses LDAP.
4405 @item wl-ldap-server
4406 @vindex wl-ldap-server
4407 The initial setting is @samp{localhost}.
4408 LDAP server name for address completion.
4411 @vindex wl-ldap-port
4412 The initial setting is @code{nil}.
4413 If non-nil, the value is used as port number.
4416 @vindex wl-ldap-base
4417 The initial setting is @samp{c=US}.
4418 LDAP search starting point (base) for address completion.
4420 @item wl-draft-remove-group-list-contents
4421 @vindex wl-draft-remove-group-list-contents
4422 The initial setting is @code{t}.
4423 If non-nil, remove the group-lists' members in the recipients when
4424 sending the message (group-list means the description such as
4425 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4428 @node Disconnected Operations, Expire and Archive, Draft, Top
4429 @chapter Off-line Management
4430 @cindex Disconnected Operations
4432 Wanderlust has on-line and off-line states.
4435 * Off-line State:: Wanderlust has on-line and off-line states.
4436 * Enable Operations:: Enable Disconeected Operations.
4437 * Plugged Mode:: Switching On-line/Off-line per Server/Port.
4438 * Off-line State settings:: Invoking Wanderlust in the Off-line State.
4439 * Variables of Plugged Mode:: Customize Plugged Mode.
4443 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4444 @section Off-line State
4446 Wanderlust has on-line and off-line states. In the off-line state, you
4447 cannot access messages via network, unless they are cached.
4449 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4450 in the mode line indicates the off-line state. In folder or summary
4451 modes, press @kbd{M-t} to switch between off- and on-line.
4453 You can invoke Wanderlust in the off-line state by setting
4454 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4456 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4457 ignores uncached messages.
4460 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4461 @section Enable Disconeected Operations
4463 Even in the off-line state, provided that relevant messages are cached,
4464 and the variable @code{elmo-enable-disconnected-operation} (described
4465 later) is non-nil, you can following operations:
4466 @xref{Plugged Mode}, @xref{Off-line State settings}.
4469 * Send Messages off-line:: Transmit Messages.
4470 * Re-file and Copy queue:: Re-file and Copy (IMAP4).
4471 * Creation of Folders:: Create Folders off-line (IMAP4).
4472 * Marking:: Mark (IMAP4).
4473 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP).
4476 As soon as Wanderlust becomes on-line, such operations invoked off-line
4477 are reflected in the servers via network.
4480 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4481 @subsection Transmission of Messages
4483 You can send mail/news messages off-line (if you are using
4484 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4485 accumulated in the queue folder, @samp{+queue}. These messages are
4486 transmitted at once when Wanderlust becomes on-line.
4488 You can visit @samp{+queue} in the off-line state and confirm content of
4489 messages in the queue. You can also remove messages. Removed messages
4490 are not transmitted even in the on-line state.
4493 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4494 @subsection Re-file and Copy (IMAP4)
4496 Re-file and copy operations to IMAP folders invoked during the off-line
4497 state are accumulated in the queue, and reflected in the server side
4498 when Wanderlust becomes on-line. If you visit destination folders after
4499 off-line re-file or copy, it looks as if messages were appended even in
4502 For the safety reasons, messages re-filed off-line are removed from
4503 source folders only if their @samp{Message-ID:} match messages on the
4504 servers. While the queue is processed, messages that failed to be
4505 re-filed or copied to the specified folders are appended to the folder
4509 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4510 @subsection Creation of Folders (IMAP4)
4512 You can create IMAP folders off-line. The creation of folders are
4513 reflected in the servers when Wanderlust becomes on-line. At that time,
4514 if folders failed to be created on the servers for any reasons, messages
4515 re-filed to such folders are appended to the folder @samp{+lost+found}.
4518 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4519 @subsection Marking (IMAP4)
4521 Off-line changes in unread/read and importance mark @samp{$} information
4522 are also reflected in the servers when Wanderlust becomes on-line.
4525 @node Pre-fetching Reservations, , Marking, Enable Operations
4526 @subsection Pre-fetching (IMAP4, NNTP)
4528 You can make reservations for pre-fetching messages in IMAP or NNTP
4529 folders. Reserved messages are marked with @samp{!} but not cached
4530 yet. When Wanderlust becomes on-line, they are pre-fetched from
4533 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4534 these off-line operations for IMAP4 and NNTP do not take place, and
4535 off-line re-file, copy or suchlike simply results in error.
4537 Because off-line operations use cache files, it is a bad idea to erase
4538 them by hand; it may cause Wanderlust to malfunction.
4540 If you want to remove caches, be sure to execute @kbd{M-x
4541 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4542 remove caches for messages relevant to off-line operations.
4545 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4546 @section Switching On-line/Off-line per Server/Port
4548 @kbd{M-t} described above switches networking states as a whole, but you
4549 can switch on-line/off-line per server/port.
4551 Pressing @kbd{C-t} in the folder or summary modes brings you in
4552 wl-plugged-mode shown below, in which you can change the plugged state
4557 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4560 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4561 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4563 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4564 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4570 The first line indicates status of the following three variables, and
4571 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
4572 column modifies the values of these variables.
4576 "Queuing" @code{wl-draft-enable-queuing}
4577 "AutoFlushQueue" @code{wl-auto-flush-queue}
4578 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4582 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4585 The second and after lines indicate on-line/off-line states of servers
4586 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4587 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4588 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4590 @dfn{sending queue} means messages accumulated in the folder
4591 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4592 off-line operations when @code{elmo-enable-disconnected-operation} is
4594 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4595 @c off-line operations are enabled.
4597 They are displayed if there are any of them. In the example above, in
4598 the sending queue there are two messages (the first and the second in
4599 the queue folder) for smtp to hosta and one (the third) for nntp to
4600 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4603 If you change @samp{(wl-plugged)} in the second line, the variable
4604 @code{wl-plugged} is changed, so that the mode line indicator and
4605 plugged states of all ports are affected. If you change plugged states
4606 of any servers or ports, @samp{(wl-plugged)} in the second line is
4607 affected depending on @code{elmo-plugged-condition} settings and the
4608 plugged state of each port.
4611 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4612 @section Invoking Wanderlust in the Off-line State
4614 As described before, if you set @code{wl-plugged} to @code{nil} in
4615 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4616 off-line state. You can specify off-line state on a per server or port
4617 basis. Refer to @code{wl-reset-plugged-alist} also.
4619 Usually, when Wanderlust starts up, the plugged state of each port is
4620 read from @file{~/.folders} and @code{wl-smtp-posting-server},
4621 @code{wl-nntp-posting-server} and so on. If you want to change the
4622 plugged state of these ports or to add other ports, configure
4623 @code{wl-make-plugged-hook} with a function.
4627 (add-hook 'wl-make-plugged-hook
4629 (elmo-set-plugged plugged-value(t/nil) server port)
4630 ;; @r{add or change plugged states of the port of the server}
4631 (elmo-set-plugged plugged-value(t/nil) server)
4632 ;; @r{if the port is omitted, all ports are affected}
4633 ;; @r{(you cannot omit the port if you newly add the server)}
4639 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4640 @section Customizable Variables
4645 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4646 mode from the beginning.
4648 @item wl-queue-folder
4649 @vindex wl-queue-folder
4650 The initial setting is @samp{+queue}.
4651 This is the folder in which messages in the transmission queue are
4654 @item wl-auto-flush-queue
4655 @vindex wl-auto-flush-queue
4656 The initial setting is @code{t}.
4657 This flag controls automatic transmission of the queue when Wanderlust
4658 becomes on-line. If non-nil, the queue is automatically transmitted
4659 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4660 manually, press @kbd{F} in the folder mode.
4662 @item elmo-enable-disconnected-operation
4663 @vindex elmo-enable-disconnected-operation
4664 The initial setting is @code{nil}. Controls off-line operations
4665 regarding IMAP4. If non-nil, off-line operations are carried out.
4667 @item elmo-lost+found-folder
4668 @vindex elmo-lost+found-folder
4669 The initial setting is @samp{+lost+found}.
4670 This is the folder to which messages are saved when they fails to be
4671 appended while the off-line re-file/copy queue is processed.
4673 @item elmo-plugged-condition
4674 @vindex elmo-plugged-condition
4675 The initial setting is @code{one}.
4676 The value of @code{wl-plugged} reflects the return value of the function
4677 @code{elmo-plugged-p} (without arguments).
4678 This variable @code{elmo-plugged-condition} specifies the condition on
4679 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4680 plugged state of each port.
4683 'one : plugged if one or more ports are plugged.
4684 'all : plugged if all ports are plugged.
4685 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4686 states of the ports.
4687 @var{function} : reflects the return value of the @var{function}
4688 functions available per default
4689 'elmo-plug-on-by-servers
4690 : reflects the plugged state of the servers specified by the
4691 variable elmo-plug-on-servers.
4692 'elmo-plug-on-by-exclude-servers
4693 : reflects the plugged state of the servers that are not
4694 in elmo-plug-on-exclude-servers.
4695 elmo-plug-on-exclude-servers defaults to
4698 (system-name)without the domain part)
4704 (setq elmo-plugged-condition 'all)
4706 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4707 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4709 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4710 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4714 @item wl-reset-plugged-alist
4715 @vindex wl-reset-plugged-alist
4716 The initial setting is @code{t}. If non-nil, plugged states are
4717 initialized on a per server or port basis when Wanderlust starts up.
4719 If @code{nil}, plugged states are retained while Emacs is running. In
4720 other words, they are initialized when Emacs is restarted even if the
4721 value is @code{nil}.
4725 @node Expire and Archive, Scoring, Disconnected Operations, Top
4726 @chapter Automatic Expiration and Archiving of Messages
4727 @cindex Expire and Archive
4730 * Expire:: Expiration and Archiving
4731 * Archive:: Archiving All Messages
4735 @node Expire, Archive, Expire and Archive, Expire and Archive
4737 @cindex Expire Message
4739 Expiration means deletion of old messages which have outlasted a
4740 certain period of time.
4742 @code{wl-expire} supports not only simple deletion, but also moving to
4743 specified archiving folders.
4747 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4748 or @kbd{M-e} in the summary mode.
4750 @subsection Configuring @code{wl-expire-alist}
4752 An example configuration of @code{wl-expire-alist} is shown below.
4753 Everything in this @code{wl-expire-alist} makes a great difference in
4754 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4755 to @code{t}, especially in the initial stage.
4759 (setq wl-expire-alist
4760 '(("^\\+trash$" (date 14) remove)
4762 ("^\\+tmp$" (date 7) trash)
4763 ;; @r{re-file to @code{wl-trash-folder}}
4764 ("^\\+outbox$" (number 300) "$outbox;lha")
4765 ;; @r{re-file to the specific folder}
4767 ;; @r{do not expire}
4768 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4769 ;; @r{archive by message number (retaining numbers)}
4770 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4771 ;; @r{archive by a fixed number (retaining numbers)}
4772 ("^\\+diary$" (date 30) wl-expire-archive-date)
4773 ;; @r{archive by year and month (numbers discarded)}
4778 Items in the list has the format of:
4781 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4785 The folder is examined if it matches @var{regexp-for-folders} from the
4786 beginning of the list. If you invoke expiration on the folder that does
4787 not match any of them, nothing will happen. And if either the second or
4788 the third element of the item is @code{nil}, expiration will not take
4791 You can use any one of the following for
4792 @var{specification-of-message-to-be-deleted}:
4795 @item (number @var{n1} [@var{n2}])
4796 deletes messages depending on the number of messages in the folder.
4798 @var{n1} is the number of messages which should survive deletion, for example
4799 if its value is 500, the newest 500 messages survive and the rests are
4802 @var{n2} is the number of messages in the folder on which expiration should
4803 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4804 folders with 510 or more messages are expired.
4805 If you configured automatic expiration, frequently used folders may
4806 expire every time it receive messages, and you may be annoyed with the
4807 long delay in reading mail.
4808 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4809 expiration would not take place until a certain number of messages
4812 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4813 with important/new/unread) are not deleted.
4814 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4815 will expire so as to have 500 messages including such ones.
4816 Otherwise, it will have 500 messages except such ones.
4818 @item (date @var{d1})
4819 deletes messages depending on the dates.
4821 Messages dated @var{d1} or more days ago are deleted, for example if its
4822 value is seven, messages seven days old or more are deleted. Note that
4823 the date is the one in the @samp{Date:} field of the message, not when
4824 the message entered the folder.
4826 Messages with no or invalid @samp{Date:} field does not expire; you
4827 might have to delete them by hand.
4830 You can use any one of the following in the place of @var{destination}:
4834 deletes the messages instantly.
4837 hide the messages from summary (messages are not deleted).
4840 moves the messages to @code{wl-trash-folder}.
4842 @item @var{string}(folder)
4843 moves the messages to the folder specified with @var{string}.
4845 It would be useful for specifying an archiving folder, but because this
4846 does not move important messages, it might be better to use the
4847 standard functions described below.
4849 @item @var{function}
4850 invokes the specified @var{function}.
4852 To the @var{function}, three arguments are passed: a folder name, a list
4853 of messages to be deleted, and msgdb information of the summary. You
4854 can specify function-specific arguments after the name of the
4855 @var{function}. Note that the list contains messages with marks in
4856 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4859 These are three standard functions; they moves messages to an archive
4860 folder in the specified way. This means old messages can be compressed
4861 and saved in a file, being deleted from the original folder.
4864 @item wl-expire-archive-number1
4865 re-files to archiving folders corresponding to the message numbers of
4866 the messages being deleted. For example, a message numbered 102 will be
4867 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4868 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4869 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4871 The archiving folders to which messages are re-filed are determined by
4872 the name of the folder as follows (in this case, archiving folders are
4873 handled as if @code{elmo-archive-treat-file} were non-nil).
4876 @item If the folder type is localdir:
4877 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4879 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4880 (@file{~/Mail/ml/wl-00100.zip}).
4882 @item The folder type is other than localdir:
4883 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4885 For example, @samp{%#mh/ml/wl} corresponds to
4886 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4889 As you can see, in the case of localdir, the folder type is not included
4890 in the path name, but otherwise it is included.
4891 And you can control the prefix to the archiving folder name by
4892 @code{wl-expire-archive-folder-prefix}.
4893 Refer to @code{wl-expire-archive-folder-prefix} for details.
4895 @item wl-expire-archive-number2
4896 re-files every certain number of messages to archiving folders.
4898 This differs from @samp{wl-expire-archive-number1} in that this re-files
4899 to the folder up to the specified number regardless of message numbers.
4900 The archiving folders to which messages are re-filed are determined in the
4901 same way as @code{wl-expire-archive-number1}.
4903 @item wl-expire-archive-date
4904 re-files messages depending on its date (year and month) to archive
4907 For example, a message dated December 1998 is re-filed to
4908 @code{$folder-199812;zip}. The name of the archiving folders except the
4909 date part are determined in the same way as
4910 @code{wl-expire-archive-number1}.
4913 You can set the first argument to these three standard functions to non-nil
4914 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4915 For example, it can be specified just after the name of the function:
4918 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4921 If you omit the argument, consecutive numbers from 1 are assigned for
4922 each archiving folder.
4925 @subsection Treatment for Important or Unread Messages
4927 If you specify any of @code{remove}, @code{trash}, a folder name, or a
4928 standard function, messages with marks in
4929 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
4930 messages} thereafter) are retained.
4932 Per default, this variable include the important, new, and unread marks,
4933 so that messages with these marks are not removed.
4934 Note that you cannot include the temporary mark (i.e. temporary marks
4935 are removed anyway), and be sure to process temporary marks before you
4938 @subsection Auto Expiration
4940 The following setup invokes expiration when you move into the summary
4941 mode. There will be no confirmation, so make sure you made no mistake
4942 in regexp and other settings before you set up this.
4946 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4950 In the folder mode, you can invoke expiration per group as well as per
4951 folder. Therefore, if you specify @samp{Desktop} group, all folders
4952 matching @code{wl-expire-alist} expire.
4956 @subsection Treating archive folders.
4957 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
4958 you must set non-nil value to @code{elmo-archive-treat-file}.
4960 @subsection Confirming
4962 If you are to use @code{remove}, try @code{trash} at first and see
4963 messages move to @code{wl-trash-folder} as expected, then replace it
4964 with @code{remove}. It would be dangerous to use @code{remove} from the
4967 If you are to use @code{wl-expire-archive-number1} and the like, try to
4968 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
4969 you can append messages to it. Even if settings in
4970 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
4971 would not be saved anywhere and disappeared in case the archiver program
4974 After you make sure you can archive to the folder correctly, you can
4975 invoke expiration and utilize the log.
4977 If you set @code{wl-expire-use-log} to @code{t},
4978 @file{~/.elmo/expired-log} should contain the log, for example:
4982 delete +ml/wl (593 594 595 596 597 598 599)
4983 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
4987 The first column indicates the operation, i.e. @samp{delete},
4988 @samp{copy}, or @samp{move}. The next is the name of the folder that
4989 expired. In the case of @samp{copy} and @samp{move}, the destination
4990 folder is recorded after @samp{->}. The last is the list of message
4991 numbers that are actually deleted or moved (in the case of @samp{copy}
4992 and @samp{move}, the number is the one in the source folder, rather than
4993 the destination folder).
4995 @subsection Re-filing Reserved Messages
4997 The three standard functions copy reserved messages to the archive
4998 folder, but do not delete them from the source folder. Because
4999 reserved messages and the like always remain, they are recorded in
5000 @file{~/.elmo/expired-alist} so that they are not copied over and over
5001 again. They are not recorded if copied by @code{wl-summary-archive}.
5003 If you enabled logging, usually @samp{move} is recorded for re-filing,
5004 but instead @samp{copy} and @samp{delete} are recorded separately if
5005 reserved messages are involved. This is because it actually copies
5006 messages including reserved, then deletes ones except reserved in that
5009 @section Customizable Variables
5012 @item wl-expire-alist
5013 @vindex wl-expire-alist
5014 The initial setting is @code{nil}.
5015 This variable specifies folders and methods to expire. For details,
5016 refer to @code{wl-expire-alist} settings above.
5018 @item wl-summary-expire-reserve-marks
5019 @vindex wl-summary-expire-reserve-marks
5020 The initial setting is the list below.
5024 (list wl-summary-important-mark
5026 wl-summary-unread-mark
5027 wl-summary-unread-uncached-mark
5028 wl-summary-unread-cached-mark)
5032 Messages with these marks are retained in the folder, even after
5034 Only permanent marks can be listed, not temporary marks.
5036 You can list marks one by one as in the default; you can use the
5037 following settings as well:
5041 All messages with permanent marks are retained,
5042 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5046 All messages are handled as usual ones that are already read, no matter
5047 what marks they have; even important messages are deleted.
5050 @item wl-expire-archive-files
5051 @vindex wl-expire-archive-files
5052 The initial setting is 100.
5053 This variable specifies the number of messages to be retained in one
5056 @item wl-expire-number-with-reserve-marks
5057 @vindex wl-expire-number-with-reserve-marks
5058 The initial setting is @code{nil}.
5059 If non-nil, if expiring messages are specified by @code{number},
5060 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5062 @item wl-expire-archive-get-folder-func
5063 @vindex wl-expire-archive-get-folder-func
5064 The initial setting is @code{wl-expire-archive-get-folder}.
5066 This variable specifies a function that returns the name of an archiving
5067 folder for standard functions in the place of @var{destination}.
5068 You can use the following three variables for simple modification of
5069 folder names; if you want more complex settings, define your own
5070 function in this variable.
5072 @code{wl-expire-archive-get-folder} can be customized by these
5075 @item @code{wl-expire-archive-folder-name-fmt}
5076 @item @code{wl-expire-archive-folder-type}
5077 @item @code{wl-expire-archive-folder-prefix}
5080 @item wl-expire-archive-folder-name-fmt
5081 @vindex wl-expire-archive-folder-name-fmt
5082 The initial setting is @samp{%s-%%05d;%s}.
5083 This is a @code{format} string for archiving folders used in
5084 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5085 Note that you must specify the message number by @samp{%%d}, because it
5086 is parsed twice by @code{format}.
5088 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5091 @item wl-expire-archive-date-folder-name-fmt
5092 @vindex wl-expire-archive-date-folder-name-fmt
5093 The initial setting is @samp{%s-%%04d%%02d;%s}.
5094 This is a @code{format} string for archiving folders used in
5095 @code{wl-expire-archive-date}. Note that you must specify the message
5096 number by @samp{%%d}, because it is parsed twice by @code{format}.
5097 There should be @samp{%%d} twice, one for the year and the other for the
5100 If you modify this, adjust
5101 @code{wl-expire-archive-date-folder-num-regexp} as well.
5103 @item wl-expire-archive-folder-type
5104 @vindex wl-expire-archive-folder-type
5105 The initial setting is @code{zip}.
5106 This variable specifies an archiver type of the archiving folders.
5108 @item wl-expire-archive-folder-prefix
5109 @vindex wl-expire-archive-folder-prefix
5110 The initial setting is @code{nil}.
5111 This variable specifies the prefix (directory structure) to archiving
5113 Exercise extreme caution in using this feature, as it has not been
5115 In the worst case, there is a fear of destructing archiving folders.
5119 There will be no prefix.
5122 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5123 @samp{$ml/wl-00000;zip;wl}.
5126 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5129 @samp{$ml/wl-00000;zip;ml/wl}.
5132 @item wl-expire-archive-folder-num-regexp
5133 @vindex wl-expire-archive-folder-num-regexp
5134 The initial setting is @samp{-\\([-0-9]+\\);}.
5135 This variable specifies the regular expression to be used for getting
5136 message numbers from multiple archiving folders specified by
5137 @code{elmo-list-folders}.
5138 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5140 @item wl-expire-archive-date-folder-num-regexp
5141 @vindex wl-expire-archive-date-folder-num-regexp
5142 The initial setting is @samp{-\\([-0-9]+\\);}.
5143 This is the regular expression to be used for getting message numbers
5144 from multiple archiving folders specified by @code{elmo-list-folders}.
5145 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5147 @item wl-expire-delete-oldmsg-confirm
5148 @vindex wl-expire-delete-oldmsg-confirm
5149 The initial setting is @code{t}.
5150 If non-nil, messages older than the one with the largest number will be
5151 deleted with confirmation.
5152 If @code{nil}, they are deleted without confirmation.
5154 This feature is valid only if non-nil is specified as a argument to the
5155 standard functions so as to retain numbers.
5157 @item wl-expire-use-log
5158 @vindex wl-expire-use-log
5159 The initial setting is @code{nil}.
5160 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5161 They are appended but not truncated or rotated automatically; you might
5162 need to remove it manually.
5164 @item wl-expire-add-seen-list
5165 @vindex wl-expire-add-seen-list
5166 The initial setting is @code{t}.
5168 If non-nil, when messages are re-filed by expiration, read/unread
5169 information is passed to the destination folder.
5171 However if you do not read the destination folder from Wanderlust,
5172 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5173 want to set this to @code{nil} if you are simply saving to some
5174 archiving folders. Even if its value is @code{nil}, messages in the
5175 archiving folders are simply treated as unread; it does not affect
5178 @item wl-expire-folder-update-msgdb
5179 @vindex wl-expire-folder-update-msgdb
5180 The initial setting is @code{t}.
5181 If @code{t}, in the folder mode, expiration is carried out after
5182 updating summary information. If you specified a list of regular
5183 expressions of folder names, summary information is updated for matching
5188 @node Archive, , Expire, Expire and Archive
5189 @section Archiving Messages
5191 @subsection Archiving Messages
5192 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5193 folders. If there are the archiving folders already, only new messages
5196 You can use @code{wl-archive-alist} in order to specify how messages are
5197 archived according to their folder names, as in @code{wl-expire-alist}.
5202 (setq wl-archive-alist
5203 '(("^\\+tmp$" wl-archive-date)
5204 ("^\\+outbox$" wl-archive-number2)
5205 (".*" wl-archive-number1)))
5209 Each item in the list has the following format:
5212 (@var{folders-regexp} @var{deleting-function})
5215 As you can see, you can only use a function after @var{folders-regexp}.
5216 Per default, there are three functions:
5219 @item @code{wl-archive-number1}
5220 @item @code{wl-archive-number2}
5221 @item @code{wl-archive-date}
5224 As inferred from their names, they work similarly to "expire" versions,
5225 other than the following points:
5228 @item No messages are deleted
5229 @item Message numbers are retained even if invoked without arguments
5232 These functions are good to archive all messages in a folder by their
5233 numbers or by their dates.
5234 These are also useful for backup or confirmation purposes before
5236 If you try to re-file them after they are archived, they are deleted but
5239 Per default, the archiving folders to which messages are copied are
5240 determined automatically by @code{wl-expire-archive-get-folder-func}.
5241 You can copy to a specific folder by invoking with a prefix argument,
5242 i.e. @kbd{C-u M-x wl-summary-archive}.
5244 Note that this feature has not been seriously tested, because you can
5245 simply copy to an archiving folder, for example by
5246 @code{wl-summary-copy-region}.
5248 The archiving folders are determined by the same logic as in
5249 @code{wl-summary-expire}; the following customizable variables are
5253 @item @code{wl-expire-archive-files}
5254 @item @code{wl-expire-archive-get-folder-func}
5255 @item @code{wl-expire-archive-folder-name-fmt}
5256 @item @code{wl-expire-archive-folder-type}
5257 @item @code{wl-expire-archive-folder-prefix}
5258 @item @code{wl-expire-archive-folder-num-regexp}
5261 @subsection Customizable Variables
5264 @item wl-archive-alist
5265 @vindex wl-archive-alist
5266 The initial setting is the list shown below:
5270 ((".*" wl-archive-number1))
5275 This variable specifies a function that copies to archiving folders.
5276 To the function, three arguments are passed: a folder name, a list of
5277 messages in the folder, and msgdb information of the summary.
5278 Needless to say, you can use your own function.
5282 @node Scoring, Customization, Expire and Archive, Top
5283 @chapter Score of the Messages
5285 @c @cindex Kill File
5287 Scoring is the function that associates a score (value) with each
5288 message, and marks as read or deletes from the summary according to it.
5290 You can put target or important marks on essential messages, or read marks
5291 on the ones you do not want to read, for example spam articles.
5293 This scoring function has a capability and a format similar to the one
5294 that Gnus has, although there are some unsupported features and
5295 Wanderlust specifics.
5296 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5299 * Score Commands:: Score Commands
5300 * Score File Format:: Score File Format
5304 @node Score Commands, Score File Format, Scoring, Scoring
5305 @section Score Commands
5306 @cindex Score Commands
5308 @subsection Score File Specification
5310 @code{wl-score-folder-alist} specifies score files or variables in which
5311 scores are defined, corresponding to folder names.
5315 (setq wl-score-folder-alist
5324 If paths to the score files are omitted, the directory specified in the
5325 variable @code{wl-score-files-dir} is assumed.
5327 No matter what you write in @code{wl-score-folder-alist}, the default
5328 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5329 read (it does not have to exist).
5330 Therefore, in the example above, the three score files,
5331 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5332 the folders that matches @samp{^-.*}.
5334 @subsection Scored Messages
5336 Scores are attached to the messages that are specified by
5337 @code{wl-summary-score-marks} temporarily when the summary is updated;
5338 when you exit from the summary, the scores are removed and reverts to
5341 @subsection Creation of Score Files
5343 In the summary buffer, move to an appropriate message and type @kbd{L}.
5344 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5345 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5347 This makes @minus{}1000 are scored for messages with the same
5348 @samp{Subject:} as the string you entered. That is, such a score file
5349 is created automatically.
5351 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5352 The score file you just made appears.
5353 This buffer is called @dfn{score editing buffer} thereafter.
5354 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5355 as you are previously; type @kbd{a}. Then a score entry for "From"
5357 In this way, you can create a score file easily either in the summary
5358 buffer or in the score editing buffer.
5360 By the way, you might be aware the numbers of key strokes are different
5361 between @kbd{s s p} and @kbd{a}.
5362 This is determined by @code{wl-score-header-default-entry}.
5363 This variable specifies the default score entries corresponding to
5365 For example, for "subject" field, a type and a time limit are prompted,
5366 but for "from" field, they are fixed upon automatically as substring and
5367 permanent respectively.
5368 However, score values can be modified by the prefix argument.
5369 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5372 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5373 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5374 erasing contents of the buffer deletes the score file being edited.
5378 @subsubsection Selecting Score Files
5380 You can change score files to which scores are appended by
5381 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5382 @code{wl-score-change-score-file}.
5384 @subsubsection Summing Up the Score
5386 If you add the same entries by @code{wl-summary-increase-score},
5387 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5388 scores for the entry is summed up.
5390 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5391 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5392 @minus{}1200 will be created as a result.
5394 @subsubsection Creating Thread Key
5396 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5397 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5399 @subsubsection Creating Followup Key
5401 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5402 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5403 at the cursor to @samp{References} key.
5404 If @code{wl-score-auto-make-followup-entry} is non-nil,
5405 @samp{Message-ID} of all messages to be followed up within dates
5406 specified by @code{wl-score-expiry-days}.
5408 @subsection Key Bindings
5413 @findex wl-summary-increase-score
5414 Increases the score for the current message.
5415 And the score entry is appended to the score file at the same moment.
5416 You can specify the score value by a prefix argument.
5420 @findex wl-summary-lower-score
5421 Decreases the score for the current message.
5422 And the score entry is appended to the score file at the same moment.
5423 You can specify the score value by a prefix argument.
5426 @kindex h R (Summary)
5427 @findex wl-summary-rescore
5428 Re-applies the scoring.
5429 However, already scored messages are not scored anew.
5432 @kindex h c (Summary)
5433 @findex wl-score-change-score-file
5434 Changes the score file currently selected.
5437 @kindex h e (Summary)
5438 @findex wl-score-edit-current-scores
5439 Edits the score file currently selected.
5440 If there are multiple score files, the previously specified one is
5444 @kindex h f (Summary)
5445 @findex wl-score-edit-file
5446 Edits an arbitrary score file and selects it.
5449 @kindex h F (Summary)
5450 @findex wl-score-flush-cache
5451 Erases caches associated to the score files that are read.
5452 If you modified score files directly (from other than Wanderlust), you
5453 need to re-read them after erasing the cache.
5456 @kindex h m (Summary)
5457 @findex wl-score-set-mark-below
5458 Specifies the criterion for scores to be marked as read.
5459 Messages with scores less than this value are marked as read.
5462 @kindex h x (Summary)
5463 @findex wl-score-set-expunge-below
5464 Specifies the criterion for scores to be deleted from the summary.
5465 Messages with scores less than this value are deleted.
5466 "Deleted" means it is not shown; they are not removed from the summary
5467 information or the folder.
5468 The deleted messages can be shown by rescan-noscore again.
5471 @subsection Key Bindings in the Score Editing Buffer
5475 @kindex C-c C-k (Score Mode)
5476 @findex wl-score-edit-kill
5477 Abandons the file being edited.
5480 @kindex C-c C-c (Score Mode)
5481 @findex wl-score-edit-exit
5482 Saves the file being edited, and quits from the edit mode.
5485 @kindex C-c C-p (Score Mode)
5486 @findex wl-score-pretty-print
5490 @kindex C-c C-d (Score Mode)
5491 @findex wl-score-edit-insert-date
5492 Inserts the number of dates from Dec. 31, 1 B.C.
5493 It is used for creating the third factor of time-limited scores.
5496 @kindex C-c C-s (Score Mode)
5497 @findex wl-score-edit-insert-header
5498 Inserts the header of the message selected in the summary buffer.
5501 @kindex C-c C-e (Score Mode)
5502 @findex wl-score-edit-insert-entry
5503 Inserts the score entry of the message selected in the summary buffer.
5506 @subsection Customizable Variables
5509 @item wl-summary-default-score
5510 @vindex wl-summary-default-score
5511 The initial setting is 0 (zero).
5512 This variable specifies the default value of the score.
5513 The score is increased or decreased based upon this value.
5515 @item wl-summary-important-above
5516 @vindex wl-summary-important-above
5517 The initial setting is @code{nil}.
5518 Messages with scores larger than this value are attached with the
5519 important mark (@samp{$}).
5520 If @code{nil}, no important marks are attached.
5522 @item wl-summary-target-above
5523 @vindex wl-summary-target-above
5524 The initial setting is @code{nil}.
5525 Messages with scores larger than this value are attached with the target
5527 If @code{nil}, no target marks are attached.
5529 @item wl-summary-mark-below
5530 @vindex wl-summary-mark-below
5531 The initial setting is 0 (zero).
5532 Messages with scores smaller than this value are marked as read.
5534 @item wl-summary-expunge-below
5535 @vindex wl-summary-expunge-below
5536 The initial setting is @code{nil}.
5537 Messages with scores smaller than this value are deleted from the
5539 If @code{nil}, they are not deleted.
5541 @item wl-summary-score-marks
5542 @vindex wl-summary-score-marks
5543 The initial setting is the list shown below:
5547 (list wl-summary-new-mark)
5552 Messages with these marks are scored.
5554 @item wl-use-scoring
5555 @vindex wl-use-scoring
5556 The initial setting is t.
5557 If non-nil, scoring is enabled.
5559 @item wl-score-files-dir
5560 @vindex wl-score-files-dir
5561 The initial setting is @file{~/.elmo/}.
5562 The default directory for score files.
5564 @item wl-score-interactive-default-score
5565 @vindex wl-score-interactive-default-score
5566 The initial setting is 1000.
5567 This value is used as a score when a score factor is @code{nil} in the
5568 score file. It is also used in @code{wl-summary-increase-score} and
5569 @code{wl-summary-lower-score}, on condition that the value of
5570 @code{wl-score-header-default-entry} is @code{nil}.
5572 @item wl-score-expiry-days
5573 @vindex wl-score-expiry-days
5574 The initial setting is 7.
5575 This is the number of days before time-limited scores are deleted.
5577 @item wl-score-update-entry-dates
5578 @vindex wl-score-update-entry-dates
5579 The initial setting is @code{t}.
5580 If non-nil, it enables deletion of time-limited scores.
5582 @item wl-score-header-default-entry
5583 @vindex wl-score-header-default-entry
5584 Specifies the default value for each header field for score entries
5585 created by @code{wl-summary-increase-score},
5586 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5588 @item wl-score-simplify-fuzzy-regexp
5589 @vindex wl-score-simplify-fuzzy-regexp
5590 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5591 regular expression to be deleted from the string.
5592 Because this is usually used for Subject, the default is prefixes that
5593 are attached by mailing list programs.
5595 @item wl-summary-rescore-partial-threshold
5596 @vindex wl-summary-rescore-partial-threshold
5597 The initial setting is 200.
5598 When sync-all or rescan is executed, if there are messages more than
5599 this value, only the last same number of messages as this value are
5602 @item wl-summary-auto-sync-marks
5603 @vindex wl-summary-auto-sync-marks
5604 If non-nil, unread/important marks are synchronized when the summary
5606 Unread marks reflect information on the IMAP4 server.
5607 Important marks reflect information on the IMAP4 server (flagged or
5608 not), and contents of @samp{'mark} folder.
5609 The initial setting is @code{t}.
5613 @node Score File Format, , Score Commands, Scoring
5614 @section Score File Format
5615 @cindex Score File Format
5617 The format of score files are the same as Gnus, and basically you can
5618 use Gnus score files as they are. But they are not fully compatible
5619 because some keys are not supported and there are Wanderlust specifics.
5620 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5625 ("for sale" -1000 nil s)
5626 ("profit" -1000 nil s))
5628 ("spam@@spamspamspam" -10000 nil s))
5630 ("my@@address" 3001 nil s))
5632 (1000000 -10 nil >))
5642 If the key is a string, it is the name of the header to be matched.
5643 The following keys are available:
5644 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5645 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5646 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5647 @code{Chars} and @code{Lines} mean the size and the number of lines of
5648 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5649 are described later.
5650 The rest corresponds the field of the same name.
5652 Arbitrary numbers of core entries are specified after the key.
5653 Each score entry consists of these five factors:
5657 A factor that matches header. This should be a number in the cases of
5658 @code{lines} and @code{chars}, otherwise a string.
5661 A score factor. When the first item matches, the score of the message
5662 is increased or decreased by this value.
5665 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5666 of a number, the score is deleted if it does not match for days
5667 (@code{wl-score-expiry-days}) from the date specified by this.
5668 The date is since Dec. 31, 1 B.C.
5671 A type factor. This specifies the way the first factor matches.
5672 Available types depend on keys.
5675 @item From, Subject, References, Message-ID
5676 For these keys in string, @code{r} and @code{R} (regexp),
5677 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5678 as well as @code{f} and @code{F} (fuzzy) can be used.
5679 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5682 For these keys, the following five numerical relative operators can be
5683 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5686 This key matches @code{From} header, and scores all follow-ups to the
5688 For example, it would be useful for increasing scores for follow-ups to
5691 You can use the same types as @code{From} except for @code{f}.
5692 And a @samp{Followup} entry is automatically appended to the score file.
5695 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5696 A @samp{Thread} entry is automatically appended for each article that
5697 has @var{x} in the @code{References} header.
5698 You can make sure the whole thread including messages that does not have
5699 all ancestors @code{Message-ID} in @code{References} is scored.
5701 You can use the same types as @code{References} except for @code{f}.
5702 And a @samp{Thread} entry is automatically appended to the score file.
5706 A factor for extension header. This is meaningful only if the key is
5708 This specifies headers to be matched other than standard headers like
5709 @code{Subject} and @code{From}.
5710 Note that you should specify the header in
5711 @code{elmo-msgdb-extra-fields} also.
5712 Therefore it does not work in folders where extension headers cannot be
5717 The sum of these scores @emph{after all factors are applied} becomes the
5718 score of the message.
5720 @cindex Score File Atoms
5722 Messages with a score less than this value is marked as read.
5723 The default is @code{wl-summary-mark-below}.
5726 Messages with a score less than this value is deleted from the summary.
5727 The default is @code{wl-summary-expunge-below}.
5729 @item mark-and-expunge
5730 Both @code{mark} and @code{expunge} are applied,
5731 i.e. messages with a score less than this value is marked as read and
5732 deleted from the summary.
5735 Messages with a score greater than this value is attached with temp
5737 The default is @code{wl-summary-target-above}.
5740 Messages with a score greater than this value is attached with important
5742 The default is @code{wl-summary-important-above}.
5747 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5748 are used, you need to set @code{elmo-msgdb-extra-fields}.
5751 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5754 There are other restrictions as shown below:
5757 @item Because @samp{References} field in the summary information
5758 contains only the last @samp{Message-ID}, @code{references} key matches
5762 Keys that can be seen by folder of types:
5766 chars lines xref extra
5767 localdir,localnews Y E E E
5768 nntp (supporting xover) Y E E N
5774 N: cannot be seen (ignored)
5775 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5780 @node Customization, Mailing List, Scoring, Top
5781 @chapter Customizing Wanderlust
5782 @cindex Customization
5785 * Living with other packages:: Living with other packages
5786 * Highlights:: Highlights
5787 * Biff:: Notify Mail arrival
5788 * Advanced Settings:: Advanced Settings
5789 * Customizable Variables:: Customizable Variables
5794 @node Living with other packages, Highlights, Customization, Customization
5795 @section Living with other packages
5797 Examples with other packages.
5800 * imput:: imput (im-wl.el)
5802 * supercite:: supercite.el
5803 * mu-cite:: mu-cite.el
5804 * x-face-mule:: x-face-mule.el
5805 * dired-dd:: dired-dd.el
5807 * mime-w3m:: mime-w3m.el
5811 @node imput, BBDB, Living with other packages, Living with other packages
5816 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5819 If @command{imput} is on the @code{exec-path} at the installation,
5820 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
5824 (autoload 'wl-draft-send-with-imput-async "im-wl")
5825 (setq wl-draft-send-func 'wl-draft-send-with-imput-async)
5830 @node BBDB, supercite, imput, Living with other packages
5834 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
5837 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
5838 byte-compiled and installed.
5846 ;; @r{enable pop-ups}
5847 (setq bbdb-use-pop-up t)
5848 ;; @r{auto collection}
5849 (setq bbdb/mail-auto-create-p t)
5850 (setq signature-use-bbdb t)
5851 (setq bbdb-north-american-phone-numbers-p nil)
5852 ;; @r{shows the name of bbdb in the summary} :-)
5853 (setq wl-summary-from-func 'bbdb-wl-from-func)
5854 ;; @r{automatically add mailing list fields}
5855 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
5856 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
5860 @node supercite, mu-cite, BBDB, Living with other packages
5861 @subsection sc.el(supercite), sc-register.el
5865 The same setting as usual mailers should be OK. The following is an
5866 example of settings:
5870 (autoload 'sc-cite-original "sc" nil t)
5871 (setq mail-yank-hooks 'sc-cite-original)
5872 (setq sc-preferred-header-style 1)
5873 (setq sc-electric-references-p nil)
5874 (setq sc-citation-leader "")
5875 (setq sc-load-hook '(lambda () (require 'sc-register)))
5876 (setq sc-preferred-attribution 'registeredname)
5881 @node mu-cite, x-face-mule, supercite, Living with other packages
5882 @subsection mu-cite.el
5885 The same setting as usual mailers should be OK. The following is an
5886 example of settings.
5888 If you use mu-cite version 8.0 or earlier:
5892 (autoload 'mu-cite/cite-original "mu-cite" nil t)
5893 (setq mail-citation-hook 'mu-cite/cite-original)
5897 If you use mu-cite version 8.1 or later:
5901 (autoload 'mu-cite-original "mu-cite" nil t)
5902 (add-hook 'mail-citation-hook (function mu-cite-original))
5906 @node x-face-mule, dired-dd, mu-cite, Living with other packages
5907 @subsection x-face-mule.el
5911 It depends on the version of x-face-mule.
5912 If you use x-face-mule 0.19 or older, do the following:
5916 (setq wl-highlight-x-face-func
5918 (lambda (&optional beg end)
5919 (x-face-mule:x-face-decode-message-header))))
5920 (require 'x-face-mule)
5924 If you use x-face-mule 0.20 or later, try the following:
5928 (setq wl-highlight-x-face-func
5930 (lambda (&optional beg end)
5931 (x-face-mule-x-face-decode-message-header))))
5932 (require 'x-face-mule)
5936 Use these settings when you use @file{x-face-mule.el} attached to
5937 bitmap-mule 8.0 or later:
5941 (autoload 'x-face-decode-message-header "x-face-mule")
5942 (setq wl-highlight-x-face-func 'x-face-decode-message-header)
5946 If there is an encoded X-Face string in a file @file{~/.xface} (the
5947 value of the variable @code{wl-x-face-file}), it is inserted as a
5948 @samp{X-Face:} field in the draft buffer (if
5949 @code{wl-auto-insert-x-face} is non-nil).
5952 @node dired-dd, MHC, x-face-mule, Living with other packages
5953 @subsection dired-dd(Dired-DragDrop)
5954 @pindex Dired-DragDrop
5956 @cindex Drag and Drop
5958 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
5959 compose multi-part by simple Drag-and-Drop from dired to the draft
5960 buffer being edited in GNU Emacs (this feature is not Wanderlust
5961 specific, but general-purpose for tm/SEMI).
5965 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
5971 ;; @r{Set dired-x variables here.}
5972 ;; @r{To and flo@dots{}}
5974 (progn (require 'dired-dd)
5975 (require 'dired-dd-mime))))))
5979 @node MHC, mime-w3m, dired-dd, Living with other packages
5983 Message Harmonized Calendaring system
5984 (@uref{http://www.quickhack.net/mhc/})
5986 By using MHC, you can make a calendar from the messages.
5992 (setq mhc-mailer-package 'wl)
5993 (autoload 'mhc-mode "mhc" nil t)
5994 (add-hook 'wl-summary-mode-hook 'mhc-mode)
5995 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6003 (autoload 'mhc-wl-setup "mhc-wl")
6004 (add-hook 'wl-init-hook 'mhc-wl-setup)
6008 @node mime-w3m, , MHC, Living with other packages
6009 @subsection mime-w3m.el
6012 You can display html part by using @file{mime-w3m.el}
6013 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6014 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6017 @node Highlights, Biff, Living with other packages, Customization
6020 @subsection Customizable Variables
6023 @item wl-summary-highlight
6024 @vindex wl-summary-highlight
6025 The initial setting is @code{t}.
6026 If non-nil, the summary is highlighted.
6028 @item wl-highlight-max-summary-lines
6029 @vindex wl-highlight-max-summary-lines
6030 The initial setting is 10000.
6031 The summary is not highlighted if it has more lines than this value.
6033 @item wl-summary-highlight-partial-threshold
6034 @vindex wl-summary-highlight-partial-threshold
6035 The initial setting is 1000.
6036 This is a threshold whether the whole summary is highlighted.
6037 If there are more lines of messages in the summary, it is partially
6040 @item wl-summary-partial-highlight-above-lines
6041 @vindex wl-summary-partial-highlight-above-lines
6042 The initial setting is 30. If there are more lines of messages than
6043 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6044 after the point that is the same number of lines as this value above the
6045 cursor line are highlighted partially. (If this value is @code{nil},
6046 the last same number of lines as the value of
6047 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6049 @item wl-highlight-body-too
6050 @vindex wl-highlight-body-too
6051 The initial setting is @code{t}.
6052 If non-nil, bodies of drafts and messages are also highlighted.
6054 @item wl-highlight-message-header-alist
6055 @vindex wl-highlight-message-header-alist
6056 When highlighting headers of drafts and messages, this variable
6057 specifies which faces are allocated to important
6058 (@code{wl-highlight-message-important-header-contents}), secondly
6059 important (@code{wl-highlight-message-important-header-contents2}), and
6060 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6062 Similarly, it can be used for allocating arbitrary faces to arbitrary
6063 regular expressions.
6065 @item wl-highlight-citation-prefix-regexp
6066 @vindex wl-highlight-citation-prefix-regexp
6067 Specifies a regular expression to which quoted lines in bodies of
6068 drafts and messages match.
6069 Bodies matching to this regular expression are highlighted by the faces
6070 specified by (@code{wl-highlight-message-cited-text-*}).
6072 @item wl-highlight-highlight-citation-too
6073 @vindex wl-highlight-highlight-citation-too
6074 The initial setting is @code{nil}.
6075 If non-nil, the quoting regular expression itself given by
6076 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6078 @item wl-highlight-citation-header-regexp
6079 @vindex wl-highlight-citation-header-regexp
6080 Specifies a regular expression that denotes beginning of quotation.
6081 Bodies matching to this regular expression are highlighted by the face
6082 specified by @code{wl-highlight-message-headers}.
6084 @item wl-highlight-max-header-size
6085 @vindex wl-highlight-max-header-size
6086 The initial setting is @code{nil}. If a header size is larger than this
6087 value, it will not be highlighted. If @code{nil}, always highlighted
6088 (ignore header size).
6090 @item wl-highlight-max-message-size
6091 @vindex wl-highlight-max-message-size
6092 The initial setting is 10000.
6093 If a message is larger than this value, it will not be highlighted.
6094 With this variable, highlight is suppressed for uuencode or huge digest
6097 @item wl-highlight-signature-separator
6098 @vindex wl-highlight-signature-separator
6099 Specifies regular expressions that denotes the boundary of a signature.
6100 It can be a regular expression, or a list of ones.
6101 Messages after the place that matches this regular expression are
6102 highlighted by the face specified by
6103 @code{wl-highlight-message-signature}.
6105 @item wl-max-signature-size
6106 @vindex wl-max-signature-size
6107 The initial setting is 400.
6108 This is the largest size for a signature to be highlighted.
6110 @item wl-use-highlight-mouse-line
6111 @vindex wl-use-highlight-mouse-line
6112 The initial setting is @code{t}.
6113 If non-nil, the line pointed by the mouse is highlighted in the folder
6114 mode, summary mode, and the like.
6117 @subsection Setting Colors and Fonts of the Characters
6119 If you want to change colors or fonts of the characters, you need to
6120 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6121 want to change fonts, and @code{set-face-foreground} for colors, and so
6122 on. You cannot write face settings in @file{.emacs}; write in
6125 For example, if you want to change the color for signatures to yellow,
6129 (set-face-foreground 'wl-highlight-message-signature "yellow")
6135 Faces defined in Wanderlust:
6138 @item wl-highlight-message-headers
6139 The face for field names of message headers.
6141 @item wl-highlight-message-header-contents
6142 The face for field bodies of message headers.
6144 @item wl-highlight-message-important-header-contents
6145 The face for important parts of message headers.
6146 Per default, this face is used for a body of @samp{Subject:} field.
6147 You can change its value by editing
6148 @code{wl-highlight-message-header-alist}.
6150 @item wl-highlight-message-important-header-contents2
6151 The face for secondly important parts of message headers.
6152 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6153 fields. You can change its value by editing
6154 @code{wl-highlight-message-header-alist}.
6156 @item wl-highlight-message-unimportant-header-contents
6157 The face for unimportant parts of message headers.
6158 Per default, this face is used for bodies of @samp{X-} fields
6159 @samp{User-Agent:} fields. You can change its value by editing
6160 @code{wl-highlight-message-header-alist}.
6162 @item wl-highlight-message-citation-header
6163 The face for headers of quoted messages.
6165 @item wl-highlight-message-cited-text-*
6166 The face for texts of quoted messages. The last @samp{*} is a
6167 @var{single figure} so that 10 different colors can be used according to
6170 @item wl-highlight-message-signature
6171 The face for signatures of messages. The initial settings are
6172 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6173 dark background colors.
6175 @item wl-highlight-header-separator-face
6176 The face for header separators of draft messages.
6178 @item wl-highlight-summary-important-face
6179 The face for message lines with important marks in the summary.
6181 @item wl-highlight-summary-new-face
6182 The face for message lines with new marks in the summary.
6184 @item wl-highlight-summary-displaying-face
6185 The face for the message line that is currently displayed.
6186 This face is overlaid.
6188 @item wl-highlight-thread-indent-face
6189 The face for the threads that is currently displayed.
6191 @item wl-highlight-summary-unread-face
6192 The face for message lines with unread marks in the summary.
6194 @item wl-highlight-summary-deleted-face
6195 The face for message lines with delete marks in the summary.
6197 @item wl-highlight-summary-refiled-face
6198 The face for message lines with re-file marks in the summary.
6200 @item wl-highlight-refile-destination-face
6201 The face for re-file information part of message lines with re-file
6202 marks in the summary.
6204 @item wl-highlight-summary-copied-face
6205 The face for message lines with copy marks in the summary.
6207 @item wl-highlight-summary-target-face
6208 The face for message lines with target marks @samp{*} in the summary.
6210 @item wl-highlight-summary-thread-top-face
6211 The face for message lines that are on the top of the thread in the
6214 @item wl-highlight-summary-normal-face
6215 The face for message lines that are not on top of the thread in the
6218 @item wl-highlight-folder-unknown-face
6219 The face for folders that are not known to have how many unsync messages
6222 @item wl-highlight-folder-zero-face
6223 The face for folders that have no unsync messages in the folder mode.
6225 @item wl-highlight-folder-few-face
6226 The face for folders that have some unsync messages in the folder mode.
6228 @item wl-highlight-folder-many-face
6229 The face for folders that have many unsync messages in the folder mode.
6230 The boundary between `some' and `many' is specified by the variable
6231 @code{wl-folder-many-unsync-threshold}.
6233 @item wl-highlight-folder-unread-face
6234 The face for folders that have no unsync but unread messages in the
6237 @item wl-highlight-folder-killed-face
6238 The face for folders that are deleted from the access group in the
6241 @item wl-highlight-folder-opened-face
6242 The face for open groups in the folder mode.
6243 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6244 @code{nil} or a @var{number}.
6246 @item wl-highlight-folder-closed-face
6247 The face for close groups in the folder mode.
6248 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6249 @code{nil} or a @var{number}.
6251 @item wl-highlight-folder-path-face
6252 The face for the path to the currently selected folder in the folder
6255 @item wl-highlight-logo-face
6256 The face for logo in the demo.
6258 @item wl-highlight-demo-face
6259 The face for strings (for example, a version number) in the demo.
6263 @node Biff, Advanced Settings, Highlights, Customization
6264 @section Notify Mail arrival
6267 Following setting is to notify mail arrival of @samp{%inbox}
6268 by the indicator on the modeline
6271 (setq wl-biff-check-folder-list '("%inbox"))
6274 @subsection Customizable Variables
6276 @item wl-biff-check-folder-list
6277 @vindex wl-biff-check-folder-list
6278 The initial setting is @code{nil}.
6279 This is the list of folders to check mail arrival.
6280 If @code{nil}, wl doesn't check mail arrival.
6282 @item wl-biff-check-interval
6283 @vindex wl-biff-check-interval
6284 The initial setting is 40 (in seconds).
6285 Check mail arrival in this period.
6287 @item wl-biff-notify-hook
6288 @vindex wl-biff-notify-hook
6289 This hook is run at the arrival of new mail.
6290 To beep with mail arrival(initial setting), set as follows.
6292 (setq wl-biff-notify-hook '(ding))
6294 For silence, set to @code{nil}.
6298 @node Advanced Settings, Customizable Variables, Biff, Customization
6299 @section Advanced Settings
6302 * Draft for Reply:: Draft for Reply
6303 * Thread Format:: Appearance of Thread
6304 * User-Agent Field:: @samp{User-Agent:} Header Field
6308 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6309 @subsection Draft for Replay
6310 @vindex wl-draft-reply-with-argument-list
6311 @vindex wl-draft-reply-without-argument-list
6312 @vindex wl-draft-reply-myself-with-argument-list
6313 @vindex wl-draft-reply-myself-without-argument-list
6315 If you want, when you replying to articles in mailing lists, the address
6316 in Reply-To field of the original message to be prepared to To field of
6317 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6322 (setq wl-draft-reply-without-argument-list
6323 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6324 ("Followup-To" . (nil nil ("Followup-To")))
6325 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6326 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6331 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6332 in the original message, @samp{Reply-To:} field in the original is
6333 copied to @samp{To:} field.)
6335 Moreover, the behavior of @kbd{a} with prefix argument can
6336 be directed by @code{wl-draft-reply-with-argument-list} as well.
6338 Note: To set the behavior when you reply to the message written by yourself, use
6339 @code{wl-draft-reply-myself-without-argument-list} and
6340 @code{wl-draft-reply-myself-with-argument-list}
6343 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6344 @subsection Appearance of Threads
6348 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6349 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6350 391 09/18(Fri)19:24 +-[ Murata-san ]
6351 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6352 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6353 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6354 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6355 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6356 412 09/22(Tue)09:28 | +-[ Teranishi ]
6357 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6358 416 09/22(Tue)12:38 | +-[ Teranishi ]
6359 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6360 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6364 Settings to make appearance of threads like shown above:
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 " ")
6377 If you do not want to see branches, do the following:
6381 (setq wl-thread-indent-level 2)
6382 (setq wl-thread-have-younger-brother-str " ")
6383 (setq wl-thread-youngest-child-str " ")
6384 (setq wl-thread-vertical-str " ")
6385 (setq wl-thread-horizontal-str " ")
6386 (setq wl-thread-space-str " ")
6391 @node User-Agent Field, , Thread Format, Advanced Settings
6392 @subsection User-Agent Field
6396 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6397 @samp{User-Agent:} fields, define a function that generate appropriate
6398 strings as you like, and set it to variable
6399 @code{wl-generate-mailer-string-func}.
6401 If you do not want verbose @samp{User-Agent:} field, do the following:
6405 (setq wl-generate-mailer-string-func
6408 (concat "User-Agent: "
6409 (wl-generate-user-agent-string-1 nil)))))
6413 The following is a example:
6417 (setq mime-edit-insert-user-agent-field nil)
6418 (setq wl-generate-mailer-string-func
6421 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6426 @node Customizable Variables, Hooks, Advanced Settings, Customization
6427 @section Customizable Variables
6429 Customizable variables that have not been described yet:
6432 @item wl-default-folder
6433 @vindex wl-default-folder
6434 The initial setting is @samp{%inbox}. This is the default value for moving to
6435 a folder and the like.
6437 @item wl-draft-folder
6438 @vindex wl-draft-folder
6439 The initial setting is @samp{+draft}. It is the folder to which drafts are
6440 saved. It must be a localdir folder.
6442 @item wl-trash-folder
6443 @vindex wl-trash-folder
6444 The initial setting is @samp{+trash}. It is the wastebasket folder.
6445 If you changed this variable, you had better restart Wanderlust.
6447 @item wl-interactive-exit
6448 @vindex wl-interactive-exit
6449 The initial setting is @code{t}.
6450 If non-nil, you are asked for confirmation when Wanderlust terminates.
6452 @item wl-interactive-send
6453 @vindex wl-interactive-send
6454 The initial setting is @code{t}.
6455 If non-nil, you are asked for confirmation when mail is sent.
6457 @item wl-folder-sync-range-alist
6458 @vindex wl-folder-sync-range-alist
6459 The initial setting is the alist shown below:
6464 ("^\\+draft$\\|^\\+queue$" . "all"))
6469 This is an associative list of regular expressions of folder names and
6470 update range of the summary. Update range is one of the @samp{all},
6471 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6472 @samp{last}. If a folder do not match, @samp{update} is used.
6475 @vindex wl-ask-range
6476 The initial setting is @code{t}.
6477 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6478 for updating the summary when you changed folders.
6480 @item wl-mime-charset
6481 @vindex wl-mime-charset
6482 The initial setting is @code{x-ctext}.
6483 This is the MIME charset for messages that are not MIME (e.g. without
6484 @samp{Content-Type:}). This value also used as default charset for
6485 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6486 this value as @code{iso-2022-jp}.)
6488 @item wl-highlight-folder-with-icon
6489 @vindex wl-highlight-folder-with-icon
6490 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6491 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6493 @item wl-strict-diff-folders
6494 @vindex wl-strict-diff-folders
6495 This is a list of regular expressions of folders.
6496 Unread messages are checked, for example when you press @kbd{s} in
6497 the folder mode, usually in a brief way (rapidly processed but not
6499 The folders matching this variable are seriously checked.
6500 You may want to set this variable so as to match conditional filter
6501 folders for IMAP4 folders.
6502 The initial setting is @code{nil}.
6504 @item wl-folder-use-server-diff
6505 @vindex wl-folder-use-server-diff
6506 When unread messages are checked, for example when you press @kbd{s} in
6507 the folder mode, usually (the number of messages on the server) @minus{}
6508 (the number of local messages) will be the number of unread messages.
6509 However, if this variable is non-nil, the number of unread messages on
6510 the server is checked. This affects IMAP4 folders only, but IMAP4
6511 folders in mail boxes matching
6512 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6513 the number of unread messages on the server, even if they matches this
6514 variable. The initial setting is @code{t}.
6516 @item wl-auto-check-folder-name
6517 @vindex wl-auto-check-folder-name
6518 The initial setting is @code{nil}.
6519 If non-nil, the folder with the name of the value is checked for unread
6520 messages at the start.
6521 If it is @code{none}, no folders are checked.
6522 If it is a list, all folders in the list are checked at the start.
6524 @item wl-auto-uncheck-folder-list
6525 @vindex wl-auto-uncheck-folder-list
6526 The initial setting is the list shown below:
6535 Folders with the name matching this variable are not checked for unread
6536 messages at the start, even if they are included in the groups in
6537 @code{wl-auto-check-folder-name}.
6539 @item wl-auto-check-folder-list
6540 @vindex wl-auto-check-folder-list
6541 The initial setting is @code{nil}.
6542 Folders with the name matching this variable are always checked for
6543 unread messages at the start, if they are included in the groups in
6544 @code{wl-auto-check-folder-name}.
6545 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6547 @item wl-no-save-folder-list
6548 @vindex wl-no-save-folder-list
6549 The initial setting is the list shown below:
6558 This is a list of regular expressions of folders not to be saved.
6560 @item wl-save-folder-list
6561 @vindex wl-save-folder-list
6562 The initial setting is @code{nil}.
6563 This is a list of regular expressions of folders to be saved.
6564 This takes precedence over @code{wl-no-save-folder-list}.
6566 @item wl-folder-mime-charset-alist
6567 @vindex wl-folder-mime-charset-alist
6568 The initial setting is the alist shown below:
6572 (("^-alt\\.chinese" . big5)
6573 ("^-relcom\\." . koi8-r)
6575 ("^-han\\." . euc-kr))
6580 This is an associative list of regular expressions of folder names and
6582 If a folder do not match, @code{wl-mime-charset} is used.
6584 @item wl-folder-init-load-access-folders
6585 @vindex wl-folder-init-load-access-folders
6586 The initial setting is @code{nil}.
6587 This is a list of access groups to be loaded specifically at the start.
6588 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6590 @item wl-folder-init-no-load-access-folders
6591 @vindex wl-folder-init-no-load-access-folders
6592 The initial setting is @code{nil}.
6593 This is a list of access groups not to be loaded specifically at the
6595 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6597 @item wl-delete-folder-alist
6598 @vindex wl-delete-folder-alist
6599 The initial setting is the alist shown below:
6608 This list determines disposition of messages with delete marks.
6609 Each item in the list is a folder and destination; you can specify any
6610 one of the following in the place of destination:
6613 @code{remove} or @code{null} : deletes the messages instantly.
6614 string : moves the messages to the specific folder.
6615 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
6618 @item wl-refile-policy-alist
6619 @vindex wl-refile-policy-alist
6620 The initial setting is the list shown below:
6630 This list determines whether messages with re-file marks are moved or
6631 copied. Each item in the list is a cons cell of a folder and
6632 @code{copy} or @code{move}.
6634 @item wl-x-face-file
6635 @vindex wl-x-face-file
6636 The initial setting is @file{~/.xface}.
6637 The name of the file that contains encoded X-Face strings.
6640 @item wl-demo-display-logo
6641 @vindex wl-demo-display-logo
6642 If non-nil, bitmap image is shown on the opening demo. If you set
6643 @code{xpm} or @code{xbm}, (if possible) display selected image type
6646 @item elmo-use-database
6647 @vindex elmo-use-database
6648 This is meaningful for XEmacs only. The initial setting depends on
6649 XEmacs (@code{t} for XEmacs with dbm).
6650 If non-nil, Message-ID is controlled by dbm.
6652 @item elmo-passwd-alist-file-name
6653 @vindex elmo-passwd-alist-file-name
6654 The initial setting is @file{passwd}.
6655 This is the name of the file in which passwords are saved.
6656 @code{elmo-passwd-alist-save} saves current passwords to the file.
6658 @item elmo-nntp-list-folders-use-cache
6659 @vindex elmo-nntp-list-folders-use-cache
6660 The initial setting is 600 (in seconds).
6661 This is period in seconds during which results of @samp{list} and
6662 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6665 @item elmo-nntp-max-number-precedes-list-active
6666 @vindex elmo-nntp-max-number-precedes-list-active
6667 The initial setting is @code{nil}.
6668 If non-nil, the number of article obtained by @samp{list active} in NNTP
6669 are used as the maximum article number of the folder.
6670 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6671 and if the number of read messages is not correct.
6673 @item elmo-nntp-default-use-listgroup
6674 @vindex elmo-nntp-default-use-listgroup
6675 The initial setting is @code{t}.
6676 If non-nil, @samp{listgroup} is used for checking the total number of
6677 articles. If it is @code{nil}, @samp{group} is used. In the latter
6678 case, the processing will be a little faster at the sacrifice of
6681 @item elmo-pop3-send-command-synchronously
6682 @vindex elmo-pop3-send-command-synchronously
6683 The initial setting is @code{nil}.
6684 If non-nil, POP3 commands are issued synchronously. Some implementation
6685 of POP3 server fails to get summary information without this setting.
6686 You may have to set this variable to @code{t}, if the process hangs
6687 while looking up POP3.
6689 @item elmo-dop-flush-confirm
6690 @vindex elmo-dop-flush-confirm
6691 The initial setting is @code{t}.
6692 If non-nil, you are asked for confirmation if accumulated off-line
6693 operations are executed.
6695 @item elmo-display-progress-threshold
6696 @vindex elmo-display-progress-threshold
6697 The initial setting is 20.
6698 Threshold for display of progress gauge. If number of renewal is more than
6699 this value, display progress gauge.
6703 @node Hooks, , Customizable Variables, Customization
6709 @node Mailing List, Addition, Customization, Top
6710 @chapter Wanderlust Mailing List
6715 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6718 Topics related to Wanderlust are discussed in the mailing list.
6719 The latest version is also announced there (in Japanese, sorry).
6721 A guide can be obtained automatically by sending mail to
6722 @t{wl-ctl@@lists.airs.net} with the body
6727 Please send bug reports or patches to the mailing list. You can post to
6728 the mailing list even though you are not a member of it.
6730 If you send a bug report, please attach Backtrace with it.
6731 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
6734 I would like to express my thanks to the members of the mailing list for
6735 valuable advice and many pieces of code they contributed.
6738 @node Addition, Index, Mailing List, Top
6739 @chapter Additional Information
6741 @section Brief History
6744 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6745 3/10 Made a msgdb mechanism by elisp.
6746 3/26 IMAP and NNTP can be displayed in threads.
6747 4/13 Began to assemble thread display modules as elmo.
6748 5/01 Finished 0.1.0, initial version with many defects.
6749 6/12 I made a slip of the tongue and said I was writing elisp
6750 mailer supporting IMAP
6751 6/16 0.1.3 was announced at tm-ja, elisp ML.
6752 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6753 7/01 Support for mm-backend (0.3.0).
6754 8/25 multi folder added (0.5.0).
6755 8/28 filter folder added (0.5.1).
6756 9/10 You can open/close threads (0.6.0).
6757 9/11 fldmgr by Murata-san made editing folders easy.
6758 9/18 lha folders added by Okunishi-san (0.6.3).
6759 9/24 Display of branches of threads (0.6.5).
6760 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6761 10/28 Off-line operations (0.7.4).
6762 12/09 Becomes beta version.
6763 12/21 wl-expire by Murata-san.
6764 1999 2/03 auto-refile by Tsumura-san.
6765 4/28 wl-template by Murata-san.
6766 5/18 Released 1.0.0 stable.
6767 7/05 Scoring by Murata-san (2.1.0).
6768 9/26 New plugged system by Murata-san (2.2.2).
6769 12/20 Support Modified UTF7.
6770 2000 3/24 Released 1.1.0 stable.
6771 4/03 CVS development started.
6772 5/07 Thread restoration & Its speed up with Murata-san.
6773 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6774 7/11 killed message feature.
6775 7/18 Use UIDL in POP3.
6776 9/12 biff feature with Satata-san & Yamaoka-san.
6777 10/17 expire-hide by Okada-san.
6778 11/08 Released 2.4.0 stable.
6779 2001 7/04 Released 2.6.0 stable.
6782 See @file{ChangeLog} for details.
6786 According to a dictionary, Wanderlust has the meaning:
6790 n eager longing for or impulse towards travelling in distant lands
6791 [Ger, fr wandern to wander + lust desire, pleasure]
6795 but I had no profound intention. (if farfetched, IMAP @result{} you can
6796 read mail anywhere @result{} desire to wander ?)
6798 Elmo is the abbreviation of @samp{Elisp Library for Message
6799 Orchestration}. At first I meant the red puppet in the Sesame Street,
6800 but you may associate it with Wandering @result{} Drifting @result{}
6801 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6805 Each versions has code names (they are almost jokes).
6806 Currently they are picked up alphabetically from the top 40 hits of
6807 U.S. Billboard magazines in 1980s.
6809 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
6812 @node Index, , Addition, Top
6816 * Concept Index:: Concept Index
6817 * Key Index:: Key Index
6818 * Variable Index:: Variable Index
6819 * Function Index:: Function Index
6822 @node Concept Index, Key Index, Index, Index
6823 @unnumberedsec Concept Index
6826 @node Key Index, Variable Index, Concept Index, Index
6827 @unnumberedsec Key Index
6830 @node Variable Index, Function Index, Key Index, Index
6831 @unnumberedsec Variable Index
6834 @node Function Index, , Variable Index, Index
6835 @unnumberedsec Function Index