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{t}. In this case, prefetch messages in all
2848 If it is a list of folder types, it specifies the folder types in which
2849 message prefetching is enabled.
2850 Following is an example (prefetch messages in nntp and imap4 folders)
2854 (setq wl-message-buffer-prefetch-folder-type-list
2859 In this case, multi folder that contains localdir and imap4 prefetches
2860 only imap4 messages. This variable precedes the value of
2861 @code{wl-message-buffer-prefetch-folder-list}.
2863 @item wl-message-buffer-prefetch-folder-list
2864 @vindex wl-message-buffer-prefetch-folder-list
2865 The initial setting is @code{nil}.
2866 A list of regexp of folders to enable message prefetching.
2868 @item wl-message-buffer-prefetch-depth
2869 @vindex wl-message-buffer-prefetch-depth
2870 The initial setting is 3. The number of messages for automatical prefetch.
2872 @item wl-message-buffer-prefetch-idle-time
2873 @vindex wl-message-buffer-prefetch-idle-time
2874 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2876 @item wl-message-buffer-prefetch-threshold
2877 @vindex wl-message-buffer-prefetch-threshold
2878 The initial setting is 30000 (bytes). If prefetching message has larger
2879 size than this value, Wanderlust does not prefetch automatically.
2880 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2881 the message is not checked for the size.
2883 @item wl-auto-prefetch-first
2884 @vindex wl-auto-prefetch-first
2885 The initial setting is @code{nil}.
2886 If non-nil, first message is automatically prefetched to the buffer
2887 when you enter the folder.
2891 @node Auto Refile, Sticky Summary, Cache, Summary
2892 @section Auto Refile
2893 @vindex elmo-msgdb-extra-fields
2894 @vindex wl-refile-rule-alist
2895 @findex wl-summary-auto-refile
2897 You can refile messages automatically, by typing @kbd{C-o}
2898 (@code{wl-summary-auto-refile}). It decides destination of refile by
2899 the content of the message header information (information in the msgdb).
2901 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2902 available. If you want to decide destination by other header fields,
2903 set the variable @code{elmo-msgdb-extra-fields} like following.
2907 (setq elmo-msgdb-extra-fields
2917 By this setting, Wanderlust saves extra fields in the msgdb. You have
2918 to type @kbd{s all} to get extra fields for the messages that are
2919 already exists in the summary.
2921 Then, specify the refile rule. The refile target folder of auto
2922 refiling is decided by the value of @code{wl-refile-rule-alist}.
2923 @code{wl-refile-rule-alist} is a list of a rule:
2927 (@var{field} (@var{regexp} . @var{target})
2928 (@var{regexp} . @var{target})
2933 Each rule means `if @var{field} value matches @var{regexp},
2934 then refile to @var{target} folder'.
2935 The rule matched first is applied.
2937 @var{field} is a string of field name. You can specify a list of field name
2938 string, too. In this case, if one of these fields is matched, then the
2939 rule is fired (i.e. OR condition).
2941 @var{regexp} is a regular expression for field value. @var{target} is a target
2942 folder string. You can specify a rule at @var{target} part, too. In this
2943 case, If the field value of the rule and the current rule is matched,
2944 then the current rule is fired (i.e. AND condition).
2946 You can refer matched substring of @var{regexp} to specify @var{target} part.
2947 To refer substring, use following keys:
2951 means substitute original matched text.
2954 means substitute what matched the @var{N}th `\(@dots{}\)'.
2955 (@var{N} is a number.)
2958 Following is an example of @code{wl-refile-rule-alist}.
2962 (setq wl-refile-rule-alist
2964 ("^Wanderlust" . "+wl")
2965 ("^Elisp" . "+elisp"))
2967 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2969 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2970 "+from-me-to-you"))))))
2974 After these settings, refile marks are automatically put on the condition
2975 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2977 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2979 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2980 with these persistent marks are not automatically refiled.
2981 It means Wanderlust does not execute auto refile on unread messages by
2982 the default setting.
2983 To execute auto refile on all messages, set following.
2986 (setq wl-summary-auto-refile-skip-marks nil)
2990 @node Sticky Summary, Summary View, Auto Refile, Summary
2991 @section Sticky Summary
2992 @cindex Summary, Sticky
2993 @cindex Sticky Summary
2995 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2997 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2998 @kbd{G} in some suummary sticky summary buffer is created.
2999 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
3000 makes current one sticky.
3002 The buffer name of the sticky summary becomes like
3003 @samp{Summary:@var{folder-name}}.
3004 You can visit the sticky summary at any time by @kbd{C-x b}
3005 (@code{switch-to-buffer}), or you can go round summary buffers by
3006 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
3007 (@code{wl-summary-next-buffer}) in summary mode.
3009 In sticky summary, the summary buffer is preserved after @kbd{g} or
3010 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
3011 another summary by @kbd{C-u g}. Other operations in the sticky summary
3012 are same as normal summary.
3014 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3015 are automatically stuck.
3018 @node Summary View, Mark and Action, Sticky Summary, Summary
3019 @section Format of summary lines
3020 @cindex Format of summary lines
3021 You can alter the format of lines in Summary mode.
3023 Summary line format is specified by @code{wl-summary-line-format}.
3024 You can use control strings defined by
3025 @code{wl-summary-line-format-spec-alist}.
3031 ;; @r{number temporary-mark persistent-mark date branch}
3032 ;; @r{[ (number-of-children) sender ] subject}
3033 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
3037 Where the number set the column number of the field. If negative value,
3038 the column is filled from right. If the number begins with @samp{0},
3039 @samp{0} is used for filling columns instead of @samp{ }.
3051 Major control strings defined by @code{wl-summary-line-format-spec-alist}
3052 are displayed in the following list.
3065 %t branch of the thread
3066 %[ [ (< for re-connected child)
3067 %] ] (> for re-connected child)
3071 %c +number-of-children: (display only for opened thread)
3072 %C [+number-of-children] (display only for opened thread)
3073 %# mailing list information (`(' ML-name [ ` ' ML-number ] `)')
3074 %l number in the mailing list
3075 %@@ `@@' only if the first MIME part is multipart/mixed
3076 %~ ` ' only if previous column is empty
3080 The temporary mark (@samp{%T}) and persistent mark (@samp{%P}) must
3081 appear at the constant column. For example, if you specify @samp{%T} or
3082 @samp{%P} after the @samp{%t}, which changes its length by thread
3083 position, marks are not treated correctly.
3085 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
3086 column of the enclosed region is justified to the `number'. Multiple
3087 level @samp{%number(} parenthesis can be defined. It is useful to
3088 justify the column of the multiple control strings. For example, in the
3089 above @code{wl-summary-line-format},
3095 means ``Adjust number-of-children and sender string to the 17 column''.
3097 You can specify the format by each folders with
3098 @code{wl-folder-summary-line-format-alist}. Please set regular
3099 expression for folder names and summary line format as the following
3104 (setq wl-folder-summary-line-format-alist
3105 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
3106 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
3110 @subsection on the format for sender name
3112 The format string @samp{%f} displays the return value of the function specified
3113 by @code{wl-summary-from-function}. If you use the function
3114 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
3115 while displays the recipient names if the folder name matches with
3116 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
3117 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
3119 For example, to display recipient names for the message in @samp{+backup} if
3120 its sender is yourself, set up as follows.
3123 (setq wl-summary-showto-folder-regexp "^\\+backup$")
3127 @node Mark and Action, Key Bindings of Summary, Summary View, Summary
3128 @section Temporary marks and their effect
3129 @cindex Mark and Action
3131 You can define temporary marks and corresponding procedure by
3132 @code{wl-summary-mark-action-list}. Initially, refile (@samp{o}), copy
3133 (@samp{O}), dispose (@samp{d}), delete (@samp{D}), prefetch (@samp{i})
3134 and resend (@samp{~}) are defined.
3136 Each element of @code{wl-summary-mark-action-list} consists of
3139 (@samp{MARK} @samp{SYMBOL}
3140 @samp{ARGUMENT-FUNCTION} @samp{SET-MARK-FUNCTION} @samp{EXEC-FUNCTION}
3141 @samp{FACE} @samp{DOC-STRING})
3144 @samp{MARK} is a temporary mark string, and @samp{SYMBOL} is the name of
3145 the action to be defined. @samp{ARGUMENT-FUNCTION} is a function to
3146 generate argument to be given to @samp{SET-MARK-FUNCTION}, which will be
3147 described next, and it takes arguments:
3150 (@samp{ACTION} @samp{NUMBER})
3153 Where @samp{ACTION} equals to @samp{SYMBOL}, and @samp{NUMBER} is message
3154 number. @samp{SET-MARK-FUNCTION} is a function to be called when the mark
3155 is put. It takes arguments:
3158 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3161 Where @samp{NUMBER} is target message number, @samp{MARK} is a temporary
3162 mark string, and @samp{DATA} is given by @samp{ARGUMENT-FUNCTION}.
3164 @samp{EXEC-FUNCTION} is a function to be called when the action is
3165 executed. Its argument is a list of @samp{MARK-INFO}. Here @samp{MARK-INFO}
3166 means a list consists of
3169 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3172 @samp{FACE} is a face to be used for highlighting.
3175 @node Key Bindings of Summary, Variables of Summary, Mark and Action, Summary
3176 @section Key bindings
3177 @cindex Keybind, Summary Mode
3178 @cindex Keybind, Summary Buffer
3180 Key bindings of the summary mode are shown below.
3184 @kindex @key{SPC} (Summary)
3185 @findex wl-summary-read
3186 Proceed reading a message at the current cursor point.
3187 (@code{wl-summary-read})
3191 @findex wl-summary-redisplay
3192 Redisplay a message at the current cursor point with default display
3193 type. If this command is called with prefix argument, reload and redisplay
3194 message regardless of the message cache.
3195 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u .},
3196 reload and redisplay message with current display type regardless of the
3197 message cache. (@code{wl-summary-redisplay})
3201 @findex wl-summary-display-top
3202 Display the top message in the folder.
3203 (@code{wl-summary-display-top})
3207 @findex wl-summary-display-bottom
3208 Display the bottom message in the folder.
3209 (@code{wl-summary-display-bottom})
3213 @kindex @key{BS} (Summary)
3214 @kindex @key{DEL} (Summary)
3215 Display the previous page of the message at the current cursor point.
3216 @findex wl-summary-prev-page
3217 (@code{wl-summary-prev-page})
3220 @kindex @key{RET} (Summary)
3221 @findex wl-summary-enter-handler
3222 Display the next line of the message at the current cursor point.
3223 Display the message at the current cursor point if it is not displayed
3224 yet. (@code{wl-summary-next-line-content}) If prefix argument is
3225 specified, message is scrolled up by one line.
3226 (@code{wl-summary-prev-line-content}) If prefix argument is numeric,
3227 cursor is jumped to the message with specified number.
3232 @kindex M-@key{RET} (Summary)
3233 @findex wl-summary-prev-line-content
3234 Display the previous line of the message at the current cursor point.
3235 Display the message at the current cursor point if it is not displayed yet.
3236 (@code{wl-summary-prev-line-content})
3240 @findex wl-thread-open-close
3241 Toggle open or close the thread at the current cursor point.
3242 With prefix argument, open all children threads.
3243 (@code{wl-thread-open-close})
3248 @findex wl-thread-open-all
3249 (@code{wl-thread-open-all})
3254 @findex wl-thread-close-all
3255 (@code{wl-thread-close-all})
3259 @findex wl-summary-goto-folder
3261 (@code{wl-summary-goto-folder})
3265 Mark all messages in the folder as read.
3266 @findex wl-summary-mark-as-read-all
3267 (@code{wl-summary-mark-as-read-all})
3271 @findex wl-summary-reply
3272 Prepare a draft for reply the message at the current cursor point.
3273 (@code{wl-summary-reply})
3277 @findex wl-summary-reply-with-citation
3278 Prepare a draft for reply the message at the current cursor point.
3279 (@code{wl-summary-reply-with-citation})
3283 @findex wl-summary-cancel-message
3284 If the message at current cursor point is your own netnews article,
3286 (@code{wl-summary-cancel-message})
3290 @findex wl-summary-reedit
3291 Prepare a draft for re-editing the message at current cursor point.
3292 If the message at current cursor point is your own netnews article,
3293 a draft for `supersedes message' for the message is prepared.
3294 (@code{wl-summary-reedit})
3297 @kindex M-E (Summary)
3298 @findex wl-summary-resend-bounced-mail
3299 If the message at current cursor point is a bounced message,
3300 a draft for re-sending original message is prepared.
3301 (@code{wl-summary-resend-bounced-mail})
3305 @findex wl-summary-forward
3306 A draft for forwarding the message at current cursor point is prepared.
3307 (@code{wl-summary-forward})
3311 @findex wl-summary-mark-as-important
3312 Put @samp{important} flag on the message at current cursor point.
3313 If already flagged as @samp{important}, remove the flag. If it is
3314 called with prefix argument, ask global flag to put similarly to @kbd{F}.
3315 (@code{wl-summary-mark-as-important})
3319 @findex wl-summary-set-flags
3320 Put arbitrary global flag entered in the minibuffer. If you use Emacs
3321 21 or later, you can specify multiple flags separated by @samp{,}
3322 simultaneously. If it is called with prefix argument, remove existent
3324 (@code{wl-summary-set-flags})
3330 Save the message at current cursor point.
3331 @findex wl-summary-save
3332 (@code{wl-summary-save})
3336 @findex wl-summary-next
3337 Move cursor to the next message.
3338 If message is marked with a temporal mark in
3339 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3340 In the offline mode, cursor is not moved to the messages which are not cached
3342 (@code{wl-summary-next})
3346 @findex wl-summary-prev
3347 Move cursor to the previous message.
3348 If message is marked with a temporal mark in
3349 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3350 In the offline mode, cursor is not moved to the messages which are not cached
3352 (@code{wl-summary-prev})
3356 @findex wl-summary-down
3357 Move cursor to the downward message which is unread or marked
3359 In the offline mode, cursor is not moved to the messages which are not cached
3361 If there are messages which have target mark @samp{*} in the summary,
3362 cursor is moved to the downward message which have a target mark.
3363 This behavior is changed according to the value of @code{wl-summary-move-order}.
3364 (@code{wl-summary-down})
3368 @findex wl-summary-up
3369 Move cursor to the upward message which is unread or marked
3371 In the offline mode, cursor is not moved to the messages which are not cached
3373 If there are messages which have target mark @samp{*} in the summary,
3374 cursor is moved to the downward message which have a target mark.
3375 This behavior is changed according to the value of @code{wl-summary-move-order}.
3376 (@code{wl-summary-up})
3380 @findex wl-summary-write
3381 Prepare a new draft.
3382 (@code{wl-summary-write})
3386 @findex wl-summary-write-current-folder
3387 Prepare a new draft. If the current folder is NNTP folder,
3388 @samp{Newsgroups:} field is completed. If the current folder is mailing
3389 list folder (refile destination), guess @samp{To:} field and completed
3390 (If @code{wl-subscribed-mailing-list} is valid list)
3391 (@code{wl-summary-write-current-folder})
3395 @findex wl-summary-toggle-all-header
3396 Toggle display type between all and partial header fields and redisplay
3397 the message at current cursor point. If this command is called with
3398 prefix argument, reload and redisplay message regardless of the message cache.
3399 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u H},
3400 set default display type of summary by current display type of header fields.
3401 (@code{wl-summary-toggle-all-header})
3405 @findex wl-summary-toggle-mime
3406 Toggle display type for MIME analysis and redisplay the message at
3407 current cursor point. A change is performed in the order set as
3408 @code{wl-summary-display-mime-mode-list}. If this command is called
3409 with numeric prefix argument, it switch directly as follows.
3413 1: Enable MIME analysis.
3414 2: Enable MIME analysis only for header fields.
3415 3: Disable MIME analysis.
3419 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u
3420 M}, set default display type of summary by current display type of MIME
3421 analysis. (@code{wl-summary-toggle-mime})
3424 @kindex C-c C-f (Summary)
3425 @findex wl-summary-toggle-header-narrowing
3426 Toggle header body narrowing of the message at current cursor point.
3427 (@code{wl-summary-toggle-header-narrowing})
3431 @findex wl-summary-burst
3432 If the message at current cursor point has
3433 encapsulates multiple messages using MIME,
3434 de-capsulate and extract them on the current folder.
3435 If it is invoked in non-writable folder or it is called with prefix
3436 argument, it asks the destination folder.
3437 (@code{wl-summary-burst})
3440 @kindex @@ (Summary)
3441 @findex wl-summary-edit-addresses
3442 Append/change/delete the message's sender information to the address
3443 book @file{~/.addresses} interactively. If this command is called with
3444 prefix argument, arbitrary address can be edited.
3445 (@code{wl-summary-edit-petname})
3449 @findex wl-status-update
3450 Sync up address book status with @file{~/.addresses}'s content.
3451 (@code{wl-status-update})
3455 @findex wl-summary-pipe-message
3456 Pipe current message's content to the external process.
3457 (@code{wl-summary-pipe-message})
3461 @findex wl-summary-print-message
3462 Print out current message's content.
3463 It uses @code{ps-print} module in Emacs 20.x.
3464 If you don't use color printer, you might want to set
3465 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3468 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3471 (@code{wl-summary-print-message})
3475 @findex wl-summary-exit
3476 Exit current folder.
3477 (@code{wl-summary-exit})
3481 @findex wl-summary-jump-to-current-message
3482 Jump cursor to the currently displayed message's window.
3483 (@code{wl-summary-jump-to-current-message})
3487 Jump cursor to the other message.
3488 @findex wl-summary-jump-to-msg
3489 (@code{wl-summary-jump-to-msg})
3493 Update summary status and
3494 prefetch all messages which have marks included in the
3495 @code{wl-summary-incorporate-marks}.
3496 @findex wl-summary-incorporate
3497 (@code{wl-summary-incorporate})
3500 @kindex M-j (Summary)
3501 @findex wl-summary-jump-to-msg-by-message-id
3502 Jump cursor to the message which have specified @samp{Message-Id:}. If
3503 @code{elmo-use-database} is non-nil, other folder is also searched.
3504 (@code{wl-summary-jump-to-msg-by-message-id})
3508 Jump to parent message.
3509 @findex wl-summary-jump-to-parent-message
3510 (@code{wl-summary-jump-to-parent-message})
3514 @findex wl-summary-mark-as-unread
3515 Mark as unread the message at current cursor point.
3516 (@code{wl-summary-mark-as-unread})
3520 @findex wl-summary-sync
3521 Synchronize summary view after prompting the update range.
3522 You can specify one of the follows.
3526 all Discard present msgdb and retrieve all informations.
3527 Do not retrieve killed messages.
3528 all-entirely Discard present msgdb and retrieve all informations.
3529 Retrieve killed messages, too.
3530 update Update the difference between informations in present
3531 msgdb and in current folder instance.
3532 Do not retrieve killed messages.
3533 update-entirely Update the difference between informations in present
3534 msgdb and in current folder instance.
3535 Retrieve killed messages, too.
3536 rescan Redisplay summary by rescanning present msgdb.
3537 rescan-noscore Redisplay summary by rescanning present msgdb.
3538 Display messages killed by score, too.
3539 rescan-thread Redisplay summary by rescanning present msgdb.
3540 Reconstruct thread, too.
3541 cache-status Sync the all marks with the real status of cache.
3544 first:NUM Move to the filter folder(partial filter).
3545 last:NUM Move to the filter folder(partial filter).
3550 (@code{wl-summary-sync})
3554 @findex wl-summary-sort
3556 You can sort by @samp{date}, @samp{from}, @samp{number}, @samp{subject},
3557 @samp{size} and @samp{list-info}.
3558 With prefix argument, sort summary lines into descending order.
3559 (@code{wl-summary-sort})
3563 @findex wl-summary-toggle-thread
3564 Toggle the threading. The state will be preserved after exiting
3565 Wanderlust. You can alter default state for newly created summary
3566 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3567 Threading status is displayed on the modeline.
3568 @samp{@{S@}} means threading is off (Sequence) and
3569 @samp{@{T@}} means threading is on (Thread).
3570 (@code{wl-summary-toggle-thread})
3574 @findex wl-summary-toggle-disp-folder
3575 Toggle displaying of folder window.
3576 (@code{wl-summary-toggle-disp-folder})
3580 Toggle displaying of message window.
3581 @findex wl-summary-toggle-disp-msg
3582 (@code{wl-summary-toggle-disp-msg})
3586 Move to the virtual folder (filter folder) with the condition specified.
3587 If called with prefix argument and current folder is virtual, exit it.
3588 @findex wl-summary-virtual
3589 (@code{wl-summary-virtual})
3592 @kindex @key{TAB} (Summary)
3593 @findex wl-summary-goto-last-displayed-msg
3594 Jump to the message which is displayed last.
3595 (@code{wl-summary-goto-last-displayed-msg})
3599 Put @samp{*} mark on the messages that satisfies the specified condition.
3600 If messages already have @samp{*} mark, new @samp{*} marks are overridden.
3601 If prefix argument is specified, current @samp{*} marks are removed and
3602 new @samp{*} marks are appended.
3604 @findex wl-summary-pick
3605 (@code{wl-summary-pick})
3609 @findex wl-summary-mark-as-read
3610 Mark as read the message at the current cursor point.
3611 (@code{wl-summary-mark-as-read})
3615 Execute action for all temporary marks in the summary buffer.
3616 @findex wl-summary-exec
3617 (@code{wl-summary-exec})
3621 @findex wl-summary-target-mark-line
3622 Put target mark on the message at the current cursor point.
3623 (@code{wl-summary-target-mark-line}) @xref{Mark and Action}.
3627 Put refile mark on the message at the current cursor point.
3628 @findex wl-summary-refile
3629 (@code{wl-summary-refile}) @xref{Mark and Action}.
3632 @kindex C-o (Summary)
3633 Execute auto refile.
3634 @findex wl-summary-auto-refile
3635 (@code{wl-summary-auto-refile})
3639 Put copy mark on the message at the current cursor point.
3640 @findex wl-summary-copy
3641 (@code{wl-summary-copy}) @xref{Mark and Action}.
3644 @kindex M-o (Summary)
3645 Put refile mark on the message at the current cursor point with the destination
3646 previously specified.
3647 @findex wl-summary-refile-prev-destination
3648 (@code{wl-summary-refile-prev-destination})
3652 @findex wl-summary-dispose
3653 Put disposal mark on the message at the current cursor point.
3654 The result of disposal is controlled by @code{wl-dispose-folder-alist},
3655 refiled to @code{wl-trash-folder} by default.
3656 (@code{wl-summary-dispose}) @xref{Mark and Action}.
3660 @findex wl-summary-delete
3661 Put force deletion mark on the message at the current cursor point.
3662 (@code{wl-summary-delete}) @xref{Mark and Action}.
3666 Put prefetch reservation mark on the message at the current cursor point.
3667 @findex wl-summary-prefetch
3668 (@code{wl-summary-prefetch}) @xref{Mark and Action}.
3672 @findex wl-summary-resend
3673 Put resend reservation mark on the message at the current cursor point.
3674 (@code{wl-summary-resend}) @xref{Mark and Action}.
3678 @findex wl-summary-unmark
3679 Unmark the temporal mark on the message at the current cursor point.
3680 (@code{wl-summary-unmark})
3684 Unmark all the temporal marks.
3685 @findex wl-summary-unmark-all
3686 (@code{wl-summary-unmark-all})
3689 @kindex r R (Summary)
3690 @findex wl-summary-mark-as-read-region
3691 Mark as read messages in the specified region.
3692 (@code{wl-summary-mark-as-read-region})
3695 @kindex r $ (Summary)
3696 @findex wl-summary-mark-as-important-region
3697 Put @samp{important} flag on messages in the specified region.
3698 If already flagged as @samp{important}, remove the flag.
3699 (@code{wl-summary-mark-as-important-region})
3702 @kindex r F (Summary)
3703 @findex wl-summary-set-flags-region
3704 Put arbitrary global flag entered in the minibuffer on messages in
3706 (@code{wl-summary-set-flags-region})
3709 @kindex r ! (Summary)
3710 @findex wl-summary-mark-as-unread-region
3711 Mark as unread messages in the specified region.
3712 (@code{wl-summary-mark-as-unread-region})
3715 @kindex r x (Summary)
3716 @findex wl-summary-exec-region
3717 Execute action for each temporary marks on the messages in the
3719 (@code{wl-summary-exec-region})
3722 @kindex r * (Summary)
3723 @findex wl-summary-target-mark-region
3724 Put target mark on the messages in the specified region.
3725 (@code{wl-summary-target-mark-region}) @xref{Mark and Action}.
3728 @kindex r o (Summary)
3729 @findex wl-summary-refile-region
3730 Put refile mark on the messages in the specified region.
3731 (@code{wl-summary-refile-region}) @xref{Mark and Action}.
3734 @kindex r O (Summary)
3735 @findex wl-summary-copy-region
3736 Put copy mark on the messages in the specified region.
3737 (@code{wl-summary-copy-region}) @xref{Mark and Action}.
3740 @kindex r d (Summary)
3741 @findex wl-summary-dispose-region
3742 Put disposal mark on the messages in the specified region.
3743 (@code{wl-summary-dispose-region}) @xref{Mark and Action}.
3746 @kindex r D (Summary)
3747 @findex wl-summary-delete-region
3748 Put force deletion mark on the messages in the specified region.
3749 (@code{wl-summary-delete-region}) @xref{Mark and Action}.
3752 @kindex r i (Summary)
3753 @findex wl-summary-prefetch-region
3754 Put prefetch reservation mark on messages in the specified region.
3755 (@code{wl-summary-prefetch-region}) @xref{Mark and Action}.
3758 @kindex r u (Summary)
3759 @findex wl-summary-unmark-region
3760 Delete temporal mark on the messages in the specified region.
3761 (@code{wl-summary-unmark-region})
3764 @kindex r y (Summary)
3765 Save messages in the specified region.
3766 @findex wl-summary-save-region
3767 (@code{wl-summary-save-region})
3770 @kindex t R (Summary)
3771 @findex wl-thread-mark-as-read
3772 Mark as read messages which are the descendant of the current thread.
3773 With prefix argument, it affects on the all messages in the thread tree.
3774 (@code{wl-thread-mark-as-read})
3777 @kindex t $ (Summary)
3778 @findex wl-thread-mark-as-important
3779 Put @samp{important} flag on the messages which are the descendant of
3780 the current thread. If already flagged as @samp{important}, remove the
3781 flag. With prefix argument, it affects on the all messages in the
3783 (@code{wl-thread-mark-as-important})
3786 @kindex t F (Summary)
3787 @findex wl-thread-set-flags
3788 Put arbitrary global flag entered in the minibuffer on the messages
3789 which are the descendant of the current thread. With prefix argument,
3790 it affects on the all messages in the thread tree.
3791 (@code{wl-thread-set-flags})
3794 @kindex t ! (Summary)
3795 @findex wl-thread-mark-as-unread
3796 Mark as unread messages which are the descendant of the current thread.
3797 With prefix argument, it affects on the all messages in the thread tree.
3798 (@code{wl-thread-mark-as-unread})
3801 @kindex t x (Summary)
3802 @findex wl-thread-exec
3803 Execute action for temporary marks on the messages which are
3804 the descendant of the current thread. With prefix argument, it affects
3805 on the all messages in the thread tree.
3806 (@code{wl-thread-exec})
3809 @kindex t * (Summary)
3810 @findex wl-thread-target-mark
3811 Put target mark @samp{*} on the messages which are the descendant of the
3812 current thread. With prefix argument, it affects on the all messages in
3814 (@code{wl-thread-target-mark}) @xref{Mark and Action}.
3817 @kindex t o (Summary)
3818 @findex wl-thread-refile
3819 Put refile mark on the messages which are the descendant of the current thread.
3820 With prefix argument, it affects on the all messages in the thread tree.
3821 (@code{wl-thread-refile}) @xref{Mark and Action}.
3824 @kindex t O (Summary)
3825 @findex wl-thread-copy
3826 Put copy mark on the messages which are the descendant of the current thread.
3827 With prefix argument, it affects on the all messages in the thread tree.
3828 (@code{wl-thread-copy}) @xref{Mark and Action}.
3831 @kindex t d (Summary)
3832 @findex wl-thread-dispose
3833 Put disposal mark on the messages which are the descendant of the current thread.
3834 With prefix argument, it affects on the all messages in the thread tree.
3835 (@code{wl-thread-dispose}) @xref{Mark and Action}.
3838 @kindex t D (Summary)
3839 @findex wl-thread-delete
3840 Put force deletion mark on the messages which are the descendant of the
3842 (@code{wl-thread-delete}) @xref{Mark and Action}.
3845 @kindex t i (Summary)
3846 @findex wl-thread-prefetch
3847 Put prefetch reservation mark on messages which are the descendant of
3849 (@code{wl-thread-prefetch}) @xref{Mark and Action}.
3852 @kindex t u (Summary)
3853 @findex wl-thread-unmark
3854 Unmark temporal mark on the messages which are the descendant of the
3855 current thread. With prefix argument, it affects on the all messages in
3857 (@code{wl-thread-unmark})
3860 @kindex t y (Summary)
3861 @findex wl-thread-save
3862 Save messages which are the descendant of the current thread.
3863 With prefix argument, it affects on the all messages in the thread tree.
3864 (@code{wl-thread-save})
3867 @kindex m R (Summary)
3868 @findex wl-summary-target-mark-mark-as-read
3869 Mark as read all messages which have target mark @samp{*}.
3870 (@code{wl-summary-target-mark-mark-as-read})
3873 @kindex m $ (Summary)
3874 @findex wl-summary-target-mark-mark-as-important
3875 Put @samp{important} flag on all messages which have target mark @samp{*}.
3876 If already flagged as @samp{important}, remove the flag.
3877 (@code{wl-summary-target-mark-mark-as-important})
3880 @kindex m F (Summary)
3881 @findex wl-summary-target-mark-set-flags
3882 Put arbitrary global flag entered in the minibuffer on all messages
3883 which have target mark @samp{*}.
3884 (@code{wl-summary-target-mark-set-flags})
3887 @kindex m ! (Summary)
3888 @findex wl-summary-target-mark-mark-as-unread
3889 Mark as unread all messages which have target mark @samp{*}.
3890 (@code{wl-summary-target-mark-mark-as-unread})
3893 @kindex m o (Summary)
3894 @findex wl-summary-target-mark-refile
3895 Put refile mark on the messages which have target mark @samp{*}.
3896 (@code{wl-summary-target-mark-refile}) @xref{Mark and Action}.
3899 @kindex m O (Summary)
3900 @findex wl-summary-target-mark-copy
3901 Put copy mark on the messages which have target mark @samp{*}.
3902 (@code{wl-summary-target-mark-copy}) @xref{Mark and Action}.
3905 @kindex m d (Summary)
3906 @findex wl-summary-target-mark-dispose
3907 Put disposal mark on the messages which have target mark @samp{*}.
3908 (@code{wl-summary-target-mark-dispose}) @xref{Mark and Action}.
3911 @kindex m D (Summary)
3912 @findex wl-summary-target-mark-delete
3913 Put force deletion mark on the messages which have target mark @samp{*}.
3914 (@code{wl-summary-target-mark-delete}) @xref{Mark and Action}.
3917 @kindex m i (Summary)
3918 @findex wl-summary-target-mark-prefetch
3919 Put prefetch reservation mark on messages which have target mark @samp{*}.
3920 (@code{wl-summary-target-mark-prefetch}) @xref{Mark and Action}.
3923 @kindex m y (Summary)
3924 @findex wl-summary-target-mark-save
3925 Save messages which have target mark @samp{*}.
3926 (@code{wl-summary-target-mark-save})
3929 @kindex m u (Summary)
3930 Unmark all temporal marks.
3931 (@code{wl-summary-delete-all-temp-marks})
3932 @findex wl-summary-delete-all-temp-marks
3935 @kindex m a (Summary)
3936 Put target mark @samp{*} on the all messages.
3937 (@code{wl-summary-target-mark-all})
3938 @findex wl-summary-target-mark-all
3941 @kindex m t (Summary)
3942 Put target mark @samp{*} on the messages in the current thread.
3943 @findex wl-summary-target-mark-thread
3944 (@code{wl-summary-target-mark-thread})
3947 @kindex m r (Summary)
3948 @findex wl-summary-target-mark-region
3949 Put target mark @samp{*} on the messages in the specified region.
3950 (@code{wl-summary-target-mark-region})
3953 @kindex m A (Summary)
3954 @findex wl-summary-target-mark-reply-with-citation
3955 Prepare a draft which cites all messages which have target mark @samp{*}.
3956 (@code{wl-summary-target-mark-reply-with-citation})
3959 @kindex m f (Summary)
3960 @findex wl-summary-target-mark-forward
3961 Prepare a draft which forwards all messages which have target mark @samp{*}.
3962 (@code{wl-summary-target-mark-forward})
3965 @kindex m U (Summary)
3966 @findex wl-summary-target-mark-uudecode
3967 Uudecode the messages which have target mark @samp{*}.
3968 (@code{wl-summary-target-mark-uudecode})
3971 @kindex m ? (Summary)
3972 @findex wl-summary-target-mark-pick
3973 Pick messages from the @samp{*} marked messages.
3974 That is, @samp{*} marks on the messages are remained
3975 if the specified condition is satisfied.
3976 (@code{wl-summary-target-mark-pick})
3979 @kindex m # (Summary)
3980 @findex wl-summary-target-mark-print
3981 Print out all messages which have target mark @samp{*}.
3982 (@code{wl-summary-target-mark-print})
3985 @kindex m | (Summary)
3986 @findex wl-summary-target-mark-pipe
3987 Pipe content of each message with target mark @samp{*} to some specified
3989 (@code{wl-summary-target-mark-pipe})
3992 @kindex M-t (Summary)
3993 @findex wl-toggle-plugged
3994 Toggle offline/online status of Wanderlust.
3995 (@code{wl-toggle-plugged})
3998 @kindex C-t (Summary)
3999 Start Wanderlust's plug-status manager.
4000 (@code{wl-plugged-change})
4003 @kindex C-c C-o (Summary)
4004 @findex wl-jump-to-draft-buffer
4005 Move to the draft buffer if available. If multiple draft buffer exists,
4006 moved to one after another. If prefix argument is specified, load draft
4007 folder's message to the draft buffer and jump to it.
4008 (@code{wl-jump-to-draft-buffer})
4011 @kindex M-w (Summary)
4012 @findex wl-summary-save-current-message
4013 Save the message at the current cursor point.
4014 (@code{wl-summary-save-current-message})
4017 @kindex C-y (Summary)
4018 @findex wl-summary-yank-saved-message
4019 Regard the message at the current cursor point as
4020 parent, connect the message saved by
4021 @code{wl-summary-save-current-message}
4023 (@code{wl-summary-yank-saved-message})
4026 @kindex C-x C-s (Summary)
4027 @findex wl-summary-save-status
4028 Save the current summary.
4029 (@code{wl-summary-save-status})
4033 @node Variables of Summary, , Key Bindings of Summary, Summary
4034 @section Customiziable variables
4037 @item wl-summary-move-order
4038 @vindex wl-summary-move-order
4039 The initial setting is @code{unread}. Specify cursor moving policy. If
4040 you want to precede new messages, set @code{new}. If you want to
4041 precede unread messages, set @code{unread}. If @code{nil}, proceed to
4044 @item wl-auto-select-first
4045 @vindex wl-auto-select-first
4046 The initial setting is @code{nil}.
4047 If non-nil, first message is automatically displayed when you enter
4050 @item wl-auto-select-next
4051 @vindex wl-auto-select-next
4052 The initial setting is @code{nil}. This controls behavior when there is
4053 no unread message in current summary.
4056 nil: asks whether you want to go back to folder mode
4057 'unread: asks whether you want to go to next unread folder
4058 If the next one comes to be possessing no unread message
4059 by treatment of cross-posted messages or Scoring, then
4060 asks whether you want to go to next to next folder.
4061 'skip-no-unread: similar as unread
4062 But does not ask before going to next to next folder.
4063 otherwise: asks whether you want to go to next unread folder
4066 It might be useful to set @code{'skip-no-unread} for people who
4067 want to continue reading by just pressing and pressing space key.
4069 @item wl-thread-insert-opened
4070 @vindex wl-thread-insert-opened
4071 The initial setting is @code{nil}.
4072 If non-nil, thread is inserted as opened.
4074 @item wl-thread-open-reading-thread
4075 @vindex wl-thread-open-reading-thread
4076 The initial setting is @code{t}. If non-nil, reading thread is
4077 automatically opened though it is closed thread.
4079 @item wl-summary-exit-next-move
4080 @vindex wl-summary-exit-next-move
4081 The initial setting is @code{t}. If non-nil, move to next folder at
4084 @item wl-folder-move-cur-folder
4085 @vindex wl-folder-move-cur-folder
4086 The initial setting is @code{nil}. If non-nil, cursor position on the
4089 @item wl-summary-weekday-name-lang
4090 @vindex wl-summary-weekday-name-lang
4091 Specify language of the weekday.
4092 @samp{en} displays English, @samp{fr} displays French, @samp{de}
4093 displays Deutsch. You should rescan summary view after changing this value.
4095 @item wl-summary-fix-timezone
4096 @vindex wl-summary-fix-timezone
4097 The initial setting is @code{nil}.
4098 Time zone of the date string in summary mode is adjusted using this value.
4099 If @code{nil}, it is adjust to the default time zone information
4100 (system's default time zone or environment variable @samp{TZ}).
4102 @item wl-use-petname
4103 @vindex wl-use-petname
4104 The initial setting is @code{t}.
4105 If non-nil, sender part displays nickname.
4107 @item wl-break-pages
4108 @vindex wl-break-pages
4109 The initial setting is @code{t}.
4110 If non-nil, message is split as pages by @samp{^L}.
4112 @item wl-message-window-size
4113 @vindex wl-message-window-size
4114 The initial setting is '(1 . 4).
4115 A cons cell to specify the rate of summary and message window.
4116 car:cdr corresponds summary:message.
4118 @item wl-summary-from-function
4119 @vindex wl-summary-from-function
4120 Format function to display sender in summary.
4121 The initial setting is @code{wl-summary-default-from}.
4123 @item wl-summary-no-from-message
4124 @vindex wl-summary-no-from-message
4125 The initial setting is @samp{nobody@@nowhere?}. A string which is
4126 displayed when there's no @samp{From:} field in the message.
4128 @item wl-summary-subject-function
4129 @vindex wl-summary-subject-function
4130 Format function to display subject in summary.
4131 The initial setting is @code{wl-summary-default-subject} and
4132 it will cut the list name part etc. on the top of the subject.
4133 To display subject as it is, set as follows.
4136 (setq wl-summary-subject-function 'identity)
4139 @item wl-summary-no-subject-message
4140 @vindex wl-summary-no-subject-message
4141 The initial setting is @samp{(WL:No Subject in original.)}. A string
4142 which is displayed when there's no @samp{Subject:} field in the message.
4144 @item wl-summary-default-view
4145 @vindex wl-summary-default-view
4146 The initial setting is @code{'thread}.
4147 The default state for newly created summary. You can set either
4148 @code{'thread} for thread view or @code{'sequence} for sequential view.
4150 @item wl-summary-use-frame
4151 @vindex wl-summary-use-frame
4152 The initial setting is @code{nil}.
4153 If non-nil, use new frame for the summary.
4155 @item wl-use-folder-petname
4156 @vindex wl-use-folder-petname
4157 The initial setting is the list shown below:
4166 A list of display policy (symbol) of folder nickname. Available symbols
4171 Display folder petname on modeline.
4173 Destination folder is notified as nickname if
4174 @code{wl-auto-select-next} is non-nil.
4176 You can input folder name by nickname in the function
4177 @code{wl-summary-read-folder}.
4180 @item wl-summary-move-direction-toggle
4181 @vindex wl-summary-move-direction-toggle
4182 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
4183 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
4184 want to aware of reading direction, set this to @code{t}.
4186 @item wl-summary-width
4187 @vindex wl-summary-width
4188 The initial setting is 80.
4189 Width of summary line. If @code{nil}, summary line's width is as is.
4191 @item wl-summary-print-argument-within-window
4192 @vindex wl-summary-print-argument-within-window
4193 The initial setting is @code{nil}.
4194 If non-nil, the action argument is always printed on right side of
4197 @item wl-summary-indent-length-limit
4198 @vindex wl-summary-indent-length-limit
4199 The initial setting is 46.
4200 Specify the limit of thread indent level. @code{nil} means unlimited
4202 If you set this to @code{nil} you should set @code{wl-summary-width}
4205 @item wl-summary-max-thread-depth
4206 @vindex wl-summary-max-thread-depth
4207 The initial setting is 15.
4208 If thread depth of the message is larger than this value,
4209 the thread is divided.
4211 @item wl-summary-recenter
4212 @vindex wl-summary-recenter
4213 The initial setting is t.
4214 If non-nil, cursor point is moved to the center of the summary window.
4216 @item wl-summary-max-thread-depth
4217 @vindex wl-summary-max-thread-depth
4218 The initial setting is 30.
4219 If thread depth is larger than this value, divide it.
4221 @item wl-summary-divide-thread-when-subject-changed
4222 @vindex wl-summary-divide-thread-when-subject-changed
4223 The initial setting is @code{nil}. If non-nil, thread is split if
4224 the subject is changed.
4226 @item wl-summary-search-via-nntp
4227 @vindex wl-summary-search-via-nntp
4228 The initial setting is @code{confirm}.
4230 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
4231 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
4232 from the NNTP server @code{elmo-nntp-default-server}. The value of
4233 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
4234 @code{elmo-nntp-default-stream-type} are used.
4236 If @code{confirm}, server name can be specified. You can specify NNTP
4237 folder format like @samp{-:username@@servername:119!}.
4239 @item wl-summary-keep-cursor-command
4240 @vindex wl-summary-keep-cursor-command
4241 The initial setting is the list shown below:
4245 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
4250 When you entered to summary by these commands and the target summary
4251 buffer already exists, summary status is not automatically updated and
4252 cursor position is saved.
4254 @item elmo-folder-update-threshold
4255 @vindex elmo-folder-update-threshold
4256 The initial setting is 500. If updated message number is larger than
4257 this value, confirm whether drop them or not (in the case where the value
4258 of @code{elmo-folder-update-confirm} is non-nil).
4260 @item elmo-folder-update-confirm
4261 @vindex elmo-folder-update-confirm
4262 The initial setting is @code{t}. If the value is non-nil, do check with
4263 @code{elmo-folder-update-threshold}.
4265 @item wl-summary-always-sticky-folder-list
4266 @vindex wl-summary-always-sticky-folder-list
4267 The initial setting is @code{nil}.
4268 @code{wl-summary-always-sticky-folder-list} specifies the folders that
4269 are automatically stuck. Each element is regexp of folder name.
4271 @item wl-summary-reserve-mark-list
4272 @vindex wl-summary-reserve-mark-list
4273 The initial setting is the list shown below:
4277 ("o" "O" "D" "d" "i")
4282 If a message is already marked as temporal marks in this list, the
4283 message is not marked by any mark command.
4285 @item wl-summary-skip-mark-list
4286 @vindex wl-summary-skip-mark-list
4287 The initial setting is the list shown below:
4296 If a message is already marked as temporal marks in this list, the
4297 message is skipped at cursor move.
4299 @item elmo-message-fetch-threshold
4300 @vindex elmo-message-fetch-threshold
4301 The initial setting is 30000 (bytes). If displaying message has larger
4302 size than this value, Wanderlust confirms whether fetch the message or
4303 not (in the case where the value of @code{elmo-message-fetch-confirm}
4306 @item elmo-message-fetch-confirm
4307 @vindex elmo-message-fetch-confirm
4308 The initial setting is @code{t}. If the value is non-nil, do check with
4309 @code{elmo-message-fetch-threshold}.
4311 @item wl-prefetch-threshold
4312 @vindex wl-prefetch-threshold
4313 The initial setting is 30000 (bytes). If prefetching message has larger
4314 size than this value and @code{wl-prefetch-confirm} is non-nil,
4315 Wanderlust confirms whether prefetch the message or not. If
4316 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
4317 without confirmation.
4319 @item wl-prefetch-confirm
4320 @vindex wl-prefetch-confirm
4321 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4322 prefetch the message or not if the message has larger size than
4323 @code{wl-prefetch-threshold}.
4325 @item elmo-imap4-use-cache
4326 @vindex elmo-imap4-use-cache
4327 The initial setting is @code{t}. If non-nil, messages read via IMAP4
4330 @item elmo-nntp-use-cache
4331 @vindex elmo-nntp-use-cache
4332 The initial setting is @code{t}. If non-nil, messages read via NNTP are
4335 @item elmo-pop3-use-cache
4336 @vindex elmo-pop3-use-cache
4337 The initial setting is @code{t}. If non-nil, messages read via POP3 are
4340 @item elmo-shimbun-use-cache
4341 @vindex elmo-shimbun-use-cache
4342 The initial setting is @code{t}. If non-nil, messages read in Shimbun
4345 @item wl-folder-process-duplicates-alist
4346 @vindex wl-folder-process-duplicates-alist
4347 The initial setting is @code{nil}.
4348 This list determines how to deal with duplicated messages in the same folder.
4349 Each item in the list is regexp of folder name and action; you can specify any
4350 one of the following in the place of action:
4353 @code{nil} : do nothing for duplicated messages.
4354 @code{hide} : hide duplicated messages from the summary.
4355 @code{read} : set duplicated messages as read.
4359 Following is an example (hide duplicated messages in multi folders)
4363 (setq wl-folder-process-duplicates-alist
4364 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4365 ("^\\*.*" . hide) (".*" . read)))
4369 @item wl-summary-flag-alist
4370 @vindex wl-summary-flag-alist
4371 The initial setting is as follows:
4375 ((important "orange"))
4379 Specify the color and the mark of message in summary buffer with flag.
4380 If the mark are omitted, the mark specified in the variable
4381 @code{wl-summary-flag-mark} is assumed. If multiple global flags are on
4382 one message, the former flag in this list is preferred.
4388 (setq wl-summary-flag-alist
4389 '((important "purple")
4391 (business "green" "B")
4392 (private "blue" "X")))
4396 @item wl-summary-display-mime-mode-list
4397 @vindex wl-summary-display-mime-mode-list
4398 The initial setting is the list shown below:
4407 The function @code{wl-summary-toggle-mime} switch specification of MIME
4408 analysis in the order of this list. You can specify one of the follows.
4411 @code{mime} : Header and body are decoded.
4412 @code{header-only} : Only header is decoded.
4413 @code{as-is} : Header and body are not decoded.
4418 @node Message, Draft, Summary, Top
4419 @chapter Message Buffer
4421 Message Buffers utilize MIME-View mode of SEMI. For operational
4422 procedures and key bindings, refer to respective documents.
4423 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4424 You can also see help by @kbd{?} in message buffer.
4426 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4427 brings you back to Summary mode. @kbd{l} toggles display of Summary
4430 @section Key Bindings
4436 @findex wl-message-toggle-disp-summary
4437 Toggles display of Summary buffer.
4438 (@code{wl-message-toggle-disp-summary})
4441 @findex wl-message-refer-article-or-url
4442 @kindex Button-2 (Message)
4443 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4444 corresponding message if found.
4445 (@code{wl-message-refer-article-or-url})
4447 @item Button-4 (upward movement of a wheel)
4448 @kindex Button-4 (Message)
4449 @findex wl-message-wheel-down
4450 Scrolls the message backwards. When the top of the message is hit,
4451 moves to the previous message.
4452 (@code{wl-message-wheel-down})
4454 @item Button-5 (downward movement of a wheel)
4455 @kindex Button-5 (Message)
4456 @findex wl-message-wheel-up
4457 Scrolls the message forward. When the bottom of the message is hit,
4458 moves to the next message.
4459 (@code{wl-message-wheel-up})
4463 @findex wl-message-delete-current-part
4464 Delete the part under cursor. In fact it appends modified message to
4465 the current folder then moves old one to trash folder. Therefore the
4466 message number will be changed.
4467 (@code{wl-message-delete-current-part})
4470 @section Customizable Variables
4473 @item wl-message-window-size
4474 @vindex wl-message-window-size
4475 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4476 its car and cdr value corresponds to the ratio of Summary and Message
4479 @item wl-message-ignored-field-list
4480 @vindex wl-message-ignored-field-list
4481 Initial setting is @code{nil}.
4482 All fields that match this list will be hidden in message buffer.
4483 Each elements are regexp of field-name.
4484 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4486 @item wl-message-visible-field-list
4487 @vindex wl-message-visible-field-list
4488 Initial setting is @code{nil}.
4489 All fields that match this list will be display in message buffer.
4490 Each elements are regexp of field-name. This value precedes
4491 @code{wl-message-ignored-field-list}.
4492 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4494 @item wl-message-sort-field-list
4495 @vindex wl-message-sort-field-list
4497 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4498 Header fields in message buffer are ordered by this value.
4499 Each elements are regexp of field-name.
4501 @item wl-message-truncate-lines
4502 @vindex wl-message-truncate-lines
4503 The initial value is the value of @code{default-truncate-lines}.
4504 If it is non-nil, truncate long lines in message buffer.
4507 @node Draft, Disconnected Operations, Message, Top
4508 @chapter Draft Buffer
4510 At Summary mode, pressing @kbd{w} and the like creates a new draft
4511 buffer. You can edit and send mail and news articles in this buffer.
4513 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4514 with those if possible.
4517 * Usage of Draft Mode:: TIPS
4518 * Key Bindings of Draft:: Key bindings
4519 * Variables of Draft Mode:: Customize Draft Mode
4522 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4525 Basically it is Emacs-standard mail mode.
4529 * Editing Message Body and Sending::
4530 * Dynamical Message Re-arrangement::
4535 @node Editing Header, Editing Message Body and Sending, Usage of Draft Mode, Usage of Draft Mode
4536 @subsection Editing Message Header
4538 You can freely edit header region above @samp{--text follows this line--},
4539 until you invoke the sending operation.
4541 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4542 addresses. @kbd{@key{TAB}} completes them.
4544 You can use following headers to specify recipients. Add some of them
4545 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4548 @item @samp{Newsgroups:}
4549 Specify newsgroups to which you post the news article.
4552 Specify addresses to send a copy (Carbon Copy) of the message.
4555 Following ones are removed from the header contents before sending.
4559 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4562 Specify folders in which a copy of the message is saved.
4565 Specify recipients to send encapsulated copy of the message.
4568 You can add initial headers by following variables.
4574 The initial setting is @code{nil}.
4575 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4576 the draft when it is prepared. If function is specified, its return
4581 The initial setting is @code{nil}.
4582 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4583 the draft when it is prepared.
4586 @node Editing Message Body and Sending, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4587 @subsection Editing Messages and Sending
4589 As a matter of course, editing message body can be performed in the same
4590 way as usual writing. You may write message body under
4591 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4592 @samp{--text follows this line--} intact.)
4594 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4595 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4596 a MIME user interface for GNU Emacs}.
4597 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4599 If you save the draft buffer you are editing, it is appended to the
4600 folder specified by @code{wl-draft-folder}. You can leave draft buffer
4601 after storing it for future editing by @kbd{C-c C-z} (@code{wl-draft-save-and-exit}).
4603 If you have finished editing, you can send message by @kbd{C-c C-c}.
4606 @node Dynamical Message Re-arrangement, Template, Editing Message Body and Sending, Usage of Draft Mode
4607 @subsection Dynamic Modification of Messages
4608 @vindex wl-draft-config-alist
4609 @c @cindex Change Message
4610 @c @cindex Message, Change Dynamic
4612 You can set @code{wl-draft-config-alist} so that header and body of the
4613 message will automatically modified depending on information of header
4616 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4618 In the example below, the header is modified when
4619 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4620 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4621 before sending the message.
4625 (setq wl-draft-config-alist
4626 '(((string-match "aaa\\.example\\.com$" (system-name))
4627 ;; @r{applied if the expression is non-nil}
4628 (wl-smtp-posting-server . "mailserver-B")
4629 (wl-nntp-posting-server . "newsserver-B")
4630 ;; @r{settings of temporary variables}
4632 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4633 ;; @r{applied if it matches the header of the draft buffer}
4634 ("Organization" . (format "Go %s" my-webpage)))
4635 ;; @r{you can write elisp expressions here (eval only)}
4636 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4637 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4642 The format of @code{wl-draft-config-alist} is:
4646 '(("@var{regexp of the header}" or @var{elisp expression}
4647 ("@var{Field}" . value(@var{elisp expression}))
4648 (@var{variable} . value(@var{elisp expression}))
4649 (@var{sub-function} . value(@var{elisp expression}))
4652 ("@var{regexp of the header}" or @var{elisp expression}
4653 ("@var{Field}" . value(@var{elisp expression}))
4658 Per default, there are 13 following sub-functions.
4661 'header: Inserts the specified string at the bottom of the header.
4662 'header-top: Inserts the specified string at the top of the header.
4663 'header-file: Inserts the specified file at the bottom of the header.
4664 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4665 'top: Inserts the specified string at the top of the body.
4666 'top-file: Inserts the specified file at the top of the body.
4667 'body: Replaces the body with the specified string.
4668 Specifying @code{nil} deletes the entire body string.
4669 'body-file: Replaces the body with the content of the specified file.
4670 'bottom: Inserts the specified string at the bottom of the body.
4671 'bottom-file: Inserts the specified file at the top of the body.
4672 'part-top: Inserts the specified string at the top of the current part.
4673 'part-bottom: Inserts the specified string at the bottom of the current part.
4674 'template: Applies the specified template.
4675 (refer to the next subsection)
4678 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4679 change them or add your own functions. If you read the code, you can
4680 easily find how to write the functions.
4682 At the first of each item, @var{a regular expression of the header} or
4683 an @var{elisp expression} should be specified. In the case of an elisp
4684 expression, the item is applied when the expression is evaluated
4687 Per default, when multiple items match or are evaluated non-nil, all
4688 such items are applied, but if you set a variable
4689 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4692 At the second of the item, a cons or a list of functions should be
4693 specified. The car part of the cons should be a header field, a
4694 variable, or a sub-function. When a header field is specified, the
4695 field will be modified. If a variable is specified, the value of the
4696 variable will be modified temporarily.
4698 In the cdr part of a cons, not only a variable but also an elisp
4699 expression can be specified as is. If the car part is a header field
4700 and the cdr part is @code{nil}, the field will be deleted.
4702 See the next example as well:
4706 (setq wl-draft-config-alist
4708 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4709 ;; @r{applied if it matches the header of the buffer being replied}
4710 (body . " Hello.\n")
4711 (template . "default")
4716 As in the (1) above, if a header regexp is prepended with @code{reply},
4717 it is applied when the draft is prepared by @code{wl-summary-reply} for
4718 example, and when it matches the header being replied. It is ignored
4719 when there is no buffer being replied, like after @code{wl-draft} was
4722 If you want to use name of parent folder, you can refer the buffer local
4723 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4724 changes From according to the folder name of the summary in which the draft
4729 (setq wl-draft-config-alist
4730 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4731 (\"From\" . \"user@@domain1\"))
4732 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4733 (\"From\" . \"user@@domain2\"))))
4738 Note that @code{wl-draft-config-alist} is applied only once when
4739 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4740 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4741 aborting transmission, execute @kbd{C-c C-e}
4742 (@code{wl-draft-config-exec}) explicitly.
4744 If you don't want to apply @code{wl-draft-config-alist} when
4745 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4749 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4752 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4753 prepared, do the following:
4756 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4759 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4760 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4764 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4767 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4768 @subsection Inserting Templates
4770 @cindex Apply Template
4772 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4773 @kbd{M-x wl-template-select} in the draft buffer.
4775 The format of @code{wl-template-alist} is almost the same as
4776 @code{wl-draft-config-alist}.
4777 @xref{Dynamical Message Re-arrangement}.
4781 (setq wl-template-alist
4784 ("Organization" . "Example Co.Ltd.")
4785 (body . "Hello.\n"))
4787 (template . "default") ;; @r{(a)}
4788 ("To" . "boss@@example.com")
4789 ("Subject" . "Report")
4790 (body-file . "~/work/report.txt")
4796 As you can see, the only difference is item (template) names such as
4797 @samp{default} and @samp{report}, instead of a regexp of header.
4798 Because definition of each item is the same as
4799 @code{wl-draft-config-alist}, you can call another template, like (a).
4801 Executing the command @code{wl-template-select} results in template
4802 selection, but the result differs depending on variable
4803 @code{wl-template-visible-select}.
4805 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4806 window is shown below the draft buffer. You can select a template by
4807 @kbd{n} and @kbd{p} seeing the buffer window.
4809 Press the @key{RET} key and the template is actually applied to the draft
4810 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4811 adjust the window size by @code{wl-template-buffer-lines}.
4813 If @code{wl-template-visible-select} is @code{nil}, you should type the
4814 name of the template in the mini buffer.
4816 If @code{wl-template-select} is executed with prefix argument,
4817 inversed value of @code{wl-template-visible-select} is used.
4819 As shown in the example in @code{wl-draft-config-alist}, you can select
4820 @samp{default} template by writing:
4823 (template . "default")
4826 @node POP-before-SMTP, , Template, Usage of Draft Mode
4827 @subsection Sending mail by POP-before-SMTP
4828 @cindex POP-before-SMTP
4830 You can send mail by POP-before-SMTP with this single line:
4833 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4837 Configure the following variables if you need.
4840 @item wl-pop-before-smtp-user
4841 The POP user name for POP-before-SMTP authentication.
4842 If unset, @code{elmo-pop3-default-user} is used.
4844 @item wl-pop-before-smtp-server
4845 The POP server name for POP-before-SMTP authentication.
4846 If unset, @code{elmo-pop3-default-server} is used.
4848 @item wl-pop-before-smtp-authenticate-type
4849 The POP authentication method for POP-before-SMTP authentication.
4850 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4852 @item wl-pop-before-smtp-port
4853 The POP port number for POP-before-SMTP authentication.
4854 If unset, @code{elmo-pop3-default-port} is used.
4856 @item wl-pop-before-smtp-stream-type
4857 If @code{ssl}, POP connection is established using SSL. If
4858 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4859 unset, @code{elmo-pop3-default-stream-type} is used.
4862 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4863 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4865 Therefore, if SMTP server and POP server are actually the same, and if
4866 POP folder per default (such as @samp{&}) is available, no settings are
4869 Refer to the following URL about POP-before-SMTP.
4873 http://spam.ayamura.org/tools/smPbS.html
4874 http://www.iecc.com/pop-before-smtp.html
4879 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4880 @section Key Bindings
4881 @cindex Keybind, Draft Mode
4882 @cindex Keybind, Draft Buffer
4887 @kindex C-c C-y (Draft)
4888 @findex wl-draft-yank-original
4889 Cites the content of the current message buffer (the part under cursor).
4890 If the region is active, cites the region (it affects only if
4891 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4892 (on XEmacs) is Non-nil).
4893 (@code{wl-draft-yank-original})
4896 @kindex C-c C-p (Draft)
4897 @findex wl-draft-preview-message
4898 Previews the content of the current draft.
4899 This is useful for previewing MIME multi-part messages.
4900 (@code{wl-draft-preview-message})
4903 @kindex C-c C-s (Draft)
4904 @findex wl-draft-send
4905 Sends the content of the current draft. Does not erase the draft buffer.
4906 This is useful for sending multiple messages, which are a little different
4908 (@code{wl-draft-send})
4911 @kindex C-c C-c (Draft)
4912 @findex wl-draft-send-and-exit
4913 Sends the content of the current draft and erases the draft buffer.
4914 (@code{wl-draft-send-and-exit})
4917 @kindex C-x C-s (Draft)
4918 @findex wl-draft-save
4919 Save the current draft.
4920 (@code{wl-draft-save})
4923 @kindex C-c C-k (Draft)
4924 @findex wl-draft-kill
4925 Kills the current draft.
4926 (@code{wl-draft-kill})
4929 @kindex C-x k (Draft)
4930 @findex wl-draft-mimic-kill-buffer
4931 Kills the current draft.
4932 (@code{wl-draft-mimic-kill-buffer})
4935 @kindex C-c C-z (Draft)
4936 @findex wl-draft-save-and-exit
4937 Saves the current draft, and erases the draft buffer.
4938 This is useful if you want to suspend editing of the draft.
4939 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4940 the @samp{+draft} folder.
4941 (@code{wl-draft-save-and-exit})
4944 @kindex C-c C-r (Draft)
4945 @findex wl-caesar-region
4946 Encodes or decodes the specified region in Caesar cipher.
4947 (@code{wl-caesar-region})
4951 @findex wl-draft-highlight-and-recenter
4952 Recenter and rehighlight current draft.
4953 (@code{wl-draft-highlight-and-recenter})
4957 @findex wl-toggle-plugged
4958 Toggles off-line/on-line states of Wanderlust.
4959 (@code{wl-toggle-plugged})
4962 @kindex C-c C-o (Draft)
4963 @findex wl-jump-to-draft-buffer
4964 Jumps to the other draft buffer, if exists.
4965 With prefix argument, reads a file (if any) from the draft folder when
4966 there is no such buffer.
4967 (@code{wl-jump-to-draft-buffer})
4970 @kindex C-c C-e (Draft)
4971 @findex wl-draft-config-exec
4972 Applies @code{wl-draft-config-alist}.
4973 (@code{wl-draft-config-exec})
4976 @kindex C-c C-j (Draft)
4977 @findex wl-template-select
4979 (@code{wl-template-select})
4982 @kindex C-c C-a (Draft)
4984 Enter Address Manager.
4985 @xref{Address Manager}.
4989 @kindex C-c C-d (Draft)
4990 @findex wl-draft-elide-region
4991 Elide the text between point and mark (@code{wl-draft-elide-region}).
4992 The text is killed and replaced with the contents of the variable
4993 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4997 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4998 @section Customizable Variables
5002 @item wl-subscribed-mailing-list
5003 @vindex wl-subscribed-mailing-list
5004 The initial setting is @code{nil}. Mailing lists to which you
5005 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
5006 field of a reply draft, removes your own address from
5007 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
5008 contained in @samp{To:} or @samp{Cc:} field of a message to be
5009 automatically re-filed, the destination folder will be leaned in
5010 connection with the address.
5016 (setq wl-subscribed-mailing-list
5017 '("wl@@lists.airs.net"
5019 "emacs-mime-ja@@m17n.org"))
5023 @item wl-insert-mail-followup-to
5024 @vindex wl-insert-mail-followup-to
5025 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
5026 field is automatically inserted in the draft buffer.
5028 @item wl-insert-mail-reply-to
5029 @vindex wl-insert-mail-reply-to
5030 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
5031 field is automatically inserted in the draft buffer.
5033 @item wl-auto-insert-x-face
5034 @vindex wl-auto-insert-x-face
5035 The initial setting is @code{t}. If non-nil and there is an encoded
5036 X-Face string in a file @file{~/.xface} (the value of the variable
5037 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
5038 draft buffer. If @code{nil}, it is not automatically inserted.
5040 @item wl-insert-message-id
5041 @vindex wl-insert-message-id
5042 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
5043 is automatically inserted on the transmission.
5045 @item wl-message-id-use-wl-from
5046 @vindex wl-message-id-use-wl-from
5047 The initial setting is @code{nil}. If non-nil, the value of
5048 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
5050 @item wl-local-domain
5051 @vindex wl-local-domain
5052 The initial setting is @code{nil}. If @code{nil}, the return value of
5053 the function @code{system-name} will be used as the domain part of
5056 If @code{system-name} does not return FQDN (i.e. the full name of the
5057 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
5058 to the string of the local domain name without hostname (like
5059 @samp{gohome.org}). That is, a concatenation of @code{system-name}
5060 @samp{.} @code{wl-local-domain} is used as domain part of the
5063 If your terminal does not have global IP, set the value of
5064 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
5065 you use invalid @samp{Message-ID:}.)
5067 Moreover, concatenation of @code{system-name} @samp{.}
5068 @code{wl-local-domain} will be used as an argument to the HELO command
5071 @item wl-message-id-domain
5072 @vindex wl-message-id-domain
5073 The initial setting is @code{nil}. If non-nil, this value is used as a
5074 domain part of the @samp{Message-ID:}. If your terminal does not have
5075 global IP address, set unique string to this value (e.x. your e-mail
5078 @item wl-unique-id-suffix
5079 @vindex wl-unique-id-suffix
5080 The initial setting is @samp{.wl}. You can specify the string in generated
5081 Message-ID which appear just before @samp{@@}.
5083 @item wl-draft-config-alist
5084 @vindex wl-draft-config-alist
5085 The initial setting is @code{nil}. Modifies the draft message just
5086 before the transmission. The content of @code{wl-draft-config-alist}
5087 will be automatically applied only once on the transmission. If you
5088 want to apply it manually, use @kbd{C-c C-e}. This command can be used
5091 @item wl-template-alist
5092 @vindex wl-template-alist
5093 The initial setting is @code{nil}.
5094 This variable specifies the template to be applied in the draft buffer.
5096 @item wl-draft-config-matchone
5097 @vindex wl-draft-config-matchone
5098 The initial setting is @code{nil}. If non-nil, only the first matching
5099 item is used when @code{wl-draft-config-alist} is applied. If
5100 @code{nil}, all matching items are used.
5102 @item wl-template-visible-select
5103 @vindex wl-template-visible-select
5104 The initial setting is @code{t}.
5105 If non-nil, you can preview the result of the template selection in
5108 @item wl-template-confirm
5109 @vindex wl-template-confirm
5110 The initial setting is @code{nil}.
5111 If non-nil, asks for confirmation when you press the enter key to select
5112 template while previewing.
5114 @item wl-template-buffer-lines
5115 @vindex wl-template-buffer-lines
5116 The initial setting is 7.
5117 If @code{wl-template-visible-select} is non-nil, this variable specifies
5118 the size of the preview window.
5120 @item wl-draft-buffer-style
5121 @vindex wl-draft-buffer-style
5122 The initial setting is @code{full}.
5123 Style of draft buffer window (except for replying and forwarding).
5124 @code{keep} is to use current window,
5125 @code{full} is to use full frame window,
5126 @code{split} is to split current window and use it.
5127 If some function is specified, it is called with the draft buffer
5130 @item wl-draft-reply-buffer-style
5131 @vindex wl-draft-reply-buffer-style
5132 The initial setting is @code{split}.
5133 Style of draft buffer for replying and forwarding.
5134 @code{keep} is to use message buffer window,
5135 @code{full} is to use full frame window,
5136 @code{split} is to split message buffer window and use it.
5137 If some function is specified, it is called with the draft buffer
5140 @item wl-draft-use-frame
5141 @vindex wl-draft-use-frame
5142 The initial setting is @code{nil}.
5143 If non-nil, use new frame for the draft.
5145 @item wl-draft-reply-default-position
5146 @vindex wl-draft-reply-default-position
5147 The initial setting is @code{body}.
5148 Specify initial cursor position on draft buffer for reply.
5149 @code{body} is to move cursor to the top of the message body,
5150 @code{bottom} to the bottom of the message body, and @code{top} to the
5153 @item wl-draft-truncate-lines
5154 @vindex wl-draft-truncate-lines
5155 The initial value is the value of @code{default-truncate-lines}.
5156 If it is non-nil, truncate long lines in draft buffer.
5160 The initial setting is the value of the variable
5161 @code{user-mail-address}. The value of this variable is inserted as a
5162 @samp{From:} field of the draft when it is prepared.
5164 @item wl-envelope-from
5165 @vindex wl-envelope-from
5166 The initial setting is @code{nil}.
5167 The value of this variable is used for envelope from (MAIL FROM).
5168 If @code{nil}, the address part of @code{wl-from} is used.
5170 @item wl-user-mail-address-list
5171 @vindex wl-user-mail-address-list
5172 The initial setting is @code{nil}.
5173 This is the User's address list. If you have multiple addresses,
5176 @item wl-reply-subject-prefix
5177 @vindex wl-reply-subject-prefix
5178 The initial setting is @samp{Re: }.
5179 In the @samp{Subject:} of the reply draft, this string is prepended to
5180 the @samp{Subject:} of being replied. You can specify a function to be
5181 message buffer of the reply target.
5183 @item wl-forward-subject-prefix
5184 @vindex wl-forward-subject-prefix
5185 The initial setting is @samp{Forward: }.
5186 In the @samp{Subject:} of the forwarding draft, this string is prepended
5187 to the @samp{Subject:} of being forwarded. You can specify a function
5188 to be message buffer of the forward target.
5190 @item wl-draft-reply-use-address-with-full-name
5191 @vindex wl-draft-reply-use-address-with-full-name
5192 The initial setting is @code{t}.
5193 If non-nil, insert her full name with address when prepare a draft for
5194 reply a message. If it is @code{nil}, insert her address only.
5196 @item wl-draft-enable-queuing
5197 @vindex wl-draft-enable-queuing
5198 The initial setting is @code{t}.
5199 This flag controls off-line transmission. If non-nil, the draft is
5202 @item wl-draft-use-cache
5203 @vindex wl-draft-use-cache
5204 The initial setting is @code{nil}. If the value is non-nil and
5205 @code{wl-insert-message-id} is nil, cache the message which is sent.
5207 @item wl-fcc-force-as-read
5208 @vindex wl-fcc-force-as-read
5209 The initial setting is @code{nil}. If the value is non-nil,
5210 Mark as read the message saved by @samp{Fcc:}.
5212 @item wl-auto-flush-queue
5213 @vindex wl-auto-flush-queue
5214 The initial setting is t.
5215 This flag controls automatic transmission of the queue when Wanderlust
5216 becomes on-line. If non-nil, the queue is automatically transmitted
5217 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5218 manually, press @kbd{F} in the folder mode.
5220 @item wl-ignored-forwarded-headers
5221 @vindex wl-ignored-forwarded-headers
5222 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
5223 All headers that match this regexp will be deleted when forwarding a message.
5225 @item wl-ignored-resent-headers
5226 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
5227 All headers that match this regexp will be deleted when resending a message.
5229 @item wl-draft-always-delete-myself
5230 @vindex wl-draft-always-delete-myself
5231 If non-nil, always removes your own address from @samp{To:} and
5232 @samp{Cc:} when you are replying to the mail addressed to you.
5234 @item wl-draft-delete-myself-from-bcc-fcc
5235 @vindex wl-draft-delete-myself-from-bcc-fcc
5236 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
5237 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
5239 @item wl-smtp-posting-server
5240 @vindex wl-smtp-posting-server
5241 The initial setting is @code{nil}.
5242 This is the SMTP server name for mail transmission.
5244 @item wl-smtp-posting-port
5245 @vindex wl-smtp-posting-port
5246 The initial setting is @code{nil}.
5247 This is the SMTP port number for mail transmission.
5248 If @code{nil}, default SMTP port number (25) is used.
5250 @item wl-smtp-posting-user
5251 @vindex wl-smtp-posting-user
5252 The initial setting is @code{nil}.
5253 This is the user name for SMTP AUTH authentication.
5255 @item wl-smtp-authenticate-type
5256 @vindex wl-smtp-authenticate-type
5257 The initial setting is @code{nil}.
5258 This string-valued variable specifies the authentication method for SMTP
5259 AUTH authentication. You may specify @code{plain}, @code{cram-md5},
5260 @code{digest-md5}, @code{login}, etc. If @code{nil}, authentication
5261 will not be carried out.
5263 @item wl-smtp-authenticate-realm
5264 @vindex wl-smtp-authenticate-realm
5265 The initial setting is @code{nil}.
5266 This string-valued variable specifies the authentication realm for SMTP
5267 AUTH authentication. You have to set this variable for DIGEST-MD5
5268 authentication and so on.
5269 If @code{nil}, authentication realm is not specified in the authentication.
5271 @item wl-smtp-connection-type
5272 @vindex wl-smtp-connection-type
5273 The initial setting is @code{nil}.
5274 This symbol-valued variable specifies how to establish SMTP connections.
5275 If @code{nil}, use default connection type.
5276 If it is @code{starttls}, use STARTTLS (RFC2595).
5277 If it is @code{ssl}, use SSL.
5279 @item wl-nntp-posting-server
5280 @vindex wl-nntp-posting-server
5281 The initial setting is @code{nil}.
5282 This is the NNTP server name used for news submission.
5283 If @code{nil}, @code{elmo-nntp-default-server} is used.
5285 @item wl-nntp-posting-user
5286 @vindex wl-nntp-posting-user
5287 The initial setting is @code{nil}.
5288 This is the user name for AUTHINFO authentication on news submission.
5289 If @code{nil}, @code{elmo-nntp-default-user} is used.
5290 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
5292 @item wl-nntp-posting-port
5293 @vindex wl-nntp-posting-port
5294 The initial setting is @code{nil}.
5295 This is the port number of the NNTP server used for news submission.
5296 If @code{nil}, @code{elmo-nntp-default-server} is used.
5298 @item wl-nntp-posting-stream-type
5299 @vindex wl-nntp-posting-stream-type
5300 The initial setting is @code{nil}.
5301 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If @code{ssl},
5302 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
5303 connection will be established.
5305 @item wl-nntp-posting-function
5306 @vindex wl-nntp-posting-function
5307 The initial setting is @code{elmo-nntp-post}.
5308 This is the function to post NNTP message.
5310 @item wl-nntp-posting-config-alist
5311 @vindex wl-nntp-posting-config-alist
5312 The initial setting is @code{nil}.
5313 The value takes an alist to define NNTP server like following example.
5314 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
5318 (setq wl-nntp-posting-config-alist
5319 '((",?gmane\\." . "news.gmane.org")
5321 ((server . "news-server")
5322 (user . "newsmaster")
5324 (function . elmo-nntp-post)))
5325 (".*" . "default-news-server")))
5329 @item wl-pop-before-smtp-user
5330 @vindex wl-pop-before-smtp-user
5331 The initial setting is @code{nil}.
5332 This is the POP user name for POP-before-SMTP.
5333 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
5335 @item wl-pop-before-smtp-server
5336 @vindex wl-pop-before-smtp-server
5337 The initial setting is @code{nil}.
5338 This is the POP server name for POP-before-SMTP.
5339 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
5341 @item wl-pop-before-smtp-authenticate-type
5342 @vindex wl-pop-before-smtp-authenticate-type
5343 The initial setting is @code{nil}.
5344 This is the authentication method for POP-before-SMTP authentication.
5345 If it is @code{nil}, @code{elmo-pop3-default-authenticate-type} is used.
5347 @item wl-pop-before-smtp-port
5348 @vindex wl-pop-before-smtp-port
5349 The initial setting is @code{nil}.
5350 This is the POP port number for POP-before-SMTP. If it is @code{nil},
5351 @code{elmo-pop3-default-port} is used.
5353 @item wl-pop-before-smtp-stream-type
5354 @vindex wl-pop-before-smtp-stream-type
5355 The initial setting is @code{nil}.
5356 This flag controls the use of SSL for POP-before-SMTP. If it is
5357 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{ssl},
5358 SSL is used. If @code{starttls}, STARTTLS (RFC2595) connection will be
5361 @item wl-draft-queue-save-variables
5362 @vindex wl-draft-queue-save-variables
5363 Specifies a list of variable to which queued messages are saved on the
5364 off-line transmission.
5366 @item wl-draft-sendlog
5367 @vindex wl-draft-sendlog
5368 The initial setting is @code{t}.
5369 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
5373 @item drafts are sent by smtp or qmail
5374 @item saved into folders by fcc
5375 @item saved into folders by queuing
5378 (it is written even if the transmission fails).
5379 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
5380 and left to the logging function of @command{imput}.
5383 @item wl-draft-sendlog-max-size
5384 @vindex wl-draft-sendlog-max-size
5385 The initial setting is 20000 (in bytes).
5386 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
5387 beyond the size specified by this variable.
5391 The initial setting is @code{nil}.
5392 If non-nil, address completion uses LDAP.
5394 @item wl-ldap-server
5395 @vindex wl-ldap-server
5396 The initial setting is @samp{localhost}.
5397 LDAP server name for address completion.
5400 @vindex wl-ldap-port
5401 The initial setting is @code{nil}.
5402 If non-nil, the value is used as port number.
5405 @vindex wl-ldap-base
5406 The initial setting is @samp{c=US}.
5407 LDAP search starting point (base) for address completion.
5409 @item wl-draft-remove-group-list-contents
5410 @vindex wl-draft-remove-group-list-contents
5411 The initial setting is @code{t}.
5412 If non-nil, remove the group-lists' members in the recipients when
5413 sending the message (group-list means the description such as
5414 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5417 @node Disconnected Operations, Expire and Archive, Draft, Top
5418 @chapter Off-line Management
5419 @cindex Disconnected Operations
5421 Wanderlust has on-line and off-line states.
5424 * Off-line State:: Wanderlust has on-line and off-line states
5425 * Enable Operations:: Enable Disconnected Operations
5426 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5427 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5428 * Variables of Plugged Mode:: Customize Plugged Mode
5432 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5433 @section Off-line State
5435 Wanderlust has on-line and off-line states. In the off-line state, you
5436 cannot access messages via network, unless they are cached.
5438 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5439 in the mode line indicates the off-line state. In folder or summary
5440 modes, press @kbd{M-t} to switch between off- and on-line.
5442 You can invoke Wanderlust in the off-line state by setting
5443 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5445 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5446 ignores uncached messages.
5449 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5450 @section Enable Disconeected Operations
5452 Even in the off-line state, provided that relevant messages are cached,
5453 and the variable @code{elmo-enable-disconnected-operation} (described
5454 later) is non-nil, you can following operations:
5455 @xref{Plugged Mode}, @xref{Off-line State settings}.
5458 * Send Messages off-line:: Transmit Messages
5459 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5460 * Creation of Folders:: Create Folders off-line (IMAP4)
5461 * Marking:: Mark (IMAP4)
5462 * Pre-fetching Reservations:: Pre-fetch
5465 As soon as Wanderlust becomes on-line, such operations invoked off-line
5466 are reflected in the servers via network.
5468 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5469 these off-line operations are not executed and causes an error on
5470 re-file or copy operations.
5472 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5473 @subsection Transmission of Messages
5475 You can proceed sending operation for mail/news messages while you are
5476 off-line, then it will be reserved for sending (if you are using
5477 @file{im-wl.el}, it is irrelevant).
5478 Messages reserved for sending while off-line are accumulated in the
5479 queue folder, @samp{+queue}. These messages are transmitted at once when
5480 Wanderlust becomes on-line.
5482 You can visit @samp{+queue} in the off-line state and confirm content of
5483 messages in the queue. You can also remove messages. Removed messages
5484 are not transmitted even in the on-line state.
5487 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5488 @subsection Re-file and Copy (IMAP4)
5490 Re-file and copy operations to IMAP folders invoked during the off-line
5491 state are accumulated in the queue, and reflected in the server side
5492 when Wanderlust becomes on-line. If you visit destination folders after
5493 off-line re-file or copy, it looks as if messages were appended even in
5496 For the safety reasons, messages re-filed off-line are removed from
5497 source folders only if their @samp{Message-ID:} match messages on the
5498 servers. While the queue is processed, messages that failed to be
5499 re-filed or copied to the specified folders are appended to the folder
5503 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5504 @subsection Creation of Folders (IMAP4)
5506 You can create IMAP folders off-line. The creation of folders are
5507 reflected in the servers when Wanderlust becomes on-line. If the creation
5508 of those folders fails at that time for some reasons, messages
5509 to be re-filed into those are appended to the folder @samp{+lost+found}
5513 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5514 @subsection Marking (IMAP4)
5516 Off-line changes in unread/read and importance mark @samp{$} information
5517 are also reflected in the servers when Wanderlust becomes on-line.
5520 @node Pre-fetching Reservations, , Marking, Enable Operations
5521 @subsection Pre-fetching
5523 You can make reservations for pre-fetching messages in networking
5524 folders (IMAP, NNTP, POP3, shimbun). Reserved messages are marked with
5525 @samp{u} but not cached yet. When Wanderlust becomes on-line, they are
5526 pre-fetched from servers.
5529 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5530 @section Switching On-line/Off-line per Server/Port
5532 @kbd{M-t} described above switches networking states as a whole, but you
5533 can switch on-line/off-line per server/port.
5535 Pressing @kbd{C-t} in the folder or summary modes brings you in
5536 wl-plugged-mode shown below, in which you can change the plugged state
5541 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5544 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5545 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5547 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5548 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5554 The first line indicates status of the following three variables, and
5555 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5556 column modifies the values of these variables.
5560 "Queuing" @code{wl-draft-enable-queuing}
5561 "AutoFlushQueue" @code{wl-auto-flush-queue}
5562 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5566 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5569 The second and after lines indicate on-line/off-line states of servers
5570 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5571 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5572 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5574 @dfn{sending queue} means messages accumulated in the folder
5575 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5576 off-line operations when @code{elmo-enable-disconnected-operation} is
5578 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5579 @c off-line operations are enabled.
5581 They are displayed if there are any of them. In the example above, in
5582 the sending queue there are two messages (the first and the second in
5583 the queue folder) for smtp to hosta and one (the third) for nntp to
5584 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5587 If you change @samp{(wl-plugged)} in the second line, the variable
5588 @code{wl-plugged} is changed, so that the mode line indicator and
5589 plugged states of all ports are affected. If you change plugged states
5590 of any servers or ports, @samp{(wl-plugged)} in the second line is
5591 affected depending on @code{elmo-plugged-condition} settings and the
5592 plugged state of each port.
5595 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5596 @section Invoking Wanderlust in the Off-line State
5598 As described before, if you set @code{wl-plugged} to @code{nil} in
5599 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5600 off-line state. You can specify off-line state on a per server or port
5601 basis. Refer to @code{wl-reset-plugged-alist} also.
5603 Usually, when Wanderlust starts up, the plugged state of each port is
5604 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5605 @code{wl-nntp-posting-server} and so on. If you want to change the
5606 plugged state of these ports or to add other ports, configure
5607 @code{wl-make-plugged-hook} with a function.
5611 (add-hook 'wl-make-plugged-hook
5613 (elmo-set-plugged plugged-value(t/nil) server port)
5614 ;; @r{add or change plugged states of the port of the server}
5615 (elmo-set-plugged plugged-value(t/nil) server)
5616 ;; @r{if the port is omitted, all ports are affected}
5617 ;; @r{(you cannot omit the port if you newly add the server)}
5623 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5624 @section Customizable Variables
5629 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5630 mode from the beginning.
5632 @item wl-queue-folder
5633 @vindex wl-queue-folder
5634 The initial setting is @samp{+queue}.
5635 This is the folder in which messages in the transmission queue are
5638 @item wl-auto-flush-queue
5639 @vindex wl-auto-flush-queue
5640 The initial setting is @code{t}.
5641 This flag controls automatic transmission of the queue when Wanderlust
5642 becomes on-line. If non-nil, the queue is automatically transmitted
5643 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5644 manually, press @kbd{F} in the folder mode.
5646 @item elmo-enable-disconnected-operation
5647 @vindex elmo-enable-disconnected-operation
5648 The initial setting is @code{t}. Controls off-line operations regarding
5649 networking folders. If non-nil, off-line operations are carried out.
5651 @item elmo-lost+found-folder
5652 @vindex elmo-lost+found-folder
5653 The initial setting is @samp{+lost+found}.
5654 This is the folder to which messages are saved when they fails to be
5655 appended while the off-line re-file/copy queue is processed.
5657 @item elmo-plugged-condition
5658 @vindex elmo-plugged-condition
5659 The initial setting is @code{one}.
5660 The value of @code{wl-plugged} reflects the return value of the function
5661 @code{elmo-plugged-p} (without arguments).
5662 This variable @code{elmo-plugged-condition} specifies the condition on
5663 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5664 plugged state of each port.
5667 'one : plugged if one or more ports are plugged.
5668 'all : plugged if all ports are plugged.
5669 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5670 states of the ports.
5671 @var{function} : reflects the return value of the @var{function}
5672 functions available per default
5673 'elmo-plug-on-by-servers
5674 : reflects the plugged state of the servers specified by the
5675 variable elmo-plug-on-servers.
5676 'elmo-plug-on-by-exclude-servers
5677 : reflects the plugged state of the servers that are not
5678 in elmo-plug-on-exclude-servers.
5679 elmo-plug-on-exclude-servers defaults to
5682 (system-name)without the domain part)
5688 (setq elmo-plugged-condition 'all)
5690 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5691 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5693 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5694 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5698 @item wl-reset-plugged-alist
5699 @vindex wl-reset-plugged-alist
5700 The initial setting is @code{t}. If non-nil, plugged states are
5701 initialized on a per server or port basis when Wanderlust starts up.
5703 If @code{nil}, plugged states are retained while Emacs is running. In
5704 other words, they are initialized when Emacs is restarted even if the
5705 value is @code{nil}.
5709 @node Expire and Archive, Scoring, Disconnected Operations, Top
5710 @chapter Automatic Expiration and Archiving of Messages
5711 @cindex Expire and Archive
5714 * Expire:: Expiration and Archiving
5715 * Archive:: Archiving All Messages
5719 @node Expire, Archive, Expire and Archive, Expire and Archive
5721 @cindex Expire Message
5723 Expiration means deletion of old messages which have outlasted a
5724 certain period of time.
5726 @code{wl-expire} supports not only simple deletion, but also moving to
5727 specified archiving folders.
5731 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5732 or @kbd{M-e} in the summary mode.
5734 @subsection Configuring @code{wl-expire-alist}
5736 An example configuration of @code{wl-expire-alist} is shown below.
5737 Everything in this @code{wl-expire-alist} makes a great difference in
5738 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5739 to @code{t}, especially in the initial stage.
5743 (setq wl-expire-alist
5744 '(("^\\+trash$" (date 14) remove)
5746 ("^\\+tmp$" (date 7) trash)
5747 ;; @r{re-file to @code{wl-trash-folder}}
5748 ("^\\+outbox$" (number 300) "$outbox;lha")
5749 ;; @r{re-file to the specific folder}
5751 ;; @r{do not expire}
5752 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5753 ;; @r{archive by message number (retaining numbers)}
5754 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5755 ;; @r{archive by a fixed number (retaining numbers)}
5756 ("^\\+diary$" (date 30) wl-expire-archive-date)
5757 ;; @r{archive by year and month (numbers discarded)}
5762 Items in the list has the format of:
5765 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5769 The folder is examined if it matches @var{regexp-for-folders} from the
5770 beginning of the list. If you invoke expiration on the folder that does
5771 not match any of them, nothing will happen. And if either the second or
5772 the third element of the item is @code{nil}, expiration will not take
5775 You can use any one of the following for
5776 @var{specification-of-message-to-be-deleted}:
5779 @item (number @var{n1} [@var{n2}])
5780 deletes messages depending on the number of messages in the folder.
5782 @var{n1} is the number of messages which should survive deletion, for example
5783 if its value is 500, the newest 500 messages survive and the rests are
5786 @var{n2} is the number of messages in the folder on which expiration should
5787 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5788 folders with 510 or more messages are expired.
5789 If you configured automatic expiration, frequently used folders may
5790 expire every time it receive messages, and you may be annoyed with the
5791 long delay in reading mail.
5792 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5793 expiration would not take place until a certain number of messages
5796 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5797 with important/new/unread) are not deleted.
5798 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5799 will expire so as to have 500 messages including such ones.
5800 Otherwise, it will have 500 messages except such ones.
5802 @item (date @var{d1})
5803 deletes messages depending on the dates.
5805 Messages dated @var{d1} or more days ago are deleted, for example if its
5806 value is seven, messages seven days old or more are deleted. Note that
5807 the date is the one in the @samp{Date:} field of the message, not when
5808 the message entered the folder.
5810 Messages with no or invalid @samp{Date:} field does not expire; you
5811 might have to delete them by hand.
5814 You can use any one of the following in the place of @var{destination}:
5818 deletes the messages instantly.
5821 hide the messages from summary (messages are not deleted).
5824 moves the messages to @code{wl-trash-folder}.
5826 @item @var{string}(folder)
5827 moves the messages to the folder specified with @var{string}.
5829 It would be useful for specifying an archiving folder, but because this
5830 does not move important messages, it might be better to use the
5831 standard functions described below.
5833 @item @var{function}
5834 invokes the specified @var{function}.
5836 To the @var{function}, three arguments are passed: a folder name, a list
5837 of messages to be deleted, and msgdb information of the summary. You
5838 can specify function-specific arguments after the name of the
5839 @var{function}. Note that the list contains messages with marks in
5840 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5843 These are four standard functions; three of them move messages to an archive
5844 folder in the specified way. This means old messages can be compressed
5845 and saved in a file, being deleted from the original folder.
5846 The last one divides messages to some MH folders.
5849 @item wl-expire-archive-number1
5850 re-files to archiving folders corresponding to the message numbers of
5851 the messages being deleted. For example, a message numbered 102 will be
5852 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5853 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5854 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5856 The archiving folders to which messages are re-filed are determined by
5857 the name of the folder as follows (in this case, archiving folders are
5858 handled as if @code{elmo-archive-treat-file} were non-nil).
5861 @item If the folder type is localdir:
5862 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5864 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5865 (@file{~/Mail/ml/wl-00100.zip}).
5867 @item The folder type is other than localdir:
5868 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5870 For example, @samp{%#mh/ml/wl} corresponds to
5871 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5874 As you can see, in the case of localdir, the folder type is not included
5875 in the path name, but otherwise it is included.
5876 And you can control the prefix to the archiving folder name by
5877 @code{wl-expire-archive-folder-prefix}.
5878 Refer to @code{wl-expire-archive-folder-prefix} for details.
5880 @item wl-expire-archive-number2
5881 re-files every certain number of messages to archiving folders.
5883 This differs from @samp{wl-expire-archive-number1} in that this re-files
5884 to the folder up to the specified number regardless of message numbers.
5885 The archiving folders to which messages are re-filed are determined in the
5886 same way as @code{wl-expire-archive-number1}.
5888 @item wl-expire-archive-date
5889 re-files messages depending on its date (year and month) to archive
5892 For example, a message dated December 1998 is re-filed to
5893 @code{$folder-199812;zip}. The name of the archiving folders except the
5894 date part are determined in the same way as
5895 @code{wl-expire-archive-number1}.
5898 You can set the first argument to these three standard functions to non-nil
5899 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5900 For example, it can be specified just after the name of the function:
5903 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5906 If you omit the argument, consecutive numbers from 1 are assigned for
5907 each archiving folder.
5909 @item wl-expire-localdir-date
5910 divedes messages depending on its date (year and month) to MH folders
5911 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5915 @subsection Treatment for Important or Unread Messages
5917 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5918 standard function, messages with marks in
5919 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5920 messages} thereafter) are retained.
5922 Per default, this variable include the important, new, and unread marks,
5923 so that messages with these marks are not removed.
5924 Note that you cannot include the temporary mark (i.e. temporary marks
5925 are removed anyway), and be sure to process temporary marks before you
5928 @subsection Auto Expiration
5930 The following setup invokes expiration when you move into the summary
5931 mode. There will be no confirmation, so make sure you made no mistake
5932 in regexp and other settings before you set up this.
5936 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5940 In the folder mode, you can invoke expiration per group as well as per
5941 folder. Therefore, if you specify @samp{Desktop} group, all folders
5942 matching @code{wl-expire-alist} expire.
5946 @subsection Treating archive folders.
5947 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5948 you must set non-nil value to @code{elmo-archive-treat-file}.
5950 @subsection Confirming
5952 If you are to use @code{remove}, try @code{trash} at first and see
5953 messages move to @code{wl-trash-folder} as expected, then replace it
5954 with @code{remove}. It would be dangerous to use @code{remove} from the
5957 If you are to use @code{wl-expire-archive-number1} and the like, try to
5958 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5959 you can append messages to it. Even if settings in
5960 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5961 would not be saved anywhere and disappeared in case the archiver program
5964 After you make sure you can archive to the folder correctly, you can
5965 invoke expiration and utilize the log.
5967 If you set @code{wl-expire-use-log} to @code{t},
5968 @file{~/.elmo/expired-log} should contain the log, for example:
5972 delete +ml/wl (593 594 595 596 597 598 599)
5973 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5977 The first column indicates the operation, i.e. @samp{delete},
5978 @samp{copy}, or @samp{move}. The next is the name of the folder that
5979 expired. In the case of @samp{copy} and @samp{move}, the destination
5980 folder is recorded after @samp{->}. The last is the list of message
5981 numbers that are actually deleted or moved (in the case of @samp{copy}
5982 and @samp{move}, the number is the one in the source folder, rather than
5983 the destination folder).
5985 @subsection Re-filing Reserved Messages
5987 The three standard functions copy reserved messages to the archive
5988 folder, but do not delete them from the source folder. Because
5989 reserved messages and the like always remain, they are recorded in
5990 @file{~/.elmo/expired-alist} so that they are not copied over and over
5991 again. They are not recorded if copied by @code{wl-summary-archive}.
5993 If you enabled logging, usually @samp{move} is recorded for re-filing,
5994 but instead @samp{copy} and @samp{delete} are recorded separately if
5995 reserved messages are involved. This is because it actually copies
5996 messages including reserved, then deletes ones except reserved in that
5999 @section Customizable Variables
6002 @item wl-expire-alist
6003 @vindex wl-expire-alist
6004 The initial setting is @code{nil}.
6005 This variable specifies folders and methods to expire. For details,
6006 refer to @code{wl-expire-alist} settings above.
6008 @item wl-summary-expire-reserve-marks
6009 @vindex wl-summary-expire-reserve-marks
6010 The initial setting is the list below.
6014 (list wl-summary-flag-mark
6015 wl-summary-new-uncached-mark
6016 wl-summary-new-cached-mark
6017 wl-summary-unread-uncached-mark
6018 wl-summary-unread-cached-mark)
6022 Messages with these marks are retained in the folder, even after
6024 Only permanent marks can be listed, not temporary marks.
6026 You can list marks one by one as in the default; you can use the
6027 following settings as well:
6031 All messages with permanent marks are retained,
6032 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
6036 All messages are handled as usual ones that are already read, no matter
6037 what marks they have; even important messages are deleted.
6040 @item wl-expire-archive-files
6041 @vindex wl-expire-archive-files
6042 The initial setting is 100.
6043 This variable specifies the number of messages to be retained in one
6046 @item wl-expire-number-with-reserve-marks
6047 @vindex wl-expire-number-with-reserve-marks
6048 The initial setting is @code{nil}.
6049 If non-nil, if expiring messages are specified by @code{number},
6050 messages with @code{wl-summary-expire-reserve-marks} are also retained.
6052 @item wl-expire-archive-get-folder-function
6053 @vindex wl-expire-archive-get-folder-function
6054 The initial setting is @code{wl-expire-archive-get-folder}.
6056 This variable specifies a function that returns the name of an archiving
6057 folder for standard functions in the place of @var{destination}.
6058 You can use the following three variables for simple modification of
6059 folder names; if you want more complex settings, define your own
6060 function in this variable.
6062 @code{wl-expire-archive-get-folder} can be customized by these
6065 @item @code{wl-expire-archive-folder-name-fmt}
6066 @item @code{wl-expire-archive-folder-type}
6067 @item @code{wl-expire-archive-folder-prefix}
6070 @item wl-expire-archive-folder-name-fmt
6071 @vindex wl-expire-archive-folder-name-fmt
6072 The initial setting is @samp{%s-%%05d;%s}.
6073 This is a @code{format} string for archiving folders used in
6074 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
6075 Note that you must specify the message number by @samp{%%d}, because it
6076 is parsed twice by @code{format}.
6078 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
6081 @item wl-expire-archive-date-folder-name-fmt
6082 @vindex wl-expire-archive-date-folder-name-fmt
6083 The initial setting is @samp{%s-%%04d%%02d;%s}.
6084 This is a @code{format} string for archiving folders used in
6085 @code{wl-expire-archive-date}. Note that you must specify the message
6086 number by @samp{%%d}, because it is parsed twice by @code{format}.
6087 There should be @samp{%%d} twice, one for the year and the other for the
6090 If you modify this, adjust
6091 @code{wl-expire-archive-date-folder-num-regexp} as well.
6093 @item wl-expire-archive-folder-type
6094 @vindex wl-expire-archive-folder-type
6095 The initial setting is @code{zip}.
6096 This variable specifies an archiver type of the archiving folders.
6098 @item wl-expire-archive-folder-prefix
6099 @vindex wl-expire-archive-folder-prefix
6100 The initial setting is @code{nil}.
6101 This variable specifies the prefix (directory structure) to archiving
6103 Exercise extreme caution in using this feature, as it has not been
6105 In the worst case, there is a fear of destructing archiving folders.
6109 There will be no prefix.
6112 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
6113 @samp{$ml/wl-00000;zip;wl}.
6116 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
6119 @samp{$ml/wl-00000;zip;ml/wl}.
6122 @item wl-expire-archive-folder-num-regexp
6123 @vindex wl-expire-archive-folder-num-regexp
6124 The initial setting is @samp{-\\([-0-9]+\\);}.
6125 This variable specifies the regular expression to be used for getting
6126 message numbers from multiple archiving folders specified by
6127 @code{elmo-list-folders}.
6128 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
6130 @item wl-expire-archive-date-folder-num-regexp
6131 @vindex wl-expire-archive-date-folder-num-regexp
6132 The initial setting is @samp{-\\([-0-9]+\\);}.
6133 This is the regular expression to be used for getting message numbers
6134 from multiple archiving folders specified by @code{elmo-list-folders}.
6135 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
6137 @item wl-expire-delete-oldmsg-confirm
6138 @vindex wl-expire-delete-oldmsg-confirm
6139 The initial setting is @code{t}.
6140 If non-nil, messages older than the one with the largest number will be
6141 deleted with confirmation.
6142 If @code{nil}, they are deleted without confirmation.
6144 This feature is valid only if non-nil is specified as a argument to the
6145 standard functions so as to retain numbers.
6147 @item wl-expire-use-log
6148 @vindex wl-expire-use-log
6149 The initial setting is @code{nil}.
6150 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
6151 They are appended but not truncated or rotated automatically; you might
6152 need to remove it manually.
6154 @item wl-expire-add-seen-list
6155 @vindex wl-expire-add-seen-list
6156 The initial setting is @code{t}.
6158 If non-nil, when messages are re-filed by expiration, read/unread
6159 information is passed to the destination folder.
6161 However if you do not read the destination folder from Wanderlust,
6162 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
6163 want to set this to @code{nil} if you are simply saving to some
6164 archiving folders. Even if its value is @code{nil}, messages in the
6165 archiving folders are simply treated as unread; it does not affect
6168 @item wl-expire-folder-update-msgdb
6169 @vindex wl-expire-folder-update-msgdb
6170 The initial setting is @code{t}.
6171 If @code{t}, in the folder mode, expiration is carried out after
6172 updating summary information. If you specified a list of regular
6173 expressions of folder names, summary information is updated for matching
6178 @node Archive, , Expire, Expire and Archive
6179 @section Archiving Messages
6181 @subsection Archiving Messages
6182 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
6183 folders. If there are the archiving folders already, only new messages
6186 You can use @code{wl-archive-alist} in order to specify how messages are
6187 archived according to their folder names, as in @code{wl-expire-alist}.
6192 (setq wl-archive-alist
6193 '(("^\\+tmp$" wl-archive-date)
6194 ("^\\+outbox$" wl-archive-number2)
6195 (".*" wl-archive-number1)))
6199 Each item in the list has the following format:
6202 (@var{folders-regexp} @var{deleting-function})
6205 As you can see, you can only use a function after @var{folders-regexp}.
6206 Per default, there are three functions:
6209 @item @code{wl-archive-number1}
6210 @item @code{wl-archive-number2}
6211 @item @code{wl-archive-date}
6214 As inferred from their names, they work similarly to "expire" versions,
6215 other than the following points:
6218 @item No messages are deleted
6219 @item Message numbers are retained even if invoked without arguments
6222 These functions are good to archive all messages in a folder by their
6223 numbers or by their dates.
6224 These are also useful for backup or confirmation purposes before
6226 If you try to re-file them after they are archived, they are deleted but
6229 Per default, the archiving folders to which messages are copied are
6230 determined automatically by @code{wl-expire-archive-get-folder-function}.
6231 You can copy to a specific folder by invoking with a prefix argument,
6232 i.e. @kbd{C-u M-x wl-summary-archive}.
6234 Note that this feature has not been seriously tested, because you can
6235 simply copy to an archiving folder, for example by
6236 @code{wl-summary-copy-region}.
6238 The archiving folders are determined by the same logic as in
6239 @code{wl-summary-expire}; the following customizable variables are
6243 @item @code{wl-expire-archive-files}
6244 @item @code{wl-expire-archive-get-folder-function}
6245 @item @code{wl-expire-archive-folder-name-fmt}
6246 @item @code{wl-expire-archive-folder-type}
6247 @item @code{wl-expire-archive-folder-prefix}
6248 @item @code{wl-expire-archive-folder-num-regexp}
6251 @subsection Customizable Variables
6254 @item wl-archive-alist
6255 @vindex wl-archive-alist
6256 The initial setting is the list shown below:
6260 ((".*" wl-archive-number1))
6265 This variable specifies a function that copies to archiving folders.
6266 To the function, three arguments are passed: a folder name, a list of
6267 messages in the folder, and msgdb information of the summary.
6268 Needless to say, you can use your own function.
6272 @node Scoring, Address Book, Expire and Archive, Top
6273 @chapter Score of the Messages
6275 @c @cindex Kill File
6277 Scoring is the function that associates a score (value) with each
6278 message, and marks as read or deletes from the summary according to it.
6280 You can put target or important marks on essential messages, or read marks
6281 on the ones you do not want to read, for example spam articles.
6283 This scoring function has a capability and a format similar to the one
6284 that Gnus has, although there are some unsupported features and
6285 Wanderlust specifics.
6286 @xref{Scoring, , ,gnus, The gnus Newsreader}.
6289 * Score Commands:: Score Commands
6290 * Score File Format:: Score File Format
6294 @node Score Commands, Score File Format, Scoring, Scoring
6295 @section Score Commands
6296 @cindex Score Commands
6298 @subsection Score File Specification
6300 @code{wl-score-folder-alist} specifies score files or variables in which
6301 scores are defined, corresponding to folder names.
6305 (setq wl-score-folder-alist
6314 If paths to the score files are omitted, the directory specified in the
6315 variable @code{wl-score-files-directory} is assumed.
6317 No matter what you write in @code{wl-score-folder-alist}, the default
6318 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
6319 read (it does not have to exist).
6320 Therefore, in the example above, the three score files,
6321 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
6322 the folders that matches @samp{^-.*}.
6324 @subsection Scored Messages
6326 Scores are attached to the messages that are specified by
6327 @code{wl-summary-score-marks} temporarily when the summary is updated;
6328 when you exit from the summary, the scores are removed and reverts to
6331 @subsection Creation of Score Files
6333 In the summary buffer, move to an appropriate message and type @kbd{L}.
6334 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
6335 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
6337 This makes @minus{}1000 are scored for messages with the same
6338 @samp{Subject:} as the string you entered. That is, such a score file
6339 is created automatically.
6341 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
6342 The score file you just made appears.
6343 This buffer is called @dfn{score editing buffer} thereafter.
6344 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
6345 as you are previously; type @kbd{a}. Then a score entry for "From"
6347 In this way, you can create a score file easily either in the summary
6348 buffer or in the score editing buffer.
6350 By the way, you might be aware the numbers of key strokes are different
6351 between @kbd{s s p} and @kbd{a}.
6352 This is determined by @code{wl-score-header-default-entry}.
6353 This variable specifies the default score entries corresponding to
6355 For example, for "subject" field, a type and a time limit are prompted,
6356 but for "from" field, they are fixed upon automatically as substring and
6357 permanent respectively.
6358 However, score values can be modified by the prefix argument.
6359 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
6362 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
6363 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
6364 erasing contents of the buffer deletes the score file being edited.
6368 @subsubsection Selecting Score Files
6370 You can change score files to which scores are appended by
6371 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
6372 @code{wl-score-change-score-file}.
6374 @subsubsection Summing Up the Score
6376 If you add the same entries by @code{wl-summary-increase-score},
6377 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
6378 scores for the entry is summed up.
6380 For example, if you create @samp{from} entry with the score of @minus{}1000 by
6381 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
6382 @minus{}1200 will be created as a result.
6384 @subsubsection Creating Thread Key
6386 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
6387 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6389 @subsubsection Creating Followup Key
6391 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6392 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6393 at the cursor to @samp{References} key.
6394 If @code{wl-score-auto-make-followup-entry} is non-nil,
6395 @samp{Message-ID} of all messages to be followed up within dates
6396 specified by @code{wl-score-expiry-days}.
6398 @subsection Key Bindings
6403 @findex wl-summary-increase-score
6404 Increases the score for the current message.
6405 And the score entry is appended to the score file at the same moment.
6406 You can specify the score value by a prefix argument.
6410 @findex wl-summary-lower-score
6411 Decreases the score for the current message.
6412 And the score entry is appended to the score file at the same moment.
6413 You can specify the score value by a prefix argument.
6416 @kindex h R (Summary)
6417 @findex wl-summary-rescore
6418 Re-applies the scoring.
6419 However, already scored messages are not scored anew.
6422 @kindex h c (Summary)
6423 @findex wl-score-change-score-file
6424 Changes the score file currently selected.
6427 @kindex h e (Summary)
6428 @findex wl-score-edit-current-scores
6429 Edits the score file currently selected.
6430 If there are multiple score files, the previously specified one is
6434 @kindex h f (Summary)
6435 @findex wl-score-edit-file
6436 Edits an arbitrary score file and selects it.
6439 @kindex h F (Summary)
6440 @findex wl-score-flush-cache
6441 Erases caches associated to the score files that are read.
6442 If you modified score files directly (from other than Wanderlust), you
6443 need to re-read them after erasing the cache.
6446 @kindex h m (Summary)
6447 @findex wl-score-set-mark-below
6448 Specifies the criterion for scores to be marked as read.
6449 Messages with scores less than this value are marked as read.
6452 @kindex h x (Summary)
6453 @findex wl-score-set-expunge-below
6454 Specifies the criterion for scores to be deleted from the summary.
6455 Messages with scores less than this value are deleted.
6456 "Deleted" means it is not shown; they are not removed from the summary
6457 information or the folder.
6458 The deleted messages can be shown by rescan-noscore again.
6461 @subsection Key Bindings in the Score Editing Buffer
6465 @kindex C-c C-k (Score Mode)
6466 @findex wl-score-edit-kill
6467 Abandons the file being edited.
6470 @kindex C-c C-c (Score Mode)
6471 @findex wl-score-edit-exit
6472 Saves the file being edited, and quits from the edit mode.
6475 @kindex C-c C-p (Score Mode)
6476 @findex wl-score-pretty-print
6480 @kindex C-c C-d (Score Mode)
6481 @findex wl-score-edit-insert-date
6482 Inserts the number of dates from Dec. 31, 1 B.C.
6483 It is used for creating the third factor of time-limited scores.
6486 @kindex C-c C-s (Score Mode)
6487 @findex wl-score-edit-insert-header
6488 Inserts the header of the message selected in the summary buffer.
6491 @kindex C-c C-e (Score Mode)
6492 @findex wl-score-edit-insert-entry
6493 Inserts the score entry of the message selected in the summary buffer.
6496 @subsection Customizable Variables
6499 @item wl-summary-default-score
6500 @vindex wl-summary-default-score
6501 The initial setting is 0 (zero).
6502 This variable specifies the default value of the score.
6503 The score is increased or decreased based upon this value.
6505 @item wl-summary-important-above
6506 @vindex wl-summary-important-above
6507 The initial setting is @code{nil}.
6508 Messages with scores larger than this value are attached with the
6509 important mark (@samp{$}).
6510 If @code{nil}, no important marks are attached.
6512 @item wl-summary-target-above
6513 @vindex wl-summary-target-above
6514 The initial setting is @code{nil}.
6515 Messages with scores larger than this value are attached with the target
6517 If @code{nil}, no target marks are attached.
6519 @item wl-summary-mark-below
6520 @vindex wl-summary-mark-below
6521 The initial setting is 0 (zero).
6522 Messages with scores smaller than this value are marked as read.
6524 @item wl-summary-expunge-below
6525 @vindex wl-summary-expunge-below
6526 The initial setting is @code{nil}.
6527 Messages with scores smaller than this value are deleted from the
6529 If @code{nil}, they are not deleted.
6531 @item wl-summary-score-marks
6532 @vindex wl-summary-score-marks
6533 The initial setting is the list shown below:
6537 (list wl-summary-new-uncached-mark
6538 wl-summary-new-cached-mark)
6543 Messages with these marks are scored.
6545 @item wl-use-scoring
6546 @vindex wl-use-scoring
6547 The initial setting is t.
6548 If non-nil, scoring is enabled.
6550 @item wl-score-files-directory
6551 @vindex wl-score-files-directory
6552 The initial setting is @file{~/.elmo/}.
6553 The default directory for score files.
6555 @item wl-score-interactive-default-score
6556 @vindex wl-score-interactive-default-score
6557 The initial setting is 1000.
6558 This value is used as a score when a score factor is @code{nil} in the
6559 score file. It is also used in @code{wl-summary-increase-score} and
6560 @code{wl-summary-lower-score}, on condition that the value of
6561 @code{wl-score-header-default-entry} is @code{nil}.
6563 @item wl-score-expiry-days
6564 @vindex wl-score-expiry-days
6565 The initial setting is 7.
6566 This is the number of days before time-limited scores are deleted.
6568 @item wl-score-update-entry-dates
6569 @vindex wl-score-update-entry-dates
6570 The initial setting is @code{t}.
6571 If non-nil, it enables deletion of time-limited scores.
6573 @item wl-score-header-default-entry
6574 @vindex wl-score-header-default-entry
6575 Specifies the default value for each header field for score entries
6576 created by @code{wl-summary-increase-score},
6577 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6579 @item wl-score-simplify-fuzzy-regexp
6580 @vindex wl-score-simplify-fuzzy-regexp
6581 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6582 regular expression to be deleted from the string.
6583 Because this is usually used for Subject, the default is prefixes that
6584 are attached by mailing list programs.
6586 @item wl-summary-rescore-partial-threshold
6587 @vindex wl-summary-rescore-partial-threshold
6588 The initial setting is 200.
6589 When sync-all or rescan is executed, if there are messages more than
6590 this value, only the last same number of messages as this value are
6593 @item wl-summary-auto-sync-marks
6594 @vindex wl-summary-auto-sync-marks
6595 If non-nil, unread/important marks are synchronized when the summary
6597 Unread marks reflect information on the IMAP4 server.
6598 Important marks reflect information on the IMAP4 server (flagged or
6599 not), and contents of @samp{'flag} folder.
6600 The initial setting is @code{t}.
6604 @node Score File Format, , Score Commands, Scoring
6605 @section Score File Format
6606 @cindex Score File Format
6608 The format of score files are the same as Gnus, and basically you can
6609 use Gnus score files as they are. But they are not fully compatible
6610 because some keys are not supported and there are Wanderlust specifics.
6611 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6616 ("for sale" -1000 nil s)
6617 ("profit" -1000 nil s))
6619 ("spam@@spamspamspam" -10000 nil s))
6621 ("my@@address" 3001 nil s))
6623 (1000000 -10 nil >))
6633 If the key is a string, it is the name of the header to be matched.
6634 The following keys are available:
6635 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6636 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6637 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6638 @code{Chars} and @code{Lines} mean the size and the number of lines of
6639 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6640 are described later.
6641 The rest corresponds the field of the same name.
6643 Arbitrary numbers of core entries are specified after the key.
6644 Each score entry consists of these five factors:
6648 A factor that matches header. This should be a number in the cases of
6649 @code{lines} and @code{chars}, otherwise a string.
6652 A score factor. When the first item matches, the score of the message
6653 is increased or decreased by this value.
6656 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6657 of a number, the score is deleted if it does not match for days
6658 (@code{wl-score-expiry-days}) from the date specified by this.
6659 The date is since Dec. 31, 1 B.C.
6662 A type factor. This specifies the way the first factor matches.
6663 Available types depend on keys.
6666 @item From, Subject, References, Message-ID
6667 For these keys in string, @code{r} and @code{R} (regexp),
6668 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6669 as well as @code{f} and @code{F} (fuzzy) can be used.
6670 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6673 For these keys, the following five numerical relative operators can be
6674 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6677 This key matches @code{From} header, and scores all follow-ups to the
6679 For example, it would be useful for increasing scores for follow-ups to
6682 You can use the same types as @code{From} except for @code{f}.
6683 And a @samp{Followup} entry is automatically appended to the score file.
6686 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6687 A @samp{Thread} entry is automatically appended for each article that
6688 has @var{x} in the @code{References} header.
6689 You can make sure the whole thread including messages that does not have
6690 all ancestors @code{Message-ID} in @code{References} is scored.
6692 You can use the same types as @code{References} except for @code{f}.
6693 And a @samp{Thread} entry is automatically appended to the score file.
6697 A factor for extension header. This is meaningful only if the key is
6699 This specifies headers to be matched other than standard headers like
6700 @code{Subject} and @code{From}.
6701 Note that you should specify the header in
6702 @code{elmo-msgdb-extra-fields} also.
6703 Therefore it does not work in folders where extension headers cannot be
6708 The sum of these scores @emph{after all factors are applied} becomes the
6709 score of the message.
6711 @cindex Score File Atoms
6713 Messages with a score less than this value is marked as read.
6714 The default is @code{wl-summary-mark-below}.
6717 Messages with a score less than this value is deleted from the summary.
6718 The default is @code{wl-summary-expunge-below}.
6720 @item mark-and-expunge
6721 Both @code{mark} and @code{expunge} are applied,
6722 i.e. messages with a score less than this value is marked as read and
6723 deleted from the summary.
6726 Messages with a score greater than this value is attached with temp
6728 The default is @code{wl-summary-target-above}.
6731 Messages with a score greater than this value is attached with important
6733 The default is @code{wl-summary-important-above}.
6738 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6739 are used, you need to set @code{elmo-msgdb-extra-fields}.
6742 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6745 There are other restrictions as shown below:
6748 @item Because @samp{References} field in the summary information
6749 contains only the last @samp{Message-ID}, @code{references} key matches
6753 Keys that can be seen by folder of types:
6757 chars lines xref extra
6758 localdir,localnews Y E E E
6759 nntp (supporting xover) Y E E N
6765 N: cannot be seen (ignored)
6766 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6771 @node Address Book, Spam Filter, Scoring, Top
6772 @chapter Address Book
6773 @cindex Address Book
6775 With address book, you can utilize address completion, and you have
6776 summary displayed with nicknames.
6779 * Mail Addresses:: Definition of Address Book
6780 * Address Manager:: Address Manager
6784 @node Mail Addresses, Address Manager, Address Book, Address Book
6785 @section Address book
6786 @cindex Address book Definition
6788 @cindex Alias, Address
6790 The file @file{~/.addresses} is a simple address book for Wanderlust.
6791 Make address file @file{~/.addresses}, and edit to suit your requirement.
6793 The data written in @file{~/.addresses} are used for address completion
6794 under draft editing mode. Furthermore, they are used when showing names
6795 in summary display mode. You can safely skip this section, if you don't
6796 want to customize address completion and summary display.
6797 It is possible to add/change/remove addresses from @file{~/.addresses} in
6798 summary buffer after Wanderlust is invoked. @refill
6800 The format is very simple. Like this. @refill
6805 # @r{Lines begin with @samp{#} are comment.}
6806 # @r{Empty lines are ignored}
6808 # @r{Format of each line:}
6809 # @var{email-address} "@var{nickname} "@var{realname}"
6811 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6812 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6813 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6818 One line defines one persons description.
6820 Actually, in default setup, @var{nickname} is used in summary-mode and
6821 @var{realname} is used in draft preparation mode. This behavior is
6822 better understood if you try it and confirmed the function first. You
6823 can write and try a small definition, so you will know the idea of the
6824 address book before writing a big one.
6826 And, if MH alias file is specified in variable @code{wl-alias-file},
6827 it is used as an address information in the draft preparation mode.
6829 If variable @code{wl-use-ldap} is non-nil (initial setting is
6830 @code{nil}), address completion in draft mode uses LDAP information.
6832 If you use LDAP, you have to set @code{wl-ldap-server},
6833 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6834 not have LDAP feature as built-in feature (Currently only XEmacs can
6835 have built-in LDAP feature), you have to set command exec @env{PATH} to
6836 the program @command{ldapsearch}.
6839 @node Address Manager, , Mail Addresses, Address Book
6840 @section Address Manager
6841 @cindex Address Manager
6843 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6844 the address book and insert address to draft buffer.
6846 @subsection Key Bindings
6850 @kindex t (Address Manager)
6851 @findex wl-addrmgr-set-to
6852 Add @samp{To:} mark.
6855 @kindex c (Address Manager)
6856 @findex wl-addrmgr-set-cc
6857 Add @samp{Cc:} mark.
6860 @kindex b (Address Manager)
6861 @findex wl-addrmgr-set-bcc
6862 Add @samp{Bcc:} mark.
6865 @kindex u (Address Manager)
6866 @findex wl-addrmgr-unmark
6870 @kindex x (Address Manager)
6871 @findex wl-addrmgr-apply
6873 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6874 buffer and quit address manager. When no draft buffer, make new draft
6875 with insert marked addresses.
6877 If no mark, quit address manager.
6881 @kindex q (Address Manager)
6882 @findex wl-addrmgr-quit
6883 Quit address manager.
6886 @kindex a (Address Manager)
6887 @findex wl-addrmgr-add
6891 @kindex d (Address Manager)
6892 @findex wl-addrmgr-delete
6896 @kindex e (Address Manager)
6897 @findex wl-addrmgr-edit
6902 @node Spam Filter, Advanced Issues, Address Book, Top
6903 @chapter Spam Filter
6906 @code{wl-spam} provides an frontend to external spam filtering programs.
6907 You can register to or judge spam by the filtering program cooperateing
6908 with messages operations on Wanderlust.
6911 * Usage of Spam Filter:: Usage of Spam Filter
6912 * Spam Filter Processors:: Supported spam filters
6915 @node Usage of Spam Filter, Spam Filter Processors, Spam Filter, Spam Filter
6916 @section Usage of Spam Filter
6918 @subsection Initial Setting
6920 To use @code{wl-spam}, write in @file{~/.wl} as follows:
6924 ;; @r{Use @samp{bogofilter} as spam back end}
6925 ;; @r{Set @samp{scheme} here as the spam filter you will use.}
6926 ;; @r{@xref{Spam Filter Processors}.}
6927 (setq elmo-spam-scheme 'bogofilter)
6932 @subsection spam mark
6934 The spam mark (@samp{s}) will be provided as new temporary mark.
6935 Messages marked by this will be refiled into @code{wl-spam-folder} when
6936 the action is called for execution. Marked messages will be skipped by
6937 summary walking in ordinary way.
6939 The spam mark is be put on by spam judgement described later, or by
6940 invoking @kbd{k m} at any time.
6942 @subsection spam judgment
6944 You can judge spam messages by following ways:
6948 Make judgement on execution of auto-refile.
6950 Insert @code{wl-refile-guess-by-spam} to arbitrary position in
6951 @code{wl-auto-refile-guess-functions} as follows.
6955 (setq wl-auto-refile-guess-functions
6956 '(wl-refile-guess-by-rule
6957 wl-refile-guess-by-spam))
6961 In this example, judge spam if it could not decide refile destination by
6962 @code{wl-refile-rule-alist}.
6965 Make judgement on entering the summary of specified folder.
6967 Specify the value of @code{wl-spam-auto-check-folder-regexp-list}
6968 as the list of regular expressions for folder names to be
6969 automatically judged by spam filter.
6972 (setq wl-spam-auto-check-folder-regexp-list '("\\+inbox"))
6975 In this example, judgement will be processed when you enter summary of
6976 the folder whose name contains @samp{+inbox}.
6979 Make judgement on splitting messages with @code{elmo-split}.
6981 It provides new function @code{spam-p} to be specified as @samp{CONDITION}
6982 in @code{elmo-split-rule}. This function returns true when the message
6984 @xref{Split messages}.
6986 You can also process learning by the result of judgement. (You would
6987 better turn on this feature after learning to some extent)
6993 (setq elmo-split-rule
6994 '(((spam-p) "+spam")
6995 ;; @r{to learn by the judgement, use following instead}
6996 ;((spam-p :register t) "+spam")
7002 @subsection spam learning
7004 @code{wl-spam} automatically learn spam with refiling messages.
7006 At first, @code{wl-spam} classifies the folders controlled by Wanderlust
7007 into following 4 domains by the class of containig messages
7011 Folders containing messages judged as spam.
7012 (The folder specified by @code{wl-spam-folder})
7014 Folders containing messages judged as non-spam.
7016 Folders containing messages not yet judged. Folders without
7017 pre-distribution may belong to this domain e.g. @samp{+inbox}.
7018 (specified by @code{wl-spam-undecided-folder-regexp-list})
7020 Foldes have nothing to do with spam processing e.g.
7021 @code{wl-trash-folder} or @code{wl-draft-folder}. (specified by
7022 @code{wl-spam-ignored-folder-regexp-list})
7025 When you refile messages across different domains, it automatically
7026 learn messages as @samp{spam} or @samp{non-spam} according to domains
7027 it belongs before and after.
7029 To put it concretely, it will learn by following rule:
7032 @item undecide -> spam
7035 learn as spam and cancel previous study as non-spam.
7036 @item undecide -> good
7039 learn as non-spam and cancel previous study as spam.
7042 It do not learn anything in other cases.
7044 @subsection Key Bindings
7045 @cindex Keybind, spam filter
7049 @kindex k m (Summary)
7050 @findex wl-summary-spam
7051 Put spam mark (@samp{s}) on current message.
7054 @kindex k c (Summary)
7055 @findex wl-summary-test-spam
7056 Test current message and put spam mark if judged as spam.
7059 @kindex k C (Summary)
7060 @findex wl-summary-mark-spam
7061 Test messages with the mark in @code{wl-spam-auto-check-marks},
7062 and put spam mark if judged as spam. If it is called with prefix
7063 argument, test all messages regardless of their marks.
7066 @kindex k s (Summary)
7067 @findex wl-summary-register-as-spam
7068 Register current message as spam.
7071 @kindex k S (Summary)
7072 @findex wl-summary-register-as-spam-all
7073 Register all messages in the folder as spam.
7076 @kindex k n (Summary)
7077 @findex wl-summary-register-as-good
7078 Register current message as non-spam.
7081 @kindex k N (Summary)
7082 @findex wl-summary-register-as-good-all
7083 Register all messages in the folder as non-spam.
7086 @kindex m k (Summary)
7087 @findex wl-summary-target-mark-spam
7088 Put spam mark (@samp{s}) on messages with the target mark @samp{*}.
7091 @kindex m s (Summary)
7092 @findex wl-summary-target-mark-register-as-spam
7093 Register messages with the target mark @samp{*} as spam.
7096 @kindex m n (Summary)
7097 @findex wl-summary-target-mark-register-as-good
7098 Register messages with the target mark @samp{*} as non-spam.
7101 @subsection Customizable Variables
7104 @item wl-spam-folder
7105 @vindex wl-spam-folder
7106 Specify the name of destination folder for the spam messages.
7107 The initial setting is @samp{+spam}.
7109 @item wl-spam-undecided-folder-regexp-list
7110 @vindex wl-spam-undecided-folder-regexp-list
7111 Specify the list of regexp of folder names which contain messages
7112 not yet decided as spam or non-spam.
7113 The initial setting is @code{'("inbox")}.
7115 @item wl-spam-ignored-folder-regexp-list
7116 @vindex wl-spam-ignored-folder-regexp-list
7117 The initial setting is as follows.
7121 (list (regexp-opt (list wl-draft-folder
7127 Folders of no effect against spam judgement, specified by the list of
7128 folder name regular expressions.
7130 @item wl-spam-auto-check-folder-regexp-list
7131 @vindex wl-spam-auto-check-folder-regexp-list
7132 Folders to make spam judgement on entering the summary of them,
7133 specified by the list of folder name regular expressions.
7134 The initial setting is @code{nil}.
7136 @item wl-spam-auto-check-marks
7137 @vindex wl-spam-auto-check-marks
7138 The initial setting is the following list:
7142 (list wl-summary-new-uncached-mark
7143 wl-summary-new-cached-mark)
7147 Messages with mark specified by this variable will be processed
7148 by whole-folder judgement including auto test by
7149 @code{wl-spam-auto-check-folder-regexp-list}.
7150 Persistent marks can be used in this method, but temporary marks cannot.
7152 You can specify the list of marks as the initial setting, or you can
7153 specify follwing symbol:
7157 Process all messages regardless of persistent marks.
7162 @node Spam Filter Processors, , Usage of Spam Filter, Spam Filter
7163 @section Supported Spam Filters
7164 @cindex Spam Filter, Bogofilter
7165 @cindex Spam Filter, Spamfilter
7167 Supported spam filtering libraries are following ones.
7170 * bogofilter:: bogofilter
7171 * spamfilter:: spamfilter.el
7172 * bsfilter:: bsfilter
7173 * SpamAssassin:: SpamAssassin
7174 * SpamOracle:: SpamOracle
7175 * Regular Expressions Header Matching:: Header regexp
7179 @node bogofilter, spamfilter, Spam Filter Processors, Spam Filter Processors
7180 @subsection bogofilter
7183 bogofilter (@uref{http://bogofilter.sourceforge.net/}) is a spam filter
7184 implemented by C language.
7186 To use spam filter with bogofilter, write following setting in
7187 @file{~/.wl} or somewhere else.
7191 (setq elmo-spam-scheme 'bogofilter)
7195 @subsubsection Customizable Variables
7198 @item elmo-spam-bogofilter-program
7199 @vindex elmo-spam-bogofilter-program
7200 The initial setting is @file{bogofilter}.
7201 Specify the name of executable of bogofilter. If the executable
7202 is not in your environmental variable @env{PATH}, you should
7203 set this by full path.
7205 @item elmo-spam-bogofilter-args
7206 @vindex elmo-spam-bogofilter-args
7207 The initial setting is @code{nil}.
7208 Specify arguments to be supplied for bogofilter executable.
7210 @item elmo-spam-bogofilter-database-directory
7211 @vindex elmo-spam-bogofilter-database-directory
7212 Specify the directory for statistical database to be used.
7213 @code{nil} to use default directory (@file{~/.bogofilter}).
7214 The initial setting is @code{nil}.
7216 @item elmo-spam-bogofilter-max-messages-per-process
7217 @vindex elmo-spam-bogofilter-max-messages-per-process
7218 The initial setting is 30. This variable specifies the number of
7219 messages to be learned by one process.
7221 @item elmo-spam-bogofilter-debug
7222 @vindex elmo-spam-bogofilter-debug
7223 The initial setting is @code{nil}.
7224 If you specify non-nil, the output from @command{bogofilter} is
7225 stored in the buffer named @code{"*Debug ELMO SPAM Bogofilter*"}.
7229 @node spamfilter, bsfilter, bogofilter, Spam Filter Processors
7230 @subsection spamfilter.el
7233 @file{spamfilter.el}
7234 (@uref{http://www.geocities.co.jp/SiliconValley-PaloAlto/7043/}) is a
7235 spam filtering library implemented by Emacs Lisp.
7237 Corresponding modules will be compiled/installed, if you have
7238 @file{spamfilter.el} within @code{load-path} when you are to install wl.
7241 To use @file{spamfilter.el}, write following setting in @file{~/.wl} or
7243 (Of cource, you have to have settings for @file{spamfilter.el} itself)
7247 (setq elmo-spam-scheme 'spamfilter)
7251 @subsubsection Customizable Variables
7254 @item elmo-spam-spamfilter-corpus-filename
7255 @vindex elmo-spam-spamfilter-corpus-filename
7256 The initial setting is @file{~/.elmo/.spamfilter}.
7257 It specifies the name of corpus file.
7260 @node bsfilter, SpamAssassin, spamfilter, Spam Filter Processors
7261 @subsection bsfilter
7264 bsfilter (@uref{http://bsfilter.org/index-e.html}) is a spam filter
7265 implemented by Ruby language.
7267 To use spam filter with bsfilter, write following setting in
7268 @file{~/.wl} or somewhere else.
7272 (setq elmo-spam-scheme 'bsfilter)
7276 @subsubsection Customizable Variables
7279 @item elmo-spam-bsfilter-program
7280 @vindex elmo-spam-bsfilter-program
7281 The initial setting is @file{bsfilter}.
7282 Specify the name of executable of @command{bsfilter}. If the executable
7283 is not in your environmental variable @env{PATH}, you should
7284 set this by full path.
7286 @item elmo-spam-bsfilter-args
7287 @vindex elmo-spam-bsfilter-args
7288 The initial setting is @code{nil}.
7289 Specify arguments to be supplied for bsfilter executable.
7291 @item elmo-spam-bsfilter-database-directory
7292 @vindex elmo-spam-bsfilter-database-directory
7293 Specify the directory for statistical database to be used.
7294 @code{nil} to use default directory (@file{~/.bsfilter}).
7295 The initial setting is @code{nil}.
7297 @item elmo-spam-bsfilter-debug
7298 @vindex elmo-spam-bsfilter-debug
7299 The initial setting is @code{nil}.
7300 If you specify non-nil, the output from @command{bsfilter} is
7301 stored in the buffer named @code{"*Debug ELMO Bsfilter*"}.
7303 @item elmo-spam-bsfilter-shell-program
7304 @vindex elmo-spam-bsfilter-shell-program
7305 The initial setting is @file{ruby}.
7306 Specify the shell to execute @command{bsfilter}. If the shell is not
7307 in your environmental variable @env{PATH}, you should set this by full path.
7309 @item elmo-spam-bsfilter-shell-switch
7310 @vindex elmo-spam-bsfilter-shell-switch
7311 The initial setting is @code{nil}.
7312 Specify options to give to the shell executing @command{bsfilter}.
7314 @item elmo-spam-bsfilter-update-switch
7315 @vindex elmo-spam-bsfilter-update-switch
7316 The initial setting is @code{"--synchronous-auto-update"}.
7317 Specify options to give to @command{bsfilter} for learning messages.
7321 @node SpamAssassin, SpamOracle, bsfilter, Spam Filter Processors
7322 @subsection SpamAssassin
7323 @cindex SpamAssassin
7325 SpamAssassin (@uref{http://spamassassin.org/}) is one of the most
7326 popular spam filtering program implemented on Perl. SpamAssassin
7327 attempts to identify spam using text analysis and several internet-based
7328 realtime blacklists. SpamAssassin also uses a Bayesian learning filter
7329 which enables more accurate spam filtering.
7331 To use @file{SpamAssassin} on Wanderlust, write following setting
7332 in @file{~/.wl} or somewhere else.
7333 (Of course, you have to install SpamAssassin beforehand.)
7337 (setq elmo-spam-scheme 'sa)
7341 @subsubsection Customize Variables
7344 @item elmo-spam-spamassassin-program
7345 @vindex elmo-spam-spamassassin-program
7346 The initial setting is @file{spamassassin}.
7347 Specify the name of executable @command{spamassassin}. If the executable
7348 is not in your environmental variable @env{PATH}, you should
7349 set this by full path.
7351 @item elmo-spam-spamassassin-learn-program
7352 @vindex elmo-spam-spamassassin-learn-program
7353 The initial setting is @file{sa-learn}.
7354 Specify the name of the SpamAssassin's Bayesian filtering learner
7355 program, @command{sa-learn}. If the executable is not in your
7356 environmental variable @env{PATH}, you should set this by full path.
7358 @item elmo-spam-spamassassin-program-arguments
7359 @vindex elmo-spam-spamassassin-program-arguments
7360 The initial setting is @code{'("-e")}.
7361 Specify the arguments to be supplied for @command{spamassassin} executable.
7362 You have to specify the argument to exit the program with an error exit code
7363 when the result is spam. For example, if you want to use @command{spamc}
7364 instead of @command{spamassassin}, you should specify @code{'("-c")}.
7366 @item elmo-spam-spamassassin-learn-program-arguments
7367 @vindex elmo-spam-spamassassin-lern-program-arguments
7368 The initial setting is @code{nil}.
7369 Specify the arguments to be supplied for @command{sa-learn}.
7371 @item elmo-spamassassin-debug
7372 @vindex elmo-spamassassin-debug
7373 The initial setting is @code{nil}.
7374 If you specify @code{t}, the output from @command{spamassassin} is
7375 stored in the buffer named @code{"*Debug ELMO SpamAssassin*"}.
7379 @node SpamOracle, Regular Expressions Header Matching, SpamAssassin, Spam Filter Processors
7380 @subsection SpamOracle
7383 SpamOracle (`http://pauillac.inria.fr/~xleroy/software.html#spamoracle')
7384 is a spam filter implemented by Objective Caml language.
7386 To use spam filter with @file{spamoracle}, write following setting in
7387 @file{~/.wl} or somewhere else.
7388 (Of course, you have to install SpamOracle beforehand.)
7392 (setq elmo-spam-scheme 'spamoracle)
7396 @subsubsection Customizable Variables
7399 @item elmo-spam-spamoracle-program
7400 @vindex elmo-spam-spamoracle-program
7401 The initial setting is @file{spamoracle}. Specify the name of
7402 executable of spamoracle. If the executable is not in your
7403 environmental variable @env{PATH}, you should set this by full path.
7405 @item elmo-spam-spamoracle-config-filename
7406 @vindex elmo-spam-spamoracle-config-filename
7407 Specify the name of config file. @code{nil} to use default file
7408 (@file{~/.spamoracle.conf}). The initial setting is @code{nil}.
7410 @item elmo-spam-spamoracle-database-filename
7411 @vindex elmo-spam-spamoracle-database-filename
7412 The initial setting is @file{~/.elmo/.spamoracle.db}.
7413 It specifies the name of database file.
7415 @item elmo-spam-spamoracle-spam-header-regexp
7416 @vindex elmo-spam-spamoracle-spam-header-regexp
7417 The initial setting is @code{"^X-Spam: yes;"}. It specifies the regular
7418 expression of the header that indicates spam mail. Use this setting
7419 when you change the @code{spam_header} parameter in the config file.
7423 @node Regular Expressions Header Matching, , SpamOracle, Spam Filter Processors
7424 @subsection Regular Expressions Header Matching
7425 @cindex Regular Expressions Header Matching
7427 Examine if regular expression matches corresponding field in message heaeder,
7428 and decide spam or not. To use this backend, add following setting to @file{~/.wl}.
7432 (setq elmo-spam-scheme 'header)
7436 If you want to check fields not included in the default overview
7437 information, add one into @code{elmo-msgdb-extra-fields}. Then it will
7438 do examination by the overview information and avoid loading whole
7439 message body as far as possible.
7441 @subsubsection Customize Variables
7444 @item elmo-spam-header-good-alist
7445 @vindex elmo-spam-header-good-alist
7446 The initial setting is the following list:
7449 '(("X-Spam-Flag" . "No"))
7452 Specify a list of regular expressions to match with header field name
7453 for making non-spam decision. It takes precedence over
7454 @code{elmo-spam-header-spam-alist}.
7456 @item elmo-spam-header-spam-alist
7457 @vindex elmo-spam-header-spam-alist
7458 The initial setting is the following list:
7461 '(("X-Spam-Flag" . "Yes"))
7464 Specify a list of regular expressions to match with header field name
7465 for making spam decision.
7469 @node Advanced Issues, Migration, Spam Filter, Top
7470 @chapter Advanced Issues
7471 @cindex Advanced Issues
7474 * Living with other packages:: Cooperating with other packages
7475 * Highlights:: Highlights
7476 * Biff:: Notify Mail arrival
7477 * Password Management:: Manage Passwords
7478 * Split messages:: Splitting messages
7479 * Batch Processing:: Invoke commands in batch mode
7480 * Advanced Settings:: Advanced Settings
7481 * Customizable Variables:: Customizable Variables
7486 @node Living with other packages, Highlights, Advanced Issues, Advanced Issues
7487 @section Living with other packages
7489 Examples with other packages.
7492 * imput:: imput (im-wl.el)
7493 * BBDB:: The Insidious Big Brother Database
7494 * LSDB:: The Lovely Sister Database
7495 * supercite:: supercite.el
7496 * mu-cite:: mu-cite.el
7497 * X-Face:: x-face,bitmap-mule
7498 * dired-dd:: dired-dd.el
7500 * Addrbook:: Addrbook
7501 * mime-w3m:: mime-w3m.el
7505 @node imput, BBDB, Living with other packages, Living with other packages
7510 Place @file{util/im-wl.el} on the @code{load-path} and do the following
7515 (autoload 'wl-draft-send-with-imput-async "im-wl")
7516 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
7521 @node BBDB, LSDB, imput, Living with other packages
7525 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
7526 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
7527 and do the following settings.
7529 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
7530 byte-compiled and installed.
7538 ;; @r{enable pop-ups}
7539 (setq bbdb-use-pop-up t)
7540 ;; @r{auto collection}
7541 (setq bbdb/mail-auto-create-p t)
7542 ;; @r{exceptional folders against auto collection}
7543 (setq bbdb-wl-ignore-folder-regexp "^@@")
7544 (setq signature-use-bbdb t)
7545 (setq bbdb-north-american-phone-numbers-p nil)
7546 ;; @r{shows the name of bbdb in the summary} :-)
7547 (setq wl-summary-from-function 'bbdb-wl-from-func)
7548 ;; @r{automatically add mailing list fields}
7549 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
7550 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
7554 You can complete address with BBDB by @kbd{M-@key{TAB}}
7558 @node LSDB, supercite, BBDB, Living with other packages
7562 The following is an example setting to use
7563 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
7570 (add-hook 'wl-draft-mode-hook
7572 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
7576 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
7577 (complete address with LSDB).
7580 @node supercite, mu-cite, LSDB, Living with other packages
7581 @subsection sc.el(supercite), sc-register.el
7585 The same setting as usual mailers should be OK. The following is an
7586 example of settings:
7590 (autoload 'sc-cite-original "supercite" nil t)
7591 (add-hook 'mail-citation-hook 'sc-cite-original)
7596 @node mu-cite, X-Face, supercite, Living with other packages
7597 @subsection mu-cite.el
7600 The same setting as usual mailers should be OK. The following is an
7601 example of settings.
7603 If you use mu-cite version 8.0 or earlier:
7607 (autoload 'mu-cite/cite-original "mu-cite" nil t)
7608 (setq mail-citation-hook 'mu-cite/cite-original)
7612 If you use mu-cite version 8.1 or later:
7616 (autoload 'mu-cite-original "mu-cite" nil t)
7617 (add-hook 'mail-citation-hook (function mu-cite-original))
7621 @node X-Face, dired-dd, mu-cite, Living with other packages
7625 If you have installed one of the following, you can decode
7626 @samp{X-Face:} field in message buffer and you will see face image.
7629 * x-face-xmas:: XEmacs case
7630 * x-face-mule:: Emacs case
7633 If there is an encoded X-Face string in a file @file{~/.xface} (the
7634 value of the variable @code{wl-x-face-file}), it is inserted as a
7635 @samp{X-Face:} field in the draft buffer (if
7636 @code{wl-auto-insert-x-face} is non-nil).
7638 @node x-face-xmas, x-face-mule, X-Face, X-Face
7639 @subsubsection x-face-xmas (for XEmacs)
7642 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
7643 1.3.6.13 or later, do the following:
7647 (autoload 'x-face-xmas-wl-display-x-face "x-face")
7648 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
7652 @node x-face-mule, , x-face-xmas, X-Face
7653 @subsubsection x-face-mule (for Emacs)
7657 If you use @file{x-face-mule.el} in bitmap-mule
7658 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
7662 (autoload 'x-face-decode-message-header "x-face-mule")
7663 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7667 @subsubsection x-face-e21 (for Emacs 21.x)
7670 With Emacs 21.x, you can use @file{x-face-e21.el}
7671 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
7672 to display X-Face. In this case, bitmap-mule is not required.
7677 (autoload 'x-face-decode-message-header "x-face-e21")
7678 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7683 @node dired-dd, MHC, X-Face, Living with other packages
7684 @subsection dired-dd(Dired-DragDrop)
7685 @pindex Dired-DragDrop
7687 @cindex Drag and Drop
7689 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
7690 compose multi-part by simple Drag-and-Drop from dired to the draft
7691 buffer being edited in GNU Emacs (this feature is not Wanderlust
7692 specific, but general-purpose for SEMI).
7696 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
7702 ;; @r{Set dired-x variables here.}
7703 ;; @r{To and flo@dots{}}
7705 (progn (require 'dired-dd)
7706 (require 'dired-dd-mime))))))
7710 @node MHC, Addrbook, dired-dd, Living with other packages
7714 Message Harmonized Calendaring system
7715 (@uref{http://www.quickhack.net/mhc/})
7717 By using MHC, you can make a calendar from the messages.
7723 (setq mhc-mailer-package 'wl)
7724 (autoload 'mhc-mode "mhc" nil t)
7725 (add-hook 'wl-summary-mode-hook 'mhc-mode)
7726 (add-hook 'wl-folder-mode-hook 'mhc-mode)
7734 (autoload 'mhc-wl-setup "mhc-wl")
7735 (add-hook 'wl-init-hook 'mhc-wl-setup)
7739 @node Addrbook, mime-w3m, MHC, Living with other packages
7740 @subsection wl-addrbook.el
7744 (@uref{http://www.mew.org/})
7746 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
7747 @code{load-path} and do the following settings.
7751 (require 'wl-addrbook)
7756 @node mime-w3m, , Addrbook, Living with other packages
7757 @subsection mime-w3m.el
7760 You can display html part by using @file{mime-w3m.el}
7761 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
7762 You can find the usage in comment region at the head of @file{mime-w3m.el}.
7765 @node Highlights, Biff, Living with other packages, Advanced Issues
7768 @subsection Customizable Variables
7771 @item wl-summary-highlight
7772 @vindex wl-summary-highlight
7773 The initial setting is @code{t}.
7774 If non-nil, the summary is highlighted.
7776 @item wl-highlight-max-summary-lines
7777 @vindex wl-highlight-max-summary-lines
7778 The initial setting is 10000.
7779 The summary is not highlighted if it has more lines than this value.
7781 @item wl-summary-highlight-partial-threshold
7782 @vindex wl-summary-highlight-partial-threshold
7783 The initial setting is 1000.
7784 This is a threshold whether the whole summary is highlighted.
7785 If there are more lines of messages in the summary, it is partially
7788 @item wl-summary-partial-highlight-above-lines
7789 @vindex wl-summary-partial-highlight-above-lines
7790 The initial setting is 30. If there are more lines of messages than
7791 @code{wl-summary-highlight-partial-threshold} in the summary, messages
7792 after the point that is the same number of lines as this value above the
7793 cursor line are highlighted partially. (If this value is @code{nil},
7794 the last same number of lines as the value of
7795 @code{wl-summary-highlight-partial-threshold} are highlighted.)
7797 @item wl-highlight-body-too
7798 @vindex wl-highlight-body-too
7799 The initial setting is @code{t}.
7800 If non-nil, bodies of drafts and messages are also highlighted.
7802 @item wl-highlight-message-header-alist
7803 @vindex wl-highlight-message-header-alist
7804 When highlighting headers of drafts and messages, this variable
7805 specifies which faces are allocated to important
7806 (@code{wl-highlight-message-important-header-contents}), secondly
7807 important (@code{wl-highlight-message-important-header-contents2}), and
7808 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7810 Similarly, it can be used for allocating arbitrary faces to arbitrary
7811 regular expressions.
7813 @item wl-highlight-citation-prefix-regexp
7814 @vindex wl-highlight-citation-prefix-regexp
7815 Specifies a regular expression to which quoted lines in bodies of
7816 drafts and messages match.
7817 Bodies matching to this regular expression are highlighted by the faces
7818 specified by (@code{wl-highlight-message-cited-text-*}).
7820 @item wl-highlight-highlight-citation-too
7821 @vindex wl-highlight-highlight-citation-too
7822 The initial setting is @code{nil}.
7823 If non-nil, the quoting regular expression itself given by
7824 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7826 @item wl-highlight-citation-header-regexp
7827 @vindex wl-highlight-citation-header-regexp
7828 Specifies a regular expression that denotes beginning of quotation.
7829 Bodies matching to this regular expression are highlighted by the face
7830 specified by @code{wl-highlight-message-headers}.
7832 @item wl-highlight-max-header-size
7833 @vindex wl-highlight-max-header-size
7834 The initial setting is @code{nil}. If a header size is larger than this
7835 value, it will not be highlighted. If @code{nil}, always highlighted
7836 (ignore header size).
7838 @item wl-highlight-max-message-size
7839 @vindex wl-highlight-max-message-size
7840 The initial setting is 10000.
7841 If a message is larger than this value, it will not be highlighted.
7842 With this variable, highlight is suppressed for uuencode or huge digest
7845 @item wl-highlight-signature-separator
7846 @vindex wl-highlight-signature-separator
7847 Specifies regular expressions that denotes the boundary of a signature.
7848 It can be a regular expression, or a list of ones.
7849 Messages after the place that matches this regular expression are
7850 highlighted by the face specified by
7851 @code{wl-highlight-message-signature}.
7853 @item wl-max-signature-size
7854 @vindex wl-max-signature-size
7855 The initial setting is 400.
7856 This is the largest size for a signature to be highlighted.
7858 @item wl-use-highlight-mouse-line
7859 @vindex wl-use-highlight-mouse-line
7860 The initial setting is @code{t}.
7861 If non-nil, the line pointed by the mouse is highlighted in the folder
7862 mode, summary mode, and the like.
7865 @subsection Setting Colors and Fonts of the Characters
7867 If you want to change colors or fonts of the characters, you need to
7868 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7869 want to change fonts, and @code{set-face-foreground} for colors, and so
7870 on. You cannot write face settings in @file{.emacs}; write in
7873 For example, if you want to change the color for signatures to yellow,
7877 (set-face-foreground 'wl-highlight-message-signature "yellow")
7883 Faces defined in Wanderlust:
7886 @item wl-highlight-message-headers
7887 The face for field names of message headers.
7889 @item wl-highlight-message-header-contents
7890 The face for field bodies of message headers.
7892 @item wl-highlight-message-important-header-contents
7893 The face for important parts of message headers.
7894 Per default, this face is used for a body of @samp{Subject:} field.
7895 You can change its value by editing
7896 @code{wl-highlight-message-header-alist}.
7898 @item wl-highlight-message-important-header-contents2
7899 The face for secondly important parts of message headers.
7900 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7901 fields. You can change its value by editing
7902 @code{wl-highlight-message-header-alist}.
7904 @item wl-highlight-message-unimportant-header-contents
7905 The face for unimportant parts of message headers.
7906 Per default, this face is used for bodies of @samp{X-} fields
7907 @samp{User-Agent:} fields. You can change its value by editing
7908 @code{wl-highlight-message-header-alist}.
7910 @item wl-highlight-message-citation-header
7911 The face for headers of quoted messages.
7913 @item wl-highlight-message-cited-text-*
7914 The face for texts of quoted messages. The last @samp{*} is a
7915 @var{single figure} so that 10 different colors can be used according to
7918 @item wl-highlight-message-signature
7919 The face for signatures of messages. The initial settings are
7920 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7921 dark background colors.
7923 @item wl-highlight-header-separator-face
7924 The face for header separators of draft messages.
7926 @item wl-highlight-summary-important-face
7927 The face for message lines with important marks in the summary.
7929 @item wl-highlight-summary-new-face
7930 The face for message lines with new marks in the summary.
7932 @item wl-highlight-summary-displaying-face
7933 The face for the message line that is currently displayed.
7934 This face is overlaid.
7936 @item wl-highlight-thread-indent-face
7937 The face for the threads that is currently displayed.
7939 @item wl-highlight-summary-unread-face
7940 The face for message lines with unread marks in the summary.
7942 @item wl-highlight-summary-deleted-face
7943 The face for message lines with delete marks in the summary.
7945 @item wl-highlight-summary-refiled-face
7946 The face for message lines with re-file marks in the summary.
7948 @item wl-highlight-refile-destination-face
7949 The face for re-file information part of message lines with re-file
7950 marks in the summary.
7952 @item wl-highlight-summary-copied-face
7953 The face for message lines with copy marks in the summary.
7955 @item wl-highlight-summary-target-face
7956 The face for message lines with target marks @samp{*} in the summary.
7958 @item wl-highlight-summary-thread-top-face
7959 The face for message lines that are on the top of the thread in the
7962 @item wl-highlight-summary-normal-face
7963 The face for message lines that are not on top of the thread in the
7966 @item wl-highlight-folder-unknown-face
7967 The face for folders that are not known to have how many unsync messages
7970 @item wl-highlight-folder-zero-face
7971 The face for folders that have no unsync messages in the folder mode.
7973 @item wl-highlight-folder-few-face
7974 The face for folders that have some unsync messages in the folder mode.
7976 @item wl-highlight-folder-many-face
7977 The face for folders that have many unsync messages in the folder mode.
7978 The boundary between `some' and `many' is specified by the variable
7979 @code{wl-folder-many-unsync-threshold}.
7981 @item wl-highlight-folder-unread-face
7982 The face for folders that have no unsync but unread messages in the
7985 @item wl-highlight-folder-killed-face
7986 The face for folders that are deleted from the access group in the
7989 @item wl-highlight-folder-opened-face
7990 The face for open groups in the folder mode.
7991 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7992 @code{nil} or a @var{number}.
7994 @item wl-highlight-folder-closed-face
7995 The face for close groups in the folder mode.
7996 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7997 @code{nil} or a @var{number}.
7999 @item wl-highlight-folder-path-face
8000 The face for the path to the currently selected folder in the folder
8003 @item wl-highlight-logo-face
8004 The face for logo in the demo.
8006 @item wl-highlight-demo-face
8007 The face for strings (for example, a version number) in the demo.
8011 @node Biff, Password Management, Highlights, Advanced Issues
8012 @section Notify Mail arrival
8015 Following setting is to notify mail arrival of @samp{%inbox}
8016 by the indicator on the modeline
8019 (setq wl-biff-check-folder-list '("%inbox"))
8022 @subsection Customizable Variables
8024 @item wl-biff-check-folder-list
8025 @vindex wl-biff-check-folder-list
8026 The initial setting is @code{nil}.
8027 This is the list of folders to check mail arrival.
8028 If @code{nil}, wl doesn't check mail arrival.
8030 @item wl-biff-check-interval
8031 @vindex wl-biff-check-interval
8032 The initial setting is 40 (in seconds).
8033 Check mail arrival in this period.
8035 @item wl-biff-use-idle-timer
8036 @vindex wl-biff-use-idle-timer
8037 The initial setting is @code{nil}.
8038 If it is @code{nil}, check mail arrival when the time specified by
8039 @code{wl-biff-check-interval} has passed. If it is non-nil, check
8040 mail arrival when idling time exceeds @code{wl-biff-check-interval}.
8042 @item wl-biff-notify-hook
8043 @vindex wl-biff-notify-hook
8044 This hook is run at the arrival of new mail.
8045 To beep with mail arrival(initial setting), set as follows.
8047 (setq wl-biff-notify-hook '(ding))
8049 For silence, set to @code{nil}.
8053 @node Password Management, Split messages, Biff, Advanced Issues
8054 @section Manage Passwords
8056 If you input passwords to connect servers, they are stored in the
8057 variable @code{elmo-passwd-alist} per connection. You should be careful
8058 that others might read your passwords if they can touch your Emacs,
8059 since encoded plain passwords are there.
8061 If you invoke @kbd{M-x elmo-passwd-alist-save} while you have stored
8062 passwords, then they are saved on the file, and it will save you to
8063 input passwords. In this case, the risk that someone reads your
8064 keystroke might decrease, but please not that plain passwords are
8065 stored on a file. You should treat them very carefully.
8066 To remove saved passwords on file, invoke @kbd{M-x elmo-passwd-alist-clear}
8067 and then @kbd{M-x elmo-passwd-alist-save}.
8070 @item elmo-passwd-alist-file-name
8071 @vindex elmo-passwd-alist-file-name
8072 The initial setting is @file{passwd}.
8073 This is the name of the file in which passwords are saved.
8074 @code{elmo-passwd-alist-save} saves current passwords to the file.
8076 @item elmo-passwd-life-time
8077 @vindex elmo-passwd-life-time
8078 The initial setting is @code{nil}.
8079 If the value is some number, timer is set to remove password entry after
8080 @code{elmo-passwd-life-time} seconds since you input the password.
8081 @code{nil} means never to remove passwords.
8085 @node Split messages, Batch Processing, Password Management, Advanced Issues
8086 @section Message splitting
8087 @cindex Split messages
8089 You can use @code{elmo-split} to split message in folder specified by
8090 the variable @code{elmo-split-folder} a la @command{procmail} according
8091 to some specified rules. To use this feature, set as follows in your
8092 @file{~/.emacs} at first.
8095 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
8098 Set source folder like following.
8101 (setq elmo-split-folder "%inbox")
8104 And specify the rule in the variable @code{elmo-split-rule} (its format
8105 will be is described below).
8106 Then you can invoke @kbd{M-x elmo-split} to split messages according to
8107 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
8108 to do a rehearsal and show result (do not split actually).
8111 We will describe how to specify the rule. First of all, see following
8116 (setq elmo-split-rule
8117 ;; @r{Store messages from spammers into @samp{+junk}}
8118 '(((or (address-equal from "i.am@@spammer")
8119 (address-equal from "dull-work@@dull-boy")
8120 (address-equal from "death-march@@software")
8121 (address-equal from "ares@@aon.at")
8122 (address-equal from "get-money@@richman"))
8124 ;; @r{Store messages from mule mailing list into @samp{%mule}}
8125 ((equal x-ml-name "mule") "%mule")
8126 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
8127 ;; @r{and continue evaluating following rules}
8128 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
8129 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
8130 ((match from "\\(.*\\)@@yahoo\\.com")
8132 ;; @r{Store unmatched mails into @samp{+inbox}}
8137 The basic unit of the rule is a combination like
8140 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
8143 If @samp{CONDITION} is true, @samp{ACTION} is performed.
8144 The 1st element @samp{CONDITION} is a condition represented by a
8145 balanced expression (sexp). Its grammar will be explained below.
8146 The 2nd element @samp{ACTION} is the name of the folder to split
8147 messages into, or a symbol. When the 3rd element @code{continue} is
8148 specified as symbol, evaluating rules is not stopped even when the
8149 condition is satisfied.
8151 The grammar for @samp{CONDITION} is as follows. See example above to
8152 learn how to write the condition practically.
8156 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
8157 (@samp{FIELD-NAME} is a symbol that describes the field name)
8161 True if the field value equals to @samp{VALUE}.
8162 Case of the letters are ignored.
8164 True if the field value matches to VALUE.
8165 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
8166 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
8167 @item @code{address-equal}
8168 True if one of the addresses in the field equals to
8169 @samp{VALUE}. Case of the letters are ignored.
8170 @item @code{address-match}
8171 True if one of the addresses in the field matches to
8173 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
8174 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
8178 Functions which accept an integer argument (@samp{SIZE}).
8182 True if the size of the message is less than @samp{SIZE}.
8184 True if the size of the message is greater than @samp{SIZE}.
8188 Functions which accept any number of arguments.
8192 True if one of the argument returns true.
8194 True if all of the arguments return true.
8200 When a symbol is specified, it is evaluated.
8203 You can specify followings as 2nd @samp{ACTION}.
8209 If some string is specified, it will be regarded as the destination
8210 folder, and the message will be appended to it.
8215 If the symbol @samp{delete} is specified, delete the substance of the
8216 message in @code{elmo-split-folder}
8221 If the symbol @samp{noop} is specified, do nothing on the message and
8227 If some function is specified, execute it.
8230 If the message passes all rules, it will be dealed along @samp{ACTION}
8231 specified by @code{elmo-split-default-action}.
8234 @node Batch Processing, Advanced Settings, Split messages, Advanced Issues
8235 @section Batch Processing
8236 @cindex Batch Processing
8238 You can request wanderlust to do some job on the command line.
8239 For now, you can invoke prefetching new messages in specified folders.
8241 Specify target folders in @code{wl-batch-prefetch-folder-list} then
8242 invoke as follows to execute prefetching:
8246 % emacs -batch -l wl-batch -f wl-batch-prefetch
8250 @subsection Customize Variables
8253 @item wl-batch-prefetch-folder-list
8254 @vindex wl-batch-prefetch-folder-list
8255 Target folders of prefetching by @code{wl-batch-prefetch}, specified as
8256 a list of folder names.
8260 @node Advanced Settings, Customizable Variables, Batch Processing, Advanced Issues
8261 @section Advanced Settings
8264 * Draft for Reply:: Draft for Reply
8265 * Thread Format:: Appearance of Thread
8266 * User-Agent Field:: @samp{User-Agent:} Header Field
8270 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
8271 @subsection Draft for Replay
8272 @vindex wl-draft-reply-with-argument-list
8273 @vindex wl-draft-reply-without-argument-list
8275 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
8276 The addressee for the draft is decided by following rules.
8278 For example, you can set as follows:
8282 (setq wl-draft-reply-without-argument-list
8283 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8284 ("Followup-To" . (nil nil ("Followup-To")))
8285 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8286 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
8290 Where each element of the list @code{wl-draft-reply-without-argument-list}
8294 (key . (to-list cc-list newsgroup-list))
8297 and if the field designated by @samp{key} exist in the parent message,
8298 parent's field values designated by @samp{to-list} are copied to @samp{To:}
8299 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
8300 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
8301 the draft respectively.
8306 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8309 Match if the parent has @samp{Mail-Followup-To} field.
8310 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
8311 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
8315 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8318 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
8319 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
8322 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
8325 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
8326 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
8329 These are evaluated in order and first matched one is used.
8331 Moreover, the behavior of @kbd{a} with prefix argument can
8332 be directed by @code{wl-draft-reply-with-argument-list} as well.
8335 By the way, you can use some function (will be evaluated in the parent
8336 message buffer) in the place of @samp{key} or @samp{to-list} etc.
8338 If you want to write a rule for replying to message written by yourself,
8339 specify function @code{wl-draft-self-reply-p} as @samp{key}.
8341 If you only want to reply to mailing lists in
8342 @code{wl-subscribed-mailing-list} if the parent has some of them,
8347 (defun wl-mailing-list-addresses ()
8351 (nth 1 (std11-extract-address-components addr)))
8354 (elmo-multiple-fields-body-list (list "To" "Cc"))
8356 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
8357 (setq list-addrs (cons to list-addrs))))
8358 (nreverse list-addrs)))
8360 (setq wl-draft-reply-with-argument-list
8361 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
8362 ("Reply-To" . (("Reply-To") nil nil))
8363 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
8364 ("From" . (("From") nil nil))))
8369 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
8370 @subsection Appearance of Threads
8374 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
8375 390 09/18(Fri)07:25 +-[ Tsumura-san ]
8376 391 09/18(Fri)19:24 +-[ Murata-san ]
8377 392 09/20(Sun)21:49 +-[ Okunishi-san ]
8378 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
8379 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
8380 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
8381 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
8382 412 09/22(Tue)09:28 | +-[ Teranishi ]
8383 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
8384 416 09/22(Tue)12:38 | +-[ Teranishi ]
8385 395 09/20(Sun)21:49 +-[ Okunishi-san ]
8386 397 09/21(Mon)00:15 +-[ Okunishi-san ]
8390 Settings to make appearance of threads like shown above:
8394 (setq wl-thread-indent-level 2)
8395 (setq wl-thread-have-younger-brother-str "+")
8396 (setq wl-thread-youngest-child-str "+")
8397 (setq wl-thread-vertical-str "|")
8398 (setq wl-thread-horizontal-str "-")
8399 (setq wl-thread-space-str " ")
8403 If you do not want to see branches, do the following:
8407 (setq wl-thread-indent-level 2)
8408 (setq wl-thread-have-younger-brother-str " ")
8409 (setq wl-thread-youngest-child-str " ")
8410 (setq wl-thread-vertical-str " ")
8411 (setq wl-thread-horizontal-str " ")
8412 (setq wl-thread-space-str " ")
8417 @node User-Agent Field, , Thread Format, Advanced Settings
8418 @subsection User-Agent Field
8422 If you are eccentric enough to elaborate @samp{X-Mailer:} or
8423 @samp{User-Agent:} fields, define a function that generate appropriate
8424 strings as you like, and set it to variable
8425 @code{wl-generate-mailer-string-function}.
8427 If you do not want verbose @samp{User-Agent:} field, do the following:
8431 (setq wl-generate-mailer-string-function
8432 'wl-generate-user-agent-string-1)
8436 The following is a example:
8440 (setq wl-generate-mailer-string-function nil)
8441 (setq wl-draft-additional-header-alist
8443 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
8448 @node Customizable Variables, Hooks, Advanced Settings, Advanced Issues
8449 @section Customizable Variables
8451 Customizable variables that have not been described yet:
8454 @item wl-default-folder
8455 @vindex wl-default-folder
8456 The initial setting is @samp{%inbox}. This is the default value for moving to
8457 a folder and the like.
8459 @item wl-draft-folder
8460 @vindex wl-draft-folder
8461 The initial setting is @samp{+draft}. It is the folder to which drafts are
8462 saved. It must be a writable folder.
8463 You can set IMAP remote folder, Maildir and so on.
8464 Note that variable settings applied by @code{wl-draft-config-exec} is saved
8465 under @code{elmo-msgdb-directory}. That is to say, if you specified remote
8466 folder as @code{wl-draft-folder}, variable settings which are applied by
8467 @code{wl-draft-config-exec} before saving the draft will not affect on the
8468 draft buffer on another host by invoking @code{wl-summary-reedit}.
8470 @item wl-trash-folder
8471 @vindex wl-trash-folder
8472 The initial setting is @samp{+trash}. It is the wastebasket folder.
8473 If you changed this variable, you had better restart Wanderlust.
8475 @item wl-interactive-exit
8476 @vindex wl-interactive-exit
8477 The initial setting is @code{t}.
8478 If non-nil, you are asked for confirmation when Wanderlust terminates.
8480 @item wl-interactive-send
8481 @vindex wl-interactive-send
8482 The initial setting is @code{t}.
8483 If non-nil, you are asked for confirmation when mail is sent.
8485 @item wl-default-sync-range
8486 @vindex wl-default-sync-range
8487 The initial setting is @samp{update}.
8488 Default update range of the summary. You can specify
8489 @samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
8490 See description of @code{wl-summary-sync} for the meaning of ranges.
8492 @item wl-folder-sync-range-alist
8493 @vindex wl-folder-sync-range-alist
8494 The initial setting is the alist shown below:
8499 ("^\\+draft$\\|^\\+queue$" . "all"))
8504 This is an associative list of regular expressions of folder names and
8505 update range of the summary. Update range is one of the @samp{all},
8506 @samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
8507 match any of them, the value of @code{wl-default-sync-range} is used
8508 (@samp{update} by default).
8509 See description of @code{wl-summary-sync} for the meaning of ranges.
8512 @vindex wl-ask-range
8513 The initial setting is @code{t}.
8514 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
8515 for updating the summary when you changed folders.
8517 @item wl-mime-charset
8518 @vindex wl-mime-charset
8519 The initial setting is @code{x-ctext}.
8520 This is the MIME charset for messages that are not MIME (e.g. without
8521 @samp{Content-Type:}). This value also used as default charset for
8522 summary. (If you want to share Summary on Nemacs and other Emacsen, set
8523 this value as @code{iso-2022-jp}.)
8525 @item wl-highlight-folder-with-icon
8526 @vindex wl-highlight-folder-with-icon
8527 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
8528 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
8530 @item wl-strict-diff-folders
8531 @vindex wl-strict-diff-folders
8532 This is a list of regular expressions of folders.
8533 Unread messages are checked, for example when you press @kbd{s} in
8534 the folder mode, usually in a brief way (rapidly processed but not
8536 The folders matching this variable are seriously checked.
8537 You may want to set this variable so as to match conditional filter
8538 folders for IMAP4 folders.
8539 The initial setting is @code{nil}.
8541 @item wl-folder-use-server-diff
8542 @vindex wl-folder-use-server-diff
8543 When unread messages are checked, for example when you press @kbd{s} in
8544 the folder mode, usually (the number of messages on the server) @minus{}
8545 (the number of local messages) will be the number of unread messages.
8546 However, if this variable is non-nil, the number of unread messages on
8547 the server is checked. This affects IMAP4 folders only, but IMAP4
8548 folders in mail boxes matching
8549 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
8550 the number of unread messages on the server, even if they matches this
8551 variable. The initial setting is @code{t}.
8553 @item wl-auto-check-folder-name
8554 @vindex wl-auto-check-folder-name
8555 The initial setting is @code{nil}.
8556 You can specify a folder or a group which is checked for unread message
8557 at the start. You can also specify a list of folders (groups) to be checked.
8558 If the value is @code{nil}, whole Desktop is checked at the start.
8559 If it is @code{none}, no folders are checked.
8561 @item wl-auto-uncheck-folder-list
8562 @vindex wl-auto-uncheck-folder-list
8563 The initial setting is the list shown below:
8572 You can set a list of regular expressions to specify folders
8573 which are not automatically checked even if they are included
8574 in some groups assigned by @code{wl-auto-check-folder-name}.
8576 @item wl-auto-check-folder-list
8577 @vindex wl-auto-check-folder-list
8578 The initial setting is @code{nil}.
8579 You can set a list of regular expressions to specify exceptions
8580 for @code{wl-auto-uncheck-folder-list}.
8582 @item wl-no-save-folder-list
8583 @vindex wl-no-save-folder-list
8584 The initial setting is the list shown below:
8593 This is a list of regular expressions of folders not to be saved.
8595 @item wl-save-folder-list
8596 @vindex wl-save-folder-list
8597 The initial setting is @code{nil}.
8598 This is a list of regular expressions of folders to be saved.
8599 This takes precedence over @code{wl-no-save-folder-list}.
8601 @item wl-folder-mime-charset-alist
8602 @vindex wl-folder-mime-charset-alist
8603 The initial setting is the alist shown below:
8607 (("^-alt\\.chinese" . big5)
8608 ("^-relcom\\." . koi8-r)
8610 ("^-han\\." . euc-kr))
8615 This is an associative list of regular expressions of folder names and
8617 If a folder do not match, @code{wl-mime-charset} is used.
8619 @item wl-folder-init-load-access-folders
8620 @vindex wl-folder-init-load-access-folders
8621 The initial setting is @code{nil}.
8622 This is a list of access groups to be loaded specifically at the start.
8623 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
8625 @item wl-folder-init-no-load-access-folders
8626 @vindex wl-folder-init-no-load-access-folders
8627 The initial setting is @code{nil}.
8628 This is a list of access groups not to be loaded specifically at the
8630 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
8632 @item wl-dispose-folder-alist
8633 @vindex wl-dispose-folder-alist
8634 The initial setting is the alist shown below:
8644 This list determines disposition of messages with disposal marks.
8645 Each item in the list is a folder and destination; you can specify any
8646 one of the following in the place of destination:
8649 @code{remove} or @code{null} : deletes the messages instantly.
8650 string : moves the messages to the specific folder.
8651 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
8654 @item wl-x-face-file
8655 @vindex wl-x-face-file
8656 The initial setting is @file{~/.xface}.
8657 The name of the file that contains encoded X-Face strings.
8660 @item wl-demo-display-logo
8661 @vindex wl-demo-display-logo
8662 If non-nil, bitmap image is shown on the opening demo. If you set
8663 @code{xpm} or @code{xbm}, (if possible) display selected image type
8666 @item elmo-use-database
8667 @vindex elmo-use-database
8668 This is meaningful for XEmacs only. The initial setting depends on
8669 XEmacs (@code{t} for XEmacs with dbm).
8670 If non-nil, Message-ID is controlled by dbm.
8672 @item elmo-nntp-list-folders-use-cache
8673 @vindex elmo-nntp-list-folders-use-cache
8674 The initial setting is 600 (in seconds).
8675 This is period in seconds during which results of @samp{list} and
8676 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
8679 @item elmo-nntp-max-number-precedes-list-active
8680 @vindex elmo-nntp-max-number-precedes-list-active
8681 The initial setting is @code{nil}.
8682 If non-nil, the number of article obtained by @samp{list active} in NNTP
8683 are used as the maximum article number of the folder.
8684 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
8685 and if the number of read messages is not correct.
8687 @item elmo-nntp-default-use-listgroup
8688 @vindex elmo-nntp-default-use-listgroup
8689 The initial setting is @code{t}.
8690 If non-nil, @samp{listgroup} is used for checking the total number of
8691 articles. If it is @code{nil}, @samp{group} is used. In the latter
8692 case, the processing will be a little faster at the sacrifice of
8695 @item elmo-pop3-send-command-synchronously
8696 @vindex elmo-pop3-send-command-synchronously
8697 The initial setting is @code{nil}.
8698 If non-nil, POP3 commands are issued synchronously. Some implementation
8699 of POP3 server fails to get summary information without this setting.
8700 You may have to set this variable to @code{t}, if the process hangs
8701 while looking up POP3.
8703 @item elmo-dop-flush-confirm
8704 @vindex elmo-dop-flush-confirm
8705 The initial setting is @code{t}.
8706 If non-nil, you are asked for confirmation if accumulated off-line
8707 operations are executed.
8709 @item elmo-display-progress-threshold
8710 @vindex elmo-display-progress-threshold
8711 The initial setting is 20.
8712 Threshold for display of progress gauge. If number of renewal is more than
8713 this value, display progress gauge.
8717 @node Hooks, , Customizable Variables, Advanced Issues
8723 @node Migration, Terminology, Advanced Issues, Top
8724 @chapter Switch from older version of Wanderlust
8727 This chapter explains the important thing for the upgrade,
8728 or migration from the previous version.
8729 It includes the changes of the setup, limitations etc.
8732 * Before 2.12.0:: From prior to the version 2.12.0
8735 @node Before 2.12.0, , Migration, Migration
8736 @section Migration from prior to the version 2.12.0
8738 @subsection The conversion of msgdb
8740 From version 2.12.0 on, the structure of msgdb is changed.
8741 The msgdb for newly created folder will use this new format when created and saved.
8742 But by writing following line, you may use the old format of the msgdb as it was.
8746 (setq elmo-msgdb-default-type 'legacy)
8750 With the default setup, the old msgdb format is converted to the new
8751 format automatically. You may change this behavior by writing following
8752 lines in @file{~/.wl}.
8756 ;; @r{If the format of msgdb is different from} @code{elmo-msgdb-default-type},
8757 ;; @r{the format will be converted automatically when}
8758 ;; @r{the msgdb is being loaded (default).}
8759 (setq elmo-msgdb-convert-type 'auto)
8761 ;; @r{Convert msgdb when hitting @kbd{s all} in Summary mode}
8762 (setq elmo-msgdb-convert-type 'sync)
8764 ;; @r{Inhibit conversion}
8765 (setq elmo-msgdb-convert-type nil)
8769 As is explained in above section, you may continue to use the old format.
8770 But you will have following limitations.
8774 You cannot use forwarded mark (@samp{F}, @samp{f}).
8776 You may only use @samp{important} flag. The other global flags may not
8780 @subsection Changes from @samp{'mark} folder to @samp{'flag}.
8782 The folder @samp{'mark} will be automatically converted to @samp{'flag}
8783 folder when you first start the new version of Wanderlust.
8784 But there are some restrictions on this type of migrated folder.
8788 @samp{important} flag attached will not be
8789 removed by deleting the associated message in @samp{'flag} folder.
8792 The message won't be deleted by removing
8793 @samp{important} flag in @samp{'flag} folder.
8796 help-echo will not show you the old message.
8800 If you have problem with migrating
8801 from @samp{'mark} folder to the @samp{'flag} folder,
8803 @kbd{M-x elmo-global-mark-upgrade} will transfer the message
8804 from @samp{'mark} folder to the @samp{'flag} folder.
8805 The duplicated message will not be processed,
8806 you may issue that command repeatedly.
8809 @node Terminology, Mailing List, Migration, Top
8810 @chapter Terminology around Wanderlust
8813 Here we explain terminologies used in this manual.
8817 A container in which messages are stored.
8820 A set consists of some folders.
8823 A special group consists of automatically collected folders under
8824 some specified path.
8825 @xref{Folder Definition}.
8827 @item summary buffer
8828 A buffer for displaying list of messages in some folder.
8830 @item sticky summary
8831 Compared with ordinary summary buffer which will be destroyed after
8832 exiting from it, this type of summary will be remain even after exiting
8833 by @kbd{q} or @kbd{g}.
8834 @xref{Sticky Summary}.
8837 To delete or put into the archive expired messages.
8844 To cache messages beforehand in order to read messages after you will be
8845 disconnected from the server.
8849 @node Mailing List, Addition, Terminology, Top
8850 @chapter Wanderlust Mailing List
8854 Topics related to Wanderlust are discussed in following mailing lists.
8855 The latest version is also announced there.
8858 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
8861 In this list Japanese is mainly used for discussion. We also have a list
8862 for discussion in English:
8865 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
8867 (Messages posted to this list are also forwarded to the former one.)
8869 A guide can be obtained automatically by sending mail to
8870 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
8871 the English one) with the body
8877 Please send bug reports or patches to one of those lists. You can post to
8878 the mailing list even though you are not a member of it.
8880 If you send a bug report, please attach Backtrace with it.
8881 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
8884 I would like to express my thanks to the members of the mailing list for
8885 valuable advice and many pieces of code they contributed.
8889 You can read messages posted to the mailing list on the web or in
8892 Read messages posted to @t{<wl@@lists.airs.net>}
8895 @uref{http://lists.airs.net/wl/archive/}
8896 @uref{news://gmane.mail.wanderlust.general.japanese@@news.gmane.org}
8899 Read messages posted to @t{<wl-en@@lists.airs.net>}
8902 @uref{http://lists.airs.net/wl-en/archive/}
8903 @uref{news://gmane.mail.wanderlust.general@@news.gmane.org}
8907 @node Addition, Index, Mailing List, Top
8908 @chapter Additional Information
8910 @section Brief History
8913 1998 3/05 Tried to make a prototype that displays MH messages in threads.
8914 3/10 Made a msgdb mechanism by elisp.
8915 3/26 IMAP and NNTP can be displayed in threads.
8916 4/13 Began to assemble thread display modules as elmo.
8917 5/01 Finished 0.1.0, initial version with many defects.
8918 6/12 I made a slip of the tongue and said I was writing elisp
8919 mailer supporting IMAP
8920 6/16 0.1.3 was announced at tm-ja, elisp ML.
8921 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
8922 7/01 Support for mm-backend (0.3.0).
8923 8/25 multi folder added (0.5.0).
8924 8/28 filter folder added (0.5.1).
8925 9/10 You can open/close threads (0.6.0).
8926 9/11 fldmgr by Murata-san made editing folders easy.
8927 9/18 lha folders added by Okunishi-san (0.6.3).
8928 9/24 Display of branches of threads (0.6.5).
8929 9/28 Compression folder supporting multiple archivers by Okunishi-san.
8930 10/28 Off-line operations (0.7.4).
8931 12/09 Becomes beta version.
8932 12/21 wl-expire by Murata-san.
8933 1999 2/03 auto-refile by Tsumura-san.
8934 4/28 wl-template by Murata-san.
8935 5/18 Released 1.0.0 stable.
8936 7/05 Scoring by Murata-san (2.1.0).
8937 9/26 New plugged system by Murata-san (2.2.2).
8938 12/20 Support Modified UTF7.
8939 2000 3/24 Released 1.1.0 stable.
8940 4/03 CVS development started.
8941 5/07 Thread restoration & Its speed up with Murata-san.
8942 6/12 Address completion with LDAP with Chiba-san & Goto-san.
8943 7/11 killed message feature.
8944 7/18 Use UIDL in POP3.
8945 9/12 biff feature with Satata-san & Yamaoka-san.
8946 10/17 expire-hide by Okada-san.
8947 11/08 Released 2.4.0 stable.
8948 2001 7/04 Released 2.6.0 stable.
8949 8/21 wl-addrmgr by Kitamoto-san.
8950 12/27 Released 2.8.1 stable.
8951 2002 12/11 Released 2.10.0 stable.
8952 2003 7/05 Released 2.10.1 stable.
8953 9/18 flag folder is added.
8954 9/20 New msgdb format (modb-standard) by H.Murata-san.
8955 10/20 Spam filter by H.Murata-san.
8956 2004 1/06 Background color of the demo become configurable.
8957 2/09 'file' folder is added.
8958 9/12 forwarded mark.
8959 Default value of the mark strings are changed.
8962 See @file{ChangeLog} for details.
8966 According to a dictionary, Wanderlust has the meaning:
8970 n eager longing for or impulse towards travelling in distant lands
8971 [Ger, fr wandern to wander + lust desire, pleasure]
8975 but I had no profound intention. (if farfetched, IMAP @result{} you can
8976 read mail anywhere @result{} desire to wander ?)
8978 Elmo is the abbreviation of @samp{Elisp Library for Message
8979 Orchestration}. At first I meant the red puppet in the Sesame Street,
8980 but you may associate it with Wandering @result{} Drifting @result{}
8981 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
8985 Each versions has code names (they are almost jokes).
8986 Currently they are picked up alphabetically from the top 40 hits of
8987 U.S. Billboard magazines in 1980s.
8989 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
8992 @node Index, , Addition, Top
8996 * Concept Index:: Concept Index
8997 * Key Index:: Key Index
8998 * Variable Index:: Variable Index
8999 * Function Index:: Function Index
9002 @node Concept Index, Key Index, Index, Index
9003 @unnumberedsec Concept Index
9006 @node Key Index, Variable Index, Concept Index, Index
9007 @unnumberedsec Key Index
9010 @node Variable Index, Function Index, Key Index, Index
9011 @unnumberedsec Variable Index
9014 @node Function Index, , Variable Index, Index
9015 @unnumberedsec Function Index