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}, 14 types of folders are predefined. These
675 are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP,
676 Shimbun, Namazu, Multi, Filter, Pipe, Internal and File folder types.
679 * IMAP Folder:: @samp{%} -- IMAP folder
680 * NNTP Folder:: @samp{-} -- NNTP folder
681 * MH Folder:: @samp{+} -- MH folder
682 * Maildir Folder:: @samp{.} -- Maildir folder
683 * News Spool Folder:: @samp{=} -- News spool folder
684 * Archive Folder:: @samp{$} -- Archive folder
685 * POP Folder:: @samp{&} -- POP folder
686 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
687 * Namazu Folder:: @samp{[} -- Namazu Folder
688 * Multi Folder:: @samp{*} -- Multi folder
689 * Filter Folder:: @samp{/} -- Filter folder
690 * Pipe Folder:: @samp{|} -- Pipe folder
691 * Internal Folder:: @samp{'} -- Internal folder
692 * File Folder:: -- File folder
696 @node IMAP Folder, NNTP Folder, Folders, Folders
704 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
710 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
714 You can specify @code{login} (encoded password transmission),
715 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
716 authentication) or @code{clear} (or @code{nil}, plain password
717 transmission) as @var{authenticate-type}.
722 @var{username} -> The value of @code{elmo-imap4-default-user}.
723 Initial setting is @env{USER} environment variable or
724 @env{LOGNAME} environment variable or return value of
725 @code{(user-login-name)}.
726 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
727 Initial setting is "auth".
728 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
729 Initial setting is "localhost".
730 @var{port} -> The value of @code{elmo-imap4-default-port}.
731 Initial setting is 143.
734 You can omit the @var{hostname} from folder names if you set
735 @code{elmo-imap4-default-server} as your main IMAP server.
736 For example, you can specify a folder as @samp{foo%imap@@gateway} even
737 if you have to go through a firewall.
741 ;; @r{Example: imap4.exaple.org as main IMAP server}
742 (setq elmo-imap4-default-server "imap4.example.org")
746 SSL (Secure Socket Layer) connection will be used if a folder name ends
747 with @samp{!}. If a folder name ends with @samp{!!}, STARTTLS
748 connection will be established.
750 If the value of @code{elmo-imap4-default-stream-type} is @code{ssl},
751 SSL will be the default connection, i.e. you can omit @samp{!}. If it
752 is is @code{starttls}, STARTTLS will be the default connection. To use
753 normal connection in these cases, add @samp{!direct} at the end of
758 ;; @r{Example: Use SSL connection}
759 (setq elmo-imap4-default-stream-type 'ssl)
763 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
764 authentication method, the password is sent in encoded form. But, if
765 your server is unable to receive an encoded password, authentication
766 will fall back to @code{clear} (that is, sending password in raw format)
767 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
768 authentication will fall back to @code{clear} without confirmation
769 (default value is @code{nil}).
773 ;; @r{Example: password in raw format}
774 (setq elmo-imap4-default-authenticate-type 'clear)
782 %inbox -> IMAP mailbox "inbox"
783 %#mh/inbox -> IMAP mailbox "#mh/inbox"
785 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
786 %inbox:hoge/clear@@server1
787 -> server1's IMAP mailbox "inbox"
788 of user "hoge", with plain password authentication
793 @subsection International mailbox names (Modified UTF7)
794 @cindex Modified UTF7
801 You can use international mailbox names in @var{mailbox} part, if you
802 are using Emacs with UTF-7 support and
803 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
804 value is @code{nil}).
806 Currently, Mule-UCS package is required to use UTF-7.
807 Mule-UCS works on following Emacsen.
810 @item Emacs 20.3 or later
811 @item XEmacs 21.2.37 or later
814 You can obtain Mule-UCS package from following URL.
817 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
820 @node NNTP Folder, MH Folder, IMAP Folder, Folders
831 A folder to access USENET news via NNTP protocol (RFC 977).
832 One newsgroup is treated as a folder.
838 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
844 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
845 Initial setting is @samp{localhost}.
846 @var{username} -> The value of @code{elmo-nntp-default-user}.
847 Initial setting is @code{nil}.
848 @var{port} -> The value of @code{elmo-nntp-default-port}.
849 Initial setting is 119.
852 AUTHINFO is used as authentication method if the @var{username} is
853 non-nil. SSL connection will be used if a folder name ends with @samp{!}.
854 If a folder name ends with @samp{!!}, STARTTLS connection will be
857 If the value of @code{elmo-nntp-default-stream-type} is @code{ssl},
858 SSL will be the default connection, i.e. you can omit @samp{!}. If it
859 is is @code{starttls}, STARTTLS will be the default connection. To use
860 normal connection in these cases, add @samp{!direct} at the end of
867 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
868 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
873 @node MH Folder, Maildir Folder, NNTP Folder, Folders
880 A folder to access MH format mail (1 file is 1 mail).
885 @samp{+} @var{directory-name}
888 Normally, @var{directory-name} is an relative path to the variable
889 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
890 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
891 (this is also true for drive-letters).
893 Message number is used for the name of the message file.
899 +inbox -> @file{~/Mail/inbox}
900 +from/teranisi -> @file{~/Mail/from/teranisi}
901 +~/test -> @file{~/test}
906 @node Maildir Folder, News Spool Folder, MH Folder, Folders
907 @section Maildir Folder
909 @cindex Maildir Folder
913 A folder to access Maildir format (1 file is 1 mail).
918 @samp{.} [@var{directory-name}]
921 Normally, @var{directory-name} is a relative path to the variable
922 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
923 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
924 (this is also true for drive-letters).
926 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
927 Messages are contained in the @file{cur} directory. All message files
928 in the @file{new} directory are moved to @file{cur} directory when you
929 access the folder. All message files contained in the @file{tmp}
930 directory and not accessed for 36 hours are deleted.
932 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
938 . -> @file{~/Maildir}
939 .inbox -> @file{~/Maildir/inbox}
940 .from/teranisi -> @file{~/Maildir/from/teranisi}
941 .~/test -> @file{~/test}
946 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
947 @section News Spool Folder
949 @cindex News spool Folder
952 This folder handles locally saved news articles which are proposed by
953 Mew/IM. You can also read articles directly from a spool-file which is
954 retrieved by an utility like @command{gnspool}.
959 @samp{=} @var{directory-name}
962 @var{directory-name} is a sub-directory to the directory defined by
963 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
964 You can use @samp{.} as directory delimiter as well as @samp{/}.
970 =fj/os/os2 -> @file{~/News/fj/os/os2}
971 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
976 @node Archive Folder, POP Folder, News Spool Folder, Folders
977 @section Archive Folder
979 @cindex Archive Folder
982 This method can handle archive files, which are compressed by utilities
983 such as Info-ZIP or LHA, as one folder.
989 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
993 @var{path-name} is the relative path from
994 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
995 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
996 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
997 also permitted under the environment of ange-ftp, efs.
999 The actual file name of the archive folder is
1000 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1001 under the @var{path-name}. If a file named @var{path-name} exists, it is
1002 treated as folder. The suffix is automatically decided for
1003 @var{archiver-type}.
1005 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1006 (Initial setting is @code{zip}) is referred.
1008 @var{prefix} specifies the internal directory structure of the archive.
1009 For example, if the ML server is fml, @file{msend.tar.gz} has a
1010 structure like @file{spool/1}, so you have to specify @samp{spool} as
1017 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1018 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1019 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1020 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1021 $ml;zip/ -> Access group consists of archive folders
1022 under @file{~/Mail/ml}
1027 * Archiver:: Supported Archivers
1028 * Archive Tips:: TIPS
1029 * Archive Vars:: Customization
1033 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1034 @subsection Supported Archives
1044 By default, following archives are supported.
1048 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1049 GNU TAR('tgz, 'tar) ;; read-only
1053 If your archiver can include multiple files in one archive, you have a
1054 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1055 of the candidate. TAR is supported read-only because it cannot delete
1056 file in the archive (@code{mv})).
1058 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1059 archiver of Wanderlust because they cannot include multiple
1060 files. Archivers that cannot extract files to standard output are also
1063 @subsection OS specific information about archiver.
1065 Behaviors of the following archivers are confirmed by further experiences.
1066 (@samp{*} mark means recommended archiver).
1069 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1070 LHA OS/2 version Rel.2.06b Feb 18, 1998
1071 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1072 *Zip 2.2 (November 3rd 1997).
1073 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1074 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1075 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1077 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1078 LHa for UNIX V 1.14c
1079 UnZip 5.32 of 3 November 1997
1080 Zip 2.2 (November 3rd 1997)
1081 GNU tar 1.12 (1.11.x is no good)
1082 gzip 1.2.4 (18 Aug 93)
1084 [Win32] Win.98/Meadow
1088 GNU tar 1.11.8 + 1.5(WIN32)
1095 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1096 Hiramatsu version of LHA is only supported.
1097 In Win32, LHa32 is only supported (DOS version is no good).
1099 * Caution about GNU tar
1101 You have to take care about GNU tar's version because many version has
1102 problem on deleting file from archive.
1104 Please test @option{--delete} @option{-f} options work. Otherwise, your
1105 archive will be destroyed. No problem is reported on above versions of
1109 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1111 @cindex Archive Tips
1113 For comfortable migration, usage of @code{wl-summary-archive}
1114 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1115 archive folders created by expiration, you must set non-nil value to
1116 @code{elmo-archive-treat-file}.
1118 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1119 in processing speed. For comfortable use, Emacs20 is recommended.
1120 (If re-search's performance is the problem, 19.3x or later may be okay.)
1122 If many files are included in one archive,
1123 it takes long time to access the archive folder because
1124 archiver starting overhead is increased (especially LHA).
1125 150-200 messages in one archive is recommended.
1127 Of course, following is possible @t{:-)}
1128 (meanings of these variables are described later.)
1132 (setq wl-fcc "$backup")
1133 (setq wl-trash-folder "$trash;lha")
1137 @node Archive Vars, , Archive Tips, Archive Folder
1138 @subsection Variables About Archive Folder
1139 @cindex Archive variables
1142 @item elmo-archive-default-type
1143 @vindex elmo-archive-default-type
1144 The initial setting is @code{zip}.
1145 Set archiver type by symbol.
1147 @item elmo-archive-@var{type}-method-alist
1148 @vindex elmo-archive-TYPE-method-alist
1149 Define archiver @var{type}'s methods.
1150 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1151 Each element of the alist is following.
1155 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1156 (@var{action} . @var{function}) ;; function
1160 Currently available actions are following.
1164 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1165 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1172 actions enclosed with braces are optional (They are used for better
1175 @item elmo-archive-suffix-alist
1176 @vindex elmo-archive-suffix-alist
1177 An alist of archiver-type (symbol) and suffix.
1179 @item elmo-archive-file-regexp-alist
1180 @vindex elmo-archive-file-regexp-alist
1181 An alist of a regexp to get file number from list output of archiver
1182 and archiver-type (symbol).
1184 @item elmo-archive-method-list
1185 @vindex elmo-archive-method-list
1186 A list of elmo-archive-@var{type}-method-alist
1187 (@var{type} is a symbol of archiver-type).
1189 @item elmo-archive-lha-dos-compatible
1190 @vindex elmo-archive-lha-dos-compatible
1191 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1192 DOS (Mr. Yoshizaki original) compatible.
1194 @item elmo-archive-cmdstr-max-length
1195 @vindex elmo-archive-cmdstr-max-length
1196 The initial setting is 8000.
1198 Max length of command line argument for external archiver program.
1199 Emacs does not have a limit of command line byte length, but some OS
1200 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1201 this limit because it calls external archiver program directly (not
1202 called via shell). For example, you cannot delete messages if archiver
1203 program must receive larger bytes of arguments to delete. OS/2 have a
1204 command line argument limit of 8190 bytes, so we defined default as 8000
1207 However, you don't have an influence of command line argument limit
1208 if the archiver has `actions' to receive target file information from
1209 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1213 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1221 A folder to access e-mails via POP3 protocol (RFC 1939).
1227 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1232 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1233 as @var{authenticate-type}.
1235 You can specify @samp{uidl} (use UIDL command for message numbering) or
1236 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1240 @var{username} -> The value of @code{elmo-pop3-default-user}.
1241 Initial setting is @env{USER} environment variable or
1242 @env{LOGNAME} environment variable or return value of
1243 @code{(user-login-name)}.
1244 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1245 Initial setting is @samp{user}.
1246 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1247 If t, use UIDL for numbering. Initial setting is t.
1248 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1249 Initial setting is @samp{localhost}.
1250 @var{port} -> The value of @code{elmo-pop3-default-port}.
1251 Initial setting is 110.
1258 &hoge@@localhost -> access localhost as user @samp{hoge}.
1259 &hoge@@popserver:109 -> access the server "popserver" on port 109
1260 as user @samp{hoge}.
1264 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1265 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1266 @file{utils/sasl/lisp/} or Emacs/W3 package
1267 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1270 If the last character of the folder name is @samp{!}, Wanderlust
1271 connects to the POP server via SSL (Secure Socket Layer). If a folder
1272 name ends with @samp{!!}, STARTTLS connection will be established.
1274 If the value of @code{elmo-pop3-default-stream-type} is @code{ssl},
1275 SSL will be the default connection, i.e. you can omit @samp{!}. If it
1276 is is @code{starttls}, STARTTLS will be the default connection. To use
1277 normal connection in these cases, add @samp{!direct} at the end of
1281 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1282 @section Shimbun Folder
1284 @cindex Shimbun Folder
1285 @cindex Folder, Shimbun
1290 A folder for watching "shimbun" (means "newspaper" in Japanese),
1291 news site and mailing list archives on WWW by using emacs-w3m
1292 (@uref{http://emacs-w3m.namazu.org/}).
1294 You should possess w3m and emacs-w3m to use this.
1300 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1304 Admissible values of @var{module-name} and @var{folder-name} are
1305 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1311 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1312 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1316 @subsection Variables About Shimbun Folder
1319 @item elmo-shimbun-update-overview-folder-list
1320 @vindex elmo-shimbun-update-overview-folder-list
1321 The initial setting is @code{all}. Specify a set of folders to update
1322 overview when messages are fetched. Specify @code{all} to update
1323 overview in all shimbun folders. You can specify a list of regular
1324 expressions of shimbun folder names to restrict affected folders.
1329 (setq elmo-shimbun-update-overview-folder-list
1330 '("^@@airs\\." "^@@namazu\\."))
1333 @kbd{s rescan} is needed after fetching to update summary view.
1337 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1338 @section Namazu Folder
1340 @cindex Namazu Folder
1341 @cindex Folder, Namazu
1342 @cindex Folder, Text Search
1345 A folder to access messages found in namazu-index with some condition.
1346 It uses namazu (@uref{http://www.namazu.org/}) for search.
1352 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1356 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1362 [wanderlust] -> search messages matched with
1363 "wanderlust" from the default index
1364 [semi flim]~/Mail/semi -> search "semi flim" from the index
1365 in the directory "~/Mail/semi"
1371 @subsubsection Enter space to separate keywords
1373 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1375 @subsubsection Alias name for index
1377 You can define an alias name for index.
1382 (setq elmo-nmz-index-alias-alist
1383 '(("cache" . "~/.elmo/cache")
1384 ("docs" . "~/documents")))
1387 Above definition defines two index aliases.
1394 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1395 directory @file{~/.elmo/cache}.
1397 @subsubsection Multiple indices
1399 You can specify a list for @code{elmo-nmz-default-index-path} and
1400 @code{elmo-nmz-index-alias-alist}.
1401 When list is specified, all index contained in the list is used as the
1407 (setq elmo-nmz-index-alias-alist
1408 '(("all" . ("~/.elmo/cache" "~/documents"))
1409 ("cache" . "~/.elmo/cache")))
1412 Using above alias setting, you can specify
1418 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1419 directory @file{~/.elmo/cache} and @file{~/documents}.
1421 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1422 @section Multi Folder
1424 @cindex Multi Folder
1425 @cindex Folder, Multiple
1426 @cindex Folder, Marge
1428 A folder to access virtual folder which collects messages from
1435 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1439 After @samp{*} character, specify multiple folders you want to collect
1440 separated by @samp{,} like
1441 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1447 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1448 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1449 treated as one folder.
1451 *+inbox,-fj.rec.tv,%inbox
1452 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1457 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1458 @section Filter Folder
1460 @cindex Filter Folder
1461 @cindex Folder, Filtering
1462 @cindex Folder, Virtual
1463 @cindex Folder, Conditional
1466 A folder to access virtual folder which collects all messages that
1467 satisfy a condition.
1472 @samp{/} @var{condition} @samp{/} @var{target-folder}
1475 In the @var{condition} part, you can specify following.
1479 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1481 first: @var{number} messages are picked from top of folder.
1482 last: @var{number} messages are picked from bottom of folder.
1488 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1489 /first:20/%inbox -> First 20 messages from %inbox are picked.
1494 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1496 since: only messages arrived since @var{date} are picked.
1497 before: only messages arrived before @var{date} are picked.
1499 You can specify following as @var{date}.
1503 yesterday -> a day before today.
1504 lastweek -> same day of last week.
1505 lastmonth -> same day of last month.
1506 lastyear -> same day of last year.
1507 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1508 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1516 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1518 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1524 Field filter: @samp{@var{field}:@var{value}}
1526 All messages that have @var{field} and its value is @var{value} are picked.
1527 @var{field} and @var{value} are case insensitive.
1533 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1534 and its value includes "teranisi" string are picked.
1535 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1541 Flag filter: @samp{flag:@var{flag-name}}
1543 Pick up messages with flag specified by @var{flag-name}.
1545 You can specify following flag names:
1550 important -> important
1552 forwarded -> forwarded
1553 digest -> unread or important
1554 any -> unread or replied or forwarded or global-flag.
1558 You can also use flags which you have set as `global-flag'. global-flag
1559 is a flag which has arbitrary name. You can put global-flag on messages
1560 by invoking @code{wl-summary-set-flags} (Key @key{F}). By default,
1561 @samp{important} flag is prepared. You can view messages with
1562 global-flag by visiting the subfolder of @samp{'flag} folder.
1564 @xref{Internal Folder}.
1570 /flag:digest/%inbox -> a folder consist of unread or important
1572 /flag:wl/+ML/Wanderlust -> a folder consist of messages with global flag
1573 wl in +ML/Wanderlust.
1580 A condition starting with @samp{!} indicates a negation.
1581 If you combine conditions by character @samp{|}, it is considered as OR condition.
1582 @samp{&} is considered as AND condition, likewise.
1583 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1585 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1586 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1592 /from:teranisi&!to:teranisi/+inbox
1593 -> In +inbox, messages are picked if the message's
1594 From: field includes "teranisi" and
1595 To: field doesn't include "teranisi".
1597 /tocc:"Yuuichi Teranishi"/+inbox
1598 -> In +inbox, messages are picked if the
1599 message's To: field or Cc: field includes
1600 "Yuuichi Teranishi".
1602 /(from:yt|from:teranisi)&subject:report/+inbox
1603 -> In +inbox, messages are picked if the message's
1604 From: field includes "yt" or "teranisi", and
1605 Subject includes "report".
1611 Tip for string description:
1613 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1614 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1615 should be escaped with @samp{\} in it). You can enclose the string with
1616 @samp{"} even it does not contain these characters.
1622 *%inbox,/from:teranisi/%inbox@@server
1623 -> Messages in %inbox or
1624 message is in the %inbox@@server folder and it's From field
1625 includes "teranisi" are collected.
1627 /last:100//to:teranisi/*+inbox,%inbox
1628 -> Latest 100 messages which is in the +inbox or %inbox folder
1629 and To: field matches "teranisi".
1631 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1632 -> Pick messages which have From: field and it includes "hogehoge"
1633 from latest 20 messages in the %#mh/inbox@@localhost
1634 and To: or Cc: field includes "teranisi".
1637 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1638 @section Pipe Folder
1642 @cindex Download Message
1643 @cindex Incorporate Message
1645 In the pipe folder, messages are automatically transferred from the source
1646 folder to destination folder.
1651 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1654 When you access the pipe folder, messages are automatically transferred
1655 from @var{source-folder} to @var{destination-folder}.
1656 It is convenient if you want to download messages to local disk via POP.
1657 For example, if you specify following
1660 |&username@@popserver|+inbox
1664 and access it, Wanderlust downloads messages from
1665 @samp{&username@@popserver} to @samp{+inbox} automatically.
1667 On the other hand, if you put @samp{|:} instead of second @samp{|},
1668 then messages are copied to the destination folder (not deleted from
1669 source-folder). At the next time you access that folder, copies new
1673 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1676 If you want to copy messages from POP server and view them, specify the
1680 |&username@@popserver|:+inbox
1683 where messages will be kept on the server.
1689 |%inbox|%myinbox -> Download %inbox to %myinbox.
1690 |*&user@@popserver1,&user@@popserver2|+inbox
1691 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1692 |-gnu.emacs.sources|:+sources
1693 -> Copy messages from -gnu.emacs.sources to +sources.
1697 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1699 @node Internal Folder, File Folder, Pipe Folder, Folders
1700 @section Internal folder
1702 @cindex Internal Folder
1703 @cindex Folder, @samp{$} mark
1706 @c @cindex Folder, Null
1708 A folder to access internal messages of Wanderlust.
1714 @samp{'flag} [@samp{/} @var{global-flag}]
1716 @samp{'cache/00} - @samp{'cache/1F}
1720 A folder named @samp{'flag} is a special virtual folder which collects
1721 messages which have @var{global-flag}.
1723 There is @samp{important} flag defined as @var{global-flag} by default.
1724 You can review important messages at once after you put important marks
1725 on the messages in the different folders. If @var{global-flag} is omitted,
1726 it is treated as @samp{important} flag is specified.
1728 In addition, in summary mode, to be described later, you can freely
1729 define global flags and put them on messages.
1730 @xref{Usage of Summary Mode}.
1732 In this folder, if you delete message, @var{global-flag} put on the
1733 message is removed. If you append messages to this folder, the message
1734 will have @var{global-flag}.
1737 A folder named @samp{'sendlog} is a virtual folder which collects
1738 cached messages which are recoded on @file{~/.elmo/sendlog}.
1739 It might be useful when you forgot to add cc for yourself.
1740 To use this, you should set @code{wl-draft-use-cache} to non-nil
1741 so that sent messages are cached.
1744 You can access cached messages fetched via network by accessing
1745 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1746 the name of the subdirectories of the cache directory
1747 (@file{~/.elmo/cache}).
1750 @node File Folder, , Internal Folder, Folders
1751 @section File folder
1754 File Folder gives the view for local file system.
1755 The one File Folder corresponds to the one directory.
1760 @samp{file:} @var{Path-of-the-directory}
1767 file:~/work -> @file{~/work}
1768 file:/etc -> @file{/etc}
1773 @node Folder, Summary, Folders, Top
1774 @chapter Folder mode
1777 After you start Wanderlust, folder mode is appeared firstly.
1778 It contains folder list you subscribed.
1779 You can select and edit folders in this mode.
1782 * Selecting Folder:: Select folder you want to read
1783 * Folder Manager:: Editing folders
1787 @node Selecting Folder, Folder Manager, Folder, Folder
1788 @section Selecting Folder
1789 @cindex Selecting Folder
1791 @subsection Usage (TIPS)
1793 @subsubsection Check new, unread number
1795 Folder mode looks like this.
1796 (In XEmacs, it looks much nicer @t{;-)})
1800 [-]Desktop:14186/35580/67263
1805 [-]Emacsen:0/34/4837
1806 Wanderlust ML:0/0/558
1809 XEmacs Beta:0/29/255
1820 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1824 @kbd{s} key on the folder line updates these numbers.
1825 It changes its color if it has many new messages.
1827 The whole folder mode is a folder group named @samp{Desktop}.
1828 Folder group open/close by return key.
1829 A operation to a folder group is treated as operations on the
1831 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1832 six children folders update its unread number status.
1834 @subsubsection Select Folder
1836 To enter summary mode of the folder, type return (or space) key on
1838 If the variable @code{wl-stay-folder-window} has non-nil value,
1839 summary window appears on the right of the folder mode window.
1841 @subsection Key bindings
1843 Folder mode's key binding (related to selecting folders) is following.
1848 @kindex @key{SPC} (Folder)
1849 @kindex @key{RET} (Folder)
1850 @findex wl-folder-jump-to-current-entity
1851 Enter to the summary mode of the folder at the current cursor point.
1852 With prefix argument, enter the sticky summary.
1853 If the cursor is on the top of folder group line,
1854 the folder group is opened or closed.
1855 When the cursor is on the access group and this command is called
1856 with prefix argument, folder children list is updated to the newest one.
1857 (Children list is updated recursively if the access folder has hierarchical
1859 (@code{wl-folder-jump-to-current-entity})
1862 @kindex M-@key{RET} (Folder)
1863 @findex wl-folder-update-recursive-current-entity
1864 Folder children list of the access group at the current cursor point
1865 is updated to the newest one.
1866 (Children list is updated recursively if the access folder has hierarchical
1868 (@code{wl-folder-update-recursive-current-entity})
1873 Create a new draft message.
1878 @findex wl-folder-write-current-folder
1879 If the current cursor point is on the NNTP folder, create a new draft
1880 message which already has @samp{Newsgroups:} field. If the current
1881 cursor point is on the folder for mailing list (refile destination),
1882 create a new draft message which already has @samp{To:} field with
1883 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1885 (@code{wl-folder-write-current-folder})
1888 @kindex C-c C-o (Folder)
1889 @findex wl-jump-to-draft-buffer
1890 Move to the draft buffer if available. If multiple draft buffer exists,
1891 moved to one after another. If prefix argument is specified, load draft
1892 folder's message to the draft buffer and jump to it.
1893 (@code{wl-jump-to-draft-buffer})
1897 @findex wl-folder-check-current-entity
1898 Update new and unread number information of the folder at the current
1900 (@code{wl-folder-check-current-entity})
1904 @findex wl-folder-sync-current-entity
1905 Update summary information of the folder at the current cursor point.
1906 (@code{wl-folder-sync-current-entity})
1909 @kindex r s (Folder)
1910 @findex wl-folder-check-region
1911 Update new and unread number information of the folders in the currently
1913 (@code{wl-folder-check-region})
1916 @kindex r S (Folder)
1917 @findex wl-folder-sync-region
1918 Update summary information of the folders in the currently selected region.
1919 (@code{wl-folder-sync-region})
1923 @findex wl-status-update
1924 Sync up address book status with @file{~/.addresses}'s content.
1925 (@code{wl-status-update})
1929 @findex wl-folder-prev-unread
1930 Jump cursor to the folder which have unread messages on the upward from
1931 current cursor point.
1932 (@code{wl-folder-prev-unread})
1936 @findex wl-folder-next-unread
1937 Jump cursor to the folder which have unread messages on the downward
1938 from current cursor point.
1939 (@code{wl-folder-next-unread})
1943 @findex wl-folder-prev-entity
1944 Move cursor to the folder on the previous line.
1945 (@code{wl-folder-prev-entity})
1949 @findex wl-folder-next-entity
1950 Move cursor to the folder on the next line.
1951 (@code{wl-folder-next-entity})
1955 @findex wl-folder-jump-folder
1956 Jump to the folder specified by the user input.
1957 (@code{wl-folder-jump-folder})
1961 @findex wl-folder-prefetch-current-entity
1962 Prefetch new messages of the folder at the current cursor point by
1963 @code{wl-summary-incorporate}.
1964 If the cursor is on the folder group, it is executed recursively.
1965 (@code{wl-folder-prefetch-current-entity})
1969 @findex wl-folder-mark-as-read-all-current-entity
1970 Mark all unread messages of the folder at the current cursor point as read.
1971 If the cursor is on the folder group, it is executed recursively.
1972 (@code{wl-folder-mark-as-read-all-current-entity})
1976 @findex wl-folder-goto-first-unread-folder
1977 Enter summary mode of the first unread folder.
1978 (@code{wl-folder-goto-first-unread-folder})
1982 @findex wl-folder-empty-trash
1984 (@code{wl-folder-empty-trash})
1988 @findex wl-folder-flush-queue
1990 (@code{wl-folder-flush-queue})
1994 @findex wl-folder-virtual
1995 Move to the virtual folder (filter folder) with the condition specified.
1996 (@code{wl-folder-virtual})
2000 @findex wl-folder-pick
2001 Search the folders with the condition specified.
2002 (@code{wl-folder-pick})
2006 @findex wl-folder-open-all-unread-folder
2007 All unread folder is opened.
2008 (@code{wl-folder-open-all-unread-folder})
2012 @findex wl-execute-temp-marks
2013 Execute marks in summary buffers. @xref{Sticky Summary}.
2014 (@code{wl-execute-temp-marks})
2018 @findex wl-folder-open-close
2019 Folder group is opened/closed.
2020 (@code{wl-folder-open-close})
2024 @findex wl-folder-open-all
2025 All folder group is opened.
2026 (@code{wl-folder-open-all})
2030 @findex wl-folder-close-all
2031 All folder group is closed.
2032 (@code{wl-folder-close-all})
2042 @findex wl-folder-suspend
2044 (@code{wl-folder-suspend})
2047 @kindex M-s (Folder)
2049 Save current folder status.
2053 @kindex M-t (Folder)
2054 @findex wl-toggle-plugged
2055 Toggle Wanderlust's offline/online status.
2056 (@code{wl-toggle-plugged})
2059 @kindex C-t (Folder)
2060 @findex wl-plugged-change
2061 Start Wanderlust's plug-status manager.
2062 (@code{wl-plugged-change})
2065 @subsection Customize variables
2068 @item wl-folders-file
2069 @vindex wl-folders-file
2070 The initial setting is @file{~/.folders}.
2071 Subscribed folders are described (saved) in this file.
2073 @item wl-folder-info-save
2074 @vindex wl-folder-info-save
2075 The initial setting is @code{t}. If non-nil, unread information is
2076 saved and used in the next Wanderlust session.
2078 @item wl-stay-folder-window
2079 @vindex wl-stay-folder-window
2080 The initial setting is @code{nil}.
2081 If non-nil, summary window is appeared on the right side of the folder buffer.
2083 @item wl-folder-window-width
2084 @vindex wl-folder-window-width
2085 The initial setting is 20.
2086 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
2088 @item wl-folder-use-frame
2089 @vindex wl-folder-use-frame
2090 The initial setting is @code{nil}.
2091 If non-nil, use new frame for the folder window.
2093 @item wl-folder-many-unsync-threshold
2094 @vindex wl-folder-many-unsync-threshold
2095 The initial setting is 70.
2096 If the number of unread messages is more than this value,
2097 folder color is changed.
2099 @item wl-highlight-folder-by-numbers
2100 @vindex wl-highlight-folder-by-numbers
2101 This option controls how to highlight each line in the folder buffer.
2102 The default value is @code{t}, highlighting with various colors based on
2103 the message numbers. If it is @code{nil}, highlighting with various
2104 colors based on the folder status. In addition, if it is a number
2105 (e.g. 1), highlighting will be done based on both the message numbers
2106 and the folder status.
2108 @item wl-folder-desktop-name
2109 @vindex wl-folder-desktop-name
2110 The initial setting is @samp{Desktop}.
2111 The name of top folder group.
2113 @item wl-folder-petname-alist
2114 @vindex wl-folder-petname-alist
2115 The initial setting is @code{nil}.
2116 An alist of folder's realname and its nickname.
2118 @item wl-folder-access-subscribe-alist
2119 @vindex wl-folder-access-subscribe-alist
2120 The initial setting is @code{nil}.
2122 Control automatic subscribing and unsubscribing of the children list
2128 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2132 If @var{subscribe-flag} is non-nil, folders which have name matched to
2133 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2134 already unsubscribed folder is not displayed even when the
2135 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2142 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2143 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2144 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2145 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2149 @item wl-folder-hierarchy-access-folders
2150 @vindex wl-folder-hierarchy-access-folders
2151 A list of regular expressions for access groups which creates children
2152 folder list hierarchically.
2154 For example, if you specify
2155 @code{wl-folder-hierarchy-access-folders} like following,
2159 (setq wl-folder-hierarchy-access-folders
2160 '("^-[^\\.]*$" "^-comp.unix$" "^-comp.unix.bsd$"))
2165 you obtain the access group hierarchy as follows.
2171 -fj.comp.announce:0/0/2
2172 -fj.comp.dev.cdrom:0/0/0
2174 [+]-japan:238/238/1688
2177 -comp.unix.admin:0/0/0
2178 -comp.unix.dos-under-unix:0/0/0
2179 -comp.unix.programmer:0/0/0
2180 [-]-comp.unix.bsd:0/0/23
2181 -comp.unix.bsd.freebsd.announce:0/0/0
2186 If you opened @samp{-} in this example, only the direct children is created
2187 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2188 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2189 is not created until the children access group is opened.
2193 @node Folder Manager, , Selecting Folder, Folder
2194 @section Editing Folders
2195 @cindex Folder Manager
2196 @cindex Folder, Edit
2197 @cindex Folder, Subscribe
2198 @cindex Folder, Unsubscribe
2200 As described before, subscribed folder list is saved in @file{~/.folders} file.
2201 But you don't have to edit @file{~/.folders} directly.
2202 You can append, delete, edit folders from folder mode.
2204 @subsection Usage (Tips)
2206 @subsubsection Append Folder
2208 @kbd{m a} appends new folder to your folder list. If you enter non-existent
2209 folder, it will ask you to create a new one.
2210 @kbd{m g} appends new folder group.
2211 To append new folder to this group, firstly open it,
2212 then execute append command in the next line.
2214 @subsubsection Edit Folder
2216 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2217 Thus, you can change folder position as if you were editing a normal file.
2219 @subsubsection Create Multi Folder.
2223 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2225 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2227 Type @kbd{m m}, then you can create multi folder.
2230 @subsubsection Delete Nickname, Filter
2232 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2233 minibuffer while appending.
2235 @subsubsection Append Folder to Empty Group
2237 To append new folder to the empty folder group
2238 (after you create folder group by typing @kbd{m g}),
2239 firstly open it, then execute append command in the next line.
2240 If it is closed, folder is appended on the same level with
2241 the folder group above. It is difficult to explain by words so try it.
2242 In other words, appended position depends on the
2243 open/close status of the upper one.
2245 @subsubsection Charset of the Folders File.
2247 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2249 @subsubsection Create Filter
2251 @kbd{m f} adds filter to the folder at the current cursor point. To
2252 create new filter folder and leave the current folder unchanged, copy it
2253 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2254 filter can be specified while appending filter. If you put
2255 ``''(@var{NULL}), filter is deleted.
2257 @subsubsection Sort Folders
2259 Sorting of the folders is executed by the function specified by
2260 @code{wl-fldmgr-sort-function}.
2261 The initial setting is @code{wl-fldmgr-sort-standard},
2262 which sorts alphabetically.
2263 Sorting affects only on the current folder group. It does not
2264 affect on the child groups.
2266 @subsubsection Hiding Folders in the Access Group
2268 Usually, access group displays all children folders, but you can set
2269 some folders hidden. Following operations are only available on access
2272 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2273 (subscribe/unsubscribe) of the folder at current cursor point. Against
2274 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2277 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2278 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2279 argument and if the argument has positive number, the unsubscribe it.
2280 If the prefix argument has negative value, folder becomes visible and if
2281 zero, folder visibility is toggled.
2283 The other commands, @code{wl-fldmgr-subscribe} and
2284 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2287 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2288 executed in the access group, they have a same effect with
2289 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2290 The difference is that cut commands deletes folders from the current
2293 @subsubsection Operations in the Access Group
2295 You can insert and delete folders in the access group like usual folder
2296 group. But insert and delete commands can be only available for the
2297 children folders of the access group and they only sets the subscribe
2298 status. In other words, insertion of the folder means subscribing,
2299 deletion means unsubscribing.
2300 @footnote{In the current implementation,
2301 it is faster to delete region than to unsubscribe region.}
2303 To update the access group when children folders are inserted or deleted
2304 by other way (other than Wanderlust),
2305 open the access group by typing @kbd{C-u @key{RET}}.
2306 @xref{Selecting Folder}.
2308 The order of children folders of access group is saved after
2309 insertion/deletion/sorting.
2310 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2311 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2312 newly created folders are inserted on the top of the access group.
2314 @subsection Key bindings
2315 @cindex Keybind, Folder Mode
2316 @cindex Keybind, Folder Buffer
2318 Key bindings on the folder mode related to folder editing are shown below.
2319 All bindings starts with @kbd{m}, and primary commands are binded to
2320 one stroke key binding.
2324 @kindex m a (Folder)
2325 @findex wl-fldmgr-add
2326 Add specified folder to your folder list . If you enter non-existent
2327 folder, create it after confirmation.
2328 (@code{wl-fldmgr-add})
2333 @kindex m g (Folder)
2334 @findex wl-fldmgr-make-group
2335 Create a folder group.
2336 (@code{wl-fldmgr-make-group})
2339 @kindex m A (Folder)
2340 @findex wl-fldmgr-make-access-group
2341 Create an access group.
2342 (@code{wl-fldmgr-make-access-group})
2345 @kindex m d (Folder)
2346 @findex wl-fldmgr-delete
2347 Delete folder itself and msgdb.
2348 If the folder itself cannot be deleted like NNTP folder,
2349 only msgdb is deleted.
2350 (@code{wl-fldmgr-delete})
2355 @kindex m R (Folder)
2356 @findex wl-fldmgr-rename
2357 Change the name of folder or folder group.
2358 msgdb's path is also changed.
2359 (@code{wl-fldmgr-rename})
2365 @findex wl-fldmgr-make-multi
2366 Create a multi folders in the cutlist (cut, copied folders).
2367 (@code{wl-fldmgr-make-multi})
2372 @kindex m f (Folder)
2373 @findex wl-fldmgr-make-filter
2374 Create a filter folder. (Put a filter on the folder).
2375 (@code{wl-fldmgr-make-filter})
2379 @kindex M-c (Folder)
2380 @kindex m c (Folder)
2381 @findex wl-fldmgr-copy
2382 Copy folder (it is not available on folder group).
2383 (@code{wl-fldmgr-copy})
2387 @kindex M-w (Folder)
2388 @kindex m W (Folder)
2389 @findex wl-fldmgr-copy-region
2390 Copy folders in the specified region.
2391 (@code{wl-fldmgr-copy-region})
2395 @kindex C-k (Folder)
2396 @kindex m k (Folder)
2397 @findex wl-fldmgr-cut
2398 Cut folder. Folder itself is not deleted.
2399 (@code{wl-fldmgr-cut})
2403 @kindex C-w (Folder)
2404 @kindex m C-w (Folder)
2405 @findex wl-fldmgr-cut-region
2406 Cut folders in the specified region.
2407 (@code{wl-fldmgr-cut-region})
2411 @kindex C-y (Folder)
2412 @kindex m y (Folder)
2413 @findex wl-fldmgr-yank
2414 Paste folders that are copied or cut (folders in the cut-list).
2415 (@code{wl-fldmgr-yank})
2418 @kindex m p (Folder)
2419 @findex wl-fldmgr-set-petname
2420 Put nickname on the folder.
2421 (@code{wl-fldmgr-set-petname})
2424 @kindex m q (Folder)
2425 @findex wl-fldmgr-clear-cut-entity-list
2426 Clear the cut-list. (cut, copied folder information is cleared,
2427 you cannot paste after this)
2428 (@code{wl-fldmgr-clear-cut-entity-list})
2431 @kindex m s (Folder)
2432 @findex wl-fldmgr-sort
2433 Sort folders in the current folder group.
2434 (@code{wl-fldmgr-sort})
2437 @kindex m C-s (Folder)
2438 @findex wl-fldmgr-save
2439 Save current folder view to the @file{wl-folders-file}.
2440 (@code{wl-fldmgr-save})
2443 [Following commands are only available on the access groups]
2449 @kindex m u (Folder)
2450 @findex wl-fldmgr-unsubscribe
2451 Set the visibility of folder (subscribe/unsubscribe).
2452 (@code{wl-fldmgr-unsubscribe})
2457 @kindex r u (Folder)
2458 @findex wl-fldmgr-unsubscribe-region
2459 Set the visibility of the folders (subscribe/unsubscribe) in the
2461 (@code{wl-fldmgr-unsubscribe-region})
2466 @kindex m l (Folder)
2467 @findex wl-fldmgr-access-display-normal
2468 List folders that are currently available.
2469 (@code{wl-fldmgr-access-display-normal})
2474 @kindex m L (Folder)
2475 @findex wl-fldmgr-access-display-all
2476 List all folders regardless of the subscription status.
2477 (@code{wl-fldmgr-access-display-all})
2481 @subsection Customize variables
2484 @item wl-interactive-save-folders
2485 @vindex wl-interactive-save-folders
2486 The initial setting is @code{t}. If non-nil and folder view is
2487 modified, confirm saving it before Wanderlust or Emacs exits. If
2488 @code{nil}, save without confirmation.
2490 @item wl-fldmgr-make-backup
2491 @vindex wl-fldmgr-make-backup
2492 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2493 created before saving the folder status.
2495 @item wl-fldmgr-sort-function
2496 @vindex wl-fldmgr-sort-function
2497 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2498 sort folders. By default function, folders are sorted alphabetically
2499 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2502 @item wl-fldmgr-sort-group-first
2503 @vindex wl-fldmgr-sort-group-first
2504 The initial setting is @code{t}. If non-nil,
2505 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2506 does not care whether it is folder group or not.
2508 @item wl-folder-check-async
2509 @vindex wl-folder-check-async
2510 The initial setting is @code{t}. If non-nil, check folder's unread
2511 status asynchronously. It boosts newsgroup checking.
2513 @item wl-folder-check-fast
2514 @vindex wl-folder-check-fast
2515 The initial setting is @code{nil}.
2516 If non-nil, it does not update folder status while checking.
2518 @item wl-folder-notify-deleted
2519 @vindex wl-folder-notify-deleted
2520 The initial setting is @code{nil}.
2522 If non-nil, negative value is displayed when the message is deleted. If
2523 @code{sync}, folder is synchronized when the message is deleted. If
2524 @code{nil}, message deletion is ignored.
2526 @item wl-fldmgr-add-complete-with-current-folder-list
2527 @vindex wl-fldmgr-add-complete-with-current-folder-list
2528 The initial setting is @code{nil}.
2529 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2530 candidate for @code{wl-fldmgr-add}.
2533 @subsection Miscellanea
2535 Following is a note for folder editing.
2539 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2540 paste(yank) command pastes the folders on one cut or copy command
2541 (If copy command is executed by region, folders in the region are pasted
2542 by one paste command)
2545 You cannot cut @samp{Desktop} group.
2546 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2549 You cannot copy folder group.
2552 Operations on the access group are only available for the folders
2553 in the same access group.
2556 You cannot create a folder which has same name with the folders already exist.
2559 You cannot insert folders which have same name in one group.
2560 You can insert them in the different groups.
2561 You cannot put same nickname to the different folders.
2565 @node Summary, Message, Folder, Top
2566 @chapter Summary Mode
2568 After you select the folder via folder mode, you enter to the summary
2572 * Usage of Summary Mode:: TIPS
2573 * Thread Operations:: Thread operations
2574 * Cache:: File cache, Buffer cache, and Prefetch
2575 * Auto Refile:: Auto refile settings
2576 * Sticky Summary:: Summary make sticky
2577 * Summary View:: Format of summary lines
2578 * Mark and Action:: Temporary marks and their effect
2579 * Key Bindings of Summary:: Key bindings
2580 * Variables of Summary:: Customize Summary Mode
2584 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2585 @section Usage (Tips)
2587 @subsection Summary Content
2589 In the summary mode, messages are displayed like following.
2593 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2594 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2595 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2596 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2603 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2607 If you want to know how to change the format for this, please refer
2608 the section format of Summary lines.
2609 @xref{Summary View}.
2611 @var{Message number} is the message's unique number in the folder. In
2612 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2613 in the MH folder, it is the filename of the message.
2615 @var{Temporal mark} and @var{Persistent mark} are described later.
2617 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2618 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2619 Japanese, but if you want to display it in English, set the value of
2620 @code{wl-summary-weekday-name-lang} as @samp{en}.
2622 @var{Sender}'s indentation corresponds to the depth of the thread.
2623 Sender name is displayed as nickname if it is defined in the address
2624 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2625 displaying with nickname.
2627 If number is printed at the head of @var{Sender} part like @samp{+2},
2628 that means the message have 2 follow messages.
2630 @var{Subject} is the @samp{Subject:} header field of the message. If
2631 the message have same @samp{Subject:} with the parent message, it is not
2632 displayed. Some mailing list puts its sequence number in the
2633 @samp{Subject:} field, but it is
2634 ignored. @code{wl-summary-no-subject-message} is displayed when the
2635 message has empty subject field.
2637 @subsection Temporary Marks
2638 @cindex Mark, Temporary
2640 There are four temporary marks,
2641 @samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}.
2642 Temporary marks indicates message operations.
2647 You can execute a command on the all messages that have @samp{*} mark,
2648 with the key bindings which begins with @kbd{m}.
2651 The mark to dispose. You can put @samp{d} by typing @kbd{d} key.
2654 The mark to force delete. You can put @samp{D} by typing @kbd{D} key.
2658 After you type @kbd{o} key, prompt appears to input refile destination.
2659 Your answer is printed in the summary line.
2663 You can put this mark by typing @kbd{O} key.
2664 The difference between this mark and refile mark is,
2665 this mark does not delete the message while latter does.
2668 The mark to prefetch reserved.
2669 You can put this mark by typing @kbd{i} key.
2672 The mark to resend reserved.
2673 After you type @kbd{~} key, prompt appears to input address to resend.
2674 Your answer is printed in the summary line.
2677 @kbd{x} key executes action for temporary marks, respectively.
2679 @subsection Persistent Marks
2681 There are five persistent marks, @samp{!}, @samp{N}, @samp{n}, @samp{U},
2682 @samp{u}, @samp{A}, @samp{a} and @samp{$}.
2684 The persistent mark indicates the message's status and it is saved.
2685 Each persistent mark indicates:
2691 It is new message. It differs from @samp{N} that message with @samp{n}
2694 It is unread message.
2696 It is unread message. It differs from @samp{U} that message with @samp{u}
2699 It is message already read. It differs from message without mark that
2700 message with @samp{!} is not cached yet.
2702 It is already replied message.
2704 It is already replied message. It differs from @samp{A} that message
2705 with @samp{u} is already cached.
2707 It is a message with some global flag. It is convenient to put this
2708 mark on the messages to remember (If you want to remember to write a
2709 reply for the message, for example) because this mark remains after
2710 you exited Emacs. Messages with the @samp{$} mark can be reviewed in
2711 the @samp{'flag} folder even the message itself is deleted in the actual
2712 folder. You can put global flag by typing @kbd{$} or @kbd{F} key.
2715 If the message is read and cached (or local message),there are no
2719 @samp{N}, @samp{U}, @samp{!}, @samp{A} indicates that the message have
2720 no cache. Messages with the marks other than these, you can read them
2721 in the offline status even they are in the IMAP folder or netnews
2724 Among messages with persistent marks, ones with marks specified by
2725 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2726 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2728 @subsection How To Read
2730 Basically, you can read messages only typing space key again and again.
2732 To update summary status to the newest status (synchronize),
2735 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2736 moves cursor to the next message.
2737 Enter message buffer by typing @kbd{j} key.
2738 To operate multipart, you have to enter to the message buffer.
2741 @subsection Pack the Message Numbers
2742 You can pack the message numbers in Summary by
2743 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2744 News Spool Folder and Maildir Folder are supported folder types.
2747 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2748 @section Thread Operations
2750 For example, the following line indicates one thread (a context of a topic).
2753 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2757 If you type @kbd{/} on this line, the thread is opened and it changes
2758 the appearance like following.
2762 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2763 388 09/17(Thu)22:34 +-[ Murata san ]
2767 (Message 388 is the replied message to the message 384.)
2768 If you type @kbd{/} key once again, the thread is closed.
2769 With prefix argument, @kbd{/} opens all children threads.
2771 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2774 Commands with the key binding that begins with @kbd{t} executes commands
2775 on the messages in the thread.
2776 @xref{Key Bindings of Summary}.
2778 @subsection reconstruct thread by hand
2780 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2781 (@code{wl-summary-save-current-message}) at the corresponding message,
2782 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2783 message then you have the reconstructed thread.
2786 @node Cache, Auto Refile, Thread Operations, Summary
2789 @subsection Cache File
2791 The messages which have to access via network (e.x. IMAP, NNTP folder)
2792 are cached as a local file so as to save network traffic or to enable
2793 off-line operation. The cache file is saved under the directory
2794 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2795 elmo-cache-expire-by-size}. The command deletes cache files to the
2796 specified size by the order of last accessed time.
2798 @subsection Buffer Cache and Prefetching
2800 The messages that are read are kept in the cache buffer so as to make
2801 the behavior fast when you are to read the message again. It is called
2802 `buffer cache'. The number of cache buffer is specified by
2803 @code{wl-message-buffer-cache-size}.
2805 There are message prefetching mechanism in the Wanderlust that
2806 prefetches next message while you are reading.
2808 You can control the message prefetching mechanism by these two
2812 @item wl-message-buffer-prefetch-folder-type-list
2813 @vindex wl-message-buffer-prefetch-folder-type-list
2814 The initial setting is @code{t}. In this case, prefetch messages in all
2816 If it is a list of folder types, it specifies the folder types in which
2817 message prefetching is enabled.
2818 Following is an example (prefetch messages in nntp and imap4 folders)
2822 (setq wl-message-buffer-prefetch-folder-type-list
2827 In this case, multi folder that contains localdir and imap4 prefetches
2828 only imap4 messages. This variable precedes the value of
2829 @code{wl-message-buffer-prefetch-folder-list}.
2831 @item wl-message-buffer-prefetch-folder-list
2832 @vindex wl-message-buffer-prefetch-folder-list
2833 The initial setting is @code{nil}.
2834 A list of regexp of folders to enable message prefetching.
2836 @item wl-message-buffer-prefetch-depth
2837 @vindex wl-message-buffer-prefetch-depth
2838 The initial setting is 3. The number of messages for automatical prefetch.
2840 @item wl-message-buffer-prefetch-idle-time
2841 @vindex wl-message-buffer-prefetch-idle-time
2842 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2844 @item wl-message-buffer-prefetch-threshold
2845 @vindex wl-message-buffer-prefetch-threshold
2846 The initial setting is 30000 (bytes). If prefetching message has larger
2847 size than this value, Wanderlust does not prefetch automatically.
2848 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2849 the message is not checked for the size.
2851 @item wl-auto-prefetch-first
2852 @vindex wl-auto-prefetch-first
2853 The initial setting is @code{nil}.
2854 If non-nil, first message is automatically prefetched to the buffer
2855 when you enter the folder.
2859 @node Auto Refile, Sticky Summary, Cache, Summary
2860 @section Auto Refile
2861 @vindex elmo-msgdb-extra-fields
2862 @vindex wl-refile-rule-alist
2863 @findex wl-summary-auto-refile
2865 You can refile messages automatically, by typing @kbd{C-o}
2866 (@code{wl-summary-auto-refile}). It decides destination of refile by
2867 the content of the message header information (information in the msgdb).
2869 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2870 available. If you want to decide destination by other header fields,
2871 set the variable @code{elmo-msgdb-extra-fields} like following.
2875 (setq elmo-msgdb-extra-fields
2885 By this setting, Wanderlust saves extra fields in the msgdb. You have
2886 to type @kbd{s all} to get extra fields for the messages that are
2887 already exists in the summary.
2889 Then, specify the refile rule. The refile target folder of auto
2890 refiling is decided by the value of @code{wl-refile-rule-alist}.
2891 @code{wl-refile-rule-alist} is a list of a rule:
2895 (@var{field} (@var{regexp} . @var{target})
2896 (@var{regexp} . @var{target})
2901 Each rule means `if @var{field} value matches @var{regexp},
2902 then refile to @var{target} folder'.
2903 The rule matched first is applied.
2905 @var{field} is a string of field name. You can specify a list of field name
2906 string, too. In this case, if one of these fields is matched, then the
2907 rule is fired (i.e. OR condition).
2909 @var{regexp} is a regular expression for field value. @var{target} is a target
2910 folder string. You can specify a rule at @var{target} part, too. In this
2911 case, If the field value of the rule and the current rule is matched,
2912 then the current rule is fired (i.e. AND condition).
2914 You can refer matched substring of @var{regexp} to specify @var{target} part.
2915 To refer substring, use following keys:
2919 means substitute original matched text.
2922 means substitute what matched the @var{N}th `\(@dots{}\)'.
2923 (@var{N} is a number.)
2926 Following is an example of @code{wl-refile-rule-alist}.
2930 (setq wl-refile-rule-alist
2932 ("^Wanderlust" . "+wl")
2933 ("^Elisp" . "+elisp"))
2935 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2937 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2938 "+from-me-to-you"))))))
2942 After these settings, refile marks are automatically put on the condition
2943 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2945 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2947 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2948 with these persistent marks are not automatically refiled.
2949 It means Wanderlust does not execute auto refile on unread messages by
2950 the default setting.
2951 To execute auto refile on all messages, set following.
2954 (setq wl-summary-auto-refile-skip-marks nil)
2958 @node Sticky Summary, Summary View, Auto Refile, Summary
2959 @section Sticky Summary
2960 @cindex Summary, Sticky
2961 @cindex Sticky Summary
2963 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2965 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2966 @kbd{G} in some suummary sticky summary buffer is created.
2967 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2968 makes current one sticky.
2970 The buffer name of the sticky summary becomes like
2971 @samp{Summary:@var{folder-name}}.
2972 You can visit the sticky summary at any time by @kbd{C-x b}
2973 (@code{switch-to-buffer}), or you can go round summary buffers by
2974 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2975 (@code{wl-summary-next-buffer}) in summary mode.
2977 In sticky summary, the summary buffer is preserved after @kbd{g} or
2978 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2979 another summary by @kbd{C-u g}. Other operations in the sticky summary
2980 are same as normal summary.
2982 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2983 are automatically stuck.
2986 @node Summary View, Mark and Action, Sticky Summary, Summary
2987 @section Format of summary lines
2988 @cindex Format of summary lines
2989 You can alter the format of lines in Summary mode.
2991 Summary line format is specified by @code{wl-summary-line-format}.
2992 You can use control strings defined by
2993 @code{wl-summary-line-format-spec-alist}.
2999 ;; @r{number temporary-mark persistent-mark date branch}
3000 ;; @r{[ (number-of-children) sender ] subject}
3001 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
3005 Where the number set the column number of the field (for negative value,
3008 Major control strings defined by @code{wl-summary-line-format-spec-alist}
3009 are displayed in the following list.
3020 %t branch of the thread
3021 %[ [ (< for re-connected child)
3022 %] ] (> for re-connected child)
3026 %c +number-of-children: (display only for opened thread)
3027 %C [+number-of-children] (display only for opened thread)
3028 %T temporary mark (mandatory)
3029 %P persistent mark (mandatory)
3033 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
3034 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
3035 the constant column. For example, if you specify @samp{%T} or
3036 @samp{%P} after the @samp{%t}, which changes its length by thread
3037 position, marks are not treated correctly.
3039 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
3040 column of the enclosed region is justified to the `number'. Multiple
3041 level @samp{%number(} parenthesis can be defined. It is useful to
3042 justify the column of the multiple control strings. For example, in the
3043 above @code{wl-summary-line-format},
3049 means ``Adjust number-of-children and sender string to the 17 column''.
3051 You can specify the format by each folders with
3052 @code{wl-folder-summary-line-format-alist}. Please set regular
3053 expression for folder names and summary line format as the following
3058 (setq wl-folder-summary-line-format-alist
3059 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
3060 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
3064 @subsection on the format for sender name
3066 The format string @samp{%f} displays the return value of the function specified
3067 by @code{wl-summary-from-function}. If you use the function
3068 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
3069 while displays the recipient names if the folder name matches with
3070 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
3071 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
3073 For example, to display recipient names for the message in @samp{+backup} if
3074 its sender is yourself, set up as follows.
3077 (setq wl-summary-showto-folder-regexp "^\\+backup$")
3081 @node Mark and Action, Key Bindings of Summary, Summary View, Summary
3082 @section Temporary marks and their effect
3083 @cindex Mark and Action
3085 You can define temporary marks and corresponding procedure by
3086 @code{wl-summary-mark-action-list}. Initially, refile (@samp{o}), copy
3087 (@samp{O}), dispose (@samp{d}), delete (@samp{D}), prefetch (@samp{i})
3088 and resend (@samp{~}) are defined.
3090 Each element of @code{wl-summary-mark-action-list} consists of
3093 (@samp{MARK} @samp{SYMBOL}
3094 @samp{ARGUMENT-FUNCTION} @samp{SET-MARK-FUNCTION} @samp{EXEC-FUNCTION}
3095 @samp{FACE} @samp{DOC-STRING})
3098 @samp{MARK} is a temporary mark string, and @samp{SYMBOL} is the name of
3099 the action to be defined. @samp{ARGUMENT-FUNCTION} is a function to
3100 generate argument to be given to @samp{SET-MARK-FUNCTION}, which will be
3101 described next, and it takes arguments:
3104 (@samp{ACTION} @samp{NUMBER})
3107 Where @samp{ACTION} equals to @samp{SYMBOL}, and @samp{NUMBER} is message
3108 number. @samp{SET-MARK-FUNCTION} is a function to be called when the mark
3109 is put. It takes arguments:
3112 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3115 Where @samp{NUMBER} is target message number, @samp{MARK} is a temporary
3116 mark string, and @samp{DATA} is given by @samp{ARGUMENT-FUNCTION}.
3118 @samp{EXEC-FUNCTION} is a function to be called when the action is
3119 executed. Its argument is a list of @samp{MARK-INFO}. Here @samp{MARK-INFO}
3120 means a list consists of
3123 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3126 @samp{FACE} is a face to be used for highlighting.
3129 @node Key Bindings of Summary, Variables of Summary, Mark and Action, Summary
3130 @section Key bindings
3131 @cindex Keybind, Summary Mode
3132 @cindex Keybind, Summary Buffer
3134 Key bindings of the summary mode are shown below.
3138 @kindex @key{SPC} (Summary)
3139 @findex wl-summary-read
3140 Proceed reading a message at the current cursor point.
3141 (@code{wl-summary-read})
3145 @findex wl-summary-redisplay
3146 Redisplay a message at the current cursor point with default display
3147 type. If this command is called with prefix argument, reload and redisplay
3148 message regardless of the message cache.
3149 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u .},
3150 reload and redisplay message with current display type regardless of the
3151 message cache. (@code{wl-summary-redisplay})
3155 @findex wl-summary-display-top
3156 Display the top message in the folder.
3157 (@code{wl-summary-display-top})
3161 @findex wl-summary-display-bottom
3162 Display the bottom message in the folder.
3163 (@code{wl-summary-display-bottom})
3167 @kindex @key{BS} (Summary)
3168 @kindex @key{DEL} (Summary)
3169 Display the previous page of the message at the current cursor point.
3170 @findex wl-summary-prev-page
3171 (@code{wl-summary-prev-page})
3174 @kindex @key{RET} (Summary)
3175 @findex wl-summary-next-line-content
3176 Display the next line of the message at the current cursor point.
3177 Display the message at the current cursor point if it is not displayed yet.
3178 (@code{wl-summary-next-line-content})
3183 @kindex M-@key{RET} (Summary)
3184 @findex wl-summary-prev-line-content
3185 Display the previous line of the message at the current cursor point.
3186 Display the message at the current cursor point if it is not displayed yet.
3187 (@code{wl-summary-prev-line-content})
3191 @findex wl-thread-open-close
3192 Toggle open or close the thread at the current cursor point.
3193 With prefix argument, open all children threads.
3194 (@code{wl-thread-open-close})
3199 @findex wl-thread-open-all
3200 (@code{wl-thread-open-all})
3205 @findex wl-thread-close-all
3206 (@code{wl-thread-close-all})
3210 @findex wl-summary-goto-folder
3212 (@code{wl-summary-goto-folder})
3216 Mark all messages in the folder as read.
3217 @findex wl-summary-mark-as-read-all
3218 (@code{wl-summary-mark-as-read-all})
3222 @findex wl-summary-reply
3223 Prepare a draft for reply the message at the current cursor point.
3224 (@code{wl-summary-reply})
3228 @findex wl-summary-reply-with-citation
3229 Prepare a draft for reply the message at the current cursor point.
3230 (@code{wl-summary-reply-with-citation})
3234 @findex wl-summary-cancel-message
3235 If the message at current cursor point is your own netnews article,
3237 (@code{wl-summary-cancel-message})
3241 @findex wl-summary-reedit
3242 Prepare a draft for re-editing the message at current cursor point.
3243 If the message at current cursor point is your own netnews article,
3244 a draft for `supersedes message' for the message is prepared.
3245 (@code{wl-summary-reedit})
3248 @kindex M-E (Summary)
3249 @findex wl-summary-resend-bounced-mail
3250 If the message at current cursor point is a bounced message,
3251 a draft for re-sending original message is prepared.
3252 (@code{wl-summary-resend-bounced-mail})
3256 @findex wl-summary-forward
3257 A draft for forwarding the message at current cursor point is prepared.
3258 (@code{wl-summary-forward})
3262 @findex wl-summary-mark-as-important
3263 Put @samp{important} flag on the message at current cursor point.
3264 If already flagged as @samp{important}, remove the flag. If it is
3265 called with prefix argument, ask global flag to put similarly to @kbd{F}.
3266 (@code{wl-summary-mark-as-important})
3270 @findex wl-summary-set-flags
3271 Put arbitrary global flag entered in the minibuffer. If you use Emacs
3272 21 or later, you can specify multiple flags separated by @samp{,}
3273 simultaneously. If it is called with prefix argument, remove existent
3275 (@code{wl-summary-set-flags})
3281 Save the message at current cursor point.
3282 @findex wl-summary-save
3283 (@code{wl-summary-save})
3287 @findex wl-summary-next
3288 Move cursor to the next message.
3289 If message is marked with a temporal mark in
3290 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3291 In the offline mode, cursor is not moved to the messages which are not cached
3293 (@code{wl-summary-next})
3297 @findex wl-summary-prev
3298 Move cursor to the previous message.
3299 If message is marked with a temporal mark in
3300 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3301 In the offline mode, cursor is not moved to the messages which are not cached
3303 (@code{wl-summary-prev})
3307 @findex wl-summary-down
3308 Move cursor to the downward message which is unread or marked
3310 In the offline mode, cursor is not moved to the messages which are not cached
3312 If there are messages which have target mark @samp{*} in the summary,
3313 cursor is moved to the downward message which have a target mark.
3314 This behavior is changed according to the value of @code{wl-summary-move-order}.
3315 (@code{wl-summary-down})
3319 @findex wl-summary-up
3320 Move cursor to the upward message which is unread or marked
3322 In the offline mode, cursor is not moved to the messages which are not cached
3324 If there are messages which have target mark @samp{*} in the summary,
3325 cursor is moved to the downward message which have a target mark.
3326 This behavior is changed according to the value of @code{wl-summary-move-order}.
3327 (@code{wl-summary-up})
3331 @findex wl-summary-write
3332 Prepare a new draft.
3333 (@code{wl-summary-write})
3337 @findex wl-summary-write-current-folder
3338 Prepare a new draft. If the current folder is NNTP folder,
3339 @samp{Newsgroups:} field is completed. If the current folder is mailing
3340 list folder (refile destination), guess @samp{To:} field and completed
3341 (If @code{wl-subscribed-mailing-list} is valid list)
3342 (@code{wl-summary-write-current-folder})
3346 @findex wl-summary-toggle-all-header
3347 Toggle display type between all and partial header fields and redisplay
3348 the message at current cursor point. If this command is called with
3349 prefix argument, reload and redisplay message regardless of the message cache.
3350 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u H},
3351 set default display type of summary by current display type of header fields.
3352 (@code{wl-summary-toggle-all-header})
3356 @findex wl-summary-toggle-mime
3357 Toggle display type for MIME analysis and redisplay the message at
3358 current cursor point. A change is performed in the order set as
3359 @code{wl-summary-display-mime-mode-list}. If this command is called
3360 with numeric prefix argument, it switch directly as follows.
3364 1: Enable MIME analysis.
3365 2: Enable MIME analysis only for header fields.
3366 3: Disable MIME analysis.
3370 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u
3371 M}, set default display type of summary by current display type of MIME
3372 analysis. (@code{wl-summary-toggle-mime})
3375 @kindex C-c C-f (Summary)
3376 @findex wl-summary-toggle-header-narrowing
3377 Toggle header body narrowing of the message at current cursor point.
3378 (@code{wl-summary-toggle-header-narrowing})
3382 @findex wl-summary-burst
3383 If the message at current cursor point has
3384 encapsulates multiple messages using MIME,
3385 de-capsulate and extract them on the current folder.
3386 If it is invoked in non-writable folder or it is called with prefix
3387 argument, it asks the destination folder.
3388 (@code{wl-summary-burst})
3391 @kindex @@ (Summary)
3392 @findex wl-summary-edit-addresses
3393 Append/change/delete the message's sender information to the address
3394 book @file{~/.addresses} interactively. If this command is called with
3395 prefix argument, arbitrary address can be edited.
3396 (@code{wl-summary-edit-petname})
3400 @findex wl-status-update
3401 Sync up address book status with @file{~/.addresses}'s content.
3402 (@code{wl-status-update})
3406 @findex wl-summary-pipe-message
3407 Pipe current message's content to the external process.
3408 (@code{wl-summary-pipe-message})
3412 @findex wl-summary-print-message
3413 Print out current message's content.
3414 It uses @code{ps-print} module in Emacs 20.x.
3415 If you don't use color printer, you might want to set
3416 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3419 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3422 (@code{wl-summary-print-message})
3426 @findex wl-summary-exit
3427 Exit current folder.
3428 (@code{wl-summary-exit})
3432 @findex wl-summary-jump-to-current-message
3433 Jump cursor to the currently displayed message's window.
3434 (@code{wl-summary-jump-to-current-message})
3438 Jump cursor to the other message.
3439 @findex wl-summary-jump-to-msg
3440 (@code{wl-summary-jump-to-msg})
3444 Update summary status and
3445 prefetch all messages which have marks included in the
3446 @code{wl-summary-incorporate-marks}.
3447 @findex wl-summary-incorporate
3448 (@code{wl-summary-incorporate})
3451 @kindex M-j (Summary)
3452 @findex wl-summary-jump-to-msg-by-message-id
3453 Jump cursor to the message which have specified @samp{Message-Id:}. If
3454 @code{elmo-use-database} is non-nil, other folder is also searched.
3455 (@code{wl-summary-jump-to-msg-by-message-id})
3459 Jump to parent message.
3460 @findex wl-summary-jump-to-parent-message
3461 (@code{wl-summary-jump-to-parent-message})
3465 @findex wl-summary-mark-as-unread
3466 Mark as unread the message at current cursor point.
3467 (@code{wl-summary-mark-as-unread})
3471 @findex wl-summary-sync
3472 Synchronize summary view after prompting the update range.
3473 You can specify one of the follows.
3477 all Discard present msgdb and retrieve all informations.
3478 Do not retrieve killed messages.
3479 all-entirely Discard present msgdb and retrieve all informations.
3480 Retrieve killed messages, too.
3481 update Update the difference between informations in present
3482 msgdb and in current folder instance.
3483 Do not retrieve killed messages.
3484 update-entirely Update the difference between informations in present
3485 msgdb and in current folder instance.
3486 Retrieve killed messages, too.
3487 rescan Redisplay summary by rescanning present msgdb.
3488 rescan-noscore Redisplay summary by rescanning present msgdb.
3489 Display messages killed by score, too.
3490 rescan-thread Redisplay summary by rescanning present msgdb.
3491 Reconstruct thread, too.
3492 cache-status Sync the all marks with the real status of cache.
3495 first:NUM Move to the filter folder(partial filter).
3496 last:NUM Move to the filter folder(partial filter).
3501 (@code{wl-summary-sync})
3505 @findex wl-summary-sort
3507 You can sort by @samp{date}, @samp{from}, @samp{number}, @samp{subject},
3508 @samp{size} and @samp{list-info}.
3509 With prefix argument, sort summary lines into descending order.
3510 (@code{wl-summary-sort})
3514 @findex wl-summary-toggle-thread
3515 Toggle the threading. The state will be preserved after exiting
3516 Wanderlust. You can alter default state for newly created summary
3517 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3518 Threading status is displayed on the modeline.
3519 @samp{@{S@}} means threading is off (Sequence) and
3520 @samp{@{T@}} means threading is on (Thread).
3521 (@code{wl-summary-toggle-thread})
3525 @findex wl-summary-toggle-disp-folder
3526 Toggle displaying of folder window.
3527 (@code{wl-summary-toggle-disp-folder})
3531 Toggle displaying of message window.
3532 @findex wl-summary-toggle-disp-msg
3533 (@code{wl-summary-toggle-disp-msg})
3537 Move to the virtual folder (filter folder) with the condition specified.
3538 If called with prefix argument and current folder is virtual, exit it.
3539 @findex wl-summary-virtual
3540 (@code{wl-summary-virtual})
3543 @kindex @key{TAB} (Summary)
3544 @findex wl-summary-goto-last-displayed-msg
3545 Jump to the message which is displayed last.
3546 (@code{wl-summary-goto-last-displayed-msg})
3550 Put @samp{*} mark on the messages that satisfies the specified condition.
3551 @findex wl-summary-pick
3552 (@code{wl-summary-pick})
3556 @findex wl-summary-mark-as-read
3557 Mark as read the message at the current cursor point.
3558 (@code{wl-summary-mark-as-read})
3562 Execute action for all temporary marks in the summary buffer.
3563 @findex wl-summary-exec
3564 (@code{wl-summary-exec})
3568 @findex wl-summary-target-mark-line
3569 Put target mark on the message at the current cursor point.
3570 (@code{wl-summary-target-mark-line}) @xref{Mark and Action}.
3574 Put refile mark on the message at the current cursor point.
3575 @findex wl-summary-refile
3576 (@code{wl-summary-refile}) @xref{Mark and Action}.
3579 @kindex C-o (Summary)
3580 Execute auto refile.
3581 @findex wl-summary-auto-refile
3582 (@code{wl-summary-auto-refile})
3586 Put copy mark on the message at the current cursor point.
3587 @findex wl-summary-copy
3588 (@code{wl-summary-copy}) @xref{Mark and Action}.
3591 @kindex M-o (Summary)
3592 Put refile mark on the message at the current cursor point with the destination
3593 previously specified.
3594 @findex wl-summary-refile-prev-destination
3595 (@code{wl-summary-refile-prev-destination})
3599 @findex wl-summary-dispose
3600 Put disposal mark on the message at the current cursor point.
3601 The result of disposal is controlled by @code{wl-dispose-folder-alist},
3602 refiled to @code{wl-trash-folder} by default.
3603 (@code{wl-summary-dispose}) @xref{Mark and Action}.
3607 @findex wl-summary-delete
3608 Put force deletion mark on the message at the current cursor point.
3609 (@code{wl-summary-delete}) @xref{Mark and Action}.
3613 Put prefetch reservation mark on the message at the current cursor point.
3614 @findex wl-summary-prefetch
3615 (@code{wl-summary-prefetch}) @xref{Mark and Action}.
3619 @findex wl-summary-resend
3620 Put resend reservation mark on the message at the current cursor point.
3621 (@code{wl-summary-resend}) @xref{Mark and Action}.
3625 @findex wl-summary-unmark
3626 Unmark the temporal mark on the message at the current cursor point.
3627 (@code{wl-summary-unmark})
3631 Unmark all the temporal marks.
3632 @findex wl-summary-unmark-all
3633 (@code{wl-summary-unmark-all})
3636 @kindex r R (Summary)
3637 @findex wl-summary-mark-as-read-region
3638 Mark as read messages in the specified region.
3639 (@code{wl-summary-mark-as-read-region})
3642 @kindex r $ (Summary)
3643 @findex wl-summary-mark-as-important-region
3644 Put @samp{important} flag on messages in the specified region.
3645 If already flagged as @samp{important}, remove the flag.
3646 (@code{wl-summary-mark-as-important-region})
3649 @kindex r F (Summary)
3650 @findex wl-summary-set-flags-region
3651 Put arbitrary global flag entered in the minibuffer on messages in
3653 (@code{wl-summary-set-flags-region})
3656 @kindex r ! (Summary)
3657 @findex wl-summary-mark-as-unread-region
3658 Mark as unread messages in the specified region.
3659 (@code{wl-summary-mark-as-unread-region})
3662 @kindex r x (Summary)
3663 @findex wl-summary-exec-region
3664 Execute action for each temporary marks on the messages in the
3666 (@code{wl-summary-exec-region})
3669 @kindex r * (Summary)
3670 @findex wl-summary-target-mark-region
3671 Put target mark on the messages in the specified region.
3672 (@code{wl-summary-target-mark-region}) @xref{Mark and Action}.
3675 @kindex r o (Summary)
3676 @findex wl-summary-refile-region
3677 Put refile mark on the messages in the specified region.
3678 (@code{wl-summary-refile-region}) @xref{Mark and Action}.
3681 @kindex r O (Summary)
3682 @findex wl-summary-copy-region
3683 Put copy mark on the messages in the specified region.
3684 (@code{wl-summary-copy-region}) @xref{Mark and Action}.
3687 @kindex r d (Summary)
3688 @findex wl-summary-dispose-region
3689 Put disposal mark on the messages in the specified region.
3690 (@code{wl-summary-dispose-region}) @xref{Mark and Action}.
3693 @kindex r D (Summary)
3694 @findex wl-summary-delete-region
3695 Put force deletion mark on the messages in the specified region.
3696 (@code{wl-summary-delete-region}) @xref{Mark and Action}.
3699 @kindex r i (Summary)
3700 @findex wl-summary-prefetch-region
3701 Put prefetch reservation mark on messages in the specified region.
3702 (@code{wl-summary-prefetch-region}) @xref{Mark and Action}.
3705 @kindex r u (Summary)
3706 @findex wl-summary-unmark-region
3707 Delete temporal mark on the messages in the specified region.
3708 (@code{wl-summary-unmark-region})
3711 @kindex r y (Summary)
3712 Save messages in the specified region.
3713 @findex wl-summary-save-region
3714 (@code{wl-summary-save-region})
3717 @kindex t R (Summary)
3718 @findex wl-thread-mark-as-read
3719 Mark as read messages which are the descendant of the current thread.
3720 With prefix argument, it affects on the all messages in the thread tree.
3721 (@code{wl-thread-mark-as-read})
3724 @kindex t $ (Summary)
3725 @findex wl-thread-mark-as-important
3726 Put @samp{important} flag on the messages which are the descendant of
3727 the current thread. If already flagged as @samp{important}, remove the
3728 flag. With prefix argument, it affects on the all messages in the
3730 (@code{wl-thread-mark-as-important})
3733 @kindex t F (Summary)
3734 @findex wl-thread-set-flags
3735 Put arbitrary global flag entered in the minibuffer on the messages
3736 which are the descendant of the current thread. With prefix argument,
3737 it affects on the all messages in the thread tree.
3738 (@code{wl-thread-set-flags})
3741 @kindex t ! (Summary)
3742 @findex wl-thread-mark-as-unread
3743 Mark as unread messages which are the descendant of the current thread.
3744 With prefix argument, it affects on the all messages in the thread tree.
3745 (@code{wl-thread-mark-as-unread})
3748 @kindex t x (Summary)
3749 @findex wl-thread-exec
3750 Execute action for temporary marks on the messages which are
3751 the descendant of the current thread. With prefix argument, it affects
3752 on the all messages in the thread tree.
3753 (@code{wl-thread-exec})
3756 @kindex t * (Summary)
3757 @findex wl-thread-target-mark
3758 Put target mark @samp{*} on the messages which are the descendant of the
3759 current thread. With prefix argument, it affects on the all messages in
3761 (@code{wl-thread-target-mark}) @xref{Mark and Action}.
3764 @kindex t o (Summary)
3765 @findex wl-thread-refile
3766 Put refile mark on the messages which are the descendant of the current thread.
3767 With prefix argument, it affects on the all messages in the thread tree.
3768 (@code{wl-thread-refile}) @xref{Mark and Action}.
3771 @kindex t O (Summary)
3772 @findex wl-thread-copy
3773 Put copy mark on the messages which are the descendant of the current thread.
3774 With prefix argument, it affects on the all messages in the thread tree.
3775 (@code{wl-thread-copy}) @xref{Mark and Action}.
3778 @kindex t d (Summary)
3779 @findex wl-thread-dispose
3780 Put disposal mark on the messages which are the descendant of the current thread.
3781 With prefix argument, it affects on the all messages in the thread tree.
3782 (@code{wl-thread-dispose}) @xref{Mark and Action}.
3785 @kindex t D (Summary)
3786 @findex wl-thread-delete
3787 Put force deletion mark on the messages which are the descendant of the
3789 (@code{wl-thread-delete}) @xref{Mark and Action}.
3792 @kindex t i (Summary)
3793 @findex wl-thread-prefetch
3794 Put prefetch reservation mark on messages which are the descendant of
3796 (@code{wl-thread-prefetch}) @xref{Mark and Action}.
3799 @kindex t u (Summary)
3800 @findex wl-thread-unmark
3801 Unmark temporal mark on the messages which are the descendant of the
3802 current thread. With prefix argument, it affects on the all messages in
3804 (@code{wl-thread-unmark})
3807 @kindex t y (Summary)
3808 @findex wl-thread-save
3809 Save messages which are the descendant of the current thread.
3810 With prefix argument, it affects on the all messages in the thread tree.
3811 (@code{wl-thread-save})
3814 @kindex m R (Summary)
3815 @findex wl-summary-target-mark-mark-as-read
3816 Mark as read all messages which have target mark @samp{*}.
3817 (@code{wl-summary-target-mark-mark-as-read})
3820 @kindex m $ (Summary)
3821 @findex wl-summary-target-mark-mark-as-important
3822 Put @samp{important} flag on all messages which have target mark @samp{*}.
3823 If already flagged as @samp{important}, remove the flag.
3824 (@code{wl-summary-target-mark-mark-as-important})
3827 @kindex m F (Summary)
3828 @findex wl-summary-target-mark-set-flags
3829 Put arbitrary global flag entered in the minibuffer on all messages
3830 which have target mark @samp{*}.
3831 (@code{wl-summary-target-mark-set-flags})
3834 @kindex m ! (Summary)
3835 @findex wl-summary-target-mark-mark-as-unread
3836 Mark as unread all messages which have target mark @samp{*}.
3837 (@code{wl-summary-target-mark-mark-as-unread})
3840 @kindex m o (Summary)
3841 @findex wl-summary-target-mark-refile
3842 Put refile mark on the messages which have target mark @samp{*}.
3843 (@code{wl-summary-target-mark-refile}) @xref{Mark and Action}.
3846 @kindex m O (Summary)
3847 @findex wl-summary-target-mark-copy
3848 Put copy mark on the messages which have target mark @samp{*}.
3849 (@code{wl-summary-target-mark-copy}) @xref{Mark and Action}.
3852 @kindex m d (Summary)
3853 @findex wl-summary-target-mark-dispose
3854 Put disposal mark on the messages which have target mark @samp{*}.
3855 (@code{wl-summary-target-mark-dispose}) @xref{Mark and Action}.
3858 @kindex m D (Summary)
3859 @findex wl-summary-target-mark-delete
3860 Put force deletion mark on the messages which have target mark @samp{*}.
3861 (@code{wl-summary-target-mark-delete}) @xref{Mark and Action}.
3864 @kindex m i (Summary)
3865 @findex wl-summary-target-mark-prefetch
3866 Put prefetch reservation mark on messages which have target mark @samp{*}.
3867 (@code{wl-summary-target-mark-prefetch}) @xref{Mark and Action}.
3870 @kindex m y (Summary)
3871 @findex wl-summary-target-mark-save
3872 Save messages which have target mark @samp{*}.
3873 (@code{wl-summary-target-mark-save})
3876 @kindex m u (Summary)
3877 Unmark all temporal marks.
3878 (@code{wl-summary-delete-all-temp-marks})
3879 @findex wl-summary-delete-all-temp-marks
3882 @kindex m a (Summary)
3883 Put target mark @samp{*} on the all messages.
3884 (@code{wl-summary-target-mark-all})
3885 @findex wl-summary-target-mark-all
3888 @kindex m t (Summary)
3889 Put target mark @samp{*} on the messages in the current thread.
3890 @findex wl-summary-target-mark-thread
3891 (@code{wl-summary-target-mark-thread})
3894 @kindex m r (Summary)
3895 @findex wl-summary-target-mark-region
3896 Put target mark @samp{*} on the messages in the specified region.
3897 (@code{wl-summary-target-mark-region})
3900 @kindex m A (Summary)
3901 @findex wl-summary-target-mark-reply-with-citation
3902 Prepare a draft which cites all messages which have target mark @samp{*}.
3903 (@code{wl-summary-target-mark-reply-with-citation})
3906 @kindex m f (Summary)
3907 @findex wl-summary-target-mark-forward
3908 Prepare a draft which forwards all messages which have target mark @samp{*}.
3909 (@code{wl-summary-target-mark-forward})
3912 @kindex m U (Summary)
3913 @findex wl-summary-target-mark-uudecode
3914 Uudecode the messages which have target mark @samp{*}.
3915 (@code{wl-summary-target-mark-uudecode})
3918 @kindex m ? (Summary)
3919 @findex wl-summary-target-mark-pick
3920 Pick messages from the @samp{*} marked messages.
3921 That is, @samp{*} marks on the messages are remained
3922 if the specified condition is satisfied.
3923 (@code{wl-summary-target-mark-pick})
3926 @kindex m # (Summary)
3927 @findex wl-summary-target-mark-print
3928 Print out all messages which have target mark @samp{*}.
3929 (@code{wl-summary-target-mark-print})
3932 @kindex m | (Summary)
3933 @findex wl-summary-target-mark-pipe
3934 Pipe content of each message with target mark @samp{*} to some specified
3936 (@code{wl-summary-target-mark-pipe})
3939 @kindex M-t (Summary)
3940 @findex wl-toggle-plugged
3941 Toggle offline/online status of Wanderlust.
3942 (@code{wl-toggle-plugged})
3945 @kindex C-t (Summary)
3946 Start Wanderlust's plug-status manager.
3947 (@code{wl-plugged-change})
3950 @kindex C-c C-o (Summary)
3951 @findex wl-jump-to-draft-buffer
3952 Move to the draft buffer if available. If multiple draft buffer exists,
3953 moved to one after another. If prefix argument is specified, load draft
3954 folder's message to the draft buffer and jump to it.
3955 (@code{wl-jump-to-draft-buffer})
3958 @kindex M-w (Summary)
3959 @findex wl-summary-save-current-message
3960 Save the message at the current cursor point.
3961 (@code{wl-summary-save-current-message})
3964 @kindex C-y (Summary)
3965 @findex wl-summary-yank-saved-message
3966 Regard the message at the current cursor point as
3967 parent, connect the message saved by
3968 @code{wl-summary-save-current-message}
3970 (@code{wl-summary-yank-saved-message})
3973 @kindex C-x C-s (Summary)
3974 @findex wl-summary-save-status
3975 Save the current summary.
3976 (@code{wl-summary-save-status})
3980 @node Variables of Summary, , Key Bindings of Summary, Summary
3981 @section Customiziable variables
3984 @item wl-summary-move-order
3985 @vindex wl-summary-move-order
3986 The initial setting is @code{unread}. Specify cursor moving policy. If
3987 you want to precede new messages, set @code{new}. If you want to
3988 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3991 @item wl-auto-select-first
3992 @vindex wl-auto-select-first
3993 The initial setting is @code{nil}.
3994 If non-nil, first message is automatically displayed when you enter
3997 @item wl-auto-select-next
3998 @vindex wl-auto-select-next
3999 The initial setting is @code{nil}. This controls behavior when there is
4000 no unread message in current summary.
4003 nil: asks whether you want to go back to folder mode
4004 'unread: asks whether you want to go to next unread folder
4005 If the next one comes to be possessing no unread message
4006 by treatment of cross-posted messages or Scoring, then
4007 asks whether you want to go to next to next folder.
4008 'skip-no-unread: similar as unread
4009 But does not ask before going to next to next folder.
4010 otherwise: asks whether you want to go to next unread folder
4013 It might be useful to set @code{'skip-no-unread} for people who
4014 want to continue reading by just pressing and pressing space key.
4016 @item wl-thread-insert-opened
4017 @vindex wl-thread-insert-opened
4018 The initial setting is @code{nil}.
4019 If non-nil, thread is inserted as opened.
4021 @item wl-thread-open-reading-thread
4022 @vindex wl-thread-open-reading-thread
4023 The initial setting is @code{t}. If non-nil, reading thread is
4024 automatically opened though it is closed thread.
4026 @item wl-summary-exit-next-move
4027 @vindex wl-summary-exit-next-move
4028 The initial setting is @code{t}. If non-nil, move to next folder at
4031 @item wl-folder-move-cur-folder
4032 @vindex wl-folder-move-cur-folder
4033 The initial setting is @code{nil}. If non-nil, cursor position on the
4036 @item wl-summary-weekday-name-lang
4037 @vindex wl-summary-weekday-name-lang
4038 Specify language of the weekday.
4039 @samp{en} displays English, @samp{fr} displays French, @samp{de}
4040 displays Deutsch. You should rescan summary view after changing this value.
4042 @item wl-summary-fix-timezone
4043 @vindex wl-summary-fix-timezone
4044 The initial setting is @code{nil}.
4045 Time zone of the date string in summary mode is adjusted using this value.
4046 If @code{nil}, it is adjust to the default time zone information
4047 (system's default time zone or environment variable @samp{TZ}).
4049 @item wl-use-petname
4050 @vindex wl-use-petname
4051 The initial setting is @code{t}.
4052 If non-nil, sender part displays nickname.
4054 @item wl-break-pages
4055 @vindex wl-break-pages
4056 The initial setting is @code{t}.
4057 If non-nil, message is split as pages by @samp{^L}.
4059 @item wl-message-window-size
4060 @vindex wl-message-window-size
4061 The initial setting is '(1 . 4).
4062 A cons cell to specify the rate of summary and message window.
4063 car:cdr corresponds summary:message.
4065 @item wl-summary-from-function
4066 @vindex wl-summary-from-function
4067 Format function to display sender in summary.
4068 The initial setting is @code{wl-summary-default-from}.
4070 @item wl-summary-no-from-message
4071 @vindex wl-summary-no-from-message
4072 The initial setting is @samp{nobody@@nowhere?}. A string which is
4073 displayed when there's no @samp{From:} field in the message.
4075 @item wl-summary-subject-function
4076 @vindex wl-summary-subject-function
4077 Format function to display subject in summary.
4078 The initial setting is @code{wl-summary-default-subject} and
4079 it will cut the list name part etc. on the top of the subject.
4080 To display subject as it is, set as follows.
4083 (setq wl-summary-subject-function 'identity)
4086 @item wl-summary-no-subject-message
4087 @vindex wl-summary-no-subject-message
4088 The initial setting is @samp{(WL:No Subject in original.)}. A string
4089 which is displayed when there's no @samp{Subject:} field in the message.
4091 @item wl-summary-default-view
4092 @vindex wl-summary-default-view
4093 The initial setting is @code{'thread}.
4094 The default state for newly created summary. You can set either
4095 @code{'thread} for thread view or @code{'sequence} for sequential view.
4097 @item wl-summary-use-frame
4098 @vindex wl-summary-use-frame
4099 The initial setting is @code{nil}.
4100 If non-nil, use new frame for the summary.
4102 @item wl-use-folder-petname
4103 @vindex wl-use-folder-petname
4104 The initial setting is the list shown below:
4113 A list of display policy (symbol) of folder nickname. Available symbols
4118 Display folder petname on modeline.
4120 Destination folder is notified as nickname if
4121 @code{wl-auto-select-next} is non-nil.
4123 You can input folder name by nickname in the function
4124 @code{wl-summary-read-folder}.
4127 @item wl-summary-move-direction-toggle
4128 @vindex wl-summary-move-direction-toggle
4129 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
4130 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
4131 want to aware of reading direction, set this to @code{t}.
4133 @item wl-summary-width
4134 @vindex wl-summary-width
4135 The initial setting is 80.
4136 Width of summary line. If @code{nil}, summary line's width is as is.
4138 @item wl-summary-print-argument-within-window
4139 @vindex wl-summary-print-argument-within-window
4140 The initial setting is @code{nil}.
4141 If non-nil, the action argument is always printed on right side of
4144 @item wl-summary-indent-length-limit
4145 @vindex wl-summary-indent-length-limit
4146 The initial setting is 46.
4147 Specify the limit of thread indent level. @code{nil} means unlimited
4149 If you set this to @code{nil} you should set @code{wl-summary-width}
4152 @item wl-summary-max-thread-depth
4153 @vindex wl-summary-max-thread-depth
4154 The initial setting is 15.
4155 If thread depth of the message is larger than this value,
4156 the thread is divided.
4158 @item wl-summary-recenter
4159 @vindex wl-summary-recenter
4160 The initial setting is t.
4161 If non-nil, cursor point is moved to the center of the summary window.
4163 @item wl-summary-max-thread-depth
4164 @vindex wl-summary-max-thread-depth
4165 The initial setting is 30.
4166 If thread depth is larger than this value, divide it.
4168 @item wl-summary-divide-thread-when-subject-changed
4169 @vindex wl-summary-divide-thread-when-subject-changed
4170 The initial setting is @code{nil}. If non-nil, thread is split if
4171 the subject is changed.
4173 @item wl-summary-search-via-nntp
4174 @vindex wl-summary-search-via-nntp
4175 The initial setting is @code{confirm}.
4177 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
4178 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
4179 from the NNTP server @code{elmo-nntp-default-server}. The value of
4180 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
4181 @code{elmo-nntp-default-stream-type} are used.
4183 If @code{confirm}, server name can be specified. You can specify NNTP
4184 folder format like @samp{-:username@@servername:119!}.
4186 @item wl-summary-keep-cursor-command
4187 @vindex wl-summary-keep-cursor-command
4188 The initial setting is the list shown below:
4192 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
4197 When you entered to summary by these commands and the target summary
4198 buffer already exists, summary status is not automatically updated and
4199 cursor position is saved.
4201 @item elmo-folder-update-threshold
4202 @vindex elmo-folder-update-threshold
4203 The initial setting is 500. If updated message number is larger than
4204 this value, confirm whether drop them or not (in the case where the value
4205 of @code{elmo-folder-update-confirm} is non-nil).
4207 @item elmo-folder-update-confirm
4208 @vindex elmo-folder-update-confirm
4209 The initial setting is @code{t}. If the value is non-nil, do check with
4210 @code{elmo-folder-update-threshold}.
4212 @item wl-summary-always-sticky-folder-list
4213 @vindex wl-summary-always-sticky-folder-list
4214 The initial setting is @code{nil}.
4215 @code{wl-summary-always-sticky-folder-list} specifies the folders that
4216 are automatically stuck. Each element is regexp of folder name.
4218 @item wl-summary-reserve-mark-list
4219 @vindex wl-summary-reserve-mark-list
4220 The initial setting is the list shown below:
4224 ("o" "O" "D" "d" "i")
4229 If a message is already marked as temporal marks in this list, the
4230 message is not marked by any mark command.
4232 @item wl-summary-skip-mark-list
4233 @vindex wl-summary-skip-mark-list
4234 The initial setting is the list shown below:
4243 If a message is already marked as temporal marks in this list, the
4244 message is skipped at cursor move.
4246 @item elmo-message-fetch-threshold
4247 @vindex elmo-message-fetch-threshold
4248 The initial setting is 30000 (bytes). If displaying message has larger
4249 size than this value, Wanderlust confirms whether fetch the message or
4250 not (in the case where the value of @code{elmo-message-fetch-confirm}
4253 @item elmo-message-fetch-confirm
4254 @vindex elmo-message-fetch-confirm
4255 The initial setting is @code{t}. If the value is non-nil, do check with
4256 @code{elmo-message-fetch-threshold}.
4258 @item wl-prefetch-threshold
4259 @vindex wl-prefetch-threshold
4260 The initial setting is 30000 (bytes). If prefetching message has larger
4261 size than this value and @code{wl-prefetch-confirm} is non-nil,
4262 Wanderlust confirms whether prefetch the message or not. If
4263 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
4264 without confirmation.
4266 @item wl-prefetch-confirm
4267 @vindex wl-prefetch-confirm
4268 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4269 prefetch the message or not if the message has larger size than
4270 @code{wl-prefetch-threshold}.
4272 @item elmo-imap4-use-cache
4273 @vindex elmo-imap4-use-cache
4274 The initial setting is @code{t}. If non-nil, messages read via IMAP4
4277 @item elmo-nntp-use-cache
4278 @vindex elmo-nntp-use-cache
4279 The initial setting is @code{t}. If non-nil, messages read via NNTP are
4282 @item elmo-pop3-use-cache
4283 @vindex elmo-pop3-use-cache
4284 The initial setting is @code{t}. If non-nil, messages read via POP3 are
4287 @item elmo-shimbun-use-cache
4288 @vindex elmo-shimbun-use-cache
4289 The initial setting is @code{t}. If non-nil, messages read in Shimbun
4292 @item wl-folder-process-duplicates-alist
4293 @vindex wl-folder-process-duplicates-alist
4294 The initial setting is @code{nil}.
4295 This list determines how to deal with duplicated messages in the same folder.
4296 Each item in the list is regexp of folder name and action; you can specify any
4297 one of the following in the place of action:
4300 @code{nil} : do nothing for duplicated messages.
4301 @code{hide} : hide duplicated messages from the summary.
4302 @code{read} : set duplicated messages as read.
4306 Following is an example (hide duplicated messages in multi folders)
4310 (setq wl-folder-process-duplicates-alist
4311 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4312 ("^\\*.*" . hide) (".*" . read)))
4316 @item wl-summary-flag-alist
4317 @vindex wl-summary-flag-alist
4318 The initial setting is as follows:
4322 ((important "orange"))
4326 Specify the color and the mark of message in summary buffer with flag.
4327 If the mark are omitted, the mark specified in the variable
4328 @code{wl-summary-flag-mark} is assumed. If multiple global flags are on
4329 one message, the former flag in this list is preferred.
4335 (setq wl-summary-flag-alist
4336 '((important "purple")
4338 (business "green" "B")
4339 (private "blue" "X")))
4343 @item wl-summary-display-mime-mode-list
4344 @vindex wl-summary-display-mime-mode-list
4345 The initial setting is the list shown below:
4354 The function @code{wl-summary-toggle-mime} switch specification of MIME
4355 analysis in the order of this list. You can specify one of the follows.
4358 @code{mime} : Header and body are decoded.
4359 @code{header-only} : Only header is decoded.
4360 @code{as-is} : Header and body are not decoded.
4365 @node Message, Draft, Summary, Top
4366 @chapter Message Buffer
4368 Message Buffers utilize MIME-View mode of SEMI. For operational
4369 procedures and key bindings, refer to respective documents.
4370 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4371 You can also see help by @kbd{?} in message buffer.
4373 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4374 brings you back to Summary mode. @kbd{l} toggles display of Summary
4377 @section Key Bindings
4383 @findex wl-message-toggle-disp-summary
4384 Toggles display of Summary buffer.
4385 (@code{wl-message-toggle-disp-summary})
4388 @findex wl-message-refer-article-or-url
4389 @kindex Button-2 (Message)
4390 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4391 corresponding message if found.
4392 (@code{wl-message-refer-article-or-url})
4394 @item Button-4 (upward movement of a wheel)
4395 @kindex Button-4 (Message)
4396 @findex wl-message-wheel-down
4397 Scrolls the message backwards. When the top of the message is hit,
4398 moves to the previous message.
4399 (@code{wl-message-wheel-down})
4401 @item Button-5 (downward movement of a wheel)
4402 @kindex Button-5 (Message)
4403 @findex wl-message-wheel-up
4404 Scrolls the message forward. When the bottom of the message is hit,
4405 moves to the next message.
4406 (@code{wl-message-wheel-up})
4410 @findex wl-message-delete-current-part
4411 Delete the part under cursor. In fact it appends modified message to
4412 the current folder then moves old one to trash folder. Therefore the
4413 message number will be changed.
4414 (@code{wl-message-delete-current-part})
4417 @section Customizable Variables
4420 @item wl-message-window-size
4421 @vindex wl-message-window-size
4422 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4423 its car and cdr value corresponds to the ratio of Summary and Message
4426 @item wl-message-ignored-field-list
4427 @vindex wl-message-ignored-field-list
4428 Initial setting is @code{nil}.
4429 All fields that match this list will be hidden in message buffer.
4430 Each elements are regexp of field-name.
4431 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4433 @item wl-message-visible-field-list
4434 @vindex wl-message-visible-field-list
4435 Initial setting is @code{nil}.
4436 All fields that match this list will be display in message buffer.
4437 Each elements are regexp of field-name. This value precedes
4438 @code{wl-message-ignored-field-list}.
4439 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4441 @item wl-message-sort-field-list
4442 @vindex wl-message-sort-field-list
4444 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4445 Header fields in message buffer are ordered by this value.
4446 Each elements are regexp of field-name.
4448 @item wl-message-truncate-lines
4449 @vindex wl-message-truncate-lines
4450 The initial value is the value of @code{default-truncate-lines}.
4451 If it is non-nil, truncate long lines in message buffer.
4454 @node Draft, Disconnected Operations, Message, Top
4455 @chapter Draft Buffer
4457 At Summary mode, pressing @kbd{w} and the like creates a new draft
4458 buffer. You can edit and send mail and news articles in this buffer.
4460 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4461 with those if possible.
4464 * Usage of Draft Mode:: TIPS
4465 * Key Bindings of Draft:: Key bindings
4466 * Variables of Draft Mode:: Customize Draft Mode
4469 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4472 Basically it is Emacs-standard mail mode.
4476 * Editing Message Body and Sending::
4477 * Dynamical Message Re-arrangement::
4482 @node Editing Header, Editing Message Body and Sending, Usage of Draft Mode, Usage of Draft Mode
4483 @subsection Editing Message Header
4485 You can freely edit header region above @samp{--text follows this line--},
4486 until you invoke the sending operation.
4488 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4489 addresses. @kbd{@key{TAB}} completes them.
4491 You can use following headers to specify recipients. Add some of them
4492 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4495 @item @samp{Newsgroups:}
4496 Specify newsgroups to which you post the news article.
4499 Specify addresses to send a copy (Carbon Copy) of the message.
4502 Following ones are removed from the header contents before sending.
4506 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4509 Specify folders in which a copy of the message is saved.
4512 Specify recipients to send encapsulated copy of the message.
4515 You can add initial headers by following variables.
4521 The initial setting is @code{nil}.
4522 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4523 the draft when it is prepared. If function is specified, its return
4528 The initial setting is @code{nil}.
4529 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4530 the draft when it is prepared.
4533 @node Editing Message Body and Sending, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4534 @subsection Editing Messages and Sending
4536 As a matter of course, editing message body can be performed in the same
4537 way as usual writing. You may write message body under
4538 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4539 @samp{--text follows this line--} intact.)
4541 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4542 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4543 a MIME user interface for GNU Emacs}.
4544 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4546 If you save the draft buffer you are editing, it is appended to the
4547 folder specified by @code{wl-draft-folder}. You can leave draft buffer
4548 after storing it for future editing by @kbd{C-c C-z} (@code{wl-draft-save-and-exit}).
4550 If you have finished editing, you can send message by @kbd{C-c C-c}.
4553 @node Dynamical Message Re-arrangement, Template, Editing Message Body and Sending, Usage of Draft Mode
4554 @subsection Dynamic Modification of Messages
4555 @vindex wl-draft-config-alist
4556 @c @cindex Change Message
4557 @c @cindex Message, Change Dynamic
4559 You can set @code{wl-draft-config-alist} so that header and body of the
4560 message will automatically modified depending on information of header
4563 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4565 In the example below, the header is modified when
4566 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4567 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4568 before sending the message.
4572 (setq wl-draft-config-alist
4573 '(((string-match "aaa\\.example\\.com$" (system-name))
4574 ;; @r{applied if the expression is non-nil}
4575 (wl-smtp-posting-server . "mailserver-B")
4576 (wl-nntp-posting-server . "newsserver-B")
4577 ;; @r{settings of temporary variables}
4579 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4580 ;; @r{applied if it matches the header of the draft buffer}
4581 ("Organization" . (format "Go %s" my-webpage)))
4582 ;; @r{you can write elisp expressions here (eval only)}
4583 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4584 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4589 The format of @code{wl-draft-config-alist} is:
4593 '(("@var{regexp of the header}" or @var{elisp expression}
4594 ("@var{Field}" . value(@var{elisp expression}))
4595 (@var{variable} . value(@var{elisp expression}))
4596 (@var{sub-function} . value(@var{elisp expression}))
4599 ("@var{regexp of the header}" or @var{elisp expression}
4600 ("@var{Field}" . value(@var{elisp expression}))
4605 Per default, there are 13 following sub-functions.
4608 'header: Inserts the specified string at the bottom of the header.
4609 'header-top: Inserts the specified string at the top of the header.
4610 'header-file: Inserts the specified file at the bottom of the header.
4611 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4612 'top: Inserts the specified string at the top of the body.
4613 'top-file: Inserts the specified file at the top of the body.
4614 'body: Replaces the body with the specified string.
4615 Specifying @code{nil} deletes the entire body string.
4616 'body-file: Replaces the body with the content of the specified file.
4617 'bottom: Inserts the specified string at the bottom of the body.
4618 'bottom-file: Inserts the specified file at the top of the body.
4619 'part-top: Inserts the specified string at the top of the current part.
4620 'part-bottom: Inserts the specified string at the bottom of the current part.
4621 'template: Applies the specified template.
4622 (refer to the next subsection)
4625 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4626 change them or add your own functions. If you read the code, you can
4627 easily find how to write the functions.
4629 At the first of each item, @var{a regular expression of the header} or
4630 an @var{elisp expression} should be specified. In the case of an elisp
4631 expression, the item is applied when the expression is evaluated
4634 Per default, when multiple items match or are evaluated non-nil, all
4635 such items are applied, but if you set a variable
4636 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4639 At the second of the item, a cons or a list of functions should be
4640 specified. The car part of the cons should be a header field, a
4641 variable, or a sub-function. When a header field is specified, the
4642 field will be modified. If a variable is specified, the value of the
4643 variable will be modified temporarily.
4645 In the cdr part of a cons, not only a variable but also an elisp
4646 expression can be specified as is. If the car part is a header field
4647 and the cdr part is @code{nil}, the field will be deleted.
4649 See the next example as well:
4653 (setq wl-draft-config-alist
4655 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4656 ;; @r{applied if it matches the header of the buffer being replied}
4657 (body . " Hello.\n")
4658 (template . "default")
4663 As in the (1) above, if a header regexp is prepended with @code{reply},
4664 it is applied when the draft is prepared by @code{wl-summary-reply} for
4665 example, and when it matches the header being replied. It is ignored
4666 when there is no buffer being replied, like after @code{wl-draft} was
4669 If you want to use name of parent folder, you can refer the buffer local
4670 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4671 changes From according to the folder name of the summary in which the draft
4676 (setq wl-draft-config-alist
4677 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4678 (\"From\" . \"user@@domain1\"))
4679 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4680 (\"From\" . \"user@@domain2\"))))
4685 Note that @code{wl-draft-config-alist} is applied only once when
4686 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4687 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4688 aborting transmission, execute @kbd{C-c C-e}
4689 (@code{wl-draft-config-exec}) explicitly.
4691 If you don't want to apply @code{wl-draft-config-alist} when
4692 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4696 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4699 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4700 prepared, do the following:
4703 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4706 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4707 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4711 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4714 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4715 @subsection Inserting Templates
4717 @cindex Apply Template
4719 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4720 @kbd{M-x wl-template-select} in the draft buffer.
4722 The format of @code{wl-template-alist} is almost the same as
4723 @code{wl-draft-config-alist}.
4724 @xref{Dynamical Message Re-arrangement}.
4728 (setq wl-template-alist
4731 ("Organization" . "Example Co.Ltd.")
4732 (body . "Hello.\n"))
4734 (template . "default") ;; @r{(a)}
4735 ("To" . "boss@@example.com")
4736 ("Subject" . "Report")
4737 (body-file . "~/work/report.txt")
4743 As you can see, the only difference is item (template) names such as
4744 @samp{default} and @samp{report}, instead of a regexp of header.
4745 Because definition of each item is the same as
4746 @code{wl-draft-config-alist}, you can call another template, like (a).
4748 Executing the command @code{wl-template-select} results in template
4749 selection, but the result differs depending on variable
4750 @code{wl-template-visible-select}.
4752 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4753 window is shown below the draft buffer. You can select a template by
4754 @kbd{n} and @kbd{p} seeing the buffer window.
4756 Press the @key{RET} key and the template is actually applied to the draft
4757 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4758 adjust the window size by @code{wl-template-buffer-lines}.
4760 If @code{wl-template-visible-select} is @code{nil}, you should type the
4761 name of the template in the mini buffer.
4763 As shown in the example in @code{wl-draft-config-alist}, you can select
4764 @samp{default} template by writing:
4767 (template . "default")
4770 @node POP-before-SMTP, , Template, Usage of Draft Mode
4771 @subsection Sending mail by POP-before-SMTP
4772 @cindex POP-before-SMTP
4774 You can send mail by POP-before-SMTP with this single line:
4777 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4781 Configure the following variables if you need.
4784 @item wl-pop-before-smtp-user
4785 The POP user name for POP-before-SMTP authentication.
4786 If unset, @code{elmo-pop3-default-user} is used.
4788 @item wl-pop-before-smtp-server
4789 The POP server name for POP-before-SMTP authentication.
4790 If unset, @code{elmo-pop3-default-server} is used.
4792 @item wl-pop-before-smtp-authenticate-type
4793 The POP authentication method for POP-before-SMTP authentication.
4794 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4796 @item wl-pop-before-smtp-port
4797 The POP port number for POP-before-SMTP authentication.
4798 If unset, @code{elmo-pop3-default-port} is used.
4800 @item wl-pop-before-smtp-stream-type
4801 If @code{ssl}, POP connection is established using SSL. If
4802 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4803 unset, @code{elmo-pop3-default-stream-type} is used.
4806 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4807 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4809 Therefore, if SMTP server and POP server are actually the same, and if
4810 POP folder per default (such as @samp{&}) is available, no settings are
4813 Refer to the following URL about POP-before-SMTP.
4817 http://spam.ayamura.org/tools/smPbS.html
4818 http://www.iecc.com/pop-before-smtp.html
4823 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4824 @section Key Bindings
4825 @cindex Keybind, Draft Mode
4826 @cindex Keybind, Draft Buffer
4831 @kindex C-c C-y (Draft)
4832 @findex wl-draft-yank-original
4833 Cites the content of the current message buffer (the part under cursor).
4834 If the region is active, cites the region (it affects only if
4835 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4836 (on XEmacs) is Non-nil).
4837 (@code{wl-draft-yank-original})
4840 @kindex C-c C-p (Draft)
4841 @findex wl-draft-preview-message
4842 Previews the content of the current draft.
4843 This is useful for previewing MIME multi-part messages.
4844 (@code{wl-draft-preview-message})
4847 @kindex C-c C-s (Draft)
4848 @findex wl-draft-send
4849 Sends the content of the current draft. Does not erase the draft buffer.
4850 This is useful for sending multiple messages, which are a little different
4852 (@code{wl-draft-send})
4855 @kindex C-c C-c (Draft)
4856 @findex wl-draft-send-and-exit
4857 Sends the content of the current draft and erases the draft buffer.
4858 (@code{wl-draft-send-and-exit})
4861 @kindex C-x C-s (Draft)
4862 @findex wl-draft-save
4863 Save the current draft.
4864 (@code{wl-draft-save})
4867 @kindex C-c C-k (Draft)
4868 @findex wl-draft-kill
4869 Kills the current draft.
4870 (@code{wl-draft-kill})
4873 @kindex C-x k (Draft)
4874 @findex wl-draft-mimic-kill-buffer
4875 Kills the current draft.
4876 (@code{wl-draft-mimic-kill-buffer})
4879 @kindex C-c C-z (Draft)
4880 @findex wl-draft-save-and-exit
4881 Saves the current draft, and erases the draft buffer.
4882 This is useful if you want to suspend editing of the draft.
4883 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4884 the @samp{+draft} folder.
4885 (@code{wl-draft-save-and-exit})
4888 @kindex C-c C-r (Draft)
4889 @findex wl-caesar-region
4890 Encodes or decodes the specified region in Caesar cipher.
4891 (@code{wl-caesar-region})
4895 @findex wl-draft-highlight-and-recenter
4896 Recenter and rehighlight current draft.
4897 (@code{wl-draft-highlight-and-recenter})
4901 @findex wl-toggle-plugged
4902 Toggles off-line/on-line states of Wanderlust.
4903 (@code{wl-toggle-plugged})
4906 @kindex C-c C-o (Draft)
4907 @findex wl-jump-to-draft-buffer
4908 Jumps to the other draft buffer, if exists.
4909 With prefix argument, reads a file (if any) from the draft folder when
4910 there is no such buffer.
4911 (@code{wl-jump-to-draft-buffer})
4914 @kindex C-c C-e (Draft)
4915 @findex wl-draft-config-exec
4916 Applies @code{wl-draft-config-alist}.
4917 (@code{wl-draft-config-exec})
4920 @kindex C-c C-j (Draft)
4921 @findex wl-template-select
4923 (@code{wl-template-select})
4926 @kindex C-c C-a (Draft)
4928 Enter Address Manager.
4929 @xref{Address Manager}.
4933 @kindex C-c C-d (Draft)
4934 @findex wl-draft-elide-region
4935 Elide the text between point and mark (@code{wl-draft-elide-region}).
4936 The text is killed and replaced with the contents of the variable
4937 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4941 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4942 @section Customizable Variables
4946 @item wl-subscribed-mailing-list
4947 @vindex wl-subscribed-mailing-list
4948 The initial setting is @code{nil}. Mailing lists to which you
4949 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4950 field of a reply draft, removes your own address from
4951 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4952 contained in @samp{To:} or @samp{Cc:} field of a message to be
4953 automatically re-filed, the destination folder will be leaned in
4954 connection with the address.
4960 (setq wl-subscribed-mailing-list
4961 '("wl@@lists.airs.net"
4963 "emacs-mime-ja@@m17n.org"))
4967 @item wl-insert-mail-followup-to
4968 @vindex wl-insert-mail-followup-to
4969 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4970 field is automatically inserted in the draft buffer.
4972 @item wl-insert-mail-reply-to
4973 @vindex wl-insert-mail-reply-to
4974 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4975 field is automatically inserted in the draft buffer.
4977 @item wl-auto-insert-x-face
4978 @vindex wl-auto-insert-x-face
4979 The initial setting is @code{t}. If non-nil and there is an encoded
4980 X-Face string in a file @file{~/.xface} (the value of the variable
4981 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4982 draft buffer. If @code{nil}, it is not automatically inserted.
4984 @item wl-insert-message-id
4985 @vindex wl-insert-message-id
4986 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4987 is automatically inserted on the transmission.
4989 @item wl-message-id-use-wl-from
4990 @vindex wl-message-id-use-wl-from
4991 The initial setting is @code{nil}. If non-nil, the value of
4992 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4994 @item wl-local-domain
4995 @vindex wl-local-domain
4996 The initial setting is @code{nil}. If @code{nil}, the return value of
4997 the function @code{system-name} will be used as the domain part of
5000 If @code{system-name} does not return FQDN (i.e. the full name of the
5001 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
5002 to the string of the local domain name without hostname (like
5003 @samp{gohome.org}). That is, a concatenation of @code{system-name}
5004 @samp{.} @code{wl-local-domain} is used as domain part of the
5007 If your terminal does not have global IP, set the value of
5008 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
5009 you use invalid @samp{Message-ID:}.)
5011 Moreover, concatenation of @code{system-name} @samp{.}
5012 @code{wl-local-domain} will be used as an argument to the HELO command
5015 @item wl-message-id-domain
5016 @vindex wl-message-id-domain
5017 The initial setting is @code{nil}. If non-nil, this value is used as a
5018 domain part of the @samp{Message-ID:}. If your terminal does not have
5019 global IP address, set unique string to this value (e.x. your e-mail
5022 @item wl-unique-id-suffix
5023 @vindex wl-unique-id-suffix
5024 The initial setting is @samp{.wl}. You can specify the string in generated
5025 Message-ID which appear just before @samp{@@}.
5027 @item wl-draft-config-alist
5028 @vindex wl-draft-config-alist
5029 The initial setting is @code{nil}. Modifies the draft message just
5030 before the transmission. The content of @code{wl-draft-config-alist}
5031 will be automatically applied only once on the transmission. If you
5032 want to apply it manually, use @kbd{C-c C-e}. This command can be used
5035 @item wl-template-alist
5036 @vindex wl-template-alist
5037 The initial setting is @code{nil}.
5038 This variable specifies the template to be applied in the draft buffer.
5040 @item wl-draft-config-matchone
5041 @vindex wl-draft-config-matchone
5042 The initial setting is @code{nil}. If non-nil, only the first matching
5043 item is used when @code{wl-draft-config-alist} is applied. If
5044 @code{nil}, all matching items are used.
5046 @item wl-template-visible-select
5047 @vindex wl-template-visible-select
5048 The initial setting is @code{t}.
5049 If non-nil, you can preview the result of the template selection in
5052 @item wl-template-confirm
5053 @vindex wl-template-confirm
5054 The initial setting is @code{nil}.
5055 If non-nil, asks for confirmation when you press the enter key to select
5056 template while previewing.
5058 @item wl-template-buffer-lines
5059 @vindex wl-template-buffer-lines
5060 The initial setting is 7.
5061 If @code{wl-template-visible-select} is non-nil, this variable specifies
5062 the size of the preview window.
5064 @item wl-draft-buffer-style
5065 @vindex wl-draft-buffer-style
5066 The initial setting is @code{full}.
5067 Style of draft buffer window (except for replying and forwarding).
5068 @code{keep} is to use current window,
5069 @code{full} is to use full frame window,
5070 @code{split} is to split current window and use it.
5071 If some function is specified, it is called with the draft buffer
5074 @item wl-draft-reply-buffer-style
5075 @vindex wl-draft-reply-buffer-style
5076 The initial setting is @code{split}.
5077 Style of draft buffer for replying and forwarding.
5078 @code{keep} is to use message buffer window,
5079 @code{full} is to use full frame window,
5080 @code{split} is to split message buffer window and use it.
5081 If some function is specified, it is called with the draft buffer
5084 @item wl-draft-use-frame
5085 @vindex wl-draft-use-frame
5086 The initial setting is @code{nil}.
5087 If non-nil, use new frame for the draft.
5089 @item wl-draft-reply-default-position
5090 @vindex wl-draft-reply-default-position
5091 The initial setting is @code{body}.
5092 Specify initial cursor position on draft buffer for reply.
5093 @code{body} is to move cursor to the top of the message body,
5094 @code{bottom} to the bottom of the message body, and @code{top} to the
5097 @item wl-draft-truncate-lines
5098 @vindex wl-draft-truncate-lines
5099 The initial value is the value of @code{default-truncate-lines}.
5100 If it is non-nil, truncate long lines in draft buffer.
5104 The initial setting is the value of the variable
5105 @code{user-mail-address}. The value of this variable is inserted as a
5106 @samp{From:} field of the draft when it is prepared.
5108 @item wl-envelope-from
5109 @vindex wl-envelope-from
5110 The initial setting is @code{nil}.
5111 The value of this variable is used for envelope from (MAIL FROM).
5112 If @code{nil}, the address part of @code{wl-from} is used.
5114 @item wl-user-mail-address-list
5115 @vindex wl-user-mail-address-list
5116 The initial setting is @code{nil}.
5117 This is the User's address list. If you have multiple addresses,
5120 @item wl-reply-subject-prefix
5121 @vindex wl-reply-subject-prefix
5122 The initial setting is @samp{Re: }.
5123 In the @samp{Subject:} of the reply draft, this string is prepended to
5124 the @samp{Subject:} of being replied. You can specify a function to be
5125 message buffer of the reply target.
5127 @item wl-forward-subject-prefix
5128 @vindex wl-forward-subject-prefix
5129 The initial setting is @samp{Forward: }.
5130 In the @samp{Subject:} of the forwarding draft, this string is prepended
5131 to the @samp{Subject:} of being forwarded. You can specify a function
5132 to be message buffer of the forward target.
5134 @item wl-draft-reply-use-address-with-full-name
5135 @vindex wl-draft-reply-use-address-with-full-name
5136 The initial setting is @code{t}.
5137 If non-nil, insert her full name with address when prepare a draft for
5138 reply a message. If it is @code{nil}, insert her address only.
5140 @item wl-draft-enable-queuing
5141 @vindex wl-draft-enable-queuing
5142 The initial setting is @code{t}.
5143 This flag controls off-line transmission. If non-nil, the draft is
5146 @item wl-draft-use-cache
5147 @vindex wl-draft-use-cache
5148 The initial setting is @code{nil}. If the value is non-nil and
5149 @code{wl-insert-message-id} is nil, cache the message which is sent.
5151 @item wl-fcc-force-as-read
5152 @vindex wl-fcc-force-as-read
5153 The initial setting is @code{nil}. If the value is non-nil,
5154 Mark as read the message saved by @samp{Fcc:}.
5156 @item wl-auto-flush-queue
5157 @vindex wl-auto-flush-queue
5158 The initial setting is t.
5159 This flag controls automatic transmission of the queue when Wanderlust
5160 becomes on-line. If non-nil, the queue is automatically transmitted
5161 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5162 manually, press @kbd{F} in the folder mode.
5164 @item wl-ignored-forwarded-headers
5165 @vindex wl-ignored-forwarded-headers
5166 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
5167 All headers that match this regexp will be deleted when forwarding a message.
5169 @item wl-ignored-resent-headers
5170 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
5171 All headers that match this regexp will be deleted when resending a message.
5173 @item wl-draft-always-delete-myself
5174 @vindex wl-draft-always-delete-myself
5175 If non-nil, always removes your own address from @samp{To:} and
5176 @samp{Cc:} when you are replying to the mail addressed to you.
5178 @item wl-draft-delete-myself-from-bcc-fcc
5179 @vindex wl-draft-delete-myself-from-bcc-fcc
5180 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
5181 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
5183 @item wl-smtp-posting-server
5184 @vindex wl-smtp-posting-server
5185 The initial setting is @code{nil}.
5186 This is the SMTP server name for mail transmission.
5188 @item wl-smtp-posting-port
5189 @vindex wl-smtp-posting-port
5190 The initial setting is @code{nil}.
5191 This is the SMTP port number for mail transmission.
5192 If @code{nil}, default SMTP port number (25) is used.
5194 @item wl-smtp-posting-user
5195 @vindex wl-smtp-posting-user
5196 The initial setting is @code{nil}.
5197 This is the user name for SMTP AUTH authentication.
5199 @item wl-smtp-authenticate-type
5200 @vindex wl-smtp-authenticate-type
5201 The initial setting is @code{nil}.
5202 This string-valued variable specifies the authentication method for SMTP
5203 AUTH authentication. You may specify @code{plain}, @code{cram-md5},
5204 @code{digest-md5}, @code{login}, etc. If @code{nil}, authentication
5205 will not be carried out.
5207 @item wl-smtp-connection-type
5208 @vindex wl-smtp-connection-type
5209 The initial setting is @code{nil}.
5210 This symbol-valued variable specifies how to establish SMTP connections.
5211 If @code{nil}, use default connection type.
5212 If it is @code{starttls}, use STARTTLS (RFC2595).
5213 If it is @code{ssl}, use SSL.
5215 @item wl-nntp-posting-server
5216 @vindex wl-nntp-posting-server
5217 The initial setting is @code{nil}.
5218 This is the NNTP server name used for news submission.
5219 If @code{nil}, @code{elmo-nntp-default-server} is used.
5221 @item wl-nntp-posting-user
5222 @vindex wl-nntp-posting-user
5223 The initial setting is @code{nil}.
5224 This is the user name for AUTHINFO authentication on news submission.
5225 If @code{nil}, @code{elmo-nntp-default-user} is used.
5226 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
5228 @item wl-nntp-posting-port
5229 @vindex wl-nntp-posting-port
5230 The initial setting is @code{nil}.
5231 This is the port number of the NNTP server used for news submission.
5232 If @code{nil}, @code{elmo-nntp-default-server} is used.
5234 @item wl-nntp-posting-stream-type
5235 @vindex wl-nntp-posting-stream-type
5236 The initial setting is @code{nil}.
5237 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If @code{ssl},
5238 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
5239 connection will be established.
5241 @item wl-nntp-posting-function
5242 @vindex wl-nntp-posting-function
5243 The initial setting is @code{elmo-nntp-post}.
5244 This is the function to post NNTP message.
5246 @item wl-nntp-posting-config-alist
5247 @vindex wl-nntp-posting-config-alist
5248 The initial setting is @code{nil}.
5249 The value takes an alist to define NNTP server like following example.
5250 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
5254 (setq wl-nntp-posting-config-alist
5255 '((",?gmane\\." . "news.gmane.org")
5257 ((server . "news-server")
5258 (user . "newsmaster")
5260 (function . elmo-nntp-post)))
5261 (".*" . "default-news-server")))
5265 @item wl-pop-before-smtp-user
5266 @vindex wl-pop-before-smtp-user
5267 The initial setting is @code{nil}.
5268 This is the POP user name for POP-before-SMTP.
5269 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
5271 @item wl-pop-before-smtp-server
5272 @vindex wl-pop-before-smtp-server
5273 The initial setting is @code{nil}.
5274 This is the POP server name for POP-before-SMTP.
5275 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
5277 @item wl-pop-before-smtp-authenticate-type
5278 @vindex wl-pop-before-smtp-authenticate-type
5279 The initial setting is @code{nil}.
5280 This is the authentication method for POP-before-SMTP authentication.
5281 If it is @code{nil}, @code{elmo-pop3-default-authenticate-type} is used.
5283 @item wl-pop-before-smtp-port
5284 @vindex wl-pop-before-smtp-port
5285 The initial setting is @code{nil}.
5286 This is the POP port number for POP-before-SMTP. If it is @code{nil},
5287 @code{elmo-pop3-default-port} is used.
5289 @item wl-pop-before-smtp-stream-type
5290 @vindex wl-pop-before-smtp-stream-type
5291 The initial setting is @code{nil}.
5292 This flag controls the use of SSL for POP-before-SMTP. If it is
5293 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{ssl},
5294 SSL is used. If @code{starttls}, STARTTLS (RFC2595) connection will be
5297 @item wl-draft-queue-save-variables
5298 @vindex wl-draft-queue-save-variables
5299 Specifies a list of variable to which queued messages are saved on the
5300 off-line transmission.
5302 @item wl-draft-sendlog
5303 @vindex wl-draft-sendlog
5304 The initial setting is @code{t}.
5305 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
5309 @item drafts are sent by smtp or qmail
5310 @item saved into folders by fcc
5311 @item saved into folders by queuing
5314 (it is written even if the transmission fails).
5315 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
5316 and left to the logging function of @command{imput}.
5319 @item wl-draft-sendlog-max-size
5320 @vindex wl-draft-sendlog-max-size
5321 The initial setting is 20000 (in bytes).
5322 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
5323 beyond the size specified by this variable.
5327 The initial setting is @code{nil}.
5328 If non-nil, address completion uses LDAP.
5330 @item wl-ldap-server
5331 @vindex wl-ldap-server
5332 The initial setting is @samp{localhost}.
5333 LDAP server name for address completion.
5336 @vindex wl-ldap-port
5337 The initial setting is @code{nil}.
5338 If non-nil, the value is used as port number.
5341 @vindex wl-ldap-base
5342 The initial setting is @samp{c=US}.
5343 LDAP search starting point (base) for address completion.
5345 @item wl-draft-remove-group-list-contents
5346 @vindex wl-draft-remove-group-list-contents
5347 The initial setting is @code{t}.
5348 If non-nil, remove the group-lists' members in the recipients when
5349 sending the message (group-list means the description such as
5350 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5353 @node Disconnected Operations, Expire and Archive, Draft, Top
5354 @chapter Off-line Management
5355 @cindex Disconnected Operations
5357 Wanderlust has on-line and off-line states.
5360 * Off-line State:: Wanderlust has on-line and off-line states
5361 * Enable Operations:: Enable Disconnected Operations
5362 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5363 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5364 * Variables of Plugged Mode:: Customize Plugged Mode
5368 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5369 @section Off-line State
5371 Wanderlust has on-line and off-line states. In the off-line state, you
5372 cannot access messages via network, unless they are cached.
5374 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5375 in the mode line indicates the off-line state. In folder or summary
5376 modes, press @kbd{M-t} to switch between off- and on-line.
5378 You can invoke Wanderlust in the off-line state by setting
5379 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5381 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5382 ignores uncached messages.
5385 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5386 @section Enable Disconeected Operations
5388 Even in the off-line state, provided that relevant messages are cached,
5389 and the variable @code{elmo-enable-disconnected-operation} (described
5390 later) is non-nil, you can following operations:
5391 @xref{Plugged Mode}, @xref{Off-line State settings}.
5394 * Send Messages off-line:: Transmit Messages
5395 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5396 * Creation of Folders:: Create Folders off-line (IMAP4)
5397 * Marking:: Mark (IMAP4)
5398 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
5401 As soon as Wanderlust becomes on-line, such operations invoked off-line
5402 are reflected in the servers via network.
5405 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5406 @subsection Transmission of Messages
5408 You can proceed sending operation for mail/news messages while you are
5409 off-line, then it will be reserved for sending (if you are using
5410 @file{im-wl.el}, it is irrelevant).
5411 Messages reserved for sending while off-line are accumulated in the
5412 queue folder, @samp{+queue}. These messages are transmitted at once when
5413 Wanderlust becomes on-line.
5415 You can visit @samp{+queue} in the off-line state and confirm content of
5416 messages in the queue. You can also remove messages. Removed messages
5417 are not transmitted even in the on-line state.
5420 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5421 @subsection Re-file and Copy (IMAP4)
5423 Re-file and copy operations to IMAP folders invoked during the off-line
5424 state are accumulated in the queue, and reflected in the server side
5425 when Wanderlust becomes on-line. If you visit destination folders after
5426 off-line re-file or copy, it looks as if messages were appended even in
5429 For the safety reasons, messages re-filed off-line are removed from
5430 source folders only if their @samp{Message-ID:} match messages on the
5431 servers. While the queue is processed, messages that failed to be
5432 re-filed or copied to the specified folders are appended to the folder
5436 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5437 @subsection Creation of Folders (IMAP4)
5439 You can create IMAP folders off-line. The creation of folders are
5440 reflected in the servers when Wanderlust becomes on-line. If the creation
5441 of those folders fails at that time for some reasons, messages
5442 to be re-filed into those are appended to the folder @samp{+lost+found}
5446 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5447 @subsection Marking (IMAP4)
5449 Off-line changes in unread/read and importance mark @samp{$} information
5450 are also reflected in the servers when Wanderlust becomes on-line.
5453 @node Pre-fetching Reservations, , Marking, Enable Operations
5454 @subsection Pre-fetching (IMAP4, NNTP)
5456 You can make reservations for pre-fetching messages in IMAP or NNTP
5457 folders. Reserved messages are marked with @samp{!} but not cached
5458 yet. When Wanderlust becomes on-line, they are pre-fetched from
5461 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5462 these off-line operations for IMAP4 and NNTP do not take place, and
5463 off-line re-file, copy or suchlike simply results in error.
5465 Because off-line operations use cache files, it is a bad idea to erase
5466 them by hand; it may cause Wanderlust to malfunction.
5468 If you want to remove caches, be sure to execute @kbd{M-x
5469 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5470 remove caches for messages relevant to off-line operations.
5473 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5474 @section Switching On-line/Off-line per Server/Port
5476 @kbd{M-t} described above switches networking states as a whole, but you
5477 can switch on-line/off-line per server/port.
5479 Pressing @kbd{C-t} in the folder or summary modes brings you in
5480 wl-plugged-mode shown below, in which you can change the plugged state
5485 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5488 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5489 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5491 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5492 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5498 The first line indicates status of the following three variables, and
5499 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5500 column modifies the values of these variables.
5504 "Queuing" @code{wl-draft-enable-queuing}
5505 "AutoFlushQueue" @code{wl-auto-flush-queue}
5506 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5510 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5513 The second and after lines indicate on-line/off-line states of servers
5514 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5515 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5516 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5518 @dfn{sending queue} means messages accumulated in the folder
5519 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5520 off-line operations when @code{elmo-enable-disconnected-operation} is
5522 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5523 @c off-line operations are enabled.
5525 They are displayed if there are any of them. In the example above, in
5526 the sending queue there are two messages (the first and the second in
5527 the queue folder) for smtp to hosta and one (the third) for nntp to
5528 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5531 If you change @samp{(wl-plugged)} in the second line, the variable
5532 @code{wl-plugged} is changed, so that the mode line indicator and
5533 plugged states of all ports are affected. If you change plugged states
5534 of any servers or ports, @samp{(wl-plugged)} in the second line is
5535 affected depending on @code{elmo-plugged-condition} settings and the
5536 plugged state of each port.
5539 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5540 @section Invoking Wanderlust in the Off-line State
5542 As described before, if you set @code{wl-plugged} to @code{nil} in
5543 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5544 off-line state. You can specify off-line state on a per server or port
5545 basis. Refer to @code{wl-reset-plugged-alist} also.
5547 Usually, when Wanderlust starts up, the plugged state of each port is
5548 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5549 @code{wl-nntp-posting-server} and so on. If you want to change the
5550 plugged state of these ports or to add other ports, configure
5551 @code{wl-make-plugged-hook} with a function.
5555 (add-hook 'wl-make-plugged-hook
5557 (elmo-set-plugged plugged-value(t/nil) server port)
5558 ;; @r{add or change plugged states of the port of the server}
5559 (elmo-set-plugged plugged-value(t/nil) server)
5560 ;; @r{if the port is omitted, all ports are affected}
5561 ;; @r{(you cannot omit the port if you newly add the server)}
5567 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5568 @section Customizable Variables
5573 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5574 mode from the beginning.
5576 @item wl-queue-folder
5577 @vindex wl-queue-folder
5578 The initial setting is @samp{+queue}.
5579 This is the folder in which messages in the transmission queue are
5582 @item wl-auto-flush-queue
5583 @vindex wl-auto-flush-queue
5584 The initial setting is @code{t}.
5585 This flag controls automatic transmission of the queue when Wanderlust
5586 becomes on-line. If non-nil, the queue is automatically transmitted
5587 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5588 manually, press @kbd{F} in the folder mode.
5590 @item elmo-enable-disconnected-operation
5591 @vindex elmo-enable-disconnected-operation
5592 The initial setting is @code{t}. Controls off-line operations
5593 regarding IMAP4. If non-nil, off-line operations are carried out.
5595 @item elmo-lost+found-folder
5596 @vindex elmo-lost+found-folder
5597 The initial setting is @samp{+lost+found}.
5598 This is the folder to which messages are saved when they fails to be
5599 appended while the off-line re-file/copy queue is processed.
5601 @item elmo-plugged-condition
5602 @vindex elmo-plugged-condition
5603 The initial setting is @code{one}.
5604 The value of @code{wl-plugged} reflects the return value of the function
5605 @code{elmo-plugged-p} (without arguments).
5606 This variable @code{elmo-plugged-condition} specifies the condition on
5607 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5608 plugged state of each port.
5611 'one : plugged if one or more ports are plugged.
5612 'all : plugged if all ports are plugged.
5613 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5614 states of the ports.
5615 @var{function} : reflects the return value of the @var{function}
5616 functions available per default
5617 'elmo-plug-on-by-servers
5618 : reflects the plugged state of the servers specified by the
5619 variable elmo-plug-on-servers.
5620 'elmo-plug-on-by-exclude-servers
5621 : reflects the plugged state of the servers that are not
5622 in elmo-plug-on-exclude-servers.
5623 elmo-plug-on-exclude-servers defaults to
5626 (system-name)without the domain part)
5632 (setq elmo-plugged-condition 'all)
5634 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5635 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5637 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5638 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5642 @item wl-reset-plugged-alist
5643 @vindex wl-reset-plugged-alist
5644 The initial setting is @code{t}. If non-nil, plugged states are
5645 initialized on a per server or port basis when Wanderlust starts up.
5647 If @code{nil}, plugged states are retained while Emacs is running. In
5648 other words, they are initialized when Emacs is restarted even if the
5649 value is @code{nil}.
5653 @node Expire and Archive, Scoring, Disconnected Operations, Top
5654 @chapter Automatic Expiration and Archiving of Messages
5655 @cindex Expire and Archive
5658 * Expire:: Expiration and Archiving
5659 * Archive:: Archiving All Messages
5663 @node Expire, Archive, Expire and Archive, Expire and Archive
5665 @cindex Expire Message
5667 Expiration means deletion of old messages which have outlasted a
5668 certain period of time.
5670 @code{wl-expire} supports not only simple deletion, but also moving to
5671 specified archiving folders.
5675 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5676 or @kbd{M-e} in the summary mode.
5678 @subsection Configuring @code{wl-expire-alist}
5680 An example configuration of @code{wl-expire-alist} is shown below.
5681 Everything in this @code{wl-expire-alist} makes a great difference in
5682 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5683 to @code{t}, especially in the initial stage.
5687 (setq wl-expire-alist
5688 '(("^\\+trash$" (date 14) remove)
5690 ("^\\+tmp$" (date 7) trash)
5691 ;; @r{re-file to @code{wl-trash-folder}}
5692 ("^\\+outbox$" (number 300) "$outbox;lha")
5693 ;; @r{re-file to the specific folder}
5695 ;; @r{do not expire}
5696 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5697 ;; @r{archive by message number (retaining numbers)}
5698 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5699 ;; @r{archive by a fixed number (retaining numbers)}
5700 ("^\\+diary$" (date 30) wl-expire-archive-date)
5701 ;; @r{archive by year and month (numbers discarded)}
5706 Items in the list has the format of:
5709 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5713 The folder is examined if it matches @var{regexp-for-folders} from the
5714 beginning of the list. If you invoke expiration on the folder that does
5715 not match any of them, nothing will happen. And if either the second or
5716 the third element of the item is @code{nil}, expiration will not take
5719 You can use any one of the following for
5720 @var{specification-of-message-to-be-deleted}:
5723 @item (number @var{n1} [@var{n2}])
5724 deletes messages depending on the number of messages in the folder.
5726 @var{n1} is the number of messages which should survive deletion, for example
5727 if its value is 500, the newest 500 messages survive and the rests are
5730 @var{n2} is the number of messages in the folder on which expiration should
5731 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5732 folders with 510 or more messages are expired.
5733 If you configured automatic expiration, frequently used folders may
5734 expire every time it receive messages, and you may be annoyed with the
5735 long delay in reading mail.
5736 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5737 expiration would not take place until a certain number of messages
5740 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5741 with important/new/unread) are not deleted.
5742 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5743 will expire so as to have 500 messages including such ones.
5744 Otherwise, it will have 500 messages except such ones.
5746 @item (date @var{d1})
5747 deletes messages depending on the dates.
5749 Messages dated @var{d1} or more days ago are deleted, for example if its
5750 value is seven, messages seven days old or more are deleted. Note that
5751 the date is the one in the @samp{Date:} field of the message, not when
5752 the message entered the folder.
5754 Messages with no or invalid @samp{Date:} field does not expire; you
5755 might have to delete them by hand.
5758 You can use any one of the following in the place of @var{destination}:
5762 deletes the messages instantly.
5765 hide the messages from summary (messages are not deleted).
5768 moves the messages to @code{wl-trash-folder}.
5770 @item @var{string}(folder)
5771 moves the messages to the folder specified with @var{string}.
5773 It would be useful for specifying an archiving folder, but because this
5774 does not move important messages, it might be better to use the
5775 standard functions described below.
5777 @item @var{function}
5778 invokes the specified @var{function}.
5780 To the @var{function}, three arguments are passed: a folder name, a list
5781 of messages to be deleted, and msgdb information of the summary. You
5782 can specify function-specific arguments after the name of the
5783 @var{function}. Note that the list contains messages with marks in
5784 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5787 These are four standard functions; three of them move messages to an archive
5788 folder in the specified way. This means old messages can be compressed
5789 and saved in a file, being deleted from the original folder.
5790 The last one divides messages to some MH folders.
5793 @item wl-expire-archive-number1
5794 re-files to archiving folders corresponding to the message numbers of
5795 the messages being deleted. For example, a message numbered 102 will be
5796 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5797 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5798 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5800 The archiving folders to which messages are re-filed are determined by
5801 the name of the folder as follows (in this case, archiving folders are
5802 handled as if @code{elmo-archive-treat-file} were non-nil).
5805 @item If the folder type is localdir:
5806 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5808 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5809 (@file{~/Mail/ml/wl-00100.zip}).
5811 @item The folder type is other than localdir:
5812 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5814 For example, @samp{%#mh/ml/wl} corresponds to
5815 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5818 As you can see, in the case of localdir, the folder type is not included
5819 in the path name, but otherwise it is included.
5820 And you can control the prefix to the archiving folder name by
5821 @code{wl-expire-archive-folder-prefix}.
5822 Refer to @code{wl-expire-archive-folder-prefix} for details.
5824 @item wl-expire-archive-number2
5825 re-files every certain number of messages to archiving folders.
5827 This differs from @samp{wl-expire-archive-number1} in that this re-files
5828 to the folder up to the specified number regardless of message numbers.
5829 The archiving folders to which messages are re-filed are determined in the
5830 same way as @code{wl-expire-archive-number1}.
5832 @item wl-expire-archive-date
5833 re-files messages depending on its date (year and month) to archive
5836 For example, a message dated December 1998 is re-filed to
5837 @code{$folder-199812;zip}. The name of the archiving folders except the
5838 date part are determined in the same way as
5839 @code{wl-expire-archive-number1}.
5842 You can set the first argument to these three standard functions to non-nil
5843 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5844 For example, it can be specified just after the name of the function:
5847 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5850 If you omit the argument, consecutive numbers from 1 are assigned for
5851 each archiving folder.
5853 @item wl-expire-localdir-date
5854 divedes messages depending on its date (year and month) to MH folders
5855 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5859 @subsection Treatment for Important or Unread Messages
5861 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5862 standard function, messages with marks in
5863 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5864 messages} thereafter) are retained.
5866 Per default, this variable include the important, new, and unread marks,
5867 so that messages with these marks are not removed.
5868 Note that you cannot include the temporary mark (i.e. temporary marks
5869 are removed anyway), and be sure to process temporary marks before you
5872 @subsection Auto Expiration
5874 The following setup invokes expiration when you move into the summary
5875 mode. There will be no confirmation, so make sure you made no mistake
5876 in regexp and other settings before you set up this.
5880 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5884 In the folder mode, you can invoke expiration per group as well as per
5885 folder. Therefore, if you specify @samp{Desktop} group, all folders
5886 matching @code{wl-expire-alist} expire.
5890 @subsection Treating archive folders.
5891 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5892 you must set non-nil value to @code{elmo-archive-treat-file}.
5894 @subsection Confirming
5896 If you are to use @code{remove}, try @code{trash} at first and see
5897 messages move to @code{wl-trash-folder} as expected, then replace it
5898 with @code{remove}. It would be dangerous to use @code{remove} from the
5901 If you are to use @code{wl-expire-archive-number1} and the like, try to
5902 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5903 you can append messages to it. Even if settings in
5904 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5905 would not be saved anywhere and disappeared in case the archiver program
5908 After you make sure you can archive to the folder correctly, you can
5909 invoke expiration and utilize the log.
5911 If you set @code{wl-expire-use-log} to @code{t},
5912 @file{~/.elmo/expired-log} should contain the log, for example:
5916 delete +ml/wl (593 594 595 596 597 598 599)
5917 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5921 The first column indicates the operation, i.e. @samp{delete},
5922 @samp{copy}, or @samp{move}. The next is the name of the folder that
5923 expired. In the case of @samp{copy} and @samp{move}, the destination
5924 folder is recorded after @samp{->}. The last is the list of message
5925 numbers that are actually deleted or moved (in the case of @samp{copy}
5926 and @samp{move}, the number is the one in the source folder, rather than
5927 the destination folder).
5929 @subsection Re-filing Reserved Messages
5931 The three standard functions copy reserved messages to the archive
5932 folder, but do not delete them from the source folder. Because
5933 reserved messages and the like always remain, they are recorded in
5934 @file{~/.elmo/expired-alist} so that they are not copied over and over
5935 again. They are not recorded if copied by @code{wl-summary-archive}.
5937 If you enabled logging, usually @samp{move} is recorded for re-filing,
5938 but instead @samp{copy} and @samp{delete} are recorded separately if
5939 reserved messages are involved. This is because it actually copies
5940 messages including reserved, then deletes ones except reserved in that
5943 @section Customizable Variables
5946 @item wl-expire-alist
5947 @vindex wl-expire-alist
5948 The initial setting is @code{nil}.
5949 This variable specifies folders and methods to expire. For details,
5950 refer to @code{wl-expire-alist} settings above.
5952 @item wl-summary-expire-reserve-marks
5953 @vindex wl-summary-expire-reserve-marks
5954 The initial setting is the list below.
5958 (list wl-summary-important-mark
5959 wl-summary-new-uncached-mark
5960 wl-summary-new-cached-mark
5961 wl-summary-unread-mark
5962 wl-summary-unread-uncached-mark
5963 wl-summary-unread-cached-mark)
5967 Messages with these marks are retained in the folder, even after
5969 Only permanent marks can be listed, not temporary marks.
5971 You can list marks one by one as in the default; you can use the
5972 following settings as well:
5976 All messages with permanent marks are retained,
5977 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5981 All messages are handled as usual ones that are already read, no matter
5982 what marks they have; even important messages are deleted.
5985 @item wl-expire-archive-files
5986 @vindex wl-expire-archive-files
5987 The initial setting is 100.
5988 This variable specifies the number of messages to be retained in one
5991 @item wl-expire-number-with-reserve-marks
5992 @vindex wl-expire-number-with-reserve-marks
5993 The initial setting is @code{nil}.
5994 If non-nil, if expiring messages are specified by @code{number},
5995 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5997 @item wl-expire-archive-get-folder-function
5998 @vindex wl-expire-archive-get-folder-function
5999 The initial setting is @code{wl-expire-archive-get-folder}.
6001 This variable specifies a function that returns the name of an archiving
6002 folder for standard functions in the place of @var{destination}.
6003 You can use the following three variables for simple modification of
6004 folder names; if you want more complex settings, define your own
6005 function in this variable.
6007 @code{wl-expire-archive-get-folder} can be customized by these
6010 @item @code{wl-expire-archive-folder-name-fmt}
6011 @item @code{wl-expire-archive-folder-type}
6012 @item @code{wl-expire-archive-folder-prefix}
6015 @item wl-expire-archive-folder-name-fmt
6016 @vindex wl-expire-archive-folder-name-fmt
6017 The initial setting is @samp{%s-%%05d;%s}.
6018 This is a @code{format} string for archiving folders used in
6019 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
6020 Note that you must specify the message number by @samp{%%d}, because it
6021 is parsed twice by @code{format}.
6023 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
6026 @item wl-expire-archive-date-folder-name-fmt
6027 @vindex wl-expire-archive-date-folder-name-fmt
6028 The initial setting is @samp{%s-%%04d%%02d;%s}.
6029 This is a @code{format} string for archiving folders used in
6030 @code{wl-expire-archive-date}. Note that you must specify the message
6031 number by @samp{%%d}, because it is parsed twice by @code{format}.
6032 There should be @samp{%%d} twice, one for the year and the other for the
6035 If you modify this, adjust
6036 @code{wl-expire-archive-date-folder-num-regexp} as well.
6038 @item wl-expire-archive-folder-type
6039 @vindex wl-expire-archive-folder-type
6040 The initial setting is @code{zip}.
6041 This variable specifies an archiver type of the archiving folders.
6043 @item wl-expire-archive-folder-prefix
6044 @vindex wl-expire-archive-folder-prefix
6045 The initial setting is @code{nil}.
6046 This variable specifies the prefix (directory structure) to archiving
6048 Exercise extreme caution in using this feature, as it has not been
6050 In the worst case, there is a fear of destructing archiving folders.
6054 There will be no prefix.
6057 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
6058 @samp{$ml/wl-00000;zip;wl}.
6061 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
6064 @samp{$ml/wl-00000;zip;ml/wl}.
6067 @item wl-expire-archive-folder-num-regexp
6068 @vindex wl-expire-archive-folder-num-regexp
6069 The initial setting is @samp{-\\([-0-9]+\\);}.
6070 This variable specifies the regular expression to be used for getting
6071 message numbers from multiple archiving folders specified by
6072 @code{elmo-list-folders}.
6073 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
6075 @item wl-expire-archive-date-folder-num-regexp
6076 @vindex wl-expire-archive-date-folder-num-regexp
6077 The initial setting is @samp{-\\([-0-9]+\\);}.
6078 This is the regular expression to be used for getting message numbers
6079 from multiple archiving folders specified by @code{elmo-list-folders}.
6080 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
6082 @item wl-expire-delete-oldmsg-confirm
6083 @vindex wl-expire-delete-oldmsg-confirm
6084 The initial setting is @code{t}.
6085 If non-nil, messages older than the one with the largest number will be
6086 deleted with confirmation.
6087 If @code{nil}, they are deleted without confirmation.
6089 This feature is valid only if non-nil is specified as a argument to the
6090 standard functions so as to retain numbers.
6092 @item wl-expire-use-log
6093 @vindex wl-expire-use-log
6094 The initial setting is @code{nil}.
6095 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
6096 They are appended but not truncated or rotated automatically; you might
6097 need to remove it manually.
6099 @item wl-expire-add-seen-list
6100 @vindex wl-expire-add-seen-list
6101 The initial setting is @code{t}.
6103 If non-nil, when messages are re-filed by expiration, read/unread
6104 information is passed to the destination folder.
6106 However if you do not read the destination folder from Wanderlust,
6107 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
6108 want to set this to @code{nil} if you are simply saving to some
6109 archiving folders. Even if its value is @code{nil}, messages in the
6110 archiving folders are simply treated as unread; it does not affect
6113 @item wl-expire-folder-update-msgdb
6114 @vindex wl-expire-folder-update-msgdb
6115 The initial setting is @code{t}.
6116 If @code{t}, in the folder mode, expiration is carried out after
6117 updating summary information. If you specified a list of regular
6118 expressions of folder names, summary information is updated for matching
6123 @node Archive, , Expire, Expire and Archive
6124 @section Archiving Messages
6126 @subsection Archiving Messages
6127 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
6128 folders. If there are the archiving folders already, only new messages
6131 You can use @code{wl-archive-alist} in order to specify how messages are
6132 archived according to their folder names, as in @code{wl-expire-alist}.
6137 (setq wl-archive-alist
6138 '(("^\\+tmp$" wl-archive-date)
6139 ("^\\+outbox$" wl-archive-number2)
6140 (".*" wl-archive-number1)))
6144 Each item in the list has the following format:
6147 (@var{folders-regexp} @var{deleting-function})
6150 As you can see, you can only use a function after @var{folders-regexp}.
6151 Per default, there are three functions:
6154 @item @code{wl-archive-number1}
6155 @item @code{wl-archive-number2}
6156 @item @code{wl-archive-date}
6159 As inferred from their names, they work similarly to "expire" versions,
6160 other than the following points:
6163 @item No messages are deleted
6164 @item Message numbers are retained even if invoked without arguments
6167 These functions are good to archive all messages in a folder by their
6168 numbers or by their dates.
6169 These are also useful for backup or confirmation purposes before
6171 If you try to re-file them after they are archived, they are deleted but
6174 Per default, the archiving folders to which messages are copied are
6175 determined automatically by @code{wl-expire-archive-get-folder-function}.
6176 You can copy to a specific folder by invoking with a prefix argument,
6177 i.e. @kbd{C-u M-x wl-summary-archive}.
6179 Note that this feature has not been seriously tested, because you can
6180 simply copy to an archiving folder, for example by
6181 @code{wl-summary-copy-region}.
6183 The archiving folders are determined by the same logic as in
6184 @code{wl-summary-expire}; the following customizable variables are
6188 @item @code{wl-expire-archive-files}
6189 @item @code{wl-expire-archive-get-folder-function}
6190 @item @code{wl-expire-archive-folder-name-fmt}
6191 @item @code{wl-expire-archive-folder-type}
6192 @item @code{wl-expire-archive-folder-prefix}
6193 @item @code{wl-expire-archive-folder-num-regexp}
6196 @subsection Customizable Variables
6199 @item wl-archive-alist
6200 @vindex wl-archive-alist
6201 The initial setting is the list shown below:
6205 ((".*" wl-archive-number1))
6210 This variable specifies a function that copies to archiving folders.
6211 To the function, three arguments are passed: a folder name, a list of
6212 messages in the folder, and msgdb information of the summary.
6213 Needless to say, you can use your own function.
6217 @node Scoring, Address Book, Expire and Archive, Top
6218 @chapter Score of the Messages
6220 @c @cindex Kill File
6222 Scoring is the function that associates a score (value) with each
6223 message, and marks as read or deletes from the summary according to it.
6225 You can put target or important marks on essential messages, or read marks
6226 on the ones you do not want to read, for example spam articles.
6228 This scoring function has a capability and a format similar to the one
6229 that Gnus has, although there are some unsupported features and
6230 Wanderlust specifics.
6231 @xref{Scoring, , ,gnus, The gnus Newsreader}.
6234 * Score Commands:: Score Commands
6235 * Score File Format:: Score File Format
6239 @node Score Commands, Score File Format, Scoring, Scoring
6240 @section Score Commands
6241 @cindex Score Commands
6243 @subsection Score File Specification
6245 @code{wl-score-folder-alist} specifies score files or variables in which
6246 scores are defined, corresponding to folder names.
6250 (setq wl-score-folder-alist
6259 If paths to the score files are omitted, the directory specified in the
6260 variable @code{wl-score-files-directory} is assumed.
6262 No matter what you write in @code{wl-score-folder-alist}, the default
6263 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
6264 read (it does not have to exist).
6265 Therefore, in the example above, the three score files,
6266 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
6267 the folders that matches @samp{^-.*}.
6269 @subsection Scored Messages
6271 Scores are attached to the messages that are specified by
6272 @code{wl-summary-score-marks} temporarily when the summary is updated;
6273 when you exit from the summary, the scores are removed and reverts to
6276 @subsection Creation of Score Files
6278 In the summary buffer, move to an appropriate message and type @kbd{L}.
6279 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
6280 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
6282 This makes @minus{}1000 are scored for messages with the same
6283 @samp{Subject:} as the string you entered. That is, such a score file
6284 is created automatically.
6286 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
6287 The score file you just made appears.
6288 This buffer is called @dfn{score editing buffer} thereafter.
6289 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
6290 as you are previously; type @kbd{a}. Then a score entry for "From"
6292 In this way, you can create a score file easily either in the summary
6293 buffer or in the score editing buffer.
6295 By the way, you might be aware the numbers of key strokes are different
6296 between @kbd{s s p} and @kbd{a}.
6297 This is determined by @code{wl-score-header-default-entry}.
6298 This variable specifies the default score entries corresponding to
6300 For example, for "subject" field, a type and a time limit are prompted,
6301 but for "from" field, they are fixed upon automatically as substring and
6302 permanent respectively.
6303 However, score values can be modified by the prefix argument.
6304 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
6307 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
6308 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
6309 erasing contents of the buffer deletes the score file being edited.
6313 @subsubsection Selecting Score Files
6315 You can change score files to which scores are appended by
6316 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
6317 @code{wl-score-change-score-file}.
6319 @subsubsection Summing Up the Score
6321 If you add the same entries by @code{wl-summary-increase-score},
6322 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
6323 scores for the entry is summed up.
6325 For example, if you create @samp{from} entry with the score of @minus{}1000 by
6326 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
6327 @minus{}1200 will be created as a result.
6329 @subsubsection Creating Thread Key
6331 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
6332 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6334 @subsubsection Creating Followup Key
6336 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6337 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6338 at the cursor to @samp{References} key.
6339 If @code{wl-score-auto-make-followup-entry} is non-nil,
6340 @samp{Message-ID} of all messages to be followed up within dates
6341 specified by @code{wl-score-expiry-days}.
6343 @subsection Key Bindings
6348 @findex wl-summary-increase-score
6349 Increases the score for the current message.
6350 And the score entry is appended to the score file at the same moment.
6351 You can specify the score value by a prefix argument.
6355 @findex wl-summary-lower-score
6356 Decreases the score for the current message.
6357 And the score entry is appended to the score file at the same moment.
6358 You can specify the score value by a prefix argument.
6361 @kindex h R (Summary)
6362 @findex wl-summary-rescore
6363 Re-applies the scoring.
6364 However, already scored messages are not scored anew.
6367 @kindex h c (Summary)
6368 @findex wl-score-change-score-file
6369 Changes the score file currently selected.
6372 @kindex h e (Summary)
6373 @findex wl-score-edit-current-scores
6374 Edits the score file currently selected.
6375 If there are multiple score files, the previously specified one is
6379 @kindex h f (Summary)
6380 @findex wl-score-edit-file
6381 Edits an arbitrary score file and selects it.
6384 @kindex h F (Summary)
6385 @findex wl-score-flush-cache
6386 Erases caches associated to the score files that are read.
6387 If you modified score files directly (from other than Wanderlust), you
6388 need to re-read them after erasing the cache.
6391 @kindex h m (Summary)
6392 @findex wl-score-set-mark-below
6393 Specifies the criterion for scores to be marked as read.
6394 Messages with scores less than this value are marked as read.
6397 @kindex h x (Summary)
6398 @findex wl-score-set-expunge-below
6399 Specifies the criterion for scores to be deleted from the summary.
6400 Messages with scores less than this value are deleted.
6401 "Deleted" means it is not shown; they are not removed from the summary
6402 information or the folder.
6403 The deleted messages can be shown by rescan-noscore again.
6406 @subsection Key Bindings in the Score Editing Buffer
6410 @kindex C-c C-k (Score Mode)
6411 @findex wl-score-edit-kill
6412 Abandons the file being edited.
6415 @kindex C-c C-c (Score Mode)
6416 @findex wl-score-edit-exit
6417 Saves the file being edited, and quits from the edit mode.
6420 @kindex C-c C-p (Score Mode)
6421 @findex wl-score-pretty-print
6425 @kindex C-c C-d (Score Mode)
6426 @findex wl-score-edit-insert-date
6427 Inserts the number of dates from Dec. 31, 1 B.C.
6428 It is used for creating the third factor of time-limited scores.
6431 @kindex C-c C-s (Score Mode)
6432 @findex wl-score-edit-insert-header
6433 Inserts the header of the message selected in the summary buffer.
6436 @kindex C-c C-e (Score Mode)
6437 @findex wl-score-edit-insert-entry
6438 Inserts the score entry of the message selected in the summary buffer.
6441 @subsection Customizable Variables
6444 @item wl-summary-default-score
6445 @vindex wl-summary-default-score
6446 The initial setting is 0 (zero).
6447 This variable specifies the default value of the score.
6448 The score is increased or decreased based upon this value.
6450 @item wl-summary-important-above
6451 @vindex wl-summary-important-above
6452 The initial setting is @code{nil}.
6453 Messages with scores larger than this value are attached with the
6454 important mark (@samp{$}).
6455 If @code{nil}, no important marks are attached.
6457 @item wl-summary-target-above
6458 @vindex wl-summary-target-above
6459 The initial setting is @code{nil}.
6460 Messages with scores larger than this value are attached with the target
6462 If @code{nil}, no target marks are attached.
6464 @item wl-summary-mark-below
6465 @vindex wl-summary-mark-below
6466 The initial setting is 0 (zero).
6467 Messages with scores smaller than this value are marked as read.
6469 @item wl-summary-expunge-below
6470 @vindex wl-summary-expunge-below
6471 The initial setting is @code{nil}.
6472 Messages with scores smaller than this value are deleted from the
6474 If @code{nil}, they are not deleted.
6476 @item wl-summary-score-marks
6477 @vindex wl-summary-score-marks
6478 The initial setting is the list shown below:
6482 (list wl-summary-new-uncached-mark
6483 wl-summary-new-cached-mark)
6488 Messages with these marks are scored.
6490 @item wl-use-scoring
6491 @vindex wl-use-scoring
6492 The initial setting is t.
6493 If non-nil, scoring is enabled.
6495 @item wl-score-files-directory
6496 @vindex wl-score-files-directory
6497 The initial setting is @file{~/.elmo/}.
6498 The default directory for score files.
6500 @item wl-score-interactive-default-score
6501 @vindex wl-score-interactive-default-score
6502 The initial setting is 1000.
6503 This value is used as a score when a score factor is @code{nil} in the
6504 score file. It is also used in @code{wl-summary-increase-score} and
6505 @code{wl-summary-lower-score}, on condition that the value of
6506 @code{wl-score-header-default-entry} is @code{nil}.
6508 @item wl-score-expiry-days
6509 @vindex wl-score-expiry-days
6510 The initial setting is 7.
6511 This is the number of days before time-limited scores are deleted.
6513 @item wl-score-update-entry-dates
6514 @vindex wl-score-update-entry-dates
6515 The initial setting is @code{t}.
6516 If non-nil, it enables deletion of time-limited scores.
6518 @item wl-score-header-default-entry
6519 @vindex wl-score-header-default-entry
6520 Specifies the default value for each header field for score entries
6521 created by @code{wl-summary-increase-score},
6522 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6524 @item wl-score-simplify-fuzzy-regexp
6525 @vindex wl-score-simplify-fuzzy-regexp
6526 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6527 regular expression to be deleted from the string.
6528 Because this is usually used for Subject, the default is prefixes that
6529 are attached by mailing list programs.
6531 @item wl-summary-rescore-partial-threshold
6532 @vindex wl-summary-rescore-partial-threshold
6533 The initial setting is 200.
6534 When sync-all or rescan is executed, if there are messages more than
6535 this value, only the last same number of messages as this value are
6538 @item wl-summary-auto-sync-marks
6539 @vindex wl-summary-auto-sync-marks
6540 If non-nil, unread/important marks are synchronized when the summary
6542 Unread marks reflect information on the IMAP4 server.
6543 Important marks reflect information on the IMAP4 server (flagged or
6544 not), and contents of @samp{'flag} folder.
6545 The initial setting is @code{t}.
6549 @node Score File Format, , Score Commands, Scoring
6550 @section Score File Format
6551 @cindex Score File Format
6553 The format of score files are the same as Gnus, and basically you can
6554 use Gnus score files as they are. But they are not fully compatible
6555 because some keys are not supported and there are Wanderlust specifics.
6556 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6561 ("for sale" -1000 nil s)
6562 ("profit" -1000 nil s))
6564 ("spam@@spamspamspam" -10000 nil s))
6566 ("my@@address" 3001 nil s))
6568 (1000000 -10 nil >))
6578 If the key is a string, it is the name of the header to be matched.
6579 The following keys are available:
6580 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6581 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6582 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6583 @code{Chars} and @code{Lines} mean the size and the number of lines of
6584 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6585 are described later.
6586 The rest corresponds the field of the same name.
6588 Arbitrary numbers of core entries are specified after the key.
6589 Each score entry consists of these five factors:
6593 A factor that matches header. This should be a number in the cases of
6594 @code{lines} and @code{chars}, otherwise a string.
6597 A score factor. When the first item matches, the score of the message
6598 is increased or decreased by this value.
6601 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6602 of a number, the score is deleted if it does not match for days
6603 (@code{wl-score-expiry-days}) from the date specified by this.
6604 The date is since Dec. 31, 1 B.C.
6607 A type factor. This specifies the way the first factor matches.
6608 Available types depend on keys.
6611 @item From, Subject, References, Message-ID
6612 For these keys in string, @code{r} and @code{R} (regexp),
6613 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6614 as well as @code{f} and @code{F} (fuzzy) can be used.
6615 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6618 For these keys, the following five numerical relative operators can be
6619 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6622 This key matches @code{From} header, and scores all follow-ups to the
6624 For example, it would be useful for increasing scores for follow-ups to
6627 You can use the same types as @code{From} except for @code{f}.
6628 And a @samp{Followup} entry is automatically appended to the score file.
6631 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6632 A @samp{Thread} entry is automatically appended for each article that
6633 has @var{x} in the @code{References} header.
6634 You can make sure the whole thread including messages that does not have
6635 all ancestors @code{Message-ID} in @code{References} is scored.
6637 You can use the same types as @code{References} except for @code{f}.
6638 And a @samp{Thread} entry is automatically appended to the score file.
6642 A factor for extension header. This is meaningful only if the key is
6644 This specifies headers to be matched other than standard headers like
6645 @code{Subject} and @code{From}.
6646 Note that you should specify the header in
6647 @code{elmo-msgdb-extra-fields} also.
6648 Therefore it does not work in folders where extension headers cannot be
6653 The sum of these scores @emph{after all factors are applied} becomes the
6654 score of the message.
6656 @cindex Score File Atoms
6658 Messages with a score less than this value is marked as read.
6659 The default is @code{wl-summary-mark-below}.
6662 Messages with a score less than this value is deleted from the summary.
6663 The default is @code{wl-summary-expunge-below}.
6665 @item mark-and-expunge
6666 Both @code{mark} and @code{expunge} are applied,
6667 i.e. messages with a score less than this value is marked as read and
6668 deleted from the summary.
6671 Messages with a score greater than this value is attached with temp
6673 The default is @code{wl-summary-target-above}.
6676 Messages with a score greater than this value is attached with important
6678 The default is @code{wl-summary-important-above}.
6683 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6684 are used, you need to set @code{elmo-msgdb-extra-fields}.
6687 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6690 There are other restrictions as shown below:
6693 @item Because @samp{References} field in the summary information
6694 contains only the last @samp{Message-ID}, @code{references} key matches
6698 Keys that can be seen by folder of types:
6702 chars lines xref extra
6703 localdir,localnews Y E E E
6704 nntp (supporting xover) Y E E N
6710 N: cannot be seen (ignored)
6711 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6716 @node Address Book, Spam Filter, Scoring, Top
6717 @chapter Address Book
6718 @cindex Address Book
6720 With address book, you can utilize address completion, and you have
6721 summary displayed with nicknames.
6724 * Mail Addresses:: Definition of Address Book
6725 * Address Manager:: Address Manager
6729 @node Mail Addresses, Address Manager, Address Book, Address Book
6730 @section Address book
6731 @cindex Address book Definition
6733 @cindex Alias, Address
6735 The file @file{~/.addresses} is a simple address book for Wanderlust.
6736 Make address file @file{~/.addresses}, and edit to suit your requirement.
6738 The data written in @file{~/.addresses} are used for address completion
6739 under draft editing mode. Furthermore, they are used when showing names
6740 in summary display mode. You can safely skip this section, if you don't
6741 want to customize address completion and summary display.
6742 It is possible to add/change/remove addresses from @file{~/.addresses} in
6743 summary buffer after Wanderlust is invoked. @refill
6745 The format is very simple. Like this. @refill
6750 # @r{Lines begin with @samp{#} are comment.}
6751 # @r{Empty lines are ignored}
6753 # @r{Format of each line:}
6754 # @var{email-address} "@var{nickname} "@var{realname}"
6756 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6757 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6758 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6763 One line defines one persons description.
6765 Actually, in default setup, @var{nickname} is used in summary-mode and
6766 @var{realname} is used in draft preparation mode. This behavior is
6767 better understood if you try it and confirmed the function first. You
6768 can write and try a small definition, so you will know the idea of the
6769 address book before writing a big one.
6771 And, if MH alias file is specified in variable @code{wl-alias-file},
6772 it is used as an address information in the draft preparation mode.
6774 If variable @code{wl-use-ldap} is non-nil (initial setting is
6775 @code{nil}), address completion in draft mode uses LDAP information.
6777 If you use LDAP, you have to set @code{wl-ldap-server},
6778 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6779 not have LDAP feature as built-in feature (Currently only XEmacs can
6780 have built-in LDAP feature), you have to set command exec @env{PATH} to
6781 the program @command{ldapsearch}.
6784 @node Address Manager, , Mail Addresses, Address Book
6785 @section Address Manager
6786 @cindex Address Manager
6788 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6789 the address book and insert address to draft buffer.
6791 @subsection Key Bindings
6795 @kindex t (Address Manager)
6796 @findex wl-addrmgr-set-to
6797 Add @samp{To:} mark.
6800 @kindex c (Address Manager)
6801 @findex wl-addrmgr-set-cc
6802 Add @samp{Cc:} mark.
6805 @kindex b (Address Manager)
6806 @findex wl-addrmgr-set-bcc
6807 Add @samp{Bcc:} mark.
6810 @kindex u (Address Manager)
6811 @findex wl-addrmgr-unmark
6815 @kindex x (Address Manager)
6816 @findex wl-addrmgr-apply
6818 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6819 buffer and quit address manager. When no draft buffer, make new draft
6820 with insert marked addresses.
6822 If no mark, quit address manager.
6826 @kindex q (Address Manager)
6827 @findex wl-addrmgr-quit
6828 Quit address manager.
6831 @kindex a (Address Manager)
6832 @findex wl-addrmgr-add
6836 @kindex d (Address Manager)
6837 @findex wl-addrmgr-delete
6841 @kindex e (Address Manager)
6842 @findex wl-addrmgr-edit
6847 @node Spam Filter, Advanced Issues, Address Book, Top
6848 @chapter Spam Filter
6851 @code{wl-spam} provides an frontend to external spam filtering programs.
6852 You can register to or judge spam by the filtering program cooperateing
6853 with messages operations on Wanderlust.
6856 * Usage of Spam Filter:: Usage of Spam Filter
6857 * Spam Filter Processors:: Supported spam filters
6860 @node Usage of Spam Filter, Spam Filter Processors, Spam Filter, Spam Filter
6861 @section Usage of Spam Filter
6863 @subsection Initial Setting
6865 To use @code{wl-spam}, write in @file{~/.wl} as follows:
6869 ;; @r{Use @samp{bogofilter} as spam back end}
6870 ;; @r{Set @samp{scheme} here as the spam filter you will use.}
6871 ;; @r{@xref{Spam Filter Processors}.}
6872 (setq elmo-spam-scheme 'bogofilter)
6877 @subsection spam mark
6879 The spam mark (@samp{s}) will be provided as new temporary mark.
6880 Messages marked by this will be refiled into @code{wl-spam-folder} when
6881 the action is called for execution. Marked messages will be skipped by
6882 summary walking in ordinary way.
6884 The spam mark is be put on by spam judgement described later, or by
6885 invoking @kbd{k m} at any time.
6887 @subsection spam judgment
6889 You can judge spam messages by following ways:
6893 Make judgement on execution of auto-refile.
6895 Insert @code{wl-refile-guess-by-spam} to arbitrary position in
6896 @code{wl-auto-refile-guess-functions} as follows.
6900 (setq wl-auto-refile-guess-functions
6901 '(wl-refile-guess-by-rule
6902 wl-refile-guess-by-spam))
6906 In this example, judge spam if it could not decide refile destination by
6907 @code{wl-refile-rule-alist}.
6910 Make judgement on entering the summary of specified folder.
6912 Specify the value of @code{wl-spam-auto-check-folder-regexp-list}
6913 as the list of regular expressions for folder names to be
6914 automatically judged by spam filter.
6917 (setq wl-spam-auto-check-folder-regexp-list '("\\+inbox"))
6920 In this example, judgement will be processed when you enter summary of
6921 the folder whose name contains @samp{+inbox}.
6924 Make judgement on splitting messages with @code{elmo-split}.
6926 It provides new function @code{spam-p} to be specified as @samp{CONDITION}
6927 in @code{elmo-split-rule}. This function returns true when the message
6929 @xref{Split messages}.
6931 You can also process learning by the result of judgement. (You would
6932 better turn on this feature after learning to some extent)
6938 (setq elmo-split-rule
6939 '(((spam-p) "+spam")
6940 ;; @r{to learn by the judgement, use following instead}
6941 ;((spam-p :register t) "+spam")
6947 @subsection spam learning
6949 @code{wl-spam} automatically learn spam with refiling messages.
6951 At first, @code{wl-spam} classifies the folders controlled by Wanderlust
6952 into following 4 domains by the class of containig messages
6956 Folders containing messages judged as spam.
6957 (The folder specified by @code{wl-spam-folder})
6959 Folders containing messages judged as non-spam.
6961 Folders containing messages not yet judged. Folders without
6962 pre-distribution may belong to this domain e.g. @samp{+inbox}.
6963 (specified by @code{wl-spam-undecided-folder-regexp-list})
6965 Foldes have nothing to do with spam processing e.g.
6966 @code{wl-trash-folder} or @code{wl-draft-folder}. (specified by
6967 @code{wl-spam-ignored-folder-regexp-list})
6970 When you refile messages across different domains, it automatically
6971 learn messages as @samp{spam} or @samp{non-spam} according to domains
6972 it belongs before and after.
6974 To put it concretely, it will learn by following rule:
6977 @item undecide -> spam
6980 learn as spam and cancel previous study as non-spam.
6981 @item undecide -> good
6984 learn as non-spam and cancel previous study as spam.
6987 It do not learn anything in other cases.
6989 @subsection Key Bindings
6990 @cindex Keybind, spam filter
6994 @kindex k m (Summary)
6995 @findex wl-summary-spam
6996 Put spam mark (@samp{s}) on current message.
6999 @kindex k c (Summary)
7000 @findex wl-summary-test-spam
7001 Test current message and put spam mark if judged as spam.
7004 @kindex k C (Summary)
7005 @findex wl-summary-mark-spam
7006 Test messages with the mark in @code{wl-spam-auto-check-marks},
7007 and put spam mark if judged as spam. If it is called with prefix
7008 argument, test all messages regardless of their marks.
7011 @kindex k s (Summary)
7012 @findex wl-summary-register-as-spam
7013 Register current message as spam.
7016 @kindex k S (Summary)
7017 @findex wl-summary-register-as-spam-all
7018 Register all messages in the folder as spam.
7021 @kindex k n (Summary)
7022 @findex wl-summary-register-as-good
7023 Register current message as non-spam.
7026 @kindex k N (Summary)
7027 @findex wl-summary-register-as-good-all
7028 Register all messages in the folder as non-spam.
7031 @kindex m k (Summary)
7032 @findex wl-summary-target-mark-spam
7033 Put spam mark (@samp{s}) on messages with the target mark @samp{*}.
7036 @kindex m s (Summary)
7037 @findex wl-summary-target-mark-register-as-spam
7038 Register messages with the target mark @samp{*} as spam.
7041 @kindex m n (Summary)
7042 @findex wl-summary-target-mark-register-as-good
7043 Register messages with the target mark @samp{*} as non-spam.
7046 @subsection Customizable Variables
7049 @item wl-spam-folder
7050 @vindex wl-spam-folder
7051 Specify the name of destination folder for the spam messages.
7052 The initial setting is @samp{+spam}.
7054 @item wl-spam-undecided-folder-regexp-list
7055 @vindex wl-spam-undecided-folder-regexp-list
7056 Specify the list of regexp of folder names which contain messages
7057 not yet decided as spam or non-spam.
7058 The initial setting is @code{'("inbox")}.
7060 @item wl-spam-ignored-folder-regexp-list
7061 @vindex wl-spam-ignored-folder-regexp-list
7062 The initial setting is as follows.
7066 (list (regexp-opt (list wl-draft-folder
7072 Folders of no effect against spam judgement, specified by the list of
7073 folder name regular expressions.
7075 @item wl-spam-auto-check-folder-regexp-list
7076 @vindex wl-spam-auto-check-folder-regexp-list
7077 Folders to make spam judgement on entering the summary of them,
7078 specified by the list of folder name regular expressions.
7079 The initial setting is @code{nil}.
7081 @item wl-spam-auto-check-marks
7082 @vindex wl-spam-auto-check-marks
7083 The initial setting is the following list:
7087 (list wl-summary-new-uncached-mark
7088 wl-summary-new-cached-mark)
7092 Messages with mark specified by this variable will be processed
7093 by whole-folder judgement including auto test by
7094 @code{wl-spam-auto-check-folder-regexp-list}.
7095 Persistent marks can be used in this method, but temporary marks cannot.
7097 You can specify the list of marks as the initial setting, or you can
7098 specify follwing symbol:
7102 Process all messages regardless of persistent marks.
7107 @node Spam Filter Processors, , Usage of Spam Filter, Spam Filter
7108 @section Supported Spam Filters
7109 @cindex Spam Filter, Bogofilter
7110 @cindex Spam Filter, Spamfilter
7112 Supported spam filtering libraries are following ones.
7115 * bogofilter:: bogofilter
7116 * spamfilter:: spamfilter.el
7117 * bsfilter:: bsfilter
7118 * SpamAssassin:: SpamAssassin
7119 * SpamOracle:: SpamOracle
7120 * Regular Expressions Header Matching:: Header regexp
7124 @node bogofilter, spamfilter, Spam Filter Processors, Spam Filter Processors
7125 @subsection bogofilter
7128 bogofilter (@uref{http://bogofilter.sourceforge.net/}) is a spam filter
7129 implemented by C language.
7131 To use spam filter with bogofilter, write following setting in
7132 @file{~/.wl} or somewhere else.
7136 (setq elmo-spam-scheme 'bogofilter)
7140 @subsubsection Customizable Variables
7143 @item elmo-spam-bogofilter-program
7144 @vindex elmo-spam-bogofilter-program
7145 The initial setting is @file{bogofilter}.
7146 Specify the name of executable of bogofilter. If the executable
7147 is not in your environmental variable @env{PATH}, you should
7148 set this by full path.
7150 @item elmo-spam-bogofilter-args
7151 @vindex elmo-spam-bogofilter-args
7152 The initial setting is @code{nil}.
7153 Specify arguments to be supplied for bogofilter executable.
7155 @item elmo-spam-bogofilter-database-directory
7156 @vindex elmo-spam-bogofilter-database-directory
7157 Specify the directory for statistical database to be used.
7158 @code{nil} to use default directory (@file{~/.bogofilter}).
7159 The initial setting is @code{nil}.
7161 @item elmo-spam-bogofilter-max-messages-per-process
7162 @vindex elmo-spam-bogofilter-max-messages-per-process
7163 The initial setting is 30. This variable specifies the number of
7164 messages to be learned by one process.
7166 @item elmo-spam-bogofilter-debug
7167 @vindex elmo-spam-bogofilter-debug
7168 The initial setting is @code{nil}.
7169 If you specify non-nil, the output from @command{bogofilter} is
7170 stored in the buffer named @code{"*Debug ELMO SPAM Bogofilter*"}.
7174 @node spamfilter, bsfilter, bogofilter, Spam Filter Processors
7175 @subsection spamfilter.el
7178 @file{spamfilter.el}
7179 (@uref{http://www.geocities.co.jp/SiliconValley-PaloAlto/7043/}) is a
7180 spam filtering library implemented by Emacs Lisp.
7182 Corresponding modules will be compiled/installed, if you have
7183 @file{spamfilter.el} within @code{load-path} when you are to install wl.
7186 To use @file{spamfilter.el}, write following setting in @file{~/.wl} or
7188 (Of cource, you have to have settings for @file{spamfilter.el} itself)
7192 (setq elmo-spam-scheme 'spamfilter)
7196 @subsubsection Customizable Variables
7199 @item elmo-spam-spamfilter-corpus-filename
7200 @vindex elmo-spam-spamfilter-corpus-filename
7201 The initial setting is @file{~/.elmo/.spamfilter}.
7202 It specifies the name of corpus file.
7205 @node bsfilter, SpamAssassin, spamfilter, Spam Filter Processors
7206 @subsection bsfilter
7209 bsfilter (@uref{http://bsfilter.org/index-e.html}) is a spam filter
7210 implemented by Ruby language.
7212 To use spam filter with bsfilter, write following setting in
7213 @file{~/.wl} or somewhere else.
7217 (setq elmo-spam-scheme 'bsfilter)
7221 @subsubsection Customizable Variables
7224 @item elmo-spam-bsfilter-program
7225 @vindex elmo-spam-bsfilter-program
7226 The initial setting is @file{bsfilter}.
7227 Specify the name of executable of @command{bsfilter}. If the executable
7228 is not in your environmental variable @env{PATH}, you should
7229 set this by full path.
7231 @item elmo-spam-bsfilter-args
7232 @vindex elmo-spam-bsfilter-args
7233 The initial setting is @code{nil}.
7234 Specify arguments to be supplied for bsfilter executable.
7236 @item elmo-spam-bsfilter-database-directory
7237 @vindex elmo-spam-bsfilter-database-directory
7238 Specify the directory for statistical database to be used.
7239 @code{nil} to use default directory (@file{~/.bsfilter}).
7240 The initial setting is @code{nil}.
7242 @item elmo-spam-bsfilter-debug
7243 @vindex elmo-spam-bsfilter-debug
7244 The initial setting is @code{nil}.
7245 If you specify non-nil, the output from @command{bsfilter} is
7246 stored in the buffer named @code{"*Debug ELMO Bsfilter*"}.
7248 @item elmo-spam-bsfilter-shell-program
7249 @vindex elmo-spam-bsfilter-shell-program
7250 The initial setting is @file{ruby}.
7251 Specify the shell to execute @command{bsfilter}. If the shell is not
7252 in your environmental variable @env{PATH}, you should set this by full path.
7254 @item elmo-spam-bsfilter-shell-switch
7255 @vindex elmo-spam-bsfilter-shell-switch
7256 The initial setting is @code{nil}.
7257 Specify options to give to the shell executing @command{bsfilter}.
7259 @item elmo-spam-bsfilter-update-switch
7260 @vindex elmo-spam-bsfilter-update-switch
7261 The initial setting is @code{"--synchronous-auto-update"}.
7262 Specify options to give to @command{bsfilter} for learning messages.
7266 @node SpamAssassin, SpamOracle, bsfilter, Spam Filter Processors
7267 @subsection SpamAssassin
7268 @cindex SpamAssassin
7270 SpamAssassin (@uref{http://spamassassin.org/}) is one of the most
7271 popular spam filtering program implemented on Perl. SpamAssassin
7272 attempts to identify spam using text analysis and several internet-based
7273 realtime blacklists. SpamAssassin also uses a Bayesian learning filter
7274 which enables more accurate spam filtering.
7276 To use @file{SpamAssassin} on Wanderlust, write following setting
7277 in @file{~/.wl} or somewhere else.
7278 (Of course, you have to install SpamAssassin beforehand.)
7282 (setq elmo-spam-scheme 'sa)
7286 @subsubsection Customize Variables
7289 @item elmo-spam-spamassassin-program
7290 @vindex elmo-spam-spamassassin-program
7291 The initial setting is @file{spamassassin}.
7292 Specify the name of executable @command{spamassassin}. If the executable
7293 is not in your environmental variable @env{PATH}, you should
7294 set this by full path.
7296 @item elmo-spam-spamassassin-learn-program
7297 @vindex elmo-spam-spamassassin-learn-program
7298 The initial setting is @file{sa-learn}.
7299 Specify the name of the SpamAssassin's Bayesian filtering learner
7300 program, @command{sa-learn}. If the executable is not in your
7301 environmental variable @env{PATH}, you should set this by full path.
7303 @item elmo-spam-spamassassin-program-arguments
7304 @vindex elmo-spam-spamassassin-program-arguments
7305 The initial setting is @code{'("-e")}.
7306 Specify the arguments to be supplied for @command{spamassassin} executable.
7307 You have to specify the argument to exit the program with an error exit code
7308 when the result is spam. For example, if you want to use @command{spamc}
7309 instead of @command{spamassassin}, you should specify @code{'("-c")}.
7311 @item elmo-spam-spamassassin-learn-program-arguments
7312 @vindex elmo-spam-spamassassin-lern-program-arguments
7313 The initial setting is @code{nil}.
7314 Specify the arguments to be supplied for @command{sa-learn}.
7316 @item elmo-spamassassin-debug
7317 @vindex elmo-spamassassin-debug
7318 The initial setting is @code{nil}.
7319 If you specify @code{t}, the output from @command{spamassassin} is
7320 stored in the buffer named @code{"*Debug ELMO SpamAssassin*"}.
7324 @node SpamOracle, Regular Expressions Header Matching, SpamAssassin, Spam Filter Processors
7325 @subsection SpamOracle
7328 SpamOracle (`http://pauillac.inria.fr/~xleroy/software.html#spamoracle')
7329 is a spam filter implemented by Objective Caml language.
7331 To use spam filter with @file{spamoracle}, write following setting in
7332 @file{~/.wl} or somewhere else.
7333 (Of course, you have to install SpamOracle beforehand.)
7337 (setq elmo-spam-scheme 'spamoracle)
7341 @subsubsection Customizable Variables
7344 @item elmo-spam-spamoracle-program
7345 @vindex elmo-spam-spamoracle-program
7346 The initial setting is @file{spamoracle}. Specify the name of
7347 executable of spamoracle. If the executable is not in your
7348 environmental variable @env{PATH}, you should set this by full path.
7350 @item elmo-spam-spamoracle-config-filename
7351 @vindex elmo-spam-spamoracle-config-filename
7352 Specify the name of config file. @code{nil} to use default file
7353 (@file{~/.spamoracle.conf}). The initial setting is @code{nil}.
7355 @item elmo-spam-spamoracle-database-filename
7356 @vindex elmo-spam-spamoracle-database-filename
7357 The initial setting is @file{~/.elmo/.spamoracle.db}.
7358 It specifies the name of database file.
7360 @item elmo-spam-spamoracle-spam-header-regexp
7361 @vindex elmo-spam-spamoracle-spam-header-regexp
7362 The initial setting is @code{"^X-Spam: yes;"}. It specifies the regular
7363 expression of the header that indicates spam mail. Use this setting
7364 when you change the @code{spam_header} parameter in the config file.
7368 @node Regular Expressions Header Matching, , SpamAssassin, Spam Filter Processors
7369 @subsection Regular Expressions Header Matching
7370 @cindex Regular Expressions Header Matching
7372 Examine if regular expression matches corresponding field in message heaeder,
7373 and decide spam or not. To use this backend, add following setting to @file{~/.wl}.
7377 (setq elmo-spam-scheme 'header)
7381 If you want to check fields not included in the default overview
7382 information, add one into @code{elmo-msgdb-extra-fields}. Then it will
7383 do examination by the overview information and avoid loading whole
7384 message body as far as possible.
7386 @subsubsection Customize Variables
7389 @item elmo-spam-header-good-alist
7390 @vindex elmo-spam-header-good-alist
7391 The initial setting is the following list:
7394 '(("X-Spam-Flag" . "No"))
7397 Specify a list of regular expressions to match with header field name
7398 for making non-spam decision. It takes precedence over
7399 @code{elmo-spam-header-spam-alist}.
7401 @item elmo-spam-header-spam-alist
7402 @vindex elmo-spam-header-spam-alist
7403 The initial setting is the following list:
7406 '(("X-Spam-Flag" . "Yes"))
7409 Specify a list of regular expressions to match with header field name
7410 for making spam decision.
7414 @node Advanced Issues, Migration, Spam Filter, Top
7415 @chapter Advanced Issues
7416 @cindex Advanced Issues
7419 * Living with other packages:: Cooperating with other packages
7420 * Highlights:: Highlights
7421 * Biff:: Notify Mail arrival
7422 * Password Management:: Manage Passwords
7423 * Split messages:: Splitting messages
7424 * Batch Processing:: Invoke commands in batch mode
7425 * Advanced Settings:: Advanced Settings
7426 * Customizable Variables:: Customizable Variables
7431 @node Living with other packages, Highlights, Advanced Issues, Advanced Issues
7432 @section Living with other packages
7434 Examples with other packages.
7437 * imput:: imput (im-wl.el)
7438 * BBDB:: The Insidious Big Brother Database
7439 * LSDB:: The Lovely Sister Database
7440 * supercite:: supercite.el
7441 * mu-cite:: mu-cite.el
7442 * X-Face:: x-face,bitmap-mule
7443 * dired-dd:: dired-dd.el
7445 * Addrbook:: Addrbook
7446 * mime-w3m:: mime-w3m.el
7450 @node imput, BBDB, Living with other packages, Living with other packages
7455 Place @file{util/im-wl.el} on the @code{load-path} and do the following
7460 (autoload 'wl-draft-send-with-imput-async "im-wl")
7461 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
7466 @node BBDB, LSDB, imput, Living with other packages
7470 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
7471 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
7472 and do the following settings.
7474 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
7475 byte-compiled and installed.
7483 ;; @r{enable pop-ups}
7484 (setq bbdb-use-pop-up t)
7485 ;; @r{auto collection}
7486 (setq bbdb/mail-auto-create-p t)
7487 ;; @r{exceptional folders against auto collection}
7488 (setq bbdb-wl-ignore-folder-regexp "^@@")
7489 (setq signature-use-bbdb t)
7490 (setq bbdb-north-american-phone-numbers-p nil)
7491 ;; @r{shows the name of bbdb in the summary} :-)
7492 (setq wl-summary-from-function 'bbdb-wl-from-func)
7493 ;; @r{automatically add mailing list fields}
7494 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
7495 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
7499 You can complete address with BBDB by @kbd{M-@key{TAB}}
7503 @node LSDB, supercite, BBDB, Living with other packages
7507 The following is an example setting to use
7508 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
7515 (add-hook 'wl-draft-mode-hook
7517 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
7521 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
7522 (complete address with LSDB).
7525 @node supercite, mu-cite, LSDB, Living with other packages
7526 @subsection sc.el(supercite), sc-register.el
7530 The same setting as usual mailers should be OK. The following is an
7531 example of settings:
7535 (autoload 'sc-cite-original "supercite" nil t)
7536 (add-hook 'mail-citation-hook 'sc-cite-original)
7541 @node mu-cite, X-Face, supercite, Living with other packages
7542 @subsection mu-cite.el
7545 The same setting as usual mailers should be OK. The following is an
7546 example of settings.
7548 If you use mu-cite version 8.0 or earlier:
7552 (autoload 'mu-cite/cite-original "mu-cite" nil t)
7553 (setq mail-citation-hook 'mu-cite/cite-original)
7557 If you use mu-cite version 8.1 or later:
7561 (autoload 'mu-cite-original "mu-cite" nil t)
7562 (add-hook 'mail-citation-hook (function mu-cite-original))
7566 @node X-Face, dired-dd, mu-cite, Living with other packages
7570 If you have installed one of the following, you can decode
7571 @samp{X-Face:} field in message buffer and you will see face image.
7574 * x-face-xmas:: XEmacs case
7575 * x-face-mule:: Emacs case
7578 If there is an encoded X-Face string in a file @file{~/.xface} (the
7579 value of the variable @code{wl-x-face-file}), it is inserted as a
7580 @samp{X-Face:} field in the draft buffer (if
7581 @code{wl-auto-insert-x-face} is non-nil).
7583 @node x-face-xmas, x-face-mule, X-Face, X-Face
7584 @subsubsection x-face-xmas (for XEmacs)
7587 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
7588 1.3.6.13 or later, do the following:
7592 (autoload 'x-face-xmas-wl-display-x-face "x-face")
7593 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
7597 @node x-face-mule, , x-face-xmas, X-Face
7598 @subsubsection x-face-mule (for Emacs)
7602 If you use @file{x-face-mule.el} in bitmap-mule
7603 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
7607 (autoload 'x-face-decode-message-header "x-face-mule")
7608 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7612 @subsubsection x-face-e21 (for Emacs 21.x)
7615 With Emacs 21.x, you can use @file{x-face-e21.el}
7616 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
7617 to display X-Face. In this case, bitmap-mule is not required.
7622 (autoload 'x-face-decode-message-header "x-face-e21")
7623 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7628 @node dired-dd, MHC, X-Face, Living with other packages
7629 @subsection dired-dd(Dired-DragDrop)
7630 @pindex Dired-DragDrop
7632 @cindex Drag and Drop
7634 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
7635 compose multi-part by simple Drag-and-Drop from dired to the draft
7636 buffer being edited in GNU Emacs (this feature is not Wanderlust
7637 specific, but general-purpose for SEMI).
7641 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
7647 ;; @r{Set dired-x variables here.}
7648 ;; @r{To and flo@dots{}}
7650 (progn (require 'dired-dd)
7651 (require 'dired-dd-mime))))))
7655 @node MHC, Addrbook, dired-dd, Living with other packages
7659 Message Harmonized Calendaring system
7660 (@uref{http://www.quickhack.net/mhc/})
7662 By using MHC, you can make a calendar from the messages.
7668 (setq mhc-mailer-package 'wl)
7669 (autoload 'mhc-mode "mhc" nil t)
7670 (add-hook 'wl-summary-mode-hook 'mhc-mode)
7671 (add-hook 'wl-folder-mode-hook 'mhc-mode)
7679 (autoload 'mhc-wl-setup "mhc-wl")
7680 (add-hook 'wl-init-hook 'mhc-wl-setup)
7684 @node Addrbook, mime-w3m, MHC, Living with other packages
7685 @subsection wl-addrbook.el
7689 (@uref{http://www.mew.org/})
7691 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
7692 @code{load-path} and do the following settings.
7696 (require 'wl-addrbook)
7701 @node mime-w3m, , Addrbook, Living with other packages
7702 @subsection mime-w3m.el
7705 You can display html part by using @file{mime-w3m.el}
7706 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
7707 You can find the usage in comment region at the head of @file{mime-w3m.el}.
7710 @node Highlights, Biff, Living with other packages, Advanced Issues
7713 @subsection Customizable Variables
7716 @item wl-summary-highlight
7717 @vindex wl-summary-highlight
7718 The initial setting is @code{t}.
7719 If non-nil, the summary is highlighted.
7721 @item wl-highlight-max-summary-lines
7722 @vindex wl-highlight-max-summary-lines
7723 The initial setting is 10000.
7724 The summary is not highlighted if it has more lines than this value.
7726 @item wl-summary-highlight-partial-threshold
7727 @vindex wl-summary-highlight-partial-threshold
7728 The initial setting is 1000.
7729 This is a threshold whether the whole summary is highlighted.
7730 If there are more lines of messages in the summary, it is partially
7733 @item wl-summary-partial-highlight-above-lines
7734 @vindex wl-summary-partial-highlight-above-lines
7735 The initial setting is 30. If there are more lines of messages than
7736 @code{wl-summary-highlight-partial-threshold} in the summary, messages
7737 after the point that is the same number of lines as this value above the
7738 cursor line are highlighted partially. (If this value is @code{nil},
7739 the last same number of lines as the value of
7740 @code{wl-summary-highlight-partial-threshold} are highlighted.)
7742 @item wl-highlight-body-too
7743 @vindex wl-highlight-body-too
7744 The initial setting is @code{t}.
7745 If non-nil, bodies of drafts and messages are also highlighted.
7747 @item wl-highlight-message-header-alist
7748 @vindex wl-highlight-message-header-alist
7749 When highlighting headers of drafts and messages, this variable
7750 specifies which faces are allocated to important
7751 (@code{wl-highlight-message-important-header-contents}), secondly
7752 important (@code{wl-highlight-message-important-header-contents2}), and
7753 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7755 Similarly, it can be used for allocating arbitrary faces to arbitrary
7756 regular expressions.
7758 @item wl-highlight-citation-prefix-regexp
7759 @vindex wl-highlight-citation-prefix-regexp
7760 Specifies a regular expression to which quoted lines in bodies of
7761 drafts and messages match.
7762 Bodies matching to this regular expression are highlighted by the faces
7763 specified by (@code{wl-highlight-message-cited-text-*}).
7765 @item wl-highlight-highlight-citation-too
7766 @vindex wl-highlight-highlight-citation-too
7767 The initial setting is @code{nil}.
7768 If non-nil, the quoting regular expression itself given by
7769 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7771 @item wl-highlight-citation-header-regexp
7772 @vindex wl-highlight-citation-header-regexp
7773 Specifies a regular expression that denotes beginning of quotation.
7774 Bodies matching to this regular expression are highlighted by the face
7775 specified by @code{wl-highlight-message-headers}.
7777 @item wl-highlight-max-header-size
7778 @vindex wl-highlight-max-header-size
7779 The initial setting is @code{nil}. If a header size is larger than this
7780 value, it will not be highlighted. If @code{nil}, always highlighted
7781 (ignore header size).
7783 @item wl-highlight-max-message-size
7784 @vindex wl-highlight-max-message-size
7785 The initial setting is 10000.
7786 If a message is larger than this value, it will not be highlighted.
7787 With this variable, highlight is suppressed for uuencode or huge digest
7790 @item wl-highlight-signature-separator
7791 @vindex wl-highlight-signature-separator
7792 Specifies regular expressions that denotes the boundary of a signature.
7793 It can be a regular expression, or a list of ones.
7794 Messages after the place that matches this regular expression are
7795 highlighted by the face specified by
7796 @code{wl-highlight-message-signature}.
7798 @item wl-max-signature-size
7799 @vindex wl-max-signature-size
7800 The initial setting is 400.
7801 This is the largest size for a signature to be highlighted.
7803 @item wl-use-highlight-mouse-line
7804 @vindex wl-use-highlight-mouse-line
7805 The initial setting is @code{t}.
7806 If non-nil, the line pointed by the mouse is highlighted in the folder
7807 mode, summary mode, and the like.
7810 @subsection Setting Colors and Fonts of the Characters
7812 If you want to change colors or fonts of the characters, you need to
7813 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7814 want to change fonts, and @code{set-face-foreground} for colors, and so
7815 on. You cannot write face settings in @file{.emacs}; write in
7818 For example, if you want to change the color for signatures to yellow,
7822 (set-face-foreground 'wl-highlight-message-signature "yellow")
7828 Faces defined in Wanderlust:
7831 @item wl-highlight-message-headers
7832 The face for field names of message headers.
7834 @item wl-highlight-message-header-contents
7835 The face for field bodies of message headers.
7837 @item wl-highlight-message-important-header-contents
7838 The face for important parts of message headers.
7839 Per default, this face is used for a body of @samp{Subject:} field.
7840 You can change its value by editing
7841 @code{wl-highlight-message-header-alist}.
7843 @item wl-highlight-message-important-header-contents2
7844 The face for secondly important parts of message headers.
7845 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7846 fields. You can change its value by editing
7847 @code{wl-highlight-message-header-alist}.
7849 @item wl-highlight-message-unimportant-header-contents
7850 The face for unimportant parts of message headers.
7851 Per default, this face is used for bodies of @samp{X-} fields
7852 @samp{User-Agent:} fields. You can change its value by editing
7853 @code{wl-highlight-message-header-alist}.
7855 @item wl-highlight-message-citation-header
7856 The face for headers of quoted messages.
7858 @item wl-highlight-message-cited-text-*
7859 The face for texts of quoted messages. The last @samp{*} is a
7860 @var{single figure} so that 10 different colors can be used according to
7863 @item wl-highlight-message-signature
7864 The face for signatures of messages. The initial settings are
7865 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7866 dark background colors.
7868 @item wl-highlight-header-separator-face
7869 The face for header separators of draft messages.
7871 @item wl-highlight-summary-important-face
7872 The face for message lines with important marks in the summary.
7874 @item wl-highlight-summary-new-face
7875 The face for message lines with new marks in the summary.
7877 @item wl-highlight-summary-displaying-face
7878 The face for the message line that is currently displayed.
7879 This face is overlaid.
7881 @item wl-highlight-thread-indent-face
7882 The face for the threads that is currently displayed.
7884 @item wl-highlight-summary-unread-face
7885 The face for message lines with unread marks in the summary.
7887 @item wl-highlight-summary-deleted-face
7888 The face for message lines with delete marks in the summary.
7890 @item wl-highlight-summary-refiled-face
7891 The face for message lines with re-file marks in the summary.
7893 @item wl-highlight-refile-destination-face
7894 The face for re-file information part of message lines with re-file
7895 marks in the summary.
7897 @item wl-highlight-summary-copied-face
7898 The face for message lines with copy marks in the summary.
7900 @item wl-highlight-summary-target-face
7901 The face for message lines with target marks @samp{*} in the summary.
7903 @item wl-highlight-summary-thread-top-face
7904 The face for message lines that are on the top of the thread in the
7907 @item wl-highlight-summary-normal-face
7908 The face for message lines that are not on top of the thread in the
7911 @item wl-highlight-folder-unknown-face
7912 The face for folders that are not known to have how many unsync messages
7915 @item wl-highlight-folder-zero-face
7916 The face for folders that have no unsync messages in the folder mode.
7918 @item wl-highlight-folder-few-face
7919 The face for folders that have some unsync messages in the folder mode.
7921 @item wl-highlight-folder-many-face
7922 The face for folders that have many unsync messages in the folder mode.
7923 The boundary between `some' and `many' is specified by the variable
7924 @code{wl-folder-many-unsync-threshold}.
7926 @item wl-highlight-folder-unread-face
7927 The face for folders that have no unsync but unread messages in the
7930 @item wl-highlight-folder-killed-face
7931 The face for folders that are deleted from the access group in the
7934 @item wl-highlight-folder-opened-face
7935 The face for open groups in the folder mode.
7936 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7937 @code{nil} or a @var{number}.
7939 @item wl-highlight-folder-closed-face
7940 The face for close groups in the folder mode.
7941 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7942 @code{nil} or a @var{number}.
7944 @item wl-highlight-folder-path-face
7945 The face for the path to the currently selected folder in the folder
7948 @item wl-highlight-logo-face
7949 The face for logo in the demo.
7951 @item wl-highlight-demo-face
7952 The face for strings (for example, a version number) in the demo.
7956 @node Biff, Password Management, Highlights, Advanced Issues
7957 @section Notify Mail arrival
7960 Following setting is to notify mail arrival of @samp{%inbox}
7961 by the indicator on the modeline
7964 (setq wl-biff-check-folder-list '("%inbox"))
7967 @subsection Customizable Variables
7969 @item wl-biff-check-folder-list
7970 @vindex wl-biff-check-folder-list
7971 The initial setting is @code{nil}.
7972 This is the list of folders to check mail arrival.
7973 If @code{nil}, wl doesn't check mail arrival.
7975 @item wl-biff-check-interval
7976 @vindex wl-biff-check-interval
7977 The initial setting is 40 (in seconds).
7978 Check mail arrival in this period.
7980 @item wl-biff-use-idle-timer
7981 @vindex wl-biff-use-idle-timer
7982 The initial setting is @code{nil}.
7983 If it is @code{nil}, check mail arrival when the time specified by
7984 @code{wl-biff-check-interval} has passed. If it is non-nil, check
7985 mail arrival when idling time exceeds @code{wl-biff-check-interval}.
7987 @item wl-biff-notify-hook
7988 @vindex wl-biff-notify-hook
7989 This hook is run at the arrival of new mail.
7990 To beep with mail arrival(initial setting), set as follows.
7992 (setq wl-biff-notify-hook '(ding))
7994 For silence, set to @code{nil}.
7998 @node Password Management, Split messages, Biff, Advanced Issues
7999 @section Manage Passwords
8001 If you input passwords to connect servers, they are stored in the
8002 variable @code{elmo-passwd-alist} per connection. You should be careful
8003 that others might read your passwords if they can touch your Emacs,
8004 since encoded plain passwords are there.
8006 If you invoke @kbd{M-x elmo-passwd-alist-save} while you have stored
8007 passwords, then they are saved on the file, and it will save you to
8008 input passwords. In this case, the risk that someone reads your
8009 keystroke might decrease, but please not that plain passwords are
8010 stored on a file. You should treat them very carefully.
8011 To remove saved passwords on file, invoke @kbd{M-x elmo-passwd-alist-clear}
8012 and then @kbd{M-x elmo-passwd-alist-save}.
8015 @item elmo-passwd-alist-file-name
8016 @vindex elmo-passwd-alist-file-name
8017 The initial setting is @file{passwd}.
8018 This is the name of the file in which passwords are saved.
8019 @code{elmo-passwd-alist-save} saves current passwords to the file.
8021 @item elmo-passwd-life-time
8022 @vindex elmo-passwd-life-time
8023 The initial setting is @code{nil}.
8024 If the value is some number, timer is set to remove password entry after
8025 @code{elmo-passwd-life-time} seconds since you input the password.
8026 @code{nil} means never to remove passwords.
8030 @node Split messages, Batch Processing, Password Management, Advanced Issues
8031 @section Message splitting
8032 @cindex Split messages
8034 You can use @code{elmo-split} to split message in folder specified by
8035 the variable @code{elmo-split-folder} a la @command{procmail} according
8036 to some specified rules. To use this feature, set as follows in your
8037 @file{~/.emacs} at first.
8040 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
8043 Set source folder like following.
8046 (setq elmo-split-folder "%inbox")
8049 And specify the rule in the variable @code{elmo-split-rule} (its format
8050 will be is described below).
8051 Then you can invoke @kbd{M-x elmo-split} to split messages according to
8052 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
8053 to do a rehearsal and show result (do not split actually).
8056 We will describe how to specify the rule. First of all, see following
8061 (setq elmo-split-rule
8062 ;; @r{Store messages from spammers into @samp{+junk}}
8063 '(((or (address-equal from "i.am@@spammer")
8064 (address-equal from "dull-work@@dull-boy")
8065 (address-equal from "death-march@@software")
8066 (address-equal from "ares@@aon.at")
8067 (address-equal from "get-money@@richman"))
8069 ;; @r{Store messages from mule mailing list into @samp{%mule}}
8070 ((equal x-ml-name "mule") "%mule")
8071 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
8072 ;; @r{and continue evaluating following rules}
8073 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
8074 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
8075 ((match from "\\(.*\\)@@yahoo\\.com")
8077 ;; @r{Store unmatched mails into @samp{+inbox}}
8082 The basic unit of the rule is a combination like
8085 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
8088 If @samp{CONDITION} is true, @samp{ACTION} is performed.
8089 The 1st element @samp{CONDITION} is a condition represented by a
8090 balanced expression (sexp). Its grammar will be explained below.
8091 The 2nd element @samp{ACTION} is the name of the folder to split
8092 messages into, or a symbol. When the 3rd element @code{continue} is
8093 specified as symbol, evaluating rules is not stopped even when the
8094 condition is satisfied.
8096 The grammar for @samp{CONDITION} is as follows. See example above to
8097 learn how to write the condition practically.
8101 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
8102 (@samp{FIELD-NAME} is a symbol that describes the field name)
8106 True if the field value equals to @samp{VALUE}.
8107 Case of the letters are ignored.
8109 True if the field value matches to VALUE.
8110 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
8111 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
8112 @item @code{address-equal}
8113 True if one of the addresses in the field equals to
8114 @samp{VALUE}. Case of the letters are ignored.
8115 @item @code{address-match}
8116 True if one of the addresses in the field matches to
8118 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
8119 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
8123 Functions which accept an integer argument (@samp{SIZE}).
8127 True if the size of the message is less than @samp{SIZE}.
8129 True if the size of the message is greater than @samp{SIZE}.
8133 Functions which accept any number of arguments.
8137 True if one of the argument returns true.
8139 True if all of the arguments return true.
8145 When a symbol is specified, it is evaluated.
8148 You can specify followings as 2nd @samp{ACTION}.
8154 If some string is specified, it will be regarded as the destination
8155 folder, and the message will be appended to it.
8160 If the symbol @samp{delete} is specified, delete the substance of the
8161 message in @code{elmo-split-folder}
8166 If the symbol @samp{noop} is specified, do nothing on the message and
8172 If some function is specified, execute it.
8175 If the message passes all rules, it will be dealed along @samp{ACTION}
8176 specified by @code{elmo-split-default-action}.
8179 @node Batch Processing, Advanced Settings, Split messages, Advanced Issues
8180 @section Batch Processing
8181 @cindex Batch Processing
8183 You can request wanderlust to do some job on the command line.
8184 For now, you can invoke prefetching new messages in specified folders.
8186 Specify target folders in @code{wl-batch-prefetch-folder-list} then
8187 invoke as follows to execute prefetching:
8191 % emacs -batch -l wl-batch -f wl-batch-prefetch
8195 @subsection Customize Variables
8198 @item wl-batch-prefetch-folder-list
8199 @vindex wl-batch-prefetch-folder-list
8200 Target folders of prefetching by @code{wl-batch-prefetch}, specified as
8201 a list of folder names.
8205 @node Advanced Settings, Customizable Variables, Batch Processing, Advanced Issues
8206 @section Advanced Settings
8209 * Draft for Reply:: Draft for Reply
8210 * Thread Format:: Appearance of Thread
8211 * User-Agent Field:: @samp{User-Agent:} Header Field
8215 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
8216 @subsection Draft for Replay
8217 @vindex wl-draft-reply-with-argument-list
8218 @vindex wl-draft-reply-without-argument-list
8220 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
8221 The addressee for the draft is decided by following rules.
8223 For example, you can set as follows:
8227 (setq wl-draft-reply-without-argument-list
8228 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8229 ("Followup-To" . (nil nil ("Followup-To")))
8230 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8231 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
8235 Where each element of the list @code{wl-draft-reply-without-argument-list}
8239 (key . (to-list cc-list newsgroup-list))
8242 and if the field designated by @samp{key} exist in the parent message,
8243 parent's field values designated by @samp{to-list} are copied to @samp{To:}
8244 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
8245 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
8246 the draft respectively.
8251 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8254 Match if the parent has @samp{Mail-Followup-To} field.
8255 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
8256 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
8260 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8263 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
8264 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
8267 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
8270 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
8271 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
8274 These are evaluated in order and first matched one is used.
8276 Moreover, the behavior of @kbd{a} with prefix argument can
8277 be directed by @code{wl-draft-reply-with-argument-list} as well.
8280 By the way, you can use some function (will be evaluated in the parent
8281 message buffer) in the place of @samp{key} or @samp{to-list} etc.
8283 If you want to write a rule for replying to message written by yourself,
8284 specify function @code{wl-draft-self-reply-p} as @samp{key}.
8286 If you only want to reply to mailing lists in
8287 @code{wl-subscribed-mailing-list} if the parent has some of them,
8292 (defun wl-mailing-list-addresses ()
8296 (nth 1 (std11-extract-address-components addr)))
8299 (elmo-multiple-fields-body-list (list "To" "Cc"))
8301 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
8302 (setq list-addrs (cons to list-addrs))))
8303 (nreverse list-addrs)))
8305 (setq wl-draft-reply-with-argument-list
8306 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
8307 ("Reply-To" . (("Reply-To") nil nil))
8308 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
8309 ("From" . (("From") nil nil))))
8314 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
8315 @subsection Appearance of Threads
8319 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
8320 390 09/18(Fri)07:25 +-[ Tsumura-san ]
8321 391 09/18(Fri)19:24 +-[ Murata-san ]
8322 392 09/20(Sun)21:49 +-[ Okunishi-san ]
8323 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
8324 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
8325 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
8326 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
8327 412 09/22(Tue)09:28 | +-[ Teranishi ]
8328 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
8329 416 09/22(Tue)12:38 | +-[ Teranishi ]
8330 395 09/20(Sun)21:49 +-[ Okunishi-san ]
8331 397 09/21(Mon)00:15 +-[ Okunishi-san ]
8335 Settings to make appearance of threads like shown above:
8339 (setq wl-thread-indent-level 2)
8340 (setq wl-thread-have-younger-brother-str "+")
8341 (setq wl-thread-youngest-child-str "+")
8342 (setq wl-thread-vertical-str "|")
8343 (setq wl-thread-horizontal-str "-")
8344 (setq wl-thread-space-str " ")
8348 If you do not want to see branches, do the following:
8352 (setq wl-thread-indent-level 2)
8353 (setq wl-thread-have-younger-brother-str " ")
8354 (setq wl-thread-youngest-child-str " ")
8355 (setq wl-thread-vertical-str " ")
8356 (setq wl-thread-horizontal-str " ")
8357 (setq wl-thread-space-str " ")
8362 @node User-Agent Field, , Thread Format, Advanced Settings
8363 @subsection User-Agent Field
8367 If you are eccentric enough to elaborate @samp{X-Mailer:} or
8368 @samp{User-Agent:} fields, define a function that generate appropriate
8369 strings as you like, and set it to variable
8370 @code{wl-generate-mailer-string-function}.
8372 If you do not want verbose @samp{User-Agent:} field, do the following:
8376 (setq wl-generate-mailer-string-function
8377 'wl-generate-user-agent-string-1)
8381 The following is a example:
8385 (setq wl-generate-mailer-string-function nil)
8386 (setq wl-draft-additional-header-alist
8388 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
8393 @node Customizable Variables, Hooks, Advanced Settings, Advanced Issues
8394 @section Customizable Variables
8396 Customizable variables that have not been described yet:
8399 @item wl-default-folder
8400 @vindex wl-default-folder
8401 The initial setting is @samp{%inbox}. This is the default value for moving to
8402 a folder and the like.
8404 @item wl-draft-folder
8405 @vindex wl-draft-folder
8406 The initial setting is @samp{+draft}. It is the folder to which drafts are
8407 saved. It must be a writable folder.
8408 You can set IMAP remote folder, Maildir and so on.
8409 Note that variable settings applied by @code{wl-draft-config-exec} is saved
8410 under @code{elmo-msgdb-directory}. That is to say, if you specified remote
8411 folder as @code{wl-draft-folder}, variable settings which are applied by
8412 @code{wl-draft-config-exec} before saving the draft will not affect on the
8413 draft buffer on another host by invoking @code{wl-summary-reedit}.
8415 @item wl-trash-folder
8416 @vindex wl-trash-folder
8417 The initial setting is @samp{+trash}. It is the wastebasket folder.
8418 If you changed this variable, you had better restart Wanderlust.
8420 @item wl-interactive-exit
8421 @vindex wl-interactive-exit
8422 The initial setting is @code{t}.
8423 If non-nil, you are asked for confirmation when Wanderlust terminates.
8425 @item wl-interactive-send
8426 @vindex wl-interactive-send
8427 The initial setting is @code{t}.
8428 If non-nil, you are asked for confirmation when mail is sent.
8430 @item wl-default-sync-range
8431 @vindex wl-default-sync-range
8432 The initial setting is @samp{update}.
8433 Default update range of the summary. You can specify
8434 @samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
8435 See description of @code{wl-summary-sync} for the meaning of ranges.
8437 @item wl-folder-sync-range-alist
8438 @vindex wl-folder-sync-range-alist
8439 The initial setting is the alist shown below:
8444 ("^\\+draft$\\|^\\+queue$" . "all"))
8449 This is an associative list of regular expressions of folder names and
8450 update range of the summary. Update range is one of the @samp{all},
8451 @samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
8452 match any of them, the value of @code{wl-default-sync-range} is used
8453 (@samp{update} by default).
8454 See description of @code{wl-summary-sync} for the meaning of ranges.
8457 @vindex wl-ask-range
8458 The initial setting is @code{t}.
8459 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
8460 for updating the summary when you changed folders.
8462 @item wl-mime-charset
8463 @vindex wl-mime-charset
8464 The initial setting is @code{x-ctext}.
8465 This is the MIME charset for messages that are not MIME (e.g. without
8466 @samp{Content-Type:}). This value also used as default charset for
8467 summary. (If you want to share Summary on Nemacs and other Emacsen, set
8468 this value as @code{iso-2022-jp}.)
8470 @item wl-highlight-folder-with-icon
8471 @vindex wl-highlight-folder-with-icon
8472 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
8473 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
8475 @item wl-strict-diff-folders
8476 @vindex wl-strict-diff-folders
8477 This is a list of regular expressions of folders.
8478 Unread messages are checked, for example when you press @kbd{s} in
8479 the folder mode, usually in a brief way (rapidly processed but not
8481 The folders matching this variable are seriously checked.
8482 You may want to set this variable so as to match conditional filter
8483 folders for IMAP4 folders.
8484 The initial setting is @code{nil}.
8486 @item wl-folder-use-server-diff
8487 @vindex wl-folder-use-server-diff
8488 When unread messages are checked, for example when you press @kbd{s} in
8489 the folder mode, usually (the number of messages on the server) @minus{}
8490 (the number of local messages) will be the number of unread messages.
8491 However, if this variable is non-nil, the number of unread messages on
8492 the server is checked. This affects IMAP4 folders only, but IMAP4
8493 folders in mail boxes matching
8494 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
8495 the number of unread messages on the server, even if they matches this
8496 variable. The initial setting is @code{t}.
8498 @item wl-auto-check-folder-name
8499 @vindex wl-auto-check-folder-name
8500 The initial setting is @code{nil}.
8501 You can specify a folder or a group which is checked for unread message
8502 at the start. You can also specify a list of folders (groups) to be checked.
8503 If the value is @code{nil}, whole Desktop is checked at the start.
8504 If it is @code{none}, no folders are checked.
8506 @item wl-auto-uncheck-folder-list
8507 @vindex wl-auto-uncheck-folder-list
8508 The initial setting is the list shown below:
8517 You can set a list of regular expressions to specify folders
8518 which are not automatically checked even if they are included
8519 in some groups assigned by @code{wl-auto-check-folder-name}.
8521 @item wl-auto-check-folder-list
8522 @vindex wl-auto-check-folder-list
8523 The initial setting is @code{nil}.
8524 You can set a list of regular expressions to specify exceptions
8525 for @code{wl-auto-uncheck-folder-list}.
8527 @item wl-no-save-folder-list
8528 @vindex wl-no-save-folder-list
8529 The initial setting is the list shown below:
8538 This is a list of regular expressions of folders not to be saved.
8540 @item wl-save-folder-list
8541 @vindex wl-save-folder-list
8542 The initial setting is @code{nil}.
8543 This is a list of regular expressions of folders to be saved.
8544 This takes precedence over @code{wl-no-save-folder-list}.
8546 @item wl-folder-mime-charset-alist
8547 @vindex wl-folder-mime-charset-alist
8548 The initial setting is the alist shown below:
8552 (("^-alt\\.chinese" . big5)
8553 ("^-relcom\\." . koi8-r)
8555 ("^-han\\." . euc-kr))
8560 This is an associative list of regular expressions of folder names and
8562 If a folder do not match, @code{wl-mime-charset} is used.
8564 @item wl-folder-init-load-access-folders
8565 @vindex wl-folder-init-load-access-folders
8566 The initial setting is @code{nil}.
8567 This is a list of access groups to be loaded specifically at the start.
8568 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
8570 @item wl-folder-init-no-load-access-folders
8571 @vindex wl-folder-init-no-load-access-folders
8572 The initial setting is @code{nil}.
8573 This is a list of access groups not to be loaded specifically at the
8575 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
8577 @item wl-dispose-folder-alist
8578 @vindex wl-dispose-folder-alist
8579 The initial setting is the alist shown below:
8589 This list determines disposition of messages with disposal marks.
8590 Each item in the list is a folder and destination; you can specify any
8591 one of the following in the place of destination:
8594 @code{remove} or @code{null} : deletes the messages instantly.
8595 string : moves the messages to the specific folder.
8596 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
8599 @item wl-x-face-file
8600 @vindex wl-x-face-file
8601 The initial setting is @file{~/.xface}.
8602 The name of the file that contains encoded X-Face strings.
8605 @item wl-demo-display-logo
8606 @vindex wl-demo-display-logo
8607 If non-nil, bitmap image is shown on the opening demo. If you set
8608 @code{xpm} or @code{xbm}, (if possible) display selected image type
8611 @item elmo-use-database
8612 @vindex elmo-use-database
8613 This is meaningful for XEmacs only. The initial setting depends on
8614 XEmacs (@code{t} for XEmacs with dbm).
8615 If non-nil, Message-ID is controlled by dbm.
8617 @item elmo-nntp-list-folders-use-cache
8618 @vindex elmo-nntp-list-folders-use-cache
8619 The initial setting is 600 (in seconds).
8620 This is period in seconds during which results of @samp{list} and
8621 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
8624 @item elmo-nntp-max-number-precedes-list-active
8625 @vindex elmo-nntp-max-number-precedes-list-active
8626 The initial setting is @code{nil}.
8627 If non-nil, the number of article obtained by @samp{list active} in NNTP
8628 are used as the maximum article number of the folder.
8629 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
8630 and if the number of read messages is not correct.
8632 @item elmo-nntp-default-use-listgroup
8633 @vindex elmo-nntp-default-use-listgroup
8634 The initial setting is @code{t}.
8635 If non-nil, @samp{listgroup} is used for checking the total number of
8636 articles. If it is @code{nil}, @samp{group} is used. In the latter
8637 case, the processing will be a little faster at the sacrifice of
8640 @item elmo-pop3-send-command-synchronously
8641 @vindex elmo-pop3-send-command-synchronously
8642 The initial setting is @code{nil}.
8643 If non-nil, POP3 commands are issued synchronously. Some implementation
8644 of POP3 server fails to get summary information without this setting.
8645 You may have to set this variable to @code{t}, if the process hangs
8646 while looking up POP3.
8648 @item elmo-dop-flush-confirm
8649 @vindex elmo-dop-flush-confirm
8650 The initial setting is @code{t}.
8651 If non-nil, you are asked for confirmation if accumulated off-line
8652 operations are executed.
8654 @item elmo-display-progress-threshold
8655 @vindex elmo-display-progress-threshold
8656 The initial setting is 20.
8657 Threshold for display of progress gauge. If number of renewal is more than
8658 this value, display progress gauge.
8662 @node Hooks, , Customizable Variables, Advanced Issues
8668 @node Migration, Terminology, Advanced Issues, Top
8669 @chapter Switch from older version of Wanderlust
8672 This chapter explains the important thing for the upgrade,
8673 or migration from the previous version.
8674 It includes the changes of the setup, limitations etc.
8677 * Before 2.12.0:: From prior to the version 2.12.0
8680 @node Before 2.12.0, , Migration, Migration
8681 @section Migration from prior to the version 2.12.0
8683 @subsection The conversion of msgdb
8685 From version 2.12.0 on, the structure of msgdb is changed.
8686 The msgdb for newly created folder will use this new format when created and saved.
8687 But by writing following line, you may use the old format of the msgdb as it was.
8691 (setq elmo-msgdb-default-type 'legacy)
8695 With the default setup,
8696 the old msgdb format will be used as it was.
8697 You may convert the format
8698 by writing following lines in @file{~/.wl} or so.
8702 ;; @r{If the format of msgdb is different from} @code{elmo-msgdb-default-type},
8703 ;; @r{the format will be converted automatically when}
8704 ;; @r{the msgdb is being loaded.}
8705 (setq elmo-msgdb-convert-type 'auto)
8707 ;; @r{Convert msgdb when hitting @kbd{s all} in Summary mode}
8708 (setq elmo-msgdb-convert-type 'sync)
8712 As is explained in above section, you may continue to use the old format.
8713 But you will have following limitations.
8717 You may only use @samp{important} flag. The other flags may not be available.
8720 @subsection Changes from @samp{'mark} folder to @samp{'flag}.
8722 The folder @samp{'mark} will be automatically converted to @samp{'flag}
8723 folder when you first start the new version of Wanderlust.
8724 But there are some restrictions on this type of migrated folder.
8728 @samp{important} flag attached will not be
8729 removed by deleting the associated message in @samp{'flag} folder.
8732 The message won't be deleted by removing
8733 @samp{important} flag in @samp{'flag} folder.
8736 help-echo will not show you the old message.
8740 If you have problem with migrating
8741 from @samp{'mark} folder to the @samp{'flag} folder,
8743 @kbd{M-x elmo-global-mark-upgrade} will transfer the message
8744 from @samp{'mark} folder to the @samp{'flag} folder.
8745 The duplicated message will not be processed,
8746 you may issue that command repeatedly.
8749 @node Terminology, Mailing List, Migration, Top
8750 @chapter Terminology around Wanderlust
8753 Here we explain terminologies used in this manual.
8757 A container in which messages are stored.
8760 A set consists of some folders.
8763 A special group consists of automatically collected folders under
8764 some specified path.
8765 @xref{Folder Definition}.
8767 @item summary buffer
8768 A buffer for displaying list of messages in some folder.
8770 @item sticky summary
8771 Compared with ordinary summary buffer which will be destroyed after
8772 exiting from it, this type of summary will be remain even after exiting
8773 by @kbd{q} or @kbd{g}.
8774 @xref{Sticky Summary}.
8777 To delete or put into the archive expired messages.
8784 To cache messages beforehand in order to read messages after you will be
8785 disconnected from the server.
8789 @node Mailing List, Addition, Terminology, Top
8790 @chapter Wanderlust Mailing List
8794 Topics related to Wanderlust are discussed in following mailing lists.
8795 The latest version is also announced there.
8798 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
8801 In this list Japanese is mainly used for discussion. We also have a list
8802 for discussion in English:
8805 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
8807 (Messages posted to this list are also forwarded to the former one.)
8809 A guide can be obtained automatically by sending mail to
8810 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
8811 the English one) with the body
8817 Please send bug reports or patches to one of those lists. You can post to
8818 the mailing list even though you are not a member of it.
8820 If you send a bug report, please attach Backtrace with it.
8821 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
8824 I would like to express my thanks to the members of the mailing list for
8825 valuable advice and many pieces of code they contributed.
8829 You can read messages posted to the mailing list on the web or in
8832 Read messages posted to @t{<wl@@lists.airs.net>}
8835 @uref{http://lists.airs.net/wl/archive/}
8836 @uref{news://gmane.mail.wanderlust.general.japanese@@news.gmane.org}
8839 Read messages posted to @t{<wl-en@@lists.airs.net>}
8842 @uref{http://lists.airs.net/wl-en/archive/}
8843 @uref{news://gmane.mail.wanderlust.general@@news.gmane.org}
8847 @node Addition, Index, Mailing List, Top
8848 @chapter Additional Information
8850 @section Brief History
8853 1998 3/05 Tried to make a prototype that displays MH messages in threads.
8854 3/10 Made a msgdb mechanism by elisp.
8855 3/26 IMAP and NNTP can be displayed in threads.
8856 4/13 Began to assemble thread display modules as elmo.
8857 5/01 Finished 0.1.0, initial version with many defects.
8858 6/12 I made a slip of the tongue and said I was writing elisp
8859 mailer supporting IMAP
8860 6/16 0.1.3 was announced at tm-ja, elisp ML.
8861 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
8862 7/01 Support for mm-backend (0.3.0).
8863 8/25 multi folder added (0.5.0).
8864 8/28 filter folder added (0.5.1).
8865 9/10 You can open/close threads (0.6.0).
8866 9/11 fldmgr by Murata-san made editing folders easy.
8867 9/18 lha folders added by Okunishi-san (0.6.3).
8868 9/24 Display of branches of threads (0.6.5).
8869 9/28 Compression folder supporting multiple archivers by Okunishi-san.
8870 10/28 Off-line operations (0.7.4).
8871 12/09 Becomes beta version.
8872 12/21 wl-expire by Murata-san.
8873 1999 2/03 auto-refile by Tsumura-san.
8874 4/28 wl-template by Murata-san.
8875 5/18 Released 1.0.0 stable.
8876 7/05 Scoring by Murata-san (2.1.0).
8877 9/26 New plugged system by Murata-san (2.2.2).
8878 12/20 Support Modified UTF7.
8879 2000 3/24 Released 1.1.0 stable.
8880 4/03 CVS development started.
8881 5/07 Thread restoration & Its speed up with Murata-san.
8882 6/12 Address completion with LDAP with Chiba-san & Goto-san.
8883 7/11 killed message feature.
8884 7/18 Use UIDL in POP3.
8885 9/12 biff feature with Satata-san & Yamaoka-san.
8886 10/17 expire-hide by Okada-san.
8887 11/08 Released 2.4.0 stable.
8888 2001 7/04 Released 2.6.0 stable.
8889 8/21 wl-addrmgr by Kitamoto-san.
8890 12/27 Released 2.8.1 stable.
8891 2002 12/11 Released 2.10.0 stable.
8892 2003 7/05 Released 2.10.1 stable.
8893 9/18 flag folder is added.
8894 9/20 New msgdb format (modb-standard) by H.Murata-san.
8895 10/20 Spam filter by H.Murata-san.
8896 2004 1/06 Background color of the demo become configurable.
8897 2/09 'file' folder is added.
8898 9/12 forwarded mark.
8899 Default value of the mark strings are changed.
8902 See @file{ChangeLog} for details.
8906 According to a dictionary, Wanderlust has the meaning:
8910 n eager longing for or impulse towards travelling in distant lands
8911 [Ger, fr wandern to wander + lust desire, pleasure]
8915 but I had no profound intention. (if farfetched, IMAP @result{} you can
8916 read mail anywhere @result{} desire to wander ?)
8918 Elmo is the abbreviation of @samp{Elisp Library for Message
8919 Orchestration}. At first I meant the red puppet in the Sesame Street,
8920 but you may associate it with Wandering @result{} Drifting @result{}
8921 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
8925 Each versions has code names (they are almost jokes).
8926 Currently they are picked up alphabetically from the top 40 hits of
8927 U.S. Billboard magazines in 1980s.
8929 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
8932 @node Index, , Addition, Top
8936 * Concept Index:: Concept Index
8937 * Key Index:: Key Index
8938 * Variable Index:: Variable Index
8939 * Function Index:: Function Index
8942 @node Concept Index, Key Index, Index, Index
8943 @unnumberedsec Concept Index
8946 @node Key Index, Variable Index, Concept Index, Index
8947 @unnumberedsec Key Index
8950 @node Variable Index, Function Index, Key Index, Index
8951 @unnumberedsec Variable Index
8954 @node Function Index, , Variable Index, Index
8955 @unnumberedsec Function Index