1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
26 This edition is for Wanderlust version @value{VERSION}.
28 Permission is granted to make and distribute verbatim copies of this
29 manual provided the copyright notice and this permission notice are
30 preserved on all copies.
33 Permission is granted to process this file through TeX and print the
34 results, provided the printed document carries copying permission notice
35 identical to this one except for the removal of this paragraph (this
36 paragraph not being relevant to the printed manual).
39 Permission is granted to copy and distribute modified versions of this
40 manual under the conditions for verbatim copying, provided that the
41 entire resulting derived work is distributed under the terms of a
42 permission notice identical to this one.
44 Permission is granted to copy and distribute translations of this manual
45 into another language, under the above conditions for modified versions.
51 @title Wanderlust User's Manual
52 @subtitle Yet another message interface on Emacsen
53 @subtitle for Wanderlust version @value{VERSION}
54 @author Yuuichi Teranishi
55 @author Fujikazu Okunishi
56 @author Masahiro Murata
58 @author Kaoru Takahashi
60 @author Masayuki Osada
63 @vskip 0pt plus 1filll
64 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
65 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
66 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
68 This manual is for Wanderlust version @value{VERSION}.
70 Permission is granted to make and distribute verbatim copies of this
71 manual provided the copyright notice and this permission notice are
72 preserved on all copies.
74 Permission is granted to copy and distribute modified versions of this
75 manual under the conditions for verbatim copying, provided that the
76 entire resulting derived work is distributed under the terms of a
77 permission notice identical to this one.
79 Permission is granted to copy and distribute translations of this manual
80 into another language, under the above conditions for modified versions.
86 @node Top, Introduction, (dir), (dir)
87 @top Wanderlust User's Manual
99 This manual is for Wanderlust @value{VERSION}.
104 * Introduction:: Read this first
105 * Start Me Up:: Invoking Wanderlust
106 * Folders:: How to specify folders
107 * Folder:: Selecting and editing folders
108 * Summary:: Reading and refiling messages
109 * Message:: Saving and playing MIME multipart entities
110 * Draft:: Draft buffer, sending mail and news
111 * Disconnected Operations:: Off-Line management
112 * Expire and Archive:: Automatic expiration and archiving of messages
113 * Scoring:: Score of the messages
114 * Address Book:: Management of Address Book
115 * Customization:: Customizing Wanderlust
116 * Mailing List:: Wanderlust mailing list
117 * Addition:: Additional Information
122 @node Introduction, Start Me Up, Top, Top
123 @chapter Introduction of Wanderlust
126 Wanderlust is an mail/news management system on Emacsen.
127 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
129 The main features of Wanderlust:
132 @item Pure elisp implementation.
133 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
134 @item Unified access method to messages based on Mew-like Folder Specification.
135 @item Mew-like Key-bind and mark handling.
136 @item Manages unread messages.
137 @item Interactive thread display.
138 @item Folder Mode shows the list of subscribed folders.
139 @item Message Cache, Disconnected Operation (Read Only).
140 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
141 @item MIME compliant (by SEMI).
142 @item Transmission of news and mail are unified by Message transmitting draft.
143 @item Graphical list of folders (XEmacs and Emacs 21).
144 @item View a part of message without retrieving the whole message (IMAP4).
145 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
146 @item Virtual Folders.
147 @item Supports compressed folder using common archiving utilities.
148 @item Old articles in folders are automatically removed/archived (Expiration).
149 @item Automatic re-file.
150 @item Template function makes it convenient to send fixed form messages.
156 Wanderlust is supposed to run on following Emacsen:
159 @item Mule 2.3 based on Emacs 19.34
160 @item Emacs 20.2 or later
161 @item XEmacs 20.4 or later
162 @item Meadow 1.00 or later
163 @item NTEmacs 20.4 or later
167 IMAP4 connectivity with following imapd are confirmed to work with
171 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
172 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
173 @item Courier-IMAP 1.3.2 or later
174 @item AIR MAIL (AIRC imapd release 2.00)
176 @item Microsoft Exchange Server 5.5
177 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
180 LDAP connectivity with following LDAPd are confirmed to work with
184 @item OpenLDAP 2.0.6 or later
188 @node Start Me Up, Folders, Introduction, Top
189 @chapter Start up Wanderlust
192 The necessary procedure for starting Wanderlust is explained in steps
195 (Of course, you need a mail/news readable environment in advance)
198 * MIME Modules:: Installing the MIME modules
199 * Download:: Download and extract the packages
200 * Install:: Byte-compile and install
201 * Minimal Settings:: @file{.emacs} setup
202 * Folder Definition:: Folder definition
203 * Start Wanderlust:: Starting Wanderlust
207 @node MIME Modules, Download, Start Me Up, Start Me Up
208 @section Installing MIME modules
215 SEMI or tm must be installed to make Wanderlust work correctly.
217 SEMI does not run on Emacs 19.28 or earlier
218 @footnote{SEMI runs on Emacs 19.34. @*
219 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} describes how to.},
220 so you must install tm, the predecessor of SEMI. (tm version 8.7 or later
223 However, SEMI is recommended because of its wider functionality.
225 Refer to the documents of each package for detailed installation procedure.
227 SEMI and tm can be downloaded from these sites:
231 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
232 tm: http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
236 You need packages named APEL and FLIM to use SEMI.
237 You can download APEL and FLIM from following URLs:
241 APEL: ftp://ftp.m17n.org/pub/mule/apel/
242 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
246 You have to install APEL, FLIM and SEMI in this order. Generally,
247 @samp{make install} will do the job. (In XEmacs 21, @samp{make
250 Recommended combination of APEL, FLIM and SEMI are following:
253 @item APEL 10.3, FLIM 1.14.2 and SEMI 1.14.3
256 You can also use many other FLIM/SEMI variants. Combination of the
257 latest versions should work. For example, the following combination are
261 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
262 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
265 You have to re-install Wanderlust if you upgraded APEL, FLIM, SEMI or
269 @node Download, Install, MIME Modules, Start Me Up
270 @section Download and Extract the Package
273 You can download Wanderlust package from following sites:
277 ftp://ftp.gohome.org/wl/
280 Mirrored ftp/http sites:
284 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
285 http://www.jpl.org/elips/wl/
286 http://www.ring.gr.jp/archives/text/elisp/wl/
287 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
288 ftp://opaopa.org/pub/mirror/elisp/wl/
289 @c ftp://roguelife.org/pub/tsumura/wl/
293 Extract the obtained package to your working directory:
298 % tar zxvf wl-@var{version}.tar.gz
299 % cd wl-@var{version}
303 @subsection To use SSL (Secure Socket Layer)
308 SSL (Secure Socket Layer) can be used for
309 SMTP, IMAP, NNTP and POP connections in Wanderlust.
311 There are two ways to use SSL. One is to start SSL negotiation just
312 after the connection establishment (generic way). The other one is to
313 start SSL negotiation by invoking STARTTLS command in the each session.
315 To use the formal SSL (generic SSL), you must set @env{PATH} to the
316 directory that OpenSSL commands are installed.
318 To use the latter SSL(STARTTLS), you must install starttls package in
320 You can download starttls package from the following site.
323 ftp://opaopa.org/pub/elisp/
326 @node Install, Minimal Settings, Download, Start Me Up
327 @section Byte-compile and install
334 @subsection Installation
336 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
337 Set the Emacs's command name to @code{EMACS}.
338 Set package installation directory to @code{LISPDIR}.
339 Then, please execute following commands.
348 Destination directory is auto-probed if you leave @code{LISPDIR}
349 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
351 If you are using an Emacs variant which does not merge specified directory
352 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
353 then you will see the error message:
356 Cannot open load file: mime-setup
360 In this case, either add destination directories of custom, APEL, FLIM
361 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
362 @code{load-path} in @file{WL-CFG} in extracted directory.
364 If you want to use BBDB, then the necessary modules are byte-compiled
365 and installed when BBDB directory is added to @code{load-path}.
368 @subsection @file{WL-CFG}
370 Contents of the file @file{WL-CFG} is loaded under installation if a file
371 with that name exists in extracted directory. You can use @file{WL-CFG} to
372 configure @code{load-path} to extra packages such as SEMI if needed.
374 If you want to specify the install directory of Wanderlust related
375 files, then set following variables in @file{WL-CFG}
379 A directory to install WL modules.
380 This directory is relative directory from @code{LISPDIR}.
381 WL modules include @file{wl*.el}, @file{wl*.elc} files.
382 @c Modules under the directory @file{util/} are also installed if
383 @c it detected as necessary.
386 A directory to install ELMO modules.
387 This directory is relative directory from @code{LISPDIR}.
388 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
389 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
393 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
395 If you want to install ELMO related files under a sub-directory
396 such as "elmo" then add following to @file{WL-CFG}:
399 (setq ELMO_PREFIX "elmo")
402 @subsection Install as a XEmacs package
403 @cindex XEmacs package
404 @cindex XEmacs package install
405 @cindex Package, XEmacs
406 @cindex Package install, XEmacs
407 @c @cindex install-package
409 It is possible to install Wanderlust as one of packages of XEmacs (21.0
410 or later). Configuration for autoload and icon-path in local
411 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
414 Follow the next example to install Wanderlust as an XEmacs package.
420 % make install-package
424 package directory is auto-probed, if SEMI is installed.
425 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
427 @subsection Run in place
429 If wl and elmo directories are defined in @code{load-path}, then
430 byte-compilation and installation are not necessary to start Wanderlust.
431 For example, if package is extracted in @file{~/work}, Wanderlust can be
432 invoked with following setting in @file{~/.emacs}.
436 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
437 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
443 Manual is described in Info format. Please do following.
452 If you install Wanderlust as a XEmacs package, Info file is already
453 installed too, so there are no need of these commands.
455 Manual directory is automatically detected. Of course, it can be
456 configured by @code{INFODIR} in @file{Makefile}.
458 You can read manual at the following URL:
461 http://www.gohome.org/wl/doc/wl-euc_toc.html
464 @node Minimal Settings, Folder Definition, Install, Start Me Up
465 @section Set up .emacs
466 @cindex Minimal Settings
468 @cindex Configuration
472 The Wanderlust package contains two module groups.
475 @item ELMO (elmo-*.el)
476 These modules show everything as folders. This is the back-end for WL.
478 These modules controls the behavior of main body of Wanderlust.
479 They are also the front-end for ELMO.
482 You can customize the behavior of Wanderlust by changing the value
483 of environmental variables which begins with @code{elmo-} and @code{wl-}.
485 The minimal requirement for settings is as the following.
489 ;; @r{The setting to use SEMI}
492 ;; @r{autoload configuration}
493 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
494 (autoload 'wl "wl" "Wanderlust" t)
495 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
497 ;; @r{Directory where icons are placed (XEmacs or Emacs 21).}
498 ;; @r{Default: @code{nil}.}
499 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
500 (setq wl-icon-dir "~/work/wl/etc")
502 ;; @r{SMTP server for mail posting. Default: @code{nil}}
503 (setq wl-smtp-posting-server "your.smtp.example.com")
504 ;; @r{NNTP server for news posting. Default: @code{nil}}
505 (setq wl-nntp-posting-server "your.nntp.example.com")
509 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
510 file exists). So it is convenient to gather Wanderlust specific settings
511 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
512 because you can't write them in @file{.emacs}
513 (if you write it to @file{.emacs}, you'll get an error).
516 All above described settings except (load "mime-setup") and autoload
517 configuration can be written in
520 @subsection @code{mail-user-agent}
521 @cindex Default Mailer
522 @cindex Mailer, Default
523 @vindex mail-user-agent
526 If you write following setting in you @file{.emacs}, you can
527 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
528 This means it enables you to run Wanderlust as a default mail composer
531 It is effective only when your Emacs can define @code{mail-user-agent}.
532 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
536 (autoload 'wl-user-agent-compose "wl-draft" nil t)
537 (if (boundp 'mail-user-agent)
538 (setq mail-user-agent 'wl-user-agent))
539 (if (fboundp 'define-mail-user-agent)
540 (define-mail-user-agent
542 'wl-user-agent-compose
551 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
552 @section Folder Definition
553 @cindex Folder Definition
556 You can skip this section because it is possible to add/edit the
557 subscribe folders from the buffer for list of folders.
558 @xref{Folder Manager}.
560 Define the folders you want to subscribe in file @file{~/.folders}. The
561 contents written in @file{~/.folders} become the folders which you
562 subscribe to as it is.
564 Format for @file{~/.folders} is very simple. Here is an example:
569 # @r{Lines begin with @samp{#} are comment.}
570 # @r{Empty lines are ignored}
572 # @var{folder name} "@var{folder nickname}"
573 # @r{(nicknames are not necessary)}
578 %#mh/Backup@@my.imap.example.com "Sent"
581 %#mh/spool/wl "Wanderlust ML"
582 %#mh/spool/elips "ELIPS ML"
583 %#mh/spool/apel-ja "APEL Japanese ML"
584 %#mh/spool/xemacs-beta "XEmacs beta"
585 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
586 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
589 # @r{If folder name ends with @samp{/}, that means an `access group',}
590 # @r{all subfolders automatically included in one folder group.}
592 %#mh/expire@@localhost /
593 # @r{All MH folders are included in one folder group.}
598 Each line contains one folder you want to read. The definition of
599 folders will be explained in detail in the next section.
601 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
602 become one folder group. One folder group is treated as a directory
603 which can bed opened and closed in folder mode. It is convenient for
604 collecting some folders and putting them in order.
606 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
607 line and you have to write it that way (It is because the parser sucks).
609 There are two types of groups. One is like @samp{Emacsen} from above
610 example which the user chooses his favorite folders as a group.
612 The other one is @dfn{access group} like @samp{+} from above example.
613 It makes all the sub-folders in a folder to a group. (It differs from
614 the type of the folder. For example, @samp{+} makes entire MH
615 sub-directories to one group)
617 This behavior is better understood if you try it and confirmed the
618 function first. You can write and try a small folder definition, so you
619 will know the idea of the folder function before writing the real one.
621 @node Start Wanderlust, , Folder Definition, Start Me Up
622 @section Start Wanderlust
623 @cindex Start Wanderlust
625 If installation and configuration worked well, you can invoke Wanderlust by
626 typing following command in Emacs.
633 After initialization, Folder Mode which shows the list of folders will appear.
634 That means the folders you defined in the @file{~/.folders} are listed
635 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
636 can skip folder checking.
639 @node Folders, Folder, Start Me Up, Top
640 @chapter Wanderlust's folders
643 This chapter describes the folder types which Wanderlust is able to handle.
645 Wanderlust uses ELMO as it's interface, so every folder types supported
646 by ELMO is usable in Wanderlust.
648 As of version @value{VERSION}, 11 types of folders are predefined. These are
649 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
650 Pipe and Internal folder types.
653 * IMAP Folder:: @samp{%} -- IMAP folder
654 * NNTP Folder:: @samp{-} -- NNTP folder
655 * MH Folder:: @samp{+} -- MH folder
656 * Maildir Folder:: @samp{.} -- Maildir folder
657 * News Spool Folder:: @samp{=} -- News spool folder
658 * Archive Folder:: @samp{$} -- Archive folder
659 * POP Folder:: @samp{&} -- POP folder
660 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
661 * Namazu Folder:: @samp{[} -- Namazu Folder
662 * Multi Folder:: @samp{*} -- Multi folder
663 * Filter Folder:: @samp{/} -- Filter folder
664 * Pipe Folder:: @samp{|} -- Pipe folder
665 * Internal Folder:: @samp{'} -- Internal folder
669 @node IMAP Folder, NNTP Folder, Folders, Folders
677 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
683 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
687 You can specify @code{login} (encoded password transmission),
688 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
689 authentication) or @code{clear} (or @code{nil}, plain password
690 transmission) as @var{authenticate-type}.
695 @var{username} -> The value of @code{elmo-imap4-default-user}.
696 Initial setting is @env{USER} environment variable or
697 @env{LOGNAME} environment variable or return value of
698 @code{(user-login-name)}.
699 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
700 Initial setting is "auth".
701 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
702 Initial setting is "localhost".
703 @var{port} -> The value of @code{elmo-imap4-default-port}.
704 Initial setting is 143.
707 You can omit the @var{hostname} from folder names if you set
708 @code{elmo-imap4-default-server} as your main IMAP server.
709 For example, you can specify a folder as @samp{foo%imap@@gateway} even
710 if you have to go through a firewall.
714 ;; @r{Example: imap4.exaple.org as main IMAP server}
715 (setq elmo-imap4-default-server "imap4.example.org")
719 SSL (Secure Socket Layer) connection will be used if a folder name ends
720 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
721 is @code{ssl}, SSL will be the default connection. If a folder name
722 ends with @samp{!!}, STARTTLS connection will be established. If the
723 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
724 STARTTLS will be the default connection.
728 ;; @r{Example: Use SSL connection}
729 (setq elmo-imap4-default-stream-type 'ssl)
733 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
734 authentication method, the password is sent in encoded form. But, if
735 your server is unable to receive an encoded password, authentication
736 will fall back to @code{clear} (that is, sending password in raw format)
737 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
738 authentication will fall back to @code{clear} without confirmation
739 (default value is @code{nil}).
743 ;; @r{Example: password in raw format}
744 (setq elmo-imap4-default-authenticate-type 'clear)
752 %inbox -> IMAP mailbox "inbox"
753 %#mh/inbox -> IMAP mailbox "#mh/inbox"
755 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
756 %inbox:hoge/clear@@server1
757 -> server1's IMAP mailbox "inbox"
758 of user "hoge", with plain password authentication
763 @subsection International mailbox names (Modified UTF7)
764 @cindex Modified UTF7
771 You can use international mailbox names in @var{mailbox} part, if you
772 are using Emacs which can treat unicode and
773 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
774 value is @code{nil}).
776 Currently, following Emacsen can treat unicode.
779 @item Emacs 20.3 or later + Mule-UCS
781 If you installed Mule-UCS package, Emacs can treat unicode.
782 You can obtain Mule-UCS package from following URL.
785 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
788 @item XEmacs 21.2.13 or later + ucs-conv package
790 By default, XEmacs 21 cannot treat unicodes, but if you installed
791 ucs-conv package, it can.
792 You can obtain ucs-conv package from following anonymous CVS.
796 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
797 Password: @var{NULL} (Just enter return key)
798 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
802 You also need utf7 conversion programs, @command{u7tou8} and
803 @command{u8tou7} to use international mailbox name in the current
804 XEmacs. These programs are included in the UTF7 package which can be
805 obtained from following URL.
808 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
813 @node NNTP Folder, MH Folder, IMAP Folder, Folders
824 A folder to access USENET news via NNTP protocol (RFC 977).
825 One newsgroup is treated as a folder.
831 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
837 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
838 Initial setting is @samp{localhost}.
839 @var{username} -> The value of @code{elmo-nntp-default-user}.
840 Initial setting is @code{nil}.
841 @var{port} -> The value of @code{elmo-nntp-default-port}.
842 Initial setting is 119.
845 AUTHINFO is used as authentication method if the @var{username} is
846 non-nil. SSL will be default method if
847 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
848 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
849 STARTTLS connection will be established. if the value of
850 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
851 be the default connection.
857 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
858 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
863 @node MH Folder, Maildir Folder, NNTP Folder, Folders
870 A folder to access MH format mail (1 file is 1 mail).
875 @samp{+} @var{directory-name}
878 Normally, @var{directory-name} is an relative path to the variable
879 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
880 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
881 (this is also true for drive-letters).
883 Message number is used for the name of the message file.
889 +inbox -> @file{~/Mail/inbox}
890 +from/teranisi -> @file{~/Mail/from/teranisi}
891 +~/test -> @file{~/test}
896 @node Maildir Folder, News Spool Folder, MH Folder, Folders
897 @section Maildir Folder
899 @cindex Maildir Folder
903 A folder to access to Maildir format (1 file is 1 mail).
908 @samp{.} [@var{directory-name}]
911 Normally, @var{directory-name} is a relative path to the variable
912 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
913 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
914 (this is also true for drive-letters).
916 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
917 Messages are contained in the @file{cur} directory. All message files
918 in the @file{new} directory are moved to @file{cur} directory when you
919 access to the folder. All message files contained in the @file{tmp}
920 directory and not accessed for 36 hours are deleted.
922 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
928 . -> @file{~/Maildir}
929 .inbox -> @file{~/Maildir/inbox}
930 .from/teranisi -> @file{~/Maildir/from/teranisi}
931 .~/test -> @file{~/test}
936 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
937 @section News Spool Folder
939 @cindex News spool Folder
942 This folder handles locally saved news articles which are proposed by
943 Mew/IM. You can also read articles directly from a spool-file which is
944 retrieved by an utility like @command{gnspool}.
949 @samp{=} @var{directory-name}
952 @var{directory-name} is a sub-directory to the directory defined by
953 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
954 You can use @samp{.} as directory delimiter as well as @samp{/}.
960 =fj/os/os2 -> @file{~/News/fj/os/os2}
961 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
966 @node Archive Folder, POP Folder, News Spool Folder, Folders
967 @section Archive Folder
969 @cindex Archive Folder
972 This method can handle archive files, which are compressed by utilities
973 such as Info-ZIP or LHA, as one folder.
979 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
983 @var{path-name} is the relative path from
984 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
985 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
986 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
987 also permitted under the environment of ange-ftp, efs.
989 The actual file name of the archive folder is
990 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
991 under the @var{path-name}. If a file named @var{path-name} exists, it is
992 treated as folder. The suffix is automatically decided for
995 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
996 (Initial setting is @code{zip}) is referred.
998 @var{prefix} specifies the internal directory structure of the archive.
999 For example, if the ML server is fml, @file{msend.tar.gz} has a
1000 structure like @file{spool/1}, so you have to specify @samp{spool} as
1007 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1008 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1009 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1010 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1015 * Archiver:: Supported Archivers
1016 * Archive Tips:: TIPS
1017 * Archive Vars:: Customization
1021 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1022 @subsection Supported Archives
1032 By default, following archives are supported.
1036 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1037 GNU TAR('tgz, 'tar) ;; read-only
1041 If your archiver can include multiple files in one archive, you have a
1042 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1043 of the candidate. TAR is supported read-only because it cannot delete
1044 file in the archive (@code{mv})).
1046 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1047 archiver of Wanderlust because they cannot include multiple
1048 files. Archivers that cannot extract files to standard output are also
1051 @subsection OS specific information about archiver.
1053 Behaviors of the following archivers are confirmed by further experiences.
1054 (@samp{*} mark means recommended archiver).
1057 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1058 LHA OS/2 version Rel.2.06b Feb 18, 1998
1059 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1060 *Zip 2.2 (November 3rd 1997).
1061 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1062 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1063 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1065 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1066 LHa for UNIX V 1.14c
1067 UnZip 5.32 of 3 November 1997
1068 Zip 2.2 (November 3rd 1997)
1069 GNU tar 1.12 (1.11.x is no good)
1070 gzip 1.2.4 (18 Aug 93)
1072 [Win32] Win.98/Meadow
1076 GNU tar 1.11.8 + 1.5(WIN32)
1083 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1084 Hiramatsu version of LHA is only supported.
1085 In Win32, LHa32 is only supported (DOS version is no good).
1087 * Caution about GNU tar
1089 You have to take care about GNU tar's version because many version has
1090 problem on deleting file from archive.
1092 Please test @option{--delete} @option{-f} options work. Otherwise, your
1093 archive will be destroyed. No problem is reported on above versions of
1097 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1099 @cindex Archive Tips
1101 For comfortable migration, usage of @code{wl-summary-archive}
1102 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1103 archive folders created by expiration, you must set non-nil value to
1104 @code{elmo-archive-treat-file}.
1106 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1107 in processing speed. For comfortable use, Emacs20 is recommended.
1108 (If re-search's performance is the problem, 19.3x or later may be okay.)
1110 If many files are included in one archive,
1111 it takes long time to access to the archive folder because
1112 archiver starting overhead is increased (especially LHA).
1113 150-200 messages in one archive is recommended.
1115 Of course, following is possible @t{:-)}
1116 (meanings of these variables are described later.)
1120 (setq wl-fcc "$backup")
1121 (setq wl-trash-folder "$trash;lha")
1125 @node Archive Vars, , Archive Tips, Archive Folder
1126 @subsection Variables About Archive Folder
1127 @cindex Archive variables
1130 @item elmo-archive-default-type
1131 @vindex elmo-archive-default-type
1132 The initial setting is @code{zip}.
1133 Set archiver type by symbol.
1135 @item elmo-archive-@var{type}-method-alist
1136 @vindex elmo-archive-TYPE-method-alist
1137 Define archiver @var{type}'s methods.
1138 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1139 Each element of the alist is following.
1143 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1144 (@var{action} . @var{function}) ;; function
1148 Currently available actions are following.
1152 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1153 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1160 actions enclosed with braces are optional (They are used for better
1163 @item elmo-archive-suffix-alist
1164 @vindex elmo-archive-suffix-alist
1165 An alist of archiver-type (symbol) and suffix.
1167 @item elmo-archive-file-regexp-alist
1168 @vindex elmo-archive-file-regexp-alist
1169 An alist of a regexp to get file number from list output of archiver
1170 and archiver-type (symbol).
1172 @item elmo-archive-method-list
1173 @vindex elmo-archive-method-list
1174 A list of elmo-archive-@var{type}-method-alist
1175 (@var{type} is a symbol of archiver-type).
1177 @item elmo-archive-lha-dos-compatible
1178 @vindex elmo-archive-lha-dos-compatible
1179 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1180 DOS (Mr. Yoshizaki original) compatible.
1182 @item elmo-archive-cmdstr-max-length
1183 @vindex elmo-archive-cmdstr-max-length
1184 The initial setting is 8000.
1186 Max length of command line argument for external archiver program.
1187 Emacs does not have a limit of command line byte length, but some OS
1188 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1189 this limit because it calls external archiver program directly (not
1190 called via shell). For example, you cannot delete messages if archiver
1191 program must receive larger bytes of arguments to delete. OS/2 have a
1192 command line argument limit of 8190 bytes, so we defined default as 8000
1195 However, you don't have an influence of command line argument limit
1196 if the archiver has `actions' to receive target file information from
1197 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1201 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1209 A folder to access e-mails via POP3 protocol (RFC 1939).
1215 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1220 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1221 as @var{authenticate-type}.
1225 @var{username} -> The value of @code{elmo-pop3-default-user}.
1226 Initial setting is @env{USER} environment variable or
1227 @env{LOGNAME} environment variable or return value of
1228 @code{(user-login-name)}.
1229 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1230 Initial setting is @samp{user}.
1231 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1232 Initial setting is @samp{localhost}.
1233 @var{port} -> The value of @code{elmo-pop3-default-port}.
1234 Initial setting is 110.
1241 &hoge@@localhost -> access to localhost as user @samp{hoge}.
1242 &hoge@@popserver:109 -> access to the server "popserver" on port 109
1243 as user @samp{hoge}.
1247 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1248 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1249 @file{utils/sasl/lisp/} or Emacs/W3 package
1250 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1253 If the last character of the folder name is @samp{!}, Wanderlust
1254 connects to the POP server via SSL (Secure Socket Layer). If you set
1255 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1256 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1257 with @samp{!!}, STARTTLS connection will be established. if the value
1258 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1262 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1263 @section Shimbun Folder
1265 @cindex Shimbun Folder
1266 @cindex Folder, Shimbun
1271 A folder for watching "shimbun" (means "newspaper" in Japanese),
1272 news site and mailing list archives on WWW by using emacs-w3m
1273 (@uref{http://emacs-w3m.namazu.org/}).
1275 You should possess w3m and emacs-w3m to use this.
1281 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1285 Admissible values of @var{module-name} and @var{folder-name} are
1286 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1289 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1290 @section Namazu Folder
1292 @cindex Namazu Folder
1293 @cindex Folder, Namazu
1294 @cindex Folder, Text Search
1299 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1300 @section Multi Folder
1302 @cindex Multi Folder
1303 @cindex Folder, Multiple
1304 @cindex Folder, Marge
1306 A folder to access to a folder which collects messages from
1307 multiple folders virtually.
1313 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1317 After @samp{*} character, specify multiple folders you want to collect
1318 separated by @samp{,} like
1319 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1325 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1326 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1327 treated as one folder.
1329 *+inbox,-fj.rec.tv,%inbox
1330 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1335 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1336 @section Filter Folder
1338 @cindex Filter Folder
1339 @cindex Folder, Filtering
1340 @cindex Folder, Virtual
1341 @cindex Folder, Conditional
1343 A folder to access to a folder which collects all messages that
1344 satisfy a condition virtually.
1349 @samp{/} @var{condition} @samp{/} @var{target-folder}
1352 In the @var{condition} part, you can specify following.
1356 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1358 first: @var{number} messages are picked from top of folder.
1359 last: @var{number} messages are picked from bottom of folder.
1365 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1366 /first:20/%inbox -> First 20 messages from %inbox are picked.
1371 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1373 since: only messages arrived since @var{date} are picked.
1374 before: only messages arrived before @var{date} are picked.
1376 You can specify following as @var{date}.
1380 yesterday -> a day before today.
1381 lastweek -> same day of last week.
1382 lastmonth -> same day of last month.
1383 lastyear -> same day of last year.
1384 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1385 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1393 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1395 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1401 Field filter: @samp{@var{field}:@var{value}}
1403 All messages that have @var{field} and its value is @var{value} are picked.
1404 @var{field} and @var{value} are case insensitive.
1410 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1411 and its value includes "teranisi" string are picked.
1412 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1420 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1421 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1423 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1424 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1430 /from:teranisi&!to:teranisi/+inbox
1431 -> In +inbox, messages are picked if the message's
1432 From: field includes "teranisi" and
1433 To: field doesn't include "teranisi".
1435 /tocc:"Yuuichi Teranishi"/+inbox
1436 -> In +inbox, messages are picked if the
1437 message's To: field or Cc: field includes
1438 "Yuuichi Teranishi".
1440 /(from:yt|from:teranisi)&subject:report/+inbox
1441 -> In +inbox, messages are picked if the message's
1442 From: field includes "yt" or "teranisi", and
1443 Subject includes "report".
1449 Tip for string description:
1451 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1452 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1453 should be escaped with @samp{\} in it). You can enclose the string with
1454 @samp{"} even it does not contain these characters.
1460 *%inbox,/from:teranisi/%inbox@@server
1461 -> Messages in %inbox or
1462 message is in the %inbox@@server folder and it's From field
1463 includes "teranisi" are collected.
1465 /last:100//to:teranisi/*+inbox,%inbox
1466 -> Latest 100 messages which is in the +inbox or %inbox folder
1467 and To: field matches "teranisi".
1469 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1470 -> Pick messages which have From: field and it includes "hogehoge"
1471 from latest 20 messages in the %#mh/inbox@@localhost
1472 and To: or Cc: field includes "teranisi".
1475 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1476 @section Pipe Folder
1480 @cindex Download Message
1481 @cindex Incorporate Message
1483 In the pipe folder, messages are automatically transferred from the source
1484 folder to destination folder.
1489 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1492 When you access to the pipe folder, messages are automatically transferred
1493 from @var{source-folder} to @var{destination-folder}.
1494 It is convenient if you want to download messages to local disk via POP.
1495 For example, if you specify following
1498 |&username@@popserver|+inbox
1502 and access to it, messages are downloaded automatically from
1503 @samp{&username@@popserver} to @samp{+inbox}.
1509 %inbox|%myinbox -> Download %inbox to %myinbox.
1510 *&user@@popserver1,&user@@popserver2|+inbox
1511 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1515 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1517 @node Internal Folder, , Pipe Folder, Folders
1518 @section Internal folder
1520 @cindex Internal Folder
1521 @cindex Folder, @samp{$} mark
1523 @c @cindex Folder, Null
1525 A folder to access to internal messages of Wanderlust.
1537 A folder named @samp{'mark} is a special virtual folder which collects
1538 messages which have important mark @samp{$}.
1540 You can review important messages at once after you put important marks
1541 on the messages in the different folders.
1543 In this folder, if you delete message, important mark @samp{$} put on
1544 the message is removed. If you append messages to this folder, the
1545 message will have @samp{$} mark.
1547 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1548 folder. If you want IMAP folder's message remove from @samp{'mark}
1549 folder, remove important mark at IMAP Folder.)
1551 You can access to the cached messages fetched via network by accessing
1552 to the folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1553 the name of the subdirectories of the cache directory
1554 (@file{~/.elmo/cache}).
1557 @node Folder, Summary, Folders, Top
1558 @chapter Folder mode
1561 After you start Wanderlust, folder mode is appeared firstly.
1562 It contains folder list you subscribed.
1563 You can select and edit folders in this mode.
1566 * Selecting Folder:: Select folder you want to read
1567 * Folder Manager:: Editing folders
1571 @node Selecting Folder, Folder Manager, Folder, Folder
1572 @section Selecting Folder
1573 @cindex Selecting Folder
1575 @subsection Usage (TIPS)
1577 @subsubsection Check new, unread number
1579 Folder mode looks like this.
1580 (In XEmacs, it looks much nicer @t{;-)})
1584 [-]Desktop:14186/35580/67263
1589 [-]Emacsen:0/34/4837
1590 Wanderlust ML:0/0/558
1593 XEmacs Beta:0/29/255
1604 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1608 @kbd{s} key on the folder line updates these numbers.
1609 It changes its color if it has many new messages.
1611 The whole folder mode is a folder group named @samp{Desktop}.
1612 Folder group open/close by return key.
1613 A operation to a folder group is treated as operations on the
1615 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1616 six children folders update its unread number status.
1618 @subsubsection Select Folder
1620 To enter summary mode of the folder, type return (or space) key on
1622 If the variable @code{wl-stay-folder-window} has non-nil value,
1623 summary window appears on the right of the folder mode window.
1625 @subsection Key bindings
1627 Folder mode's key binding (related to selecting folders) is following.
1632 @kindex @key{SPC} (Folder)
1633 @kindex @key{RET} (Folder)
1634 @findex wl-folder-jump-to-current-entity
1635 Enter to the summary mode of the folder at the current cursor point.
1636 If the cursor is on the top of folder group line,
1637 the folder group is opened or closed.
1638 When the cursor is on the access group and this command is called
1639 with prefix argument, folder children list is updated to the newest one.
1640 (Children list is updated recursively if the access folder has hierarchical
1642 (@code{wl-folder-jump-to-current-entity})
1645 @kindex M-@key{RET} (Folder)
1646 @findex wl-folder-update-recursive-current-entity
1647 Folder children list of the access group at the current cursor point
1648 is updated to the newest one.
1649 (Children list is updated recursively if the access folder has hierarchical
1651 (@code{wl-folder-update-recursive-current-entity})
1656 Create a new draft message.
1661 @findex wl-folder-write-current-folder
1662 If the current cursor point is on the NNTP folder, create a new draft
1663 message which already has @samp{Newsgroups:} field. If the current
1664 cursor point is on the folder for mailing list (refile destination),
1665 create a new draft message which already has @samp{To:} field with
1666 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1668 (@code{wl-folder-write-current-folder})
1671 @kindex C-c C-o (Folder)
1672 @findex wl-jump-to-draft-buffer
1673 Move to the draft buffer if available. If multiple draft buffer exists,
1674 moved to one after another. If prefix argument is specified, load draft
1675 folder's message to the draft buffer and jump to it.
1676 (@code{wl-jump-to-draft-buffer})
1680 @findex wl-folder-check-current-entity
1681 Update new and unread number information of the folder at the current
1683 (@code{wl-folder-check-current-entity})
1687 @findex wl-folder-sync-current-entity
1688 Update summary information of the folder at the current cursor point.
1689 (@code{wl-folder-sync-current-entity})
1692 @kindex r s (Folder)
1693 @findex wl-folder-check-region
1694 Update new and unread number information of the folders in the currently
1696 (@code{wl-folder-check-region})
1699 @kindex r S (Folder)
1700 @findex wl-folder-sync-region
1701 Update summary information of the folders in the currently selected region.
1702 (@code{wl-folder-sync-region})
1706 @findex wl-status-update
1707 Sync up address book status with @file{~/.addresses}'s content.
1708 (@code{wl-status-update})
1712 @findex wl-folder-prev-unread
1713 Jump cursor to the folder which have unread messages on the upward from
1714 current cursor point.
1715 (@code{wl-folder-prev-unread})
1719 Jump cursor to the folder which have unread messages on the downward
1720 from current cursor point.
1721 (@code{wl-folder-next-unread})
1725 Move cursor to the folder on the previous line.
1726 (@code{wl-folder-prev-entity})
1730 Move cursor to the folder on the next line.
1731 (@code{wl-folder-next-entity})
1735 Jump to the folder specified by the user input.
1736 (@code{wl-folder-jump-folder})
1740 @findex wl-folder-prefetch-current-entity
1741 Prefetch new messages of the folder at the current cursor point by
1742 @code{wl-summary-incorporate}.
1743 If the cursor is on the folder group, it is executed recursively.
1744 (@code{wl-folder-prefetch-current-entity})
1748 @findex wl-folder-mark-as-read-all-current-entity
1749 Mark all unread messages of the folder at the current cursor point as read.
1750 If the cursor is on the folder group, it is executed recursively.
1751 (@code{wl-folder-mark-as-read-all-current-entity})
1755 @findex wl-folder-goto-first-unread-folder
1756 Enter summary mode of the first unread folder.
1757 (@code{wl-folder-goto-first-unread-folder})
1761 @findex wl-folder-empty-trash
1763 (@code{wl-folder-empty-trash})
1767 @findex wl-folder-open-all-unread-folder
1768 All unread folder is opened.
1769 (@code{wl-folder-open-all-unread-folder})
1773 @findex wl-folder-open-close
1774 Folder group is opened/closed.
1775 (@code{wl-thread-open-close})
1779 All folder group is opened.
1780 (@code{wl-folder-open-all})
1784 All folder group is closed.
1785 (@code{wl-folder-close-all})
1795 (@code{wl-folder-suspend})
1798 @kindex M-s (Folder)
1799 Save current folder status.
1803 @kindex M-t (Folder)
1804 Toggle Wanderlust's offline/online status.
1805 (@code{wl-toggle-plugged})
1808 @kindex C-t (Folder)
1809 Start Wanderlust's plug-status manager.
1810 (@code{wl-plugged-change})
1813 @subsection Customize variables
1816 @item wl-folders-file
1817 @vindex wl-folders-file
1818 The initial setting is @file{~/.folders}.
1819 Subscribed folders are described (saved) in this file.
1821 @item wl-folder-info-save
1822 @vindex wl-folder-info-save
1823 The initial setting is @code{t}. If non-nil, unread information is
1824 saved and used in the next Wanderlust session.
1826 @item wl-stay-folder-window
1827 @vindex wl-stay-folder-window
1828 The initial setting is @code{nil}.
1829 If non-nil, summary window is appeared on the right side of the folder buffer.
1831 @item wl-folder-window-width
1832 @vindex wl-folder-window-width
1833 The initial setting is 20.
1834 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1836 @item wl-folder-many-unsync-threshold
1837 @vindex wl-folder-many-unsync-threshold
1838 The initial setting is 70.
1839 If the number of unread messages is more than this value,
1840 folder color is changed.
1842 @item wl-highlight-folder-by-numbers
1843 @vindex wl-highlight-folder-by-numbers
1844 This option controls how to highlight each line in the folder buffer.
1845 The default value is @code{t}, highlighting with various colors based on
1846 the message numbers. If it is @code{nil}, highlighting with various
1847 colors based on the folder status. In addition, if it is a number
1848 (e.g. 1), highlighting will be done based on both the message numbers
1849 and the folder status.
1851 @item wl-folder-desktop-name
1852 @vindex wl-folder-desktop-name
1853 The initial setting is @samp{Desktop}.
1854 The name of top folder group.
1856 @item wl-folder-petname-alist
1857 @vindex wl-folder-petname-alist
1858 The initial setting is @code{nil}.
1859 An alist of folder's realname and its nickname.
1861 @item wl-folder-access-subscribe-alist
1862 @vindex wl-folder-access-subscribe-alist
1863 The initial setting is @code{nil}.
1865 Control automatic subscribing and unsubscribing of the children list
1871 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1875 If @var{subscribe-flag} is non-nil, folders which have name matched to
1876 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1877 already unsubscribed folder is not displayed even when the
1878 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1885 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1886 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1887 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1888 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1892 @item wl-folder-hierarchy-access-folders
1893 @vindex wl-folder-hierarchy-access-folders
1894 The initial setting is the list shown below:
1903 A list of access groups which creates children folder list hierarchically.
1905 For example, if you specify
1906 @code{wl-folder-hierarchy-access-folders} like following,
1910 (setq wl-folder-hierarchy-access-folders
1911 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1916 such access group hierarchy is obtained.
1922 -fj.comp.announce:0/0/2
1923 -fj.comp.dev.cdrom:0/0/0
1925 [+]-japan:238/238/1688
1928 -comp.unix.admin:0/0/0
1929 -comp.unix.dos-under-unix:0/0/0
1930 -comp.unix.programmer:0/0/0
1931 [-]-comp.unix.bsd:0/0/23
1932 -comp.unix.bsd.freebsd.announce:0/0/0
1937 If you opened @samp{-} in this example, only the direct children is created
1938 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1939 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1940 is not created until the children access group is opened.
1944 @node Folder Manager, , Selecting Folder, Folder
1945 @section Editing Folders
1946 @cindex Folder Manager
1947 @cindex Folder, Edit
1948 @cindex Folder, Subscribe
1949 @cindex Folder, Unsubscribe
1951 As described before, subscribed folder list is saved in @file{~/.folders} file.
1952 But you don't have to edit @file{~/.folders} directly.
1953 You can append, delete, edit folders from folder mode.
1955 @subsection Usage (Tips)
1957 @subsubsection Append Folder
1959 @kbd{m a} appends new folder to the folder mode.
1960 @kbd{m g} appends new folder group.
1961 To append new folder to this group, firstly open it,
1962 then execute append command in the next line.
1964 @subsubsection Edit Folder
1966 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1967 Thus, you can change folder position as if you were editing a normal file.
1969 @subsubsection Create Multi Folder.
1973 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
1975 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
1977 Type @kbd{m m}, then you can create multi folder.
1980 @subsubsection Delete Nickname, Filter
1982 You can delete nickname or filter by putting ``''(@var{NULL}) from the
1983 minibuffer while appending.
1985 @subsubsection Append Folder to Empty Group
1987 To append new folder to the empty folder group
1988 (after you create folder group by typing @kbd{m g}),
1989 firstly open it, then execute append command in the next line.
1990 If it is closed, folder is appended on the same level with
1991 the above folder group. It is difficult to explain by words so try it.
1992 In other words, appended position depends on the
1993 above folder group's open/close status.
1995 @subsubsection Charset of the Folders File.
1997 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
1999 @subsubsection Create Filter
2001 @kbd{m f} adds filter to the folder at the current cursor point. To
2002 create new filter folder and leave the current folder unchanged, copy it
2003 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2004 filter can be specified while appending filter. If you put
2005 ``''(@var{NULL}), filter is deleted.
2007 @subsubsection Sort Folders
2009 Sorting of the folders is executed by the function specified by
2010 @code{wl-fldmgr-sort-function}.
2011 The initial setting is @code{wl-fldmgr-sort-standard},
2012 which sorts alphabetically.
2013 Sorting affects only on the current folder group. It does not
2014 affect on the child groups.
2016 @subsubsection Hiding Folders in the Access Group
2018 Usually, access group displays all children folders, but you can set
2019 some folders hidden. Following operations are only available on access
2022 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2023 (subscribe/unsubscribe) of the folder at current cursor point. Against
2024 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2027 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2028 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2029 argument and if the argument has positive number, the unsubscribe it.
2030 If the prefix argument has negative value, folder becomes visible and if
2031 zero, folder visibility is toggled.
2033 The other commands, @code{wl-fldmgr-subscribe} and
2034 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2037 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2038 executed in the access group, they have a same effect with
2039 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2040 The difference is that cut commands deletes folders from the current
2043 @subsubsection Operations in the Access Group
2045 You can insert and delete folders in the access group like usual folder
2046 group. But insert and delete commands can be only available for the
2047 children folders of the access group and they only sets the subscribe
2048 status. In other words, insertion of the folder means subscribing,
2049 deletion means unsubscribing.
2050 @footnote{In the current implementation,
2051 it is faster to delete region than to unsubscribe region.}
2053 To update the access group when children folders are inserted or deleted
2054 by other way (other than Wanderlust),
2055 open the access group by typing @kbd{C-u @key{RET}}.
2056 @xref{Selecting Folder}.
2058 The order of children folders of access group is saved after
2059 insertion/deletion/sorting.
2060 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2061 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2062 newly created folders are inserted on the top of the access group.
2064 @subsection Key bindings
2065 @cindex Keybind, Folder Mode
2066 @cindex Keybind, Folder Buffer
2068 Key bindings on the folder mode related to folder editing are shown below.
2069 All bindings starts with @kbd{m}, and primary commands are binded to
2070 one stroke key binding.
2074 @kindex m a (Folder)
2075 @findex wl-fldmgr-add
2077 (@code{wl-fldmgr-add})
2082 @kindex m g (Folder)
2083 @findex wl-fldmgr-make-group
2084 Create a folder group.
2085 (@code{wl-fldmgr-make-group})
2088 @kindex m A (Folder)
2089 @findex wl-fldmgr-make-access-group
2090 Create an access group.
2091 (@code{wl-fldmgr-make-access-group})
2094 @kindex m d (Folder)
2095 @findex wl-fldmgr-delete
2096 Delete folder itself and msgdb.
2097 If the folder itself cannot be deleted like NNTP folder,
2098 only msgdb is deleted.
2099 (@code{wl-fldmgr-delete})
2104 @kindex m R (Folder)
2105 @findex wl-fldmgr-rename
2106 Change the name of folder or folder group.
2107 msgdb's path is also changed.
2108 (@code{wl-fldmgr-rename})
2114 @findex wl-fldmgr-make-multi
2115 Create a multi folders in the cutlist (cut, copied folders).
2116 (@code{wl-fldmgr-make-multi})
2121 @kindex m f (Folder)
2122 @findex wl-fldmgr-make-filter
2123 Create a filter folder. (Put a filter on the folder).
2124 (@code{wl-fldmgr-make-filter})
2128 @kindex M-c (Folder)
2129 @kindex m c (Folder)
2130 @findex wl-fldmgr-copy
2131 Copy folder (it is not available on folder group).
2132 (@code{wl-fldmgr-copy})
2136 @kindex M-w (Folder)
2137 @kindex m W (Folder)
2138 @findex wl-fldmgr-copy-region
2139 Copy folders in the specified region.
2140 (@code{wl-fldmgr-copy-region})
2144 @kindex C-k (Folder)
2145 @kindex m k (Folder)
2146 @findex wl-fldmgr-cut
2147 Cut folder. Folder itself is not deleted.
2148 (@code{wl-fldmgr-cut})
2152 @kindex C-w (Folder)
2153 @kindex m C-w (Folder)
2154 @findex wl-fldmgr-cut-region
2155 Cut folders in the specified region.
2156 (@code{wl-fldmgr-cut-region})
2160 @kindex C-y (Folder)
2161 @kindex m y (Folder)
2162 @findex wl-fldmgr-yank
2163 Paste folders that are copied or cut (folders in the cut-list).
2164 (@code{wl-fldmgr-yank})
2167 @kindex m p (Folder)
2168 @findex wl-fldmgr-set-petname
2169 Put nickname on the folder.
2170 (@code{wl-fldmgr-set-petname})
2173 @kindex m q (Folder)
2174 @findex wl-fldmgr-clear-cut-entity-list
2175 Clear the cut-list. (cut, copied folder information is cleared,
2176 you cannot paste after this)
2177 (@code{wl-fldmgr-clear-cut-entity-list})
2180 @kindex m s (Folder)
2181 @findex wl-fldmgr-sort
2182 Sort folders in the current folder group.
2183 (@code{wl-fldmgr-sort})
2186 @kindex m C-s (Folder)
2187 @findex wl-fldmgr-save
2188 Save current folder view to the @file{wl-folders-file}.
2189 (@code{wl-fldmgr-save})
2192 [Following commands are only available on the access groups]
2198 @kindex m u (Folder)
2199 @findex wl-fldmgr-unsubscribe
2200 Set the visibility of folder (subscribe/unsubscribe).
2201 (@code{wl-fldmgr-unsubscribe})
2206 @kindex r u (Folder)
2207 @findex wl-fldmgr-unsubscribe-region
2208 Set the visibility of the folders (subscribe/unsubscribe) in the
2210 (@code{wl-fldmgr-unsubscribe-region})
2215 @kindex m l (Folder)
2216 @findex wl-fldmgr-access-display-normal
2217 List folders that are currently available.
2218 (@code{wl-fldmgr-access-display-normal})
2223 @kindex m L (Folder)
2224 @findex wl-fldmgr-access-display-all
2225 List all folders regardless of the subscription status.
2226 (@code{wl-fldmgr-access-display-all})
2230 @subsection Customize variables
2233 @item wl-interactive-save-folders
2234 @vindex wl-interactive-save-folders
2235 The initial setting is @code{t}. If non-nil and folder view is
2236 modified, confirm saving it before Wanderlust or Emacs exits. If
2237 @code{nil}, save without confirmation.
2239 @item wl-fldmgr-make-backup
2240 @vindex wl-fldmgr-make-backup
2241 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2242 created before saving the folder status.
2244 @item wl-fldmgr-sort-function
2245 @vindex wl-fldmgr-sort-function
2246 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2247 sort folders. By default function, folders are sorted alphabetically
2248 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2251 @item wl-fldmgr-sort-group-first
2252 @vindex wl-fldmgr-sort-group-first
2253 The initial setting is @code{t}. If non-nil,
2254 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2255 does not care whether it is folder group or not.
2257 @item wl-folder-check-async
2258 @vindex wl-folder-check-async
2259 The initial setting is @code{t}. If non-nil, check folder's unread
2260 status asynchronously. It boosts newsgroup checking.
2262 @item wl-folder-check-fast
2263 @vindex wl-folder-check-fast
2264 The initial setting is @code{nil}.
2265 If non-nil, it does not update folder status while checking.
2267 @item wl-folder-notify-deleted
2268 @vindex wl-folder-notify-deleted
2269 The initial setting is @code{nil}.
2271 If non-nil, negative value is displayed when the message is deleted. If
2272 @code{sync}, folder is synchronized when the message is deleted. If
2273 @code{nil}, message deletion is ignored.
2276 @subsection Miscellanea
2278 Following is a note for folder editing.
2282 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2283 paste(yank) command pastes the folders on one cut or copy command
2284 (If copy command is executed by region, folders in the region are pasted
2285 by one paste command)
2288 You cannot cut @samp{Desktop} group.
2289 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2292 You cannot copy folder group.
2295 Operations on the access group are only available for the folders
2296 in the same access group.
2299 You cannot create a folder which has same name with the folders already exist.
2302 You cannot insert folders which have same name in one group.
2303 You can insert them in the different groups.
2304 You cannot put same nickname to the different folders.
2308 @node Summary, Message, Folder, Top
2309 @chapter Summary Mode
2311 After you select the folder via folder mode, you enter to the summary
2315 * Usage of Summary Mode:: TIPS
2316 * Thread Operations:: Thread operations
2317 * Cache:: File cache, Buffer cache, and Prefetch
2318 * Auto Refile:: Auto refile settings
2319 * Sticky Summary:: Summary make sticky
2320 * Key Bindings of Summary:: Key bindings
2321 * Variables of Summary:: Customize Summary Mode
2325 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2326 @section Usage (Tips)
2328 @subsection Summary Content
2330 In the summary mode, messages are displayed like following.
2334 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2335 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2336 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2337 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2344 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2348 You cannot change this in the current version.
2350 @var{Message number} is the message's unique number in the folder. In
2351 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2352 in the MH folder, it is the filename of the message.
2354 @var{Temporal mark} and @var{Persistent mark} are described later.
2356 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2357 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2358 Japanese, but if you want to display it in English, set the value of
2359 @code{wl-summary-weekday-name-lang} as @samp{en}.
2361 @var{Sender}'s indentation corresponds to the depth of the thread.
2362 Sender name is displayed as nickname if it is defined in the address
2363 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2364 displaying with nickname.
2366 If number is printed at the head of @var{Sender} part like @samp{+2},
2367 that means the message have 2 follow messages.
2369 @var{Subject} is the @samp{Subject:} header field of the message. If
2370 the message have same @samp{Subject:} with the parent message, it is not
2371 displayed. Some mailing list puts its sequence number in the
2372 @samp{Subject:} field, but it is
2373 ignored. @code{wl-summary-no-subject-message} is displayed when the
2374 message has empty subject field.
2376 @subsection Temporary Marks
2377 @cindex Mark, Temporary
2379 There are four temporary marks,
2380 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2381 Temporary marks indicates message operations.
2386 You can execute a command on the all messages that have @samp{*} mark,
2387 with the key bindings which begins with @kbd{m}.
2390 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2394 After you type @kbd{o} key, prompt appears to input refile destination.
2395 Your answer is printed in the summary line.
2399 You can put this mark by typing @kbd{O} key.
2400 The difference between this mark and refile mark is,
2401 this mark does not delete the message while latter does.
2404 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2406 @subsection Persistent Marks
2408 There are five persistent marks,
2409 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2411 The persistent mark indicates the message's status and it is saved.
2412 Each persistent mark indicates:
2418 It is unread message.
2420 It is unread but cached message.
2422 It is read but it is not cached.
2424 It is important message. You can put @samp{$} mark by typing @kbd{$}
2425 key (if already exists, the mark is deleted). It is convenient to put
2426 this mark on the messages to remember (If you want to remember to write
2427 a reply for the message, for example) because this mark remains after
2428 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2429 even the message itself is deleted in the actual folder.
2432 If the message is read and cached (or local message),there are no
2436 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2437 cache. Messages with the marks other than these, you can read them in
2438 the offline status even they are in the IMAP folder or netnews folder.
2440 @subsection How To Read
2442 Basically, you can read messages only typing space key again and again.
2444 To update summary status to the newest status (synchronize),
2447 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2448 moves cursor to the next message.
2449 Enter message buffer by typing @kbd{j} key.
2450 To operate multipart, you have to enter to the message buffer.
2453 @subsection Pack the Message Numbers
2454 You can pack the message numbers in Summary by
2455 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2456 News Spool Folder and Maildir Folder are supported folder types.
2459 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2460 @section Thread Operations
2462 For example, the following line indicates one thread (a context of a topic).
2465 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2469 If you type @kbd{/} on this line, the thread is opened and it changes
2470 the appearance like following.
2474 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2475 388 09/17(Thu)22:34 +-[ Murata san ]
2479 (Message 388 is the replied message to the message 384.)
2480 If you type @kbd{/} key once again, the thread is closed.
2481 With prefix argument, @kbd{/} opens all children threads.
2483 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2486 Commands with the key binding that begins with @kbd{t} executes commands
2487 on the messages in the thread.
2488 @xref{Key Bindings of Summary}.
2490 @subsection reconstruct thread by hand
2492 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2493 (@code{wl-summary-save-current-message}) at the corresponding message,
2494 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2495 message then you have the reconstructed thread.
2498 @node Cache, Auto Refile, Thread Operations, Summary
2501 @subsection Cache File
2503 The messages which have to access via network (e.x. IMAP, NNTP folder)
2504 are cached as a local file. The cache file is saved under the directory
2505 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2506 elmo-cache-expire-by-size}. The command deletes cache files to the
2507 specified size by the order of last accessed time.
2509 @subsection Buffer Cache and Prefetching
2511 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2512 that are read are kept in the cache buffer. It is called `buffer
2513 cache'. The number of cache buffer is specified by
2514 @code{elmo-buffer-cache-size}.
2516 There are message prefetching mechanism in the Wanderlust that
2517 prefetches next message while you are reading. This function requires
2518 that the value of @code{elmo-use-buffer-cache} is non-nil.
2520 You can control the message prefetching mechanism by these two
2524 @item wl-cache-prefetch-folder-type-list
2525 @vindex wl-cache-prefetch-folder-type-list
2526 The initial setting is the list shown below:
2534 It specifies the folder types in which message prefetching is enabled.
2535 In the initial setting, multi folder that contains localdir and imap4
2536 prefetches only imap4 messages. This variable precedes the value of
2537 @code{wl-cache-prefetch-folder-list}.
2539 If you want to prefetch localdir and localnews also, following setting
2544 (setq wl-cache-prefetch-folder-type-list
2545 '(nntp imap4 localdir localnews))
2549 @item wl-cache-prefetch-folder-list
2550 @vindex wl-cache-prefetch-folder-list
2551 The initial setting is @code{nil}.
2552 A list of regexp of folders to enable message prefetching.
2556 @node Auto Refile, Sticky Summary, Cache, Summary
2557 @section Auto Refile
2558 @vindex elmo-msgdb-extra-fields
2559 @vindex wl-refile-rule-alist
2560 @findex wl-summary-auto-refile
2562 You can refile messages automatically, by typing @kbd{C-o}
2563 (@code{wl-summary-auto-refile}). It decides destination of refile by
2564 the content of the message header information (information in the msgdb).
2566 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2567 available. If you want to decide destination by other header fields,
2568 set the variable @code{elmo-msgdb-extra-fields} like following.
2572 (setq elmo-msgdb-extra-fields
2582 By this setting, Wanderlust saves extra fields in the msgdb. You have
2583 to type @kbd{s all} to get extra fields for the messages that are
2584 already exists in the summary.
2586 Then, specify the refile rule. The refile target folder of auto
2587 refiling is decided by the value of @code{wl-refile-rule-alist}.
2588 @code{wl-refile-rule-alist} is a list of a rule:
2592 (@var{field} (@var{regexp} . @var{target})
2593 (@var{regexp} . @var{target})
2598 Each rule means `if @var{field} value matches @var{regexp},
2599 then refile to @var{target} folder'.
2600 The rule matched first is applied.
2602 @var{field} is a string of field name. You can specify a list of field name
2603 string, too. In this case, if one of these fields is matched, then the
2604 rule is fired (i.e. OR condition).
2606 @var{regexp} is a regular expression for field value. @var{target} is a target
2607 folder string. You can specify a rule at @var{target} part, too. In this
2608 case, If the field value of the rule and the current rule is matched,
2609 then the current rule is fired (i.e. AND condition).
2611 In @var{target} part, you can refer matched substring of @var{regexp}.
2612 To refer substring, specify following in @var{target}:
2616 means substitute original matched text.
2619 means substitute what matched the @var{N}th `\(@dots{}\)'.
2620 (@var{N} is a number.)
2623 Following is an example of @code{wl-refile-rule-alist}.
2627 (setq wl-refile-rule-alist
2629 ("^Wanderlust" . "+wl")
2630 ("^Elisp" . "+elisp"))
2632 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2634 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2635 "+from-me-to-you"))))))
2639 After these settings, refile marks are automatically put on the condition
2640 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2642 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2644 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2645 with these persistent marks are not automatically refiled.
2646 It means Wanderlust does not execute auto refile on unread messages by
2647 the default setting.
2648 To execute auto refile on all messages, set following.
2651 (setq wl-summary-auto-refile-skip-marks nil)
2655 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2656 @section Sticky Summary
2657 @cindex Summary, Sticky
2658 @cindex Sticky Summary
2660 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2662 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2663 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2665 The buffer name of the sticky summary becomes like
2666 @samp{Summary:@var{folder-name}}.
2668 You can visit the sticky summary at any time by @kbd{C-x b}
2669 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2670 q}. Other operations in the sticky summary are same as normal summary.
2672 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2673 are automatically stuck.
2676 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2677 @section Key bindings
2678 @cindex Keybind, Summary Mode
2679 @cindex Keybind, Summary Buffer
2681 Key bindings of the summary mode are shown below.
2685 @kindex @key{SPC} (Summary)
2686 @findex wl-summary-read
2687 Proceed reading a message at the current cursor point.
2688 (@code{wl-summary-read})
2692 @findex wl-summary-redisplay
2693 Redisplay a message at the current cursor point.
2694 If this command is called with prefix argument,
2695 Redisplay message regardless of the message cache (message is re-loaded
2697 (@code{wl-summary-redisplay})
2701 @findex wl-summary-display-top
2702 Display the top message in the folder.
2703 (@code{wl-summary-display-top})
2707 @findex wl-summary-display-bottom
2708 Display the bottom message in the folder.
2709 (@code{wl-summary-display-bottom})
2713 @kindex @key{BS} (Summary)
2714 @kindex @key{DEL} (Summary)
2715 Display the previous page of the message at the current cursor point.
2716 @findex wl-summary-prev-page
2717 (@code{wl-summary-prev-page})
2720 @kindex @key{RET} (Summary)
2721 @findex wl-summary-next-line-content
2722 Display the next line of the message at the current cursor point.
2723 Display the message at the current cursor point if it is not displayed yet.
2724 (@code{wl-summary-next-line-content})
2729 @kindex M-@key{RET} (Summary)
2730 @findex wl-summary-prev-line-content
2731 Display the previous line of the message at the current cursor point.
2732 Display the message at the current cursor point if it is not displayed yet.
2733 (@code{wl-summary-prev-line-content})
2737 @findex wl-thread-open-close
2738 Toggle open or close the thread at the current cursor point.
2739 (@code{wl-thread-open-close})
2744 @findex wl-thread-open-all
2745 (@code{wl-thread-open-all})
2750 @findex wl-thread-close-all
2751 (@code{wl-thread-close-all})
2755 @findex wl-summary-goto-folder
2757 (@code{wl-summary-goto-folder})
2761 Mark all messages in the folder as read.
2762 @findex wl-summary-mark-as-read-all
2763 (@code{wl-summary-mark-as-read-all})
2767 @findex wl-summary-reply
2768 Prepare a draft for reply the message at the current cursor point.
2769 (@code{wl-summary-reply})
2773 @findex wl-summary-reply-with-citation
2774 Prepare a draft for reply the message at the current cursor point.
2775 (@code{wl-summary-reply-with-citation})
2779 @findex wl-summary-cancel-message
2780 If the message at current cursor point is your own netnews article,
2782 (@code{wl-summary-cancel-message})
2786 @findex wl-summary-reedit
2787 Prepare a draft for re-editing the message at current cursor point.
2788 If the message at current cursor point is your own netnews article,
2789 a draft for `supersedes message' for the message is prepared.
2790 (@code{wl-summary-reedit})
2793 @kindex M-e (Summary)
2794 @findex wl-summary-resend-bounced-mail
2795 If the message at current cursor point is a bounced message,
2796 a draft for re-sending original message is prepared.
2797 (@code{wl-summary-resend-bounced-mail})
2801 @findex wl-summary-forward
2802 A draft for forwarding the message at current cursor point is prepared.
2803 (@code{wl-summary-forward})
2807 @findex wl-summary-mark-as-important
2808 Put @samp{$} mark on the message at current cursor point.
2809 If already marked as @samp{$}, delete it.
2810 (@code{wl-summary-mark-as-important})
2816 Save the message at current cursor point.
2817 @findex wl-summary-save
2818 (@code{wl-summary-save})
2822 @findex wl-summary-next
2823 Move cursor to the next message.
2824 If message is marked with a temporal mark in
2825 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2826 In the offline mode, cursor is not moved to the messages which are not cached
2828 (@code{wl-summary-next})
2832 @findex wl-summary-prev
2833 Move cursor to the previous message.
2834 If message is marked with a temporal mark in
2835 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2836 In the offline mode, cursor is not moved to the messages which are not cached
2838 (@code{wl-summary-prev})
2842 @findex wl-summary-down
2843 Move cursor to the downward message which is unread or marked
2845 In the offline mode, cursor is not moved to the messages which are not cached
2847 If there are messages which have target mark @samp{*} in the summary,
2848 cursor is moved to the downward message which have a target mark.
2849 This behavior is changed according to the value of @code{wl-summary-move-order}.
2850 (@code{wl-summary-down})
2854 @findex wl-summary-up
2855 Move cursor to the upward message which is unread or marked
2857 In the offline mode, cursor is not moved to the messages which are not cached
2859 If there are messages which have target mark @samp{*} in the summary,
2860 cursor is moved to the downward message which have a target mark.
2861 This behavior is changed according to the value of @code{wl-summary-move-order}.
2862 (@code{wl-summary-up})
2866 @findex wl-summary-write
2867 Prepare a new draft.
2868 (@code{wl-summary-write})
2872 @findex wl-summary-write-current-folder
2873 Prepare a new draft. If the current folder is NNTP folder,
2874 @samp{Newsgroups:} field is completed. If the current folder is mailing
2875 list folder (refile destination), guess @samp{To:} field and completed
2876 (If @code{wl-subscribed-mailing-list} is valid list)
2877 (@code{wl-summary-write-current-folder})
2881 @findex wl-summary-redisplay-all-header
2882 Redisplay the message at current cursor point with all header fields.
2883 (@code{wl-summary-redisplay-all-header})
2887 @findex wl-summary-redisplay-no-mime
2888 Redisplay the message at current cursor point without MIME analysis.
2889 (@code{wl-summary-redisplay-no-mime})
2893 @findex wl-summary-burst
2894 If the message at current cursor point has
2895 encapsulates multiple messages using MIME,
2896 de-capsulate and extract them on the current folder.
2897 (@code{wl-summary-burst})
2900 @kindex @@ (Summary)
2901 @findex wl-summary-edit-addresses
2902 Append/change/delete the message's sender information to the address
2903 book @file{~/.addresses} interactively. If this command is called with
2904 prefix argument, arbitrary address can be edited.
2905 (@code{wl-summary-edit-petname})
2909 @findex wl-status-update
2910 Sync up address book status with @file{~/.addresses}'s content.
2911 (@code{wl-status-update})
2915 @findex wl-summary-pipe-message
2916 Pipe current message's content to the external process.
2917 (@code{wl-summary-pipe-message})
2921 @findex wl-summary-print-message
2922 Print out current message's content.
2923 It uses @code{ps-print} module in Emacs 20.x.
2924 If you don't use color printer, you might want to set
2925 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
2928 (setq wl-ps-print-buffer-function 'ps-print-buffer)
2931 (@code{wl-summary-print-message})
2935 @findex wl-summary-exit
2936 Exit current folder.
2937 (@code{wl-summary-exit})
2941 @findex wl-summary-jump-to-current-message
2942 Jump cursor to the currently displayed message's window.
2943 (@code{wl-summary-jump-to-current-message})
2947 Jump cursor to the other message.
2948 @findex wl-summary-jump-to-msg
2949 (@code{wl-summary-jump-to-msg})
2953 Update summary status and
2954 prefetch all messages which have marks included in the
2955 @code{wl-summary-incorporate-marks}.
2956 @findex wl-summary-incorporate
2957 (@code{wl-summary-incorporate})
2960 @kindex M-j (Summary)
2961 @findex wl-summary-jump-to-msg-by-message-id
2962 Jump cursor to the message which have specified @samp{Message-Id:}. If
2963 @code{elmo-use-database} is non-nil, other folder is also searched.
2964 (@code{wl-summary-jump-to-msg-by-message-id})
2968 Jump to parent message.
2969 @findex wl-summary-jump-to-parent-message
2970 (@code{wl-summary-jump-to-parent-message})
2974 @findex wl-summary-mark-as-unread
2975 Mark as unread the message at current cursor point.
2976 (@code{wl-summary-mark-as-unread})
2980 @findex wl-summary-sync
2981 Synchronize summary view after prompting the update range
2982 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
2986 all ...Discard current summary and update all message.
2987 update ...Update the difference between summary and the folder itself.
2988 rescan ...Rescan the msgdb and display again.
2989 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2990 first, last ...Move to the filter folder(partial filter).
2995 (@code{wl-summary-sync})
2999 @findex wl-summary-sort
3001 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3002 (@code{wl-summary-sort})
3006 @findex wl-summary-toggle-thread
3007 Toggle the threading.
3008 Threading status is displayed on the modeline.
3009 @samp{@{S@}} means threading is off (Sequence) and
3010 @samp{@{T@}} means threading is on (Thread).
3011 (@code{wl-summary-toggle-thread})
3015 @findex wl-summary-toggle-disp-folder
3016 Toggle displaying of folder window.
3017 (@code{wl-summary-toggle-disp-folder})
3021 Toggle displaying of message window.
3022 @findex wl-summary-toggle-disp-msg
3023 (@code{wl-summary-toggle-disp-msg})
3027 Move to the virtual folder with the condition specified.
3028 If called with prefix argument and current folder is virtual, exit it.
3029 @findex wl-summary-virtual
3030 (@code{wl-summary-virtual})
3033 @kindex @key{TAB} (Summary)
3034 @findex wl-summary-goto-last-displayed-msg
3035 Jump to the message which is displayed last.
3036 (@code{wl-summary-goto-last-displayed-msg})
3040 Put @samp{*} mark on the messages that satisfies the specified condition.
3041 @findex wl-summary-pick
3042 (@code{wl-summary-pick})
3046 @findex wl-summary-mark-as-read
3047 Mark as read the message at the current cursor point.
3048 (@code{wl-summary-mark-as-read})
3052 Prefetch the message at the current cursor point.
3053 With prefix argument, prefetch the message even if it is cached.
3054 @findex wl-summary-prefetch
3055 (@code{wl-summary-prefetch})
3059 Execute @samp{D}, @samp{o} and @samp{O} marks.
3060 @findex wl-summary-exec
3061 (@code{wl-summary-exec})
3065 @findex wl-summary-target-mark-line
3066 Put target mark on the message at the current cursor point.
3067 (@code{wl-summary-target-mark-line})
3071 Put refile mark on the message at the current cursor point.
3072 @findex wl-summary-refile
3073 (@code{wl-summary-refile})
3076 @kindex C-o (Summary)
3077 Execute auto refile.
3078 @findex wl-summary-auto-refile
3079 (@code{wl-summary-auto-refile})
3083 Put copy mark on the message at the current cursor point.
3084 @findex wl-summary-copy
3085 (@code{wl-summary-copy})
3088 @kindex M-o (Summary)
3089 Put refile mark on the message at the current cursor point with the destination
3090 previously specified.
3091 @findex wl-summary-refile-prev-destination
3092 (@code{wl-summary-refile-prev-destination})
3096 @findex wl-summary-delete
3097 Put delete mark on the message at the current cursor point.
3098 (@code{wl-summary-delete})
3102 @findex wl-summary-unmark
3103 Unmark the temporal mark on the message at the current cursor point.
3104 (@code{wl-summary-unmark})
3108 Unmark all the temporal marks.
3109 @findex wl-summary-unmark-all
3110 (@code{wl-summary-unmark-all})
3113 @kindex r R (Summary)
3114 @findex wl-summary-mark-as-read-region
3115 Mark as read messages in the specified region.
3116 (@code{wl-summary-mark-as-read-region})
3119 @kindex r $ (Summary)
3120 @findex wl-summary-mark-as-important-region
3121 Mark as important @samp{$} messages in the specified region.
3122 If @samp{$} already exists, it is deleted.
3123 (@code{wl-summary-mark-as-important-region})
3126 @kindex r ! (Summary)
3127 @findex wl-summary-mark-as-unread-region
3128 Mark as unread messages in the specified region.
3129 (@code{wl-summary-mark-as-unread-region})
3132 @kindex r i (Summary)
3133 @findex wl-summary-prefetch-region
3134 Prefetch messages in the specified region.
3135 (@code{wl-summary-prefetch-region})
3138 @kindex r x (Summary)
3139 @findex wl-summary-exec-region
3140 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3142 (@code{wl-summary-exec-region})
3145 @kindex r * (Summary)
3146 @findex wl-summary-target-mark-region
3147 Put target mark on the messages in the specified region.
3148 (@code{wl-summary-target-mark-region})
3151 @kindex r o (Summary)
3152 @findex wl-summary-refile-region
3153 Put refile mark on the messages in the specified region.
3154 (@code{wl-summary-refile-region})
3157 @kindex r O (Summary)
3158 @findex wl-summary-copy-region
3159 Put copy mark on the messages in the specified region.
3160 (@code{wl-summary-copy-region})
3163 @kindex r d (Summary)
3164 @findex wl-summary-delete-region
3165 Put delete mark on the messages in the specified region.
3166 (@code{wl-summary-delete-region})
3169 @kindex r u (Summary)
3170 @findex wl-summary-unmark-region
3171 Delete temporal mark on the messages in the specified region.
3172 (@code{wl-summary-unmark-region})
3175 @kindex r y (Summary)
3176 Save messages in the specified region.
3177 @findex wl-summary-save-region
3178 (@code{wl-summary-save-region})
3181 @kindex t R (Summary)
3182 @findex wl-thread-mark-as-read
3183 Mark as read messages which are the descendant of the current thread.
3184 With prefix argument, it affects on the all messages in the thread tree.
3185 (@code{wl-thread-mark-as-read})
3188 @kindex t $ (Summary)
3189 @findex wl-thread-mark-as-important
3190 Put important mark @samp{$} on the messages which are the
3191 descendant of the current thread.
3192 If @samp{$} mark exists, it is deleted.
3193 With prefix argument, it affects on the all messages in the thread tree.
3194 (@code{wl-thread-mark-as-important})
3197 @kindex t ! (Summary)
3198 @findex wl-thread-mark-as-unread
3199 Mark as unread messages which are the descendant of the current thread.
3200 With prefix argument, it affects on the all messages in the thread tree.
3201 (@code{wl-thread-mark-as-unread})
3204 @kindex t i (Summary)
3205 @findex wl-thread-prefetch
3206 Prefetch messages which are the descendant of the current thread.
3207 With prefix argument, it affects on the all messages in the thread tree.
3208 (@code{wl-thread-prefetch})
3211 @kindex t x (Summary)
3212 @findex wl-thread-exec
3213 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3214 the descendant of the current thread. With prefix argument, it affects
3215 on the all messages in the thread tree.
3216 (@code{wl-thread-exec})
3219 @kindex t * (Summary)
3220 @findex wl-thread-target-mark
3221 Put target mark @samp{*} on the messages which are the descendant of the
3222 current thread. With prefix argument, it affects on the all messages in
3224 (@code{wl-thread-target-mark})
3227 @kindex t o (Summary)
3228 @findex wl-thread-refile
3229 Put refile mark on the messages which are the descendant of the current thread.
3230 With prefix argument, it affects on the all messages in the thread tree.
3231 (@code{wl-thread-refile})
3234 @kindex t O (Summary)
3235 @findex wl-thread-copy
3236 Put copy mark on the messages which are the descendant of the current thread.
3237 With prefix argument, it affects on the all messages in the thread tree.
3238 (@code{wl-thread-copy})
3241 @kindex t d (Summary)
3242 @findex wl-thread-delete
3243 Put delete mar on the messages which are the descendant of the current thread.
3244 With prefix argument, it affects on the all messages in the thread tree.
3245 (@code{wl-thread-delete})
3248 @kindex t u (Summary)
3249 @findex wl-thread-unmark
3250 Unmark temporal mark on the messages which are the descendant of the
3251 current thread. With prefix argument, it affects on the all messages in
3253 (@code{wl-thread-unmark})
3256 @kindex t y (Summary)
3257 @findex wl-thread-save
3258 Save messages which are the descendant of the current thread.
3259 With prefix argument, it affects on the all messages in the thread tree.
3260 (@code{wl-thread-save})
3263 @kindex m i (Summary)
3264 @findex wl-summary-target-mark-prefetch
3265 Prefetch all messages which have target mark @samp{*}.
3266 (@code{wl-summary-target-mark-prefetch})
3269 @kindex m R (Summary)
3270 @findex wl-summary-target-mark-mark-as-read
3271 Mark as read all messages which have target mark @samp{*}.
3272 (@code{wl-summary-target-mark-mark-as-read})
3275 @kindex m $ (Summary)
3276 @findex wl-summary-target-mark-mark-as-important
3277 Mark as important all messages which have target mark @samp{*}.
3278 If already marked as @samp{$}, it is deleted.
3279 (@code{wl-summary-target-mark-mark-as-important})
3282 @kindex m ! (Summary)
3283 @findex wl-summary-target-mark-mark-as-unread
3284 Mark as unread all messages which have target mark @samp{*}.
3285 (@code{wl-summary-target-mark-mark-as-unread})
3288 @kindex m o (Summary)
3289 @findex wl-summary-target-mark-refile
3290 Put refile mark on the messages which have target mark @samp{*}.
3291 (@code{wl-summary-target-mark-refile})
3294 @kindex m O (Summary)
3295 @findex wl-summary-target-mark-copy
3296 Put copy mark on the messages which have target mark @samp{*}.
3297 (@code{wl-summary-target-mark-copy})
3300 @kindex m d (Summary)
3301 @findex wl-summary-target-mark-delete
3302 Put delete mark on the messages which have target mark @samp{*}.
3303 (@code{wl-summary-target-mark-delete})
3306 @kindex m y (Summary)
3307 @findex wl-summary-target-mark-save
3308 Save messages which have target mark @samp{*}.
3309 (@code{wl-summary-target-mark-save})
3312 @kindex m u (Summary)
3313 Unmark all temporal marks.
3314 (@code{wl-summary-delete-all-temp-marks})
3315 @findex wl-summary-delete-all-temp-marks
3318 @kindex m a (Summary)
3319 Put target mark @samp{*} on the all messages.
3320 (@code{wl-summary-target-mark-all})
3321 @findex wl-summary-target-mark-all
3324 @kindex m t (Summary)
3325 Put target mark @samp{*} on the messages in the current thread.
3326 @findex wl-summary-target-mark-thread
3327 (@code{wl-summary-target-mark-thread})
3330 @kindex m r (Summary)
3331 @findex wl-summary-target-mark-region
3332 Put target mark @samp{*} on the messages in the specified region.
3333 (@code{wl-summary-target-mark-region})
3336 @kindex m A (Summary)
3337 @findex wl-summary-target-mark-reply-with-citation
3338 Prepare a draft which cites all messages which have target mark @samp{*}.
3339 (@code{wl-summary-target-mark-reply-with-citation})
3342 @kindex m f (Summary)
3343 @findex wl-summary-target-mark-forward
3344 Prepare a draft which forwards all messages which have target mark @samp{*}.
3345 (@code{wl-summary-target-mark-forward})
3348 @kindex m U (Summary)
3349 @findex wl-summary-target-mark-uudecode
3350 Uudecode the messages which have target mark @samp{*}.
3351 (@code{wl-summary-target-mark-uudecode})
3354 @kindex m ? (Summary)
3355 @findex wl-summary-target-mark-pick
3356 Pick messages from the @samp{*} marked messages.
3357 That is, @samp{*} marks on the messages are remained
3358 if the specified condition is satisfied.
3359 (@code{wl-summary-target-mark-pick})
3362 @kindex M-t (Summary)
3363 @findex wl-toggle-plugged
3364 Toggle offline/online status of Wanderlust.
3365 (@code{wl-toggle-plugged})
3368 @kindex C-t (Summary)
3369 Start Wanderlust's plug-status manager.
3370 (@code{wl-plugged-change})
3373 @kindex C-c C-o (Summary)
3374 @findex wl-jump-to-draft-buffer
3375 Move to the draft buffer if available. If multiple draft buffer exists,
3376 moved to one after another. If prefix argument is specified, load draft
3377 folder's message to the draft buffer and jump to it.
3378 (@code{wl-jump-to-draft-buffer})
3381 @kindex M-w (Summary)
3382 @findex wl-summary-save-current-message
3383 Save the message at the current cursor point.
3384 (@code{wl-summary-save-current-message})
3387 @kindex C-y (Summary)
3388 @findex wl-summary-yank-saved-message
3389 Regard the message at the current cursor point as
3390 parent, connect the message saved by
3391 @code{wl-summary-save-current-message}
3393 (@code{wl-summary-yank-saved-message})
3397 @node Variables of Summary, , Key Bindings of Summary, Summary
3398 @section Customiziable variables
3401 @item wl-summary-move-order
3402 @vindex wl-summary-move-order
3403 The initial setting is @code{unread}. Specify cursor moving policy. If
3404 you want to precede new messages, set @code{new}. If you want to
3405 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3408 @item wl-auto-select-first
3409 @vindex wl-auto-select-first
3410 The initial setting is @code{nil}.
3411 If non-nil, first message is automatically displayed.
3413 @item wl-auto-select-next
3414 @vindex wl-auto-select-next
3415 The initial setting is @code{nil}. If non-nil, jump to next summary
3416 automatically. If @code{unread}, jump to next unread folder's summary
3417 after confirmation. If @code{skip-no-unread}, unread folders are
3418 automatically skipped.
3420 @item wl-thread-insert-opened
3421 @vindex wl-thread-insert-opened
3422 The initial setting is @code{nil}.
3423 If non-nil, thread is inserted as opened.
3425 @item wl-thread-open-reading-thread
3426 @vindex wl-thread-open-reading-thread
3427 The initial setting is @code{t}. If non-nil, reading thread is
3428 automatically opened though it is closed thread.
3430 @item wl-summary-exit-next-move
3431 @vindex wl-summary-exit-next-move
3432 The initial setting is @code{t}. If non-nil, move to next folder at
3435 @item wl-folder-move-cur-folder
3436 @vindex wl-folder-move-cur-folder
3437 The initial setting is @code{nil}. If non-nil, cursor position on the
3440 @item wl-summary-weekday-name-lang
3441 @vindex wl-summary-weekday-name-lang
3442 The initial setting is @samp{ja}. Specify language of the weekday.
3443 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3446 @item wl-summary-fix-timezone
3447 @vindex wl-summary-fix-timezone
3448 The initial setting is @code{nil}.
3449 Time zone of the date string in summary mode is adjusted using this value.
3450 If @code{nil}, it is adjust to the default time zone information
3451 (system's default time zone or environment variable @samp{TZ}).
3453 @item wl-use-petname
3454 @vindex wl-use-petname
3455 The initial setting is @code{t}.
3456 If non-nil, sender part displays nickname.
3458 @item wl-break-pages
3459 @vindex wl-break-pages
3460 The initial setting is @code{t}.
3461 If non-nil, message is split as pages by @samp{^L}.
3463 @item wl-message-window-size
3464 @vindex wl-message-window-size
3465 The initial setting is '(1 . 4).
3466 A cons cell to specify the rate of summary and message window.
3467 car:cdr corresponds summary:message.
3469 @item wl-summary-recenter
3470 @vindex wl-summary-recenter
3471 The initial setting is t.
3472 If non-nil, cursor point is moved to the center of the summary window.
3474 @item wl-summary-indent-length-limit
3475 @vindex wl-summary-indent-length-limit
3476 The initial setting is 46.
3477 Specify the limit of thread indent level.
3478 If nil, max indent level is unlimited.
3480 @item wl-summary-no-from-message
3481 @vindex wl-summary-no-from-message
3482 The initial setting is @samp{nobody@@nowhere?}. A string which is
3483 displayed when there's no @samp{From:} field in the message.
3485 @item wl-summary-no-subject-message
3486 @vindex wl-summary-no-subject-message
3487 The initial setting is @samp{(WL:No Subject in original.)}. A string
3488 which is displayed when there's no @samp{Subject:} field in the message.
3490 @item wl-summary-width
3491 @vindex wl-summary-width
3492 The initial setting is 80.
3493 Width of summary line. If @code{nil}, summary line's width is as is.
3495 @item wl-use-folder-petname
3496 @vindex wl-use-folder-petname
3497 The initial setting is the list shown below:
3506 A list of display policy (symbol) of folder nickname. Available symbols
3511 Display folder petname on modeline.
3513 Destination folder is notified as nickname if
3514 @code{wl-auto-select-next} is non-nil.
3516 You can input folder name by nickname in the function
3517 @code{wl-summary-read-folder}.
3520 @item wl-summary-move-direction-toggle
3521 @vindex wl-summary-move-direction-toggle
3522 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3523 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3524 want to aware of reading direction, set this to @code{t}.
3527 @vindex wl-from-width
3528 The initial setting is 17.
3529 Width of sender part of summary line.
3531 @item wl-summary-divide-thread-when-subject-changed
3532 @vindex wl-summary-divide-thread-when-subject-changed
3533 The initial setting is @code{nil}. If non-nil, thread is split if
3534 the subject is changed.
3536 @item wl-summary-search-via-nntp
3537 @vindex wl-summary-search-via-nntp
3538 The initial setting is @code{confirm}.
3540 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3541 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3542 from the NNTP server @code{elmo-nntp-default-server}. The value of
3543 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3544 @code{elmo-nntp-default-stream-type} are used.
3546 If @code{confirm}, server name can be specified. You can specify NNTP
3547 folder format like @samp{-:username@@servername:119!}.
3549 @item wl-summary-keep-cursor-command
3550 @vindex wl-summary-keep-cursor-command
3551 The initial setting is the list shown below:
3555 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3560 When you entered to summary by these commands and the target summary
3561 buffer already exists, summary status is not automatically updated and
3562 cursor position is saved.
3564 @item wl-summary-update-confirm-threshold
3565 @vindex wl-summary-update-confirm-threshold
3566 The initial setting is 500. If updated message number is larger than
3567 this value, confirm whether drop them or not.
3569 @item wl-summary-always-sticky-folder-list
3570 @vindex wl-summary-always-sticky-folder-list
3571 The initial setting is @code{nil}.
3572 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3573 are automatically stuck. Each element is regexp of folder name.
3575 @item wl-summary-reserve-mark-list
3576 @vindex wl-summary-reserve-mark-list
3577 The initial setting is the list shown below:
3586 If a message is already marked as temporal marks in this list, the
3587 message is not marked by any mark command.
3589 @item wl-summary-skip-mark-list
3590 @vindex wl-summary-skip-mark-list
3591 The initial setting is the list shown below:
3600 If a message is already marked as temporal marks in this list, the
3601 message is skipped at cursor move.
3603 @item wl-fetch-confirm-threshold
3604 @vindex wl-fetch-confirm-threshold
3605 The initial setting is 30000 (bytes). If displaying message has larger
3606 size than this value, Wanderlust confirms whether fetch the message or
3607 not. If @code{nil}, the message is fetched without confirmation.
3609 @item wl-prefetch-threshold
3610 @vindex wl-prefetch-threshold
3611 The initial setting is 30000 (bytes). If prefetching message has larger
3612 size than this value and @code{wl-prefetch-confirm} is non-nil,
3613 Wanderlust confirms whether prefetch the message or not. If
3614 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3615 without confirmation.
3617 @item wl-prefetch-confirm
3618 @vindex wl-prefetch-confirm
3619 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3620 prefetch the message or not if the message has larger size than
3621 @code{wl-prefetch-threshold}.
3623 @item wl-cache-fetch-threshold
3624 @vindex wl-cache-fetch-threshold
3625 The initial setting is 30000 (bytes). The messages which have larger
3626 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3627 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3630 @item elmo-imap4-use-cache
3631 @vindex elmo-imap4-use-cache
3632 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3635 @item elmo-nntp-use-cache
3636 @vindex elmo-nntp-use-cache
3637 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3640 @item elmo-pop3-use-cache
3641 @vindex elmo-pop3-use-cache
3642 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3645 @item wl-folder-process-duplicates-alist
3646 @vindex wl-folder-process-duplicates-alist
3647 The initial setting is @code{nil}.
3648 This list determines how to deal with duplicated messages in the same folder.
3649 Each item in the list is regexp of folder name and action; you can specify any
3650 one of the following in the place of action:
3653 @code{nil} : do nothing for duplicated messages.
3654 @code{hide} : hide duplicated messages from the summary.
3655 @code{read} : set duplicated messages as read.
3659 Following is an example (hide duplicated messages in multi folders)
3663 (setq wl-folder-process-duplicates-alist
3664 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3665 ("^\\*.*" . hide) (".*" . read)))
3671 @node Message, Draft, Summary, Top
3672 @chapter Message Buffer
3674 Message Buffers utilize MIME-View mode of SEMI. For operational
3675 procedures and key bindings, refer to respective documents.
3676 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3678 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3679 brings you back to Summary mode. @kbd{l} toggles display of Summary
3682 @section Key Bindings
3688 @findex wl-message-toggle-disp-summary
3689 Toggles display of Summary mode buffer.
3690 (@code{wl-message-toggle-disp-summary})
3693 @findex wl-message-refer-article-or-url
3694 @kindex Button-2 (Message)
3695 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3696 corresponding message if found.
3697 (@code{wl-message-refer-article-or-url})
3699 @item Button-4 (upward movement of a wheel)
3700 @kindex Button-4 (Message)
3701 @findex wl-message-wheel-down
3702 Scrolls the message backwards. When the top of the message is hit,
3703 moves to the previous message.
3704 (@code{wl-message-wheel-down})
3706 @item Button-5 (downward movement of a wheel)
3707 @kindex Button-5 (Message)
3708 @findex wl-message-wheel-up
3709 Scrolls the message forward. When the bottom of the message is hit,
3710 moves to the next message.
3711 (@code{wl-message-wheel-up})
3714 @section Customizable Variables
3717 @item wl-message-window-size
3718 @vindex wl-message-window-size
3719 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3720 its car and cdr value corresponds to the ratio of Summary and Message
3723 @item wl-message-ignored-field-list
3724 @vindex wl-message-ignored-field-list
3725 (SEMI only) Initial setting is @code{nil}.
3726 All fields that match this list will be hidden in message buffer.
3727 Each elements are regexp of field-name.
3728 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3730 @item wl-message-visible-field-list
3731 @vindex wl-message-visible-field-list
3732 (SEMI only) Initial setting is @code{nil}.
3733 All fields that match this list will be display in message buffer.
3734 Each elements are regexp of field-name. This value precedes
3735 @code{wl-message-ignored-field-list}.
3736 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3738 @item wl-message-sort-field-list
3739 @vindex wl-message-sort-field-list
3740 (SEMI only) Initial setting is
3741 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3742 Header fields in message buffer are ordered by this value.
3743 Each elements are regexp of field-name.
3746 @node Draft, Disconnected Operations, Message, Top
3747 @chapter Draft Buffer
3749 At Summary mode, pressing @kbd{w} and the like creates a new draft
3750 buffer. You can edit and send mail and news articles in this buffer.
3754 Basically it is Emacs-standard mail mode.
3756 @subsection Address Completion
3758 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3759 addresses. @kbd{@key{TAB}} completes them.
3761 If you want to submit a news article, add @samp{Newsgroups:} field by
3762 yourself. Field names can be completed by @kbd{@key{TAB}}.
3764 If you save the draft buffer you are editing, it is appended to the
3765 folder specified by @code{wl-draft-folder}.
3767 Using @samp{FCC:} field, you can specify the folder to which a copy of
3768 the message is saved when it is sent.
3770 @subsection Editing Messages
3772 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
3773 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
3774 a MIME user interface for GNU Emacs}.
3776 @subsection Dynamic Modification of Messages
3777 @vindex wl-draft-config-alist
3778 @c @cindex Change Message
3779 @c @cindex Message, Change Dynamic
3781 You can set @code{wl-draft-config-alist} so that header and body of the
3782 message will automatically modified depending on information of header
3785 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3787 In the example below, the header is modified when
3788 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3789 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3790 before sending the message.
3794 (setq wl-draft-config-alist
3795 '(((string-match "aaa.example.com$" (system-name))
3796 ;; @r{applied if the expression is non-nil}
3797 (wl-smtp-posting-server . "mailserver-B")
3798 (wl-nntp-posting-server . "newsserver-B")
3799 ;; @r{settings of temporary variables}
3801 ("^To: .*user@@aaa.bbb.example.com"
3802 ;; @r{applied if it matches the header of the draft buffer}
3803 ("Organization" . (format "Go %s" my-webpage)))
3804 ;; @r{you can write elisp expressions here (eval only)}
3805 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3806 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3811 The format of @code{wl-draft-config-alist} is:
3815 '(("@var{regexp of the header}" or @var{elisp expression}
3816 ("@var{Field}" . value(@var{elisp expression}))
3817 (@var{variable} . value(@var{elisp expression}))
3818 (@var{sub-function} . value(@var{elisp expression}))
3821 ("@var{regexp of the header}" or @var{elisp expression}
3822 ("@var{Field}" . value(@var{elisp expression}))
3827 Per default, there are 10 following sub-functions.
3830 'header: Inserts the specified string at the bottom of the header.
3831 'header-file: Inserts the specified file at the bottom of the header.
3832 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3833 'top: Inserts the specified string at the top of the body.
3834 'top-file: Inserts the specified file at the top of the body.
3835 'body: Replaces the body with the specified string.
3836 Specifying @code{nil} deletes the entire body string.
3837 'body-file: Replaces the body with the content of the specified file.
3838 'bottom: Inserts the specified string at the bottom of the body.
3839 'bottom-file: Inserts the specified file at the top of the body.
3840 'template: Applies the specified template.
3841 (refer to the next subsection)
3844 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3845 change them or add your own functions. If you read the code, you can
3846 easily find how to write the functions.
3848 At the first of each item, @var{a regular expression of the header} or
3849 an @var{elisp expression} should be specified. In the case of an elisp
3850 expression, the item is applied when the expression is evaluated
3853 Per default, when multiple items match or are evaluated non-nil, all
3854 such items are applied, but if you set a variable
3855 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3858 At the second of the item, a cons or a list of functions should be
3859 specified. The car part of the cons should be a header field, a
3860 variable, or a sub-function. When a header field is specified, the
3861 field will be modified. If a variable is specified, the value of the
3862 variable will be modified temporarily.
3864 In the cdr part of a cons, not only a variable but also an elisp
3865 expression can be specified as is. If the car part is a header field
3866 and the cdr part is @code{nil}, the field will be deleted.
3868 See the next example as well:
3872 (setq wl-draft-config-alist
3874 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3875 ;; @r{applied if it matches the header of the buffer being replied}
3876 (body . " Hello.\n")
3877 (template . "default")
3882 As in the (1) above, if a header regexp is prepended with @code{reply},
3883 it is applied when the draft is prepared by @code{wl-summary-reply} for
3884 example, and when it matches the header being replied. It is ignored
3885 when there is no buffer being replied, like after @code{wl-draft} was
3888 Note that @code{wl-draft-config-alist} is applied only once when
3889 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3890 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3891 aborting transmission, execute @kbd{C-c C-e}
3892 (@code{wl-draft-config-exec}) explicitly.
3894 If you don't want to apply @code{wl-draft-config-alist} when
3895 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
3899 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
3902 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3903 prepared, do the following:
3906 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3909 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
3910 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
3914 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
3917 @subsection Inserting Templates
3919 @cindex Apply Template
3921 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3922 @kbd{M-x wl-template-select} in the draft buffer.
3924 The format of @code{wl-template-alist} is almost the same as
3925 @code{wl-draft-config-alist}.
3929 (setq wl-template-alist
3932 ("Organization" . "~/.wl sample")
3933 (body . "Hello.\n"))
3935 (template . "default") ;; @r{(a)}
3936 ("To" . "boss@@example.com")
3937 ("Subject" . "Report")
3938 (body-file . "~/work/report.txt")
3944 As you can see, the only difference is item (template) names such as
3945 @samp{default} and @samp{report}, instead of a regexp of header.
3946 Because definition of each item is the same as
3947 @code{wl-draft-config-alist}, you can call another template, like (a).
3949 Executing the command @code{wl-template-select} results in template
3950 selection, but the result differs depending on variable
3951 @code{wl-template-visible-select}.
3953 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3954 window is shown below the draft buffer. You can select a template by
3955 @kbd{n} and @kbd{p} seeing the buffer window.
3957 Press the @key{RET} key and the template is actually applied to the draft
3958 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3959 adjust the window size by @code{wl-template-buffer-lines}.
3961 If @code{wl-template-visible-select} is @code{nil}, you should type the
3962 name of the template in the mini buffer.
3964 As shown in the example in @code{wl-draft-config-alist}, you can select
3965 @samp{default} template by writing:
3968 (template . "default")
3971 @subsection Sending mail by POP-before-SMTP
3972 @cindex POP-before-SMTP
3974 You can send mail by POP-before-SMTP with this single line:
3977 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
3981 Configure the following variables if you need.
3984 @item wl-pop-before-smtp-user
3985 The POP user name for POP-before-SMTP authentication.
3986 If unset, @code{elmo-pop3-default-user} is used.
3988 @item wl-pop-before-smtp-server
3989 The POP server name for POP-before-SMTP authentication.
3990 If unset, @code{elmo-pop3-default-server} is used.
3992 @item wl-pop-before-smtp-authenticate-type
3993 The POP authentication method for POP-before-SMTP authentication.
3994 If unset, @code{elmo-pop3-default-authenticate-type} is used.
3996 @item wl-pop-before-smtp-port
3997 The POP port number for POP-before-SMTP authentication.
3998 If unset, @code{elmo-pop3-default-port} is used.
4000 @item wl-pop-before-smtp-stream-type
4001 If non-nil, POP connection is established using SSL. If
4002 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4003 unset, @code{elmo-pop3-default-stream-type} is used.
4006 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4007 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4009 Therefore, if SMTP server and POP server are actually the same, and if
4010 POP folder per default (such as @samp{&}) is available, no settings are
4013 Refer to the following URL about POP-before-SMTP.
4017 http://spam.ayamura.org/tools/smPbS.html
4018 http://www.iecc.com/pop-before-smtp.html
4022 @section Key Bindings
4023 @cindex Keybind, Draft Mode
4024 @cindex Keybind, Draft Buffer
4029 @kindex C-c C-y (Draft)
4030 @findex wl-draft-yank-original
4031 Cites the content of the current message buffer.
4032 (@code{wl-draft-yank-original})
4035 @kindex C-c C-p (Draft)
4036 @findex wl-draft-preview-message
4037 Previews the content of the current draft.
4038 This is useful for previewing MIME multi-part messages.
4039 (@code{wl-draft-preview-message})
4042 @kindex C-c C-s (Draft)
4043 @findex wl-draft-send
4044 Sends the content of the current draft. Does not erase the draft buffer.
4045 This is useful for sending multiple messages, which are a little different
4047 (@code{wl-draft-send})
4050 @kindex C-c C-c (Draft)
4051 @findex wl-draft-send-and-exit
4052 Sends the content of the current draft and erases the draft buffer.
4053 (@code{wl-draft-send-and-exit})
4056 @kindex C-x C-s (Draft)
4057 @findex wl-draft-save
4058 Save the current draft.
4059 (@code{wl-draft-save})
4062 @kindex C-c C-k (Draft)
4063 @findex wl-draft-kill
4064 Kills the current draft.
4065 (@code{wl-draft-kill})
4068 @kindex C-x k (Draft)
4069 @findex wl-draft-mimic-kill-buffer
4070 Kills the current draft.
4071 (@code{wl-draft-mimic-kill-buffer})
4074 @kindex C-c C-z (Draft)
4075 @findex wl-draft-save-and-exit
4076 Saves the current draft, and erases the draft buffer.
4077 This is useful if you want to suspend editing of the draft.
4078 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4079 the @samp{+draft} folder.
4080 (@code{wl-draft-save-and-exit})
4083 @kindex C-c C-r (Draft)
4084 @findex wl-caesar-region
4085 Encodes or decodes the specified region in Caesar cipher.
4086 (@code{wl-caesar-region})
4090 @findex wl-toggle-plugged
4091 Toggles off-line/on-line states of Wanderlust.
4092 (@code{wl-toggle-plugged})
4095 @kindex C-c C-o (Draft)
4096 @findex wl-jump-to-draft-buffer
4097 Jumps to the other draft buffer, if exists.
4098 With prefix argument, reads a file (if any) from the draft folder when
4099 there is no such buffer.
4100 (@code{wl-jump-to-draft-buffer})
4103 @kindex C-c C-e (Draft)
4104 @findex wl-draft-config-exec
4105 Applies @code{wl-draft-config-alist}.
4106 (@code{wl-draft-config-exec})
4109 @kindex C-c C-j (Draft)
4110 @findex wl-template-select
4112 (@code{wl-template-select})
4115 @kindex C-c C-a (Draft)
4117 Enter Address Manager.
4118 @xref{Address Manager}.
4123 @section Customizable Variables
4126 @item wl-subscribed-mailing-list
4127 @vindex wl-subscribed-mailing-list
4128 The initial setting is @code{nil}. Mailing lists to which you
4129 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4130 field of a reply draft, removes your own address from
4131 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4132 contained in @samp{To:} or @samp{Cc:} field of a message to be
4133 automatically re-filed, the destination folder will be leaned in
4134 connection with the address.
4140 (setq wl-subscribed-mailing-list
4141 '("wl@@lists.airs.net"
4143 "emacs-mime-ja@@m17n.org"))
4147 @item wl-insert-mail-followup-to
4148 @vindex wl-insert-mail-followup-to
4149 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4150 field is automatically inserted in the draft buffer.
4152 @item wl-insert-mail-reply-to
4153 @vindex wl-insert-mail-reply-to
4154 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4155 field is automatically inserted in the draft buffer.
4157 @item wl-auto-insert-x-face
4158 @vindex wl-auto-insert-x-face
4159 The initial setting is @code{t}. If non-nil and there is an encoded
4160 X-Face string in a file @file{~/.xface} (the value of the variable
4161 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4162 draft buffer. If @code{nil}, it is not automatically inserted.
4164 @item wl-insert-message-id
4165 @vindex wl-insert-message-id
4166 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4167 is automatically inserted on the transmission.
4169 @item wl-local-domain
4170 @vindex wl-local-domain
4171 The initial setting is @code{nil}. If @code{nil}, the return value of
4172 the function @code{system-name} will be used as the domain part of
4175 If @code{system-name} does not return FQDN (i.e. the full name of the
4176 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4177 to the string of the local domain name without hostname (like
4178 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4179 @samp{.} @code{wl-local-domain} is used as domain part of the
4182 If your terminal does not have global IP, set the value of
4183 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4184 you use invalid @samp{Message-ID:}.)
4186 Moreover, concatenation of @code{system-name} @samp{.}
4187 @code{wl-local-domain} will be used as an argument to the HELO command
4190 @item wl-message-id-domain
4191 @vindex wl-message-id-domain
4192 The initial setting is @code{nil}. If non-nil, this value is used as a
4193 domain part of the @samp{Message-ID:}. If your terminal does not have
4194 global IP address, set unique string to this value (e.x. your e-mail
4197 @item wl-message-id-domain
4198 @vindex wl-message-id-domain
4199 The initial setting is @code{nil}. If @code{nil}, the return value of
4200 the function @code{system-name} will be used as the domain part of
4201 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4202 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4203 @strong{must} set this variable to the string of the full name of the
4204 host. Otherwise, you might be beaten up on the Net News.
4206 @item wl-draft-config-alist
4207 @vindex wl-draft-config-alist
4208 The initial setting is @code{nil}. Modifies the draft message just
4209 before the transmission. The content of @code{wl-draft-config-alist}
4210 will be automatically applied only once on the transmission. If you
4211 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4214 @item wl-template-alist
4215 @vindex wl-template-alist
4216 The initial setting is @code{nil}.
4217 This variable specifies the template to be applied in the draft buffer.
4219 @item wl-draft-config-matchone
4220 @vindex wl-draft-config-matchone
4221 The initial setting is @code{nil}. If non-nil, only the first matching
4222 item is used when @code{wl-draft-config-alist} is applied. If
4223 @code{nil}, all matching items are used.
4225 @item wl-template-visible-select
4226 @vindex wl-template-visible-select
4227 The initial setting is @code{t}.
4228 If non-nil, you can preview the result of the template selection in
4231 @item wl-template-confirm
4232 @vindex wl-template-confirm
4233 The initial setting is @code{nil}.
4234 If non-nil, asks for confirmation when you press the enter key to select
4235 template while previewing.
4237 @item wl-template-buffer-lines
4238 @vindex wl-template-buffer-lines
4239 The initial setting is 7.
4240 If @code{wl-template-visible-select} is non-nil, this variable specifies
4241 the size of the preview window.
4243 @item wl-draft-reply-buffer-style
4244 @vindex wl-draft-reply-buffer-style
4245 The initial setting is @code{split}. @code{split} or @code{full} can be
4246 specified. In the case of @code{full}, the whole frame will be used for
4247 a reply draft buffer when it is prepared.
4249 @item wl-draft-use-frame
4250 @vindex wl-draft-use-frame
4251 The initial setting is @code{nil}.
4252 If non-nil, use new frame for the draft.
4256 The initial setting is the value of the variable
4257 @code{user-mail-address}. The value of this variable is inserted as a
4258 @samp{From:} field of the draft when it is prepared.
4260 @item wl-envelope-from
4261 @vindex wl-envelope-from
4262 The initial setting is @code{nil}.
4263 The value of this variable is used for envelope from (MAIL FROM).
4264 If @code{nil}, the address part of @code{wl-from} is used.
4266 @item wl-user-mail-address-list
4267 @vindex wl-user-mail-address-list
4268 The initial setting is @code{nil}.
4269 This is the User's address list. If you have multiple addresses,
4274 The initial setting is @code{nil}.
4275 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4276 the draft when it is prepared. If function is specified, its return
4281 The initial setting is @code{nil}.
4282 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4283 the draft when it is prepared.
4285 @item wl-reply-subject-prefix
4286 @vindex wl-reply-subject-prefix
4287 The initial setting is @samp{Re: }.
4288 In the @samp{Subject:} of the reply draft, this string is prepended to
4289 the @samp{Subject:} of being replied.
4291 @item wl-draft-reply-use-address-with-full-name
4292 @vindex wl-draft-reply-use-address-with-full-name
4293 The initial setting is @code{t}.
4294 If non-nil, insert her full name with address when prepare a draft for
4295 reply a message. If it is @code{nil}, insert her address only.
4297 @item wl-draft-enable-queuing
4298 @vindex wl-draft-enable-queuing
4299 The initial setting is @code{t}.
4300 This flag controls off-line transmission. If non-nil, the draft is
4303 @item wl-draft-use-cache
4304 @vindex wl-draft-use-cache
4305 The initial setting is @code{nil}. If the value is non-nil and
4306 @code{wl-insert-message-id} is nil, cache the message which is sent.
4308 @item wl-auto-flush-queue
4309 @vindex wl-auto-flush-queue
4310 The initial setting is t.
4311 This flag controls automatic transmission of the queue when Wanderlust
4312 becomes on-line. If non-nil, the queue is automatically transmitted
4313 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4314 manually, press @kbd{F} in the folder mode.
4316 @item wl-ignored-forwarded-headers
4317 @vindex wl-ignored-forwarded-headers
4318 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4319 All headers that match this regexp will be deleted when forwarding a message.
4321 @item wl-ignored-resent-headers
4322 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4323 All headers that match this regexp will be deleted when resending a message.
4325 @item wl-draft-always-delete-myself
4326 @vindex wl-draft-always-delete-myself
4327 If non-nil, always removes your own address from @samp{To:} and
4328 @samp{Cc:} when you are replying to the mail addressed to you.
4330 @item wl-draft-delete-myself-from-bcc-fcc
4331 @vindex wl-draft-delete-myself-from-bcc-fcc
4332 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4333 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4335 @item wl-smtp-posting-server
4336 @vindex wl-smtp-posting-server
4337 The initial setting is @code{nil}.
4338 This is the SMTP server name for mail transmission.
4340 @item wl-smtp-posting-user
4341 @vindex wl-smtp-posting-user
4342 The initial setting is @code{nil}.
4343 This is the user name for SMTP AUTH authentication. If @code{nil},
4344 @code{smtp-authenticate-user} is used.
4346 @item wl-smtp-authenticate-type
4347 @vindex wl-smtp-authenticate-type
4348 The initial setting is @code{nil}.
4349 This is the authentication method for SMTP AUTH authentication. If
4350 @code{nil}, @code{smtp-authenticate-type} is used. If
4351 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4354 @item wl-smtp-connection-type
4355 @vindex wl-smtp-connection-type
4356 The initial setting is @code{nil}.
4357 This variable specifies how to establish SMTP connections.
4358 If @code{nil}, @code{smtp-connection-type} is used.
4359 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4361 @item wl-nntp-posting-server
4362 @vindex wl-nntp-posting-server
4363 The initial setting is @code{nil}.
4364 This is the NNTP server name used for news submission.
4365 If @code{nil}, @code{elmo-nntp-default-server} is used.
4367 @item wl-nntp-posting-user
4368 @vindex wl-nntp-posting-user
4369 The initial setting is @code{nil}.
4370 This is the user name for AUTHINFO authentication on news submission.
4371 If @code{nil}, @code{elmo-nntp-default-user} is used.
4372 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4374 @item wl-nntp-posting-port
4375 @vindex wl-nntp-posting-port
4376 The initial setting is @code{nil}.
4377 This is the port number of the NNTP server used for news submission.
4378 If @code{nil}, @code{elmo-nntp-default-server} is used.
4380 @item wl-nntp-posting-stream-type
4381 @vindex wl-nntp-posting-stream-type
4382 The initial setting is @code{nil}.
4383 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4384 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4385 connection will be established.
4387 @item wl-pop-before-smtp-user
4388 @vindex wl-pop-before-smtp-user
4389 The initial setting is @code{nil}.
4390 This is the POP user name for POP-before-SMTP.
4391 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4393 @item wl-pop-before-smtp-server
4394 @vindex wl-pop-before-smtp-server
4395 The initial setting is @code{nil}.
4396 This is the POP server name for POP-before-SMTP.
4397 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4399 @item wl-pop-before-smtp-authenticate-type
4400 @vindex wl-pop-before-smtp-authenticate-type
4401 The initial setting is @code{nil}.
4402 This is the authentication method for POP-before-SMTP authentication.
4403 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4405 @item wl-pop-before-smtp-port
4406 @vindex wl-pop-before-smtp-port
4407 The initial setting is @code{nil}.
4408 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4409 @code{elmo-pop3-default-port} is used.
4411 @item wl-pop-before-smtp-stream-type
4412 @vindex wl-pop-before-smtp-stream-type
4413 The initial setting is @code{nil}.
4414 This flag controls the use of SSL for POP-before-SMTP. If it is
4415 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4416 STARTTLS (RFC2595) connection will be established.
4418 @item wl-draft-queue-save-variables
4419 @vindex wl-draft-queue-save-variables
4420 Specifies a list of variable to which queued messages are saved on the
4421 off-line transmission.
4423 @item wl-draft-sendlog
4424 @vindex wl-draft-sendlog
4425 The initial setting is @code{t}.
4426 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4430 @item drafts are sent by smtp or qmail
4431 @item saved into folders by fcc
4432 @item saved into folders by queuing
4435 (it is written even if the transmission fails).
4436 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4437 and left to the logging function of @command{imput}.
4440 @item wl-draft-sendlog-max-size
4441 @vindex wl-draft-sendlog-max-size
4442 The initial setting is 20000 (in bytes).
4443 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4444 beyond the size specified by this variable.
4448 The initial setting is @code{nil}.
4449 If non-nil, address completion uses LDAP.
4451 @item wl-ldap-server
4452 @vindex wl-ldap-server
4453 The initial setting is @samp{localhost}.
4454 LDAP server name for address completion.
4457 @vindex wl-ldap-port
4458 The initial setting is @code{nil}.
4459 If non-nil, the value is used as port number.
4462 @vindex wl-ldap-base
4463 The initial setting is @samp{c=US}.
4464 LDAP search starting point (base) for address completion.
4466 @item wl-draft-remove-group-list-contents
4467 @vindex wl-draft-remove-group-list-contents
4468 The initial setting is @code{t}.
4469 If non-nil, remove the group-lists' members in the recipients when
4470 sending the message (group-list means the description such as
4471 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4474 @node Disconnected Operations, Expire and Archive, Draft, Top
4475 @chapter Off-line Management
4476 @cindex Disconnected Operations
4478 Wanderlust has on-line and off-line states.
4481 * Off-line State:: Wanderlust has on-line and off-line states
4482 * Enable Operations:: Enable Disconnected Operations
4483 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4484 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4485 * Variables of Plugged Mode:: Customize Plugged Mode
4489 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4490 @section Off-line State
4492 Wanderlust has on-line and off-line states. In the off-line state, you
4493 cannot access messages via network, unless they are cached.
4495 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4496 in the mode line indicates the off-line state. In folder or summary
4497 modes, press @kbd{M-t} to switch between off- and on-line.
4499 You can invoke Wanderlust in the off-line state by setting
4500 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4502 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4503 ignores uncached messages.
4506 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4507 @section Enable Disconeected Operations
4509 Even in the off-line state, provided that relevant messages are cached,
4510 and the variable @code{elmo-enable-disconnected-operation} (described
4511 later) is non-nil, you can following operations:
4512 @xref{Plugged Mode}, @xref{Off-line State settings}.
4515 * Send Messages off-line:: Transmit Messages
4516 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4517 * Creation of Folders:: Create Folders off-line (IMAP4)
4518 * Marking:: Mark (IMAP4)
4519 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4522 As soon as Wanderlust becomes on-line, such operations invoked off-line
4523 are reflected in the servers via network.
4526 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4527 @subsection Transmission of Messages
4529 You can send mail/news messages off-line (if you are using
4530 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4531 accumulated in the queue folder, @samp{+queue}. These messages are
4532 transmitted at once when Wanderlust becomes on-line.
4534 You can visit @samp{+queue} in the off-line state and confirm content of
4535 messages in the queue. You can also remove messages. Removed messages
4536 are not transmitted even in the on-line state.
4539 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4540 @subsection Re-file and Copy (IMAP4)
4542 Re-file and copy operations to IMAP folders invoked during the off-line
4543 state are accumulated in the queue, and reflected in the server side
4544 when Wanderlust becomes on-line. If you visit destination folders after
4545 off-line re-file or copy, it looks as if messages were appended even in
4548 For the safety reasons, messages re-filed off-line are removed from
4549 source folders only if their @samp{Message-ID:} match messages on the
4550 servers. While the queue is processed, messages that failed to be
4551 re-filed or copied to the specified folders are appended to the folder
4555 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4556 @subsection Creation of Folders (IMAP4)
4558 You can create IMAP folders off-line. The creation of folders are
4559 reflected in the servers when Wanderlust becomes on-line. At that time,
4560 if folders failed to be created on the servers for any reasons, messages
4561 re-filed to such folders are appended to the folder @samp{+lost+found}.
4564 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4565 @subsection Marking (IMAP4)
4567 Off-line changes in unread/read and importance mark @samp{$} information
4568 are also reflected in the servers when Wanderlust becomes on-line.
4571 @node Pre-fetching Reservations, , Marking, Enable Operations
4572 @subsection Pre-fetching (IMAP4, NNTP)
4574 You can make reservations for pre-fetching messages in IMAP or NNTP
4575 folders. Reserved messages are marked with @samp{!} but not cached
4576 yet. When Wanderlust becomes on-line, they are pre-fetched from
4579 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4580 these off-line operations for IMAP4 and NNTP do not take place, and
4581 off-line re-file, copy or suchlike simply results in error.
4583 Because off-line operations use cache files, it is a bad idea to erase
4584 them by hand; it may cause Wanderlust to malfunction.
4586 If you want to remove caches, be sure to execute @kbd{M-x
4587 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4588 remove caches for messages relevant to off-line operations.
4591 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4592 @section Switching On-line/Off-line per Server/Port
4594 @kbd{M-t} described above switches networking states as a whole, but you
4595 can switch on-line/off-line per server/port.
4597 Pressing @kbd{C-t} in the folder or summary modes brings you in
4598 wl-plugged-mode shown below, in which you can change the plugged state
4603 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4606 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4607 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4609 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4610 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4616 The first line indicates status of the following three variables, and
4617 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4618 column modifies the values of these variables.
4622 "Queuing" @code{wl-draft-enable-queuing}
4623 "AutoFlushQueue" @code{wl-auto-flush-queue}
4624 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4628 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4631 The second and after lines indicate on-line/off-line states of servers
4632 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4633 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4634 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4636 @dfn{sending queue} means messages accumulated in the folder
4637 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4638 off-line operations when @code{elmo-enable-disconnected-operation} is
4640 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4641 @c off-line operations are enabled.
4643 They are displayed if there are any of them. In the example above, in
4644 the sending queue there are two messages (the first and the second in
4645 the queue folder) for smtp to hosta and one (the third) for nntp to
4646 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4649 If you change @samp{(wl-plugged)} in the second line, the variable
4650 @code{wl-plugged} is changed, so that the mode line indicator and
4651 plugged states of all ports are affected. If you change plugged states
4652 of any servers or ports, @samp{(wl-plugged)} in the second line is
4653 affected depending on @code{elmo-plugged-condition} settings and the
4654 plugged state of each port.
4657 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4658 @section Invoking Wanderlust in the Off-line State
4660 As described before, if you set @code{wl-plugged} to @code{nil} in
4661 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4662 off-line state. You can specify off-line state on a per server or port
4663 basis. Refer to @code{wl-reset-plugged-alist} also.
4665 Usually, when Wanderlust starts up, the plugged state of each port is
4666 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4667 @code{wl-nntp-posting-server} and so on. If you want to change the
4668 plugged state of these ports or to add other ports, configure
4669 @code{wl-make-plugged-hook} with a function.
4673 (add-hook 'wl-make-plugged-hook
4675 (elmo-set-plugged plugged-value(t/nil) server port)
4676 ;; @r{add or change plugged states of the port of the server}
4677 (elmo-set-plugged plugged-value(t/nil) server)
4678 ;; @r{if the port is omitted, all ports are affected}
4679 ;; @r{(you cannot omit the port if you newly add the server)}
4685 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4686 @section Customizable Variables
4691 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4692 mode from the beginning.
4694 @item wl-queue-folder
4695 @vindex wl-queue-folder
4696 The initial setting is @samp{+queue}.
4697 This is the folder in which messages in the transmission queue are
4700 @item wl-auto-flush-queue
4701 @vindex wl-auto-flush-queue
4702 The initial setting is @code{t}.
4703 This flag controls automatic transmission of the queue when Wanderlust
4704 becomes on-line. If non-nil, the queue is automatically transmitted
4705 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4706 manually, press @kbd{F} in the folder mode.
4708 @item elmo-enable-disconnected-operation
4709 @vindex elmo-enable-disconnected-operation
4710 The initial setting is @code{nil}. Controls off-line operations
4711 regarding IMAP4. If non-nil, off-line operations are carried out.
4713 @item elmo-lost+found-folder
4714 @vindex elmo-lost+found-folder
4715 The initial setting is @samp{+lost+found}.
4716 This is the folder to which messages are saved when they fails to be
4717 appended while the off-line re-file/copy queue is processed.
4719 @item elmo-plugged-condition
4720 @vindex elmo-plugged-condition
4721 The initial setting is @code{one}.
4722 The value of @code{wl-plugged} reflects the return value of the function
4723 @code{elmo-plugged-p} (without arguments).
4724 This variable @code{elmo-plugged-condition} specifies the condition on
4725 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4726 plugged state of each port.
4729 'one : plugged if one or more ports are plugged.
4730 'all : plugged if all ports are plugged.
4731 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4732 states of the ports.
4733 @var{function} : reflects the return value of the @var{function}
4734 functions available per default
4735 'elmo-plug-on-by-servers
4736 : reflects the plugged state of the servers specified by the
4737 variable elmo-plug-on-servers.
4738 'elmo-plug-on-by-exclude-servers
4739 : reflects the plugged state of the servers that are not
4740 in elmo-plug-on-exclude-servers.
4741 elmo-plug-on-exclude-servers defaults to
4744 (system-name)without the domain part)
4750 (setq elmo-plugged-condition 'all)
4752 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4753 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4755 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4756 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4760 @item wl-reset-plugged-alist
4761 @vindex wl-reset-plugged-alist
4762 The initial setting is @code{t}. If non-nil, plugged states are
4763 initialized on a per server or port basis when Wanderlust starts up.
4765 If @code{nil}, plugged states are retained while Emacs is running. In
4766 other words, they are initialized when Emacs is restarted even if the
4767 value is @code{nil}.
4771 @node Expire and Archive, Scoring, Disconnected Operations, Top
4772 @chapter Automatic Expiration and Archiving of Messages
4773 @cindex Expire and Archive
4776 * Expire:: Expiration and Archiving
4777 * Archive:: Archiving All Messages
4781 @node Expire, Archive, Expire and Archive, Expire and Archive
4783 @cindex Expire Message
4785 Expiration means deletion of old messages which have outlasted a
4786 certain period of time.
4788 @code{wl-expire} supports not only simple deletion, but also moving to
4789 specified archiving folders.
4793 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4794 or @kbd{M-e} in the summary mode.
4796 @subsection Configuring @code{wl-expire-alist}
4798 An example configuration of @code{wl-expire-alist} is shown below.
4799 Everything in this @code{wl-expire-alist} makes a great difference in
4800 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4801 to @code{t}, especially in the initial stage.
4805 (setq wl-expire-alist
4806 '(("^\\+trash$" (date 14) remove)
4808 ("^\\+tmp$" (date 7) trash)
4809 ;; @r{re-file to @code{wl-trash-folder}}
4810 ("^\\+outbox$" (number 300) "$outbox;lha")
4811 ;; @r{re-file to the specific folder}
4813 ;; @r{do not expire}
4814 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4815 ;; @r{archive by message number (retaining numbers)}
4816 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4817 ;; @r{archive by a fixed number (retaining numbers)}
4818 ("^\\+diary$" (date 30) wl-expire-archive-date)
4819 ;; @r{archive by year and month (numbers discarded)}
4824 Items in the list has the format of:
4827 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4831 The folder is examined if it matches @var{regexp-for-folders} from the
4832 beginning of the list. If you invoke expiration on the folder that does
4833 not match any of them, nothing will happen. And if either the second or
4834 the third element of the item is @code{nil}, expiration will not take
4837 You can use any one of the following for
4838 @var{specification-of-message-to-be-deleted}:
4841 @item (number @var{n1} [@var{n2}])
4842 deletes messages depending on the number of messages in the folder.
4844 @var{n1} is the number of messages which should survive deletion, for example
4845 if its value is 500, the newest 500 messages survive and the rests are
4848 @var{n2} is the number of messages in the folder on which expiration should
4849 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4850 folders with 510 or more messages are expired.
4851 If you configured automatic expiration, frequently used folders may
4852 expire every time it receive messages, and you may be annoyed with the
4853 long delay in reading mail.
4854 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4855 expiration would not take place until a certain number of messages
4858 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4859 with important/new/unread) are not deleted.
4860 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4861 will expire so as to have 500 messages including such ones.
4862 Otherwise, it will have 500 messages except such ones.
4864 @item (date @var{d1})
4865 deletes messages depending on the dates.
4867 Messages dated @var{d1} or more days ago are deleted, for example if its
4868 value is seven, messages seven days old or more are deleted. Note that
4869 the date is the one in the @samp{Date:} field of the message, not when
4870 the message entered the folder.
4872 Messages with no or invalid @samp{Date:} field does not expire; you
4873 might have to delete them by hand.
4876 You can use any one of the following in the place of @var{destination}:
4880 deletes the messages instantly.
4883 hide the messages from summary (messages are not deleted).
4886 moves the messages to @code{wl-trash-folder}.
4888 @item @var{string}(folder)
4889 moves the messages to the folder specified with @var{string}.
4891 It would be useful for specifying an archiving folder, but because this
4892 does not move important messages, it might be better to use the
4893 standard functions described below.
4895 @item @var{function}
4896 invokes the specified @var{function}.
4898 To the @var{function}, three arguments are passed: a folder name, a list
4899 of messages to be deleted, and msgdb information of the summary. You
4900 can specify function-specific arguments after the name of the
4901 @var{function}. Note that the list contains messages with marks in
4902 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4905 These are three standard functions; they moves messages to an archive
4906 folder in the specified way. This means old messages can be compressed
4907 and saved in a file, being deleted from the original folder.
4910 @item wl-expire-archive-number1
4911 re-files to archiving folders corresponding to the message numbers of
4912 the messages being deleted. For example, a message numbered 102 will be
4913 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4914 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4915 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4917 The archiving folders to which messages are re-filed are determined by
4918 the name of the folder as follows (in this case, archiving folders are
4919 handled as if @code{elmo-archive-treat-file} were non-nil).
4922 @item If the folder type is localdir:
4923 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4925 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4926 (@file{~/Mail/ml/wl-00100.zip}).
4928 @item The folder type is other than localdir:
4929 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4931 For example, @samp{%#mh/ml/wl} corresponds to
4932 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4935 As you can see, in the case of localdir, the folder type is not included
4936 in the path name, but otherwise it is included.
4937 And you can control the prefix to the archiving folder name by
4938 @code{wl-expire-archive-folder-prefix}.
4939 Refer to @code{wl-expire-archive-folder-prefix} for details.
4941 @item wl-expire-archive-number2
4942 re-files every certain number of messages to archiving folders.
4944 This differs from @samp{wl-expire-archive-number1} in that this re-files
4945 to the folder up to the specified number regardless of message numbers.
4946 The archiving folders to which messages are re-filed are determined in the
4947 same way as @code{wl-expire-archive-number1}.
4949 @item wl-expire-archive-date
4950 re-files messages depending on its date (year and month) to archive
4953 For example, a message dated December 1998 is re-filed to
4954 @code{$folder-199812;zip}. The name of the archiving folders except the
4955 date part are determined in the same way as
4956 @code{wl-expire-archive-number1}.
4959 You can set the first argument to these three standard functions to non-nil
4960 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4961 For example, it can be specified just after the name of the function:
4964 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4967 If you omit the argument, consecutive numbers from 1 are assigned for
4968 each archiving folder.
4971 @subsection Treatment for Important or Unread Messages
4973 If you specify any of @code{remove}, @code{trash}, a folder name, or a
4974 standard function, messages with marks in
4975 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
4976 messages} thereafter) are retained.
4978 Per default, this variable include the important, new, and unread marks,
4979 so that messages with these marks are not removed.
4980 Note that you cannot include the temporary mark (i.e. temporary marks
4981 are removed anyway), and be sure to process temporary marks before you
4984 @subsection Auto Expiration
4986 The following setup invokes expiration when you move into the summary
4987 mode. There will be no confirmation, so make sure you made no mistake
4988 in regexp and other settings before you set up this.
4992 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4996 In the folder mode, you can invoke expiration per group as well as per
4997 folder. Therefore, if you specify @samp{Desktop} group, all folders
4998 matching @code{wl-expire-alist} expire.
5002 @subsection Treating archive folders.
5003 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5004 you must set non-nil value to @code{elmo-archive-treat-file}.
5006 @subsection Confirming
5008 If you are to use @code{remove}, try @code{trash} at first and see
5009 messages move to @code{wl-trash-folder} as expected, then replace it
5010 with @code{remove}. It would be dangerous to use @code{remove} from the
5013 If you are to use @code{wl-expire-archive-number1} and the like, try to
5014 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5015 you can append messages to it. Even if settings in
5016 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5017 would not be saved anywhere and disappeared in case the archiver program
5020 After you make sure you can archive to the folder correctly, you can
5021 invoke expiration and utilize the log.
5023 If you set @code{wl-expire-use-log} to @code{t},
5024 @file{~/.elmo/expired-log} should contain the log, for example:
5028 delete +ml/wl (593 594 595 596 597 598 599)
5029 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5033 The first column indicates the operation, i.e. @samp{delete},
5034 @samp{copy}, or @samp{move}. The next is the name of the folder that
5035 expired. In the case of @samp{copy} and @samp{move}, the destination
5036 folder is recorded after @samp{->}. The last is the list of message
5037 numbers that are actually deleted or moved (in the case of @samp{copy}
5038 and @samp{move}, the number is the one in the source folder, rather than
5039 the destination folder).
5041 @subsection Re-filing Reserved Messages
5043 The three standard functions copy reserved messages to the archive
5044 folder, but do not delete them from the source folder. Because
5045 reserved messages and the like always remain, they are recorded in
5046 @file{~/.elmo/expired-alist} so that they are not copied over and over
5047 again. They are not recorded if copied by @code{wl-summary-archive}.
5049 If you enabled logging, usually @samp{move} is recorded for re-filing,
5050 but instead @samp{copy} and @samp{delete} are recorded separately if
5051 reserved messages are involved. This is because it actually copies
5052 messages including reserved, then deletes ones except reserved in that
5055 @section Customizable Variables
5058 @item wl-expire-alist
5059 @vindex wl-expire-alist
5060 The initial setting is @code{nil}.
5061 This variable specifies folders and methods to expire. For details,
5062 refer to @code{wl-expire-alist} settings above.
5064 @item wl-summary-expire-reserve-marks
5065 @vindex wl-summary-expire-reserve-marks
5066 The initial setting is the list below.
5070 (list wl-summary-important-mark
5072 wl-summary-unread-mark
5073 wl-summary-unread-uncached-mark
5074 wl-summary-unread-cached-mark)
5078 Messages with these marks are retained in the folder, even after
5080 Only permanent marks can be listed, not temporary marks.
5082 You can list marks one by one as in the default; you can use the
5083 following settings as well:
5087 All messages with permanent marks are retained,
5088 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5092 All messages are handled as usual ones that are already read, no matter
5093 what marks they have; even important messages are deleted.
5096 @item wl-expire-archive-files
5097 @vindex wl-expire-archive-files
5098 The initial setting is 100.
5099 This variable specifies the number of messages to be retained in one
5102 @item wl-expire-number-with-reserve-marks
5103 @vindex wl-expire-number-with-reserve-marks
5104 The initial setting is @code{nil}.
5105 If non-nil, if expiring messages are specified by @code{number},
5106 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5108 @item wl-expire-archive-get-folder-function
5109 @vindex wl-expire-archive-get-folder-function
5110 The initial setting is @code{wl-expire-archive-get-folder}.
5112 This variable specifies a function that returns the name of an archiving
5113 folder for standard functions in the place of @var{destination}.
5114 You can use the following three variables for simple modification of
5115 folder names; if you want more complex settings, define your own
5116 function in this variable.
5118 @code{wl-expire-archive-get-folder} can be customized by these
5121 @item @code{wl-expire-archive-folder-name-fmt}
5122 @item @code{wl-expire-archive-folder-type}
5123 @item @code{wl-expire-archive-folder-prefix}
5126 @item wl-expire-archive-folder-name-fmt
5127 @vindex wl-expire-archive-folder-name-fmt
5128 The initial setting is @samp{%s-%%05d;%s}.
5129 This is a @code{format} string for archiving folders used in
5130 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5131 Note that you must specify the message number by @samp{%%d}, because it
5132 is parsed twice by @code{format}.
5134 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5137 @item wl-expire-archive-date-folder-name-fmt
5138 @vindex wl-expire-archive-date-folder-name-fmt
5139 The initial setting is @samp{%s-%%04d%%02d;%s}.
5140 This is a @code{format} string for archiving folders used in
5141 @code{wl-expire-archive-date}. Note that you must specify the message
5142 number by @samp{%%d}, because it is parsed twice by @code{format}.
5143 There should be @samp{%%d} twice, one for the year and the other for the
5146 If you modify this, adjust
5147 @code{wl-expire-archive-date-folder-num-regexp} as well.
5149 @item wl-expire-archive-folder-type
5150 @vindex wl-expire-archive-folder-type
5151 The initial setting is @code{zip}.
5152 This variable specifies an archiver type of the archiving folders.
5154 @item wl-expire-archive-folder-prefix
5155 @vindex wl-expire-archive-folder-prefix
5156 The initial setting is @code{nil}.
5157 This variable specifies the prefix (directory structure) to archiving
5159 Exercise extreme caution in using this feature, as it has not been
5161 In the worst case, there is a fear of destructing archiving folders.
5165 There will be no prefix.
5168 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5169 @samp{$ml/wl-00000;zip;wl}.
5172 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5175 @samp{$ml/wl-00000;zip;ml/wl}.
5178 @item wl-expire-archive-folder-num-regexp
5179 @vindex wl-expire-archive-folder-num-regexp
5180 The initial setting is @samp{-\\([-0-9]+\\);}.
5181 This variable specifies the regular expression to be used for getting
5182 message numbers from multiple archiving folders specified by
5183 @code{elmo-list-folders}.
5184 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5186 @item wl-expire-archive-date-folder-num-regexp
5187 @vindex wl-expire-archive-date-folder-num-regexp
5188 The initial setting is @samp{-\\([-0-9]+\\);}.
5189 This is the regular expression to be used for getting message numbers
5190 from multiple archiving folders specified by @code{elmo-list-folders}.
5191 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5193 @item wl-expire-delete-oldmsg-confirm
5194 @vindex wl-expire-delete-oldmsg-confirm
5195 The initial setting is @code{t}.
5196 If non-nil, messages older than the one with the largest number will be
5197 deleted with confirmation.
5198 If @code{nil}, they are deleted without confirmation.
5200 This feature is valid only if non-nil is specified as a argument to the
5201 standard functions so as to retain numbers.
5203 @item wl-expire-use-log
5204 @vindex wl-expire-use-log
5205 The initial setting is @code{nil}.
5206 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5207 They are appended but not truncated or rotated automatically; you might
5208 need to remove it manually.
5210 @item wl-expire-add-seen-list
5211 @vindex wl-expire-add-seen-list
5212 The initial setting is @code{t}.
5214 If non-nil, when messages are re-filed by expiration, read/unread
5215 information is passed to the destination folder.
5217 However if you do not read the destination folder from Wanderlust,
5218 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5219 want to set this to @code{nil} if you are simply saving to some
5220 archiving folders. Even if its value is @code{nil}, messages in the
5221 archiving folders are simply treated as unread; it does not affect
5224 @item wl-expire-folder-update-msgdb
5225 @vindex wl-expire-folder-update-msgdb
5226 The initial setting is @code{t}.
5227 If @code{t}, in the folder mode, expiration is carried out after
5228 updating summary information. If you specified a list of regular
5229 expressions of folder names, summary information is updated for matching
5234 @node Archive, , Expire, Expire and Archive
5235 @section Archiving Messages
5237 @subsection Archiving Messages
5238 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5239 folders. If there are the archiving folders already, only new messages
5242 You can use @code{wl-archive-alist} in order to specify how messages are
5243 archived according to their folder names, as in @code{wl-expire-alist}.
5248 (setq wl-archive-alist
5249 '(("^\\+tmp$" wl-archive-date)
5250 ("^\\+outbox$" wl-archive-number2)
5251 (".*" wl-archive-number1)))
5255 Each item in the list has the following format:
5258 (@var{folders-regexp} @var{deleting-function})
5261 As you can see, you can only use a function after @var{folders-regexp}.
5262 Per default, there are three functions:
5265 @item @code{wl-archive-number1}
5266 @item @code{wl-archive-number2}
5267 @item @code{wl-archive-date}
5270 As inferred from their names, they work similarly to "expire" versions,
5271 other than the following points:
5274 @item No messages are deleted
5275 @item Message numbers are retained even if invoked without arguments
5278 These functions are good to archive all messages in a folder by their
5279 numbers or by their dates.
5280 These are also useful for backup or confirmation purposes before
5282 If you try to re-file them after they are archived, they are deleted but
5285 Per default, the archiving folders to which messages are copied are
5286 determined automatically by @code{wl-expire-archive-get-folder-function}.
5287 You can copy to a specific folder by invoking with a prefix argument,
5288 i.e. @kbd{C-u M-x wl-summary-archive}.
5290 Note that this feature has not been seriously tested, because you can
5291 simply copy to an archiving folder, for example by
5292 @code{wl-summary-copy-region}.
5294 The archiving folders are determined by the same logic as in
5295 @code{wl-summary-expire}; the following customizable variables are
5299 @item @code{wl-expire-archive-files}
5300 @item @code{wl-expire-archive-get-folder-function}
5301 @item @code{wl-expire-archive-folder-name-fmt}
5302 @item @code{wl-expire-archive-folder-type}
5303 @item @code{wl-expire-archive-folder-prefix}
5304 @item @code{wl-expire-archive-folder-num-regexp}
5307 @subsection Customizable Variables
5310 @item wl-archive-alist
5311 @vindex wl-archive-alist
5312 The initial setting is the list shown below:
5316 ((".*" wl-archive-number1))
5321 This variable specifies a function that copies to archiving folders.
5322 To the function, three arguments are passed: a folder name, a list of
5323 messages in the folder, and msgdb information of the summary.
5324 Needless to say, you can use your own function.
5328 @node Scoring, Address Book, Expire and Archive, Top
5329 @chapter Score of the Messages
5331 @c @cindex Kill File
5333 Scoring is the function that associates a score (value) with each
5334 message, and marks as read or deletes from the summary according to it.
5336 You can put target or important marks on essential messages, or read marks
5337 on the ones you do not want to read, for example spam articles.
5339 This scoring function has a capability and a format similar to the one
5340 that Gnus has, although there are some unsupported features and
5341 Wanderlust specifics.
5342 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5345 * Score Commands:: Score Commands
5346 * Score File Format:: Score File Format
5350 @node Score Commands, Score File Format, Scoring, Scoring
5351 @section Score Commands
5352 @cindex Score Commands
5354 @subsection Score File Specification
5356 @code{wl-score-folder-alist} specifies score files or variables in which
5357 scores are defined, corresponding to folder names.
5361 (setq wl-score-folder-alist
5370 If paths to the score files are omitted, the directory specified in the
5371 variable @code{wl-score-files-dir} is assumed.
5373 No matter what you write in @code{wl-score-folder-alist}, the default
5374 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5375 read (it does not have to exist).
5376 Therefore, in the example above, the three score files,
5377 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5378 the folders that matches @samp{^-.*}.
5380 @subsection Scored Messages
5382 Scores are attached to the messages that are specified by
5383 @code{wl-summary-score-marks} temporarily when the summary is updated;
5384 when you exit from the summary, the scores are removed and reverts to
5387 @subsection Creation of Score Files
5389 In the summary buffer, move to an appropriate message and type @kbd{L}.
5390 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5391 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5393 This makes @minus{}1000 are scored for messages with the same
5394 @samp{Subject:} as the string you entered. That is, such a score file
5395 is created automatically.
5397 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5398 The score file you just made appears.
5399 This buffer is called @dfn{score editing buffer} thereafter.
5400 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5401 as you are previously; type @kbd{a}. Then a score entry for "From"
5403 In this way, you can create a score file easily either in the summary
5404 buffer or in the score editing buffer.
5406 By the way, you might be aware the numbers of key strokes are different
5407 between @kbd{s s p} and @kbd{a}.
5408 This is determined by @code{wl-score-header-default-entry}.
5409 This variable specifies the default score entries corresponding to
5411 For example, for "subject" field, a type and a time limit are prompted,
5412 but for "from" field, they are fixed upon automatically as substring and
5413 permanent respectively.
5414 However, score values can be modified by the prefix argument.
5415 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5418 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5419 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5420 erasing contents of the buffer deletes the score file being edited.
5424 @subsubsection Selecting Score Files
5426 You can change score files to which scores are appended by
5427 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5428 @code{wl-score-change-score-file}.
5430 @subsubsection Summing Up the Score
5432 If you add the same entries by @code{wl-summary-increase-score},
5433 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5434 scores for the entry is summed up.
5436 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5437 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5438 @minus{}1200 will be created as a result.
5440 @subsubsection Creating Thread Key
5442 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5443 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5445 @subsubsection Creating Followup Key
5447 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5448 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5449 at the cursor to @samp{References} key.
5450 If @code{wl-score-auto-make-followup-entry} is non-nil,
5451 @samp{Message-ID} of all messages to be followed up within dates
5452 specified by @code{wl-score-expiry-days}.
5454 @subsection Key Bindings
5459 @findex wl-summary-increase-score
5460 Increases the score for the current message.
5461 And the score entry is appended to the score file at the same moment.
5462 You can specify the score value by a prefix argument.
5466 @findex wl-summary-lower-score
5467 Decreases the score for the current message.
5468 And the score entry is appended to the score file at the same moment.
5469 You can specify the score value by a prefix argument.
5472 @kindex h R (Summary)
5473 @findex wl-summary-rescore
5474 Re-applies the scoring.
5475 However, already scored messages are not scored anew.
5478 @kindex h c (Summary)
5479 @findex wl-score-change-score-file
5480 Changes the score file currently selected.
5483 @kindex h e (Summary)
5484 @findex wl-score-edit-current-scores
5485 Edits the score file currently selected.
5486 If there are multiple score files, the previously specified one is
5490 @kindex h f (Summary)
5491 @findex wl-score-edit-file
5492 Edits an arbitrary score file and selects it.
5495 @kindex h F (Summary)
5496 @findex wl-score-flush-cache
5497 Erases caches associated to the score files that are read.
5498 If you modified score files directly (from other than Wanderlust), you
5499 need to re-read them after erasing the cache.
5502 @kindex h m (Summary)
5503 @findex wl-score-set-mark-below
5504 Specifies the criterion for scores to be marked as read.
5505 Messages with scores less than this value are marked as read.
5508 @kindex h x (Summary)
5509 @findex wl-score-set-expunge-below
5510 Specifies the criterion for scores to be deleted from the summary.
5511 Messages with scores less than this value are deleted.
5512 "Deleted" means it is not shown; they are not removed from the summary
5513 information or the folder.
5514 The deleted messages can be shown by rescan-noscore again.
5517 @subsection Key Bindings in the Score Editing Buffer
5521 @kindex C-c C-k (Score Mode)
5522 @findex wl-score-edit-kill
5523 Abandons the file being edited.
5526 @kindex C-c C-c (Score Mode)
5527 @findex wl-score-edit-exit
5528 Saves the file being edited, and quits from the edit mode.
5531 @kindex C-c C-p (Score Mode)
5532 @findex wl-score-pretty-print
5536 @kindex C-c C-d (Score Mode)
5537 @findex wl-score-edit-insert-date
5538 Inserts the number of dates from Dec. 31, 1 B.C.
5539 It is used for creating the third factor of time-limited scores.
5542 @kindex C-c C-s (Score Mode)
5543 @findex wl-score-edit-insert-header
5544 Inserts the header of the message selected in the summary buffer.
5547 @kindex C-c C-e (Score Mode)
5548 @findex wl-score-edit-insert-entry
5549 Inserts the score entry of the message selected in the summary buffer.
5552 @subsection Customizable Variables
5555 @item wl-summary-default-score
5556 @vindex wl-summary-default-score
5557 The initial setting is 0 (zero).
5558 This variable specifies the default value of the score.
5559 The score is increased or decreased based upon this value.
5561 @item wl-summary-important-above
5562 @vindex wl-summary-important-above
5563 The initial setting is @code{nil}.
5564 Messages with scores larger than this value are attached with the
5565 important mark (@samp{$}).
5566 If @code{nil}, no important marks are attached.
5568 @item wl-summary-target-above
5569 @vindex wl-summary-target-above
5570 The initial setting is @code{nil}.
5571 Messages with scores larger than this value are attached with the target
5573 If @code{nil}, no target marks are attached.
5575 @item wl-summary-mark-below
5576 @vindex wl-summary-mark-below
5577 The initial setting is 0 (zero).
5578 Messages with scores smaller than this value are marked as read.
5580 @item wl-summary-expunge-below
5581 @vindex wl-summary-expunge-below
5582 The initial setting is @code{nil}.
5583 Messages with scores smaller than this value are deleted from the
5585 If @code{nil}, they are not deleted.
5587 @item wl-summary-score-marks
5588 @vindex wl-summary-score-marks
5589 The initial setting is the list shown below:
5593 (list wl-summary-new-mark)
5598 Messages with these marks are scored.
5600 @item wl-use-scoring
5601 @vindex wl-use-scoring
5602 The initial setting is t.
5603 If non-nil, scoring is enabled.
5605 @item wl-score-files-dir
5606 @vindex wl-score-files-dir
5607 The initial setting is @file{~/.elmo/}.
5608 The default directory for score files.
5610 @item wl-score-interactive-default-score
5611 @vindex wl-score-interactive-default-score
5612 The initial setting is 1000.
5613 This value is used as a score when a score factor is @code{nil} in the
5614 score file. It is also used in @code{wl-summary-increase-score} and
5615 @code{wl-summary-lower-score}, on condition that the value of
5616 @code{wl-score-header-default-entry} is @code{nil}.
5618 @item wl-score-expiry-days
5619 @vindex wl-score-expiry-days
5620 The initial setting is 7.
5621 This is the number of days before time-limited scores are deleted.
5623 @item wl-score-update-entry-dates
5624 @vindex wl-score-update-entry-dates
5625 The initial setting is @code{t}.
5626 If non-nil, it enables deletion of time-limited scores.
5628 @item wl-score-header-default-entry
5629 @vindex wl-score-header-default-entry
5630 Specifies the default value for each header field for score entries
5631 created by @code{wl-summary-increase-score},
5632 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5634 @item wl-score-simplify-fuzzy-regexp
5635 @vindex wl-score-simplify-fuzzy-regexp
5636 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5637 regular expression to be deleted from the string.
5638 Because this is usually used for Subject, the default is prefixes that
5639 are attached by mailing list programs.
5641 @item wl-summary-rescore-partial-threshold
5642 @vindex wl-summary-rescore-partial-threshold
5643 The initial setting is 200.
5644 When sync-all or rescan is executed, if there are messages more than
5645 this value, only the last same number of messages as this value are
5648 @item wl-summary-auto-sync-marks
5649 @vindex wl-summary-auto-sync-marks
5650 If non-nil, unread/important marks are synchronized when the summary
5652 Unread marks reflect information on the IMAP4 server.
5653 Important marks reflect information on the IMAP4 server (flagged or
5654 not), and contents of @samp{'mark} folder.
5655 The initial setting is @code{t}.
5659 @node Score File Format, , Score Commands, Scoring
5660 @section Score File Format
5661 @cindex Score File Format
5663 The format of score files are the same as Gnus, and basically you can
5664 use Gnus score files as they are. But they are not fully compatible
5665 because some keys are not supported and there are Wanderlust specifics.
5666 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5671 ("for sale" -1000 nil s)
5672 ("profit" -1000 nil s))
5674 ("spam@@spamspamspam" -10000 nil s))
5676 ("my@@address" 3001 nil s))
5678 (1000000 -10 nil >))
5688 If the key is a string, it is the name of the header to be matched.
5689 The following keys are available:
5690 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5691 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5692 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5693 @code{Chars} and @code{Lines} mean the size and the number of lines of
5694 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5695 are described later.
5696 The rest corresponds the field of the same name.
5698 Arbitrary numbers of core entries are specified after the key.
5699 Each score entry consists of these five factors:
5703 A factor that matches header. This should be a number in the cases of
5704 @code{lines} and @code{chars}, otherwise a string.
5707 A score factor. When the first item matches, the score of the message
5708 is increased or decreased by this value.
5711 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5712 of a number, the score is deleted if it does not match for days
5713 (@code{wl-score-expiry-days}) from the date specified by this.
5714 The date is since Dec. 31, 1 B.C.
5717 A type factor. This specifies the way the first factor matches.
5718 Available types depend on keys.
5721 @item From, Subject, References, Message-ID
5722 For these keys in string, @code{r} and @code{R} (regexp),
5723 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5724 as well as @code{f} and @code{F} (fuzzy) can be used.
5725 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5728 For these keys, the following five numerical relative operators can be
5729 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5732 This key matches @code{From} header, and scores all follow-ups to the
5734 For example, it would be useful for increasing scores for follow-ups to
5737 You can use the same types as @code{From} except for @code{f}.
5738 And a @samp{Followup} entry is automatically appended to the score file.
5741 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5742 A @samp{Thread} entry is automatically appended for each article that
5743 has @var{x} in the @code{References} header.
5744 You can make sure the whole thread including messages that does not have
5745 all ancestors @code{Message-ID} in @code{References} is scored.
5747 You can use the same types as @code{References} except for @code{f}.
5748 And a @samp{Thread} entry is automatically appended to the score file.
5752 A factor for extension header. This is meaningful only if the key is
5754 This specifies headers to be matched other than standard headers like
5755 @code{Subject} and @code{From}.
5756 Note that you should specify the header in
5757 @code{elmo-msgdb-extra-fields} also.
5758 Therefore it does not work in folders where extension headers cannot be
5763 The sum of these scores @emph{after all factors are applied} becomes the
5764 score of the message.
5766 @cindex Score File Atoms
5768 Messages with a score less than this value is marked as read.
5769 The default is @code{wl-summary-mark-below}.
5772 Messages with a score less than this value is deleted from the summary.
5773 The default is @code{wl-summary-expunge-below}.
5775 @item mark-and-expunge
5776 Both @code{mark} and @code{expunge} are applied,
5777 i.e. messages with a score less than this value is marked as read and
5778 deleted from the summary.
5781 Messages with a score greater than this value is attached with temp
5783 The default is @code{wl-summary-target-above}.
5786 Messages with a score greater than this value is attached with important
5788 The default is @code{wl-summary-important-above}.
5793 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5794 are used, you need to set @code{elmo-msgdb-extra-fields}.
5797 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5800 There are other restrictions as shown below:
5803 @item Because @samp{References} field in the summary information
5804 contains only the last @samp{Message-ID}, @code{references} key matches
5808 Keys that can be seen by folder of types:
5812 chars lines xref extra
5813 localdir,localnews Y E E E
5814 nntp (supporting xover) Y E E N
5820 N: cannot be seen (ignored)
5821 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5826 @node Address Book, Customization, Scoring, Top
5827 @chapter Address Book
5828 @cindex Address Book
5830 With address book, you can utilize address completion, and you have
5831 summary displayed with nicknames.
5834 * Mail Addresses:: Definition of Address Book
5835 * Address Manager:: Address Manager
5838 @node Mail Addresses, Address Manager, Address Book, Address Book
5839 @section Address book
5840 @cindex Address book Definition
5842 @cindex Alias, Address
5844 The file @file{~/.addresses} is a simple address book for Wanderlust.
5845 Make address file @file{~/.addresses}, and edit to suit your requirement.
5847 The data written in @file{~/.addresses} are used for address completion
5848 under draft editing mode. Furthermore, they are used when showing names
5849 in summary display mode. You can safely skip this section, if you don't
5850 want to customize address completion and summary display.
5851 It is possible to add/change/remove addresses from @file{~/.addresses} in
5852 summary buffer after Wanderlust is invoked. @refill
5854 The format is very simple. Like this. @refill
5859 # @r{Lines begin with @samp{#} are comment.}
5860 # @r{Empty lines are ignored}
5862 # @r{Format of each line:}
5863 # @var{email-address} "@var{nickname} "@var{realname}"
5865 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
5866 foo@@bar.gohome.org "Mr. Foo" "John Foo"
5867 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
5872 One line defines one persons description.
5874 Actually, in default setup, @var{nickname} is used in summary-mode and
5875 @var{realname} is used in draft preparation mode. This behavior is
5876 better understood if you try it and confirmed the function first. You
5877 can write and try a small definition, so you will know the idea of the
5878 address book before writing a big one.
5880 And, if MH alias file is specified in variable @code{wl-alias-file},
5881 it is used as an address information in the draft preparation mode.
5883 If variable @code{wl-use-ldap} is non-nil (initial setting is
5884 @code{nil}), address completion in draft mode uses LDAP information.
5886 If you use LDAP, you have to set @code{wl-ldap-server},
5887 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
5888 not have LDAP feature as built-in feature (Currently only XEmacs can
5889 have built-in LDAP feature), you have to set command exec @env{PATH} to
5890 the program @command{ldapsearch}.
5893 @node Address Manager, , Mail Addresses, Address Book
5894 @section Address Manager
5895 @cindex Address Manager
5897 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
5898 the address book and insert address to draft buffer.
5900 @subsection Key Bindings
5904 @kindex t (Address Manager)
5905 @findex wl-addrmgr-set-to
5906 Add @samp{To:} mark.
5909 @kindex c (Address Manager)
5910 @findex wl-addrmgr-set-cc
5911 Add @samp{Cc:} mark.
5914 @kindex b (Address Manager)
5915 @findex wl-addrmgr-set-bcc
5916 Add @samp{Bcc:} mark.
5919 @kindex u (Address Manager)
5920 @findex wl-addrmgr-unmark
5924 @kindex x (Address Manager)
5925 @findex wl-addrmgr-apply
5927 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
5928 buffer and quit address manager. When no draft buffer, make new draft
5929 with insert marked addresses.
5931 If no mark, quit address manager.
5935 @kindex q (Address Manager)
5936 @findex wl-addrmgr-quit
5937 Quit address manager.
5940 @kindex a (Address Manager)
5941 @findex wl-addrmgr-add
5945 @kindex d (Address Manager)
5946 @findex wl-addrmgr-delete
5950 @kindex e (Address Manager)
5951 @findex wl-addrmgr-edit
5956 @node Customization, Mailing List, Address Book, Top
5957 @chapter Customizing Wanderlust
5958 @cindex Customization
5961 * Living with other packages:: Cooperating with other packages
5962 * Highlights:: Highlights
5963 * Biff:: Notify Mail arrival
5964 * Advanced Settings:: Advanced Settings
5965 * Customizable Variables:: Customizable Variables
5970 @node Living with other packages, Highlights, Customization, Customization
5971 @section Living with other packages
5973 Examples with other packages.
5976 * imput:: imput (im-wl.el)
5978 * supercite:: supercite.el
5979 * mu-cite:: mu-cite.el
5980 * x-face-mule:: x-face-mule.el
5981 * dired-dd:: dired-dd.el
5986 @node imput, BBDB, Living with other packages, Living with other packages
5991 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5994 If @command{imput} is on the @code{exec-path} at the installation,
5995 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
5999 (autoload 'wl-draft-send-with-imput-async "im-wl")
6000 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6005 @node BBDB, supercite, imput, Living with other packages
6009 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6012 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6013 byte-compiled and installed.
6021 ;; @r{enable pop-ups}
6022 (setq bbdb-use-pop-up t)
6023 ;; @r{auto collection}
6024 (setq bbdb/mail-auto-create-p t)
6025 (setq signature-use-bbdb t)
6026 (setq bbdb-north-american-phone-numbers-p nil)
6027 ;; @r{shows the name of bbdb in the summary} :-)
6028 (setq wl-summary-from-function 'bbdb-wl-from-func)
6029 ;; @r{automatically add mailing list fields}
6030 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6031 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6035 @node supercite, mu-cite, BBDB, Living with other packages
6036 @subsection sc.el(supercite), sc-register.el
6040 The same setting as usual mailers should be OK. The following is an
6041 example of settings:
6045 (autoload 'sc-cite-original "sc" nil t)
6046 (setq mail-yank-hooks 'sc-cite-original)
6047 (setq sc-preferred-header-style 1)
6048 (setq sc-electric-references-p nil)
6049 (setq sc-citation-leader "")
6050 (setq sc-load-hook '(lambda () (require 'sc-register)))
6051 (setq sc-preferred-attribution 'registeredname)
6056 @node mu-cite, x-face-mule, supercite, Living with other packages
6057 @subsection mu-cite.el
6060 The same setting as usual mailers should be OK. The following is an
6061 example of settings.
6063 If you use mu-cite version 8.0 or earlier:
6067 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6068 (setq mail-citation-hook 'mu-cite/cite-original)
6072 If you use mu-cite version 8.1 or later:
6076 (autoload 'mu-cite-original "mu-cite" nil t)
6077 (add-hook 'mail-citation-hook (function mu-cite-original))
6081 @node x-face-mule, dired-dd, mu-cite, Living with other packages
6082 @subsection x-face-mule.el
6086 It depends on the version of x-face-mule.
6087 If you use x-face-mule 0.19 or older, do the following:
6091 (setq wl-highlight-x-face-function
6093 (lambda (&optional beg end)
6094 (x-face-mule:x-face-decode-message-header))))
6095 (require 'x-face-mule)
6099 If you use x-face-mule 0.20 or later, try the following:
6103 (setq wl-highlight-x-face-function
6105 (lambda (&optional beg end)
6106 (x-face-mule-x-face-decode-message-header))))
6107 (require 'x-face-mule)
6111 Use these settings when you use @file{x-face-mule.el} attached to
6112 bitmap-mule 8.0 or later:
6116 (autoload 'x-face-decode-message-header "x-face-mule")
6117 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6121 If there is an encoded X-Face string in a file @file{~/.xface} (the
6122 value of the variable @code{wl-x-face-file}), it is inserted as a
6123 @samp{X-Face:} field in the draft buffer (if
6124 @code{wl-auto-insert-x-face} is non-nil).
6127 @node dired-dd, MHC, x-face-mule, Living with other packages
6128 @subsection dired-dd(Dired-DragDrop)
6129 @pindex Dired-DragDrop
6131 @cindex Drag and Drop
6133 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6134 compose multi-part by simple Drag-and-Drop from dired to the draft
6135 buffer being edited in GNU Emacs (this feature is not Wanderlust
6136 specific, but general-purpose for SEMI).
6140 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6146 ;; @r{Set dired-x variables here.}
6147 ;; @r{To and flo@dots{}}
6149 (progn (require 'dired-dd)
6150 (require 'dired-dd-mime))))))
6154 @node MHC, , dired-dd, Living with other packages
6158 Message Harmonized Calendaring system
6159 (@uref{http://www.quickhack.net/mhc/})
6161 By using MHC, you can make a calendar from the messages.
6167 (setq mhc-mailer-package 'wl)
6168 (autoload 'mhc-mode "mhc" nil t)
6169 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6170 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6178 (autoload 'mhc-wl-setup "mhc-wl")
6179 (add-hook 'wl-init-hook 'mhc-wl-setup)
6183 @node Highlights, Biff, Living with other packages, Customization
6186 @subsection Customizable Variables
6189 @item wl-summary-highlight
6190 @vindex wl-summary-highlight
6191 The initial setting is @code{t}.
6192 If non-nil, the summary is highlighted.
6194 @item wl-highlight-max-summary-lines
6195 @vindex wl-highlight-max-summary-lines
6196 The initial setting is 10000.
6197 The summary is not highlighted if it has more lines than this value.
6199 @item wl-summary-highlight-partial-threshold
6200 @vindex wl-summary-highlight-partial-threshold
6201 The initial setting is 1000.
6202 This is a threshold whether the whole summary is highlighted.
6203 If there are more lines of messages in the summary, it is partially
6206 @item wl-summary-partial-highlight-above-lines
6207 @vindex wl-summary-partial-highlight-above-lines
6208 The initial setting is 30. If there are more lines of messages than
6209 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6210 after the point that is the same number of lines as this value above the
6211 cursor line are highlighted partially. (If this value is @code{nil},
6212 the last same number of lines as the value of
6213 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6215 @item wl-highlight-body-too
6216 @vindex wl-highlight-body-too
6217 The initial setting is @code{t}.
6218 If non-nil, bodies of drafts and messages are also highlighted.
6220 @item wl-highlight-message-header-alist
6221 @vindex wl-highlight-message-header-alist
6222 When highlighting headers of drafts and messages, this variable
6223 specifies which faces are allocated to important
6224 (@code{wl-highlight-message-important-header-contents}), secondly
6225 important (@code{wl-highlight-message-important-header-contents2}), and
6226 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6228 Similarly, it can be used for allocating arbitrary faces to arbitrary
6229 regular expressions.
6231 @item wl-highlight-citation-prefix-regexp
6232 @vindex wl-highlight-citation-prefix-regexp
6233 Specifies a regular expression to which quoted lines in bodies of
6234 drafts and messages match.
6235 Bodies matching to this regular expression are highlighted by the faces
6236 specified by (@code{wl-highlight-message-cited-text-*}).
6238 @item wl-highlight-highlight-citation-too
6239 @vindex wl-highlight-highlight-citation-too
6240 The initial setting is @code{nil}.
6241 If non-nil, the quoting regular expression itself given by
6242 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6244 @item wl-highlight-citation-header-regexp
6245 @vindex wl-highlight-citation-header-regexp
6246 Specifies a regular expression that denotes beginning of quotation.
6247 Bodies matching to this regular expression are highlighted by the face
6248 specified by @code{wl-highlight-message-headers}.
6250 @item wl-highlight-max-header-size
6251 @vindex wl-highlight-max-header-size
6252 The initial setting is @code{nil}. If a header size is larger than this
6253 value, it will not be highlighted. If @code{nil}, always highlighted
6254 (ignore header size).
6256 @item wl-highlight-max-message-size
6257 @vindex wl-highlight-max-message-size
6258 The initial setting is 10000.
6259 If a message is larger than this value, it will not be highlighted.
6260 With this variable, highlight is suppressed for uuencode or huge digest
6263 @item wl-highlight-signature-separator
6264 @vindex wl-highlight-signature-separator
6265 Specifies regular expressions that denotes the boundary of a signature.
6266 It can be a regular expression, or a list of ones.
6267 Messages after the place that matches this regular expression are
6268 highlighted by the face specified by
6269 @code{wl-highlight-message-signature}.
6271 @item wl-max-signature-size
6272 @vindex wl-max-signature-size
6273 The initial setting is 400.
6274 This is the largest size for a signature to be highlighted.
6276 @item wl-use-highlight-mouse-line
6277 @vindex wl-use-highlight-mouse-line
6278 The initial setting is @code{t}.
6279 If non-nil, the line pointed by the mouse is highlighted in the folder
6280 mode, summary mode, and the like.
6283 @subsection Setting Colors and Fonts of the Characters
6285 If you want to change colors or fonts of the characters, you need to
6286 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6287 want to change fonts, and @code{set-face-foreground} for colors, and so
6288 on. You cannot write face settings in @file{.emacs}; write in
6291 For example, if you want to change the color for signatures to yellow,
6295 (set-face-foreground 'wl-highlight-message-signature "yellow")
6301 Faces defined in Wanderlust:
6304 @item wl-highlight-message-headers
6305 The face for field names of message headers.
6307 @item wl-highlight-message-header-contents
6308 The face for field bodies of message headers.
6310 @item wl-highlight-message-important-header-contents
6311 The face for important parts of message headers.
6312 Per default, this face is used for a body of @samp{Subject:} field.
6313 You can change its value by editing
6314 @code{wl-highlight-message-header-alist}.
6316 @item wl-highlight-message-important-header-contents2
6317 The face for secondly important parts of message headers.
6318 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6319 fields. You can change its value by editing
6320 @code{wl-highlight-message-header-alist}.
6322 @item wl-highlight-message-unimportant-header-contents
6323 The face for unimportant parts of message headers.
6324 Per default, this face is used for bodies of @samp{X-} fields
6325 @samp{User-Agent:} fields. You can change its value by editing
6326 @code{wl-highlight-message-header-alist}.
6328 @item wl-highlight-message-citation-header
6329 The face for headers of quoted messages.
6331 @item wl-highlight-message-cited-text-*
6332 The face for texts of quoted messages. The last @samp{*} is a
6333 @var{single figure} so that 10 different colors can be used according to
6336 @item wl-highlight-message-signature
6337 The face for signatures of messages. The initial settings are
6338 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6339 dark background colors.
6341 @item wl-highlight-header-separator-face
6342 The face for header separators of draft messages.
6344 @item wl-highlight-summary-important-face
6345 The face for message lines with important marks in the summary.
6347 @item wl-highlight-summary-new-face
6348 The face for message lines with new marks in the summary.
6350 @item wl-highlight-summary-displaying-face
6351 The face for the message line that is currently displayed.
6352 This face is overlaid.
6354 @item wl-highlight-thread-indent-face
6355 The face for the threads that is currently displayed.
6357 @item wl-highlight-summary-unread-face
6358 The face for message lines with unread marks in the summary.
6360 @item wl-highlight-summary-deleted-face
6361 The face for message lines with delete marks in the summary.
6363 @item wl-highlight-summary-refiled-face
6364 The face for message lines with re-file marks in the summary.
6366 @item wl-highlight-refile-destination-face
6367 The face for re-file information part of message lines with re-file
6368 marks in the summary.
6370 @item wl-highlight-summary-copied-face
6371 The face for message lines with copy marks in the summary.
6373 @item wl-highlight-summary-target-face
6374 The face for message lines with target marks @samp{*} in the summary.
6376 @item wl-highlight-summary-thread-top-face
6377 The face for message lines that are on the top of the thread in the
6380 @item wl-highlight-summary-normal-face
6381 The face for message lines that are not on top of the thread in the
6384 @item wl-highlight-folder-unknown-face
6385 The face for folders that are not known to have how many unsync messages
6388 @item wl-highlight-folder-zero-face
6389 The face for folders that have no unsync messages in the folder mode.
6391 @item wl-highlight-folder-few-face
6392 The face for folders that have some unsync messages in the folder mode.
6394 @item wl-highlight-folder-many-face
6395 The face for folders that have many unsync messages in the folder mode.
6396 The boundary between `some' and `many' is specified by the variable
6397 @code{wl-folder-many-unsync-threshold}.
6399 @item wl-highlight-folder-unread-face
6400 The face for folders that have no unsync but unread messages in the
6403 @item wl-highlight-folder-killed-face
6404 The face for folders that are deleted from the access group in the
6407 @item wl-highlight-folder-opened-face
6408 The face for open groups in the folder mode.
6409 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6410 @code{nil} or a @var{number}.
6412 @item wl-highlight-folder-closed-face
6413 The face for close groups in the folder mode.
6414 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6415 @code{nil} or a @var{number}.
6417 @item wl-highlight-folder-path-face
6418 The face for the path to the currently selected folder in the folder
6421 @item wl-highlight-logo-face
6422 The face for logo in the demo.
6424 @item wl-highlight-demo-face
6425 The face for strings (for example, a version number) in the demo.
6429 @node Biff, Advanced Settings, Highlights, Customization
6430 @section Notify Mail arrival
6433 Following setting is to notify mail arrival of @samp{%inbox}
6434 by the indicator on the modeline
6437 (setq wl-biff-check-folder-list '("%inbox"))
6440 @subsection Customizable Variables
6442 @item wl-biff-check-folder-list
6443 @vindex wl-biff-check-folder-list
6444 The initial setting is @code{nil}.
6445 This is the list of folders to check mail arrival.
6446 If @code{nil}, wl doesn't check mail arrival.
6448 @item wl-biff-check-interval
6449 @vindex wl-biff-check-interval
6450 The initial setting is 40 (in seconds).
6451 Check mail arrival in this period.
6453 @item wl-biff-notify-hook
6454 @vindex wl-biff-notify-hook
6455 The initial setting is @code{nil}.
6456 This is a hook run at the arrival of the new mail.
6459 (setq wl-biff-notify-hook '(beep))
6464 @node Advanced Settings, Customizable Variables, Biff, Customization
6465 @section Advanced Settings
6468 * Draft for Reply:: Draft for Reply
6469 * Thread Format:: Appearance of Thread
6470 * User-Agent Field:: @samp{User-Agent:} Header Field
6474 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6475 @subsection Draft for Replay
6476 @vindex wl-draft-reply-with-argument-list
6477 @vindex wl-draft-reply-without-argument-list
6478 @vindex wl-draft-reply-myself-with-argument-list
6479 @vindex wl-draft-reply-myself-without-argument-list
6481 If you want, when you replying to articles in mailing lists, the address
6482 in Reply-To field of the original message to be prepared to To field of
6483 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6488 (setq wl-draft-reply-without-argument-list
6489 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6490 ("Followup-To" . (nil nil ("Followup-To")))
6491 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6492 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6497 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6498 in the original message, @samp{Reply-To:} field in the original is
6499 copied to @samp{To:} field.)
6501 Moreover, the behavior of @kbd{a} with prefix argument can
6502 be directed by @code{wl-draft-reply-with-argument-list} as well.
6504 Note: To set the behavior when you reply to the message written by yourself, use
6505 @code{wl-draft-reply-myself-without-argument-list} and
6506 @code{wl-draft-reply-myself-with-argument-list}
6509 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6510 @subsection Appearance of Threads
6514 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6515 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6516 391 09/18(Fri)19:24 +-[ Murata-san ]
6517 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6518 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6519 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6520 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6521 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6522 412 09/22(Tue)09:28 | +-[ Teranishi ]
6523 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6524 416 09/22(Tue)12:38 | +-[ Teranishi ]
6525 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6526 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6530 Settings to make appearance of threads like shown above:
6534 (setq wl-thread-indent-level 2)
6535 (setq wl-thread-have-younger-brother-str "+")
6536 (setq wl-thread-youngest-child-str "+")
6537 (setq wl-thread-vertical-str "|")
6538 (setq wl-thread-horizontal-str "-")
6539 (setq wl-thread-space-str " ")
6543 If you do not want to see branches, do the following:
6547 (setq wl-thread-indent-level 2)
6548 (setq wl-thread-have-younger-brother-str " ")
6549 (setq wl-thread-youngest-child-str " ")
6550 (setq wl-thread-vertical-str " ")
6551 (setq wl-thread-horizontal-str " ")
6552 (setq wl-thread-space-str " ")
6557 @node User-Agent Field, , Thread Format, Advanced Settings
6558 @subsection User-Agent Field
6562 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6563 @samp{User-Agent:} fields, define a function that generate appropriate
6564 strings as you like, and set it to variable
6565 @code{wl-generate-mailer-string-function}.
6567 If you do not want verbose @samp{User-Agent:} field, do the following:
6571 (setq wl-generate-mailer-string-function
6574 (concat "User-Agent: "
6575 (wl-generate-user-agent-string-1 nil)))))
6579 The following is a example:
6583 (setq mime-edit-insert-user-agent-field nil)
6584 (setq wl-generate-mailer-string-function
6587 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6592 @node Customizable Variables, Hooks, Advanced Settings, Customization
6593 @section Customizable Variables
6595 Customizable variables that have not been described yet:
6598 @item wl-default-folder
6599 @vindex wl-default-folder
6600 The initial setting is @samp{%inbox}. This is the default value for moving to
6601 a folder and the like.
6603 @item wl-draft-folder
6604 @vindex wl-draft-folder
6605 The initial setting is @samp{+draft}. It is the folder to which drafts are
6606 saved. It must be a localdir folder.
6608 @item wl-trash-folder
6609 @vindex wl-trash-folder
6610 The initial setting is @samp{+trash}. It is the wastebasket folder.
6611 If you changed this variable, you had better restart Wanderlust.
6613 @item wl-interactive-exit
6614 @vindex wl-interactive-exit
6615 The initial setting is @code{t}.
6616 If non-nil, you are asked for confirmation when Wanderlust terminates.
6618 @item wl-interactive-send
6619 @vindex wl-interactive-send
6620 The initial setting is @code{nil}.
6621 If non-nil, you are asked for confirmation when mail is sent.
6623 @item wl-folder-sync-range-alist
6624 @vindex wl-folder-sync-range-alist
6625 The initial setting is the alist shown below:
6630 ("^\\+draft$\\|^\\+queue$" . "all"))
6635 This is an associative list of regular expressions of folder names and
6636 update range of the summary. Update range is one of the @samp{all},
6637 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6638 @samp{last}. If a folder do not match, @samp{update} is used.
6641 @vindex wl-ask-range
6642 The initial setting is @code{t}.
6643 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6644 for updating the summary when you changed folders.
6646 @item wl-mime-charset
6647 @vindex wl-mime-charset
6648 The initial setting is @code{x-ctext}.
6649 This is the MIME charset for messages that are not MIME (e.g. without
6650 @samp{Content-Type:}). This value also used as default charset for
6651 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6652 this value as @code{iso-2022-jp}.)
6654 @item wl-highlight-folder-with-icon
6655 @vindex wl-highlight-folder-with-icon
6656 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6657 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6659 @item wl-strict-diff-folders
6660 @vindex wl-strict-diff-folders
6661 This is a list of regular expressions of folders.
6662 Unread messages are checked, for example when you press @kbd{s} in
6663 the folder mode, usually in a brief way (rapidly processed but not
6665 The folders matching this variable are seriously checked.
6666 You may want to set this variable so as to match conditional filter
6667 folders for IMAP4 folders.
6668 The initial setting is @code{nil}.
6670 @item wl-folder-use-server-diff
6671 @vindex wl-folder-use-server-diff
6672 When unread messages are checked, for example when you press @kbd{s} in
6673 the folder mode, usually (the number of messages on the server) @minus{}
6674 (the number of local messages) will be the number of unread messages.
6675 However, if this variable is non-nil, the number of unread messages on
6676 the server is checked. This affects IMAP4 folders only, but IMAP4
6677 folders in mail boxes matching
6678 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6679 the number of unread messages on the server, even if they matches this
6680 variable. The initial setting is @code{t}.
6682 @item wl-auto-check-folder-name
6683 @vindex wl-auto-check-folder-name
6684 The initial setting is @code{nil}.
6685 If non-nil, the folder with the name of the value is checked for unread
6686 messages at the start.
6687 If it is @code{none}, no folders are checked.
6688 If it is a list, all folders in the list are checked at the start.
6690 @item wl-auto-uncheck-folder-list
6691 @vindex wl-auto-uncheck-folder-list
6692 The initial setting is the list shown below:
6701 Folders with the name matching this variable are not checked for unread
6702 messages at the start, even if they are included in the groups in
6703 @code{wl-auto-check-folder-name}.
6705 @item wl-auto-check-folder-list
6706 @vindex wl-auto-check-folder-list
6707 The initial setting is @code{nil}.
6708 Folders with the name matching this variable are always checked for
6709 unread messages at the start, if they are included in the groups in
6710 @code{wl-auto-check-folder-name}.
6711 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6713 @item wl-no-save-folder-list
6714 @vindex wl-no-save-folder-list
6715 The initial setting is the list shown below:
6724 This is a list of regular expressions of folders not to be saved.
6726 @item wl-save-folder-list
6727 @vindex wl-save-folder-list
6728 The initial setting is @code{nil}.
6729 This is a list of regular expressions of folders to be saved.
6730 This takes precedence over @code{wl-no-save-folder-list}.
6732 @item wl-folder-mime-charset-alist
6733 @vindex wl-folder-mime-charset-alist
6734 The initial setting is the alist shown below:
6738 (("^-alt\\.chinese" . big5)
6739 ("^-relcom\\." . koi8-r)
6741 ("^-han\\." . euc-kr))
6746 This is an associative list of regular expressions of folder names and
6748 If a folder do not match, @code{wl-mime-charset} is used.
6750 @item wl-folder-init-load-access-folders
6751 @vindex wl-folder-init-load-access-folders
6752 The initial setting is @code{nil}.
6753 This is a list of access groups to be loaded specifically at the start.
6754 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6756 @item wl-folder-init-no-load-access-folders
6757 @vindex wl-folder-init-no-load-access-folders
6758 The initial setting is @code{nil}.
6759 This is a list of access groups not to be loaded specifically at the
6761 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6763 @item wl-delete-folder-alist
6764 @vindex wl-delete-folder-alist
6765 The initial setting is the alist shown below:
6774 This list determines disposition of messages with delete marks.
6775 Each item in the list is a folder and destination; you can specify any
6776 one of the following in the place of destination:
6779 @code{remove} or @code{null} : deletes the messages instantly.
6780 string : moves the messages to the specific folder.
6781 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
6784 @item wl-refile-policy-alist
6785 @vindex wl-refile-policy-alist
6786 The initial setting is the list shown below:
6796 This list determines whether messages with re-file marks are moved or
6797 copied. Each item in the list is a cons cell of a folder and
6798 @code{copy} or @code{move}.
6800 @item wl-x-face-file
6801 @vindex wl-x-face-file
6802 The initial setting is @file{~/.xface}.
6803 The name of the file that contains encoded X-Face strings.
6806 @item wl-demo-display-logo
6807 @vindex wl-demo-display-logo
6808 If non-nil, bitmap image is shown on the opening demo. If you set
6809 @code{xpm} or @code{xbm}, (if possible) display selected image type
6812 @item elmo-use-database
6813 @vindex elmo-use-database
6814 This is meaningful for XEmacs only. The initial setting depends on
6815 XEmacs (@code{t} for XEmacs with dbm).
6816 If non-nil, Message-ID is controlled by dbm.
6818 @item elmo-passwd-alist-file-name
6819 @vindex elmo-passwd-alist-file-name
6820 The initial setting is @file{passwd}.
6821 This is the name of the file in which passwords are saved.
6822 @code{elmo-passwd-alist-save} saves current passwords to the file.
6824 @item elmo-nntp-list-folders-use-cache
6825 @vindex elmo-nntp-list-folders-use-cache
6826 The initial setting is 600 (in seconds).
6827 This is period in seconds during which results of @samp{list} and
6828 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6831 @item elmo-nntp-max-number-precedes-list-active
6832 @vindex elmo-nntp-max-number-precedes-list-active
6833 The initial setting is @code{nil}.
6834 If non-nil, the number of article obtained by @samp{list active} in NNTP
6835 are used as the maximum article number of the folder.
6836 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6837 and if the number of read messages is not correct.
6839 @item elmo-nntp-default-use-listgroup
6840 @vindex elmo-nntp-default-use-listgroup
6841 The initial setting is @code{t}.
6842 If non-nil, @samp{listgroup} is used for checking the total number of
6843 articles. If it is @code{nil}, @samp{group} is used. In the latter
6844 case, the processing will be a little faster at the sacrifice of
6847 @item elmo-pop3-send-command-synchronously
6848 @vindex elmo-pop3-send-command-synchronously
6849 The initial setting is @code{nil}.
6850 If non-nil, POP3 commands are issued synchronously. Some implementation
6851 of POP3 server fails to get summary information without this setting.
6852 You may have to set this variable to @code{t}, if the process hangs
6853 while looking up POP3.
6855 @item elmo-dop-flush-confirm
6856 @vindex elmo-dop-flush-confirm
6857 The initial setting is @code{t}.
6858 If non-nil, you are asked for confirmation if accumulated off-line
6859 operations are executed.
6861 @item elmo-display-progress-threshold
6862 @vindex elmo-display-progress-threshold
6863 The initial setting is 20.
6864 Threshold for display of progress gauge. If number of renewal is more than
6865 this value, display progress gauge.
6869 @node Hooks, , Customizable Variables, Customization
6875 @node Mailing List, Addition, Customization, Top
6876 @chapter Wanderlust Mailing List
6881 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6884 Topics related to Wanderlust are discussed in the mailing list.
6885 The latest version is also announced there (in Japanese, sorry).
6887 A guide can be obtained automatically by sending mail to
6888 @t{wl-ctl@@lists.airs.net} with the body
6893 Please send bug reports or patches to the mailing list. You can post to
6894 the mailing list even though you are not a member of it.
6896 If you send a bug report, please attach Backtrace with it.
6897 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
6900 I would like to express my thanks to the members of the mailing list for
6901 valuable advice and many pieces of code they contributed.
6904 @node Addition, Index, Mailing List, Top
6905 @chapter Additional Information
6907 @section Brief History
6910 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6911 3/10 Made a msgdb mechanism by elisp.
6912 3/26 IMAP and NNTP can be displayed in threads.
6913 4/13 Began to assemble thread display modules as elmo.
6914 5/01 Finished 0.1.0, initial version with many defects.
6915 6/12 I made a slip of the tongue and said I was writing elisp
6916 mailer supporting IMAP
6917 6/16 0.1.3 was announced at tm-ja, elisp ML.
6918 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6919 7/01 Support for mm-backend (0.3.0).
6920 8/25 multi folder added (0.5.0).
6921 8/28 filter folder added (0.5.1).
6922 9/10 You can open/close threads (0.6.0).
6923 9/11 fldmgr by Murata-san made editing folders easy.
6924 9/18 lha folders added by Okunishi-san (0.6.3).
6925 9/24 Display of branches of threads (0.6.5).
6926 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6927 10/28 Off-line operations (0.7.4).
6928 12/09 Becomes beta version.
6929 12/21 wl-expire by Murata-san.
6930 1999 2/03 auto-refile by Tsumura-san.
6931 4/28 wl-template by Murata-san.
6932 5/18 Released 1.0.0 stable.
6933 7/05 Scoring by Murata-san (2.1.0).
6934 9/26 New plugged system by Murata-san (2.2.2).
6935 12/20 Support Modified UTF7.
6936 2000 3/24 Released 1.1.0 stable.
6937 4/03 CVS development started.
6938 5/07 Thread restoration & Its speed up with Murata-san.
6939 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6940 7/11 killed message feature.
6941 7/18 Use UIDL in POP3.
6942 9/12 biff feature with Satata-san & Yamaoka-san.
6943 10/17 expire-hide by Okada-san.
6944 11/08 Released 2.4.0 stable.
6945 2001 7/04 Released 2.6.0 stable.
6946 8/21 wl-addrmgr by Kitamoto-san.
6949 See @file{ChangeLog} for details.
6953 According to a dictionary, Wanderlust has the meaning:
6957 n eager longing for or impulse towards travelling in distant lands
6958 [Ger, fr wandern to wander + lust desire, pleasure]
6962 but I had no profound intention. (if farfetched, IMAP @result{} you can
6963 read mail anywhere @result{} desire to wander ?)
6965 Elmo is the abbreviation of @samp{Elisp Library for Message
6966 Orchestration}. At first I meant the red puppet in the Sesame Street,
6967 but you may associate it with Wandering @result{} Drifting @result{}
6968 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6972 Each versions has code names (they are almost jokes).
6973 Currently they are picked up alphabetically from the top 40 hits of
6974 U.S. Billboard magazines in 1980s.
6976 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
6979 @node Index, , Addition, Top
6983 * Concept Index:: Concept Index
6984 * Key Index:: Key Index
6985 * Variable Index:: Variable Index
6986 * Function Index:: Function Index
6989 @node Concept Index, Key Index, Index, Index
6990 @unnumberedsec Concept Index
6993 @node Key Index, Variable Index, Concept Index, Index
6994 @unnumberedsec Key Index
6997 @node Variable Index, Function Index, Key Index, Index
6998 @unnumberedsec Variable Index
7001 @node Function Index, , Variable Index, Index
7002 @unnumberedsec Function Index