1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
11 @dircategory GNU Emacs Lisp
13 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
16 @c permissions text appears in an Info file before the first node.
18 This file documents Wanderlust, Yet another message interface on
21 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
22 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
23 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada},
24 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
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
61 @author Katsumi Yamaoka
63 @author Yoichi Nakayama
66 @vskip 0pt plus 1filll
67 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
68 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
69 @w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
70 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
72 This manual is for Wanderlust version @value{VERSION}.
74 Permission is granted to make and distribute verbatim copies of this
75 manual provided the copyright notice and this permission notice are
76 preserved on all copies.
78 Permission is granted to copy and distribute modified versions of this
79 manual under the conditions for verbatim copying, provided that the
80 entire resulting derived work is distributed under the terms of a
81 permission notice identical to this one.
83 Permission is granted to copy and distribute translations of this manual
84 into another language, under the above conditions for modified versions.
90 @node Top, Introduction, (dir), (dir)
91 @top Wanderlust User's Manual
106 This manual is for Wanderlust @value{VERSION}.
111 * Introduction:: Read this first
112 * Start Me Up:: Invoking Wanderlust
113 * Folders:: How to specify folders
114 * Folder:: Selecting and editing folders
115 * Summary:: Reading and refiling messages
116 * Message:: Saving and playing MIME multipart entities
117 * Draft:: Draft buffer, sending mail and news
118 * Disconnected Operations:: Off-Line management
119 * Expire and Archive:: Automatic expiration and archiving of messages
120 * Scoring:: Score of the messages
121 * Address Book:: Management of Address Book
122 * Spam Filter:: Spam filtering
123 * Advanced Issues:: Advanced Issues
124 * Migration:: Switch from older version of Wanderlust
125 * Terminology:: Terminologies
126 * Mailing List:: Wanderlust mailing list
127 * Addition:: Additional Information
132 @node Introduction, Start Me Up, Top, Top
133 @chapter Introduction of Wanderlust
136 Wanderlust is an mail/news management system on Emacsen.
137 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
139 The main features of Wanderlust:
142 @item Pure elisp implementation.
143 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
144 @item Unified access method to messages based on Mew-like Folder Specification.
145 @item Mew-like Key-bind and mark handling.
146 @item Manages unread messages.
147 @item Interactive thread display.
148 @item Folder Mode shows the list of subscribed folders.
149 @item Message Cache, Disconnected Operation.
150 @item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed).
151 @item MIME compliant (by SEMI).
152 @item Transmission of news and mail are unified by Message transmitting draft.
153 @item Graphical list of folders (XEmacs and Emacs 21).
154 @item View a part of message without retrieving the whole message (IMAP4).
155 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
156 @item Virtual Folders.
157 @item Supports compressed folder using common archiving utilities.
158 @item Old articles in folders are automatically removed/archived (Expiration).
159 @item Automatic re-file.
160 @item Template function makes it convenient to send fixed form messages.
166 We confirm Wanderlust works on following Emacsen:
169 @item Mule 2.3 based on Emacs 19.34
170 @item Emacs 20.2 or later
171 @item XEmacs 20.4 or later
172 @item Meadow 1.00 or later
173 @item NTEmacs 20.4 or later
177 IMAP4 connectivity with following imapd are confirmed to work with
181 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
182 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
183 @item Courier-IMAP 1.3.2 or later
184 @item AIR MAIL (AIRC imapd release 2.00)
186 @item Microsoft Exchange Server 5.5
187 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
190 LDAP connectivity with following LDAPd are confirmed to work with
194 @item OpenLDAP 2.0.6 or later
198 @node Start Me Up, Folders, Introduction, Top
199 @chapter Start up Wanderlust
202 The necessary procedure for starting Wanderlust is explained in steps
205 (Of course, you need a mail/news readable environment in advance)
208 * MIME Modules:: Installing the MIME modules
209 * Download:: Download and extract the packages
210 * Install:: Byte-compile and install
211 * Minimal Settings:: @file{.emacs} setup
212 * Folder Definition:: Folder definition
213 * Start Wanderlust:: Starting Wanderlust
214 * Overview:: Basic components of Wanderlust
218 @node MIME Modules, Download, Start Me Up, Start Me Up
219 @section Installing MIME modules
225 You must install SEMI beforehand to use Wanderlust.
227 SEMI can be downloaded from following site:
231 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
235 You need packages named APEL and FLIM to use SEMI.
236 You can download APEL and FLIM from following URLs:
240 APEL: ftp://ftp.m17n.org/pub/mule/apel/
241 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
245 You have to install APEL, FLIM and SEMI in this order. Generally,
246 @samp{make install} will do the job. (In XEmacs 21, @samp{make
249 Refer to the documents of each package for detailed installation
250 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
251 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
255 Recommended combination of APEL, FLIM and SEMI are following:
258 @item APEL 10.6, FLIM 1.14.6 and SEMI 1.14.6
261 You can also use many other FLIM/SEMI variants. Combination of the
262 latest versions should work. For example, the following combination are
266 @item APEL 10.6, SLIM 1.14.9, SEMI 1.14.5
267 @item APEL 10.6, CLIME 1.14.5, EMIKO 1.14.1
270 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
273 @node Download, Install, MIME Modules, Start Me Up
274 @section Download and Extract the Package
277 You can download Wanderlust package from following sites:
281 ftp://ftp.gohome.org/wl/
284 Mirrored ftp/http sites:
288 @c ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
289 http://www.jpl.org/elips/wl/
290 http://www.ring.gr.jp/archives/text/elisp/wl/
291 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
295 Extract the obtained package to your working directory:
300 % tar zxvf wl-@var{version}.tar.gz
301 % cd wl-@var{version}
305 @subsection To use SSL (Secure Socket Layer)
310 SSL (Secure Socket Layer) can be used for
311 SMTP, IMAP, NNTP and POP connections in Wanderlust.
313 There are two ways to use SSL. One is to start SSL negotiation just
314 after the connection establishment (generic way). The other one is to
315 start SSL negotiation by invoking STARTTLS command in the each session.
317 To use the formal SSL (generic SSL), you must set @env{PATH} to the
318 directory that OpenSSL commands are installed.
320 To use the latter SSL(STARTTLS), you must install starttls package in
322 You can download starttls package from the following site.
325 ftp://opaopa.org/pub/elisp/
328 @node Install, Minimal Settings, Download, Start Me Up
329 @section Byte-compile and install
336 @subsection Installation
338 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
339 Set the Emacs's command name to @code{EMACS}.
340 Set package installation directory to @code{LISPDIR}.
341 Then, please execute following commands.
350 Destination directory is auto-probed if you leave @code{LISPDIR}
351 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
353 If you are using an Emacs variant which does not merge specified directory
354 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
355 then you will see the error message:
358 Cannot open load file: mime-setup
362 In this case, either add destination directories of custom, APEL, FLIM
363 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
364 @code{load-path} in @file{WL-CFG} in extracted directory.
366 If you want to handle shimbun folders or to use BBDB, add directory
367 where emacs-w3m or BBDB is installed to @code{load-path}. Then necessary
368 modules will be byte-compiled and installed.
369 @xref{Shimbun Folder}, @xref{BBDB}.
371 @subsection @file{WL-CFG}
373 Contents of the file @file{WL-CFG} is loaded under installation if a file
374 with that name exists in extracted directory. You can use @file{WL-CFG} to
375 configure @code{load-path} to extra packages such as SEMI if needed.
377 If you want to specify the install directory of Wanderlust related
378 files, then set following variables in @file{WL-CFG}
382 A directory to install WL modules.
383 This directory is relative directory from @code{LISPDIR}.
384 WL modules include @file{wl*.el}, @file{wl*.elc} files.
385 @c Modules under the directory @file{util/} are also installed if
386 @c it detected as necessary.
389 A directory to install ELMO modules.
390 This directory is relative directory from @code{LISPDIR}.
391 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
392 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
396 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
398 If you want to install ELMO related files under a sub-directory
399 such as "elmo" then add following to @file{WL-CFG}:
402 (setq ELMO_PREFIX "elmo")
405 @subsection Install as a XEmacs package
406 @cindex XEmacs package
407 @cindex XEmacs package install
408 @cindex Package, XEmacs
409 @cindex Package install, XEmacs
410 @c @cindex install-package
412 It is possible to install Wanderlust as one of packages of XEmacs (21.0
413 or later). Configuration for autoload and icon-path in local
414 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
417 Follow the next example to install Wanderlust as an XEmacs package.
423 % make install-package
427 package directory is auto-probed, if SEMI is installed.
428 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
430 @subsection Run in place
432 If wl and elmo directories are defined in @code{load-path}, then
433 byte-compilation and installation are not necessary to start Wanderlust.
434 For example, if package is extracted in @file{~/work}, Wanderlust can be
435 invoked with following setting in @file{~/.emacs}.
439 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
440 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
446 Manual is described in Info format. Please do following.
455 If you install Wanderlust as a XEmacs package, Info file is already
456 installed too, so there are no need of these commands.
458 Manual directory is automatically detected. Of course, it can be
459 configured by @code{INFODIR} in @file{Makefile}.
461 You can read manual at the following URL:
464 http://www.gohome.org/wl/doc/wl_toc.html
467 @node Minimal Settings, Folder Definition, Install, Start Me Up
468 @section Set up .emacs
469 @cindex Minimal Settings
471 @cindex Configuration
475 The Wanderlust package contains two module groups.
478 @item ELMO (elmo-*.el)
479 These modules show everything as folders. This is the back-end for WL.
481 These modules controls the behavior of main body of Wanderlust.
482 They are also the front-end for ELMO.
485 You can customize the behavior of Wanderlust by changing the value
486 of environmental variables which begins with @code{elmo-} and @code{wl-}.
488 The minimal requirement for settings is as the following.
492 ;; @r{autoload configuration}
493 ;; @r{(Not required if you have installed Wanderlust as XEmacs package)}
494 (autoload 'wl "wl" "Wanderlust" t)
495 (autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
496 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
498 ;; @r{Directory where icons are placed.}
499 ;; @r{Default: the peculiar value to the running version of Emacs.}
500 ;; @r{(Not required if the default value points properly)}
501 (setq wl-icon-directory "~/work/wl/etc")
503 ;; @r{SMTP server for mail posting. Default: @code{nil}}
504 (setq wl-smtp-posting-server "your.smtp.example.com")
505 ;; @r{NNTP server for news posting. Default: @code{nil}}
506 (setq wl-nntp-posting-server "your.nntp.example.com")
510 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
511 file exists). So it is convenient to gather Wanderlust specific settings
512 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
513 because you can't write them in @file{.emacs}
514 (if you write it to @file{.emacs}, you'll get an error).
517 All above described settings except autoload configuration can be written
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 your @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, 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 be 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 collects all sub-folders in the folder to make a group. (Its
614 behavior differs by the type of the folder. For example, @samp{+}
615 followed by @samp{/} makes entire MH 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, Overview, 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
634 appear. That means the folders you defined in the @file{~/.folders} are
637 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
638 can skip folder checking.
641 @node Overview, , Start Wanderlust, Start Me Up
645 Basically, you will handle messages in wanderlust while you come and go
646 from/to each of the following buffers. Details of each ones are
647 explained in following chapters.
651 You can see the list of folders. You can select some folder and go into the summary
652 of it. You can subscribe new folder or edit subscription list.
654 You can see the list of messages in the folder. You can select message
655 and view its contents, and reply to some message. You can delete ones or
656 move ones to another folder.
658 You can see the contents of the message. You can save part to disk or
659 open in external programs.
661 You can edit message.
665 @node Folders, Folder, Start Me Up, Top
666 @chapter Wanderlust's folders
669 This chapter describes the folder types which Wanderlust is able to handle.
671 Wanderlust uses ELMO as it's interface, so you can use every folder types
674 As of version @value{VERSION}, 15 types of folders are predefined. These
675 are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP,
676 Shimbun, Namazu, Multi, Filter, Pipe, File, Access and Internal folder
680 * IMAP Folder:: @samp{%} -- IMAP folder
681 * NNTP Folder:: @samp{-} -- NNTP folder
682 * MH Folder:: @samp{+} -- MH folder
683 * Maildir Folder:: @samp{.} -- Maildir folder
684 * News Spool Folder:: @samp{=} -- News spool folder
685 * Archive Folder:: @samp{$} -- Archive folder
686 * POP Folder:: @samp{&} -- POP folder
687 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
688 * Namazu Folder:: @samp{[} -- Namazu Folder
689 * Multi Folder:: @samp{*} -- Multi folder
690 * Filter Folder:: @samp{/} -- Filter folder
691 * Pipe Folder:: @samp{|} -- Pipe folder
692 * Internal Folder:: @samp{'} -- Internal folder
693 * File Folder:: -- File folder
694 * Access Folder:: -- Access folder
698 @node IMAP Folder, NNTP Folder, Folders, Folders
706 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
712 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
716 You can specify @code{login} (encoded password transmission),
717 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
718 authentication) or @code{clear} (or @code{nil}, plain password
719 transmission) as @var{authenticate-type}.
724 @var{username} -> The value of @code{elmo-imap4-default-user}.
725 Initial setting is @env{USER} environment variable or
726 @env{LOGNAME} environment variable or return value of
727 @code{(user-login-name)}.
728 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
729 Initial setting is "auth".
730 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
731 Initial setting is "localhost".
732 @var{port} -> The value of @code{elmo-imap4-default-port}.
733 Initial setting is 143.
736 You can omit the @var{hostname} from folder names if you set
737 @code{elmo-imap4-default-server} as your main IMAP server.
738 For example, you can specify a folder as @samp{foo%imap@@gateway} even
739 if you have to go through a firewall.
743 ;; @r{Example: imap4.exaple.org as main IMAP server}
744 (setq elmo-imap4-default-server "imap4.example.org")
748 SSL (Secure Socket Layer) connection will be used if a folder name ends
749 with @samp{!}. If a folder name ends with @samp{!!}, STARTTLS
750 connection will be established.
752 If the value of @code{elmo-imap4-default-stream-type} is @code{ssl},
753 SSL will be the default connection, i.e. you can omit @samp{!}. If it
754 is is @code{starttls}, STARTTLS will be the default connection. To use
755 normal connection in these cases, add @samp{!direct} at the end of
760 ;; @r{Example: Use SSL connection}
761 (setq elmo-imap4-default-stream-type 'ssl)
765 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
766 authentication method, the password is sent in encoded form. But, if
767 your server is unable to receive an encoded password, authentication
768 will fall back to @code{clear} (that is, sending password in raw format)
769 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
770 authentication will fall back to @code{clear} without confirmation
771 (default value is @code{nil}).
775 ;; @r{Example: password in raw format}
776 (setq elmo-imap4-default-authenticate-type 'clear)
784 %inbox -> IMAP mailbox "inbox"
785 %#mh/inbox -> IMAP mailbox "#mh/inbox"
787 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
788 %inbox:hoge/clear@@server1
789 -> server1's IMAP mailbox "inbox"
790 of user "hoge", with plain password authentication
795 @subsection International mailbox names (Modified UTF7)
796 @cindex Modified UTF7
803 You can use international mailbox names in @var{mailbox} part, if you
804 are using Emacs with UTF-7 support and
805 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
806 value is @code{nil}).
808 Currently, Mule-UCS package is required to use UTF-7.
809 Mule-UCS works on following Emacsen.
812 @item Emacs 20.3 or later
813 @item XEmacs 21.2.37 or later
816 You can obtain Mule-UCS package from following URL.
819 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
822 @node NNTP Folder, MH Folder, IMAP Folder, Folders
833 A folder to access USENET news via NNTP protocol (RFC 977).
834 One newsgroup is treated as a folder.
840 @samp{-} @var{newsgroup} [@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
846 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
847 Initial setting is @samp{localhost}.
848 @var{username} -> The value of @code{elmo-nntp-default-user}.
849 Initial setting is @code{nil}.
850 @var{port} -> The value of @code{elmo-nntp-default-port}.
851 Initial setting is 119.
854 AUTHINFO is used as authentication method if the @var{username} is
855 non-nil. SSL connection will be used if a folder name ends with @samp{!}.
856 If a folder name ends with @samp{!!}, STARTTLS connection will be
859 If the value of @code{elmo-nntp-default-stream-type} is @code{ssl},
860 SSL will be the default connection, i.e. you can omit @samp{!}. If it
861 is is @code{starttls}, STARTTLS will be the default connection. To use
862 normal connection in these cases, add @samp{!direct} at the end of
869 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
870 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
875 @node MH Folder, Maildir Folder, NNTP Folder, Folders
882 A folder to access MH format mail (1 file is 1 mail).
887 @samp{+} @var{directory-name}
890 Normally, @var{directory-name} is an relative path to the variable
891 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
892 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
893 (this is also true for drive-letters).
895 Message number is used for the name of the message file.
901 +inbox -> @file{~/Mail/inbox}
902 +from/teranisi -> @file{~/Mail/from/teranisi}
903 +~/test -> @file{~/test}
908 @node Maildir Folder, News Spool Folder, MH Folder, Folders
909 @section Maildir Folder
911 @cindex Maildir Folder
915 A folder to access Maildir format (1 file is 1 mail).
920 @samp{.} [@var{directory-name}]
923 Normally, @var{directory-name} is a relative path to the variable
924 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
925 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
926 (this is also true for drive-letters).
928 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
929 Messages are contained in the @file{cur} directory. All message files
930 in the @file{new} directory are moved to @file{cur} directory when you
931 access the folder. All message files contained in the @file{tmp}
932 directory and not accessed for 36 hours are deleted.
934 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
940 . -> @file{~/Maildir}
941 .inbox -> @file{~/Maildir/inbox}
942 .from/teranisi -> @file{~/Maildir/from/teranisi}
943 .~/test -> @file{~/test}
948 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
949 @section News Spool Folder
951 @cindex News spool Folder
954 This folder handles locally saved news articles which are proposed by
955 Mew/IM. You can also read articles directly from a spool-file which is
956 retrieved by an utility like @command{gnspool}.
961 @samp{=} @var{directory-name}
964 @var{directory-name} is a sub-directory to the directory defined by
965 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
966 You can use @samp{.} as directory delimiter as well as @samp{/}.
972 =fj/os/os2 -> @file{~/News/fj/os/os2}
973 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
978 @node Archive Folder, POP Folder, News Spool Folder, Folders
979 @section Archive Folder
981 @cindex Archive Folder
984 This method can handle archive files, which are compressed by utilities
985 such as Info-ZIP or LHA, as one folder.
991 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
995 @var{path-name} is the relative path from
996 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
997 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
998 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
999 also permitted under the environment of ange-ftp, efs.
1001 The actual file name of the archive folder is
1002 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1003 under the @var{path-name}. If a file named @var{path-name} exists, it is
1004 treated as folder. The suffix is automatically decided for
1005 @var{archiver-type}.
1007 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1008 (Initial setting is @code{zip}) is referred.
1010 @var{prefix} specifies the internal directory structure of the archive.
1011 For example, if the ML server is fml, @file{msend.tar.gz} has a
1012 structure like @file{spool/1}, so you have to specify @samp{spool} as
1019 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1020 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1021 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1022 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1023 $ml;zip/ -> Access group consists of archive folders
1024 under @file{~/Mail/ml}
1029 * Archiver:: Supported Archivers
1030 * Archive Tips:: TIPS
1031 * Archive Vars:: Customization
1035 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1036 @subsection Supported Archives
1046 By default, following archives are supported.
1050 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1051 GNU TAR('tgz, 'tar) ;; read-only
1055 If your archiver can include multiple files in one archive, you have a
1056 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1057 of the candidate. TAR is supported read-only because it cannot delete
1058 file in the archive (@code{mv})).
1060 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1061 archiver of Wanderlust because they cannot include multiple
1062 files. Archivers that cannot extract files to standard output are also
1065 @subsection OS specific information about archiver.
1067 Behaviors of the following archivers are confirmed by further experiences.
1068 (@samp{*} mark means recommended archiver).
1071 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1072 LHA OS/2 version Rel.2.06b Feb 18, 1998
1073 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1074 *Zip 2.2 (November 3rd 1997).
1075 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1076 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1077 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1079 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1080 LHa for UNIX V 1.14c
1081 UnZip 5.32 of 3 November 1997
1082 Zip 2.2 (November 3rd 1997)
1083 GNU tar 1.12 (1.11.x is no good)
1084 gzip 1.2.4 (18 Aug 93)
1086 [Win32] Win.98/Meadow
1090 GNU tar 1.11.8 + 1.5(WIN32)
1097 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1098 Hiramatsu version of LHA is only supported.
1099 In Win32, LHa32 is only supported (DOS version is no good).
1101 * Caution about GNU tar
1103 You have to take care about GNU tar's version because many version has
1104 problem on deleting file from archive.
1106 Please test @option{--delete} @option{-f} options work. Otherwise, your
1107 archive will be destroyed. No problem is reported on above versions of
1111 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1113 @cindex Archive Tips
1115 For comfortable migration, usage of @code{wl-summary-archive}
1116 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1117 archive folders created by expiration, you must set non-nil value to
1118 @code{elmo-archive-treat-file}.
1120 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1121 in processing speed. For comfortable use, Emacs20 is recommended.
1122 (If re-search's performance is the problem, 19.3x or later may be okay.)
1124 If many files are included in one archive,
1125 it takes long time to access the archive folder because
1126 archiver starting overhead is increased (especially LHA).
1127 150-200 messages in one archive is recommended.
1129 Of course, following is possible @t{:-)}
1130 (meanings of these variables are described later.)
1134 (setq wl-fcc "$backup")
1135 (setq wl-trash-folder "$trash;lha")
1139 @node Archive Vars, , Archive Tips, Archive Folder
1140 @subsection Variables About Archive Folder
1141 @cindex Archive variables
1144 @item elmo-archive-default-type
1145 @vindex elmo-archive-default-type
1146 The initial setting is @code{zip}.
1147 Set archiver type by symbol.
1149 @item elmo-archive-@var{type}-method-alist
1150 @vindex elmo-archive-TYPE-method-alist
1151 Define archiver @var{type}'s methods.
1152 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1153 Each element of the alist is following.
1157 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1158 (@var{action} . @var{function}) ;; function
1162 Currently available actions are following.
1166 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1167 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1174 actions enclosed with braces are optional (They are used for better
1177 @item elmo-archive-suffix-alist
1178 @vindex elmo-archive-suffix-alist
1179 An alist of archiver-type (symbol) and suffix.
1181 @item elmo-archive-file-regexp-alist
1182 @vindex elmo-archive-file-regexp-alist
1183 An alist of a regexp to get file number from list output of archiver
1184 and archiver-type (symbol).
1186 @item elmo-archive-method-list
1187 @vindex elmo-archive-method-list
1188 A list of elmo-archive-@var{type}-method-alist
1189 (@var{type} is a symbol of archiver-type).
1191 @item elmo-archive-lha-dos-compatible
1192 @vindex elmo-archive-lha-dos-compatible
1193 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1194 DOS (Mr. Yoshizaki original) compatible.
1196 @item elmo-archive-cmdstr-max-length
1197 @vindex elmo-archive-cmdstr-max-length
1198 The initial setting is 8000.
1200 Max length of command line argument for external archiver program.
1201 Emacs does not have a limit of command line byte length, but some OS
1202 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1203 this limit because it calls external archiver program directly (not
1204 called via shell). For example, you cannot delete messages if archiver
1205 program must receive larger bytes of arguments to delete. OS/2 have a
1206 command line argument limit of 8190 bytes, so we defined default as 8000
1209 However, you don't have an influence of command line argument limit
1210 if the archiver has `actions' to receive target file information from
1211 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1215 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1223 A folder to access e-mails via POP3 protocol (RFC 1939).
1229 @samp{&} [@var{username}][@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
1234 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1235 as @var{authenticate-type}.
1237 You can specify @samp{uidl} (use UIDL command for message numbering) or
1238 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1242 @var{username} -> The value of @code{elmo-pop3-default-user}.
1243 Initial setting is @env{USER} environment variable or
1244 @env{LOGNAME} environment variable or return value of
1245 @code{(user-login-name)}.
1246 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1247 Initial setting is @samp{user}.
1248 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1249 If t, use UIDL for numbering. Initial setting is t.
1250 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1251 Initial setting is @samp{localhost}.
1252 @var{port} -> The value of @code{elmo-pop3-default-port}.
1253 Initial setting is 110.
1260 &hoge@@localhost -> access localhost as user @samp{hoge}.
1261 &hoge@@popserver:109 -> access the server "popserver" on port 109
1262 as user @samp{hoge}.
1266 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1267 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1268 @file{utils/sasl/lisp/} or Emacs/W3 package
1269 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1272 If the last character of the folder name is @samp{!}, Wanderlust
1273 connects to the POP server via SSL (Secure Socket Layer). If a folder
1274 name ends with @samp{!!}, STARTTLS connection will be established.
1276 If the value of @code{elmo-pop3-default-stream-type} is @code{ssl},
1277 SSL will be the default connection, i.e. you can omit @samp{!}. If it
1278 is is @code{starttls}, STARTTLS will be the default connection. To use
1279 normal connection in these cases, add @samp{!direct} at the end of
1283 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1284 @section Shimbun Folder
1286 @cindex Shimbun Folder
1287 @cindex Folder, Shimbun
1292 A folder for watching "shimbun" (means "newspaper" in Japanese),
1293 news site and mailing list archives on WWW by using emacs-w3m
1294 (@uref{http://emacs-w3m.namazu.org/}).
1296 You should possess w3m and emacs-w3m to use this.
1302 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1306 Admissible values of @var{module-name} and @var{folder-name} are
1307 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1313 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1314 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1318 @subsection Variables About Shimbun Folder
1321 @item elmo-shimbun-update-overview-folder-list
1322 @vindex elmo-shimbun-update-overview-folder-list
1323 The initial setting is @code{all}. Specify a set of folders to update
1324 overview when messages are fetched. Specify @code{all} to update
1325 overview in all shimbun folders. You can specify a list of regular
1326 expressions of shimbun folder names to restrict affected folders.
1331 (setq elmo-shimbun-update-overview-folder-list
1332 '("^@@airs\\." "^@@namazu\\."))
1335 @kbd{s rescan} is needed after fetching to update summary view.
1339 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1340 @section Namazu Folder
1342 @cindex Namazu Folder
1343 @cindex Folder, Namazu
1344 @cindex Folder, Text Search
1347 A folder to access messages found in namazu-index with some condition.
1348 It uses namazu (@uref{http://www.namazu.org/}) for search.
1354 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1358 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1364 [wanderlust] -> search messages matched with
1365 "wanderlust" from the default index
1366 [semi flim]~/Mail/semi -> search "semi flim" from the index
1367 in the directory "~/Mail/semi"
1373 @subsubsection Enter space to separate keywords
1375 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1377 @subsubsection Alias name for index
1379 You can define an alias name for index.
1384 (setq elmo-nmz-index-alias-alist
1385 '(("cache" . "~/.elmo/cache")
1386 ("docs" . "~/documents")))
1389 Above definition defines two index aliases.
1396 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1397 directory @file{~/.elmo/cache}.
1399 @subsubsection Multiple indices
1401 You can specify a list for @code{elmo-nmz-default-index-path} and
1402 @code{elmo-nmz-index-alias-alist}.
1403 When list is specified, all index contained in the list is used as the
1409 (setq elmo-nmz-index-alias-alist
1410 '(("all" . ("~/.elmo/cache" "~/documents"))
1411 ("cache" . "~/.elmo/cache")))
1414 Using above alias setting, you can specify
1420 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1421 directory @file{~/.elmo/cache} and @file{~/documents}.
1423 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1424 @section Multi Folder
1426 @cindex Multi Folder
1427 @cindex Folder, Multiple
1428 @cindex Folder, Marge
1430 A folder to access virtual folder which collects messages from
1437 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1441 After @samp{*} character, specify multiple folders you want to collect
1442 separated by @samp{,} like
1443 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1449 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1450 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1451 treated as one folder.
1453 *+inbox,-fj.rec.tv,%inbox
1454 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1459 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1460 @section Filter Folder
1462 @cindex Filter Folder
1463 @cindex Folder, Filtering
1464 @cindex Folder, Virtual
1465 @cindex Folder, Conditional
1468 A folder to access virtual folder which collects all messages that
1469 satisfy a condition.
1474 @samp{/} @var{condition} @samp{/} @var{target-folder}
1477 In the @var{condition} part, you can specify following.
1481 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1483 first: @var{number} messages are picked from top of folder.
1484 last: @var{number} messages are picked from bottom of folder.
1490 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1491 /first:20/%inbox -> First 20 messages from %inbox are picked.
1496 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1498 since: only messages arrived since @var{date} are picked (@var{date} is included).
1499 before: only messages arrived before @var{date} are picked (@var{date} is not included).
1501 You can specify following as @var{date}.
1505 yesterday -> a day before today.
1506 lastweek -> same day of last week.
1507 lastmonth -> same day of last month.
1508 lastyear -> same day of last year.
1509 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1510 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1518 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1520 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1526 Field filter: @samp{@var{field}:@var{value}}
1528 All messages that have @var{field} and its value is @var{value} are picked.
1529 @var{field} and @var{value} are case insensitive.
1535 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1536 and its value includes "teranisi" string are picked.
1537 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1543 Flag filter: @samp{flag:@var{flag-name}}
1545 Pick up messages with flag specified by @var{flag-name}.
1547 You can specify following flag names:
1552 important -> important
1554 forwarded -> forwarded
1555 digest -> unread or important
1556 any -> unread or replied or forwarded or global-flag.
1560 You can also use flags which you have set as `global-flag'. global-flag
1561 is a flag which has arbitrary name. You can put global-flag on messages
1562 by invoking @code{wl-summary-set-flags} (Key @key{F}). By default,
1563 @samp{important} flag is prepared. You can view messages with
1564 global-flag by visiting the subfolder of @samp{'flag} folder.
1566 @xref{Internal Folder}.
1572 /flag:digest/%inbox -> a folder consist of unread or important
1574 /flag:wl/+ML/Wanderlust -> a folder consist of messages with global flag
1575 wl in +ML/Wanderlust.
1582 A condition starting with @samp{!} indicates a negation.
1583 If you combine conditions by character @samp{|}, it is considered as OR condition.
1584 @samp{&} is considered as AND condition, likewise.
1585 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1587 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1588 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1594 /from:teranisi&!to:teranisi/+inbox
1595 -> In +inbox, messages are picked if the message's
1596 From: field includes "teranisi" and
1597 To: field doesn't include "teranisi".
1599 /tocc:"Yuuichi Teranishi"/+inbox
1600 -> In +inbox, messages are picked if the
1601 message's To: field or Cc: field includes
1602 "Yuuichi Teranishi".
1604 /(from:yt|from:teranisi)&subject:report/+inbox
1605 -> In +inbox, messages are picked if the message's
1606 From: field includes "yt" or "teranisi", and
1607 Subject includes "report".
1613 Tip for string description:
1615 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1616 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1617 should be escaped with @samp{\} in it). You can enclose the string with
1618 @samp{"} even it does not contain these characters.
1624 *%inbox,/from:teranisi/%inbox@@server
1625 -> Messages in %inbox or
1626 message is in the %inbox@@server folder and it's From field
1627 includes "teranisi" are collected.
1629 /last:100//to:teranisi/*+inbox,%inbox
1630 -> Latest 100 messages which is in the +inbox or %inbox folder
1631 and To: field matches "teranisi".
1633 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1634 -> Pick messages which have From: field and it includes "hogehoge"
1635 from latest 20 messages in the %#mh/inbox@@localhost
1636 and To: or Cc: field includes "teranisi".
1639 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1640 @section Pipe Folder
1644 @cindex Download Message
1645 @cindex Incorporate Message
1647 In the pipe folder, messages are automatically transferred from the source
1648 folder to destination folder.
1653 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1656 When you access the pipe folder, messages are automatically transferred
1657 from @var{source-folder} to @var{destination-folder}.
1658 It is convenient if you want to download messages to local disk via POP.
1659 For example, if you specify following
1662 |&username@@popserver|+inbox
1666 and access it, Wanderlust downloads messages from
1667 @samp{&username@@popserver} to @samp{+inbox} automatically.
1669 On the other hand, if you put @samp{|:} instead of second @samp{|},
1670 then messages are copied to the destination folder (not deleted from
1671 source-folder). At the next time you access that folder, copies new
1675 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1678 If you want to copy messages from POP server and view them, specify the
1682 |&username@@popserver|:+inbox
1685 where messages will be kept on the server.
1691 |%inbox|%myinbox -> Download %inbox to %myinbox.
1692 |*&user@@popserver1,&user@@popserver2|+inbox
1693 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1694 |-gnu.emacs.sources|:+sources
1695 -> Copy messages from -gnu.emacs.sources to +sources.
1699 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1701 @node Internal Folder, File Folder, Pipe Folder, Folders
1702 @section Internal folder
1704 @cindex Internal Folder
1705 @cindex Folder, @samp{$} mark
1708 @c @cindex Folder, Null
1710 A folder to access internal messages of Wanderlust.
1716 @samp{'flag} [@samp{/} @var{global-flag}]
1718 @samp{'cache/00} - @samp{'cache/1F}
1722 A folder named @samp{'flag} is a special virtual folder which collects
1723 messages which have @var{global-flag}.
1725 There is @samp{important} flag defined as @var{global-flag} by default.
1726 You can review important messages at once after you put important marks
1727 on the messages in the different folders. If @var{global-flag} is omitted,
1728 it is treated as @samp{important} flag is specified.
1730 In addition, in summary mode, to be described later, you can freely
1731 define global flags and put them on messages.
1732 @xref{Usage of Summary Mode}.
1734 In this folder, if you delete message, @var{global-flag} put on the
1735 message is removed. If you append messages to this folder, the message
1736 will have @var{global-flag}.
1739 A folder named @samp{'sendlog} is a virtual folder which collects
1740 cached messages which are recoded on @file{~/.elmo/sendlog}.
1741 It might be useful when you forgot to add cc for yourself.
1742 To use this, you should set @code{wl-draft-use-cache} to non-nil
1743 so that sent messages are cached.
1746 You can access cached messages fetched via network by accessing
1747 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1748 the name of the subdirectories of the cache directory
1749 (@file{~/.elmo/cache}).
1752 @node File Folder, Access Folder, Internal Folder, Folders
1753 @section File folder
1756 File Folder gives the view for local file system.
1757 The one File Folder corresponds to the one directory.
1762 @samp{file:} @var{Path-of-the-directory}
1769 file:~/work -> @file{~/work}
1770 file:/etc -> @file{/etc}
1775 @node Access Folder, , File Folder, Folders
1776 @section Access folder
1777 @cindex Access Folder
1779 A folder to access virtual folder which collects messages from a root
1780 folder and subfolders of one. The add and remove of the subfolder is
1781 automatically reflected.
1787 @samp{access:} @var{root-folder}
1794 access:%INBOX -> All subfolders of IMAP mailbox "inbox".
1795 access:'cache -> All of 'cache folder
1800 @node Folder, Summary, Folders, Top
1801 @chapter Folder mode
1804 After you start Wanderlust, folder mode is appeared firstly.
1805 It contains folder list you subscribed.
1806 You can select and edit folders in this mode.
1809 * Selecting Folder:: Select folder you want to read
1810 * Folder Manager:: Editing folders
1814 @node Selecting Folder, Folder Manager, Folder, Folder
1815 @section Selecting Folder
1816 @cindex Selecting Folder
1818 @subsection Usage (TIPS)
1820 @subsubsection Check new, unread number
1822 Folder mode looks like this.
1823 (In XEmacs, it looks much nicer @t{;-)})
1827 [-]Desktop:14186/35580/67263
1832 [-]Emacsen:0/34/4837
1833 Wanderlust ML:0/0/558
1836 XEmacs Beta:0/29/255
1847 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1851 @kbd{s} key on the folder line updates these numbers.
1852 It changes its color if it has many new messages.
1854 The whole folder mode is a folder group named @samp{Desktop}.
1855 Folder group open/close by return key.
1856 A operation to a folder group is treated as operations on the
1858 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1859 six children folders update its unread number status.
1861 @subsubsection Select Folder
1863 To enter summary mode of the folder, type return (or space) key on
1865 If the variable @code{wl-stay-folder-window} has non-nil value,
1866 summary window appears on the right of the folder mode window.
1868 @subsection Key bindings
1870 Folder mode's key binding (related to selecting folders) is following.
1875 @kindex @key{SPC} (Folder)
1876 @kindex @key{RET} (Folder)
1877 @findex wl-folder-jump-to-current-entity
1878 Enter to the summary mode of the folder at the current cursor point.
1879 With prefix argument, enter the sticky summary.
1880 If the cursor is on the top of folder group line,
1881 the folder group is opened or closed.
1882 When the cursor is on the access group and this command is called
1883 with prefix argument, folder children list is updated to the newest one.
1884 (Children list is updated recursively if the access folder has hierarchical
1886 (@code{wl-folder-jump-to-current-entity})
1889 @kindex M-@key{RET} (Folder)
1890 @findex wl-folder-update-recursive-current-entity
1891 Folder children list of the access group at the current cursor point
1892 is updated to the newest one.
1893 (Children list is updated recursively if the access folder has hierarchical
1895 (@code{wl-folder-update-recursive-current-entity})
1900 Create a new draft message.
1905 @findex wl-folder-write-current-folder
1906 If the current cursor point is on the NNTP folder, create a new draft
1907 message which already has @samp{Newsgroups:} field. If the current
1908 cursor point is on the folder for mailing list (refile destination),
1909 create a new draft message which already has @samp{To:} field with
1910 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1912 (@code{wl-folder-write-current-folder})
1915 @kindex C-c C-o (Folder)
1916 @findex wl-jump-to-draft-buffer
1917 Move to the draft buffer if available. If multiple draft buffer exists,
1918 moved to one after another. If prefix argument is specified, load draft
1919 folder's message to the draft buffer and jump to it.
1920 (@code{wl-jump-to-draft-buffer})
1924 @findex wl-folder-check-current-entity
1925 Update new and unread number information of the folder at the current
1927 (@code{wl-folder-check-current-entity})
1931 @findex wl-folder-sync-current-entity
1932 Update summary information of the folder at the current cursor point.
1933 (@code{wl-folder-sync-current-entity})
1936 @kindex r s (Folder)
1937 @findex wl-folder-check-region
1938 Update new and unread number information of the folders in the currently
1940 (@code{wl-folder-check-region})
1943 @kindex r S (Folder)
1944 @findex wl-folder-sync-region
1945 Update summary information of the folders in the currently selected region.
1946 (@code{wl-folder-sync-region})
1950 @findex wl-status-update
1951 Sync up address book status with @file{~/.addresses}'s content.
1952 (@code{wl-status-update})
1956 @findex wl-folder-prev-unread
1957 Jump cursor to the folder which have unread messages on the upward from
1958 current cursor point.
1959 (@code{wl-folder-prev-unread})
1963 @findex wl-folder-next-unread
1964 Jump cursor to the folder which have unread messages on the downward
1965 from current cursor point.
1966 (@code{wl-folder-next-unread})
1970 @findex wl-folder-prev-entity
1971 Move cursor to the folder on the previous line.
1972 (@code{wl-folder-prev-entity})
1976 @findex wl-folder-next-entity
1977 Move cursor to the folder on the next line.
1978 (@code{wl-folder-next-entity})
1982 @findex wl-folder-jump-folder
1983 Jump to the folder specified by the user input.
1984 (@code{wl-folder-jump-folder})
1988 @findex wl-folder-prefetch-current-entity
1989 Prefetch new messages of the folder at the current cursor point by
1990 @code{wl-summary-incorporate}.
1991 If the cursor is on the folder group, it is executed recursively.
1992 (@code{wl-folder-prefetch-current-entity})
1996 @findex wl-folder-mark-as-read-all-current-entity
1997 Mark all unread messages of the folder at the current cursor point as read.
1998 If the cursor is on the folder group, it is executed recursively.
1999 (@code{wl-folder-mark-as-read-all-current-entity})
2003 @findex wl-folder-goto-first-unread-folder
2004 Enter summary mode of the first unread folder.
2005 (@code{wl-folder-goto-first-unread-folder})
2009 @findex wl-folder-empty-trash
2011 (@code{wl-folder-empty-trash})
2015 @findex wl-folder-flush-queue
2017 (@code{wl-folder-flush-queue})
2021 @findex wl-folder-virtual
2022 Move to the virtual folder (filter folder) with the condition specified.
2023 (@code{wl-folder-virtual})
2027 @findex wl-folder-pick
2028 Search the folders with the condition specified.
2029 (@code{wl-folder-pick})
2033 @findex wl-folder-open-all-unread-folder
2034 All unread folder is opened.
2035 (@code{wl-folder-open-all-unread-folder})
2039 @findex wl-execute-temp-marks
2040 Execute marks in summary buffers. @xref{Sticky Summary}.
2041 (@code{wl-execute-temp-marks})
2045 @findex wl-folder-open-close
2046 Folder group is opened/closed.
2047 (@code{wl-folder-open-close})
2051 @findex wl-folder-open-all
2052 All folder group is opened.
2053 (@code{wl-folder-open-all})
2057 @findex wl-folder-close-all
2058 All folder group is closed.
2059 (@code{wl-folder-close-all})
2069 @findex wl-folder-suspend
2071 (@code{wl-folder-suspend})
2074 @kindex M-s (Folder)
2076 Save current folder status.
2080 @kindex M-t (Folder)
2081 @findex wl-toggle-plugged
2082 Toggle Wanderlust's offline/online status.
2083 (@code{wl-toggle-plugged})
2086 @kindex C-t (Folder)
2087 @findex wl-plugged-change
2088 Start Wanderlust's plug-status manager.
2089 (@code{wl-plugged-change})
2092 @subsection Customize variables
2095 @item wl-folders-file
2096 @vindex wl-folders-file
2097 The initial setting is @file{~/.folders}.
2098 Subscribed folders are described (saved) in this file.
2100 @item wl-folder-info-save
2101 @vindex wl-folder-info-save
2102 The initial setting is @code{t}. If non-nil, unread information is
2103 saved and used in the next Wanderlust session.
2105 @item wl-stay-folder-window
2106 @vindex wl-stay-folder-window
2107 The initial setting is @code{nil}.
2108 If non-nil, summary window is appeared on the right side of the folder buffer.
2110 @item wl-folder-window-width
2111 @vindex wl-folder-window-width
2112 The initial setting is 20.
2113 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
2115 @item wl-folder-use-frame
2116 @vindex wl-folder-use-frame
2117 The initial setting is @code{nil}.
2118 If non-nil, use new frame for the folder window.
2120 @item wl-folder-many-unsync-threshold
2121 @vindex wl-folder-many-unsync-threshold
2122 The initial setting is 70.
2123 If the number of unread messages is more than this value,
2124 folder color is changed.
2126 @item wl-highlight-folder-by-numbers
2127 @vindex wl-highlight-folder-by-numbers
2128 This option controls how to highlight each line in the folder buffer.
2129 The default value is @code{t}, highlighting with various colors based on
2130 the message numbers. If it is @code{nil}, highlighting with various
2131 colors based on the folder status. In addition, if it is a number
2132 (e.g. 1), highlighting will be done based on both the message numbers
2133 and the folder status.
2135 @item wl-folder-desktop-name
2136 @vindex wl-folder-desktop-name
2137 The initial setting is @samp{Desktop}.
2138 The name of top folder group.
2140 @item wl-folder-petname-alist
2141 @vindex wl-folder-petname-alist
2142 The initial setting is @code{nil}.
2143 An alist of folder's realname and its nickname.
2145 @item wl-folder-access-subscribe-alist
2146 @vindex wl-folder-access-subscribe-alist
2147 The initial setting is @code{nil}.
2149 Control automatic subscribing and unsubscribing of the children list
2155 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2159 If @var{subscribe-flag} is non-nil, folders which have name matched to
2160 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2161 already unsubscribed folder is not displayed even when the
2162 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2169 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2170 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2171 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2172 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2176 @item wl-folder-hierarchy-access-folders
2177 @vindex wl-folder-hierarchy-access-folders
2178 A list of regular expressions for access groups which creates children
2179 folder list hierarchically.
2181 For example, if you specify
2182 @code{wl-folder-hierarchy-access-folders} like following,
2186 (setq wl-folder-hierarchy-access-folders
2187 '("^-[^\\.]*$" "^-comp.unix$" "^-comp.unix.bsd$"))
2192 you obtain the access group hierarchy as follows.
2198 -fj.comp.announce:0/0/2
2199 -fj.comp.dev.cdrom:0/0/0
2201 [+]-japan:238/238/1688
2204 -comp.unix.admin:0/0/0
2205 -comp.unix.dos-under-unix:0/0/0
2206 -comp.unix.programmer:0/0/0
2207 [-]-comp.unix.bsd:0/0/23
2208 -comp.unix.bsd.freebsd.announce:0/0/0
2213 If you opened @samp{-} in this example, only the direct children is created
2214 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2215 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2216 is not created until the children access group is opened.
2220 @node Folder Manager, , Selecting Folder, Folder
2221 @section Editing Folders
2222 @cindex Folder Manager
2223 @cindex Folder, Edit
2224 @cindex Folder, Subscribe
2225 @cindex Folder, Unsubscribe
2227 As described before, subscribed folder list is saved in @file{~/.folders} file.
2228 But you don't have to edit @file{~/.folders} directly.
2229 You can append, delete, edit folders from folder mode.
2231 @subsection Usage (Tips)
2233 @subsubsection Append Folder
2235 @kbd{m a} appends new folder to your folder list. If you enter non-existent
2236 folder, it will ask you to create a new one.
2237 @kbd{m g} appends new folder group.
2238 To append new folder to this group, firstly open it,
2239 then execute append command in the next line.
2241 @subsubsection Edit Folder
2243 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2244 Thus, you can change folder position as if you were editing a normal file.
2246 @subsubsection Create Multi Folder.
2250 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2252 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2254 Type @kbd{m m}, then you can create multi folder.
2257 @subsubsection Delete Nickname, Filter
2259 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2260 minibuffer while appending.
2262 @subsubsection Append Folder to Empty Group
2264 To append new folder to the empty folder group
2265 (after you create folder group by typing @kbd{m g}),
2266 firstly open it, then execute append command in the next line.
2267 If it is closed, folder is appended on the same level with
2268 the folder group above. It is difficult to explain by words so try it.
2269 In other words, appended position depends on the
2270 open/close status of the upper one.
2272 @subsubsection Charset of the Folders File.
2274 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2276 @subsubsection Create Filter
2278 @kbd{m f} adds filter to the folder at the current cursor point. To
2279 create new filter folder and leave the current folder unchanged, copy it
2280 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2281 filter can be specified while appending filter. If you put
2282 ``''(@var{NULL}), filter is deleted.
2284 @subsubsection Sort Folders
2286 Sorting of the folders is executed by the function specified by
2287 @code{wl-fldmgr-sort-function}.
2288 The initial setting is @code{wl-fldmgr-sort-standard},
2289 which sorts alphabetically.
2290 Sorting affects only on the current folder group. It does not
2291 affect on the child groups.
2293 @subsubsection Hiding Folders in the Access Group
2295 Usually, access group displays all children folders, but you can set
2296 some folders hidden. Following operations are only available on access
2299 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2300 (subscribe/unsubscribe) of the folder at current cursor point. Against
2301 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2304 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2305 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2306 argument and if the argument has positive number, the unsubscribe it.
2307 If the prefix argument has negative value, folder becomes visible and if
2308 zero, folder visibility is toggled.
2310 The other commands, @code{wl-fldmgr-subscribe} and
2311 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2314 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2315 executed in the access group, they have a same effect with
2316 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2317 The difference is that cut commands deletes folders from the current
2320 @subsubsection Operations in the Access Group
2322 You can insert and delete folders in the access group like usual folder
2323 group. But insert and delete commands can be only available for the
2324 children folders of the access group and they only sets the subscribe
2325 status. In other words, insertion of the folder means subscribing,
2326 deletion means unsubscribing.
2327 @footnote{In the current implementation,
2328 it is faster to delete region than to unsubscribe region.}
2330 To update the access group when children folders are inserted or deleted
2331 by other way (other than Wanderlust),
2332 open the access group by typing @kbd{C-u @key{RET}}.
2333 @xref{Selecting Folder}.
2335 The order of children folders of access group is saved after
2336 insertion/deletion/sorting.
2337 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2338 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2339 newly created folders are inserted on the top of the access group.
2341 @subsection Key bindings
2342 @cindex Keybind, Folder Mode
2343 @cindex Keybind, Folder Buffer
2345 Key bindings on the folder mode related to folder editing are shown below.
2346 All bindings starts with @kbd{m}, and primary commands are binded to
2347 one stroke key binding.
2351 @kindex m a (Folder)
2352 @findex wl-fldmgr-add
2353 Add specified folder to your folder list . If you enter non-existent
2354 folder, create it after confirmation.
2355 (@code{wl-fldmgr-add})
2360 @kindex m g (Folder)
2361 @findex wl-fldmgr-make-group
2362 Create a folder group.
2363 (@code{wl-fldmgr-make-group})
2366 @kindex m A (Folder)
2367 @findex wl-fldmgr-make-access-group
2368 Create an access group.
2369 (@code{wl-fldmgr-make-access-group})
2372 @kindex m d (Folder)
2373 @findex wl-fldmgr-delete
2374 Delete folder itself and msgdb.
2375 If the folder itself cannot be deleted like NNTP folder,
2376 only msgdb is deleted.
2377 (@code{wl-fldmgr-delete})
2382 @kindex m R (Folder)
2383 @findex wl-fldmgr-rename
2384 Change the name of folder or folder group.
2385 msgdb's path is also changed.
2386 (@code{wl-fldmgr-rename})
2392 @findex wl-fldmgr-make-multi
2393 Create a multi folders in the cutlist (cut, copied folders).
2394 (@code{wl-fldmgr-make-multi})
2399 @kindex m f (Folder)
2400 @findex wl-fldmgr-make-filter
2401 Create a filter folder. (Put a filter on the folder).
2402 (@code{wl-fldmgr-make-filter})
2406 @kindex M-c (Folder)
2407 @kindex m c (Folder)
2408 @findex wl-fldmgr-copy
2409 Copy folder (it is not available on folder group).
2410 (@code{wl-fldmgr-copy})
2414 @kindex M-w (Folder)
2415 @kindex m W (Folder)
2416 @findex wl-fldmgr-copy-region
2417 Copy folders in the specified region.
2418 (@code{wl-fldmgr-copy-region})
2422 @kindex C-k (Folder)
2423 @kindex m k (Folder)
2424 @findex wl-fldmgr-cut
2425 Cut folder. Folder itself is not deleted.
2426 (@code{wl-fldmgr-cut})
2430 @kindex C-w (Folder)
2431 @kindex m C-w (Folder)
2432 @findex wl-fldmgr-cut-region
2433 Cut folders in the specified region.
2434 (@code{wl-fldmgr-cut-region})
2438 @kindex C-y (Folder)
2439 @kindex m y (Folder)
2440 @findex wl-fldmgr-yank
2441 Paste folders that are copied or cut (folders in the cut-list).
2442 (@code{wl-fldmgr-yank})
2445 @kindex m p (Folder)
2446 @findex wl-fldmgr-set-petname
2447 Put nickname on the folder.
2448 (@code{wl-fldmgr-set-petname})
2451 @kindex m q (Folder)
2452 @findex wl-fldmgr-clear-cut-entity-list
2453 Clear the cut-list. (cut, copied folder information is cleared,
2454 you cannot paste after this)
2455 (@code{wl-fldmgr-clear-cut-entity-list})
2458 @kindex m s (Folder)
2459 @findex wl-fldmgr-sort
2460 Sort folders in the current folder group.
2461 (@code{wl-fldmgr-sort})
2464 @kindex m C-s (Folder)
2465 @findex wl-fldmgr-save
2466 Save current folder view to the @file{wl-folders-file}.
2467 (@code{wl-fldmgr-save})
2470 [Following commands are only available on the access groups]
2476 @kindex m u (Folder)
2477 @findex wl-fldmgr-unsubscribe
2478 Set the visibility of folder (subscribe/unsubscribe).
2479 (@code{wl-fldmgr-unsubscribe})
2484 @kindex r u (Folder)
2485 @findex wl-fldmgr-unsubscribe-region
2486 Set the visibility of the folders (subscribe/unsubscribe) in the
2488 (@code{wl-fldmgr-unsubscribe-region})
2493 @kindex m l (Folder)
2494 @findex wl-fldmgr-access-display-normal
2495 List folders that are currently available.
2496 (@code{wl-fldmgr-access-display-normal})
2501 @kindex m L (Folder)
2502 @findex wl-fldmgr-access-display-all
2503 List all folders regardless of the subscription status.
2504 (@code{wl-fldmgr-access-display-all})
2508 @subsection Customize variables
2511 @item wl-interactive-save-folders
2512 @vindex wl-interactive-save-folders
2513 The initial setting is @code{t}. If non-nil and folder view is
2514 modified, confirm saving it before Wanderlust or Emacs exits. If
2515 @code{nil}, save without confirmation.
2517 @item wl-fldmgr-make-backup
2518 @vindex wl-fldmgr-make-backup
2519 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2520 created before saving the folder status.
2522 @item wl-fldmgr-sort-function
2523 @vindex wl-fldmgr-sort-function
2524 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2525 sort folders. By default function, folders are sorted alphabetically
2526 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2529 @item wl-fldmgr-sort-group-first
2530 @vindex wl-fldmgr-sort-group-first
2531 The initial setting is @code{t}. If non-nil,
2532 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2533 does not care whether it is folder group or not.
2535 @item wl-folder-check-async
2536 @vindex wl-folder-check-async
2537 The initial setting is @code{t}. If non-nil, check folder's unread
2538 status asynchronously. It boosts newsgroup checking.
2540 @item wl-folder-check-fast
2541 @vindex wl-folder-check-fast
2542 The initial setting is @code{nil}.
2543 If non-nil, it does not update folder status while checking.
2545 @item wl-folder-notify-deleted
2546 @vindex wl-folder-notify-deleted
2547 The initial setting is @code{nil}.
2549 If non-nil, negative value is displayed when the message is deleted. If
2550 @code{sync}, folder is synchronized when the message is deleted. If
2551 @code{nil}, message deletion is ignored.
2553 @item wl-fldmgr-add-complete-with-current-folder-list
2554 @vindex wl-fldmgr-add-complete-with-current-folder-list
2555 The initial setting is @code{nil}.
2556 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2557 candidate for @code{wl-fldmgr-add}.
2560 @subsection Miscellanea
2562 Following is a note for folder editing.
2566 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2567 paste(yank) command pastes the folders on one cut or copy command
2568 (If copy command is executed by region, folders in the region are pasted
2569 by one paste command)
2572 You cannot cut @samp{Desktop} group.
2573 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2576 You cannot copy folder group.
2579 Operations on the access group are only available for the folders
2580 in the same access group.
2583 You cannot create a folder which has same name with the folders already exist.
2586 You cannot insert folders which have same name in one group.
2587 You can insert them in the different groups.
2588 You cannot put same nickname to the different folders.
2592 @node Summary, Message, Folder, Top
2593 @chapter Summary Mode
2595 After you select the folder via folder mode, you enter to the summary
2599 * Usage of Summary Mode:: TIPS
2600 * Thread Operations:: Thread operations
2601 * Cache:: File cache, Buffer cache, and Prefetch
2602 * Auto Refile:: Auto refile settings
2603 * Sticky Summary:: Summary make sticky
2604 * Summary View:: Format of summary lines
2605 * Mark and Action:: Temporary marks and their effect
2606 * Key Bindings of Summary:: Key bindings
2607 * Variables of Summary:: Customize Summary Mode
2611 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2612 @section Usage (Tips)
2614 @subsection Summary Content
2616 In the summary mode, messages are displayed like following.
2620 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2621 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2622 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2623 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2630 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2634 If you want to know how to change the format for this, please refer
2635 the section format of Summary lines.
2636 @xref{Summary View}.
2638 @var{Message number} is the message's unique number in the folder. In
2639 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2640 in the MH folder, it is the filename of the message.
2642 @var{Temporal mark} and @var{Persistent mark} are described later.
2644 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2645 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2646 Japanese, but if you want to display it in English, set the value of
2647 @code{wl-summary-weekday-name-lang} as @samp{en}.
2649 @var{Sender}'s indentation corresponds to the depth of the thread.
2650 Sender name is displayed as nickname if it is defined in the address
2651 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2652 displaying with nickname.
2654 If number is printed at the head of @var{Sender} part like @samp{+2},
2655 that means the message have 2 follow messages.
2657 @var{Subject} is the @samp{Subject:} header field of the message. If
2658 the message have same @samp{Subject:} with the parent message, it is not
2659 displayed. Some mailing list puts its sequence number in the
2660 @samp{Subject:} field, but it is
2661 ignored. @code{wl-summary-no-subject-message} is displayed when the
2662 message has empty subject field.
2664 @subsection Temporary Marks
2665 @cindex Mark, Temporary
2667 There are seven temporary marks,
2668 @samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}.
2669 Temporary marks indicates message operations.
2674 You can execute a command on the all messages that have @samp{*} mark,
2675 with the key bindings which begins with @kbd{m}.
2678 The mark to dispose. You can put @samp{d} by typing @kbd{d} key.
2681 The mark to force delete. You can put @samp{D} by typing @kbd{D} key.
2685 After you type @kbd{o} key, prompt appears to input refile destination.
2686 Your answer is printed in the summary line.
2690 You can put this mark by typing @kbd{O} key.
2691 The difference between this mark and refile mark is,
2692 this mark does not delete the message while latter does.
2695 The mark to prefetch reserved.
2696 You can put this mark by typing @kbd{i} key.
2699 The mark to resend reserved.
2700 After you type @kbd{~} key, prompt appears to input address to resend.
2701 Your answer is printed in the summary line.
2704 @kbd{x} key executes action for temporary marks, respectively.
2706 @subsection Persistent Marks
2708 There are ten persistent marks, @samp{!}, @samp{N}, @samp{n}, @samp{U},
2709 @samp{u}, @samp{A}, @samp{a}, @samp{F}, @samp{f} and @samp{$}.
2711 The persistent mark indicates the message's status and it is saved.
2712 Each persistent mark indicates:
2718 It is new message. It differs from @samp{N} that message with @samp{n}
2721 It is unread message.
2723 It is unread message. It differs from @samp{U} that message with @samp{u}
2726 It is message already read. It differs from message without mark that
2727 message with @samp{!} is not cached yet.
2729 It is already replied message.
2731 It is already replied message. It differs from @samp{A} that message
2732 with @samp{a} is already cached.
2734 It is already forwarded message.
2736 It is already forwarded message. It differs from @samp{F} that message
2737 with @samp{f} is already cached.
2739 It is a message with some global flag. It is convenient to put this
2740 mark on the messages to remember (If you want to remember to write a
2741 reply for the message, for example) because this mark remains after
2742 you exited Emacs. Messages with the @samp{$} mark can be reviewed in
2743 the @samp{'flag} folder even the message itself is deleted in the actual
2744 folder. You can put global flag by typing @kbd{$} or @kbd{F} key.
2747 If the message is read and cached (or local message),there are no
2751 @samp{N}, @samp{U}, @samp{!}, @samp{A}, @samp{F} indicates that the
2752 message have no cache. Messages with the marks other than these, you
2753 can read them in the offline status even they are in the IMAP folder or
2756 Among messages with persistent marks, ones with marks specified by
2757 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2758 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2760 @subsection How To Read
2762 Basically, you can read messages only typing space key again and again.
2764 To update summary status to the newest status (synchronize),
2767 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2768 moves cursor to the next message.
2769 Enter message buffer by typing @kbd{j} key.
2770 To operate multipart, you have to enter to the message buffer.
2773 @subsection Pack the Message Numbers
2774 You can pack the message numbers in Summary by
2775 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2776 News Spool Folder and Maildir Folder are supported folder types.
2779 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2780 @section Thread Operations
2782 For example, the following line indicates one thread (a context of a topic).
2785 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2789 If you type @kbd{/} on this line, the thread is opened and it changes
2790 the appearance like following.
2794 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2795 388 09/17(Thu)22:34 +-[ Murata san ]
2799 (Message 388 is the replied message to the message 384.)
2800 If you type @kbd{/} key once again, the thread is closed.
2801 With prefix argument, @kbd{/} opens all children threads.
2803 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2806 Commands with the key binding that begins with @kbd{t} executes commands
2807 on the messages in the thread.
2808 @xref{Key Bindings of Summary}.
2810 @subsection reconstruct thread by hand
2812 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2813 (@code{wl-summary-save-current-message}) at the corresponding message,
2814 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2815 message then you have the reconstructed thread.
2818 @node Cache, Auto Refile, Thread Operations, Summary
2821 @subsection Cache File
2823 The messages which have to access via network (e.x. IMAP, NNTP folder)
2824 are cached as a local file so as to save network traffic or to enable
2825 off-line operation. The cache file is saved under the directory
2826 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2827 elmo-cache-expire-by-size}. The command deletes cache files to the
2828 specified size by the order of last accessed time.
2830 @subsection Buffer Cache and Prefetching
2832 The messages that are read are kept in the cache buffer so as to make
2833 the behavior fast when you are to read the message again. It is called
2834 `buffer cache'. The number of cache buffer is specified by
2835 @code{wl-message-buffer-cache-size}.
2837 There are message prefetching mechanism in the Wanderlust that
2838 prefetches next message while you are reading.
2840 You can control the message prefetching mechanism by these two
2844 @item wl-message-buffer-prefetch-folder-type-list
2845 @vindex wl-message-buffer-prefetch-folder-type-list
2846 The initial setting is @code{'(imap4 nntp)}. If it is a list of folder
2847 types, it specifies the folder types in which message prefetching is
2848 enabled. In initial setting, messages are prefetch only in the nntp and
2849 imap4 folders. In this case, multi folder that contains localdir and
2850 imap4 prefetches only imap4 messages. This variable precedes the value of
2851 @code{wl-message-buffer-prefetch-folder-list}.
2852 To prefetch messages in all folder types, specify @code{t}.
2854 @item wl-message-buffer-prefetch-folder-list
2855 @vindex wl-message-buffer-prefetch-folder-list
2856 The initial setting is @code{nil}.
2857 A list of regexp of folders to enable message prefetching.
2859 @item wl-message-buffer-prefetch-depth
2860 @vindex wl-message-buffer-prefetch-depth
2861 The initial setting is 1. The number of messages for automatical prefetch.
2863 @item wl-message-buffer-prefetch-idle-time
2864 @vindex wl-message-buffer-prefetch-idle-time
2865 The initial setting is 1 (in seconds). The period of automatical prefetch.
2867 @item wl-message-buffer-prefetch-threshold
2868 @vindex wl-message-buffer-prefetch-threshold
2869 The initial setting is 30000 (bytes). If prefetching message has larger
2870 size than this value, Wanderlust does not prefetch automatically.
2871 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2872 the message is not checked for the size.
2874 @item wl-auto-prefetch-first
2875 @vindex wl-auto-prefetch-first
2876 The initial setting is @code{nil}.
2877 If non-nil, first message is automatically prefetched to the buffer
2878 when you enter the folder.
2882 @node Auto Refile, Sticky Summary, Cache, Summary
2883 @section Auto Refile
2884 @vindex elmo-msgdb-extra-fields
2885 @vindex wl-refile-rule-alist
2886 @findex wl-summary-auto-refile
2888 You can refile messages automatically, by typing @kbd{C-o}
2889 (@code{wl-summary-auto-refile}). It decides destination of refile by
2890 the content of the message header information (information in the msgdb).
2892 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2893 available. If you want to decide destination by other header fields,
2894 set the variable @code{elmo-msgdb-extra-fields} like following.
2898 (setq elmo-msgdb-extra-fields
2908 By this setting, Wanderlust saves extra fields in the msgdb. You have
2909 to type @kbd{s all} to get extra fields for the messages that are
2910 already exists in the summary.
2912 Then, specify the refile rule. The refile target folder of auto
2913 refiling is decided by the value of @code{wl-refile-rule-alist}.
2914 @code{wl-refile-rule-alist} is a list of a rule:
2918 (@var{field} (@var{regexp} . @var{target})
2919 (@var{regexp} . @var{target})
2924 Each rule means `if @var{field} value matches @var{regexp},
2925 then refile to @var{target} folder'.
2926 The rule matched first is applied.
2928 @var{field} is a string of field name. You can specify a list of field name
2929 string, too. In this case, if one of these fields is matched, then the
2930 rule is fired (i.e. OR condition).
2932 @var{regexp} is a regular expression for field value. @var{target} is a target
2933 folder string. You can specify a rule at @var{target} part, too. In this
2934 case, If the field value of the rule and the current rule is matched,
2935 then the current rule is fired (i.e. AND condition).
2937 You can refer matched substring of @var{regexp} to specify @var{target} part.
2938 To refer substring, use following keys:
2942 means substitute original matched text.
2945 means substitute what matched the @var{N}th `\(@dots{}\)'.
2946 (@var{N} is a number.)
2949 Following is an example of @code{wl-refile-rule-alist}.
2953 (setq wl-refile-rule-alist
2955 ("^Wanderlust" . "+wl")
2956 ("^Elisp" . "+elisp"))
2958 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2960 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2961 "+from-me-to-you"))))))
2965 After these settings, refile marks are automatically put on the condition
2966 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2968 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2970 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2971 with these persistent marks are not automatically refiled.
2972 It means Wanderlust does not execute auto refile on unread messages by
2973 the default setting.
2974 To execute auto refile on all messages, set following.
2977 (setq wl-summary-auto-refile-skip-marks nil)
2981 @node Sticky Summary, Summary View, Auto Refile, Summary
2982 @section Sticky Summary
2983 @cindex Summary, Sticky
2984 @cindex Sticky Summary
2986 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2988 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2989 @kbd{G} in some suummary sticky summary buffer is created.
2990 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2991 makes current one sticky.
2993 The buffer name of the sticky summary becomes like
2994 @samp{Summary:@var{folder-name}}.
2995 You can visit the sticky summary at any time by @kbd{C-x b}
2996 (@code{switch-to-buffer}), or you can go round summary buffers by
2997 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2998 (@code{wl-summary-next-buffer}) in summary mode.
3000 In sticky summary, the summary buffer is preserved after @kbd{g} or
3001 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
3002 another summary by @kbd{C-u g}. Other operations in the sticky summary
3003 are same as normal summary.
3005 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3006 are automatically stuck.
3009 @node Summary View, Mark and Action, Sticky Summary, Summary
3010 @section Format of summary lines
3011 @cindex Format of summary lines
3012 You can alter the format of lines in Summary mode.
3014 Summary line format is specified by @code{wl-summary-line-format}.
3015 You can use control strings defined by
3016 @code{wl-summary-line-format-spec-alist}.
3022 ;; @r{number temporary-mark persistent-mark date branch}
3023 ;; @r{[ (number-of-children) sender ] subject}
3024 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
3028 Where the number set the column number of the field. If negative value,
3029 the column is filled from right. If the number begins with @samp{0},
3030 @samp{0} is used for filling columns instead of @samp{ }.
3042 Major control strings defined by @code{wl-summary-line-format-spec-alist}
3043 are displayed in the following list.
3056 %t branch of the thread
3057 %[ [ (< for re-connected child)
3058 %] ] (> for re-connected child)
3062 %c +number-of-children: (display only for opened thread)
3063 %C [+number-of-children] (display only for opened thread)
3064 %# mailing list information (`(' ML-name [ ` ' ML-number ] `)')
3065 %l number in the mailing list
3066 %@@ `@@' only if the first MIME part is multipart/mixed
3067 %~ ` ' only if previous column is empty
3071 The temporary mark (@samp{%T}) and persistent mark (@samp{%P}) must
3072 appear at the constant column. For example, if you specify @samp{%T} or
3073 @samp{%P} after the @samp{%t}, which changes its length by thread
3074 position, marks are not treated correctly.
3076 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
3077 column of the enclosed region is justified to the `number'. Multiple
3078 level @samp{%number(} parenthesis can be defined. It is useful to
3079 justify the column of the multiple control strings. For example, in the
3080 above @code{wl-summary-line-format},
3086 means ``Adjust number-of-children and sender string to the 17 column''.
3088 You can specify the format by each folders with
3089 @code{wl-folder-summary-line-format-alist}. Please set regular
3090 expression for folder names and summary line format as the following
3095 (setq wl-folder-summary-line-format-alist
3096 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
3097 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
3101 @subsection on the format for sender name
3103 The format string @samp{%f} displays the return value of the function specified
3104 by @code{wl-summary-from-function}. If you use the function
3105 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
3106 while displays the recipient names if the folder name matches with
3107 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
3108 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
3110 For example, to display recipient names for the message in @samp{+backup} if
3111 its sender is yourself, set up as follows.
3114 (setq wl-summary-showto-folder-regexp "^\\+backup$")
3118 @node Mark and Action, Key Bindings of Summary, Summary View, Summary
3119 @section Temporary marks and their effect
3120 @cindex Mark and Action
3122 You can define temporary marks and corresponding procedure by
3123 @code{wl-summary-mark-action-list}. Initially, refile (@samp{o}), copy
3124 (@samp{O}), dispose (@samp{d}), delete (@samp{D}), prefetch (@samp{i})
3125 and resend (@samp{~}) are defined.
3127 Each element of @code{wl-summary-mark-action-list} consists of
3130 (@samp{MARK} @samp{SYMBOL}
3131 @samp{ARGUMENT-FUNCTION} @samp{SET-MARK-FUNCTION} @samp{EXEC-FUNCTION}
3132 @samp{FACE} @samp{DOC-STRING})
3135 @samp{MARK} is a temporary mark string, and @samp{SYMBOL} is the name of
3136 the action to be defined. @samp{ARGUMENT-FUNCTION} is a function to
3137 generate argument to be given to @samp{SET-MARK-FUNCTION}, which will be
3138 described next, and it takes arguments:
3141 (@samp{ACTION} @samp{NUMBER})
3144 Where @samp{ACTION} equals to @samp{SYMBOL}, and @samp{NUMBER} is message
3145 number. @samp{SET-MARK-FUNCTION} is a function to be called when the mark
3146 is put. It takes arguments:
3149 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3152 Where @samp{NUMBER} is target message number, @samp{MARK} is a temporary
3153 mark string, and @samp{DATA} is given by @samp{ARGUMENT-FUNCTION}.
3155 @samp{EXEC-FUNCTION} is a function to be called when the action is
3156 executed. Its argument is a list of @samp{MARK-INFO}. Here @samp{MARK-INFO}
3157 means a list consists of
3160 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3163 @samp{FACE} is a face to be used for highlighting.
3166 @node Key Bindings of Summary, Variables of Summary, Mark and Action, Summary
3167 @section Key bindings
3168 @cindex Keybind, Summary Mode
3169 @cindex Keybind, Summary Buffer
3171 Key bindings of the summary mode are shown below.
3175 @kindex @key{SPC} (Summary)
3176 @findex wl-summary-read
3177 Proceed reading a message at the current cursor point.
3178 (@code{wl-summary-read})
3182 @findex wl-summary-redisplay
3183 Redisplay a message at the current cursor point with default display
3184 type. If this command is called with prefix argument, reload and redisplay
3185 message regardless of the message cache.
3186 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u .},
3187 reload and redisplay message with current display type regardless of the
3188 message cache. (@code{wl-summary-redisplay})
3192 @findex wl-summary-display-top
3193 Display the top message in the folder.
3194 (@code{wl-summary-display-top})
3198 @findex wl-summary-display-bottom
3199 Display the bottom message in the folder.
3200 (@code{wl-summary-display-bottom})
3204 @kindex @key{BS} (Summary)
3205 @kindex @key{DEL} (Summary)
3206 Display the previous page of the message at the current cursor point.
3207 @findex wl-summary-prev-page
3208 (@code{wl-summary-prev-page})
3211 @kindex @key{RET} (Summary)
3212 @findex wl-summary-enter-handler
3213 Display the next line of the message at the current cursor point.
3214 Display the message at the current cursor point if it is not displayed
3215 yet. (@code{wl-summary-next-line-content}) If prefix argument is
3216 specified, message is scrolled up by one line.
3217 (@code{wl-summary-prev-line-content}) If prefix argument is numeric,
3218 cursor is jumped to the message with specified number.
3223 @kindex M-@key{RET} (Summary)
3224 @findex wl-summary-prev-line-content
3225 Display the previous line of the message at the current cursor point.
3226 Display the message at the current cursor point if it is not displayed yet.
3227 (@code{wl-summary-prev-line-content})
3231 @findex wl-thread-open-close
3232 Toggle open or close the thread at the current cursor point.
3233 With prefix argument, open all children threads.
3234 (@code{wl-thread-open-close})
3239 @findex wl-thread-open-all
3240 (@code{wl-thread-open-all})
3245 @findex wl-thread-close-all
3246 (@code{wl-thread-close-all})
3250 @findex wl-summary-goto-folder
3252 (@code{wl-summary-goto-folder})
3256 Mark all messages in the folder as read.
3257 @findex wl-summary-mark-as-read-all
3258 (@code{wl-summary-mark-as-read-all})
3262 @findex wl-summary-reply
3263 Prepare a draft for reply the message at the current cursor point.
3264 (@code{wl-summary-reply})
3268 @findex wl-summary-reply-with-citation
3269 Prepare a draft for reply the message at the current cursor point.
3270 (@code{wl-summary-reply-with-citation})
3274 @findex wl-summary-cancel-message
3275 If the message at current cursor point is your own netnews article,
3277 (@code{wl-summary-cancel-message})
3281 @findex wl-summary-reedit
3282 Prepare a draft for re-editing the message at current cursor point.
3283 If the message at current cursor point is your own netnews article,
3284 a draft for `supersedes message' for the message is prepared.
3285 (@code{wl-summary-reedit})
3288 @kindex M-E (Summary)
3289 @findex wl-summary-resend-bounced-mail
3290 If the message at current cursor point is a bounced message,
3291 a draft for re-sending original message is prepared.
3292 (@code{wl-summary-resend-bounced-mail})
3296 @findex wl-summary-forward
3297 A draft for forwarding the message at current cursor point is prepared.
3298 (@code{wl-summary-forward})
3302 @findex wl-summary-mark-as-important
3303 Put @samp{important} flag on the message at current cursor point.
3304 If already flagged as @samp{important}, remove the flag. If it is
3305 called with prefix argument, ask global flag to put similarly to @kbd{F}.
3306 (@code{wl-summary-mark-as-important})
3310 @findex wl-summary-set-flags
3311 Put arbitrary global flag entered in the minibuffer. If you use Emacs
3312 21 or later, you can specify multiple flags separated by @samp{,}
3313 simultaneously. If it is called with prefix argument, remove existent
3315 (@code{wl-summary-set-flags})
3321 Save the message at current cursor point.
3322 @findex wl-summary-save
3323 (@code{wl-summary-save})
3327 @findex wl-summary-next
3328 Move cursor to the next message.
3329 If message is marked with a temporal mark in
3330 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3331 In the offline mode, cursor is not moved to the messages which are not cached
3333 (@code{wl-summary-next})
3337 @findex wl-summary-prev
3338 Move cursor to the previous message.
3339 If message is marked with a temporal mark in
3340 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3341 In the offline mode, cursor is not moved to the messages which are not cached
3343 (@code{wl-summary-prev})
3347 @findex wl-summary-down
3348 Move cursor to the downward message which is unread or marked
3350 In the offline mode, cursor is not moved to the messages which are not cached
3352 If there are messages which have target mark @samp{*} in the summary,
3353 cursor is moved to the downward message which have a target mark.
3354 This behavior is changed according to the value of @code{wl-summary-move-order}.
3355 (@code{wl-summary-down})
3359 @findex wl-summary-up
3360 Move cursor to the upward message which is unread or marked
3362 In the offline mode, cursor is not moved to the messages which are not cached
3364 If there are messages which have target mark @samp{*} in the summary,
3365 cursor is moved to the downward message which have a target mark.
3366 This behavior is changed according to the value of @code{wl-summary-move-order}.
3367 (@code{wl-summary-up})
3371 @findex wl-summary-write
3372 Prepare a new draft.
3373 (@code{wl-summary-write})
3377 @findex wl-summary-write-current-folder
3378 Prepare a new draft. If the current folder is NNTP folder,
3379 @samp{Newsgroups:} field is completed. If the current folder is mailing
3380 list folder (refile destination), guess @samp{To:} field and completed
3381 (If @code{wl-subscribed-mailing-list} is valid list)
3382 (@code{wl-summary-write-current-folder})
3386 @findex wl-summary-toggle-all-header
3387 Toggle display type between all and partial header fields and redisplay
3388 the message at current cursor point. If this command is called with
3389 prefix argument, reload and redisplay message regardless of the message cache.
3390 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u H},
3391 set default display type of summary by current display type of header fields.
3392 (@code{wl-summary-toggle-all-header})
3396 @findex wl-summary-toggle-mime
3397 Toggle display type for MIME analysis and redisplay the message at
3398 current cursor point. A change is performed in the order set as
3399 @code{wl-summary-display-mime-mode-list}. If this command is called
3400 with numeric prefix argument, it switch directly as follows.
3404 1: Enable MIME analysis.
3405 2: Enable MIME analysis only for header fields.
3406 3: Disable MIME analysis.
3410 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u
3411 M}, set default display type of summary by current display type of MIME
3412 analysis. (@code{wl-summary-toggle-mime})
3415 @kindex C-c C-f (Summary)
3416 @findex wl-summary-toggle-header-narrowing
3417 Toggle header body narrowing of the message at current cursor point.
3418 (@code{wl-summary-toggle-header-narrowing})
3422 @findex wl-summary-burst
3423 If the message at current cursor point has
3424 encapsulates multiple messages using MIME,
3425 de-capsulate and extract them on the current folder.
3426 If it is invoked in non-writable folder or it is called with prefix
3427 argument, it asks the destination folder.
3428 (@code{wl-summary-burst})
3431 @kindex @@ (Summary)
3432 @findex wl-summary-edit-addresses
3433 Append/change/delete the message's sender information to the address
3434 book @file{~/.addresses} interactively. If this command is called with
3435 prefix argument, arbitrary address can be edited.
3436 (@code{wl-summary-edit-petname})
3440 @findex wl-status-update
3441 Sync up address book status with @file{~/.addresses}'s content.
3442 (@code{wl-status-update})
3446 @findex wl-summary-pipe-message
3447 Pipe current message's content to the external process.
3448 (@code{wl-summary-pipe-message})
3452 @findex wl-summary-print-message
3453 Print out current message's content.
3454 It uses @code{ps-print} module in Emacs 20.x.
3455 If you don't use color printer, you might want to set
3456 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3459 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3462 (@code{wl-summary-print-message})
3466 @findex wl-summary-exit
3467 Exit current folder.
3468 (@code{wl-summary-exit})
3472 @findex wl-summary-jump-to-current-message
3473 Jump cursor to the currently displayed message's window.
3474 (@code{wl-summary-jump-to-current-message})
3478 Jump cursor to the other message.
3479 @findex wl-summary-jump-to-msg
3480 (@code{wl-summary-jump-to-msg})
3484 Update summary status and
3485 prefetch all messages which have marks included in the
3486 @code{wl-summary-incorporate-marks}.
3487 @findex wl-summary-incorporate
3488 (@code{wl-summary-incorporate})
3491 @kindex M-j (Summary)
3492 @findex wl-summary-jump-to-msg-by-message-id
3493 Jump cursor to the message which have specified @samp{Message-Id:}. If
3494 @code{elmo-use-database} is non-nil, other folder is also searched.
3495 (@code{wl-summary-jump-to-msg-by-message-id})
3499 Jump to parent message.
3500 @findex wl-summary-jump-to-parent-message
3501 (@code{wl-summary-jump-to-parent-message})
3505 @findex wl-summary-mark-as-unread
3506 Mark as unread the message at current cursor point.
3507 (@code{wl-summary-mark-as-unread})
3511 @findex wl-summary-sync
3512 Synchronize summary view after prompting the update range.
3513 You can specify one of the follows.
3517 all Discard present msgdb and retrieve all informations.
3518 Do not retrieve killed messages.
3519 all-entirely Discard present msgdb and retrieve all informations.
3520 Retrieve killed messages, too.
3521 update Update the difference between informations in present
3522 msgdb and in current folder instance.
3523 Do not retrieve killed messages.
3524 update-entirely Update the difference between informations in present
3525 msgdb and in current folder instance.
3526 Retrieve killed messages, too.
3527 rescan Redisplay summary by rescanning present msgdb.
3528 rescan-noscore Redisplay summary by rescanning present msgdb.
3529 Display messages killed by score, too.
3530 rescan-thread Redisplay summary by rescanning present msgdb.
3531 Reconstruct thread, too.
3532 cache-status Sync the all marks with the real status of cache.
3535 first:NUM Move to the filter folder(partial filter).
3536 last:NUM Move to the filter folder(partial filter).
3541 (@code{wl-summary-sync})
3545 @findex wl-summary-sort
3547 You can sort by @samp{date}, @samp{from}, @samp{number}, @samp{subject},
3548 @samp{size} and @samp{list-info}.
3549 With prefix argument, sort summary lines into descending order.
3550 (@code{wl-summary-sort})
3554 @findex wl-summary-toggle-thread
3555 Toggle the threading. The state will be preserved after exiting
3556 Wanderlust. You can alter default state for newly created summary
3557 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3558 Threading status is displayed on the modeline.
3559 @samp{@{S@}} means threading is off (Sequence) and
3560 @samp{@{T@}} means threading is on (Thread).
3561 (@code{wl-summary-toggle-thread})
3565 @findex wl-summary-toggle-disp-folder
3566 Toggle displaying of folder window.
3567 (@code{wl-summary-toggle-disp-folder})
3571 Toggle displaying of message window.
3572 @findex wl-summary-toggle-disp-msg
3573 (@code{wl-summary-toggle-disp-msg})
3577 Move to the virtual folder (filter folder) with the condition specified.
3578 If called with prefix argument and current folder is virtual, exit it.
3579 @findex wl-summary-virtual
3580 (@code{wl-summary-virtual})
3583 @kindex @key{TAB} (Summary)
3584 @findex wl-summary-goto-last-displayed-msg
3585 Jump to the message which is displayed last.
3586 (@code{wl-summary-goto-last-displayed-msg})
3590 Put @samp{*} mark on the messages that satisfies the specified condition.
3591 If messages already have @samp{*} mark, new @samp{*} marks are overridden.
3592 If prefix argument is specified, current @samp{*} marks are removed and
3593 new @samp{*} marks are appended.
3595 @findex wl-summary-pick
3596 (@code{wl-summary-pick})
3600 @findex wl-summary-mark-as-read
3601 Mark as read the message at the current cursor point.
3602 (@code{wl-summary-mark-as-read})
3606 Execute action for all temporary marks in the summary buffer.
3607 @findex wl-summary-exec
3608 (@code{wl-summary-exec})
3612 @findex wl-summary-target-mark-line
3613 Put target mark on the message at the current cursor point.
3614 (@code{wl-summary-target-mark-line}) @xref{Mark and Action}.
3618 Put refile mark on the message at the current cursor point.
3619 @findex wl-summary-refile
3620 (@code{wl-summary-refile}) @xref{Mark and Action}.
3623 @kindex C-o (Summary)
3624 Execute auto refile.
3625 @findex wl-summary-auto-refile
3626 (@code{wl-summary-auto-refile})
3630 Put copy mark on the message at the current cursor point.
3631 @findex wl-summary-copy
3632 (@code{wl-summary-copy}) @xref{Mark and Action}.
3635 @kindex M-o (Summary)
3636 Put refile mark on the message at the current cursor point with the destination
3637 previously specified.
3638 @findex wl-summary-refile-prev-destination
3639 (@code{wl-summary-refile-prev-destination})
3643 @findex wl-summary-dispose
3644 Put disposal mark on the message at the current cursor point.
3645 The result of disposal is controlled by @code{wl-dispose-folder-alist},
3646 refiled to @code{wl-trash-folder} by default.
3647 (@code{wl-summary-dispose}) @xref{Mark and Action}.
3651 @findex wl-summary-delete
3652 Put force deletion mark on the message at the current cursor point.
3653 (@code{wl-summary-delete}) @xref{Mark and Action}.
3657 Put prefetch reservation mark on the message at the current cursor point.
3658 @findex wl-summary-prefetch
3659 (@code{wl-summary-prefetch}) @xref{Mark and Action}.
3663 @findex wl-summary-resend
3664 Put resend reservation mark on the message at the current cursor point.
3665 (@code{wl-summary-resend}) @xref{Mark and Action}.
3669 @findex wl-summary-unmark
3670 Unmark the temporal mark on the message at the current cursor point.
3671 (@code{wl-summary-unmark})
3675 Unmark all the temporal marks.
3676 @findex wl-summary-unmark-all
3677 (@code{wl-summary-unmark-all})
3680 @kindex r R (Summary)
3681 @findex wl-summary-mark-as-read-region
3682 Mark as read messages in the specified region.
3683 (@code{wl-summary-mark-as-read-region})
3686 @kindex r $ (Summary)
3687 @findex wl-summary-mark-as-important-region
3688 Put @samp{important} flag on messages in the specified region.
3689 If already flagged as @samp{important}, remove the flag.
3690 (@code{wl-summary-mark-as-important-region})
3693 @kindex r F (Summary)
3694 @findex wl-summary-set-flags-region
3695 Put arbitrary global flag entered in the minibuffer on messages in
3697 (@code{wl-summary-set-flags-region})
3700 @kindex r ! (Summary)
3701 @findex wl-summary-mark-as-unread-region
3702 Mark as unread messages in the specified region.
3703 (@code{wl-summary-mark-as-unread-region})
3706 @kindex r x (Summary)
3707 @findex wl-summary-exec-region
3708 Execute action for each temporary marks on the messages in the
3710 (@code{wl-summary-exec-region})
3713 @kindex r * (Summary)
3714 @findex wl-summary-target-mark-region
3715 Put target mark on the messages in the specified region.
3716 (@code{wl-summary-target-mark-region}) @xref{Mark and Action}.
3719 @kindex r o (Summary)
3720 @findex wl-summary-refile-region
3721 Put refile mark on the messages in the specified region.
3722 (@code{wl-summary-refile-region}) @xref{Mark and Action}.
3725 @kindex r O (Summary)
3726 @findex wl-summary-copy-region
3727 Put copy mark on the messages in the specified region.
3728 (@code{wl-summary-copy-region}) @xref{Mark and Action}.
3731 @kindex r d (Summary)
3732 @findex wl-summary-dispose-region
3733 Put disposal mark on the messages in the specified region.
3734 (@code{wl-summary-dispose-region}) @xref{Mark and Action}.
3737 @kindex r D (Summary)
3738 @findex wl-summary-delete-region
3739 Put force deletion mark on the messages in the specified region.
3740 (@code{wl-summary-delete-region}) @xref{Mark and Action}.
3743 @kindex r i (Summary)
3744 @findex wl-summary-prefetch-region
3745 Put prefetch reservation mark on messages in the specified region.
3746 (@code{wl-summary-prefetch-region}) @xref{Mark and Action}.
3749 @kindex r u (Summary)
3750 @findex wl-summary-unmark-region
3751 Delete temporal mark on the messages in the specified region.
3752 (@code{wl-summary-unmark-region})
3755 @kindex r y (Summary)
3756 Save messages in the specified region.
3757 @findex wl-summary-save-region
3758 (@code{wl-summary-save-region})
3761 @kindex t R (Summary)
3762 @findex wl-thread-mark-as-read
3763 Mark as read messages which are the descendant of the current thread.
3764 With prefix argument, it affects on the all messages in the thread tree.
3765 (@code{wl-thread-mark-as-read})
3768 @kindex t $ (Summary)
3769 @findex wl-thread-mark-as-important
3770 Put @samp{important} flag on the messages which are the descendant of
3771 the current thread. If already flagged as @samp{important}, remove the
3772 flag. With prefix argument, it affects on the all messages in the
3774 (@code{wl-thread-mark-as-important})
3777 @kindex t F (Summary)
3778 @findex wl-thread-set-flags
3779 Put arbitrary global flag entered in the minibuffer on the messages
3780 which are the descendant of the current thread. With prefix argument,
3781 it affects on the all messages in the thread tree.
3782 (@code{wl-thread-set-flags})
3785 @kindex t ! (Summary)
3786 @findex wl-thread-mark-as-unread
3787 Mark as unread messages which are the descendant of the current thread.
3788 With prefix argument, it affects on the all messages in the thread tree.
3789 (@code{wl-thread-mark-as-unread})
3792 @kindex t x (Summary)
3793 @findex wl-thread-exec
3794 Execute action for temporary marks on the messages which are
3795 the descendant of the current thread. With prefix argument, it affects
3796 on the all messages in the thread tree.
3797 (@code{wl-thread-exec})
3800 @kindex t * (Summary)
3801 @findex wl-thread-target-mark
3802 Put target mark @samp{*} on the messages which are the descendant of the
3803 current thread. With prefix argument, it affects on the all messages in
3805 (@code{wl-thread-target-mark}) @xref{Mark and Action}.
3808 @kindex t o (Summary)
3809 @findex wl-thread-refile
3810 Put refile mark on the messages which are the descendant of the current thread.
3811 With prefix argument, it affects on the all messages in the thread tree.
3812 (@code{wl-thread-refile}) @xref{Mark and Action}.
3815 @kindex t O (Summary)
3816 @findex wl-thread-copy
3817 Put copy mark on the messages which are the descendant of the current thread.
3818 With prefix argument, it affects on the all messages in the thread tree.
3819 (@code{wl-thread-copy}) @xref{Mark and Action}.
3822 @kindex t d (Summary)
3823 @findex wl-thread-dispose
3824 Put disposal mark on the messages which are the descendant of the current thread.
3825 With prefix argument, it affects on the all messages in the thread tree.
3826 (@code{wl-thread-dispose}) @xref{Mark and Action}.
3829 @kindex t D (Summary)
3830 @findex wl-thread-delete
3831 Put force deletion mark on the messages which are the descendant of the
3833 (@code{wl-thread-delete}) @xref{Mark and Action}.
3836 @kindex t i (Summary)
3837 @findex wl-thread-prefetch
3838 Put prefetch reservation mark on messages which are the descendant of
3840 (@code{wl-thread-prefetch}) @xref{Mark and Action}.
3843 @kindex t u (Summary)
3844 @findex wl-thread-unmark
3845 Unmark temporal mark on the messages which are the descendant of the
3846 current thread. With prefix argument, it affects on the all messages in
3848 (@code{wl-thread-unmark})
3851 @kindex t y (Summary)
3852 @findex wl-thread-save
3853 Save messages which are the descendant of the current thread.
3854 With prefix argument, it affects on the all messages in the thread tree.
3855 (@code{wl-thread-save})
3858 @kindex m R (Summary)
3859 @findex wl-summary-target-mark-mark-as-read
3860 Mark as read all messages which have target mark @samp{*}.
3861 (@code{wl-summary-target-mark-mark-as-read})
3864 @kindex m $ (Summary)
3865 @findex wl-summary-target-mark-mark-as-important
3866 Put @samp{important} flag on all messages which have target mark @samp{*}.
3867 If already flagged as @samp{important}, remove the flag.
3868 (@code{wl-summary-target-mark-mark-as-important})
3871 @kindex m F (Summary)
3872 @findex wl-summary-target-mark-set-flags
3873 Put arbitrary global flag entered in the minibuffer on all messages
3874 which have target mark @samp{*}.
3875 (@code{wl-summary-target-mark-set-flags})
3878 @kindex m ! (Summary)
3879 @findex wl-summary-target-mark-mark-as-unread
3880 Mark as unread all messages which have target mark @samp{*}.
3881 (@code{wl-summary-target-mark-mark-as-unread})
3884 @kindex m o (Summary)
3885 @findex wl-summary-target-mark-refile
3886 Put refile mark on the messages which have target mark @samp{*}.
3887 (@code{wl-summary-target-mark-refile}) @xref{Mark and Action}.
3890 @kindex m O (Summary)
3891 @findex wl-summary-target-mark-copy
3892 Put copy mark on the messages which have target mark @samp{*}.
3893 (@code{wl-summary-target-mark-copy}) @xref{Mark and Action}.
3896 @kindex m d (Summary)
3897 @findex wl-summary-target-mark-dispose
3898 Put disposal mark on the messages which have target mark @samp{*}.
3899 (@code{wl-summary-target-mark-dispose}) @xref{Mark and Action}.
3902 @kindex m D (Summary)
3903 @findex wl-summary-target-mark-delete
3904 Put force deletion mark on the messages which have target mark @samp{*}.
3905 (@code{wl-summary-target-mark-delete}) @xref{Mark and Action}.
3908 @kindex m i (Summary)
3909 @findex wl-summary-target-mark-prefetch
3910 Put prefetch reservation mark on messages which have target mark @samp{*}.
3911 (@code{wl-summary-target-mark-prefetch}) @xref{Mark and Action}.
3914 @kindex m y (Summary)
3915 @findex wl-summary-target-mark-save
3916 Save messages which have target mark @samp{*}.
3917 (@code{wl-summary-target-mark-save})
3920 @kindex m u (Summary)
3921 Unmark all temporal marks.
3922 (@code{wl-summary-delete-all-temp-marks})
3923 @findex wl-summary-delete-all-temp-marks
3926 @kindex m a (Summary)
3927 Put target mark @samp{*} on the all messages.
3928 (@code{wl-summary-target-mark-all})
3929 @findex wl-summary-target-mark-all
3932 @kindex m t (Summary)
3933 Put target mark @samp{*} on the messages in the current thread.
3934 @findex wl-summary-target-mark-thread
3935 (@code{wl-summary-target-mark-thread})
3938 @kindex m r (Summary)
3939 @findex wl-summary-target-mark-region
3940 Put target mark @samp{*} on the messages in the specified region.
3941 (@code{wl-summary-target-mark-region})
3944 @kindex m A (Summary)
3945 @findex wl-summary-target-mark-reply-with-citation
3946 Prepare a draft which cites all messages which have target mark @samp{*}.
3947 (@code{wl-summary-target-mark-reply-with-citation})
3950 @kindex m f (Summary)
3951 @findex wl-summary-target-mark-forward
3952 Prepare a draft which forwards all messages which have target mark @samp{*}.
3953 (@code{wl-summary-target-mark-forward})
3956 @kindex m U (Summary)
3957 @findex wl-summary-target-mark-uudecode
3958 Uudecode the messages which have target mark @samp{*}.
3959 (@code{wl-summary-target-mark-uudecode})
3962 @kindex m ? (Summary)
3963 @findex wl-summary-target-mark-pick
3964 Pick messages from the @samp{*} marked messages.
3965 That is, @samp{*} marks on the messages are remained
3966 if the specified condition is satisfied.
3967 (@code{wl-summary-target-mark-pick})
3970 @kindex m # (Summary)
3971 @findex wl-summary-target-mark-print
3972 Print out all messages which have target mark @samp{*}.
3973 (@code{wl-summary-target-mark-print})
3976 @kindex m | (Summary)
3977 @findex wl-summary-target-mark-pipe
3978 Pipe content of each message with target mark @samp{*} to some specified
3980 (@code{wl-summary-target-mark-pipe})
3983 @kindex M-t (Summary)
3984 @findex wl-toggle-plugged
3985 Toggle offline/online status of Wanderlust.
3986 (@code{wl-toggle-plugged})
3989 @kindex C-t (Summary)
3990 Start Wanderlust's plug-status manager.
3991 (@code{wl-plugged-change})
3994 @kindex C-c C-o (Summary)
3995 @findex wl-jump-to-draft-buffer
3996 Move to the draft buffer if available. If multiple draft buffer exists,
3997 moved to one after another. If prefix argument is specified, load draft
3998 folder's message to the draft buffer and jump to it.
3999 (@code{wl-jump-to-draft-buffer})
4002 @kindex M-w (Summary)
4003 @findex wl-summary-save-current-message
4004 Save the message at the current cursor point.
4005 (@code{wl-summary-save-current-message})
4008 @kindex C-y (Summary)
4009 @findex wl-summary-yank-saved-message
4010 Regard the message at the current cursor point as
4011 parent, connect the message saved by
4012 @code{wl-summary-save-current-message}
4014 (@code{wl-summary-yank-saved-message})
4017 @kindex C-x C-s (Summary)
4018 @findex wl-summary-save-status
4019 Save the current summary.
4020 (@code{wl-summary-save-status})
4024 @node Variables of Summary, , Key Bindings of Summary, Summary
4025 @section Customiziable variables
4028 @item wl-summary-move-order
4029 @vindex wl-summary-move-order
4030 The initial setting is @code{unread}. Specify cursor moving policy. If
4031 you want to precede new messages, set @code{new}. If you want to
4032 precede unread messages, set @code{unread}. If @code{nil}, proceed to
4035 @item wl-auto-select-first
4036 @vindex wl-auto-select-first
4037 The initial setting is @code{nil}.
4038 If non-nil, first message is automatically displayed when you enter
4041 @item wl-auto-select-next
4042 @vindex wl-auto-select-next
4043 The initial setting is @code{nil}. This controls behavior when there is
4044 no unread message in current summary.
4047 nil: asks whether you want to go back to folder mode
4048 'unread: asks whether you want to go to next unread folder
4049 If the next one comes to be possessing no unread message
4050 by treatment of cross-posted messages or Scoring, then
4051 asks whether you want to go to next to next folder.
4052 'skip-no-unread: similar as unread
4053 But does not ask before going to next to next folder.
4054 otherwise: asks whether you want to go to next unread folder
4057 It might be useful to set @code{'skip-no-unread} for people who
4058 want to continue reading by just pressing and pressing space key.
4060 @item wl-thread-insert-opened
4061 @vindex wl-thread-insert-opened
4062 The initial setting is @code{nil}.
4063 If non-nil, thread is inserted as opened.
4065 @item wl-thread-open-reading-thread
4066 @vindex wl-thread-open-reading-thread
4067 The initial setting is @code{t}. If non-nil, reading thread is
4068 automatically opened though it is closed thread.
4070 @item wl-summary-exit-next-move
4071 @vindex wl-summary-exit-next-move
4072 The initial setting is @code{t}. If non-nil, move to next folder at
4075 @item wl-folder-move-cur-folder
4076 @vindex wl-folder-move-cur-folder
4077 The initial setting is @code{nil}. If non-nil, cursor position on the
4080 @item wl-summary-weekday-name-lang
4081 @vindex wl-summary-weekday-name-lang
4082 Specify language of the weekday.
4083 @samp{en} displays English, @samp{fr} displays French, @samp{de}
4084 displays Deutsch. You should rescan summary view after changing this value.
4086 @item wl-summary-fix-timezone
4087 @vindex wl-summary-fix-timezone
4088 The initial setting is @code{nil}.
4089 Time zone of the date string in summary mode is adjusted using this value.
4090 If @code{nil}, it is adjust to the default time zone information
4091 (system's default time zone or environment variable @samp{TZ}).
4093 @item wl-use-petname
4094 @vindex wl-use-petname
4095 The initial setting is @code{t}.
4096 If non-nil, sender part displays nickname.
4098 @item wl-break-pages
4099 @vindex wl-break-pages
4100 The initial setting is @code{t}.
4101 If non-nil, message is split as pages by @samp{^L}.
4103 @item wl-summary-from-function
4104 @vindex wl-summary-from-function
4105 Format function to display sender in summary.
4106 The initial setting is @code{wl-summary-default-from}.
4108 @item wl-summary-no-from-message
4109 @vindex wl-summary-no-from-message
4110 The initial setting is @samp{nobody@@nowhere?}. A string which is
4111 displayed when there's no @samp{From:} field in the message.
4113 @item wl-summary-subject-function
4114 @vindex wl-summary-subject-function
4115 Format function to display subject in summary.
4116 The initial setting is @code{wl-summary-default-subject} and
4117 it will cut the list name part etc. on the top of the subject.
4118 To display subject as it is, set as follows.
4121 (setq wl-summary-subject-function 'identity)
4124 @item wl-summary-no-subject-message
4125 @vindex wl-summary-no-subject-message
4126 The initial setting is @samp{(WL:No Subject in original.)}. A string
4127 which is displayed when there's no @samp{Subject:} field in the message.
4129 @item wl-summary-default-view
4130 @vindex wl-summary-default-view
4131 The initial setting is @code{'thread}.
4132 The default state for newly created summary. You can set either
4133 @code{'thread} for thread view or @code{'sequence} for sequential view.
4135 @item wl-summary-use-frame
4136 @vindex wl-summary-use-frame
4137 The initial setting is @code{nil}.
4138 If non-nil, use new frame for the summary.
4140 @item wl-use-folder-petname
4141 @vindex wl-use-folder-petname
4142 The initial setting is the list shown below:
4151 A list of display policy (symbol) of folder nickname. Available symbols
4156 Display folder petname on modeline.
4158 Destination folder is notified as nickname if
4159 @code{wl-auto-select-next} is non-nil.
4161 You can input folder name by nickname in the function
4162 @code{wl-summary-read-folder}.
4165 @item wl-summary-move-direction-toggle
4166 @vindex wl-summary-move-direction-toggle
4167 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
4168 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
4169 want to aware of reading direction, set this to @code{t}.
4171 @item wl-summary-width
4172 @vindex wl-summary-width
4173 The initial setting is 80.
4174 Width of summary line. If @code{nil}, summary line's width is as is.
4176 @item wl-summary-print-argument-within-window
4177 @vindex wl-summary-print-argument-within-window
4178 The initial setting is @code{nil}.
4179 If non-nil, the action argument is always printed on right side of
4182 @item wl-summary-indent-length-limit
4183 @vindex wl-summary-indent-length-limit
4184 The initial setting is 46.
4185 Specify the limit of thread indent level. @code{nil} means unlimited
4187 If you set this to @code{nil} you should set @code{wl-summary-width}
4190 @item wl-summary-max-thread-depth
4191 @vindex wl-summary-max-thread-depth
4192 The initial setting is 15.
4193 If thread depth of the message is larger than this value,
4194 the thread is divided.
4196 @item wl-summary-recenter
4197 @vindex wl-summary-recenter
4198 The initial setting is t.
4199 If non-nil, cursor point is moved to the center of the summary window.
4201 @item wl-summary-max-thread-depth
4202 @vindex wl-summary-max-thread-depth
4203 The initial setting is 30.
4204 If thread depth is larger than this value, divide it.
4206 @item wl-summary-divide-thread-when-subject-changed
4207 @vindex wl-summary-divide-thread-when-subject-changed
4208 The initial setting is @code{nil}. If non-nil, thread is split if
4209 the subject is changed.
4211 @item wl-summary-search-via-nntp
4212 @vindex wl-summary-search-via-nntp
4213 The initial setting is @code{confirm}.
4215 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
4216 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
4217 from the NNTP server @code{elmo-nntp-default-server}. The value of
4218 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
4219 @code{elmo-nntp-default-stream-type} are used.
4221 If @code{confirm}, server name can be specified. You can specify NNTP
4222 folder format like @samp{-:username@@servername:119!}.
4224 @item wl-summary-keep-cursor-command
4225 @vindex wl-summary-keep-cursor-command
4226 The initial setting is the list shown below:
4230 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
4235 When you entered to summary by these commands and the target summary
4236 buffer already exists, summary status is not automatically updated and
4237 cursor position is saved.
4239 @item elmo-folder-update-threshold
4240 @vindex elmo-folder-update-threshold
4241 The initial setting is 500. If updated message number is larger than
4242 this value, confirm whether drop them or not (in the case where the value
4243 of @code{elmo-folder-update-confirm} is non-nil).
4245 @item elmo-folder-update-confirm
4246 @vindex elmo-folder-update-confirm
4247 The initial setting is @code{t}. If the value is non-nil, do check with
4248 @code{elmo-folder-update-threshold}.
4250 @item wl-summary-always-sticky-folder-list
4251 @vindex wl-summary-always-sticky-folder-list
4252 The initial setting is @code{nil}.
4253 @code{wl-summary-always-sticky-folder-list} specifies the folders that
4254 are automatically stuck. Each element is regexp of folder name.
4256 @item wl-summary-reserve-mark-list
4257 @vindex wl-summary-reserve-mark-list
4258 The initial setting is the list shown below:
4262 ("o" "O" "D" "d" "i")
4267 If a message is already marked as temporal marks in this list, the
4268 message is not marked by any mark command.
4270 @item wl-summary-skip-mark-list
4271 @vindex wl-summary-skip-mark-list
4272 The initial setting is the list shown below:
4281 If a message is already marked as temporal marks in this list, the
4282 message is skipped at cursor move.
4284 @item elmo-message-fetch-threshold
4285 @vindex elmo-message-fetch-threshold
4286 The initial setting is 30000 (bytes). If displaying message has larger
4287 size than this value, Wanderlust confirms whether fetch the message or
4288 not (in the case where the value of @code{elmo-message-fetch-confirm}
4291 @item elmo-message-fetch-confirm
4292 @vindex elmo-message-fetch-confirm
4293 The initial setting is @code{t}. If the value is non-nil, do check with
4294 @code{elmo-message-fetch-threshold}.
4296 @item wl-prefetch-threshold
4297 @vindex wl-prefetch-threshold
4298 The initial setting is 30000 (bytes). If prefetching message has larger
4299 size than this value and @code{wl-prefetch-confirm} is non-nil,
4300 Wanderlust confirms whether prefetch the message or not. If
4301 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
4302 without confirmation.
4304 @item wl-prefetch-confirm
4305 @vindex wl-prefetch-confirm
4306 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4307 prefetch the message or not if the message has larger size than
4308 @code{wl-prefetch-threshold}.
4310 @item elmo-imap4-use-cache
4311 @vindex elmo-imap4-use-cache
4312 The initial setting is @code{t}. If non-nil, messages read via IMAP4
4315 @item elmo-nntp-use-cache
4316 @vindex elmo-nntp-use-cache
4317 The initial setting is @code{t}. If non-nil, messages read via NNTP are
4320 @item elmo-pop3-use-cache
4321 @vindex elmo-pop3-use-cache
4322 The initial setting is @code{t}. If non-nil, messages read via POP3 are
4325 @item elmo-shimbun-use-cache
4326 @vindex elmo-shimbun-use-cache
4327 The initial setting is @code{t}. If non-nil, messages read in Shimbun
4330 @item wl-summary-resend-use-cache
4331 @vindex wl-summary-resend-use-cache
4332 The initial setting is @code{nil}¡£If non-nil, messages are resend
4333 using cache even in the offline status. Note that if you use cache,
4334 the message identity is not guaranteed.
4336 @item wl-folder-process-duplicates-alist
4337 @vindex wl-folder-process-duplicates-alist
4338 The initial setting is @code{nil}.
4339 This list determines how to deal with duplicated messages in the same folder.
4340 Each item in the list is regexp of folder name and action; you can specify any
4341 one of the following in the place of action:
4344 @code{nil} : do nothing for duplicated messages.
4345 @code{hide} : hide duplicated messages from the summary.
4346 @code{read} : set duplicated messages as read.
4350 Following is an example (hide duplicated messages in multi folders)
4354 (setq wl-folder-process-duplicates-alist
4355 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4356 ("^\\*.*" . hide) (".*" . read)))
4360 @item wl-summary-flag-alist
4361 @vindex wl-summary-flag-alist
4362 The initial setting is as follows:
4366 ((important "orange"))
4370 Specify the color and the mark of message in summary buffer with flag.
4371 If the mark are omitted, the mark specified in the variable
4372 @code{wl-summary-flag-mark} is assumed. If multiple global flags are on
4373 one message, the former flag in this list is preferred.
4379 (setq wl-summary-flag-alist
4380 '((important "purple")
4382 (business "green" "B")
4383 (private "blue" "X")))
4387 @item wl-summary-display-mime-mode-list
4388 @vindex wl-summary-display-mime-mode-list
4389 The initial setting is the list shown below:
4398 The function @code{wl-summary-toggle-mime} switch specification of MIME
4399 analysis in the order of this list. You can specify one of the follows.
4402 @code{mime} : Header and body are decoded.
4403 @code{header-only} : Only header is decoded.
4404 @code{as-is} : Header and body are not decoded.
4409 @node Message, Draft, Summary, Top
4410 @chapter Message Buffer
4412 Message Buffers utilize MIME-View mode of SEMI. For operational
4413 procedures and key bindings, refer to respective documents.
4414 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4415 You can also see help by @kbd{?} in message buffer.
4417 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4418 brings you back to Summary mode. @kbd{l} toggles display of Summary
4421 @section Key Bindings
4427 @findex wl-message-toggle-disp-summary
4428 Toggles display of Summary buffer.
4429 (@code{wl-message-toggle-disp-summary})
4432 @findex wl-message-refer-article-or-url
4433 @kindex Button-2 (Message)
4434 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4435 corresponding message if found.
4436 (@code{wl-message-refer-article-or-url})
4438 @item Button-4 (upward movement of a wheel)
4439 @kindex Button-4 (Message)
4440 @findex wl-message-wheel-down
4441 Scrolls the message backwards. When the top of the message is hit,
4442 moves to the previous message.
4443 (@code{wl-message-wheel-down})
4445 @item Button-5 (downward movement of a wheel)
4446 @kindex Button-5 (Message)
4447 @findex wl-message-wheel-up
4448 Scrolls the message forward. When the bottom of the message is hit,
4449 moves to the next message.
4450 (@code{wl-message-wheel-up})
4454 @findex wl-message-delete-current-part
4455 Delete the part under cursor. In fact it appends modified message to
4456 the current folder then moves old one to trash folder. Therefore the
4457 message number will be changed.
4458 (@code{wl-message-delete-current-part})
4461 @section Customizable Variables
4464 @item wl-message-window-size
4465 @vindex wl-message-window-size
4466 Initial setting is @code{(1 . 4)}. It is a cons cell and the ratio of
4467 its car and cdr value corresponds to the ratio of Summary and Message
4470 @item wl-message-ignored-field-list
4471 @vindex wl-message-ignored-field-list
4472 Initial setting is @code{nil}.
4473 All fields that match this list will be hidden in message buffer.
4474 Each elements are regexp of field-name.
4475 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4477 @item wl-message-visible-field-list
4478 @vindex wl-message-visible-field-list
4479 Initial setting is @code{nil}.
4480 All fields that match this list will be display in message buffer.
4481 Each elements are regexp of field-name. This value precedes
4482 @code{wl-message-ignored-field-list}.
4483 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4485 @item wl-message-sort-field-list
4486 @vindex wl-message-sort-field-list
4488 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4489 Header fields in message buffer are ordered by this value.
4490 Each elements are regexp of field-name.
4492 @item wl-message-truncate-lines
4493 @vindex wl-message-truncate-lines
4494 The initial value is the value of @code{default-truncate-lines}.
4495 If it is non-nil, truncate long lines in message buffer.
4497 @item wl-message-auto-reassemble-message/partial
4498 @vindex wl-message-auto-reassemble-message/partial
4499 The initial setting is @code{nil}.
4500 If non-nil, automatically reassemble fragments of the message on
4501 displaying when its MIME media type is message/partial.
4504 @node Draft, Disconnected Operations, Message, Top
4505 @chapter Draft Buffer
4507 At Summary mode, pressing @kbd{w} and the like creates a new draft
4508 buffer. You can edit and send mail and news articles in this buffer.
4510 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4511 with those if possible.
4514 * Usage of Draft Mode:: TIPS
4515 * Key Bindings of Draft:: Key bindings
4516 * Variables of Draft Mode:: Customize Draft Mode
4519 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4522 Basically it is Emacs-standard mail mode.
4525 * Parameters for Sending::
4527 * Editing Message Body and Sending::
4528 * Dynamical Message Re-arrangement::
4533 @node Parameters for Sending, Editing Header, Usage of Draft Mode, Usage of Draft Mode
4534 @subsection Parameters for Sending
4536 According to the information of servers to send messages, configure
4537 following variables.
4540 @item wl-smtp-posting-server
4541 The name of the SMTP server used for mail transmission.
4543 @item wl-smtp-posting-port
4544 The SMTP port number for mail transmission.
4545 Without configuration, use default SMTP port number (25).
4547 @item wl-nntp-posting-server
4548 The name of NNTP server used for news submission.
4549 Without configuration, use @code{elmo-nntp-default-server}.
4551 @item wl-nntp-posting-port
4552 The NNTP port number for news submission.
4553 Without configuration, use @code{elmo-nntp-default-port}.
4556 You may configure following variables on demand. See section
4557 Variables of Draft Mode for detail @xref{Variables of Draft Mode}.
4560 @item wl-smtp-posting-user
4561 User name for authentication by SMTP AUTH.
4563 @item wl-smtp-authenticate-type
4564 The authentication method for SMTP AUTH.
4565 Without configuration, authentication will not be carried out.
4567 @item wl-smtp-authenticate-realm
4568 The authentication realm for SMTP AUTH.
4569 Without configuration, authentication realm will not be specified.
4571 @item wl-smtp-connection-type
4572 Specify how to establish SMTP connections.
4574 @item wl-nntp-posting-user
4575 User name for AUTHINFO authentication on news submission.
4577 @item wl-nntp-posting-stream-type
4578 Specify how to establish NNTP connections.
4581 @node Editing Header, Editing Message Body and Sending, Parameters for Sending, Usage of Draft Mode
4582 @subsection Editing Message Header
4584 You can freely edit header region above @samp{--text follows this line--},
4585 until you invoke the sending operation.
4587 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4588 addresses. @kbd{@key{TAB}} completes them.
4590 You can use following headers to specify recipients. Add some of them
4591 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4594 @item @samp{Newsgroups:}
4595 Specify newsgroups to which you post the news article.
4598 Specify addresses to send a copy (Carbon Copy) of the message.
4601 Following ones are removed from the header contents before sending.
4605 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4608 Specify folders in which a copy of the message is saved.
4611 Specify recipients to send encapsulated copy of the message.
4614 You can add initial headers by following variables.
4620 The initial setting is @code{nil}.
4621 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4622 the draft when it is prepared. If function is specified, its return
4627 The initial setting is @code{nil}.
4628 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4629 the draft when it is prepared.
4632 @node Editing Message Body and Sending, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4633 @subsection Editing Messages and Sending
4635 As a matter of course, editing message body can be performed in the same
4636 way as usual writing. You may write message body under
4637 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4638 @samp{--text follows this line--} intact.)
4640 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4641 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4642 a MIME user interface for GNU Emacs}.
4643 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4645 If you save the draft buffer you are editing, it is appended to the
4646 folder specified by @code{wl-draft-folder}. You can leave draft buffer
4647 after storing it for future editing by @kbd{C-c C-z} (@code{wl-draft-save-and-exit}).
4649 If you have finished editing, you can send message by @kbd{C-c C-c}.
4652 @node Dynamical Message Re-arrangement, Template, Editing Message Body and Sending, Usage of Draft Mode
4653 @subsection Dynamic Modification of Messages
4654 @vindex wl-draft-config-alist
4655 @c @cindex Change Message
4656 @c @cindex Message, Change Dynamic
4658 You can set @code{wl-draft-config-alist} so that header and body of the
4659 message will automatically modified depending on information of header
4662 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4664 In the example below, the header is modified when
4665 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4666 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4667 before sending the message.
4671 (setq wl-draft-config-alist
4672 '(((string-match "aaa\\.example\\.com$" (system-name))
4673 ;; @r{applied if the expression is non-nil}
4674 (wl-smtp-posting-server . "mailserver-B")
4675 (wl-nntp-posting-server . "newsserver-B")
4676 ;; @r{settings of temporary variables}
4678 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4679 ;; @r{applied if it matches the header of the draft buffer}
4680 ("Organization" . (format "Go %s" my-webpage)))
4681 ;; @r{you can write elisp expressions here (eval only)}
4682 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4683 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4688 The format of @code{wl-draft-config-alist} is:
4692 '(("@var{regexp of the header}" or @var{elisp expression}
4693 ("@var{Field}" . value(@var{elisp expression}))
4694 (@var{variable} . value(@var{elisp expression}))
4695 (@var{sub-function} . value(@var{elisp expression}))
4698 ("@var{regexp of the header}" or @var{elisp expression}
4699 ("@var{Field}" . value(@var{elisp expression}))
4704 Per default, there are 13 following sub-functions.
4707 'header: Inserts the specified string at the bottom of the header.
4708 'header-top: Inserts the specified string at the top of the header.
4709 'header-file: Inserts the specified file at the bottom of the header.
4710 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4711 'top: Inserts the specified string at the top of the body.
4712 'top-file: Inserts the specified file at the top of the body.
4713 'body: Replaces the body with the specified string.
4714 Specifying @code{nil} deletes the entire body string.
4715 'body-file: Replaces the body with the content of the specified file.
4716 'bottom: Inserts the specified string at the bottom of the body.
4717 'bottom-file: Inserts the specified file at the top of the body.
4718 'part-top: Inserts the specified string at the top of the current part.
4719 'part-bottom: Inserts the specified string at the bottom of the current part.
4720 'template: Applies the specified template.
4721 (refer to the next subsection)
4724 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4725 change them or add your own functions. If you read the code, you can
4726 easily find how to write the functions.
4728 At the first of each item, @var{a regular expression of the header} or
4729 an @var{elisp expression} should be specified. In the case of an elisp
4730 expression, the item is applied when the expression is evaluated
4733 Per default, when multiple items match or are evaluated non-nil, all
4734 such items are applied, but if you set a variable
4735 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4738 At the second of the item, a cons or a list of functions should be
4739 specified. The car part of the cons should be a header field, a
4740 variable, or a sub-function. When a header field is specified, the
4741 field will be modified. If a variable is specified, the value of the
4742 variable will be modified temporarily.
4744 In the cdr part of a cons, not only a variable but also an elisp
4745 expression can be specified as is. If the car part is a header field
4746 and the cdr part is @code{nil}, the field will be deleted.
4748 See the next example as well:
4752 (setq wl-draft-config-alist
4754 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4755 ;; @r{applied if it matches the header of the buffer being replied}
4756 (body . " Hello.\n")
4757 (template . "default")
4762 As in the (1) above, if a header regexp is prepended with @code{reply},
4763 it is applied when the draft is prepared by @code{wl-summary-reply} for
4764 example, and when it matches the header being replied. It is ignored
4765 when there is no buffer being replied, like after @code{wl-draft} was
4768 If you want to use name of parent folder, you can refer the buffer local
4769 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4770 changes From according to the folder name of the summary in which the draft
4775 (setq wl-draft-config-alist
4776 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4777 (\"From\" . \"user@@domain1\"))
4778 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4779 (\"From\" . \"user@@domain2\"))))
4784 Note that @code{wl-draft-config-alist} is applied only once when
4785 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4786 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4787 aborting transmission, execute @kbd{C-c C-e}
4788 (@code{wl-draft-config-exec}) explicitly.
4790 If you don't want to apply @code{wl-draft-config-alist} when
4791 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4795 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4798 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4799 prepared, do the following:
4802 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4805 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4806 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4810 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4813 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4814 @subsection Inserting Templates
4816 @cindex Apply Template
4818 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4819 @kbd{M-x wl-template-select} in the draft buffer.
4821 The format of @code{wl-template-alist} is almost the same as
4822 @code{wl-draft-config-alist}.
4823 @xref{Dynamical Message Re-arrangement}.
4827 (setq wl-template-alist
4830 ("Organization" . "Example Co.Ltd.")
4831 (body . "Hello.\n"))
4833 (template . "default") ;; @r{(a)}
4834 ("To" . "boss@@example.com")
4835 ("Subject" . "Report")
4836 (body-file . "~/work/report.txt")
4842 As you can see, the only difference is item (template) names such as
4843 @samp{default} and @samp{report}, instead of a regexp of header.
4844 Because definition of each item is the same as
4845 @code{wl-draft-config-alist}, you can call another template, like (a).
4847 Executing the command @code{wl-template-select} results in template
4848 selection, but the result differs depending on variable
4849 @code{wl-template-visible-select}.
4851 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4852 window is shown below the draft buffer. You can select a template by
4853 @kbd{n} and @kbd{p} seeing the buffer window.
4855 Press the @key{RET} key and the template is actually applied to the draft
4856 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4857 adjust the window size by @code{wl-template-buffer-lines}.
4859 If @code{wl-template-visible-select} is @code{nil}, you should type the
4860 name of the template in the mini buffer.
4862 If @code{wl-template-select} is executed with prefix argument,
4863 inversed value of @code{wl-template-visible-select} is used.
4865 As shown in the example in @code{wl-draft-config-alist}, you can select
4866 @samp{default} template by writing:
4869 (template . "default")
4872 @node POP-before-SMTP, , Template, Usage of Draft Mode
4873 @subsection Sending mail by POP-before-SMTP
4874 @cindex POP-before-SMTP
4876 You can send mail by POP-before-SMTP. Necessary setting is
4879 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4883 to change mail posting function from its default value @code{wl-draft-send-mail-with-smtp}.
4884 Also you would configure following variables on demand.
4887 @item wl-pop-before-smtp-user
4888 The POP user name for POP-before-SMTP authentication.
4889 If unset, @code{elmo-pop3-default-user} is used.
4891 @item wl-pop-before-smtp-server
4892 The POP server name for POP-before-SMTP authentication.
4893 If unset, @code{elmo-pop3-default-server} is used.
4895 @item wl-pop-before-smtp-authenticate-type
4896 The POP authentication method for POP-before-SMTP authentication.
4897 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4899 @item wl-pop-before-smtp-port
4900 The POP port number for POP-before-SMTP authentication.
4901 If unset, @code{elmo-pop3-default-port} is used.
4903 @item wl-pop-before-smtp-stream-type
4904 If @code{ssl}, POP connection is established using SSL. If
4905 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4906 unset, @code{elmo-pop3-default-stream-type} is used.
4909 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4910 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4912 Therefore, if SMTP server and POP server are actually the same, and if
4913 POP folder per default (such as @samp{&}) is available, no settings are
4916 Refer to the following URL about POP-before-SMTP.
4920 http://www.iecc.com/pop-before-smtp.html
4925 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4926 @section Key Bindings
4927 @cindex Keybind, Draft Mode
4928 @cindex Keybind, Draft Buffer
4933 @kindex C-c C-y (Draft)
4934 @findex wl-draft-yank-original
4935 Cites the content of the current message buffer (the part under cursor).
4936 If the region is active, cites the region (it affects only if
4937 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4938 (on XEmacs) is Non-nil). If the command is called with prefix argument,
4939 the text inserted by yank command (the text content of clipboard) is cited.
4940 (@code{wl-draft-yank-original})
4943 @kindex C-c C-p (Draft)
4944 @findex wl-draft-preview-message
4945 Previews the content of the current draft.
4946 This is useful for previewing MIME multi-part messages.
4947 (@code{wl-draft-preview-message})
4950 @kindex C-c C-s (Draft)
4951 @findex wl-draft-send
4952 Sends the content of the current draft. Does not erase the draft buffer.
4953 This is useful for sending multiple messages, which are a little different
4955 (@code{wl-draft-send})
4958 @kindex C-c C-c (Draft)
4959 @findex wl-draft-send-and-exit
4960 Sends the content of the current draft and erases the draft buffer.
4961 (@code{wl-draft-send-and-exit})
4964 @kindex C-x C-s (Draft)
4965 @findex wl-draft-save
4966 Save the current draft.
4967 (@code{wl-draft-save})
4970 @kindex C-c C-k (Draft)
4971 @findex wl-draft-kill
4972 Kills the current draft.
4973 (@code{wl-draft-kill})
4976 @kindex C-x k (Draft)
4977 @findex wl-draft-mimic-kill-buffer
4978 Kills the current draft.
4979 (@code{wl-draft-mimic-kill-buffer})
4982 @kindex C-c C-z (Draft)
4983 @findex wl-draft-save-and-exit
4984 Saves the current draft, and erases the draft buffer.
4985 This is useful if you want to suspend editing of the draft.
4986 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4987 the @samp{+draft} folder.
4988 (@code{wl-draft-save-and-exit})
4991 @kindex C-c C-r (Draft)
4992 @findex wl-caesar-region
4993 Encodes or decodes the specified region in Caesar cipher.
4994 (@code{wl-caesar-region})
4998 @findex wl-draft-highlight-and-recenter
4999 Recenter and rehighlight current draft.
5000 (@code{wl-draft-highlight-and-recenter})
5004 @findex wl-toggle-plugged
5005 Toggles off-line/on-line states of Wanderlust.
5006 (@code{wl-toggle-plugged})
5009 @kindex C-c C-o (Draft)
5010 @findex wl-jump-to-draft-buffer
5011 Jumps to the other draft buffer, if exists.
5012 With prefix argument, reads a file (if any) from the draft folder when
5013 there is no such buffer.
5014 (@code{wl-jump-to-draft-buffer})
5017 @kindex C-c C-e (Draft)
5018 @findex wl-draft-config-exec
5019 Applies @code{wl-draft-config-alist}.
5020 (@code{wl-draft-config-exec})
5023 @kindex C-c C-j (Draft)
5024 @findex wl-template-select
5026 (@code{wl-template-select})
5029 @kindex C-c C-a (Draft)
5031 Enter Address Manager.
5032 @xref{Address Manager}.
5036 @kindex C-c C-d (Draft)
5037 @findex wl-draft-elide-region
5038 Elide the text between point and mark (@code{wl-draft-elide-region}).
5039 The text is killed and replaced with the contents of the variable
5040 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
5044 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
5045 @section Customizable Variables
5049 @item wl-subscribed-mailing-list
5050 @vindex wl-subscribed-mailing-list
5051 The initial setting is @code{nil}. Mailing lists to which you
5052 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
5053 field of a reply draft, removes your own address from
5054 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
5055 contained in @samp{To:} or @samp{Cc:} field of a message to be
5056 automatically re-filed, the destination folder will be leaned in
5057 connection with the address.
5063 (setq wl-subscribed-mailing-list
5064 '("wl@@lists.airs.net"
5066 "emacs-mime-ja@@m17n.org"))
5070 @item wl-insert-mail-followup-to
5071 @vindex wl-insert-mail-followup-to
5072 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
5073 field is automatically inserted in the draft buffer.
5075 @item wl-insert-mail-reply-to
5076 @vindex wl-insert-mail-reply-to
5077 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
5078 field is automatically inserted in the draft buffer.
5080 @item wl-auto-insert-x-face
5081 @vindex wl-auto-insert-x-face
5082 The initial setting is @code{t}. If non-nil and there is an encoded
5083 X-Face string in a file @file{~/.xface} (the value of the variable
5084 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
5085 draft buffer. If @code{nil}, it is not automatically inserted.
5087 @item wl-insert-message-id
5088 @vindex wl-insert-message-id
5089 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
5090 is automatically inserted on the transmission.
5092 @item wl-message-id-use-wl-from
5093 @vindex wl-message-id-use-wl-from
5094 The initial setting is @code{nil}. If non-nil, the value of
5095 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
5097 @item wl-local-domain
5098 @vindex wl-local-domain
5099 The initial setting is @code{nil}. If @code{nil}, the return value of
5100 the function @code{system-name} will be used as the domain part of
5103 If @code{system-name} does not return FQDN (i.e. the full name of the
5104 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
5105 to the string of the local domain name without hostname (like
5106 @samp{gohome.org}). That is, a concatenation of @code{system-name}
5107 @samp{.} @code{wl-local-domain} is used as domain part of the
5110 If your terminal does not have global IP, set the value of
5111 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
5112 you use invalid @samp{Message-ID:}.)
5114 Moreover, concatenation of @code{system-name} @samp{.}
5115 @code{wl-local-domain} will be used as an argument to the HELO command
5118 @item wl-message-id-domain
5119 @vindex wl-message-id-domain
5120 The initial setting is @code{nil}. If non-nil, this value is used as a
5121 domain part of the @samp{Message-ID:}. If your terminal does not have
5122 global IP address, set unique string to this value (e.x. your e-mail
5125 @item wl-unique-id-suffix
5126 @vindex wl-unique-id-suffix
5127 The initial setting is @samp{.wl}. You can specify the string in generated
5128 Message-ID which appear just before @samp{@@}.
5130 @item wl-draft-config-alist
5131 @vindex wl-draft-config-alist
5132 The initial setting is @code{nil}. Modifies the draft message just
5133 before the transmission. The content of @code{wl-draft-config-alist}
5134 will be automatically applied only once on the transmission. If you
5135 want to apply it manually, use @kbd{C-c C-e}. This command can be used
5138 @item wl-template-alist
5139 @vindex wl-template-alist
5140 The initial setting is @code{nil}.
5141 This variable specifies the template to be applied in the draft buffer.
5143 @item wl-draft-config-matchone
5144 @vindex wl-draft-config-matchone
5145 The initial setting is @code{nil}. If non-nil, only the first matching
5146 item is used when @code{wl-draft-config-alist} is applied. If
5147 @code{nil}, all matching items are used.
5149 @item wl-template-visible-select
5150 @vindex wl-template-visible-select
5151 The initial setting is @code{t}.
5152 If non-nil, you can preview the result of the template selection in
5155 @item wl-template-confirm
5156 @vindex wl-template-confirm
5157 The initial setting is @code{nil}.
5158 If non-nil, asks for confirmation when you press the enter key to select
5159 template while previewing.
5161 @item wl-template-buffer-lines
5162 @vindex wl-template-buffer-lines
5163 The initial setting is 7.
5164 If @code{wl-template-visible-select} is non-nil, this variable specifies
5165 the size of the preview window.
5167 @item wl-draft-buffer-style
5168 @vindex wl-draft-buffer-style
5169 The initial setting is @code{full}.
5170 Style of draft buffer window (except for replying and forwarding).
5171 @code{keep} is to use current window,
5172 @code{full} is to use full frame window,
5173 @code{split} is to split current window and use it.
5174 If some function is specified, it is called with the draft buffer
5177 @item wl-draft-reply-buffer-style
5178 @vindex wl-draft-reply-buffer-style
5179 The initial setting is @code{split}.
5180 Style of draft buffer for replying and forwarding.
5181 @code{keep} is to use message buffer window,
5182 @code{full} is to use full frame window,
5183 @code{split} is to split message buffer window and use it.
5184 If some function is specified, it is called with the draft buffer
5187 @item wl-draft-use-frame
5188 @vindex wl-draft-use-frame
5189 The initial setting is @code{nil}.
5190 If non-nil, use new frame for the draft.
5192 @item wl-draft-reply-default-position
5193 @vindex wl-draft-reply-default-position
5194 The initial setting is @code{body}.
5195 Specify initial cursor position on draft buffer for reply.
5196 @code{body} is to move cursor to the top of the message body,
5197 @code{bottom} to the bottom of the message body, and @code{top} to the
5200 @item wl-draft-truncate-lines
5201 @vindex wl-draft-truncate-lines
5202 The initial value is the value of @code{default-truncate-lines}.
5203 If it is non-nil, truncate long lines in draft buffer.
5207 The initial setting is the value of the variable
5208 @code{user-mail-address}. The value of this variable is inserted as a
5209 @samp{From:} field of the draft when it is prepared.
5211 @item wl-envelope-from
5212 @vindex wl-envelope-from
5213 The initial setting is @code{nil}.
5214 The value of this variable is used for envelope from (MAIL FROM).
5215 If @code{nil}, the address part of @code{wl-from} is used.
5217 @item wl-user-mail-address-list
5218 @vindex wl-user-mail-address-list
5219 The initial setting is @code{nil}.
5220 This is the User's address list. If you have multiple addresses,
5223 @item wl-reply-subject-prefix
5224 @vindex wl-reply-subject-prefix
5225 The initial setting is @samp{Re: }.
5226 In the @samp{Subject:} of the reply draft, this string is prepended to
5227 the @samp{Subject:} of being replied. You can specify a function to be
5228 message buffer of the reply target.
5230 @item wl-forward-subject-prefix
5231 @vindex wl-forward-subject-prefix
5232 The initial setting is @samp{Forward: }.
5233 In the @samp{Subject:} of the forwarding draft, this string is prepended
5234 to the @samp{Subject:} of being forwarded. You can specify a function
5235 to be message buffer of the forward target.
5237 @item wl-draft-reply-use-address-with-full-name
5238 @vindex wl-draft-reply-use-address-with-full-name
5239 The initial setting is @code{t}.
5240 If non-nil, insert her full name with address when prepare a draft for
5241 reply a message. If it is @code{nil}, insert her address only.
5243 @item wl-draft-enable-queuing
5244 @vindex wl-draft-enable-queuing
5245 The initial setting is @code{t}.
5246 This flag controls off-line transmission. If non-nil, the draft is
5249 @item wl-draft-use-cache
5250 @vindex wl-draft-use-cache
5251 The initial setting is @code{nil}. If the value is non-nil and
5252 @code{wl-insert-message-id} is nil, cache the message which is sent.
5254 @item wl-fcc-force-as-read
5255 @vindex wl-fcc-force-as-read
5256 The initial setting is @code{nil}. If the value is non-nil,
5257 Mark as read the message saved by @samp{Fcc:}.
5259 @item wl-auto-flush-queue
5260 @vindex wl-auto-flush-queue
5261 The initial setting is t.
5262 This flag controls automatic transmission of the queue when Wanderlust
5263 becomes on-line. If non-nil, the queue is automatically transmitted
5264 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5265 manually, press @kbd{F} in the folder mode.
5267 @item wl-ignored-forwarded-headers
5268 @vindex wl-ignored-forwarded-headers
5269 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
5270 All headers that match this regexp will be deleted when forwarding a message.
5272 @item wl-ignored-resent-headers
5273 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
5274 All headers that match this regexp will be deleted when resending a message.
5276 @item wl-draft-always-delete-myself
5277 @vindex wl-draft-always-delete-myself
5278 If non-nil, always removes your own address from @samp{To:} and
5279 @samp{Cc:} when you are replying to the mail addressed to you.
5281 @item wl-draft-delete-myself-from-bcc-fcc
5282 @vindex wl-draft-delete-myself-from-bcc-fcc
5283 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
5284 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
5286 @item wl-draft-send-mail-function
5287 @vindex wl-draft-send-mail-function
5288 The initial setting is @code{wl-draft-send-mail-with-smtp}.
5289 This is the function to post mails. To use POP-before-SMTP, set this to
5290 @code{wl-draft-send-mail-with-pop-before-smtp}.
5292 @item wl-smtp-posting-server
5293 @vindex wl-smtp-posting-server
5294 The initial setting is @code{nil}.
5295 This is the SMTP server name for mail transmission.
5297 @item wl-smtp-posting-port
5298 @vindex wl-smtp-posting-port
5299 The initial setting is @code{nil}.
5300 This is the SMTP port number for mail transmission.
5301 If @code{nil}, default SMTP port number (25) is used.
5303 @item wl-smtp-posting-user
5304 @vindex wl-smtp-posting-user
5305 The initial setting is @code{nil}.
5306 This is the user name for SMTP AUTH authentication.
5308 @item wl-smtp-authenticate-type
5309 @vindex wl-smtp-authenticate-type
5310 The initial setting is @code{nil}.
5311 This string-valued variable specifies the authentication method for SMTP
5312 AUTH authentication. You may specify @code{plain}, @code{cram-md5},
5313 @code{digest-md5}, @code{login}, etc. If @code{nil}, authentication
5314 will not be carried out.
5316 @item wl-smtp-authenticate-realm
5317 @vindex wl-smtp-authenticate-realm
5318 The initial setting is @code{nil}.
5319 This string-valued variable specifies the authentication realm for SMTP
5320 AUTH authentication. You have to set this variable for DIGEST-MD5
5321 authentication and so on.
5322 If @code{nil}, authentication realm is not specified in the authentication.
5324 @item wl-smtp-connection-type
5325 @vindex wl-smtp-connection-type
5326 The initial setting is @code{nil}.
5327 This symbol-valued variable specifies how to establish SMTP connections.
5328 If @code{nil}, use default connection type.
5329 If it is @code{starttls}, use STARTTLS (RFC2595).
5330 If it is @code{ssl}, use SSL.
5332 @item wl-nntp-posting-server
5333 @vindex wl-nntp-posting-server
5334 The initial setting is @code{nil}.
5335 This is the NNTP server name used for news submission.
5336 If @code{nil}, @code{elmo-nntp-default-server} is used.
5338 @item wl-nntp-posting-user
5339 @vindex wl-nntp-posting-user
5340 The initial setting is @code{nil}.
5341 This is the user name for AUTHINFO authentication on news submission.
5342 If @code{nil}, @code{elmo-nntp-default-user} is used.
5343 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
5345 @item wl-nntp-posting-port
5346 @vindex wl-nntp-posting-port
5347 The initial setting is @code{nil}.
5348 This is the port number of the NNTP server used for news submission.
5349 If @code{nil}, @code{elmo-nntp-default-port} is used.
5351 @item wl-nntp-posting-stream-type
5352 @vindex wl-nntp-posting-stream-type
5353 The initial setting is @code{nil}.
5354 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If @code{ssl},
5355 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
5356 connection will be established.
5358 @item wl-nntp-posting-function
5359 @vindex wl-nntp-posting-function
5360 The initial setting is @code{elmo-nntp-post}.
5361 This is the function to post NNTP message.
5363 @item wl-nntp-posting-config-alist
5364 @vindex wl-nntp-posting-config-alist
5365 The initial setting is @code{nil}.
5366 The value takes an alist to define NNTP server like following example.
5367 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
5371 (setq wl-nntp-posting-config-alist
5372 '((",?gmane\\." . "news.gmane.org")
5374 ((server . "news-server")
5375 (user . "newsmaster")
5377 (function . elmo-nntp-post)))
5378 (".*" . "default-news-server")))
5382 @item wl-pop-before-smtp-user
5383 @vindex wl-pop-before-smtp-user
5384 The initial setting is @code{nil}.
5385 This is the POP user name for POP-before-SMTP.
5386 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
5388 @item wl-pop-before-smtp-server
5389 @vindex wl-pop-before-smtp-server
5390 The initial setting is @code{nil}.
5391 This is the POP server name for POP-before-SMTP.
5392 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
5394 @item wl-pop-before-smtp-authenticate-type
5395 @vindex wl-pop-before-smtp-authenticate-type
5396 The initial setting is @code{nil}.
5397 This is the authentication method for POP-before-SMTP authentication.
5398 If it is @code{nil}, @code{elmo-pop3-default-authenticate-type} is used.
5400 @item wl-pop-before-smtp-port
5401 @vindex wl-pop-before-smtp-port
5402 The initial setting is @code{nil}.
5403 This is the POP port number for POP-before-SMTP. If it is @code{nil},
5404 @code{elmo-pop3-default-port} is used.
5406 @item wl-pop-before-smtp-stream-type
5407 @vindex wl-pop-before-smtp-stream-type
5408 The initial setting is @code{nil}.
5409 This flag controls the use of SSL for POP-before-SMTP. If it is
5410 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{ssl},
5411 SSL is used. If @code{starttls}, STARTTLS (RFC2595) connection will be
5414 @item wl-draft-queue-save-variables
5415 @vindex wl-draft-queue-save-variables
5416 Specifies a list of variable to which queued messages are saved on the
5417 off-line transmission.
5419 @item wl-draft-sendlog
5420 @vindex wl-draft-sendlog
5421 The initial setting is @code{t}.
5422 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
5426 @item drafts are sent by smtp or qmail
5427 @item saved into folders by fcc
5428 @item saved into folders by queuing
5431 (it is written even if the transmission fails).
5432 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
5433 and left to the logging function of @command{imput}.
5436 @item wl-draft-sendlog-max-size
5437 @vindex wl-draft-sendlog-max-size
5438 The initial setting is 20000 (in bytes).
5439 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
5440 beyond the size specified by this variable.
5444 The initial setting is @code{nil}.
5445 If non-nil, address completion uses LDAP.
5447 @item wl-ldap-server
5448 @vindex wl-ldap-server
5449 The initial setting is @samp{localhost}.
5450 LDAP server name for address completion.
5453 @vindex wl-ldap-port
5454 The initial setting is @code{nil}.
5455 If non-nil, the value is used as port number.
5458 @vindex wl-ldap-base
5459 The initial setting is @samp{c=US}.
5460 LDAP search starting point (base) for address completion.
5462 @item wl-draft-remove-group-list-contents
5463 @vindex wl-draft-remove-group-list-contents
5464 The initial setting is @code{t}.
5465 If non-nil, remove the group-lists' members in the recipients when
5466 sending the message (group-list means the description such as
5467 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5470 @node Disconnected Operations, Expire and Archive, Draft, Top
5471 @chapter Off-line Management
5472 @cindex Disconnected Operations
5474 Wanderlust has on-line and off-line states.
5477 * Off-line State:: Wanderlust has on-line and off-line states
5478 * Enable Operations:: Enable Disconnected Operations
5479 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5480 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5481 * Variables of Plugged Mode:: Customize Plugged Mode
5485 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5486 @section Off-line State
5488 Wanderlust has on-line and off-line states. In the off-line state, you
5489 cannot access messages via network, unless they are cached.
5491 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5492 in the mode line indicates the off-line state. In folder or summary
5493 modes, press @kbd{M-t} to switch between off- and on-line.
5495 You can invoke Wanderlust in the off-line state by setting
5496 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5498 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5499 ignores uncached messages.
5502 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5503 @section Enable Disconeected Operations
5505 Even in the off-line state, provided that relevant messages are cached,
5506 and the variable @code{elmo-enable-disconnected-operation} (described
5507 later) is non-nil, you can following operations:
5508 @xref{Plugged Mode}, @xref{Off-line State settings}.
5511 * Send Messages off-line:: Transmit Messages
5512 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5513 * Creation of Folders:: Create Folders off-line (IMAP4)
5514 * Marking:: Mark (IMAP4)
5515 * Pre-fetching Reservations:: Pre-fetch
5518 As soon as Wanderlust becomes on-line, such operations invoked off-line
5519 are reflected in the servers via network.
5521 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5522 these off-line operations are not executed and causes an error on
5523 re-file or copy operations.
5525 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5526 @subsection Transmission of Messages
5528 You can proceed sending operation for mail/news messages while you are
5529 off-line, then it will be reserved for sending (if you are using
5530 @file{im-wl.el}, it is irrelevant).
5531 Messages reserved for sending while off-line are accumulated in the
5532 queue folder, @samp{+queue}. These messages are transmitted at once when
5533 Wanderlust becomes on-line.
5535 You can visit @samp{+queue} in the off-line state and confirm content of
5536 messages in the queue. You can also remove messages. Removed messages
5537 are not transmitted even in the on-line state.
5540 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5541 @subsection Re-file and Copy (IMAP4)
5543 Re-file and copy operations to IMAP folders invoked during the off-line
5544 state are accumulated in the queue, and reflected in the server side
5545 when Wanderlust becomes on-line. If you visit destination folders after
5546 off-line re-file or copy, it looks as if messages were appended even in
5549 For the safety reasons, messages re-filed off-line are removed from
5550 source folders only if their @samp{Message-ID:} match messages on the
5551 servers. While the queue is processed, messages that failed to be
5552 re-filed or copied to the specified folders are appended to the folder
5556 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5557 @subsection Creation of Folders (IMAP4)
5559 You can create IMAP folders off-line. The creation of folders are
5560 reflected in the servers when Wanderlust becomes on-line. If the creation
5561 of those folders fails at that time for some reasons, messages
5562 to be re-filed into those are appended to the folder @samp{+lost+found}
5566 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5567 @subsection Marking (IMAP4)
5569 Off-line changes in unread/read and importance mark @samp{$} information
5570 are also reflected in the servers when Wanderlust becomes on-line.
5573 @node Pre-fetching Reservations, , Marking, Enable Operations
5574 @subsection Pre-fetching
5576 You can make reservations for pre-fetching messages in networking
5577 folders (IMAP, NNTP, POP3, shimbun). Reserved messages are marked with
5578 @samp{u} but not cached yet. When Wanderlust becomes on-line, they are
5579 pre-fetched from servers.
5582 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5583 @section Switching On-line/Off-line per Server/Port
5585 @kbd{M-t} described above switches networking states as a whole, but you
5586 can switch on-line/off-line per server/port.
5588 Pressing @kbd{C-t} in the folder or summary modes brings you in
5589 wl-plugged-mode shown below, in which you can change the plugged state
5594 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5597 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5598 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5600 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5601 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5607 The first line indicates status of the following three variables, and
5608 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5609 column modifies the values of these variables.
5613 "Queuing" @code{wl-draft-enable-queuing}
5614 "AutoFlushQueue" @code{wl-auto-flush-queue}
5615 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5619 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5622 The second and after lines indicate on-line/off-line states of servers
5623 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5624 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5625 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5627 @dfn{sending queue} means messages accumulated in the folder
5628 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5629 off-line operations when @code{elmo-enable-disconnected-operation} is
5631 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5632 @c off-line operations are enabled.
5634 They are displayed if there are any of them. In the example above, in
5635 the sending queue there are two messages (the first and the second in
5636 the queue folder) for smtp to hosta and one (the third) for nntp to
5637 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5640 If you change @samp{(wl-plugged)} in the second line, the variable
5641 @code{wl-plugged} is changed, so that the mode line indicator and
5642 plugged states of all ports are affected. If you change plugged states
5643 of any servers or ports, @samp{(wl-plugged)} in the second line is
5644 affected depending on @code{elmo-plugged-condition} settings and the
5645 plugged state of each port.
5648 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5649 @section Invoking Wanderlust in the Off-line State
5651 As described before, if you set @code{wl-plugged} to @code{nil} in
5652 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5653 off-line state. You can specify off-line state on a per server or port
5654 basis. Refer to @code{wl-reset-plugged-alist} also.
5656 Usually, when Wanderlust starts up, the plugged state of each port is
5657 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5658 @code{wl-nntp-posting-server} and so on. If you want to change the
5659 plugged state of these ports or to add other ports, configure
5660 @code{wl-make-plugged-hook} with a function.
5664 (add-hook 'wl-make-plugged-hook
5666 (elmo-set-plugged plugged-value(t/nil) server port)
5667 ;; @r{add or change plugged states of the port of the server}
5668 (elmo-set-plugged plugged-value(t/nil) server)
5669 ;; @r{if the port is omitted, all ports are affected}
5670 ;; @r{(you cannot omit the port if you newly add the server)}
5676 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5677 @section Customizable Variables
5682 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5683 mode from the beginning.
5685 @item wl-queue-folder
5686 @vindex wl-queue-folder
5687 The initial setting is @samp{+queue}.
5688 This is the folder in which messages in the transmission queue are
5691 @item wl-auto-flush-queue
5692 @vindex wl-auto-flush-queue
5693 The initial setting is @code{t}.
5694 This flag controls automatic transmission of the queue when Wanderlust
5695 becomes on-line. If non-nil, the queue is automatically transmitted
5696 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5697 manually, press @kbd{F} in the folder mode.
5699 @item elmo-enable-disconnected-operation
5700 @vindex elmo-enable-disconnected-operation
5701 The initial setting is @code{t}. Controls off-line operations regarding
5702 networking folders. If non-nil, off-line operations are carried out.
5704 @item elmo-lost+found-folder
5705 @vindex elmo-lost+found-folder
5706 The initial setting is @samp{+lost+found}.
5707 This is the folder to which messages are saved when they fails to be
5708 appended while the off-line re-file/copy queue is processed.
5710 @item elmo-plugged-condition
5711 @vindex elmo-plugged-condition
5712 The initial setting is @code{one}.
5713 The value of @code{wl-plugged} reflects the return value of the function
5714 @code{elmo-plugged-p} (without arguments).
5715 This variable @code{elmo-plugged-condition} specifies the condition on
5716 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5717 plugged state of each port.
5720 'one : plugged if one or more ports are plugged.
5721 'all : plugged if all ports are plugged.
5722 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5723 states of the ports.
5724 @var{function} : reflects the return value of the @var{function}
5725 functions available per default
5726 'elmo-plug-on-by-servers
5727 : reflects the plugged state of the servers specified by the
5728 variable elmo-plug-on-servers.
5729 'elmo-plug-on-by-exclude-servers
5730 : reflects the plugged state of the servers that are not
5731 in elmo-plug-on-exclude-servers.
5732 elmo-plug-on-exclude-servers defaults to
5735 (system-name)without the domain part)
5741 (setq elmo-plugged-condition 'all)
5743 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5744 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5746 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5747 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5751 @item wl-reset-plugged-alist
5752 @vindex wl-reset-plugged-alist
5753 The initial setting is @code{t}. If non-nil, plugged states are
5754 initialized on a per server or port basis when Wanderlust starts up.
5756 If @code{nil}, plugged states are retained while Emacs is running. In
5757 other words, they are initialized when Emacs is restarted even if the
5758 value is @code{nil}.
5762 @node Expire and Archive, Scoring, Disconnected Operations, Top
5763 @chapter Automatic Expiration and Archiving of Messages
5764 @cindex Expire and Archive
5767 * Expire:: Expiration and Archiving
5768 * Archive:: Archiving All Messages
5772 @node Expire, Archive, Expire and Archive, Expire and Archive
5774 @cindex Expire Message
5776 Expiration means deletion of old messages which have outlasted a
5777 certain period of time.
5779 @code{wl-expire} supports not only simple deletion, but also moving to
5780 specified archiving folders.
5784 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5785 or @kbd{M-e} in the summary mode.
5787 @subsection Configuring @code{wl-expire-alist}
5789 An example configuration of @code{wl-expire-alist} is shown below.
5790 Everything in this @code{wl-expire-alist} makes a great difference in
5791 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5792 to @code{t}, especially in the initial stage.
5796 (setq wl-expire-alist
5797 '(("^\\+trash$" (date 14) remove)
5799 ("^\\+tmp$" (date 7) trash)
5800 ;; @r{re-file to @code{wl-trash-folder}}
5801 ("^\\+outbox$" (number 300) "$outbox;lha")
5802 ;; @r{re-file to the specific folder}
5804 ;; @r{do not expire}
5805 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5806 ;; @r{archive by message number (retaining numbers)}
5807 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5808 ;; @r{archive by a fixed number (retaining numbers)}
5809 ("^\\+diary$" (date 30) wl-expire-archive-date)
5810 ;; @r{archive by year and month (numbers discarded)}
5815 Items in the list has the format of:
5818 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5822 The folder is examined if it matches @var{regexp-for-folders} from the
5823 beginning of the list. If you invoke expiration on the folder that does
5824 not match any of them, nothing will happen. And if either the second or
5825 the third element of the item is @code{nil}, expiration will not take
5828 You can use any one of the following for
5829 @var{specification-of-message-to-be-deleted}:
5832 @item (number @var{n1} [@var{n2}])
5833 deletes messages depending on the number of messages in the folder.
5835 @var{n1} is the number of messages which should survive deletion, for example
5836 if its value is 500, the newest 500 messages survive and the rests are
5839 @var{n2} is the number of messages in the folder on which expiration should
5840 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5841 folders with 510 or more messages are expired.
5842 If you configured automatic expiration, frequently used folders may
5843 expire every time it receive messages, and you may be annoyed with the
5844 long delay in reading mail.
5845 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5846 expiration would not take place until a certain number of messages
5849 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5850 with important/new/unread) are not deleted.
5851 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5852 will expire so as to have 500 messages including such ones.
5853 Otherwise, it will have 500 messages except such ones.
5855 @item (date @var{d1})
5856 deletes messages depending on the dates.
5858 Messages dated @var{d1} or more days ago are deleted, for example if its
5859 value is seven, messages seven days old or more are deleted. Note that
5860 the date is the one in the @samp{Date:} field of the message, not when
5861 the message entered the folder.
5863 Messages with no or invalid @samp{Date:} field does not expire; you
5864 might have to delete them by hand.
5867 You can use any one of the following in the place of @var{destination}:
5871 deletes the messages instantly.
5874 hide the messages from summary (messages are not deleted).
5877 moves the messages to @code{wl-trash-folder}.
5879 @item @var{string}(folder)
5880 moves the messages to the folder specified with @var{string}.
5882 It would be useful for specifying an archiving folder, but because this
5883 does not move important messages, it might be better to use the
5884 standard functions described below.
5886 @item @var{function}
5887 invokes the specified @var{function}.
5889 To the @var{function}, three arguments are passed: a folder name, a list
5890 of messages to be deleted, and msgdb information of the summary. You
5891 can specify function-specific arguments after the name of the
5892 @var{function}. Note that the list contains messages with marks in
5893 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5896 These are four standard functions; three of them move messages to an archive
5897 folder in the specified way. This means old messages can be compressed
5898 and saved in a file, being deleted from the original folder.
5899 The last one divides messages to some MH folders.
5902 @item wl-expire-archive-number1
5903 re-files to archiving folders corresponding to the message numbers of
5904 the messages being deleted. For example, a message numbered 102 will be
5905 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5906 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5907 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5909 The archiving folders to which messages are re-filed are determined by
5910 the name of the folder as follows (in this case, archiving folders are
5911 handled as if @code{elmo-archive-treat-file} were non-nil).
5914 @item If the folder type is localdir:
5915 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5917 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5918 (@file{~/Mail/ml/wl-00100.zip}).
5920 @item The folder type is other than localdir:
5921 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5923 For example, @samp{%#mh/ml/wl} corresponds to
5924 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5927 As you can see, in the case of localdir, the folder type is not included
5928 in the path name, but otherwise it is included.
5929 And you can control the prefix to the archiving folder name by
5930 @code{wl-expire-archive-folder-prefix}.
5931 Refer to @code{wl-expire-archive-folder-prefix} for details.
5933 @item wl-expire-archive-number2
5934 re-files every certain number of messages to archiving folders.
5936 This differs from @samp{wl-expire-archive-number1} in that this re-files
5937 to the folder up to the specified number regardless of message numbers.
5938 The archiving folders to which messages are re-filed are determined in the
5939 same way as @code{wl-expire-archive-number1}.
5941 @item wl-expire-archive-date
5942 re-files messages depending on its date (year and month) to archive
5945 For example, a message dated December 1998 is re-filed to
5946 @code{$folder-199812;zip}. The name of the archiving folders except the
5947 date part are determined in the same way as
5948 @code{wl-expire-archive-number1}.
5951 You can set the first argument to these three standard functions to non-nil
5952 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5953 For example, it can be specified just after the name of the function:
5956 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5959 If you omit the argument, consecutive numbers from 1 are assigned for
5960 each archiving folder.
5962 @item wl-expire-localdir-date
5963 divedes messages depending on its date (year and month) to MH folders
5964 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5968 @subsection Treatment for Important or Unread Messages
5970 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5971 standard function, messages with marks in
5972 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5973 messages} thereafter) are retained.
5975 Per default, this variable include the important, new, and unread marks,
5976 so that messages with these marks are not removed.
5977 Note that you cannot include the temporary mark (i.e. temporary marks
5978 are removed anyway), and be sure to process temporary marks before you
5981 @subsection Auto Expiration
5983 The following setup invokes expiration when you move into the summary
5984 mode. There will be no confirmation, so make sure you made no mistake
5985 in regexp and other settings before you set up this.
5989 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5993 In the folder mode, you can invoke expiration per group as well as per
5994 folder. Therefore, if you specify @samp{Desktop} group, all folders
5995 matching @code{wl-expire-alist} expire.
5999 @subsection Treating archive folders.
6000 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
6001 you must set non-nil value to @code{elmo-archive-treat-file}.
6003 @subsection Confirming
6005 If you are to use @code{remove}, try @code{trash} at first and see
6006 messages move to @code{wl-trash-folder} as expected, then replace it
6007 with @code{remove}. It would be dangerous to use @code{remove} from the
6010 If you are to use @code{wl-expire-archive-number1} and the like, try to
6011 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
6012 you can append messages to it. Even if settings in
6013 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
6014 would not be saved anywhere and disappeared in case the archiver program
6017 After you make sure you can archive to the folder correctly, you can
6018 invoke expiration and utilize the log.
6020 If you set @code{wl-expire-use-log} to @code{t},
6021 @file{~/.elmo/expired-log} should contain the log, for example:
6025 delete +ml/wl (593 594 595 596 597 598 599)
6026 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
6030 The first column indicates the operation, i.e. @samp{delete},
6031 @samp{copy}, or @samp{move}. The next is the name of the folder that
6032 expired. In the case of @samp{copy} and @samp{move}, the destination
6033 folder is recorded after @samp{->}. The last is the list of message
6034 numbers that are actually deleted or moved (in the case of @samp{copy}
6035 and @samp{move}, the number is the one in the source folder, rather than
6036 the destination folder).
6038 @subsection Re-filing Reserved Messages
6040 The three standard functions copy reserved messages to the archive
6041 folder, but do not delete them from the source folder. Because
6042 reserved messages and the like always remain, they are recorded in
6043 @file{~/.elmo/expired-alist} so that they are not copied over and over
6044 again. They are not recorded if copied by @code{wl-summary-archive}.
6046 If you enabled logging, usually @samp{move} is recorded for re-filing,
6047 but instead @samp{copy} and @samp{delete} are recorded separately if
6048 reserved messages are involved. This is because it actually copies
6049 messages including reserved, then deletes ones except reserved in that
6052 @section Customizable Variables
6055 @item wl-expire-alist
6056 @vindex wl-expire-alist
6057 The initial setting is @code{nil}.
6058 This variable specifies folders and methods to expire. For details,
6059 refer to @code{wl-expire-alist} settings above.
6061 @item wl-summary-expire-reserve-marks
6062 @vindex wl-summary-expire-reserve-marks
6063 The initial setting is the list below.
6067 (list wl-summary-flag-mark
6068 wl-summary-new-uncached-mark
6069 wl-summary-new-cached-mark
6070 wl-summary-unread-uncached-mark
6071 wl-summary-unread-cached-mark)
6075 Messages with these marks are retained in the folder, even after
6077 Only permanent marks can be listed, not temporary marks.
6079 You can list marks one by one as in the default; you can use the
6080 following settings as well:
6084 All messages with permanent marks are retained,
6085 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
6089 All messages are handled as usual ones that are already read, no matter
6090 what marks they have; even important messages are deleted.
6093 @item wl-expire-archive-files
6094 @vindex wl-expire-archive-files
6095 The initial setting is 100.
6096 This variable specifies the number of messages to be retained in one
6099 @item wl-expire-number-with-reserve-marks
6100 @vindex wl-expire-number-with-reserve-marks
6101 The initial setting is @code{nil}.
6102 If non-nil, if expiring messages are specified by @code{number},
6103 messages with @code{wl-summary-expire-reserve-marks} are also retained.
6105 @item wl-expire-archive-get-folder-function
6106 @vindex wl-expire-archive-get-folder-function
6107 The initial setting is @code{wl-expire-archive-get-folder}.
6109 This variable specifies a function that returns the name of an archiving
6110 folder for standard functions in the place of @var{destination}.
6111 You can use the following three variables for simple modification of
6112 folder names; if you want more complex settings, define your own
6113 function in this variable.
6115 @code{wl-expire-archive-get-folder} can be customized by these
6118 @item @code{wl-expire-archive-folder-name-fmt}
6119 @item @code{wl-expire-archive-folder-type}
6120 @item @code{wl-expire-archive-folder-prefix}
6123 @item wl-expire-archive-folder-name-fmt
6124 @vindex wl-expire-archive-folder-name-fmt
6125 The initial setting is @samp{%s-%%05d;%s}.
6126 This is a @code{format} string for archiving folders used in
6127 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
6128 Note that you must specify the message number by @samp{%%d}, because it
6129 is parsed twice by @code{format}.
6131 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
6134 @item wl-expire-archive-date-folder-name-fmt
6135 @vindex wl-expire-archive-date-folder-name-fmt
6136 The initial setting is @samp{%s-%%04d%%02d;%s}.
6137 This is a @code{format} string for archiving folders used in
6138 @code{wl-expire-archive-date}. Note that you must specify the message
6139 number by @samp{%%d}, because it is parsed twice by @code{format}.
6140 There should be @samp{%%d} twice, one for the year and the other for the
6143 If you modify this, adjust
6144 @code{wl-expire-archive-date-folder-num-regexp} as well.
6146 @item wl-expire-archive-folder-type
6147 @vindex wl-expire-archive-folder-type
6148 The initial setting is @code{zip}.
6149 This variable specifies an archiver type of the archiving folders.
6151 @item wl-expire-archive-folder-prefix
6152 @vindex wl-expire-archive-folder-prefix
6153 The initial setting is @code{nil}.
6154 This variable specifies the prefix (directory structure) to archiving
6156 Exercise extreme caution in using this feature, as it has not been
6158 In the worst case, there is a fear of destructing archiving folders.
6162 There will be no prefix.
6165 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
6166 @samp{$ml/wl-00000;zip;wl}.
6169 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
6172 @samp{$ml/wl-00000;zip;ml/wl}.
6175 @item wl-expire-archive-folder-num-regexp
6176 @vindex wl-expire-archive-folder-num-regexp
6177 The initial setting is @samp{-\\([-0-9]+\\);}.
6178 This variable specifies the regular expression to be used for getting
6179 message numbers from multiple archiving folders specified by
6180 @code{elmo-list-folders}.
6181 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
6183 @item wl-expire-archive-date-folder-num-regexp
6184 @vindex wl-expire-archive-date-folder-num-regexp
6185 The initial setting is @samp{-\\([-0-9]+\\);}.
6186 This is the regular expression to be used for getting message numbers
6187 from multiple archiving folders specified by @code{elmo-list-folders}.
6188 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
6190 @item wl-expire-delete-oldmsg-confirm
6191 @vindex wl-expire-delete-oldmsg-confirm
6192 The initial setting is @code{t}.
6193 If non-nil, messages older than the one with the largest number will be
6194 deleted with confirmation.
6195 If @code{nil}, they are deleted without confirmation.
6197 This feature is valid only if non-nil is specified as a argument to the
6198 standard functions so as to retain numbers.
6200 @item wl-expire-use-log
6201 @vindex wl-expire-use-log
6202 The initial setting is @code{nil}.
6203 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
6204 They are appended but not truncated or rotated automatically; you might
6205 need to remove it manually.
6207 @item wl-expire-add-seen-list
6208 @vindex wl-expire-add-seen-list
6209 The initial setting is @code{t}.
6211 If non-nil, when messages are re-filed by expiration, read/unread
6212 information is passed to the destination folder.
6214 However if you do not read the destination folder from Wanderlust,
6215 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
6216 want to set this to @code{nil} if you are simply saving to some
6217 archiving folders. Even if its value is @code{nil}, messages in the
6218 archiving folders are simply treated as unread; it does not affect
6221 @item wl-expire-folder-update-msgdb
6222 @vindex wl-expire-folder-update-msgdb
6223 The initial setting is @code{t}.
6224 If @code{t}, in the folder mode, expiration is carried out after
6225 updating summary information. If you specified a list of regular
6226 expressions of folder names, summary information is updated for matching
6231 @node Archive, , Expire, Expire and Archive
6232 @section Archiving Messages
6234 @subsection Archiving Messages
6235 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
6236 folders. If there are the archiving folders already, only new messages
6239 You can use @code{wl-archive-alist} in order to specify how messages are
6240 archived according to their folder names, as in @code{wl-expire-alist}.
6245 (setq wl-archive-alist
6246 '(("^\\+tmp$" wl-archive-date)
6247 ("^\\+outbox$" wl-archive-number2)
6248 (".*" wl-archive-number1)))
6252 Each item in the list has the following format:
6255 (@var{folders-regexp} @var{deleting-function})
6258 As you can see, you can only use a function after @var{folders-regexp}.
6259 Per default, there are three functions:
6262 @item @code{wl-archive-number1}
6263 @item @code{wl-archive-number2}
6264 @item @code{wl-archive-date}
6267 As inferred from their names, they work similarly to "expire" versions,
6268 other than the following points:
6271 @item No messages are deleted
6272 @item Message numbers are retained even if invoked without arguments
6275 These functions are good to archive all messages in a folder by their
6276 numbers or by their dates.
6277 These are also useful for backup or confirmation purposes before
6279 If you try to re-file them after they are archived, they are deleted but
6282 Per default, the archiving folders to which messages are copied are
6283 determined automatically by @code{wl-expire-archive-get-folder-function}.
6284 You can copy to a specific folder by invoking with a prefix argument,
6285 i.e. @kbd{C-u M-x wl-summary-archive}.
6287 Note that this feature has not been seriously tested, because you can
6288 simply copy to an archiving folder, for example by
6289 @code{wl-summary-copy-region}.
6291 The archiving folders are determined by the same logic as in
6292 @code{wl-summary-expire}; the following customizable variables are
6296 @item @code{wl-expire-archive-files}
6297 @item @code{wl-expire-archive-get-folder-function}
6298 @item @code{wl-expire-archive-folder-name-fmt}
6299 @item @code{wl-expire-archive-folder-type}
6300 @item @code{wl-expire-archive-folder-prefix}
6301 @item @code{wl-expire-archive-folder-num-regexp}
6304 @subsection Customizable Variables
6307 @item wl-archive-alist
6308 @vindex wl-archive-alist
6309 The initial setting is the list shown below:
6313 ((".*" wl-archive-number1))
6318 This variable specifies a function that copies to archiving folders.
6319 To the function, three arguments are passed: a folder name, a list of
6320 messages in the folder, and msgdb information of the summary.
6321 Needless to say, you can use your own function.
6325 @node Scoring, Address Book, Expire and Archive, Top
6326 @chapter Score of the Messages
6328 @c @cindex Kill File
6330 Scoring is the function that associates a score (value) with each
6331 message, and marks as read or deletes from the summary according to it.
6333 You can put target or important marks on essential messages, or read marks
6334 on the ones you do not want to read, for example spam articles.
6336 This scoring function has a capability and a format similar to the one
6337 that Gnus has, although there are some unsupported features and
6338 Wanderlust specifics.
6339 @xref{Scoring, , ,gnus, The gnus Newsreader}.
6342 * Score Commands:: Score Commands
6343 * Score File Format:: Score File Format
6347 @node Score Commands, Score File Format, Scoring, Scoring
6348 @section Score Commands
6349 @cindex Score Commands
6351 @subsection Score File Specification
6353 @code{wl-score-folder-alist} specifies score files or variables in which
6354 scores are defined, corresponding to folder names.
6358 (setq wl-score-folder-alist
6367 If paths to the score files are omitted, the directory specified in the
6368 variable @code{wl-score-files-directory} is assumed.
6370 No matter what you write in @code{wl-score-folder-alist}, the default
6371 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
6372 read (it does not have to exist).
6373 Therefore, in the example above, the three score files,
6374 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
6375 the folders that matches @samp{^-.*}.
6377 @subsection Scored Messages
6379 Scores are attached to the messages that are specified by
6380 @code{wl-summary-score-marks} temporarily when the summary is updated;
6381 when you exit from the summary, the scores are removed and reverts to
6384 @subsection Creation of Score Files
6386 In the summary buffer, move to an appropriate message and type @kbd{L}.
6387 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
6388 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
6390 This makes @minus{}1000 are scored for messages with the same
6391 @samp{Subject:} as the string you entered. That is, such a score file
6392 is created automatically.
6394 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
6395 The score file you just made appears.
6396 This buffer is called @dfn{score editing buffer} thereafter.
6397 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
6398 as you are previously; type @kbd{a}. Then a score entry for "From"
6400 In this way, you can create a score file easily either in the summary
6401 buffer or in the score editing buffer.
6403 By the way, you might be aware the numbers of key strokes are different
6404 between @kbd{s s p} and @kbd{a}.
6405 This is determined by @code{wl-score-header-default-entry}.
6406 This variable specifies the default score entries corresponding to
6408 For example, for "subject" field, a type and a time limit are prompted,
6409 but for "from" field, they are fixed upon automatically as substring and
6410 permanent respectively.
6411 However, score values can be modified by the prefix argument.
6412 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
6415 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
6416 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
6417 erasing contents of the buffer deletes the score file being edited.
6421 @subsubsection Selecting Score Files
6423 You can change score files to which scores are appended by
6424 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
6425 @code{wl-score-change-score-file}.
6427 @subsubsection Summing Up the Score
6429 If you add the same entries by @code{wl-summary-increase-score},
6430 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
6431 scores for the entry is summed up.
6433 For example, if you create @samp{from} entry with the score of @minus{}1000 by
6434 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
6435 @minus{}1200 will be created as a result.
6437 @subsubsection Creating Thread Key
6439 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
6440 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6442 @subsubsection Creating Followup Key
6444 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6445 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6446 at the cursor to @samp{References} key.
6447 If @code{wl-score-auto-make-followup-entry} is non-nil,
6448 @samp{Message-ID} of all messages to be followed up within dates
6449 specified by @code{wl-score-expiry-days}.
6451 @subsection Key Bindings
6456 @findex wl-summary-increase-score
6457 Increases the score for the current message.
6458 And the score entry is appended to the score file at the same moment.
6459 You can specify the score value by a prefix argument.
6463 @findex wl-summary-lower-score
6464 Decreases the score for the current message.
6465 And the score entry is appended to the score file at the same moment.
6466 You can specify the score value by a prefix argument.
6469 @kindex h R (Summary)
6470 @findex wl-summary-rescore
6471 Re-applies the scoring.
6472 However, already scored messages are not scored anew.
6475 @kindex h c (Summary)
6476 @findex wl-score-change-score-file
6477 Changes the score file currently selected.
6480 @kindex h e (Summary)
6481 @findex wl-score-edit-current-scores
6482 Edits the score file currently selected.
6483 If there are multiple score files, the previously specified one is
6487 @kindex h f (Summary)
6488 @findex wl-score-edit-file
6489 Edits an arbitrary score file and selects it.
6492 @kindex h F (Summary)
6493 @findex wl-score-flush-cache
6494 Erases caches associated to the score files that are read.
6495 If you modified score files directly (from other than Wanderlust), you
6496 need to re-read them after erasing the cache.
6499 @kindex h m (Summary)
6500 @findex wl-score-set-mark-below
6501 Specifies the criterion for scores to be marked as read.
6502 Messages with scores less than this value are marked as read.
6505 @kindex h x (Summary)
6506 @findex wl-score-set-expunge-below
6507 Specifies the criterion for scores to be deleted from the summary.
6508 Messages with scores less than this value are deleted.
6509 "Deleted" means it is not shown; they are not removed from the summary
6510 information or the folder.
6511 The deleted messages can be shown by rescan-noscore again.
6514 @subsection Key Bindings in the Score Editing Buffer
6518 @kindex C-c C-k (Score Mode)
6519 @findex wl-score-edit-kill
6520 Abandons the file being edited.
6523 @kindex C-c C-c (Score Mode)
6524 @findex wl-score-edit-exit
6525 Saves the file being edited, and quits from the edit mode.
6528 @kindex C-c C-p (Score Mode)
6529 @findex wl-score-pretty-print
6533 @kindex C-c C-d (Score Mode)
6534 @findex wl-score-edit-insert-date
6535 Inserts the number of dates from Dec. 31, 1 B.C.
6536 It is used for creating the third factor of time-limited scores.
6539 @kindex C-c C-s (Score Mode)
6540 @findex wl-score-edit-insert-header
6541 Inserts the header of the message selected in the summary buffer.
6544 @kindex C-c C-e (Score Mode)
6545 @findex wl-score-edit-insert-entry
6546 Inserts the score entry of the message selected in the summary buffer.
6549 @subsection Customizable Variables
6552 @item wl-summary-default-score
6553 @vindex wl-summary-default-score
6554 The initial setting is 0 (zero).
6555 This variable specifies the default value of the score.
6556 The score is increased or decreased based upon this value.
6558 @item wl-summary-important-above
6559 @vindex wl-summary-important-above
6560 The initial setting is @code{nil}.
6561 Messages with scores larger than this value are attached with the
6562 important mark (@samp{$}).
6563 If @code{nil}, no important marks are attached.
6565 @item wl-summary-target-above
6566 @vindex wl-summary-target-above
6567 The initial setting is @code{nil}.
6568 Messages with scores larger than this value are attached with the target
6570 If @code{nil}, no target marks are attached.
6572 @item wl-summary-mark-below
6573 @vindex wl-summary-mark-below
6574 The initial setting is 0 (zero).
6575 Messages with scores smaller than this value are marked as read.
6577 @item wl-summary-expunge-below
6578 @vindex wl-summary-expunge-below
6579 The initial setting is @code{nil}.
6580 Messages with scores smaller than this value are deleted from the
6582 If @code{nil}, they are not deleted.
6584 @item wl-summary-score-marks
6585 @vindex wl-summary-score-marks
6586 The initial setting is the list shown below:
6590 (list wl-summary-new-uncached-mark
6591 wl-summary-new-cached-mark)
6596 Messages with these marks are scored.
6598 @item wl-use-scoring
6599 @vindex wl-use-scoring
6600 The initial setting is t.
6601 If non-nil, scoring is enabled.
6603 @item wl-score-files-directory
6604 @vindex wl-score-files-directory
6605 The initial setting is @file{~/.elmo/}.
6606 The default directory for score files.
6608 @item wl-score-interactive-default-score
6609 @vindex wl-score-interactive-default-score
6610 The initial setting is 1000.
6611 This value is used as a score when a score factor is @code{nil} in the
6612 score file. It is also used in @code{wl-summary-increase-score} and
6613 @code{wl-summary-lower-score}, on condition that the value of
6614 @code{wl-score-header-default-entry} is @code{nil}.
6616 @item wl-score-expiry-days
6617 @vindex wl-score-expiry-days
6618 The initial setting is 7.
6619 This is the number of days before time-limited scores are deleted.
6621 @item wl-score-update-entry-dates
6622 @vindex wl-score-update-entry-dates
6623 The initial setting is @code{t}.
6624 If non-nil, it enables deletion of time-limited scores.
6626 @item wl-score-header-default-entry
6627 @vindex wl-score-header-default-entry
6628 Specifies the default value for each header field for score entries
6629 created by @code{wl-summary-increase-score},
6630 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6632 @item wl-score-simplify-fuzzy-regexp
6633 @vindex wl-score-simplify-fuzzy-regexp
6634 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6635 regular expression to be deleted from the string.
6636 Because this is usually used for Subject, the default is prefixes that
6637 are attached by mailing list programs.
6639 @item wl-summary-rescore-partial-threshold
6640 @vindex wl-summary-rescore-partial-threshold
6641 The initial setting is 200.
6642 When sync-all or rescan is executed, if there are messages more than
6643 this value, only the last same number of messages as this value are
6646 @item wl-summary-auto-sync-marks
6647 @vindex wl-summary-auto-sync-marks
6648 If non-nil, unread/important marks are synchronized when the summary
6650 Unread marks reflect information on the IMAP4 server.
6651 Important marks reflect information on the IMAP4 server (flagged or
6652 not), and contents of @samp{'flag} folder.
6653 The initial setting is @code{t}.
6657 @node Score File Format, , Score Commands, Scoring
6658 @section Score File Format
6659 @cindex Score File Format
6661 The format of score files are the same as Gnus, and basically you can
6662 use Gnus score files as they are. But they are not fully compatible
6663 because some keys are not supported and there are Wanderlust specifics.
6664 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6669 ("for sale" -1000 nil s)
6670 ("profit" -1000 nil s))
6672 ("spam@@spamspamspam" -10000 nil s))
6674 ("my@@address" 3001 nil s))
6676 (1000000 -10 nil >))
6686 If the key is a string, it is the name of the header to be matched.
6687 The following keys are available:
6688 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6689 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6690 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6691 @code{Chars} and @code{Lines} mean the size and the number of lines of
6692 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6693 are described later.
6694 The rest corresponds the field of the same name.
6696 Arbitrary numbers of core entries are specified after the key.
6697 Each score entry consists of these five factors:
6701 A factor that matches header. This should be a number in the cases of
6702 @code{lines} and @code{chars}, otherwise a string.
6705 A score factor. When the first item matches, the score of the message
6706 is increased or decreased by this value.
6709 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6710 of a number, the score is deleted if it does not match for days
6711 (@code{wl-score-expiry-days}) from the date specified by this.
6712 The date is since Dec. 31, 1 B.C.
6715 A type factor. This specifies the way the first factor matches.
6716 Available types depend on keys.
6719 @item From, Subject, References, Message-ID
6720 For these keys in string, @code{r} and @code{R} (regexp),
6721 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6722 as well as @code{f} and @code{F} (fuzzy) can be used.
6723 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6726 For these keys, the following five numerical relative operators can be
6727 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6730 This key matches @code{From} header, and scores all follow-ups to the
6732 For example, it would be useful for increasing scores for follow-ups to
6735 You can use the same types as @code{From} except for @code{f}.
6736 And a @samp{Followup} entry is automatically appended to the score file.
6739 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6740 A @samp{Thread} entry is automatically appended for each article that
6741 has @var{x} in the @code{References} header.
6742 You can make sure the whole thread including messages that does not have
6743 all ancestors @code{Message-ID} in @code{References} is scored.
6745 You can use the same types as @code{References} except for @code{f}.
6746 And a @samp{Thread} entry is automatically appended to the score file.
6750 A factor for extension header. This is meaningful only if the key is
6752 This specifies headers to be matched other than standard headers like
6753 @code{Subject} and @code{From}.
6754 Note that you should specify the header in
6755 @code{elmo-msgdb-extra-fields} also.
6756 Therefore it does not work in folders where extension headers cannot be
6761 The sum of these scores @emph{after all factors are applied} becomes the
6762 score of the message.
6764 @cindex Score File Atoms
6766 Messages with a score less than this value is marked as read.
6767 The default is @code{wl-summary-mark-below}.
6770 Messages with a score less than this value is deleted from the summary.
6771 The default is @code{wl-summary-expunge-below}.
6773 @item mark-and-expunge
6774 Both @code{mark} and @code{expunge} are applied,
6775 i.e. messages with a score less than this value is marked as read and
6776 deleted from the summary.
6779 Messages with a score greater than this value is attached with temp
6781 The default is @code{wl-summary-target-above}.
6784 Messages with a score greater than this value is attached with important
6786 The default is @code{wl-summary-important-above}.
6791 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6792 are used, you need to set @code{elmo-msgdb-extra-fields}.
6795 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6798 There are other restrictions as shown below:
6801 @item Because @samp{References} field in the summary information
6802 contains only the last @samp{Message-ID}, @code{references} key matches
6806 Keys that can be seen by folder of types:
6810 chars lines xref extra
6811 localdir,localnews Y E E E
6812 nntp (supporting xover) Y E E N
6818 N: cannot be seen (ignored)
6819 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6824 @node Address Book, Spam Filter, Scoring, Top
6825 @chapter Address Book
6826 @cindex Address Book
6828 With address book, you can utilize address completion, and you have
6829 summary displayed with nicknames.
6832 * Mail Addresses:: Definition of Address Book
6833 * Address Manager:: Address Manager
6837 @node Mail Addresses, Address Manager, Address Book, Address Book
6838 @section Address book
6839 @cindex Address book Definition
6841 @cindex Alias, Address
6843 The file @file{~/.addresses} is a simple address book for Wanderlust.
6844 Make address file @file{~/.addresses}, and edit to suit your requirement.
6846 The data written in @file{~/.addresses} are used for address completion
6847 under draft editing mode. Furthermore, they are used when showing names
6848 in summary display mode. You can safely skip this section, if you don't
6849 want to customize address completion and summary display.
6850 It is possible to add/change/remove addresses from @file{~/.addresses} in
6851 summary buffer after Wanderlust is invoked. @refill
6853 The format is very simple. Like this. @refill
6858 # @r{Lines begin with @samp{#} are comment.}
6859 # @r{Empty lines are ignored}
6861 # @r{Format of each line:}
6862 # @var{email-address} "@var{nickname} "@var{realname}"
6864 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6865 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6866 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6871 One line defines one persons description.
6873 Actually, in default setup, @var{nickname} is used in summary-mode and
6874 @var{realname} is used in draft preparation mode. This behavior is
6875 better understood if you try it and confirmed the function first. You
6876 can write and try a small definition, so you will know the idea of the
6877 address book before writing a big one.
6879 And, if MH alias file is specified in variable @code{wl-alias-file},
6880 it is used as an address information in the draft preparation mode.
6882 If variable @code{wl-use-ldap} is non-nil (initial setting is
6883 @code{nil}), address completion in draft mode uses LDAP information.
6885 If you use LDAP, you have to set @code{wl-ldap-server},
6886 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6887 not have LDAP feature as built-in feature (Currently only XEmacs can
6888 have built-in LDAP feature), you have to set command exec @env{PATH} to
6889 the program @command{ldapsearch}.
6892 @node Address Manager, , Mail Addresses, Address Book
6893 @section Address Manager
6894 @cindex Address Manager
6896 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6897 the address book and insert address to draft buffer.
6899 @subsection Key Bindings
6903 @kindex t (Address Manager)
6904 @findex wl-addrmgr-set-to
6905 Add @samp{To:} mark.
6908 @kindex c (Address Manager)
6909 @findex wl-addrmgr-set-cc
6910 Add @samp{Cc:} mark.
6913 @kindex b (Address Manager)
6914 @findex wl-addrmgr-set-bcc
6915 Add @samp{Bcc:} mark.
6918 @kindex u (Address Manager)
6919 @findex wl-addrmgr-unmark
6923 @kindex x (Address Manager)
6924 @findex wl-addrmgr-apply
6926 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6927 buffer and quit address manager. When no draft buffer, make new draft
6928 with insert marked addresses.
6930 If no mark, quit address manager.
6934 @kindex q (Address Manager)
6935 @findex wl-addrmgr-quit
6936 Quit address manager.
6939 @kindex a (Address Manager)
6940 @findex wl-addrmgr-add
6944 @kindex d (Address Manager)
6945 @findex wl-addrmgr-delete
6949 @kindex e (Address Manager)
6950 @findex wl-addrmgr-edit
6955 @node Spam Filter, Advanced Issues, Address Book, Top
6956 @chapter Spam Filter
6959 @code{wl-spam} provides an frontend to external spam filtering programs.
6960 You can register to or judge spam by the filtering program cooperateing
6961 with messages operations on Wanderlust.
6964 * Usage of Spam Filter:: Usage of Spam Filter
6965 * Spam Filter Processors:: Supported spam filters
6968 @node Usage of Spam Filter, Spam Filter Processors, Spam Filter, Spam Filter
6969 @section Usage of Spam Filter
6971 @subsection Initial Setting
6973 To use @code{wl-spam}, write in @file{~/.wl} as follows:
6977 ;; @r{Use @samp{bogofilter} as spam back end}
6978 ;; @r{Set @samp{scheme} here as the spam filter you will use.}
6979 ;; @r{@xref{Spam Filter Processors}.}
6980 (setq elmo-spam-scheme 'bogofilter)
6985 @subsection spam mark
6987 The spam mark (@samp{s}) will be provided as new temporary mark.
6988 Messages marked by this will be refiled into @code{wl-spam-folder} when
6989 the action is called for execution. Marked messages will be skipped by
6990 summary walking in ordinary way.
6992 The spam mark is be put on by spam judgement described later, or by
6993 invoking @kbd{k m} at any time.
6995 @subsection spam judgment
6997 You can judge spam messages by following ways:
7001 Make judgement on execution of auto-refile.
7003 Insert @code{wl-refile-guess-by-spam} to arbitrary position in
7004 @code{wl-auto-refile-guess-functions} as follows.
7008 (setq wl-auto-refile-guess-functions
7009 '(wl-refile-guess-by-rule
7010 wl-refile-guess-by-spam))
7014 In this example, judge spam if it could not decide refile destination by
7015 @code{wl-refile-rule-alist}.
7018 Make judgement on entering the summary of specified folder.
7020 Specify the value of @code{wl-spam-auto-check-folder-regexp-list}
7021 as the list of regular expressions for folder names to be
7022 automatically judged by spam filter.
7025 (setq wl-spam-auto-check-folder-regexp-list '("\\+inbox"))
7028 In this example, judgement will be processed when you enter summary of
7029 the folder whose name contains @samp{+inbox}.
7032 Make judgement on splitting messages with @code{elmo-split}.
7034 It provides new function @code{spam-p} to be specified as @samp{CONDITION}
7035 in @code{elmo-split-rule}. This function returns true when the message
7037 @xref{Split messages}.
7039 You can also process learning by the result of judgement. (You would
7040 better turn on this feature after learning to some extent)
7046 (setq elmo-split-rule
7047 '(((spam-p) "+spam")
7048 ;; @r{to learn by the judgement, use following instead}
7049 ;((spam-p :register t) "+spam")
7055 @subsection spam learning
7057 @code{wl-spam} automatically learn spam with refiling messages.
7059 At first, @code{wl-spam} classifies the folders controlled by Wanderlust
7060 into following 4 domains by the class of containig messages
7064 Folders containing messages judged as spam.
7065 (The folder specified by @code{wl-spam-folder})
7067 Folders containing messages judged as non-spam.
7069 Folders containing messages not yet judged. Folders without
7070 pre-distribution may belong to this domain e.g. @samp{+inbox}.
7071 (specified by @code{wl-spam-undecided-folder-regexp-list})
7073 Foldes have nothing to do with spam processing e.g.
7074 @code{wl-trash-folder} or @code{wl-draft-folder}. (specified by
7075 @code{wl-spam-ignored-folder-regexp-list})
7078 When you refile messages across different domains, it automatically
7079 learn messages as @samp{spam} or @samp{non-spam} according to domains
7080 it belongs before and after.
7082 To put it concretely, it will learn by following rule:
7085 @item undecide -> spam
7088 learn as spam and cancel previous study as non-spam.
7089 @item undecide -> good
7092 learn as non-spam and cancel previous study as spam.
7095 It do not learn anything in other cases.
7097 @subsection Key Bindings
7098 @cindex Keybind, spam filter
7102 @kindex k m (Summary)
7103 @findex wl-summary-spam
7104 Put spam mark (@samp{s}) on current message.
7107 @kindex k c (Summary)
7108 @findex wl-summary-test-spam
7109 Test current message and put spam mark if judged as spam.
7112 @kindex r k c (Summary)
7113 @findex wl-summary-test-spam-region
7114 Test messages in the specified region and put spam mark if judged as spam.
7117 @kindex k C (Summary)
7118 @findex wl-summary-mark-spam
7119 Test messages with the mark in @code{wl-spam-auto-check-marks},
7120 and put spam mark if judged as spam. If it is called with prefix
7121 argument, test all messages regardless of their marks.
7124 @kindex k s (Summary)
7125 @findex wl-summary-register-as-spam
7126 Register current message as spam.
7129 @kindex k S (Summary)
7130 @findex wl-summary-register-as-spam-all
7131 Register all messages in the folder as spam.
7134 @kindex k n (Summary)
7135 @findex wl-summary-register-as-good
7136 Register current message as non-spam.
7139 @kindex k N (Summary)
7140 @findex wl-summary-register-as-good-all
7141 Register all messages in the folder as non-spam.
7144 @kindex m k (Summary)
7145 @findex wl-summary-target-mark-spam
7146 Put spam mark (@samp{s}) on messages with the target mark @samp{*}.
7149 @kindex m s (Summary)
7150 @findex wl-summary-target-mark-register-as-spam
7151 Register messages with the target mark @samp{*} as spam.
7154 @kindex m n (Summary)
7155 @findex wl-summary-target-mark-register-as-good
7156 Register messages with the target mark @samp{*} as non-spam.
7159 @subsection Customizable Variables
7162 @item wl-spam-folder
7163 @vindex wl-spam-folder
7164 Specify the name of destination folder for the spam messages.
7165 The initial setting is @samp{+spam}.
7167 @item wl-spam-undecided-folder-regexp-list
7168 @vindex wl-spam-undecided-folder-regexp-list
7169 Specify the list of regexp of folder names which contain messages
7170 not yet decided as spam or non-spam.
7171 The initial setting is @code{'("inbox")}.
7173 @item wl-spam-ignored-folder-regexp-list
7174 @vindex wl-spam-ignored-folder-regexp-list
7175 The initial setting is as follows.
7179 (list (regexp-opt (list wl-draft-folder
7185 Folders of no effect against spam judgement, specified by the list of
7186 folder name regular expressions.
7188 @item wl-spam-auto-check-folder-regexp-list
7189 @vindex wl-spam-auto-check-folder-regexp-list
7190 Folders to make spam judgement on entering the summary of them,
7191 specified by the list of folder name regular expressions.
7192 The initial setting is @code{nil}.
7194 @item wl-spam-auto-check-marks
7195 @vindex wl-spam-auto-check-marks
7196 The initial setting is the following list:
7200 (list wl-summary-new-uncached-mark
7201 wl-summary-new-cached-mark)
7205 Messages with mark specified by this variable will be processed
7206 by whole-folder judgement including auto test by
7207 @code{wl-spam-auto-check-folder-regexp-list}.
7208 Persistent marks can be used in this method, but temporary marks cannot.
7210 You can specify the list of marks as the initial setting, or you can
7211 specify follwing symbol:
7215 Process all messages regardless of persistent marks.
7220 @node Spam Filter Processors, , Usage of Spam Filter, Spam Filter
7221 @section Supported Spam Filters
7222 @cindex Spam Filter, Bogofilter
7223 @cindex Spam Filter, Spamfilter
7225 Supported spam filtering libraries are following ones.
7228 * bogofilter:: bogofilter
7229 * spamfilter:: spamfilter.el
7230 * bsfilter:: bsfilter
7231 * SpamAssassin:: SpamAssassin
7232 * SpamOracle:: SpamOracle
7233 * Regular Expressions Header Matching:: Header regexp
7237 @node bogofilter, spamfilter, Spam Filter Processors, Spam Filter Processors
7238 @subsection bogofilter
7241 bogofilter (@uref{http://bogofilter.sourceforge.net/}) is a spam filter
7242 implemented by C language.
7244 To use spam filter with bogofilter, write following setting in
7245 @file{~/.wl} or somewhere else.
7249 (setq elmo-spam-scheme 'bogofilter)
7253 @subsubsection Customizable Variables
7256 @item elmo-spam-bogofilter-program
7257 @vindex elmo-spam-bogofilter-program
7258 The initial setting is @file{bogofilter}.
7259 Specify the name of executable of bogofilter. If the executable
7260 is not in your environmental variable @env{PATH}, you should
7261 set this by full path.
7263 @item elmo-spam-bogofilter-args
7264 @vindex elmo-spam-bogofilter-args
7265 The initial setting is @code{nil}.
7266 Specify arguments to be supplied for bogofilter executable.
7268 @item elmo-spam-bogofilter-database-directory
7269 @vindex elmo-spam-bogofilter-database-directory
7270 Specify the directory for statistical database to be used.
7271 @code{nil} to use default directory (@file{~/.bogofilter}).
7272 The initial setting is @code{nil}.
7274 @item elmo-spam-bogofilter-max-messages-per-process
7275 @vindex elmo-spam-bogofilter-max-messages-per-process
7276 The initial setting is 30. This variable specifies the number of
7277 messages to be learned by one process.
7279 @item elmo-spam-bogofilter-debug
7280 @vindex elmo-spam-bogofilter-debug
7281 The initial setting is @code{nil}.
7282 If you specify non-nil, the output from @command{bogofilter} is
7283 stored in the buffer named @code{"*Debug ELMO SPAM Bogofilter*"}.
7287 @node spamfilter, bsfilter, bogofilter, Spam Filter Processors
7288 @subsection spamfilter.el
7291 @file{spamfilter.el}
7292 (@uref{http://www.geocities.co.jp/SiliconValley-PaloAlto/7043/}) is a
7293 spam filtering library implemented by Emacs Lisp.
7295 Corresponding modules will be compiled/installed, if you have
7296 @file{spamfilter.el} within @code{load-path} when you are to install wl.
7299 To use @file{spamfilter.el}, write following setting in @file{~/.wl} or
7301 (Of cource, you have to have settings for @file{spamfilter.el} itself)
7305 (setq elmo-spam-scheme 'spamfilter)
7309 @subsubsection Customizable Variables
7312 @item elmo-spam-spamfilter-corpus-filename
7313 @vindex elmo-spam-spamfilter-corpus-filename
7314 The initial setting is @file{~/.elmo/.spamfilter}.
7315 It specifies the name of corpus file.
7318 @node bsfilter, SpamAssassin, spamfilter, Spam Filter Processors
7319 @subsection bsfilter
7322 bsfilter (@uref{http://bsfilter.org/index-e.html}) is a spam filter
7323 implemented by Ruby language.
7325 To use spam filter with bsfilter, write following setting in
7326 @file{~/.wl} or somewhere else.
7330 (setq elmo-spam-scheme 'bsfilter)
7334 @subsubsection Customizable Variables
7337 @item elmo-spam-bsfilter-program
7338 @vindex elmo-spam-bsfilter-program
7339 The initial setting is @file{bsfilter}.
7340 Specify the name of executable of @command{bsfilter}. If the executable
7341 is not in your environmental variable @env{PATH}, you should
7342 set this by full path.
7344 @item elmo-spam-bsfilter-args
7345 @vindex elmo-spam-bsfilter-args
7346 The initial setting is @code{nil}.
7347 Specify arguments to be supplied for bsfilter executable.
7349 @item elmo-spam-bsfilter-database-directory
7350 @vindex elmo-spam-bsfilter-database-directory
7351 Specify the directory for statistical database to be used.
7352 @code{nil} to use default directory (@file{~/.bsfilter}).
7353 The initial setting is @code{nil}.
7355 @item elmo-spam-bsfilter-debug
7356 @vindex elmo-spam-bsfilter-debug
7357 The initial setting is @code{nil}.
7358 If you specify non-nil, the output from @command{bsfilter} is
7359 stored in the buffer named @code{"*Debug ELMO Bsfilter*"}.
7361 @item elmo-spam-bsfilter-shell-program
7362 @vindex elmo-spam-bsfilter-shell-program
7363 The initial setting is @file{ruby}.
7364 Specify the shell to execute @command{bsfilter}. If the shell is not
7365 in your environmental variable @env{PATH}, you should set this by full path.
7367 @item elmo-spam-bsfilter-shell-switch
7368 @vindex elmo-spam-bsfilter-shell-switch
7369 The initial setting is @code{nil}.
7370 Specify options to give to the shell executing @command{bsfilter}.
7372 @item elmo-spam-bsfilter-update-switch
7373 @vindex elmo-spam-bsfilter-update-switch
7374 The initial setting is @code{"--synchronous-auto-update"}.
7375 Specify options to give to @command{bsfilter} for learning messages.
7379 @node SpamAssassin, SpamOracle, bsfilter, Spam Filter Processors
7380 @subsection SpamAssassin
7381 @cindex SpamAssassin
7383 SpamAssassin (@uref{http://spamassassin.org/}) is one of the most
7384 popular spam filtering program implemented on Perl. SpamAssassin
7385 attempts to identify spam using text analysis and several internet-based
7386 realtime blacklists. SpamAssassin also uses a Bayesian learning filter
7387 which enables more accurate spam filtering.
7389 To use @file{SpamAssassin} on Wanderlust, write following setting
7390 in @file{~/.wl} or somewhere else.
7391 (Of course, you have to install SpamAssassin beforehand.)
7395 (setq elmo-spam-scheme 'sa)
7399 @subsubsection Customize Variables
7402 @item elmo-spam-spamassassin-program
7403 @vindex elmo-spam-spamassassin-program
7404 The initial setting is @file{spamassassin}.
7405 Specify the name of executable @command{spamassassin}. If the executable
7406 is not in your environmental variable @env{PATH}, you should
7407 set this by full path.
7409 @item elmo-spam-spamassassin-learn-program
7410 @vindex elmo-spam-spamassassin-learn-program
7411 The initial setting is @file{sa-learn}.
7412 Specify the name of the SpamAssassin's Bayesian filtering learner
7413 program, @command{sa-learn}. If the executable is not in your
7414 environmental variable @env{PATH}, you should set this by full path.
7416 @item elmo-spam-spamassassin-program-arguments
7417 @vindex elmo-spam-spamassassin-program-arguments
7418 The initial setting is @code{'("-e")}.
7419 Specify the arguments to be supplied for @command{spamassassin} executable.
7420 You have to specify the argument to exit the program with an error exit code
7421 when the result is spam. For example, if you want to use @command{spamc}
7422 instead of @command{spamassassin}, you should specify @code{'("-c")}.
7424 @item elmo-spam-spamassassin-learn-program-arguments
7425 @vindex elmo-spam-spamassassin-lern-program-arguments
7426 The initial setting is @code{nil}.
7427 Specify the arguments to be supplied for @command{sa-learn}.
7429 @item elmo-spamassassin-debug
7430 @vindex elmo-spamassassin-debug
7431 The initial setting is @code{nil}.
7432 If you specify @code{t}, the output from @command{spamassassin} is
7433 stored in the buffer named @code{"*Debug ELMO SpamAssassin*"}.
7437 @node SpamOracle, Regular Expressions Header Matching, SpamAssassin, Spam Filter Processors
7438 @subsection SpamOracle
7441 SpamOracle (`http://pauillac.inria.fr/~xleroy/software.html#spamoracle')
7442 is a spam filter implemented by Objective Caml language.
7444 To use spam filter with @file{spamoracle}, write following setting in
7445 @file{~/.wl} or somewhere else.
7446 (Of course, you have to install SpamOracle beforehand.)
7450 (setq elmo-spam-scheme 'spamoracle)
7454 @subsubsection Customizable Variables
7457 @item elmo-spam-spamoracle-program
7458 @vindex elmo-spam-spamoracle-program
7459 The initial setting is @file{spamoracle}. Specify the name of
7460 executable of spamoracle. If the executable is not in your
7461 environmental variable @env{PATH}, you should set this by full path.
7463 @item elmo-spam-spamoracle-config-filename
7464 @vindex elmo-spam-spamoracle-config-filename
7465 Specify the name of config file. @code{nil} to use default file
7466 (@file{~/.spamoracle.conf}). The initial setting is @code{nil}.
7468 @item elmo-spam-spamoracle-database-filename
7469 @vindex elmo-spam-spamoracle-database-filename
7470 The initial setting is @file{~/.elmo/.spamoracle.db}.
7471 It specifies the name of database file.
7473 @item elmo-spam-spamoracle-spam-header-regexp
7474 @vindex elmo-spam-spamoracle-spam-header-regexp
7475 The initial setting is @code{"^X-Spam: yes;"}. It specifies the regular
7476 expression of the header that indicates spam mail. Use this setting
7477 when you change the @code{spam_header} parameter in the config file.
7481 @node Regular Expressions Header Matching, , SpamOracle, Spam Filter Processors
7482 @subsection Regular Expressions Header Matching
7483 @cindex Regular Expressions Header Matching
7485 Examine if regular expression matches corresponding field in message heaeder,
7486 and decide spam or not. To use this backend, add following setting to @file{~/.wl}.
7490 (setq elmo-spam-scheme 'header)
7494 If you want to check fields not included in the default overview
7495 information, add one into @code{elmo-msgdb-extra-fields}. Then it will
7496 do examination by the overview information and avoid loading whole
7497 message body as far as possible.
7499 @subsubsection Customize Variables
7502 @item elmo-spam-header-good-alist
7503 @vindex elmo-spam-header-good-alist
7504 The initial setting is the following list:
7507 '(("X-Spam-Flag" . "No"))
7510 Specify a list of regular expressions to match with header field name
7511 for making non-spam decision. It takes precedence over
7512 @code{elmo-spam-header-spam-alist}.
7514 @item elmo-spam-header-spam-alist
7515 @vindex elmo-spam-header-spam-alist
7516 The initial setting is the following list:
7519 '(("X-Spam-Flag" . "Yes"))
7522 Specify a list of regular expressions to match with header field name
7523 for making spam decision.
7527 @node Advanced Issues, Migration, Spam Filter, Top
7528 @chapter Advanced Issues
7529 @cindex Advanced Issues
7532 * Living with other packages:: Cooperating with other packages
7533 * Highlights:: Highlights
7534 * Biff:: Notify Mail arrival
7535 * Password Management:: Manage Passwords
7536 * Split messages:: Splitting messages
7537 * Batch Processing:: Invoke commands in batch mode
7538 * Advanced Settings:: Advanced Settings
7539 * Customizable Variables:: Customizable Variables
7544 @node Living with other packages, Highlights, Advanced Issues, Advanced Issues
7545 @section Living with other packages
7547 Examples with other packages.
7550 * imput:: imput (im-wl.el)
7551 * BBDB:: The Insidious Big Brother Database
7552 * LSDB:: The Lovely Sister Database
7553 * supercite:: supercite.el
7554 * mu-cite:: mu-cite.el
7555 * X-Face:: x-face,bitmap-mule
7556 * dired-dd:: dired-dd.el
7558 * Addrbook:: Addrbook
7559 * mime-w3m:: mime-w3m.el
7563 @node imput, BBDB, Living with other packages, Living with other packages
7568 Place @file{util/im-wl.el} on the @code{load-path} and do the following
7573 (autoload 'wl-draft-send-with-imput-async "im-wl")
7574 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
7579 @node BBDB, LSDB, imput, Living with other packages
7583 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
7584 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
7585 and do the following settings.
7587 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
7588 byte-compiled and installed.
7596 ;; @r{enable pop-ups}
7597 (setq bbdb-use-pop-up t)
7598 ;; @r{auto collection}
7599 (setq bbdb/mail-auto-create-p t)
7600 ;; @r{exceptional folders against auto collection}
7601 (setq bbdb-wl-ignore-folder-regexp "^@@")
7602 (setq signature-use-bbdb t)
7603 (setq bbdb-north-american-phone-numbers-p nil)
7604 ;; @r{shows the name of bbdb in the summary} :-)
7605 (setq wl-summary-from-function 'bbdb-wl-from-func)
7606 ;; @r{automatically add mailing list fields}
7607 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
7608 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
7612 You can complete address with BBDB by @kbd{M-@key{TAB}}
7616 @node LSDB, supercite, BBDB, Living with other packages
7620 The following is an example setting to use
7621 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
7628 (add-hook 'wl-draft-mode-hook
7630 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
7634 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
7635 (complete address with LSDB).
7638 @node supercite, mu-cite, LSDB, Living with other packages
7639 @subsection sc.el(supercite), sc-register.el
7643 The same setting as usual mailers should be OK. The following is an
7644 example of settings:
7648 (autoload 'sc-cite-original "supercite" nil t)
7649 (add-hook 'mail-citation-hook 'sc-cite-original)
7654 @node mu-cite, X-Face, supercite, Living with other packages
7655 @subsection mu-cite.el
7658 The same setting as usual mailers should be OK. The following is an
7659 example of settings.
7661 If you use mu-cite version 8.0 or earlier:
7665 (autoload 'mu-cite/cite-original "mu-cite" nil t)
7666 (setq mail-citation-hook 'mu-cite/cite-original)
7670 If you use mu-cite version 8.1 or later:
7674 (autoload 'mu-cite-original "mu-cite" nil t)
7675 (add-hook 'mail-citation-hook (function mu-cite-original))
7679 @node X-Face, dired-dd, mu-cite, Living with other packages
7683 If you have installed one of the following, you can decode
7684 @samp{X-Face:} field in message buffer and you will see face image.
7687 * x-face-xmas:: XEmacs case
7688 * x-face-mule:: Emacs case
7691 If there is an encoded X-Face string in a file @file{~/.xface} (the
7692 value of the variable @code{wl-x-face-file}), it is inserted as a
7693 @samp{X-Face:} field in the draft buffer (if
7694 @code{wl-auto-insert-x-face} is non-nil).
7696 @node x-face-xmas, x-face-mule, X-Face, X-Face
7697 @subsubsection x-face-xmas (for XEmacs)
7700 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
7701 1.3.6.13 or later, do the following:
7705 (autoload 'x-face-xmas-wl-display-x-face "x-face")
7706 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
7710 @node x-face-mule, , x-face-xmas, X-Face
7711 @subsubsection x-face-mule (for Emacs)
7715 If you use @file{x-face-mule.el} in bitmap-mule
7716 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
7720 (autoload 'x-face-decode-message-header "x-face-mule")
7721 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7725 @subsubsection x-face-e21 (for Emacs 21.x)
7728 With Emacs 21.x, you can use @file{x-face-e21.el}
7729 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
7730 to display X-Face. In this case, bitmap-mule is not required.
7735 (autoload 'x-face-decode-message-header "x-face-e21")
7736 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7741 @node dired-dd, MHC, X-Face, Living with other packages
7742 @subsection dired-dd(Dired-DragDrop)
7743 @pindex Dired-DragDrop
7745 @cindex Drag and Drop
7747 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
7748 compose multi-part by simple Drag-and-Drop from dired to the draft
7749 buffer being edited in GNU Emacs (this feature is not Wanderlust
7750 specific, but general-purpose for SEMI).
7754 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
7760 ;; @r{Set dired-x variables here.}
7761 ;; @r{To and flo@dots{}}
7763 (progn (require 'dired-dd)
7764 (require 'dired-dd-mime))))))
7768 @node MHC, Addrbook, dired-dd, Living with other packages
7772 Message Harmonized Calendaring system
7773 (@uref{http://www.quickhack.net/mhc/})
7775 By using MHC, you can make a calendar from the messages.
7781 (setq mhc-mailer-package 'wl)
7782 (autoload 'mhc-mode "mhc" nil t)
7783 (add-hook 'wl-summary-mode-hook 'mhc-mode)
7784 (add-hook 'wl-folder-mode-hook 'mhc-mode)
7792 (autoload 'mhc-wl-setup "mhc-wl")
7793 (add-hook 'wl-init-hook 'mhc-wl-setup)
7797 @node Addrbook, mime-w3m, MHC, Living with other packages
7798 @subsection wl-addrbook.el
7802 (@uref{http://www.mew.org/})
7804 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
7805 @code{load-path} and do the following settings.
7809 (require 'wl-addrbook)
7814 @node mime-w3m, , Addrbook, Living with other packages
7815 @subsection mime-w3m.el
7818 You can display html part by using @file{mime-w3m.el}
7819 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
7820 You can find the usage in comment region at the head of @file{mime-w3m.el}.
7823 @node Highlights, Biff, Living with other packages, Advanced Issues
7826 @subsection Customizable Variables
7829 @item wl-summary-highlight
7830 @vindex wl-summary-highlight
7831 The initial setting is @code{t}.
7832 If non-nil, the summary is highlighted.
7834 @item wl-highlight-max-summary-lines
7835 @vindex wl-highlight-max-summary-lines
7836 The initial setting is 10000.
7837 The summary is not highlighted if it has more lines than this value.
7839 @item wl-summary-highlight-partial-threshold
7840 @vindex wl-summary-highlight-partial-threshold
7841 The initial setting is 1000.
7842 This is a threshold whether the whole summary is highlighted.
7843 If there are more lines of messages in the summary, it is partially
7846 @item wl-summary-partial-highlight-above-lines
7847 @vindex wl-summary-partial-highlight-above-lines
7848 The initial setting is 30. If there are more lines of messages than
7849 @code{wl-summary-highlight-partial-threshold} in the summary, messages
7850 after the point that is the same number of lines as this value above the
7851 cursor line are highlighted partially. (If this value is @code{nil},
7852 the last same number of lines as the value of
7853 @code{wl-summary-highlight-partial-threshold} are highlighted.)
7855 @item wl-highlight-body-too
7856 @vindex wl-highlight-body-too
7857 The initial setting is @code{t}.
7858 If non-nil, bodies of drafts and messages are also highlighted.
7860 @item wl-highlight-message-header-alist
7861 @vindex wl-highlight-message-header-alist
7862 When highlighting headers of drafts and messages, this variable
7863 specifies which faces are allocated to important
7864 (@code{wl-highlight-message-important-header-contents}), secondly
7865 important (@code{wl-highlight-message-important-header-contents2}), and
7866 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7868 Similarly, it can be used for allocating arbitrary faces to arbitrary
7869 regular expressions.
7871 @item wl-highlight-citation-prefix-regexp
7872 @vindex wl-highlight-citation-prefix-regexp
7873 Specifies a regular expression to which quoted lines in bodies of
7874 drafts and messages match.
7875 Bodies matching to this regular expression are highlighted by the faces
7876 specified by (@code{wl-highlight-message-cited-text-*}).
7878 @item wl-highlight-highlight-citation-too
7879 @vindex wl-highlight-highlight-citation-too
7880 The initial setting is @code{nil}.
7881 If non-nil, the quoting regular expression itself given by
7882 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7884 @item wl-highlight-citation-header-regexp
7885 @vindex wl-highlight-citation-header-regexp
7886 Specifies a regular expression that denotes beginning of quotation.
7887 Bodies matching to this regular expression are highlighted by the face
7888 specified by @code{wl-highlight-message-headers}.
7890 @item wl-highlight-max-header-size
7891 @vindex wl-highlight-max-header-size
7892 The initial setting is @code{nil}. If a header size is larger than this
7893 value, it will not be highlighted. If @code{nil}, always highlighted
7894 (ignore header size).
7896 @item wl-highlight-max-message-size
7897 @vindex wl-highlight-max-message-size
7898 The initial setting is 10000.
7899 If a message is larger than this value, it will not be highlighted.
7900 With this variable, highlight is suppressed for uuencode or huge digest
7903 @item wl-highlight-signature-separator
7904 @vindex wl-highlight-signature-separator
7905 Specifies regular expressions that denotes the boundary of a signature.
7906 It can be a regular expression, or a list of ones.
7907 Messages after the place that matches this regular expression are
7908 highlighted by the face specified by
7909 @code{wl-highlight-message-signature}.
7911 @item wl-max-signature-size
7912 @vindex wl-max-signature-size
7913 The initial setting is 400.
7914 This is the largest size for a signature to be highlighted.
7916 @item wl-use-highlight-mouse-line
7917 @vindex wl-use-highlight-mouse-line
7918 The initial setting is @code{t}.
7919 If non-nil, the line pointed by the mouse is highlighted in the folder
7920 mode, summary mode, and the like.
7923 @subsection Setting Colors and Fonts of the Characters
7925 If you want to change colors or fonts of the characters, you need to
7926 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7927 want to change fonts, and @code{set-face-foreground} for colors, and so
7928 on. You cannot write face settings in @file{.emacs}; write in
7931 For example, if you want to change the color for signatures to yellow,
7935 (set-face-foreground 'wl-highlight-message-signature "yellow")
7941 Faces defined in Wanderlust:
7944 @item wl-highlight-message-headers
7945 The face for field names of message headers.
7947 @item wl-highlight-message-header-contents
7948 The face for field bodies of message headers.
7950 @item wl-highlight-message-important-header-contents
7951 The face for important parts of message headers.
7952 Per default, this face is used for a body of @samp{Subject:} field.
7953 You can change its value by editing
7954 @code{wl-highlight-message-header-alist}.
7956 @item wl-highlight-message-important-header-contents2
7957 The face for secondly important parts of message headers.
7958 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7959 fields. You can change its value by editing
7960 @code{wl-highlight-message-header-alist}.
7962 @item wl-highlight-message-unimportant-header-contents
7963 The face for unimportant parts of message headers.
7964 Per default, this face is used for bodies of @samp{X-} fields
7965 @samp{User-Agent:} fields. You can change its value by editing
7966 @code{wl-highlight-message-header-alist}.
7968 @item wl-highlight-message-citation-header
7969 The face for headers of quoted messages.
7971 @item wl-highlight-message-cited-text-*
7972 The face for texts of quoted messages. The last @samp{*} is a
7973 @var{single figure} so that 10 different colors can be used according to
7976 @item wl-highlight-message-signature
7977 The face for signatures of messages. The initial settings are
7978 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7979 dark background colors.
7981 @item wl-highlight-header-separator-face
7982 The face for header separators of draft messages.
7984 @item wl-highlight-summary-important-face
7985 The face for message lines with important marks in the summary.
7987 @item wl-highlight-summary-new-face
7988 The face for message lines with new marks in the summary.
7990 @item wl-highlight-summary-displaying-face
7991 The face for the message line that is currently displayed.
7992 This face is overlaid.
7994 @item wl-highlight-thread-indent-face
7995 The face for the threads that is currently displayed.
7997 @item wl-highlight-summary-unread-face
7998 The face for message lines with unread marks in the summary.
8000 @item wl-highlight-summary-deleted-face
8001 The face for message lines with delete marks in the summary.
8003 @item wl-highlight-summary-refiled-face
8004 The face for message lines with re-file marks in the summary.
8006 @item wl-highlight-refile-destination-face
8007 The face for re-file information part of message lines with re-file
8008 marks in the summary.
8010 @item wl-highlight-summary-copied-face
8011 The face for message lines with copy marks in the summary.
8013 @item wl-highlight-summary-target-face
8014 The face for message lines with target marks @samp{*} in the summary.
8016 @item wl-highlight-summary-thread-top-face
8017 The face for message lines that are on the top of the thread in the
8020 @item wl-highlight-summary-normal-face
8021 The face for message lines that are not on top of the thread in the
8024 @item wl-highlight-folder-unknown-face
8025 The face for folders that are not known to have how many unsync messages
8028 @item wl-highlight-folder-zero-face
8029 The face for folders that have no unsync messages in the folder mode.
8031 @item wl-highlight-folder-few-face
8032 The face for folders that have some unsync messages in the folder mode.
8034 @item wl-highlight-folder-many-face
8035 The face for folders that have many unsync messages in the folder mode.
8036 The boundary between `some' and `many' is specified by the variable
8037 @code{wl-folder-many-unsync-threshold}.
8039 @item wl-highlight-folder-unread-face
8040 The face for folders that have no unsync but unread messages in the
8043 @item wl-highlight-folder-killed-face
8044 The face for folders that are deleted from the access group in the
8047 @item wl-highlight-folder-opened-face
8048 The face for open groups in the folder mode.
8049 It is meaningful when @code{wl-highlight-folder-by-numbers} is
8050 @code{nil} or a @var{number}.
8052 @item wl-highlight-folder-closed-face
8053 The face for close groups in the folder mode.
8054 It is meaningful when @code{wl-highlight-folder-by-numbers} is
8055 @code{nil} or a @var{number}.
8057 @item wl-highlight-folder-path-face
8058 The face for the path to the currently selected folder in the folder
8061 @item wl-highlight-logo-face
8062 The face for logo in the demo.
8064 @item wl-highlight-demo-face
8065 The face for strings (for example, a version number) in the demo.
8069 @node Biff, Password Management, Highlights, Advanced Issues
8070 @section Notify Mail arrival
8073 Following setting is to notify mail arrival of @samp{%inbox}
8074 by the indicator on the modeline
8077 (setq wl-biff-check-folder-list '("%inbox"))
8080 @subsection Customizable Variables
8082 @item wl-biff-check-folder-list
8083 @vindex wl-biff-check-folder-list
8084 The initial setting is @code{nil}.
8085 This is the list of folders to check mail arrival.
8086 If @code{nil}, wl doesn't check mail arrival.
8088 @item wl-biff-check-interval
8089 @vindex wl-biff-check-interval
8090 The initial setting is 40 (in seconds).
8091 Check mail arrival in this period.
8093 @item wl-biff-use-idle-timer
8094 @vindex wl-biff-use-idle-timer
8095 The initial setting is @code{nil}.
8096 If it is @code{nil}, check mail arrival when the time specified by
8097 @code{wl-biff-check-interval} has passed. If it is non-nil, check
8098 mail arrival when idling time exceeds @code{wl-biff-check-interval}.
8100 @item wl-biff-notify-hook
8101 @vindex wl-biff-notify-hook
8102 This hook is run at the arrival of new mail.
8103 To beep with mail arrival(initial setting), set as follows.
8105 (setq wl-biff-notify-hook '(ding))
8107 For silence, set to @code{nil}.
8111 @node Password Management, Split messages, Biff, Advanced Issues
8112 @section Manage Passwords
8114 If you input passwords to connect servers, they are stored in the
8115 variable @code{elmo-passwd-alist} per connection. You should be careful
8116 that others might read your passwords if they can touch your Emacs,
8117 since encoded plain passwords are there.
8119 If you invoke @kbd{M-x elmo-passwd-alist-save} while you have stored
8120 passwords, then they are saved on the file, and it will save you to
8121 input passwords. In this case, the risk that someone reads your
8122 keystroke might decrease, but please not that plain passwords are
8123 stored on a file. You should treat them very carefully.
8124 To remove saved passwords on file, invoke @kbd{M-x elmo-passwd-alist-clear}
8125 and then @kbd{M-x elmo-passwd-alist-save}.
8128 @item elmo-passwd-alist-file-name
8129 @vindex elmo-passwd-alist-file-name
8130 The initial setting is @file{passwd}.
8131 This is the name of the file in which passwords are saved.
8132 @code{elmo-passwd-alist-save} saves current passwords to the file.
8134 @item elmo-passwd-life-time
8135 @vindex elmo-passwd-life-time
8136 The initial setting is @code{nil}.
8137 If the value is some number, timer is set to remove password entry after
8138 @code{elmo-passwd-life-time} seconds since you input the password.
8139 @code{nil} means never to remove passwords.
8143 @node Split messages, Batch Processing, Password Management, Advanced Issues
8144 @section Message splitting
8145 @cindex Split messages
8147 You can use @code{elmo-split} to split message in folder specified by
8148 the variable @code{elmo-split-folder} a la @command{procmail} according
8149 to some specified rules. To use this feature, set as follows in your
8150 @file{~/.emacs} at first.
8153 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
8156 Set source folder like following.
8159 (setq elmo-split-folder "%inbox")
8162 And specify the rule in the variable @code{elmo-split-rule} (its format
8163 will be is described below).
8164 Then you can invoke @kbd{M-x elmo-split} to split messages according to
8165 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
8166 to do a rehearsal and show result (do not split actually).
8169 We will describe how to specify the rule. First of all, see following
8174 (setq elmo-split-rule
8175 ;; @r{Store messages from spammers into @samp{+junk}}
8176 '(((or (address-equal from "i.am@@spammer")
8177 (address-equal from "dull-work@@dull-boy")
8178 (address-equal from "death-march@@software")
8179 (address-equal from "ares@@aon.at")
8180 (address-equal from "get-money@@richman"))
8182 ;; @r{Store messages from mule mailing list into @samp{%mule}}
8183 ((equal x-ml-name "mule") "%mule")
8184 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
8185 ;; @r{and continue evaluating following rules}
8186 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
8187 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
8188 ((match from "\\(.*\\)@@yahoo\\.com")
8190 ;; @r{Store unmatched mails into @samp{+inbox}}
8195 The basic unit of the rule is a combination like
8198 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
8201 If @samp{CONDITION} is true, @samp{ACTION} is performed.
8202 The 1st element @samp{CONDITION} is a condition represented by a
8203 balanced expression (sexp). Its grammar will be explained below.
8204 The 2nd element @samp{ACTION} is the name of the folder to split
8205 messages into, or a symbol. When the 3rd element @code{continue} is
8206 specified as symbol, evaluating rules is not stopped even when the
8207 condition is satisfied.
8209 The grammar for @samp{CONDITION} is as follows. See example above to
8210 learn how to write the condition practically.
8214 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
8215 (@samp{FIELD-NAME} is a symbol that describes the field name)
8219 True if the field value equals to @samp{VALUE}.
8220 Case of the letters are ignored.
8222 True if the field value matches to VALUE.
8223 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
8224 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
8225 @item @code{address-equal}
8226 True if one of the addresses in the field equals to
8227 @samp{VALUE}. Case of the letters are ignored.
8228 @item @code{address-match}
8229 True if one of the addresses in the field matches to
8231 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
8232 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
8236 Functions which accept an integer argument (@samp{SIZE}).
8240 True if the size of the message is less than @samp{SIZE}.
8242 True if the size of the message is greater than @samp{SIZE}.
8246 Functions which accept any number of arguments.
8250 True if one of the argument returns true.
8252 True if all of the arguments return true.
8258 When a symbol is specified, it is evaluated.
8261 You can specify followings as 2nd @samp{ACTION}.
8267 If some string is specified, it will be regarded as the destination
8268 folder, and the message will be appended to it.
8273 If the symbol @samp{delete} is specified, delete the substance of the
8274 message in @code{elmo-split-folder}
8279 If the symbol @samp{noop} is specified, do nothing on the message and
8285 If some function is specified, execute it.
8288 If the message passes all rules, it will be dealed along @samp{ACTION}
8289 specified by @code{elmo-split-default-action}.
8292 @node Batch Processing, Advanced Settings, Split messages, Advanced Issues
8293 @section Batch Processing
8294 @cindex Batch Processing
8296 You can request wanderlust to do some job on the command line.
8297 For now, you can invoke prefetching new messages in specified folders.
8299 Specify target folders in @code{wl-batch-prefetch-folder-list} then
8300 invoke as follows to execute prefetching:
8304 % emacs -batch -l wl-batch -f wl-batch-prefetch
8308 @subsection Customize Variables
8311 @item wl-batch-prefetch-folder-list
8312 @vindex wl-batch-prefetch-folder-list
8313 Target folders of prefetching by @code{wl-batch-prefetch}, specified as
8314 a list of folder names.
8318 @node Advanced Settings, Customizable Variables, Batch Processing, Advanced Issues
8319 @section Advanced Settings
8322 * Draft for Reply:: Draft for Reply
8323 * Thread Format:: Appearance of Thread
8324 * User-Agent Field:: @samp{User-Agent:} Header Field
8328 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
8329 @subsection Draft for Replay
8330 @vindex wl-draft-reply-with-argument-list
8331 @vindex wl-draft-reply-without-argument-list
8333 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
8334 The addressee for the draft is decided by following rules.
8336 For example, you can set as follows:
8340 (setq wl-draft-reply-without-argument-list
8341 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8342 ("Followup-To" . (nil nil ("Followup-To")))
8343 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8344 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
8348 Where each element of the list @code{wl-draft-reply-without-argument-list}
8352 (key . (to-list cc-list newsgroup-list))
8355 and if the field designated by @samp{key} exist in the parent message,
8356 parent's field values designated by @samp{to-list} are copied to @samp{To:}
8357 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
8358 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
8359 the draft respectively.
8364 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8367 Match if the parent has @samp{Mail-Followup-To} field.
8368 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
8369 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
8373 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8376 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
8377 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
8380 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
8383 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
8384 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
8387 These are evaluated in order and first matched one is used.
8389 Moreover, the behavior of @kbd{a} with prefix argument can
8390 be directed by @code{wl-draft-reply-with-argument-list} as well.
8393 By the way, you can use some function (will be evaluated in the parent
8394 message buffer) in the place of @samp{key} or @samp{to-list} etc.
8396 If you want to write a rule for replying to message written by yourself,
8397 specify function @code{wl-draft-self-reply-p} as @samp{key}.
8399 If you only want to reply to mailing lists in
8400 @code{wl-subscribed-mailing-list} if the parent has some of them,
8405 (defun wl-mailing-list-addresses ()
8409 (nth 1 (std11-extract-address-components addr)))
8412 (elmo-multiple-fields-body-list (list "To" "Cc"))
8414 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
8415 (setq list-addrs (cons to list-addrs))))
8416 (nreverse list-addrs)))
8418 (setq wl-draft-reply-with-argument-list
8419 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
8420 ("Reply-To" . (("Reply-To") nil nil))
8421 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
8422 ("From" . (("From") nil nil))))
8427 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
8428 @subsection Appearance of Threads
8432 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
8433 390 09/18(Fri)07:25 +-[ Tsumura-san ]
8434 391 09/18(Fri)19:24 +-[ Murata-san ]
8435 392 09/20(Sun)21:49 +-[ Okunishi-san ]
8436 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
8437 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
8438 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
8439 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
8440 412 09/22(Tue)09:28 | +-[ Teranishi ]
8441 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
8442 416 09/22(Tue)12:38 | +-[ Teranishi ]
8443 395 09/20(Sun)21:49 +-[ Okunishi-san ]
8444 397 09/21(Mon)00:15 +-[ Okunishi-san ]
8448 Settings to make appearance of threads like shown above:
8452 (setq wl-thread-indent-level 2)
8453 (setq wl-thread-have-younger-brother-str "+")
8454 (setq wl-thread-youngest-child-str "+")
8455 (setq wl-thread-vertical-str "|")
8456 (setq wl-thread-horizontal-str "-")
8457 (setq wl-thread-space-str " ")
8461 If you do not want to see branches, do the following:
8465 (setq wl-thread-indent-level 2)
8466 (setq wl-thread-have-younger-brother-str " ")
8467 (setq wl-thread-youngest-child-str " ")
8468 (setq wl-thread-vertical-str " ")
8469 (setq wl-thread-horizontal-str " ")
8470 (setq wl-thread-space-str " ")
8475 @node User-Agent Field, , Thread Format, Advanced Settings
8476 @subsection User-Agent Field
8480 If you are eccentric enough to elaborate @samp{X-Mailer:} or
8481 @samp{User-Agent:} fields, define a function that generate appropriate
8482 strings as you like, and set it to variable
8483 @code{wl-generate-mailer-string-function}.
8485 If you do not want verbose @samp{User-Agent:} field, do the following:
8489 (setq wl-generate-mailer-string-function
8490 'wl-generate-user-agent-string-1)
8494 The following is a example:
8498 (setq wl-generate-mailer-string-function nil)
8499 (setq wl-draft-additional-header-alist
8501 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
8506 @node Customizable Variables, Hooks, Advanced Settings, Advanced Issues
8507 @section Customizable Variables
8509 Customizable variables that have not been described yet:
8512 @item wl-default-folder
8513 @vindex wl-default-folder
8514 The initial setting is @samp{%inbox}. This is the default value for moving to
8515 a folder and the like.
8517 @item wl-draft-folder
8518 @vindex wl-draft-folder
8519 The initial setting is @samp{+draft}. It is the folder to which drafts are
8520 saved. It must be a writable folder.
8521 You can set IMAP remote folder, Maildir and so on.
8522 Note that variable settings applied by @code{wl-draft-config-exec} is saved
8523 under @code{elmo-msgdb-directory}. That is to say, if you specified remote
8524 folder as @code{wl-draft-folder}, variable settings which are applied by
8525 @code{wl-draft-config-exec} before saving the draft will not affect on the
8526 draft buffer on another host by invoking @code{wl-summary-reedit}.
8528 @item wl-trash-folder
8529 @vindex wl-trash-folder
8530 The initial setting is @samp{+trash}. It is the wastebasket folder.
8531 If you changed this variable, you had better restart Wanderlust.
8533 @item wl-interactive-exit
8534 @vindex wl-interactive-exit
8535 The initial setting is @code{t}.
8536 If non-nil, you are asked for confirmation when Wanderlust terminates.
8538 @item wl-interactive-send
8539 @vindex wl-interactive-send
8540 The initial setting is @code{t}.
8541 If non-nil, you are asked for confirmation when mail is sent.
8543 @item wl-default-sync-range
8544 @vindex wl-default-sync-range
8545 The initial setting is @samp{update}.
8546 Default update range of the summary. You can specify
8547 @samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
8548 See description of @code{wl-summary-sync} for the meaning of ranges.
8550 @item wl-folder-sync-range-alist
8551 @vindex wl-folder-sync-range-alist
8552 The initial setting is the alist shown below:
8557 ("^\\+draft$\\|^\\+queue$" . "all"))
8562 This is an associative list of regular expressions of folder names and
8563 update range of the summary. Update range is one of the @samp{all},
8564 @samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
8565 match any of them, the value of @code{wl-default-sync-range} is used
8566 (@samp{update} by default).
8567 See description of @code{wl-summary-sync} for the meaning of ranges.
8570 @vindex wl-ask-range
8571 The initial setting is @code{t}.
8572 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
8573 for updating the summary when you changed folders.
8575 @item wl-mime-charset
8576 @vindex wl-mime-charset
8577 The initial setting is @code{x-ctext}.
8578 This is the MIME charset for messages that are not MIME (e.g. without
8579 @samp{Content-Type:}). This value also used as default charset for
8580 summary. (If you want to share Summary on Nemacs and other Emacsen, set
8581 this value as @code{iso-2022-jp}.)
8583 @item wl-highlight-folder-with-icon
8584 @vindex wl-highlight-folder-with-icon
8585 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
8586 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
8588 @item wl-strict-diff-folders
8589 @vindex wl-strict-diff-folders
8590 This is a list of regular expressions of folders.
8591 Unread messages are checked, for example when you press @kbd{s} in
8592 the folder mode, usually in a brief way (rapidly processed but not
8594 The folders matching this variable are seriously checked.
8595 You may want to set this variable so as to match conditional filter
8596 folders for IMAP4 folders.
8597 The initial setting is @code{nil}.
8599 @item wl-folder-use-server-diff
8600 @vindex wl-folder-use-server-diff
8601 When unread messages are checked, for example when you press @kbd{s} in
8602 the folder mode, usually (the number of messages on the server) @minus{}
8603 (the number of local messages) will be the number of unread messages.
8604 However, if this variable is non-nil, the number of unread messages on
8605 the server is checked. This affects IMAP4 folders only, but IMAP4
8606 folders in mail boxes matching
8607 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
8608 the number of unread messages on the server, even if they matches this
8609 variable. The initial setting is @code{t}.
8611 @item wl-auto-check-folder-name
8612 @vindex wl-auto-check-folder-name
8613 The initial setting is @code{nil}.
8614 You can specify a folder or a group which is checked for unread message
8615 at the start. You can also specify a list of folders (groups) to be checked.
8616 If the value is @code{nil}, whole Desktop is checked at the start.
8617 If it is @code{none}, no folders are checked.
8619 @item wl-auto-uncheck-folder-list
8620 @vindex wl-auto-uncheck-folder-list
8621 The initial setting is the list shown below:
8630 You can set a list of regular expressions to specify folders
8631 which are not automatically checked even if they are included
8632 in some groups assigned by @code{wl-auto-check-folder-name}.
8634 @item wl-auto-check-folder-list
8635 @vindex wl-auto-check-folder-list
8636 The initial setting is @code{nil}.
8637 You can set a list of regular expressions to specify exceptions
8638 for @code{wl-auto-uncheck-folder-list}.
8640 @item wl-no-save-folder-list
8641 @vindex wl-no-save-folder-list
8642 The initial setting is the list shown below:
8651 This is a list of regular expressions of folders not to be saved.
8653 @item wl-save-folder-list
8654 @vindex wl-save-folder-list
8655 The initial setting is @code{nil}.
8656 This is a list of regular expressions of folders to be saved.
8657 This takes precedence over @code{wl-no-save-folder-list}.
8659 @item wl-folder-mime-charset-alist
8660 @vindex wl-folder-mime-charset-alist
8661 The initial setting is the alist shown below:
8665 (("^-alt\\.chinese" . big5)
8666 ("^-relcom\\." . koi8-r)
8668 ("^-han\\." . euc-kr))
8673 This is an associative list of regular expressions of folder names and
8675 If a folder do not match, @code{wl-mime-charset} is used.
8677 @item wl-folder-init-load-access-folders
8678 @vindex wl-folder-init-load-access-folders
8679 The initial setting is @code{nil}.
8680 This is a list of access groups to be loaded specifically at the start.
8681 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
8683 @item wl-folder-init-no-load-access-folders
8684 @vindex wl-folder-init-no-load-access-folders
8685 The initial setting is @code{nil}.
8686 This is a list of access groups not to be loaded specifically at the
8688 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
8690 @item wl-dispose-folder-alist
8691 @vindex wl-dispose-folder-alist
8692 The initial setting is the alist shown below:
8702 This list determines disposition of messages with disposal marks.
8703 Each item in the list is a folder and destination; you can specify any
8704 one of the following in the place of destination:
8707 @code{remove} or @code{null} : deletes the messages instantly.
8708 string : moves the messages to the specific folder.
8709 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
8712 @item wl-x-face-file
8713 @vindex wl-x-face-file
8714 The initial setting is @file{~/.xface}.
8715 The name of the file that contains encoded X-Face strings.
8718 @item wl-demo-display-logo
8719 @vindex wl-demo-display-logo
8720 If non-nil, bitmap image is shown on the opening demo. If you set
8721 @code{xpm} or @code{xbm}, (if possible) display selected image type
8724 @item elmo-use-database
8725 @vindex elmo-use-database
8726 This is meaningful for XEmacs only. The initial setting depends on
8727 XEmacs (@code{t} for XEmacs with dbm).
8728 If non-nil, Message-ID is controlled by dbm.
8730 @item elmo-nntp-list-folders-use-cache
8731 @vindex elmo-nntp-list-folders-use-cache
8732 The initial setting is 600 (in seconds).
8733 This is period in seconds during which results of @samp{list} and
8734 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
8737 @item elmo-nntp-max-number-precedes-list-active
8738 @vindex elmo-nntp-max-number-precedes-list-active
8739 The initial setting is @code{nil}.
8740 If non-nil, the number of article obtained by @samp{list active} in NNTP
8741 are used as the maximum article number of the folder.
8742 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
8743 and if the number of read messages is not correct.
8745 @item elmo-nntp-default-use-listgroup
8746 @vindex elmo-nntp-default-use-listgroup
8747 The initial setting is @code{t}.
8748 If non-nil, @samp{listgroup} is used for checking the total number of
8749 articles. If it is @code{nil}, @samp{group} is used. In the latter
8750 case, the processing will be a little faster at the sacrifice of
8753 @item elmo-pop3-send-command-synchronously
8754 @vindex elmo-pop3-send-command-synchronously
8755 The initial setting is @code{nil}.
8756 If non-nil, POP3 commands are issued synchronously. Some implementation
8757 of POP3 server fails to get summary information without this setting.
8758 You may have to set this variable to @code{t}, if the process hangs
8759 while looking up POP3.
8761 @item elmo-dop-flush-confirm
8762 @vindex elmo-dop-flush-confirm
8763 The initial setting is @code{t}.
8764 If non-nil, you are asked for confirmation if accumulated off-line
8765 operations are executed.
8767 @item elmo-display-progress-threshold
8768 @vindex elmo-display-progress-threshold
8769 The initial setting is 20.
8770 Threshold for display of progress gauge. If number of renewal is more than
8771 this value, display progress gauge.
8773 @item elmo-network-session-idle-timeout
8774 @vindex elmo-network-session-idle-timeout
8775 The initial setting is @code{nil}.
8776 Idle timeout of the network cache. Specified in seconds.
8777 If elapsed time since last access is larger than this value,
8778 cached session is not reused. If nil, network cache is reused.
8783 @node Hooks, , Customizable Variables, Advanced Issues
8789 @node Migration, Terminology, Advanced Issues, Top
8790 @chapter Switch from older version of Wanderlust
8793 This chapter explains the important thing for the upgrade,
8794 or migration from the previous version.
8795 It includes the changes of the setup, limitations etc.
8798 * Before 2.12.0:: From prior to the version 2.12.0
8801 @node Before 2.12.0, , Migration, Migration
8802 @section Migration from prior to the version 2.12.0
8804 @subsection The conversion of msgdb
8806 From version 2.12.0 on, the structure of msgdb is changed.
8807 The msgdb for newly created folder will use this new format when created and saved.
8808 But by writing following line, you may use the old format of the msgdb as it was.
8812 (setq elmo-msgdb-default-type 'legacy)
8816 With the default setup, the old msgdb format is converted to the new
8817 format automatically. You may change this behavior by writing following
8818 lines in @file{~/.wl}.
8822 ;; @r{If the format of msgdb is different from} @code{elmo-msgdb-default-type},
8823 ;; @r{the format will be converted automatically when}
8824 ;; @r{the msgdb is being loaded (default).}
8825 (setq elmo-msgdb-convert-type 'auto)
8827 ;; @r{Convert msgdb when hitting @kbd{s all} in Summary mode}
8828 (setq elmo-msgdb-convert-type 'sync)
8830 ;; @r{Inhibit conversion}
8831 (setq elmo-msgdb-convert-type nil)
8835 As is explained in above section, you may continue to use the old format.
8836 But you will have following limitations.
8840 You cannot use forwarded mark (@samp{F}, @samp{f}).
8842 You may only use @samp{important} flag. The other global flags may not
8846 @subsection Changes from @samp{'mark} folder to @samp{'flag}.
8848 The folder @samp{'mark} will be automatically converted to @samp{'flag}
8849 folder when you first start the new version of Wanderlust.
8850 But there are some restrictions on this type of migrated folder.
8854 @samp{important} flag attached will not be
8855 removed by deleting the associated message in @samp{'flag} folder.
8858 The message won't be deleted by removing
8859 @samp{important} flag in @samp{'flag} folder.
8862 help-echo will not show you the old message.
8866 If you have problem with migrating
8867 from @samp{'mark} folder to the @samp{'flag} folder,
8869 @kbd{M-x elmo-global-mark-upgrade} will transfer the message
8870 from @samp{'mark} folder to the @samp{'flag} folder.
8871 The duplicated message will not be processed,
8872 you may issue that command repeatedly.
8875 @node Terminology, Mailing List, Migration, Top
8876 @chapter Terminology around Wanderlust
8879 Here we explain terminologies used in this manual.
8883 A container in which messages are stored.
8886 A set consists of some folders.
8889 A special group consists of automatically collected folders under
8890 some specified path.
8891 @xref{Folder Definition}.
8893 @item summary buffer
8894 A buffer for displaying list of messages in some folder.
8896 @item sticky summary
8897 Compared with ordinary summary buffer which will be destroyed after
8898 exiting from it, this type of summary will be remain even after exiting
8899 by @kbd{q} or @kbd{g}.
8900 @xref{Sticky Summary}.
8903 To delete or put into the archive expired messages.
8910 To cache messages beforehand in order to read messages after you will be
8911 disconnected from the server.
8915 @node Mailing List, Addition, Terminology, Top
8916 @chapter Wanderlust Mailing List
8920 Topics related to Wanderlust are discussed in following mailing lists.
8921 The latest version is also announced there.
8924 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
8927 In this list Japanese is mainly used for discussion. We also have a list
8928 for discussion in English:
8931 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
8933 (Messages posted to this list are also forwarded to the former one.)
8935 A guide can be obtained automatically by sending mail to
8936 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
8937 the English one) with the body
8943 Please send bug reports or patches to one of those lists. You can post to
8944 the mailing list even though you are not a member of it.
8946 If you send a bug report, please attach Backtrace with it.
8947 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
8950 I would like to express my thanks to the members of the mailing list for
8951 valuable advice and many pieces of code they contributed.
8955 You can read messages posted to the mailing list on the web or in
8958 Read messages posted to @t{<wl@@lists.airs.net>}
8961 @uref{http://lists.airs.net/wl/archive/}
8962 @uref{news://gmane.mail.wanderlust.general.japanese@@news.gmane.org}
8965 Read messages posted to @t{<wl-en@@lists.airs.net>}
8968 @uref{http://lists.airs.net/wl-en/archive/}
8969 @uref{news://gmane.mail.wanderlust.general@@news.gmane.org}
8973 @node Addition, Index, Mailing List, Top
8974 @chapter Additional Information
8976 @section Brief History
8979 1998 3/05 Tried to make a prototype that displays MH messages in threads.
8980 3/10 Made a msgdb mechanism by elisp.
8981 3/26 IMAP and NNTP can be displayed in threads.
8982 4/13 Began to assemble thread display modules as elmo.
8983 5/01 Finished 0.1.0, initial version with many defects.
8984 6/12 I made a slip of the tongue and said I was writing elisp
8985 mailer supporting IMAP
8986 6/16 0.1.3 was announced at tm-ja, elisp ML.
8987 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
8988 7/01 Support for mm-backend (0.3.0).
8989 8/25 multi folder added (0.5.0).
8990 8/28 filter folder added (0.5.1).
8991 9/10 You can open/close threads (0.6.0).
8992 9/11 fldmgr by Murata-san made editing folders easy.
8993 9/18 lha folders added by Okunishi-san (0.6.3).
8994 9/24 Display of branches of threads (0.6.5).
8995 9/28 Compression folder supporting multiple archivers by Okunishi-san.
8996 10/28 Off-line operations (0.7.4).
8997 12/09 Becomes beta version.
8998 12/21 wl-expire by Murata-san.
8999 1999 2/03 auto-refile by Tsumura-san.
9000 4/28 wl-template by Murata-san.
9001 5/18 Released 1.0.0 stable.
9002 7/05 Scoring by Murata-san (2.1.0).
9003 9/26 New plugged system by Murata-san (2.2.2).
9004 12/20 Support Modified UTF7.
9005 2000 3/24 Released 1.1.0 stable.
9006 4/03 CVS development started.
9007 5/07 Thread restoration & Its speed up with Murata-san.
9008 6/12 Address completion with LDAP with Chiba-san & Goto-san.
9009 7/11 killed message feature.
9010 7/18 Use UIDL in POP3.
9011 9/12 biff feature with Satata-san & Yamaoka-san.
9012 10/17 expire-hide by Okada-san.
9013 11/08 Released 2.4.0 stable.
9014 2001 7/04 Released 2.6.0 stable.
9015 8/21 wl-addrmgr by Kitamoto-san.
9016 12/27 Released 2.8.1 stable.
9017 2002 12/11 Released 2.10.0 stable.
9018 2003 7/05 Released 2.10.1 stable.
9019 9/18 flag folder is added.
9020 9/20 New msgdb format (modb-standard) by H.Murata-san.
9021 10/20 Spam filter by H.Murata-san.
9022 2004 1/06 Background color of the demo become configurable.
9023 2/09 'file' folder is added.
9024 9/12 forwarded mark.
9025 Default value of the mark strings are changed.
9026 12/24 Released 2.12.0 stable.
9029 See @file{ChangeLog} for details.
9033 According to a dictionary, Wanderlust has the meaning:
9037 n eager longing for or impulse towards travelling in distant lands
9038 [Ger, fr wandern to wander + lust desire, pleasure]
9042 but I had no profound intention. (if farfetched, IMAP @result{} you can
9043 read mail anywhere @result{} desire to wander ?)
9045 Elmo is the abbreviation of @samp{Elisp Library for Message
9046 Orchestration}. At first I meant the red puppet in the Sesame Street,
9047 but you may associate it with Wandering @result{} Drifting @result{}
9048 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
9052 Each versions has code names (they are almost jokes).
9053 Currently they are picked up alphabetically from the top 40 hits of
9054 U.S. Billboard magazines in 1980s.
9056 (@uref{http://ntl.matrix.com.br/pfilho/html/top40/})
9058 @node Index, , Addition, Top
9062 * Concept Index:: Concept Index
9063 * Key Index:: Key Index
9064 * Variable Index:: Variable Index
9065 * Function Index:: Function Index
9068 @node Concept Index, Key Index, Index, Index
9069 @unnumberedsec Concept Index
9072 @node Key Index, Variable Index, Concept Index, Index
9073 @unnumberedsec Key Index
9076 @node Variable Index, Function Index, Key Index, Index
9077 @unnumberedsec Variable Index
9080 @node Function Index, , Variable Index, Index
9081 @unnumberedsec Function Index