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 * Split messages:: Splitting messages
122 * Address Book:: Management of Address Book
123 * Spam Filter:: Spam filtering
124 * Customization:: Customizing 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}, 13 types of folders are predefined. These
675 are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP,
676 Shimbun, Namazu, Multi, Filter, Pipe and Internal 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
695 @node IMAP Folder, NNTP Folder, Folders, Folders
703 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
709 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
713 You can specify @code{login} (encoded password transmission),
714 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
715 authentication) or @code{clear} (or @code{nil}, plain password
716 transmission) as @var{authenticate-type}.
721 @var{username} -> The value of @code{elmo-imap4-default-user}.
722 Initial setting is @env{USER} environment variable or
723 @env{LOGNAME} environment variable or return value of
724 @code{(user-login-name)}.
725 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
726 Initial setting is "auth".
727 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
728 Initial setting is "localhost".
729 @var{port} -> The value of @code{elmo-imap4-default-port}.
730 Initial setting is 143.
733 You can omit the @var{hostname} from folder names if you set
734 @code{elmo-imap4-default-server} as your main IMAP server.
735 For example, you can specify a folder as @samp{foo%imap@@gateway} even
736 if you have to go through a firewall.
740 ;; @r{Example: imap4.exaple.org as main IMAP server}
741 (setq elmo-imap4-default-server "imap4.example.org")
745 SSL (Secure Socket Layer) connection will be used if a folder name ends
746 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
747 is @code{ssl}, SSL will be the default connection. If a folder name
748 ends with @samp{!!}, STARTTLS connection will be established. If the
749 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
750 STARTTLS will be the default connection.
754 ;; @r{Example: Use SSL connection}
755 (setq elmo-imap4-default-stream-type 'ssl)
759 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
760 authentication method, the password is sent in encoded form. But, if
761 your server is unable to receive an encoded password, authentication
762 will fall back to @code{clear} (that is, sending password in raw format)
763 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
764 authentication will fall back to @code{clear} without confirmation
765 (default value is @code{nil}).
769 ;; @r{Example: password in raw format}
770 (setq elmo-imap4-default-authenticate-type 'clear)
778 %inbox -> IMAP mailbox "inbox"
779 %#mh/inbox -> IMAP mailbox "#mh/inbox"
781 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
782 %inbox:hoge/clear@@server1
783 -> server1's IMAP mailbox "inbox"
784 of user "hoge", with plain password authentication
789 @subsection International mailbox names (Modified UTF7)
790 @cindex Modified UTF7
797 You can use international mailbox names in @var{mailbox} part, if you
798 are using Emacs with UTF-7 support and
799 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
800 value is @code{nil}).
802 Currently, Mule-UCS package is required to use UTF-7.
803 Mule-UCS works on following Emacsen.
806 @item Emacs 20.3 or later
807 @item XEmacs 21.2.37 or later
810 You can obtain Mule-UCS package from following URL.
813 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
816 @node NNTP Folder, MH Folder, IMAP Folder, Folders
827 A folder to access USENET news via NNTP protocol (RFC 977).
828 One newsgroup is treated as a folder.
834 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
840 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
841 Initial setting is @samp{localhost}.
842 @var{username} -> The value of @code{elmo-nntp-default-user}.
843 Initial setting is @code{nil}.
844 @var{port} -> The value of @code{elmo-nntp-default-port}.
845 Initial setting is 119.
848 AUTHINFO is used as authentication method if the @var{username} is
849 non-nil. SSL will be default method if
850 @code{elmo-nntp-default-stream-type} is @code{ssl} even if the folder name
851 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
852 STARTTLS connection will be established. if the value of
853 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
854 be the default connection.
860 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
861 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
866 @node MH Folder, Maildir Folder, NNTP Folder, Folders
873 A folder to access MH format mail (1 file is 1 mail).
878 @samp{+} @var{directory-name}
881 Normally, @var{directory-name} is an relative path to the variable
882 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
883 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
884 (this is also true for drive-letters).
886 Message number is used for the name of the message file.
892 +inbox -> @file{~/Mail/inbox}
893 +from/teranisi -> @file{~/Mail/from/teranisi}
894 +~/test -> @file{~/test}
899 @node Maildir Folder, News Spool Folder, MH Folder, Folders
900 @section Maildir Folder
902 @cindex Maildir Folder
906 A folder to access Maildir format (1 file is 1 mail).
911 @samp{.} [@var{directory-name}]
914 Normally, @var{directory-name} is a relative path to the variable
915 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
916 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
917 (this is also true for drive-letters).
919 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
920 Messages are contained in the @file{cur} directory. All message files
921 in the @file{new} directory are moved to @file{cur} directory when you
922 access the folder. All message files contained in the @file{tmp}
923 directory and not accessed for 36 hours are deleted.
925 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
931 . -> @file{~/Maildir}
932 .inbox -> @file{~/Maildir/inbox}
933 .from/teranisi -> @file{~/Maildir/from/teranisi}
934 .~/test -> @file{~/test}
939 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
940 @section News Spool Folder
942 @cindex News spool Folder
945 This folder handles locally saved news articles which are proposed by
946 Mew/IM. You can also read articles directly from a spool-file which is
947 retrieved by an utility like @command{gnspool}.
952 @samp{=} @var{directory-name}
955 @var{directory-name} is a sub-directory to the directory defined by
956 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
957 You can use @samp{.} as directory delimiter as well as @samp{/}.
963 =fj/os/os2 -> @file{~/News/fj/os/os2}
964 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
969 @node Archive Folder, POP Folder, News Spool Folder, Folders
970 @section Archive Folder
972 @cindex Archive Folder
975 This method can handle archive files, which are compressed by utilities
976 such as Info-ZIP or LHA, as one folder.
982 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
986 @var{path-name} is the relative path from
987 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
988 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
989 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
990 also permitted under the environment of ange-ftp, efs.
992 The actual file name of the archive folder is
993 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
994 under the @var{path-name}. If a file named @var{path-name} exists, it is
995 treated as folder. The suffix is automatically decided for
998 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
999 (Initial setting is @code{zip}) is referred.
1001 @var{prefix} specifies the internal directory structure of the archive.
1002 For example, if the ML server is fml, @file{msend.tar.gz} has a
1003 structure like @file{spool/1}, so you have to specify @samp{spool} as
1010 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1011 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1012 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1013 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1014 $ml;zip/ -> Access group consists of archive folders
1015 under @file{~/Mail/ml}
1020 * Archiver:: Supported Archivers
1021 * Archive Tips:: TIPS
1022 * Archive Vars:: Customization
1026 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1027 @subsection Supported Archives
1037 By default, following archives are supported.
1041 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1042 GNU TAR('tgz, 'tar) ;; read-only
1046 If your archiver can include multiple files in one archive, you have a
1047 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1048 of the candidate. TAR is supported read-only because it cannot delete
1049 file in the archive (@code{mv})).
1051 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1052 archiver of Wanderlust because they cannot include multiple
1053 files. Archivers that cannot extract files to standard output are also
1056 @subsection OS specific information about archiver.
1058 Behaviors of the following archivers are confirmed by further experiences.
1059 (@samp{*} mark means recommended archiver).
1062 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1063 LHA OS/2 version Rel.2.06b Feb 18, 1998
1064 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1065 *Zip 2.2 (November 3rd 1997).
1066 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1067 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1068 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1070 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1071 LHa for UNIX V 1.14c
1072 UnZip 5.32 of 3 November 1997
1073 Zip 2.2 (November 3rd 1997)
1074 GNU tar 1.12 (1.11.x is no good)
1075 gzip 1.2.4 (18 Aug 93)
1077 [Win32] Win.98/Meadow
1081 GNU tar 1.11.8 + 1.5(WIN32)
1088 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1089 Hiramatsu version of LHA is only supported.
1090 In Win32, LHa32 is only supported (DOS version is no good).
1092 * Caution about GNU tar
1094 You have to take care about GNU tar's version because many version has
1095 problem on deleting file from archive.
1097 Please test @option{--delete} @option{-f} options work. Otherwise, your
1098 archive will be destroyed. No problem is reported on above versions of
1102 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1104 @cindex Archive Tips
1106 For comfortable migration, usage of @code{wl-summary-archive}
1107 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1108 archive folders created by expiration, you must set non-nil value to
1109 @code{elmo-archive-treat-file}.
1111 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1112 in processing speed. For comfortable use, Emacs20 is recommended.
1113 (If re-search's performance is the problem, 19.3x or later may be okay.)
1115 If many files are included in one archive,
1116 it takes long time to access the archive folder because
1117 archiver starting overhead is increased (especially LHA).
1118 150-200 messages in one archive is recommended.
1120 Of course, following is possible @t{:-)}
1121 (meanings of these variables are described later.)
1125 (setq wl-fcc "$backup")
1126 (setq wl-trash-folder "$trash;lha")
1130 @node Archive Vars, , Archive Tips, Archive Folder
1131 @subsection Variables About Archive Folder
1132 @cindex Archive variables
1135 @item elmo-archive-default-type
1136 @vindex elmo-archive-default-type
1137 The initial setting is @code{zip}.
1138 Set archiver type by symbol.
1140 @item elmo-archive-@var{type}-method-alist
1141 @vindex elmo-archive-TYPE-method-alist
1142 Define archiver @var{type}'s methods.
1143 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1144 Each element of the alist is following.
1148 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1149 (@var{action} . @var{function}) ;; function
1153 Currently available actions are following.
1157 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1158 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1165 actions enclosed with braces are optional (They are used for better
1168 @item elmo-archive-suffix-alist
1169 @vindex elmo-archive-suffix-alist
1170 An alist of archiver-type (symbol) and suffix.
1172 @item elmo-archive-file-regexp-alist
1173 @vindex elmo-archive-file-regexp-alist
1174 An alist of a regexp to get file number from list output of archiver
1175 and archiver-type (symbol).
1177 @item elmo-archive-method-list
1178 @vindex elmo-archive-method-list
1179 A list of elmo-archive-@var{type}-method-alist
1180 (@var{type} is a symbol of archiver-type).
1182 @item elmo-archive-lha-dos-compatible
1183 @vindex elmo-archive-lha-dos-compatible
1184 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1185 DOS (Mr. Yoshizaki original) compatible.
1187 @item elmo-archive-cmdstr-max-length
1188 @vindex elmo-archive-cmdstr-max-length
1189 The initial setting is 8000.
1191 Max length of command line argument for external archiver program.
1192 Emacs does not have a limit of command line byte length, but some OS
1193 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1194 this limit because it calls external archiver program directly (not
1195 called via shell). For example, you cannot delete messages if archiver
1196 program must receive larger bytes of arguments to delete. OS/2 have a
1197 command line argument limit of 8190 bytes, so we defined default as 8000
1200 However, you don't have an influence of command line argument limit
1201 if the archiver has `actions' to receive target file information from
1202 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1206 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1214 A folder to access e-mails via POP3 protocol (RFC 1939).
1220 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1225 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1226 as @var{authenticate-type}.
1228 You can specify @samp{uidl} (use UIDL command for message numbering) or
1229 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1233 @var{username} -> The value of @code{elmo-pop3-default-user}.
1234 Initial setting is @env{USER} environment variable or
1235 @env{LOGNAME} environment variable or return value of
1236 @code{(user-login-name)}.
1237 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1238 Initial setting is @samp{user}.
1239 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1240 If t, use UIDL for numbering. Initial setting is t.
1241 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1242 Initial setting is @samp{localhost}.
1243 @var{port} -> The value of @code{elmo-pop3-default-port}.
1244 Initial setting is 110.
1251 &hoge@@localhost -> access localhost as user @samp{hoge}.
1252 &hoge@@popserver:109 -> access the server "popserver" on port 109
1253 as user @samp{hoge}.
1257 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1258 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1259 @file{utils/sasl/lisp/} or Emacs/W3 package
1260 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1263 If the last character of the folder name is @samp{!}, Wanderlust
1264 connects to the POP server via SSL (Secure Socket Layer). If you set
1265 @code{ssl} to @code{elmo-pop3-default-stream-type}, you don't have to put
1266 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1267 with @samp{!!}, STARTTLS connection will be established. if the value
1268 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1272 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1273 @section Shimbun Folder
1275 @cindex Shimbun Folder
1276 @cindex Folder, Shimbun
1281 A folder for watching "shimbun" (means "newspaper" in Japanese),
1282 news site and mailing list archives on WWW by using emacs-w3m
1283 (@uref{http://emacs-w3m.namazu.org/}).
1285 You should possess w3m and emacs-w3m to use this.
1291 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1295 Admissible values of @var{module-name} and @var{folder-name} are
1296 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1302 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1303 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1307 @subsection Variables About Shimbun Folder
1310 @item elmo-shimbun-update-overview-folder-list
1311 @vindex elmo-shimbun-update-overview-folder-list
1312 The initial setting is @code{all}. Specify a set of folders to update
1313 overview when messages are fetched. Specify @code{all} to update
1314 overview in all shimbun folders. You can specify a list of regular
1315 expressions of shimbun folder names to restrict affected folders.
1320 (setq elmo-shimbun-update-overview-folder-list
1321 '("^@@airs\\." "^@@namazu\\."))
1324 @kbd{s rescan} is needed after fetching to update summary view.
1328 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1329 @section Namazu Folder
1331 @cindex Namazu Folder
1332 @cindex Folder, Namazu
1333 @cindex Folder, Text Search
1336 A folder to access messages found in namazu-index with some condition.
1337 It uses namazu (@uref{http://www.namazu.org/}) for search.
1343 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1347 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1353 [wanderlust] -> search messages matched with
1354 "wanderlust" from the default index
1355 [semi flim]~/Mail/semi -> search "semi flim" from the index
1356 in the directory "~/Mail/semi"
1362 @subsubsection Enter space to separate keywords
1364 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1366 @subsubsection Alias name for index
1368 You can define an alias name for index.
1373 (setq elmo-nmz-index-alias-alist
1374 '(("cache" . "~/.elmo/cache")
1375 ("docs" . "~/documents")))
1378 Above definition defines two index aliases.
1385 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1386 directory @file{~/.elmo/cache}.
1388 @subsubsection Multiple indices
1390 You can specify a list for @code{elmo-nmz-default-index-path} and
1391 @code{elmo-nmz-index-alias-alist}.
1392 When list is specified, all index contained in the list is used as the
1398 (setq elmo-nmz-index-alias-alist
1399 '(("all" . ("~/.elmo/cache" "~/documents"))
1400 ("cache" . "~/.elmo/cache")))
1403 Using above alias setting, you can specify
1409 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1410 directory @file{~/.elmo/cache} and @file{~/documents}.
1412 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1413 @section Multi Folder
1415 @cindex Multi Folder
1416 @cindex Folder, Multiple
1417 @cindex Folder, Marge
1419 A folder to access virtual folder which collects messages from
1426 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1430 After @samp{*} character, specify multiple folders you want to collect
1431 separated by @samp{,} like
1432 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1438 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1439 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1440 treated as one folder.
1442 *+inbox,-fj.rec.tv,%inbox
1443 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1448 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1449 @section Filter Folder
1451 @cindex Filter Folder
1452 @cindex Folder, Filtering
1453 @cindex Folder, Virtual
1454 @cindex Folder, Conditional
1456 A folder to access virtual folder which collects all messages that
1457 satisfy a condition.
1462 @samp{/} @var{condition} @samp{/} @var{target-folder}
1465 In the @var{condition} part, you can specify following.
1469 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1471 first: @var{number} messages are picked from top of folder.
1472 last: @var{number} messages are picked from bottom of folder.
1478 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1479 /first:20/%inbox -> First 20 messages from %inbox are picked.
1484 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1486 since: only messages arrived since @var{date} are picked.
1487 before: only messages arrived before @var{date} are picked.
1489 You can specify following as @var{date}.
1493 yesterday -> a day before today.
1494 lastweek -> same day of last week.
1495 lastmonth -> same day of last month.
1496 lastyear -> same day of last year.
1497 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1498 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1506 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1508 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1514 Field filter: @samp{@var{field}:@var{value}}
1516 All messages that have @var{field} and its value is @var{value} are picked.
1517 @var{field} and @var{value} are case insensitive.
1523 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1524 and its value includes "teranisi" string are picked.
1525 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1533 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1534 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1536 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1537 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1543 /from:teranisi&!to:teranisi/+inbox
1544 -> In +inbox, messages are picked if the message's
1545 From: field includes "teranisi" and
1546 To: field doesn't include "teranisi".
1548 /tocc:"Yuuichi Teranishi"/+inbox
1549 -> In +inbox, messages are picked if the
1550 message's To: field or Cc: field includes
1551 "Yuuichi Teranishi".
1553 /(from:yt|from:teranisi)&subject:report/+inbox
1554 -> In +inbox, messages are picked if the message's
1555 From: field includes "yt" or "teranisi", and
1556 Subject includes "report".
1562 Tip for string description:
1564 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1565 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1566 should be escaped with @samp{\} in it). You can enclose the string with
1567 @samp{"} even it does not contain these characters.
1573 *%inbox,/from:teranisi/%inbox@@server
1574 -> Messages in %inbox or
1575 message is in the %inbox@@server folder and it's From field
1576 includes "teranisi" are collected.
1578 /last:100//to:teranisi/*+inbox,%inbox
1579 -> Latest 100 messages which is in the +inbox or %inbox folder
1580 and To: field matches "teranisi".
1582 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1583 -> Pick messages which have From: field and it includes "hogehoge"
1584 from latest 20 messages in the %#mh/inbox@@localhost
1585 and To: or Cc: field includes "teranisi".
1588 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1589 @section Pipe Folder
1593 @cindex Download Message
1594 @cindex Incorporate Message
1596 In the pipe folder, messages are automatically transferred from the source
1597 folder to destination folder.
1602 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1605 When you access the pipe folder, messages are automatically transferred
1606 from @var{source-folder} to @var{destination-folder}.
1607 It is convenient if you want to download messages to local disk via POP.
1608 For example, if you specify following
1611 |&username@@popserver|+inbox
1615 and access it, Wanderlust downloads messages from
1616 @samp{&username@@popserver} to @samp{+inbox} automatically.
1618 On the other hand, if you put @samp{|:} instead of second @samp{|},
1619 then messages are copied to the destination folder (not deleted from
1620 source-folder). At the next time you access that folder, copies new
1624 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1627 If you want to copy messages from POP server and view them, specify the
1631 |&username@@popserver|:+inbox
1634 where messages will be kept on the server.
1640 |%inbox|%myinbox -> Download %inbox to %myinbox.
1641 |*&user@@popserver1,&user@@popserver2|+inbox
1642 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1643 |-gnu.emacs.sources|:+sources
1644 -> Copy messages from -gnu.emacs.sources to +sources.
1648 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1650 @node Internal Folder, , Pipe Folder, Folders
1651 @section Internal folder
1653 @cindex Internal Folder
1654 @cindex Folder, @samp{$} mark
1656 @c @cindex Folder, Null
1658 A folder to access internal messages of Wanderlust.
1664 @samp{'flag} [@samp{/} @var{global-flag}]
1666 @samp{'cache/00} - @samp{'cache/1F}
1670 A folder named @samp{'flag} is a special virtual folder which collects
1671 messages which have @var{global-flag}.
1673 Now, @samp{important} flag is supported as @var{global-flag}. You can
1674 review important messages at once after you put important marks on the
1675 messages in the different folders.
1677 In this folder, if you delete message, @var{global-flag} put on the
1678 message is removed. If you append messages to this folder, the message
1679 will have @var{global-flag}.
1682 A folder named @samp{'sendlog} is a virtual folder which collects
1683 cached messages which are recoded on @file{~/.elmo/sendlog}.
1684 It might be useful when you forgot to add cc for yourself.
1685 To use this, you should set @code{wl-draft-use-cache} to non-nil
1686 so that sent messages are cached.
1689 You can access cached messages fetched via network by accessing
1690 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1691 the name of the subdirectories of the cache directory
1692 (@file{~/.elmo/cache}).
1695 @node Folder, Summary, Folders, Top
1696 @chapter Folder mode
1699 After you start Wanderlust, folder mode is appeared firstly.
1700 It contains folder list you subscribed.
1701 You can select and edit folders in this mode.
1704 * Selecting Folder:: Select folder you want to read
1705 * Folder Manager:: Editing folders
1709 @node Selecting Folder, Folder Manager, Folder, Folder
1710 @section Selecting Folder
1711 @cindex Selecting Folder
1713 @subsection Usage (TIPS)
1715 @subsubsection Check new, unread number
1717 Folder mode looks like this.
1718 (In XEmacs, it looks much nicer @t{;-)})
1722 [-]Desktop:14186/35580/67263
1727 [-]Emacsen:0/34/4837
1728 Wanderlust ML:0/0/558
1731 XEmacs Beta:0/29/255
1742 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1746 @kbd{s} key on the folder line updates these numbers.
1747 It changes its color if it has many new messages.
1749 The whole folder mode is a folder group named @samp{Desktop}.
1750 Folder group open/close by return key.
1751 A operation to a folder group is treated as operations on the
1753 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1754 six children folders update its unread number status.
1756 @subsubsection Select Folder
1758 To enter summary mode of the folder, type return (or space) key on
1760 If the variable @code{wl-stay-folder-window} has non-nil value,
1761 summary window appears on the right of the folder mode window.
1763 @subsection Key bindings
1765 Folder mode's key binding (related to selecting folders) is following.
1770 @kindex @key{SPC} (Folder)
1771 @kindex @key{RET} (Folder)
1772 @findex wl-folder-jump-to-current-entity
1773 Enter to the summary mode of the folder at the current cursor point.
1774 With prefix argument, enter the sticky summary.
1775 If the cursor is on the top of folder group line,
1776 the folder group is opened or closed.
1777 When the cursor is on the access group and this command is called
1778 with prefix argument, folder children list is updated to the newest one.
1779 (Children list is updated recursively if the access folder has hierarchical
1781 (@code{wl-folder-jump-to-current-entity})
1784 @kindex M-@key{RET} (Folder)
1785 @findex wl-folder-update-recursive-current-entity
1786 Folder children list of the access group at the current cursor point
1787 is updated to the newest one.
1788 (Children list is updated recursively if the access folder has hierarchical
1790 (@code{wl-folder-update-recursive-current-entity})
1795 Create a new draft message.
1800 @findex wl-folder-write-current-folder
1801 If the current cursor point is on the NNTP folder, create a new draft
1802 message which already has @samp{Newsgroups:} field. If the current
1803 cursor point is on the folder for mailing list (refile destination),
1804 create a new draft message which already has @samp{To:} field with
1805 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1807 (@code{wl-folder-write-current-folder})
1810 @kindex C-c C-o (Folder)
1811 @findex wl-jump-to-draft-buffer
1812 Move to the draft buffer if available. If multiple draft buffer exists,
1813 moved to one after another. If prefix argument is specified, load draft
1814 folder's message to the draft buffer and jump to it.
1815 (@code{wl-jump-to-draft-buffer})
1819 @findex wl-folder-check-current-entity
1820 Update new and unread number information of the folder at the current
1822 (@code{wl-folder-check-current-entity})
1826 @findex wl-folder-sync-current-entity
1827 Update summary information of the folder at the current cursor point.
1828 (@code{wl-folder-sync-current-entity})
1831 @kindex r s (Folder)
1832 @findex wl-folder-check-region
1833 Update new and unread number information of the folders in the currently
1835 (@code{wl-folder-check-region})
1838 @kindex r S (Folder)
1839 @findex wl-folder-sync-region
1840 Update summary information of the folders in the currently selected region.
1841 (@code{wl-folder-sync-region})
1845 @findex wl-status-update
1846 Sync up address book status with @file{~/.addresses}'s content.
1847 (@code{wl-status-update})
1851 @findex wl-folder-prev-unread
1852 Jump cursor to the folder which have unread messages on the upward from
1853 current cursor point.
1854 (@code{wl-folder-prev-unread})
1858 Jump cursor to the folder which have unread messages on the downward
1859 from current cursor point.
1860 (@code{wl-folder-next-unread})
1864 Move cursor to the folder on the previous line.
1865 (@code{wl-folder-prev-entity})
1869 Move cursor to the folder on the next line.
1870 (@code{wl-folder-next-entity})
1874 Jump to the folder specified by the user input.
1875 (@code{wl-folder-jump-folder})
1879 @findex wl-folder-prefetch-current-entity
1880 Prefetch new messages of the folder at the current cursor point by
1881 @code{wl-summary-incorporate}.
1882 If the cursor is on the folder group, it is executed recursively.
1883 (@code{wl-folder-prefetch-current-entity})
1887 @findex wl-folder-mark-as-read-all-current-entity
1888 Mark all unread messages of the folder at the current cursor point as read.
1889 If the cursor is on the folder group, it is executed recursively.
1890 (@code{wl-folder-mark-as-read-all-current-entity})
1894 @findex wl-folder-goto-first-unread-folder
1895 Enter summary mode of the first unread folder.
1896 (@code{wl-folder-goto-first-unread-folder})
1900 @findex wl-folder-empty-trash
1902 (@code{wl-folder-empty-trash})
1906 @findex wl-folder-flush-queue
1908 (@code{wl-folder-flush-queue})
1912 @findex wl-folder-virtual
1913 Move to the virtual folder (filter folder) with the condition specified.
1914 (@code{wl-folder-virtual})
1918 @findex wl-folder-pick
1919 Search the folders with the condition specified.
1920 (@code{wl-folder-pick})
1924 @findex wl-folder-open-all-unread-folder
1925 All unread folder is opened.
1926 (@code{wl-folder-open-all-unread-folder})
1930 @findex wl-folder-open-close
1931 Folder group is opened/closed.
1932 (@code{wl-thread-open-close})
1936 All folder group is opened.
1937 (@code{wl-folder-open-all})
1941 All folder group is closed.
1942 (@code{wl-folder-close-all})
1952 (@code{wl-folder-suspend})
1955 @kindex M-s (Folder)
1956 Save current folder status.
1960 @kindex M-t (Folder)
1961 Toggle Wanderlust's offline/online status.
1962 (@code{wl-toggle-plugged})
1965 @kindex C-t (Folder)
1966 Start Wanderlust's plug-status manager.
1967 (@code{wl-plugged-change})
1970 @subsection Customize variables
1973 @item wl-folders-file
1974 @vindex wl-folders-file
1975 The initial setting is @file{~/.folders}.
1976 Subscribed folders are described (saved) in this file.
1978 @item wl-folder-info-save
1979 @vindex wl-folder-info-save
1980 The initial setting is @code{t}. If non-nil, unread information is
1981 saved and used in the next Wanderlust session.
1983 @item wl-stay-folder-window
1984 @vindex wl-stay-folder-window
1985 The initial setting is @code{nil}.
1986 If non-nil, summary window is appeared on the right side of the folder buffer.
1988 @item wl-folder-window-width
1989 @vindex wl-folder-window-width
1990 The initial setting is 20.
1991 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1993 @item wl-folder-use-frame
1994 @vindex wl-folder-use-frame
1995 The initial setting is @code{nil}.
1996 If non-nil, use new frame for the folder window.
1998 @item wl-folder-many-unsync-threshold
1999 @vindex wl-folder-many-unsync-threshold
2000 The initial setting is 70.
2001 If the number of unread messages is more than this value,
2002 folder color is changed.
2004 @item wl-highlight-folder-by-numbers
2005 @vindex wl-highlight-folder-by-numbers
2006 This option controls how to highlight each line in the folder buffer.
2007 The default value is @code{t}, highlighting with various colors based on
2008 the message numbers. If it is @code{nil}, highlighting with various
2009 colors based on the folder status. In addition, if it is a number
2010 (e.g. 1), highlighting will be done based on both the message numbers
2011 and the folder status.
2013 @item wl-folder-desktop-name
2014 @vindex wl-folder-desktop-name
2015 The initial setting is @samp{Desktop}.
2016 The name of top folder group.
2018 @item wl-folder-petname-alist
2019 @vindex wl-folder-petname-alist
2020 The initial setting is @code{nil}.
2021 An alist of folder's realname and its nickname.
2023 @item wl-folder-access-subscribe-alist
2024 @vindex wl-folder-access-subscribe-alist
2025 The initial setting is @code{nil}.
2027 Control automatic subscribing and unsubscribing of the children list
2033 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2037 If @var{subscribe-flag} is non-nil, folders which have name matched to
2038 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2039 already unsubscribed folder is not displayed even when the
2040 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2047 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2048 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2049 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2050 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2054 @item wl-folder-hierarchy-access-folders
2055 @vindex wl-folder-hierarchy-access-folders
2056 A list of regular expressions for access groups which creates children
2057 folder list hierarchically.
2059 For example, if you specify
2060 @code{wl-folder-hierarchy-access-folders} like following,
2064 (setq wl-folder-hierarchy-access-folders
2065 '("^-[^\\.]*$" "^-comp.unix$" "^-comp.unix.bsd$"))
2070 you obtain the access group hierarchy as follows.
2076 -fj.comp.announce:0/0/2
2077 -fj.comp.dev.cdrom:0/0/0
2079 [+]-japan:238/238/1688
2082 -comp.unix.admin:0/0/0
2083 -comp.unix.dos-under-unix:0/0/0
2084 -comp.unix.programmer:0/0/0
2085 [-]-comp.unix.bsd:0/0/23
2086 -comp.unix.bsd.freebsd.announce:0/0/0
2091 If you opened @samp{-} in this example, only the direct children is created
2092 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2093 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2094 is not created until the children access group is opened.
2098 @node Folder Manager, , Selecting Folder, Folder
2099 @section Editing Folders
2100 @cindex Folder Manager
2101 @cindex Folder, Edit
2102 @cindex Folder, Subscribe
2103 @cindex Folder, Unsubscribe
2105 As described before, subscribed folder list is saved in @file{~/.folders} file.
2106 But you don't have to edit @file{~/.folders} directly.
2107 You can append, delete, edit folders from folder mode.
2109 @subsection Usage (Tips)
2111 @subsubsection Append Folder
2113 @kbd{m a} appends new folder to the folder mode.
2114 @kbd{m g} appends new folder group.
2115 To append new folder to this group, firstly open it,
2116 then execute append command in the next line.
2118 @subsubsection Edit Folder
2120 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2121 Thus, you can change folder position as if you were editing a normal file.
2123 @subsubsection Create Multi Folder.
2127 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2129 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2131 Type @kbd{m m}, then you can create multi folder.
2134 @subsubsection Delete Nickname, Filter
2136 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2137 minibuffer while appending.
2139 @subsubsection Append Folder to Empty Group
2141 To append new folder to the empty folder group
2142 (after you create folder group by typing @kbd{m g}),
2143 firstly open it, then execute append command in the next line.
2144 If it is closed, folder is appended on the same level with
2145 the folder group above. It is difficult to explain by words so try it.
2146 In other words, appended position depends on the
2147 open/close status of the upper one.
2149 @subsubsection Charset of the Folders File.
2151 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2153 @subsubsection Create Filter
2155 @kbd{m f} adds filter to the folder at the current cursor point. To
2156 create new filter folder and leave the current folder unchanged, copy it
2157 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2158 filter can be specified while appending filter. If you put
2159 ``''(@var{NULL}), filter is deleted.
2161 @subsubsection Sort Folders
2163 Sorting of the folders is executed by the function specified by
2164 @code{wl-fldmgr-sort-function}.
2165 The initial setting is @code{wl-fldmgr-sort-standard},
2166 which sorts alphabetically.
2167 Sorting affects only on the current folder group. It does not
2168 affect on the child groups.
2170 @subsubsection Hiding Folders in the Access Group
2172 Usually, access group displays all children folders, but you can set
2173 some folders hidden. Following operations are only available on access
2176 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2177 (subscribe/unsubscribe) of the folder at current cursor point. Against
2178 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2181 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2182 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2183 argument and if the argument has positive number, the unsubscribe it.
2184 If the prefix argument has negative value, folder becomes visible and if
2185 zero, folder visibility is toggled.
2187 The other commands, @code{wl-fldmgr-subscribe} and
2188 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2191 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2192 executed in the access group, they have a same effect with
2193 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2194 The difference is that cut commands deletes folders from the current
2197 @subsubsection Operations in the Access Group
2199 You can insert and delete folders in the access group like usual folder
2200 group. But insert and delete commands can be only available for the
2201 children folders of the access group and they only sets the subscribe
2202 status. In other words, insertion of the folder means subscribing,
2203 deletion means unsubscribing.
2204 @footnote{In the current implementation,
2205 it is faster to delete region than to unsubscribe region.}
2207 To update the access group when children folders are inserted or deleted
2208 by other way (other than Wanderlust),
2209 open the access group by typing @kbd{C-u @key{RET}}.
2210 @xref{Selecting Folder}.
2212 The order of children folders of access group is saved after
2213 insertion/deletion/sorting.
2214 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2215 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2216 newly created folders are inserted on the top of the access group.
2218 @subsection Key bindings
2219 @cindex Keybind, Folder Mode
2220 @cindex Keybind, Folder Buffer
2222 Key bindings on the folder mode related to folder editing are shown below.
2223 All bindings starts with @kbd{m}, and primary commands are binded to
2224 one stroke key binding.
2228 @kindex m a (Folder)
2229 @findex wl-fldmgr-add
2231 (@code{wl-fldmgr-add})
2236 @kindex m g (Folder)
2237 @findex wl-fldmgr-make-group
2238 Create a folder group.
2239 (@code{wl-fldmgr-make-group})
2242 @kindex m A (Folder)
2243 @findex wl-fldmgr-make-access-group
2244 Create an access group.
2245 (@code{wl-fldmgr-make-access-group})
2248 @kindex m d (Folder)
2249 @findex wl-fldmgr-delete
2250 Delete folder itself and msgdb.
2251 If the folder itself cannot be deleted like NNTP folder,
2252 only msgdb is deleted.
2253 (@code{wl-fldmgr-delete})
2258 @kindex m R (Folder)
2259 @findex wl-fldmgr-rename
2260 Change the name of folder or folder group.
2261 msgdb's path is also changed.
2262 (@code{wl-fldmgr-rename})
2268 @findex wl-fldmgr-make-multi
2269 Create a multi folders in the cutlist (cut, copied folders).
2270 (@code{wl-fldmgr-make-multi})
2275 @kindex m f (Folder)
2276 @findex wl-fldmgr-make-filter
2277 Create a filter folder. (Put a filter on the folder).
2278 (@code{wl-fldmgr-make-filter})
2282 @kindex M-c (Folder)
2283 @kindex m c (Folder)
2284 @findex wl-fldmgr-copy
2285 Copy folder (it is not available on folder group).
2286 (@code{wl-fldmgr-copy})
2290 @kindex M-w (Folder)
2291 @kindex m W (Folder)
2292 @findex wl-fldmgr-copy-region
2293 Copy folders in the specified region.
2294 (@code{wl-fldmgr-copy-region})
2298 @kindex C-k (Folder)
2299 @kindex m k (Folder)
2300 @findex wl-fldmgr-cut
2301 Cut folder. Folder itself is not deleted.
2302 (@code{wl-fldmgr-cut})
2306 @kindex C-w (Folder)
2307 @kindex m C-w (Folder)
2308 @findex wl-fldmgr-cut-region
2309 Cut folders in the specified region.
2310 (@code{wl-fldmgr-cut-region})
2314 @kindex C-y (Folder)
2315 @kindex m y (Folder)
2316 @findex wl-fldmgr-yank
2317 Paste folders that are copied or cut (folders in the cut-list).
2318 (@code{wl-fldmgr-yank})
2321 @kindex m p (Folder)
2322 @findex wl-fldmgr-set-petname
2323 Put nickname on the folder.
2324 (@code{wl-fldmgr-set-petname})
2327 @kindex m q (Folder)
2328 @findex wl-fldmgr-clear-cut-entity-list
2329 Clear the cut-list. (cut, copied folder information is cleared,
2330 you cannot paste after this)
2331 (@code{wl-fldmgr-clear-cut-entity-list})
2334 @kindex m s (Folder)
2335 @findex wl-fldmgr-sort
2336 Sort folders in the current folder group.
2337 (@code{wl-fldmgr-sort})
2340 @kindex m C-s (Folder)
2341 @findex wl-fldmgr-save
2342 Save current folder view to the @file{wl-folders-file}.
2343 (@code{wl-fldmgr-save})
2346 [Following commands are only available on the access groups]
2352 @kindex m u (Folder)
2353 @findex wl-fldmgr-unsubscribe
2354 Set the visibility of folder (subscribe/unsubscribe).
2355 (@code{wl-fldmgr-unsubscribe})
2360 @kindex r u (Folder)
2361 @findex wl-fldmgr-unsubscribe-region
2362 Set the visibility of the folders (subscribe/unsubscribe) in the
2364 (@code{wl-fldmgr-unsubscribe-region})
2369 @kindex m l (Folder)
2370 @findex wl-fldmgr-access-display-normal
2371 List folders that are currently available.
2372 (@code{wl-fldmgr-access-display-normal})
2377 @kindex m L (Folder)
2378 @findex wl-fldmgr-access-display-all
2379 List all folders regardless of the subscription status.
2380 (@code{wl-fldmgr-access-display-all})
2384 @subsection Customize variables
2387 @item wl-interactive-save-folders
2388 @vindex wl-interactive-save-folders
2389 The initial setting is @code{t}. If non-nil and folder view is
2390 modified, confirm saving it before Wanderlust or Emacs exits. If
2391 @code{nil}, save without confirmation.
2393 @item wl-fldmgr-make-backup
2394 @vindex wl-fldmgr-make-backup
2395 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2396 created before saving the folder status.
2398 @item wl-fldmgr-sort-function
2399 @vindex wl-fldmgr-sort-function
2400 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2401 sort folders. By default function, folders are sorted alphabetically
2402 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2405 @item wl-fldmgr-sort-group-first
2406 @vindex wl-fldmgr-sort-group-first
2407 The initial setting is @code{t}. If non-nil,
2408 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2409 does not care whether it is folder group or not.
2411 @item wl-folder-check-async
2412 @vindex wl-folder-check-async
2413 The initial setting is @code{t}. If non-nil, check folder's unread
2414 status asynchronously. It boosts newsgroup checking.
2416 @item wl-folder-check-fast
2417 @vindex wl-folder-check-fast
2418 The initial setting is @code{nil}.
2419 If non-nil, it does not update folder status while checking.
2421 @item wl-folder-notify-deleted
2422 @vindex wl-folder-notify-deleted
2423 The initial setting is @code{nil}.
2425 If non-nil, negative value is displayed when the message is deleted. If
2426 @code{sync}, folder is synchronized when the message is deleted. If
2427 @code{nil}, message deletion is ignored.
2429 @item wl-fldmgr-add-complete-with-current-folder-list
2430 @vindex wl-fldmgr-add-complete-with-current-folder-list
2431 The initial setting is @code{nil}.
2432 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2433 candidate for @code{wl-fldmgr-add}.
2436 @subsection Miscellanea
2438 Following is a note for folder editing.
2442 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2443 paste(yank) command pastes the folders on one cut or copy command
2444 (If copy command is executed by region, folders in the region are pasted
2445 by one paste command)
2448 You cannot cut @samp{Desktop} group.
2449 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2452 You cannot copy folder group.
2455 Operations on the access group are only available for the folders
2456 in the same access group.
2459 You cannot create a folder which has same name with the folders already exist.
2462 You cannot insert folders which have same name in one group.
2463 You can insert them in the different groups.
2464 You cannot put same nickname to the different folders.
2468 @node Summary, Message, Folder, Top
2469 @chapter Summary Mode
2471 After you select the folder via folder mode, you enter to the summary
2475 * Usage of Summary Mode:: TIPS
2476 * Thread Operations:: Thread operations
2477 * Cache:: File cache, Buffer cache, and Prefetch
2478 * Auto Refile:: Auto refile settings
2479 * Sticky Summary:: Summary make sticky
2480 * Summary View:: Format of summary lines
2481 * Key Bindings of Summary:: Key bindings
2482 * Variables of Summary:: Customize Summary Mode
2486 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2487 @section Usage (Tips)
2489 @subsection Summary Content
2491 In the summary mode, messages are displayed like following.
2495 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2496 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2497 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2498 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2505 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2509 If you want to know how to change the format for this, please refer
2510 the section format of Summary lines.
2511 @xref{Summary View}.
2513 @var{Message number} is the message's unique number in the folder. In
2514 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2515 in the MH folder, it is the filename of the message.
2517 @var{Temporal mark} and @var{Persistent mark} are described later.
2519 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2520 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2521 Japanese, but if you want to display it in English, set the value of
2522 @code{wl-summary-weekday-name-lang} as @samp{en}.
2524 @var{Sender}'s indentation corresponds to the depth of the thread.
2525 Sender name is displayed as nickname if it is defined in the address
2526 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2527 displaying with nickname.
2529 If number is printed at the head of @var{Sender} part like @samp{+2},
2530 that means the message have 2 follow messages.
2532 @var{Subject} is the @samp{Subject:} header field of the message. If
2533 the message have same @samp{Subject:} with the parent message, it is not
2534 displayed. Some mailing list puts its sequence number in the
2535 @samp{Subject:} field, but it is
2536 ignored. @code{wl-summary-no-subject-message} is displayed when the
2537 message has empty subject field.
2539 @subsection Temporary Marks
2540 @cindex Mark, Temporary
2542 There are four temporary marks,
2543 @samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}.
2544 Temporary marks indicates message operations.
2549 You can execute a command on the all messages that have @samp{*} mark,
2550 with the key bindings which begins with @kbd{m}.
2553 The mark to dispose. You can put @samp{d} by typing @kbd{d} key.
2556 The mark to force delete. You can put @samp{D} by typing @kbd{D} key.
2560 After you type @kbd{o} key, prompt appears to input refile destination.
2561 Your answer is printed in the summary line.
2565 You can put this mark by typing @kbd{O} key.
2566 The difference between this mark and refile mark is,
2567 this mark does not delete the message while latter does.
2570 The mark to prefetch reserved.
2571 You can put this mark by typing @kbd{i} key.
2574 The mark to resend reserved.
2575 After you type @kbd{~} key, prompt appears to input address to resend.
2576 Your answer is printed in the summary line.
2579 @kbd{x} key executes action for temporary marks, respectively.
2581 @subsection Persistent Marks
2583 There are five persistent marks, @samp{N}, @samp{?}, @samp{U}, @samp{!},
2584 @samp{u}, @samp{A}, @samp{&} and @samp{$}.
2586 The persistent mark indicates the message's status and it is saved.
2587 Each persistent mark indicates:
2593 It is new but cached message.
2595 It is unread message.
2597 It is unread but cached message.
2599 It is read but it is not cached.
2601 It is already replied message.
2603 It is already replied but cached message.
2605 It is important message. You can put @samp{$} mark by typing @kbd{$}
2606 key (if already exists, the mark is deleted). It is convenient to put
2607 this mark on the messages to remember (If you want to remember to write
2608 a reply for the message, for example) because this mark remains after
2609 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2610 @samp{'mark} folder even the message itself is deleted in the actual folder.
2613 If the message is read and cached (or local message),there are no
2617 @samp{N}, @samp{U}, @samp{u}, @samp{A} indicates that the message have
2618 no cache. Messages with the marks other than these, you can read them
2619 in the offline status even they are in the IMAP folder or netnews
2622 Among messages with persistent marks, ones with marks specified by
2623 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2624 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2626 @subsection How To Read
2628 Basically, you can read messages only typing space key again and again.
2630 To update summary status to the newest status (synchronize),
2633 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2634 moves cursor to the next message.
2635 Enter message buffer by typing @kbd{j} key.
2636 To operate multipart, you have to enter to the message buffer.
2639 @subsection Pack the Message Numbers
2640 You can pack the message numbers in Summary by
2641 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2642 News Spool Folder and Maildir Folder are supported folder types.
2645 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2646 @section Thread Operations
2648 For example, the following line indicates one thread (a context of a topic).
2651 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2655 If you type @kbd{/} on this line, the thread is opened and it changes
2656 the appearance like following.
2660 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2661 388 09/17(Thu)22:34 +-[ Murata san ]
2665 (Message 388 is the replied message to the message 384.)
2666 If you type @kbd{/} key once again, the thread is closed.
2667 With prefix argument, @kbd{/} opens all children threads.
2669 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2672 Commands with the key binding that begins with @kbd{t} executes commands
2673 on the messages in the thread.
2674 @xref{Key Bindings of Summary}.
2676 @subsection reconstruct thread by hand
2678 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2679 (@code{wl-summary-save-current-message}) at the corresponding message,
2680 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2681 message then you have the reconstructed thread.
2684 @node Cache, Auto Refile, Thread Operations, Summary
2687 @subsection Cache File
2689 The messages which have to access via network (e.x. IMAP, NNTP folder)
2690 are cached as a local file so as to save network traffic or to enable
2691 off-line operation. The cache file is saved under the directory
2692 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2693 elmo-cache-expire-by-size}. The command deletes cache files to the
2694 specified size by the order of last accessed time.
2696 @subsection Buffer Cache and Prefetching
2698 The messages that are read are kept in the cache buffer so as to make
2699 the behavior fast when you are to read the message again. It is called
2700 `buffer cache'. The number of cache buffer is specified by
2701 @code{wl-message-buffer-cache-size}.
2703 There are message prefetching mechanism in the Wanderlust that
2704 prefetches next message while you are reading.
2706 You can control the message prefetching mechanism by these two
2710 @item wl-message-buffer-prefetch-folder-type-list
2711 @vindex wl-message-buffer-prefetch-folder-type-list
2712 The initial setting is @code{t}. In this case, prefetch messages in all
2714 If it is a list of folder types, it specifies the folder types in which
2715 message prefetching is enabled.
2716 Following is an example (prefetch messages in nntp and imap4 folders)
2720 (setq wl-message-buffer-prefetch-folder-type-list
2725 In this case, multi folder that contains localdir and imap4 prefetches
2726 only imap4 messages. This variable precedes the value of
2727 @code{wl-message-buffer-prefetch-folder-list}.
2729 @item wl-message-buffer-prefetch-folder-list
2730 @vindex wl-message-buffer-prefetch-folder-list
2731 The initial setting is @code{nil}.
2732 A list of regexp of folders to enable message prefetching.
2734 @item wl-message-buffer-prefetch-depth
2735 @vindex wl-message-buffer-prefetch-depth
2736 The initial setting is 3. The number of messages for automatical prefetch.
2738 @item wl-message-buffer-prefetch-idle-time
2739 @vindex wl-message-buffer-prefetch-idle-time
2740 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2742 @item wl-message-buffer-prefetch-threshold
2743 @vindex wl-message-buffer-prefetch-threshold
2744 The initial setting is 30000 (bytes). If prefetching message has larger
2745 size than this value, Wanderlust does not prefetch automatically.
2746 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2747 the message is not checked for the size.
2749 @item wl-auto-prefetch-first
2750 @vindex wl-auto-prefetch-first
2751 The initial setting is @code{nil}.
2752 If non-nil, first message is automatically prefetched to the buffer
2753 when you enter the folder.
2757 @node Auto Refile, Sticky Summary, Cache, Summary
2758 @section Auto Refile
2759 @vindex elmo-msgdb-extra-fields
2760 @vindex wl-refile-rule-alist
2761 @findex wl-summary-auto-refile
2763 You can refile messages automatically, by typing @kbd{C-o}
2764 (@code{wl-summary-auto-refile}). It decides destination of refile by
2765 the content of the message header information (information in the msgdb).
2767 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2768 available. If you want to decide destination by other header fields,
2769 set the variable @code{elmo-msgdb-extra-fields} like following.
2773 (setq elmo-msgdb-extra-fields
2783 By this setting, Wanderlust saves extra fields in the msgdb. You have
2784 to type @kbd{s all} to get extra fields for the messages that are
2785 already exists in the summary.
2787 Then, specify the refile rule. The refile target folder of auto
2788 refiling is decided by the value of @code{wl-refile-rule-alist}.
2789 @code{wl-refile-rule-alist} is a list of a rule:
2793 (@var{field} (@var{regexp} . @var{target})
2794 (@var{regexp} . @var{target})
2799 Each rule means `if @var{field} value matches @var{regexp},
2800 then refile to @var{target} folder'.
2801 The rule matched first is applied.
2803 @var{field} is a string of field name. You can specify a list of field name
2804 string, too. In this case, if one of these fields is matched, then the
2805 rule is fired (i.e. OR condition).
2807 @var{regexp} is a regular expression for field value. @var{target} is a target
2808 folder string. You can specify a rule at @var{target} part, too. In this
2809 case, If the field value of the rule and the current rule is matched,
2810 then the current rule is fired (i.e. AND condition).
2812 You can refer matched substring of @var{regexp} to specify @var{target} part.
2813 To refer substring, use following keys:
2817 means substitute original matched text.
2820 means substitute what matched the @var{N}th `\(@dots{}\)'.
2821 (@var{N} is a number.)
2824 Following is an example of @code{wl-refile-rule-alist}.
2828 (setq wl-refile-rule-alist
2830 ("^Wanderlust" . "+wl")
2831 ("^Elisp" . "+elisp"))
2833 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2835 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2836 "+from-me-to-you"))))))
2840 After these settings, refile marks are automatically put on the condition
2841 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2843 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2845 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2846 with these persistent marks are not automatically refiled.
2847 It means Wanderlust does not execute auto refile on unread messages by
2848 the default setting.
2849 To execute auto refile on all messages, set following.
2852 (setq wl-summary-auto-refile-skip-marks nil)
2856 @node Sticky Summary, Summary View, Auto Refile, Summary
2857 @section Sticky Summary
2858 @cindex Summary, Sticky
2859 @cindex Sticky Summary
2861 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2863 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2864 @kbd{G} in some suummary sticky summary buffer is created.
2865 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2866 makes current one sticky.
2868 The buffer name of the sticky summary becomes like
2869 @samp{Summary:@var{folder-name}}.
2870 You can visit the sticky summary at any time by @kbd{C-x b}
2871 (@code{switch-to-buffer}), or you can go round summary buffers by
2872 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2873 (@code{wl-summary-next-buffer}) in summary mode.
2875 In sticky summary, the summary buffer is preserved after @kbd{g} or
2876 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2877 another summary by @kbd{C-u g}. Other operations in the sticky summary
2878 are same as normal summary.
2880 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2881 are automatically stuck.
2884 @node Summary View, Key Bindings of Summary, Sticky Summary, Summary
2885 @section Format of summary lines
2886 @cindex Format of summary lines
2887 You can alter the format of lines in Summary mode.
2889 Summary line format is specified by @code{wl-summary-line-format}.
2890 You can use control strings defined by
2891 @code{wl-summary-line-format-spec-alist}.
2897 ;; @r{number temporary-mark persistent-mark date branch}
2898 ;; @r{[ (number-of-children) sender ] subject}
2899 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
2903 Where the number set the column number of the field (for negative value,
2906 Major control strings defined by @code{wl-summary-line-format-spec-alist}
2907 are displayed in the following list.
2918 %t branch of the thread
2919 %[ [ (< for re-connected child)
2920 %] ] (> for re-connected child)
2924 %c +number-of-children: (display only for opened thread)
2925 %C [+number-of-children] (display only for opened thread)
2926 %T temporary mark (mandatory)
2927 %P persistent mark (mandatory)
2931 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
2932 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
2933 the constant column. For example, if you specify @samp{%T} or
2934 @samp{%P} after the @samp{%t}, which changes its length by thread
2935 position, marks are not treated correctly.
2937 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
2938 column of the enclosed region is justified to the `number'. Multiple
2939 level @samp{%number(} parenthesis can be defined. It is useful to
2940 justify the column of the multiple control strings. For example, in the
2941 above @code{wl-summary-line-format},
2947 means ``Adjust number-of-children and sender string to the 17 column''.
2949 You can specify the format by each folders with
2950 @code{wl-folder-summary-line-format-alist}. Please set regular
2951 expression for folder names and summary line format as the following
2956 (setq wl-folder-summary-line-format-alist
2957 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
2958 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
2962 @subsection on the format for sender name
2964 The format string @samp{%f} displays the return value of the function specified
2965 by @code{wl-summary-from-function}. If you use the function
2966 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
2967 while displays the recipient names if the folder name matches with
2968 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
2969 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
2971 For example, to display recipient names for the message in @samp{+backup} if
2972 its sender is yourself, set up as follows.
2975 (setq wl-summary-showto-folder-regexp "^\\+backup$")
2979 @node Key Bindings of Summary, Variables of Summary, Summary View, Summary
2980 @section Key bindings
2981 @cindex Keybind, Summary Mode
2982 @cindex Keybind, Summary Buffer
2984 Key bindings of the summary mode are shown below.
2988 @kindex @key{SPC} (Summary)
2989 @findex wl-summary-read
2990 Proceed reading a message at the current cursor point.
2991 (@code{wl-summary-read})
2995 @findex wl-summary-redisplay
2996 Redisplay a message at the current cursor point.
2997 If this command is called with prefix argument,
2998 Redisplay message regardless of the message cache (message is re-loaded
3000 (@code{wl-summary-redisplay})
3004 @findex wl-summary-display-top
3005 Display the top message in the folder.
3006 (@code{wl-summary-display-top})
3010 @findex wl-summary-display-bottom
3011 Display the bottom message in the folder.
3012 (@code{wl-summary-display-bottom})
3016 @kindex @key{BS} (Summary)
3017 @kindex @key{DEL} (Summary)
3018 Display the previous page of the message at the current cursor point.
3019 @findex wl-summary-prev-page
3020 (@code{wl-summary-prev-page})
3023 @kindex @key{RET} (Summary)
3024 @findex wl-summary-next-line-content
3025 Display the next line of the message at the current cursor point.
3026 Display the message at the current cursor point if it is not displayed yet.
3027 (@code{wl-summary-next-line-content})
3032 @kindex M-@key{RET} (Summary)
3033 @findex wl-summary-prev-line-content
3034 Display the previous line of the message at the current cursor point.
3035 Display the message at the current cursor point if it is not displayed yet.
3036 (@code{wl-summary-prev-line-content})
3040 @findex wl-thread-open-close
3041 Toggle open or close the thread at the current cursor point.
3042 (@code{wl-thread-open-close})
3047 @findex wl-thread-open-all
3048 (@code{wl-thread-open-all})
3053 @findex wl-thread-close-all
3054 (@code{wl-thread-close-all})
3058 @findex wl-summary-goto-folder
3060 (@code{wl-summary-goto-folder})
3064 Mark all messages in the folder as read.
3065 @findex wl-summary-mark-as-read-all
3066 (@code{wl-summary-mark-as-read-all})
3070 @findex wl-summary-reply
3071 Prepare a draft for reply the message at the current cursor point.
3072 (@code{wl-summary-reply})
3076 @findex wl-summary-reply-with-citation
3077 Prepare a draft for reply the message at the current cursor point.
3078 (@code{wl-summary-reply-with-citation})
3082 @findex wl-summary-cancel-message
3083 If the message at current cursor point is your own netnews article,
3085 (@code{wl-summary-cancel-message})
3089 @findex wl-summary-reedit
3090 Prepare a draft for re-editing the message at current cursor point.
3091 If the message at current cursor point is your own netnews article,
3092 a draft for `supersedes message' for the message is prepared.
3093 (@code{wl-summary-reedit})
3096 @kindex M-E (Summary)
3097 @findex wl-summary-resend-bounced-mail
3098 If the message at current cursor point is a bounced message,
3099 a draft for re-sending original message is prepared.
3100 (@code{wl-summary-resend-bounced-mail})
3104 @findex wl-summary-forward
3105 A draft for forwarding the message at current cursor point is prepared.
3106 (@code{wl-summary-forward})
3110 @findex wl-summary-mark-as-important
3111 Put @samp{$} mark on the message at current cursor point.
3112 If already marked as @samp{$}, remove the mark.
3113 (@code{wl-summary-mark-as-important})
3119 Save the message at current cursor point.
3120 @findex wl-summary-save
3121 (@code{wl-summary-save})
3125 @findex wl-summary-next
3126 Move cursor to the next message.
3127 If message is marked with a temporal mark in
3128 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3129 In the offline mode, cursor is not moved to the messages which are not cached
3131 (@code{wl-summary-next})
3135 @findex wl-summary-prev
3136 Move cursor to the previous message.
3137 If message is marked with a temporal mark in
3138 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3139 In the offline mode, cursor is not moved to the messages which are not cached
3141 (@code{wl-summary-prev})
3145 @findex wl-summary-down
3146 Move cursor to the downward message which is unread or marked
3148 In the offline mode, cursor is not moved to the messages which are not cached
3150 If there are messages which have target mark @samp{*} in the summary,
3151 cursor is moved to the downward message which have a target mark.
3152 This behavior is changed according to the value of @code{wl-summary-move-order}.
3153 (@code{wl-summary-down})
3157 @findex wl-summary-up
3158 Move cursor to the upward message which is unread or marked
3160 In the offline mode, cursor is not moved to the messages which are not cached
3162 If there are messages which have target mark @samp{*} in the summary,
3163 cursor is moved to the downward message which have a target mark.
3164 This behavior is changed according to the value of @code{wl-summary-move-order}.
3165 (@code{wl-summary-up})
3169 @findex wl-summary-write
3170 Prepare a new draft.
3171 (@code{wl-summary-write})
3175 @findex wl-summary-write-current-folder
3176 Prepare a new draft. If the current folder is NNTP folder,
3177 @samp{Newsgroups:} field is completed. If the current folder is mailing
3178 list folder (refile destination), guess @samp{To:} field and completed
3179 (If @code{wl-subscribed-mailing-list} is valid list)
3180 (@code{wl-summary-write-current-folder})
3184 @findex wl-summary-redisplay-all-header
3185 Redisplay the message at current cursor point with all header fields.
3186 (@code{wl-summary-redisplay-all-header})
3190 @findex wl-summary-redisplay-no-mime
3191 Redisplay the message at current cursor point without MIME analysis.
3192 (@code{wl-summary-redisplay-no-mime})
3196 @findex wl-summary-burst
3197 If the message at current cursor point has
3198 encapsulates multiple messages using MIME,
3199 de-capsulate and extract them on the current folder.
3200 If it is invoked in non-writable folder or it is called with prefix
3201 argument, it asks the destination folder.
3202 (@code{wl-summary-burst})
3205 @kindex @@ (Summary)
3206 @findex wl-summary-edit-addresses
3207 Append/change/delete the message's sender information to the address
3208 book @file{~/.addresses} interactively. If this command is called with
3209 prefix argument, arbitrary address can be edited.
3210 (@code{wl-summary-edit-petname})
3214 @findex wl-status-update
3215 Sync up address book status with @file{~/.addresses}'s content.
3216 (@code{wl-status-update})
3220 @findex wl-summary-pipe-message
3221 Pipe current message's content to the external process.
3222 (@code{wl-summary-pipe-message})
3226 @findex wl-summary-print-message
3227 Print out current message's content.
3228 It uses @code{ps-print} module in Emacs 20.x.
3229 If you don't use color printer, you might want to set
3230 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3233 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3236 (@code{wl-summary-print-message})
3240 @findex wl-summary-exit
3241 Exit current folder.
3242 (@code{wl-summary-exit})
3246 @findex wl-summary-jump-to-current-message
3247 Jump cursor to the currently displayed message's window.
3248 (@code{wl-summary-jump-to-current-message})
3252 Jump cursor to the other message.
3253 @findex wl-summary-jump-to-msg
3254 (@code{wl-summary-jump-to-msg})
3258 Update summary status and
3259 prefetch all messages which have marks included in the
3260 @code{wl-summary-incorporate-marks}.
3261 @findex wl-summary-incorporate
3262 (@code{wl-summary-incorporate})
3265 @kindex M-j (Summary)
3266 @findex wl-summary-jump-to-msg-by-message-id
3267 Jump cursor to the message which have specified @samp{Message-Id:}. If
3268 @code{elmo-use-database} is non-nil, other folder is also searched.
3269 (@code{wl-summary-jump-to-msg-by-message-id})
3273 Jump to parent message.
3274 @findex wl-summary-jump-to-parent-message
3275 (@code{wl-summary-jump-to-parent-message})
3279 @findex wl-summary-mark-as-unread
3280 Mark as unread the message at current cursor point.
3281 (@code{wl-summary-mark-as-unread})
3285 @findex wl-summary-sync
3286 Synchronize summary view after prompting the update range.
3287 You can specify one of the follows.
3291 all Discard present msgdb and retrieve all informations.
3292 Do not retrieve killed messages.
3293 all-entirely Discard present msgdb and retrieve all informations.
3294 Retrieve killed messages, too.
3295 update Update the difference between informations in present
3296 msgdb and in current folder instance.
3297 Do not retrieve killed messages.
3298 update-entirely Update the difference between informations in present
3299 msgdb and in current folder instance.
3300 Retrieve killed messages, too.
3301 rescan Redisplay summary by rescanning present msgdb.
3302 rescan-noscore Redisplay summary by rescanning present msgdb.
3303 Display messages killed by score, too.
3304 cache-status Sync the all marks with the real status of cache.
3307 first:NUM Move to the filter folder(partial filter).
3308 last:NUM Move to the filter folder(partial filter).
3313 (@code{wl-summary-sync})
3317 @findex wl-summary-sort
3319 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3320 (@code{wl-summary-sort})
3324 @findex wl-summary-toggle-thread
3325 Toggle the threading. The state will be preserved after exiting
3326 Wanderlust. You can alter default state for newly created summary
3327 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3328 Threading status is displayed on the modeline.
3329 @samp{@{S@}} means threading is off (Sequence) and
3330 @samp{@{T@}} means threading is on (Thread).
3331 (@code{wl-summary-toggle-thread})
3335 @findex wl-summary-toggle-disp-folder
3336 Toggle displaying of folder window.
3337 (@code{wl-summary-toggle-disp-folder})
3341 Toggle displaying of message window.
3342 @findex wl-summary-toggle-disp-msg
3343 (@code{wl-summary-toggle-disp-msg})
3347 Move to the virtual folder (filter folder) with the condition specified.
3348 If called with prefix argument and current folder is virtual, exit it.
3349 @findex wl-summary-virtual
3350 (@code{wl-summary-virtual})
3353 @kindex @key{TAB} (Summary)
3354 @findex wl-summary-goto-last-displayed-msg
3355 Jump to the message which is displayed last.
3356 (@code{wl-summary-goto-last-displayed-msg})
3360 Put @samp{*} mark on the messages that satisfies the specified condition.
3361 @findex wl-summary-pick
3362 (@code{wl-summary-pick})
3366 @findex wl-summary-mark-as-read
3367 Mark as read the message at the current cursor point.
3368 (@code{wl-summary-mark-as-read})
3372 Execute action for all temporary marks in the summary buffer.
3373 @findex wl-summary-exec
3374 (@code{wl-summary-exec})
3378 @findex wl-summary-target-mark-line
3379 Put target mark on the message at the current cursor point.
3380 (@code{wl-summary-target-mark-line})
3384 Put refile mark on the message at the current cursor point.
3385 @findex wl-summary-refile
3386 (@code{wl-summary-refile})
3389 @kindex C-o (Summary)
3390 Execute auto refile.
3391 @findex wl-summary-auto-refile
3392 (@code{wl-summary-auto-refile})
3396 Put copy mark on the message at the current cursor point.
3397 @findex wl-summary-copy
3398 (@code{wl-summary-copy})
3401 @kindex M-o (Summary)
3402 Put refile mark on the message at the current cursor point with the destination
3403 previously specified.
3404 @findex wl-summary-refile-prev-destination
3405 (@code{wl-summary-refile-prev-destination})
3409 @findex wl-summary-dispose
3410 Put disposal mark on the message at the current cursor point.
3411 The result of disposal is controlled by @code{wl-dispose-folder-alist},
3412 refiled to @code{wl-trash-folder} by default.
3413 (@code{wl-summary-dispose})
3417 @findex wl-summary-delete
3418 Put force deletion mark on the message at the current cursor point.
3419 (@code{wl-summary-delete})
3423 Put prefetch reservation mark on the message at the current cursor point.
3424 @findex wl-summary-prefetch
3425 (@code{wl-summary-prefetch})
3429 @findex wl-summary-resend
3430 Put resend reservation mark on the message at the current cursor point.
3431 (@code{wl-summary-resend})
3435 @findex wl-summary-unmark
3436 Unmark the temporal mark on the message at the current cursor point.
3437 (@code{wl-summary-unmark})
3441 Unmark all the temporal marks.
3442 @findex wl-summary-unmark-all
3443 (@code{wl-summary-unmark-all})
3446 @kindex r R (Summary)
3447 @findex wl-summary-mark-as-read-region
3448 Mark as read messages in the specified region.
3449 (@code{wl-summary-mark-as-read-region})
3452 @kindex r $ (Summary)
3453 @findex wl-summary-mark-as-important-region
3454 Mark as important @samp{$} messages in the specified region.
3455 If @samp{$} mark already exists, remove the mark.
3456 (@code{wl-summary-mark-as-important-region})
3459 @kindex r ! (Summary)
3460 @findex wl-summary-mark-as-unread-region
3461 Mark as unread messages in the specified region.
3462 (@code{wl-summary-mark-as-unread-region})
3465 @kindex r x (Summary)
3466 @findex wl-summary-exec-region
3467 Execute action for each temporary marks on the messages in the
3469 (@code{wl-summary-exec-region})
3472 @kindex r * (Summary)
3473 @findex wl-summary-target-mark-region
3474 Put target mark on the messages in the specified region.
3475 (@code{wl-summary-target-mark-region})
3478 @kindex r o (Summary)
3479 @findex wl-summary-refile-region
3480 Put refile mark on the messages in the specified region.
3481 (@code{wl-summary-refile-region})
3484 @kindex r O (Summary)
3485 @findex wl-summary-copy-region
3486 Put copy mark on the messages in the specified region.
3487 (@code{wl-summary-copy-region})
3490 @kindex r d (Summary)
3491 @findex wl-summary-dispose-region
3492 Put disposal mark on the messages in the specified region.
3493 (@code{wl-summary-dispose-region})
3496 @kindex r i (Summary)
3497 @findex wl-summary-prefetch-region
3498 Put prefetch reservation mark on messages in the specified region.
3499 (@code{wl-summary-prefetch-region})
3502 @kindex r u (Summary)
3503 @findex wl-summary-unmark-region
3504 Delete temporal mark on the messages in the specified region.
3505 (@code{wl-summary-unmark-region})
3508 @kindex r y (Summary)
3509 Save messages in the specified region.
3510 @findex wl-summary-save-region
3511 (@code{wl-summary-save-region})
3514 @kindex t R (Summary)
3515 @findex wl-thread-mark-as-read
3516 Mark as read messages which are the descendant of the current thread.
3517 With prefix argument, it affects on the all messages in the thread tree.
3518 (@code{wl-thread-mark-as-read})
3521 @kindex t $ (Summary)
3522 @findex wl-thread-mark-as-important
3523 Put important mark @samp{$} on the messages which are the
3524 descendant of the current thread.
3525 If @samp{$} mark exists, remove the mark.
3526 With prefix argument, it affects on the all messages in the thread tree.
3527 (@code{wl-thread-mark-as-important})
3530 @kindex t ! (Summary)
3531 @findex wl-thread-mark-as-unread
3532 Mark as unread messages which are the descendant of the current thread.
3533 With prefix argument, it affects on the all messages in the thread tree.
3534 (@code{wl-thread-mark-as-unread})
3537 @kindex t x (Summary)
3538 @findex wl-thread-exec
3539 Execute action for temporary marks on the messages which are
3540 the descendant of the current thread. With prefix argument, it affects
3541 on the all messages in the thread tree.
3542 (@code{wl-thread-exec})
3545 @kindex t * (Summary)
3546 @findex wl-thread-target-mark
3547 Put target mark @samp{*} on the messages which are the descendant of the
3548 current thread. With prefix argument, it affects on the all messages in
3550 (@code{wl-thread-target-mark})
3553 @kindex t o (Summary)
3554 @findex wl-thread-refile
3555 Put refile mark on the messages which are the descendant of the current thread.
3556 With prefix argument, it affects on the all messages in the thread tree.
3557 (@code{wl-thread-refile})
3560 @kindex t O (Summary)
3561 @findex wl-thread-copy
3562 Put copy mark on the messages which are the descendant of the current thread.
3563 With prefix argument, it affects on the all messages in the thread tree.
3564 (@code{wl-thread-copy})
3567 @kindex t d (Summary)
3568 @findex wl-thread-dispose
3569 Put disposal mark on the messages which are the descendant of the current thread.
3570 With prefix argument, it affects on the all messages in the thread tree.
3571 (@code{wl-thread-dispose})
3574 @kindex t i (Summary)
3575 @findex wl-thread-prefetch
3576 Put prefetch reservation mark on messages which are the descendant of
3578 (@code{wl-thread-prefetch})
3581 @kindex t u (Summary)
3582 @findex wl-thread-unmark
3583 Unmark temporal mark on the messages which are the descendant of the
3584 current thread. With prefix argument, it affects on the all messages in
3586 (@code{wl-thread-unmark})
3589 @kindex t y (Summary)
3590 @findex wl-thread-save
3591 Save messages which are the descendant of the current thread.
3592 With prefix argument, it affects on the all messages in the thread tree.
3593 (@code{wl-thread-save})
3596 @kindex m R (Summary)
3597 @findex wl-summary-target-mark-mark-as-read
3598 Mark as read all messages which have target mark @samp{*}.
3599 (@code{wl-summary-target-mark-mark-as-read})
3602 @kindex m $ (Summary)
3603 @findex wl-summary-target-mark-mark-as-important
3604 Mark as important all messages which have target mark @samp{*}.
3605 If already marked as @samp{$}, remove the mark.
3606 (@code{wl-summary-target-mark-mark-as-important})
3609 @kindex m ! (Summary)
3610 @findex wl-summary-target-mark-mark-as-unread
3611 Mark as unread all messages which have target mark @samp{*}.
3612 (@code{wl-summary-target-mark-mark-as-unread})
3615 @kindex m o (Summary)
3616 @findex wl-summary-target-mark-refile
3617 Put refile mark on the messages which have target mark @samp{*}.
3618 (@code{wl-summary-target-mark-refile})
3621 @kindex m O (Summary)
3622 @findex wl-summary-target-mark-copy
3623 Put copy mark on the messages which have target mark @samp{*}.
3624 (@code{wl-summary-target-mark-copy})
3627 @kindex m d (Summary)
3628 @findex wl-summary-target-mark-dispose
3629 Put disposal mark on the messages which have target mark @samp{*}.
3630 (@code{wl-summary-target-mark-dispose})
3633 @kindex m i (Summary)
3634 @findex wl-summary-target-mark-prefetch
3635 Put prefetch reservation mark on messages which have target mark @samp{*}.
3636 (@code{wl-summary-target-mark-prefetch})
3639 @kindex m y (Summary)
3640 @findex wl-summary-target-mark-save
3641 Save messages which have target mark @samp{*}.
3642 (@code{wl-summary-target-mark-save})
3645 @kindex m u (Summary)
3646 Unmark all temporal marks.
3647 (@code{wl-summary-delete-all-temp-marks})
3648 @findex wl-summary-delete-all-temp-marks
3651 @kindex m a (Summary)
3652 Put target mark @samp{*} on the all messages.
3653 (@code{wl-summary-target-mark-all})
3654 @findex wl-summary-target-mark-all
3657 @kindex m t (Summary)
3658 Put target mark @samp{*} on the messages in the current thread.
3659 @findex wl-summary-target-mark-thread
3660 (@code{wl-summary-target-mark-thread})
3663 @kindex m r (Summary)
3664 @findex wl-summary-target-mark-region
3665 Put target mark @samp{*} on the messages in the specified region.
3666 (@code{wl-summary-target-mark-region})
3669 @kindex m A (Summary)
3670 @findex wl-summary-target-mark-reply-with-citation
3671 Prepare a draft which cites all messages which have target mark @samp{*}.
3672 (@code{wl-summary-target-mark-reply-with-citation})
3675 @kindex m f (Summary)
3676 @findex wl-summary-target-mark-forward
3677 Prepare a draft which forwards all messages which have target mark @samp{*}.
3678 (@code{wl-summary-target-mark-forward})
3681 @kindex m U (Summary)
3682 @findex wl-summary-target-mark-uudecode
3683 Uudecode the messages which have target mark @samp{*}.
3684 (@code{wl-summary-target-mark-uudecode})
3687 @kindex m ? (Summary)
3688 @findex wl-summary-target-mark-pick
3689 Pick messages from the @samp{*} marked messages.
3690 That is, @samp{*} marks on the messages are remained
3691 if the specified condition is satisfied.
3692 (@code{wl-summary-target-mark-pick})
3695 @kindex m # (Summary)
3696 @findex wl-summary-target-mark-print
3697 Print out all messages which have target mark @samp{*}.
3698 (@code{wl-summary-target-mark-print})
3701 @kindex m | (Summary)
3702 @findex wl-summary-target-mark-pipe
3703 Pipe content of each message with target mark @samp{*} to some specified
3705 (@code{wl-summary-target-mark-pipe})
3708 @kindex M-t (Summary)
3709 @findex wl-toggle-plugged
3710 Toggle offline/online status of Wanderlust.
3711 (@code{wl-toggle-plugged})
3714 @kindex C-t (Summary)
3715 Start Wanderlust's plug-status manager.
3716 (@code{wl-plugged-change})
3719 @kindex C-c C-o (Summary)
3720 @findex wl-jump-to-draft-buffer
3721 Move to the draft buffer if available. If multiple draft buffer exists,
3722 moved to one after another. If prefix argument is specified, load draft
3723 folder's message to the draft buffer and jump to it.
3724 (@code{wl-jump-to-draft-buffer})
3727 @kindex M-w (Summary)
3728 @findex wl-summary-save-current-message
3729 Save the message at the current cursor point.
3730 (@code{wl-summary-save-current-message})
3733 @kindex C-y (Summary)
3734 @findex wl-summary-yank-saved-message
3735 Regard the message at the current cursor point as
3736 parent, connect the message saved by
3737 @code{wl-summary-save-current-message}
3739 (@code{wl-summary-yank-saved-message})
3742 @kindex C-x C-s (Summary)
3743 @findex wl-summary-save-status
3744 Save the current summary.
3745 (@code{wl-summary-save-status})
3749 @node Variables of Summary, , Key Bindings of Summary, Summary
3750 @section Customiziable variables
3753 @item wl-summary-move-order
3754 @vindex wl-summary-move-order
3755 The initial setting is @code{unread}. Specify cursor moving policy. If
3756 you want to precede new messages, set @code{new}. If you want to
3757 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3760 @item wl-auto-select-first
3761 @vindex wl-auto-select-first
3762 The initial setting is @code{nil}.
3763 If non-nil, first message is automatically displayed when you enter
3766 @item wl-auto-select-next
3767 @vindex wl-auto-select-next
3768 The initial setting is @code{nil}. This controls behavior when there is
3769 no unread message in current summary.
3772 nil: asks whether you want to go back to folder mode
3773 'unread: asks whether you want to go to next unread folder
3774 If the next one comes to be possessing no unread message
3775 by treatment of cross-posted messages or Scoring, then
3776 asks whether you want to go to next to next folder.
3777 'skip-no-unread: similar as unread
3778 But does not ask before going to next to next folder.
3779 otherwise: asks whether you want to go to next unread folder
3782 It might be useful to set @code{'skip-no-unread} for people who
3783 want to continue reading by just pressing and pressing space key.
3785 @item wl-thread-insert-opened
3786 @vindex wl-thread-insert-opened
3787 The initial setting is @code{nil}.
3788 If non-nil, thread is inserted as opened.
3790 @item wl-thread-open-reading-thread
3791 @vindex wl-thread-open-reading-thread
3792 The initial setting is @code{t}. If non-nil, reading thread is
3793 automatically opened though it is closed thread.
3795 @item wl-summary-exit-next-move
3796 @vindex wl-summary-exit-next-move
3797 The initial setting is @code{t}. If non-nil, move to next folder at
3800 @item wl-folder-move-cur-folder
3801 @vindex wl-folder-move-cur-folder
3802 The initial setting is @code{nil}. If non-nil, cursor position on the
3805 @item wl-summary-weekday-name-lang
3806 @vindex wl-summary-weekday-name-lang
3807 Specify language of the weekday.
3808 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3809 displays Deutsch. You should rescan summary view after changing this value.
3811 @item wl-summary-fix-timezone
3812 @vindex wl-summary-fix-timezone
3813 The initial setting is @code{nil}.
3814 Time zone of the date string in summary mode is adjusted using this value.
3815 If @code{nil}, it is adjust to the default time zone information
3816 (system's default time zone or environment variable @samp{TZ}).
3818 @item wl-use-petname
3819 @vindex wl-use-petname
3820 The initial setting is @code{t}.
3821 If non-nil, sender part displays nickname.
3823 @item wl-break-pages
3824 @vindex wl-break-pages
3825 The initial setting is @code{t}.
3826 If non-nil, message is split as pages by @samp{^L}.
3828 @item wl-message-window-size
3829 @vindex wl-message-window-size
3830 The initial setting is '(1 . 4).
3831 A cons cell to specify the rate of summary and message window.
3832 car:cdr corresponds summary:message.
3834 @item wl-summary-from-function
3835 @vindex wl-summary-from-function
3836 Format function to display sender in summary.
3837 The initial setting is @code{wl-summary-default-from}.
3839 @item wl-summary-no-from-message
3840 @vindex wl-summary-no-from-message
3841 The initial setting is @samp{nobody@@nowhere?}. A string which is
3842 displayed when there's no @samp{From:} field in the message.
3844 @item wl-summary-subject-function
3845 @vindex wl-summary-subject-function
3846 Format function to display subject in summary.
3847 The initial setting is @code{wl-summary-default-subject} and
3848 it will cut the list name part etc. on the top of the subject.
3849 To display subject as it is, set as follows.
3852 (setq wl-summary-subject-function 'identity)
3855 @item wl-summary-no-subject-message
3856 @vindex wl-summary-no-subject-message
3857 The initial setting is @samp{(WL:No Subject in original.)}. A string
3858 which is displayed when there's no @samp{Subject:} field in the message.
3860 @item wl-summary-default-view
3861 @vindex wl-summary-default-view
3862 The initial setting is @code{'thread}.
3863 The default state for newly created summary. You can set either
3864 @code{'thread} for thread view or @code{'sequence} for sequential view.
3866 @item wl-summary-use-frame
3867 @vindex wl-summary-use-frame
3868 The initial setting is @code{nil}.
3869 If non-nil, use new frame for the summary.
3871 @item wl-use-folder-petname
3872 @vindex wl-use-folder-petname
3873 The initial setting is the list shown below:
3882 A list of display policy (symbol) of folder nickname. Available symbols
3887 Display folder petname on modeline.
3889 Destination folder is notified as nickname if
3890 @code{wl-auto-select-next} is non-nil.
3892 You can input folder name by nickname in the function
3893 @code{wl-summary-read-folder}.
3896 @item wl-summary-move-direction-toggle
3897 @vindex wl-summary-move-direction-toggle
3898 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3899 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3900 want to aware of reading direction, set this to @code{t}.
3902 @item wl-summary-width
3903 @vindex wl-summary-width
3904 The initial setting is 80.
3905 Width of summary line. If @code{nil}, summary line's width is as is.
3907 @item wl-summary-print-argument-within-window
3908 @vindex wl-summary-print-argument-within-window
3909 The initial setting is @code{nil}.
3910 If non-nil, the action argument is always printed on right side of
3913 @item wl-summary-indent-length-limit
3914 @vindex wl-summary-indent-length-limit
3915 The initial setting is 46.
3916 Specify the limit of thread indent level. @code{nil} means unlimited
3918 If you set this to @code{nil} you should set @code{wl-summary-width}
3921 @item wl-summary-max-thread-depth
3922 @vindex wl-summary-max-thread-depth
3923 The initial setting is 15.
3924 If thread depth of the message is larger than this value,
3925 the thread is divided.
3927 @item wl-summary-recenter
3928 @vindex wl-summary-recenter
3929 The initial setting is t.
3930 If non-nil, cursor point is moved to the center of the summary window.
3932 @item wl-summary-divide-thread-when-subject-changed
3933 @vindex wl-summary-divide-thread-when-subject-changed
3934 The initial setting is @code{nil}. If non-nil, thread is split if
3935 the subject is changed.
3937 @item wl-summary-search-via-nntp
3938 @vindex wl-summary-search-via-nntp
3939 The initial setting is @code{confirm}.
3941 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3942 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3943 from the NNTP server @code{elmo-nntp-default-server}. The value of
3944 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3945 @code{elmo-nntp-default-stream-type} are used.
3947 If @code{confirm}, server name can be specified. You can specify NNTP
3948 folder format like @samp{-:username@@servername:119!}.
3950 @item wl-summary-keep-cursor-command
3951 @vindex wl-summary-keep-cursor-command
3952 The initial setting is the list shown below:
3956 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3961 When you entered to summary by these commands and the target summary
3962 buffer already exists, summary status is not automatically updated and
3963 cursor position is saved.
3965 @item elmo-folder-update-threshold
3966 @vindex elmo-folder-update-threshold
3967 The initial setting is 500. If updated message number is larger than
3968 this value, confirm whether drop them or not (in the case where the value
3969 of @code{elmo-folder-update-confirm} is non-nil).
3971 @item elmo-folder-update-confirm
3972 @vindex elmo-folder-update-confirm
3973 The initial setting is @code{t}. If the value is non-nil, do check with
3974 @code{elmo-folder-update-threshold}.
3976 @item wl-summary-always-sticky-folder-list
3977 @vindex wl-summary-always-sticky-folder-list
3978 The initial setting is @code{nil}.
3979 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3980 are automatically stuck. Each element is regexp of folder name.
3982 @item wl-summary-reserve-mark-list
3983 @vindex wl-summary-reserve-mark-list
3984 The initial setting is the list shown below:
3988 ("o" "O" "D" "d" "i")
3993 If a message is already marked as temporal marks in this list, the
3994 message is not marked by any mark command.
3996 @item wl-summary-skip-mark-list
3997 @vindex wl-summary-skip-mark-list
3998 The initial setting is the list shown below:
4007 If a message is already marked as temporal marks in this list, the
4008 message is skipped at cursor move.
4010 @item elmo-message-fetch-threshold
4011 @vindex elmo-message-fetch-threshold
4012 The initial setting is 30000 (bytes). If displaying message has larger
4013 size than this value, Wanderlust confirms whether fetch the message or
4014 not (in the case where the value of @code{elmo-message-fetch-confirm}
4017 @item elmo-message-fetch-confirm
4018 @vindex elmo-message-fetch-confirm
4019 The initial setting is @code{t}. If the value is non-nil, do check with
4020 @code{elmo-message-fetch-threshold}.
4022 @item wl-prefetch-threshold
4023 @vindex wl-prefetch-threshold
4024 The initial setting is 30000 (bytes). If prefetching message has larger
4025 size than this value and @code{wl-prefetch-confirm} is non-nil,
4026 Wanderlust confirms whether prefetch the message or not. If
4027 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
4028 without confirmation.
4030 @item wl-prefetch-confirm
4031 @vindex wl-prefetch-confirm
4032 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4033 prefetch the message or not if the message has larger size than
4034 @code{wl-prefetch-threshold}.
4036 @item elmo-imap4-use-cache
4037 @vindex elmo-imap4-use-cache
4038 The initial setting is @code{t}. If non-nil, messages read via IMAP4
4041 @item elmo-nntp-use-cache
4042 @vindex elmo-nntp-use-cache
4043 The initial setting is @code{t}. If non-nil, messages read via NNTP are
4046 @item elmo-pop3-use-cache
4047 @vindex elmo-pop3-use-cache
4048 The initial setting is @code{t}. If non-nil, messages read via POP3 are
4051 @item elmo-shimbun-use-cache
4052 @vindex elmo-shimbun-use-cache
4053 The initial setting is @code{t}. If non-nil, messages read in Shimbun
4056 @item wl-folder-process-duplicates-alist
4057 @vindex wl-folder-process-duplicates-alist
4058 The initial setting is @code{nil}.
4059 This list determines how to deal with duplicated messages in the same folder.
4060 Each item in the list is regexp of folder name and action; you can specify any
4061 one of the following in the place of action:
4064 @code{nil} : do nothing for duplicated messages.
4065 @code{hide} : hide duplicated messages from the summary.
4066 @code{read} : set duplicated messages as read.
4070 Following is an example (hide duplicated messages in multi folders)
4074 (setq wl-folder-process-duplicates-alist
4075 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4076 ("^\\*.*" . hide) (".*" . read)))
4082 @node Message, Draft, Summary, Top
4083 @chapter Message Buffer
4085 Message Buffers utilize MIME-View mode of SEMI. For operational
4086 procedures and key bindings, refer to respective documents.
4087 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4088 You can also see help by @kbd{?} in message buffer.
4090 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4091 brings you back to Summary mode. @kbd{l} toggles display of Summary
4094 @section Key Bindings
4100 @findex wl-message-toggle-disp-summary
4101 Toggles display of Summary buffer.
4102 (@code{wl-message-toggle-disp-summary})
4105 @findex wl-message-refer-article-or-url
4106 @kindex Button-2 (Message)
4107 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4108 corresponding message if found.
4109 (@code{wl-message-refer-article-or-url})
4111 @item Button-4 (upward movement of a wheel)
4112 @kindex Button-4 (Message)
4113 @findex wl-message-wheel-down
4114 Scrolls the message backwards. When the top of the message is hit,
4115 moves to the previous message.
4116 (@code{wl-message-wheel-down})
4118 @item Button-5 (downward movement of a wheel)
4119 @kindex Button-5 (Message)
4120 @findex wl-message-wheel-up
4121 Scrolls the message forward. When the bottom of the message is hit,
4122 moves to the next message.
4123 (@code{wl-message-wheel-up})
4127 @findex wl-message-delete-current-part
4128 Delete the part under cursor. In fact it appends modified message to
4129 the current folder then moves old one to trash folder. Therefore the
4130 message number will be changed.
4131 (@code{wl-message-delete-current-part})
4134 @section Customizable Variables
4137 @item wl-message-window-size
4138 @vindex wl-message-window-size
4139 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4140 its car and cdr value corresponds to the ratio of Summary and Message
4143 @item wl-message-ignored-field-list
4144 @vindex wl-message-ignored-field-list
4145 Initial setting is @code{nil}.
4146 All fields that match this list will be hidden in message buffer.
4147 Each elements are regexp of field-name.
4148 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4150 @item wl-message-visible-field-list
4151 @vindex wl-message-visible-field-list
4152 Initial setting is @code{nil}.
4153 All fields that match this list will be display in message buffer.
4154 Each elements are regexp of field-name. This value precedes
4155 @code{wl-message-ignored-field-list}.
4156 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4158 @item wl-message-sort-field-list
4159 @vindex wl-message-sort-field-list
4161 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4162 Header fields in message buffer are ordered by this value.
4163 Each elements are regexp of field-name.
4165 @item wl-message-truncate-lines
4166 @vindex wl-message-truncate-lines
4167 The initial value is the value of @code{default-truncate-lines}.
4168 If it is non-nil, truncate long lines in message buffer.
4171 @node Draft, Disconnected Operations, Message, Top
4172 @chapter Draft Buffer
4174 At Summary mode, pressing @kbd{w} and the like creates a new draft
4175 buffer. You can edit and send mail and news articles in this buffer.
4177 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4178 with those if possible.
4181 * Usage of Draft Mode:: TIPS
4182 * Key Bindings of Draft:: Key bindings
4183 * Variables of Draft Mode:: Customize Draft Mode
4186 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4189 Basically it is Emacs-standard mail mode.
4193 * Editing Message Body::
4194 * Dynamical Message Re-arrangement::
4199 @node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
4200 @subsection Editing Message Header
4202 You can freely edit header region above @samp{--text follows this line--},
4203 until you invoke the sending operation.
4205 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4206 addresses. @kbd{@key{TAB}} completes them.
4208 You can use following headers to specify recipients. Add some of them
4209 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4212 @item @samp{Newsgroups:}
4213 Specify newsgroups to which you post the news article.
4216 Specify addresses to send a copy (Carbon Copy) of the message.
4219 Following ones are removed from the header contents before sending.
4223 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4226 Specify folders in which a copy of the message is saved.
4229 Specify recipients to send encapsulated copy of the message.
4232 You can add initial headers by following variables.
4238 The initial setting is @code{nil}.
4239 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4240 the draft when it is prepared. If function is specified, its return
4245 The initial setting is @code{nil}.
4246 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4247 the draft when it is prepared.
4250 @node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4251 @subsection Editing Messages
4253 As a matter of course, editing message body can be performed in the same
4254 way as usual writing. You may write message body under
4255 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4256 @samp{--text follows this line--} intact.)
4258 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4259 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4260 a MIME user interface for GNU Emacs}.
4261 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4263 If you save the draft buffer you are editing, it is appended to the
4264 folder specified by @code{wl-draft-folder}.
4266 @node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
4267 @subsection Dynamic Modification of Messages
4268 @vindex wl-draft-config-alist
4269 @c @cindex Change Message
4270 @c @cindex Message, Change Dynamic
4272 You can set @code{wl-draft-config-alist} so that header and body of the
4273 message will automatically modified depending on information of header
4276 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4278 In the example below, the header is modified when
4279 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4280 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4281 before sending the message.
4285 (setq wl-draft-config-alist
4286 '(((string-match "aaa\\.example\\.com$" (system-name))
4287 ;; @r{applied if the expression is non-nil}
4288 (wl-smtp-posting-server . "mailserver-B")
4289 (wl-nntp-posting-server . "newsserver-B")
4290 ;; @r{settings of temporary variables}
4292 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4293 ;; @r{applied if it matches the header of the draft buffer}
4294 ("Organization" . (format "Go %s" my-webpage)))
4295 ;; @r{you can write elisp expressions here (eval only)}
4296 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4297 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4302 The format of @code{wl-draft-config-alist} is:
4306 '(("@var{regexp of the header}" or @var{elisp expression}
4307 ("@var{Field}" . value(@var{elisp expression}))
4308 (@var{variable} . value(@var{elisp expression}))
4309 (@var{sub-function} . value(@var{elisp expression}))
4312 ("@var{regexp of the header}" or @var{elisp expression}
4313 ("@var{Field}" . value(@var{elisp expression}))
4318 Per default, there are 13 following sub-functions.
4321 'header: Inserts the specified string at the bottom of the header.
4322 'header-top: Inserts the specified string at the top of the header.
4323 'header-file: Inserts the specified file at the bottom of the header.
4324 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4325 'top: Inserts the specified string at the top of the body.
4326 'top-file: Inserts the specified file at the top of the body.
4327 'body: Replaces the body with the specified string.
4328 Specifying @code{nil} deletes the entire body string.
4329 'body-file: Replaces the body with the content of the specified file.
4330 'bottom: Inserts the specified string at the bottom of the body.
4331 'bottom-file: Inserts the specified file at the top of the body.
4332 'part-top: Inserts the specified string at the top of the current part.
4333 'part-bottom: Inserts the specified string at the bottom of the current part.
4334 'template: Applies the specified template.
4335 (refer to the next subsection)
4338 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4339 change them or add your own functions. If you read the code, you can
4340 easily find how to write the functions.
4342 At the first of each item, @var{a regular expression of the header} or
4343 an @var{elisp expression} should be specified. In the case of an elisp
4344 expression, the item is applied when the expression is evaluated
4347 Per default, when multiple items match or are evaluated non-nil, all
4348 such items are applied, but if you set a variable
4349 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4352 At the second of the item, a cons or a list of functions should be
4353 specified. The car part of the cons should be a header field, a
4354 variable, or a sub-function. When a header field is specified, the
4355 field will be modified. If a variable is specified, the value of the
4356 variable will be modified temporarily.
4358 In the cdr part of a cons, not only a variable but also an elisp
4359 expression can be specified as is. If the car part is a header field
4360 and the cdr part is @code{nil}, the field will be deleted.
4362 See the next example as well:
4366 (setq wl-draft-config-alist
4368 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4369 ;; @r{applied if it matches the header of the buffer being replied}
4370 (body . " Hello.\n")
4371 (template . "default")
4376 As in the (1) above, if a header regexp is prepended with @code{reply},
4377 it is applied when the draft is prepared by @code{wl-summary-reply} for
4378 example, and when it matches the header being replied. It is ignored
4379 when there is no buffer being replied, like after @code{wl-draft} was
4382 If you want to use name of parent folder, you can refer the buffer local
4383 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4384 changes From according to the folder name of the summary in which the draft
4389 (setq wl-draft-config-alist
4390 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4391 (\"From\" . \"user@@domain1\"))
4392 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4393 (\"From\" . \"user@@domain2\"))))
4398 Note that @code{wl-draft-config-alist} is applied only once when
4399 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4400 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4401 aborting transmission, execute @kbd{C-c C-e}
4402 (@code{wl-draft-config-exec}) explicitly.
4404 If you don't want to apply @code{wl-draft-config-alist} when
4405 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4409 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4412 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4413 prepared, do the following:
4416 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4419 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4420 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4424 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4427 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4428 @subsection Inserting Templates
4430 @cindex Apply Template
4432 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4433 @kbd{M-x wl-template-select} in the draft buffer.
4435 The format of @code{wl-template-alist} is almost the same as
4436 @code{wl-draft-config-alist}.
4437 @xref{Dynamical Message Re-arrangement}.
4441 (setq wl-template-alist
4444 ("Organization" . "Example Co.Ltd.")
4445 (body . "Hello.\n"))
4447 (template . "default") ;; @r{(a)}
4448 ("To" . "boss@@example.com")
4449 ("Subject" . "Report")
4450 (body-file . "~/work/report.txt")
4456 As you can see, the only difference is item (template) names such as
4457 @samp{default} and @samp{report}, instead of a regexp of header.
4458 Because definition of each item is the same as
4459 @code{wl-draft-config-alist}, you can call another template, like (a).
4461 Executing the command @code{wl-template-select} results in template
4462 selection, but the result differs depending on variable
4463 @code{wl-template-visible-select}.
4465 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4466 window is shown below the draft buffer. You can select a template by
4467 @kbd{n} and @kbd{p} seeing the buffer window.
4469 Press the @key{RET} key and the template is actually applied to the draft
4470 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4471 adjust the window size by @code{wl-template-buffer-lines}.
4473 If @code{wl-template-visible-select} is @code{nil}, you should type the
4474 name of the template in the mini buffer.
4476 As shown in the example in @code{wl-draft-config-alist}, you can select
4477 @samp{default} template by writing:
4480 (template . "default")
4483 @node POP-before-SMTP, , Template, Usage of Draft Mode
4484 @subsection Sending mail by POP-before-SMTP
4485 @cindex POP-before-SMTP
4487 You can send mail by POP-before-SMTP with this single line:
4490 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4494 Configure the following variables if you need.
4497 @item wl-pop-before-smtp-user
4498 The POP user name for POP-before-SMTP authentication.
4499 If unset, @code{elmo-pop3-default-user} is used.
4501 @item wl-pop-before-smtp-server
4502 The POP server name for POP-before-SMTP authentication.
4503 If unset, @code{elmo-pop3-default-server} is used.
4505 @item wl-pop-before-smtp-authenticate-type
4506 The POP authentication method for POP-before-SMTP authentication.
4507 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4509 @item wl-pop-before-smtp-port
4510 The POP port number for POP-before-SMTP authentication.
4511 If unset, @code{elmo-pop3-default-port} is used.
4513 @item wl-pop-before-smtp-stream-type
4514 If @code{ssl}, POP connection is established using SSL. If
4515 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4516 unset, @code{elmo-pop3-default-stream-type} is used.
4519 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4520 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4522 Therefore, if SMTP server and POP server are actually the same, and if
4523 POP folder per default (such as @samp{&}) is available, no settings are
4526 Refer to the following URL about POP-before-SMTP.
4530 http://spam.ayamura.org/tools/smPbS.html
4531 http://www.iecc.com/pop-before-smtp.html
4536 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4537 @section Key Bindings
4538 @cindex Keybind, Draft Mode
4539 @cindex Keybind, Draft Buffer
4544 @kindex C-c C-y (Draft)
4545 @findex wl-draft-yank-original
4546 Cites the content of the current message buffer (the part under cursor).
4547 If the region is active, cites the region (it affects only if
4548 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4549 (on XEmacs) is Non-nil).
4550 (@code{wl-draft-yank-original})
4553 @kindex C-c C-p (Draft)
4554 @findex wl-draft-preview-message
4555 Previews the content of the current draft.
4556 This is useful for previewing MIME multi-part messages.
4557 (@code{wl-draft-preview-message})
4560 @kindex C-c C-s (Draft)
4561 @findex wl-draft-send
4562 Sends the content of the current draft. Does not erase the draft buffer.
4563 This is useful for sending multiple messages, which are a little different
4565 (@code{wl-draft-send})
4568 @kindex C-c C-c (Draft)
4569 @findex wl-draft-send-and-exit
4570 Sends the content of the current draft and erases the draft buffer.
4571 (@code{wl-draft-send-and-exit})
4574 @kindex C-x C-s (Draft)
4575 @findex wl-draft-save
4576 Save the current draft.
4577 (@code{wl-draft-save})
4580 @kindex C-c C-k (Draft)
4581 @findex wl-draft-kill
4582 Kills the current draft.
4583 (@code{wl-draft-kill})
4586 @kindex C-x k (Draft)
4587 @findex wl-draft-mimic-kill-buffer
4588 Kills the current draft.
4589 (@code{wl-draft-mimic-kill-buffer})
4592 @kindex C-c C-z (Draft)
4593 @findex wl-draft-save-and-exit
4594 Saves the current draft, and erases the draft buffer.
4595 This is useful if you want to suspend editing of the draft.
4596 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4597 the @samp{+draft} folder.
4598 (@code{wl-draft-save-and-exit})
4601 @kindex C-c C-r (Draft)
4602 @findex wl-caesar-region
4603 Encodes or decodes the specified region in Caesar cipher.
4604 (@code{wl-caesar-region})
4608 @findex wl-draft-highlight-and-recenter
4609 Recenter and rehighlight current draft.
4610 (@code{wl-draft-highlight-and-recenter})
4614 @findex wl-toggle-plugged
4615 Toggles off-line/on-line states of Wanderlust.
4616 (@code{wl-toggle-plugged})
4619 @kindex C-c C-o (Draft)
4620 @findex wl-jump-to-draft-buffer
4621 Jumps to the other draft buffer, if exists.
4622 With prefix argument, reads a file (if any) from the draft folder when
4623 there is no such buffer.
4624 (@code{wl-jump-to-draft-buffer})
4627 @kindex C-c C-e (Draft)
4628 @findex wl-draft-config-exec
4629 Applies @code{wl-draft-config-alist}.
4630 (@code{wl-draft-config-exec})
4633 @kindex C-c C-j (Draft)
4634 @findex wl-template-select
4636 (@code{wl-template-select})
4639 @kindex C-c C-a (Draft)
4641 Enter Address Manager.
4642 @xref{Address Manager}.
4646 @kindex C-c C-d (Draft)
4647 @findex wl-draft-elide-region
4648 Elide the text between point and mark (@code{wl-draft-elide-region}).
4649 The text is killed and replaced with the contents of the variable
4650 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4654 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4655 @section Customizable Variables
4659 @item wl-subscribed-mailing-list
4660 @vindex wl-subscribed-mailing-list
4661 The initial setting is @code{nil}. Mailing lists to which you
4662 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4663 field of a reply draft, removes your own address from
4664 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4665 contained in @samp{To:} or @samp{Cc:} field of a message to be
4666 automatically re-filed, the destination folder will be leaned in
4667 connection with the address.
4673 (setq wl-subscribed-mailing-list
4674 '("wl@@lists.airs.net"
4676 "emacs-mime-ja@@m17n.org"))
4680 @item wl-insert-mail-followup-to
4681 @vindex wl-insert-mail-followup-to
4682 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4683 field is automatically inserted in the draft buffer.
4685 @item wl-insert-mail-reply-to
4686 @vindex wl-insert-mail-reply-to
4687 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4688 field is automatically inserted in the draft buffer.
4690 @item wl-auto-insert-x-face
4691 @vindex wl-auto-insert-x-face
4692 The initial setting is @code{t}. If non-nil and there is an encoded
4693 X-Face string in a file @file{~/.xface} (the value of the variable
4694 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4695 draft buffer. If @code{nil}, it is not automatically inserted.
4697 @item wl-insert-message-id
4698 @vindex wl-insert-message-id
4699 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4700 is automatically inserted on the transmission.
4702 @item wl-message-id-use-wl-from
4703 @vindex wl-message-id-use-wl-from
4704 The initial setting is @code{nil}. If non-nil, the value of
4705 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4707 @item wl-local-domain
4708 @vindex wl-local-domain
4709 The initial setting is @code{nil}. If @code{nil}, the return value of
4710 the function @code{system-name} will be used as the domain part of
4713 If @code{system-name} does not return FQDN (i.e. the full name of the
4714 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4715 to the string of the local domain name without hostname (like
4716 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4717 @samp{.} @code{wl-local-domain} is used as domain part of the
4720 If your terminal does not have global IP, set the value of
4721 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4722 you use invalid @samp{Message-ID:}.)
4724 Moreover, concatenation of @code{system-name} @samp{.}
4725 @code{wl-local-domain} will be used as an argument to the HELO command
4728 @item wl-message-id-domain
4729 @vindex wl-message-id-domain
4730 The initial setting is @code{nil}. If non-nil, this value is used as a
4731 domain part of the @samp{Message-ID:}. If your terminal does not have
4732 global IP address, set unique string to this value (e.x. your e-mail
4735 @item wl-unique-id-suffix
4736 @vindex wl-unique-id-suffix
4737 The initial setting is @samp{.wl}. You can specify the string in generated
4738 Message-ID which appear just before @samp{@@}.
4740 @item wl-draft-config-alist
4741 @vindex wl-draft-config-alist
4742 The initial setting is @code{nil}. Modifies the draft message just
4743 before the transmission. The content of @code{wl-draft-config-alist}
4744 will be automatically applied only once on the transmission. If you
4745 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4748 @item wl-template-alist
4749 @vindex wl-template-alist
4750 The initial setting is @code{nil}.
4751 This variable specifies the template to be applied in the draft buffer.
4753 @item wl-draft-config-matchone
4754 @vindex wl-draft-config-matchone
4755 The initial setting is @code{nil}. If non-nil, only the first matching
4756 item is used when @code{wl-draft-config-alist} is applied. If
4757 @code{nil}, all matching items are used.
4759 @item wl-template-visible-select
4760 @vindex wl-template-visible-select
4761 The initial setting is @code{t}.
4762 If non-nil, you can preview the result of the template selection in
4765 @item wl-template-confirm
4766 @vindex wl-template-confirm
4767 The initial setting is @code{nil}.
4768 If non-nil, asks for confirmation when you press the enter key to select
4769 template while previewing.
4771 @item wl-template-buffer-lines
4772 @vindex wl-template-buffer-lines
4773 The initial setting is 7.
4774 If @code{wl-template-visible-select} is non-nil, this variable specifies
4775 the size of the preview window.
4777 @item wl-draft-buffer-style
4778 @vindex wl-draft-buffer-style
4779 The initial setting is @code{full}.
4780 Style of draft buffer window (except for replying and forwarding).
4781 @code{keep} is to use current window,
4782 @code{full} is to use full frame window,
4783 @code{split} is to split current window and use it.
4784 If some function is specified, it is called with the draft buffer
4787 @item wl-draft-reply-buffer-style
4788 @vindex wl-draft-reply-buffer-style
4789 The initial setting is @code{split}.
4790 Style of draft buffer for replying and forwarding.
4791 @code{keep} is to use message buffer window,
4792 @code{full} is to use full frame window,
4793 @code{split} is to split message buffer window and use it.
4794 If some function is specified, it is called with the draft buffer
4797 @item wl-draft-use-frame
4798 @vindex wl-draft-use-frame
4799 The initial setting is @code{nil}.
4800 If non-nil, use new frame for the draft.
4802 @item wl-draft-truncate-lines
4803 @vindex wl-draft-truncate-lines
4804 The initial value is the value of @code{default-truncate-lines}.
4805 If it is non-nil, truncate long lines in draft buffer.
4809 The initial setting is the value of the variable
4810 @code{user-mail-address}. The value of this variable is inserted as a
4811 @samp{From:} field of the draft when it is prepared.
4813 @item wl-envelope-from
4814 @vindex wl-envelope-from
4815 The initial setting is @code{nil}.
4816 The value of this variable is used for envelope from (MAIL FROM).
4817 If @code{nil}, the address part of @code{wl-from} is used.
4819 @item wl-user-mail-address-list
4820 @vindex wl-user-mail-address-list
4821 The initial setting is @code{nil}.
4822 This is the User's address list. If you have multiple addresses,
4825 @item wl-reply-subject-prefix
4826 @vindex wl-reply-subject-prefix
4827 The initial setting is @samp{Re: }.
4828 In the @samp{Subject:} of the reply draft, this string is prepended to
4829 the @samp{Subject:} of being replied.
4831 @item wl-forward-subject-prefix
4832 @vindex wl-forward-subject-prefix
4833 The initial setting is @samp{Forward: }.
4834 In the @samp{Subject:} of the forwarding draft, this string is prepended
4835 to the @samp{Subject:} of being forwarded.
4837 @item wl-draft-reply-use-address-with-full-name
4838 @vindex wl-draft-reply-use-address-with-full-name
4839 The initial setting is @code{t}.
4840 If non-nil, insert her full name with address when prepare a draft for
4841 reply a message. If it is @code{nil}, insert her address only.
4843 @item wl-draft-enable-queuing
4844 @vindex wl-draft-enable-queuing
4845 The initial setting is @code{t}.
4846 This flag controls off-line transmission. If non-nil, the draft is
4849 @item wl-draft-use-cache
4850 @vindex wl-draft-use-cache
4851 The initial setting is @code{nil}. If the value is non-nil and
4852 @code{wl-insert-message-id} is nil, cache the message which is sent.
4854 @item wl-fcc-force-as-read
4855 @vindex wl-fcc-force-as-read
4856 The initial setting is @code{nil}. If the value is non-nil,
4857 Mark as read the message saved by @samp{Fcc:}.
4859 @item wl-auto-flush-queue
4860 @vindex wl-auto-flush-queue
4861 The initial setting is t.
4862 This flag controls automatic transmission of the queue when Wanderlust
4863 becomes on-line. If non-nil, the queue is automatically transmitted
4864 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4865 manually, press @kbd{F} in the folder mode.
4867 @item wl-ignored-forwarded-headers
4868 @vindex wl-ignored-forwarded-headers
4869 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4870 All headers that match this regexp will be deleted when forwarding a message.
4872 @item wl-ignored-resent-headers
4873 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4874 All headers that match this regexp will be deleted when resending a message.
4876 @item wl-draft-always-delete-myself
4877 @vindex wl-draft-always-delete-myself
4878 If non-nil, always removes your own address from @samp{To:} and
4879 @samp{Cc:} when you are replying to the mail addressed to you.
4881 @item wl-draft-delete-myself-from-bcc-fcc
4882 @vindex wl-draft-delete-myself-from-bcc-fcc
4883 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4884 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
4886 @item wl-smtp-posting-server
4887 @vindex wl-smtp-posting-server
4888 The initial setting is @code{nil}.
4889 This is the SMTP server name for mail transmission.
4891 @item wl-smtp-posting-port
4892 @vindex wl-smtp-posting-port
4893 The initial setting is @code{nil}.
4894 This is the SMTP port number for mail transmission.
4895 If @code{nil}, default SMTP port number (25) is used.
4897 @item wl-smtp-posting-user
4898 @vindex wl-smtp-posting-user
4899 The initial setting is @code{nil}.
4900 This is the user name for SMTP AUTH authentication. If @code{nil},
4901 @code{smtp-authenticate-user} is used.
4903 @item wl-smtp-authenticate-type
4904 @vindex wl-smtp-authenticate-type
4905 The initial setting is @code{nil}.
4906 This is the authentication method for SMTP AUTH authentication. If
4907 @code{nil}, @code{smtp-authenticate-type} is used. If
4908 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4911 @item wl-smtp-connection-type
4912 @vindex wl-smtp-connection-type
4913 The initial setting is @code{nil}.
4914 This variable specifies how to establish SMTP connections.
4915 If @code{nil}, use default connection type.
4916 If it is @code{starttls}, use STARTTLS (RFC2595).
4917 If it is @code{ssl}, use SSL.
4919 @item wl-nntp-posting-server
4920 @vindex wl-nntp-posting-server
4921 The initial setting is @code{nil}.
4922 This is the NNTP server name used for news submission.
4923 If @code{nil}, @code{elmo-nntp-default-server} is used.
4925 @item wl-nntp-posting-user
4926 @vindex wl-nntp-posting-user
4927 The initial setting is @code{nil}.
4928 This is the user name for AUTHINFO authentication on news submission.
4929 If @code{nil}, @code{elmo-nntp-default-user} is used.
4930 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4932 @item wl-nntp-posting-port
4933 @vindex wl-nntp-posting-port
4934 The initial setting is @code{nil}.
4935 This is the port number of the NNTP server used for news submission.
4936 If @code{nil}, @code{elmo-nntp-default-server} is used.
4938 @item wl-nntp-posting-stream-type
4939 @vindex wl-nntp-posting-stream-type
4940 The initial setting is @code{nil}.
4941 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If @code{ssl},
4942 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4943 connection will be established.
4945 @item wl-nntp-posting-function
4946 @vindex wl-nntp-posting-function
4947 The initial setting is @code{elmo-nntp-post}.
4948 This is the function to post NNTP message.
4950 @item wl-nntp-posting-config-alist
4951 @vindex wl-nntp-posting-config-alist
4952 The initial setting is @code{nil}.
4953 The value takes an alist to define NNTP server like following example.
4954 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
4958 (setq wl-nntp-posting-config-alist
4959 '((",?gmane\\." . "news.gmane.org")
4961 ((server . "news-server")
4962 (user . "newsmaster")
4964 (function . elmo-nntp-post)))
4965 (".*" . "default-news-server")))
4969 @item wl-pop-before-smtp-user
4970 @vindex wl-pop-before-smtp-user
4971 The initial setting is @code{nil}.
4972 This is the POP user name for POP-before-SMTP.
4973 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4975 @item wl-pop-before-smtp-server
4976 @vindex wl-pop-before-smtp-server
4977 The initial setting is @code{nil}.
4978 This is the POP server name for POP-before-SMTP.
4979 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4981 @item wl-pop-before-smtp-authenticate-type
4982 @vindex wl-pop-before-smtp-authenticate-type
4983 The initial setting is @code{nil}.
4984 This is the authentication method for POP-before-SMTP authentication.
4985 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4987 @item wl-pop-before-smtp-port
4988 @vindex wl-pop-before-smtp-port
4989 The initial setting is @code{nil}.
4990 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4991 @code{elmo-pop3-default-port} is used.
4993 @item wl-pop-before-smtp-stream-type
4994 @vindex wl-pop-before-smtp-stream-type
4995 The initial setting is @code{nil}.
4996 This flag controls the use of SSL for POP-before-SMTP. If it is
4997 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{ssl},
4998 SSL is used. If @code{starttls}, STARTTLS (RFC2595) connection will be
5001 @item wl-draft-queue-save-variables
5002 @vindex wl-draft-queue-save-variables
5003 Specifies a list of variable to which queued messages are saved on the
5004 off-line transmission.
5006 @item wl-draft-sendlog
5007 @vindex wl-draft-sendlog
5008 The initial setting is @code{t}.
5009 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
5013 @item drafts are sent by smtp or qmail
5014 @item saved into folders by fcc
5015 @item saved into folders by queuing
5018 (it is written even if the transmission fails).
5019 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
5020 and left to the logging function of @command{imput}.
5023 @item wl-draft-sendlog-max-size
5024 @vindex wl-draft-sendlog-max-size
5025 The initial setting is 20000 (in bytes).
5026 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
5027 beyond the size specified by this variable.
5031 The initial setting is @code{nil}.
5032 If non-nil, address completion uses LDAP.
5034 @item wl-ldap-server
5035 @vindex wl-ldap-server
5036 The initial setting is @samp{localhost}.
5037 LDAP server name for address completion.
5040 @vindex wl-ldap-port
5041 The initial setting is @code{nil}.
5042 If non-nil, the value is used as port number.
5045 @vindex wl-ldap-base
5046 The initial setting is @samp{c=US}.
5047 LDAP search starting point (base) for address completion.
5049 @item wl-draft-remove-group-list-contents
5050 @vindex wl-draft-remove-group-list-contents
5051 The initial setting is @code{t}.
5052 If non-nil, remove the group-lists' members in the recipients when
5053 sending the message (group-list means the description such as
5054 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5057 @node Disconnected Operations, Expire and Archive, Draft, Top
5058 @chapter Off-line Management
5059 @cindex Disconnected Operations
5061 Wanderlust has on-line and off-line states.
5064 * Off-line State:: Wanderlust has on-line and off-line states
5065 * Enable Operations:: Enable Disconnected Operations
5066 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5067 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5068 * Variables of Plugged Mode:: Customize Plugged Mode
5072 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5073 @section Off-line State
5075 Wanderlust has on-line and off-line states. In the off-line state, you
5076 cannot access messages via network, unless they are cached.
5078 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5079 in the mode line indicates the off-line state. In folder or summary
5080 modes, press @kbd{M-t} to switch between off- and on-line.
5082 You can invoke Wanderlust in the off-line state by setting
5083 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5085 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5086 ignores uncached messages.
5089 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5090 @section Enable Disconeected Operations
5092 Even in the off-line state, provided that relevant messages are cached,
5093 and the variable @code{elmo-enable-disconnected-operation} (described
5094 later) is non-nil, you can following operations:
5095 @xref{Plugged Mode}, @xref{Off-line State settings}.
5098 * Send Messages off-line:: Transmit Messages
5099 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5100 * Creation of Folders:: Create Folders off-line (IMAP4)
5101 * Marking:: Mark (IMAP4)
5102 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
5105 As soon as Wanderlust becomes on-line, such operations invoked off-line
5106 are reflected in the servers via network.
5109 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5110 @subsection Transmission of Messages
5112 You can proceed sending operation for mail/news messages while you are
5113 off-line, then it will be reserved for sending (if you are using
5114 @file{im-wl.el}, it is irrelevant).
5115 Messages reserved for sending while off-line are accumulated in the
5116 queue folder, @samp{+queue}. These messages are transmitted at once when
5117 Wanderlust becomes on-line.
5119 You can visit @samp{+queue} in the off-line state and confirm content of
5120 messages in the queue. You can also remove messages. Removed messages
5121 are not transmitted even in the on-line state.
5124 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5125 @subsection Re-file and Copy (IMAP4)
5127 Re-file and copy operations to IMAP folders invoked during the off-line
5128 state are accumulated in the queue, and reflected in the server side
5129 when Wanderlust becomes on-line. If you visit destination folders after
5130 off-line re-file or copy, it looks as if messages were appended even in
5133 For the safety reasons, messages re-filed off-line are removed from
5134 source folders only if their @samp{Message-ID:} match messages on the
5135 servers. While the queue is processed, messages that failed to be
5136 re-filed or copied to the specified folders are appended to the folder
5140 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5141 @subsection Creation of Folders (IMAP4)
5143 You can create IMAP folders off-line. The creation of folders are
5144 reflected in the servers when Wanderlust becomes on-line. If the creation
5145 of those folders fails at that time for some reasons, messages
5146 to be re-filed into those are appended to the folder @samp{+lost+found}
5150 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5151 @subsection Marking (IMAP4)
5153 Off-line changes in unread/read and importance mark @samp{$} information
5154 are also reflected in the servers when Wanderlust becomes on-line.
5157 @node Pre-fetching Reservations, , Marking, Enable Operations
5158 @subsection Pre-fetching (IMAP4, NNTP)
5160 You can make reservations for pre-fetching messages in IMAP or NNTP
5161 folders. Reserved messages are marked with @samp{!} but not cached
5162 yet. When Wanderlust becomes on-line, they are pre-fetched from
5165 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5166 these off-line operations for IMAP4 and NNTP do not take place, and
5167 off-line re-file, copy or suchlike simply results in error.
5169 Because off-line operations use cache files, it is a bad idea to erase
5170 them by hand; it may cause Wanderlust to malfunction.
5172 If you want to remove caches, be sure to execute @kbd{M-x
5173 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5174 remove caches for messages relevant to off-line operations.
5177 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5178 @section Switching On-line/Off-line per Server/Port
5180 @kbd{M-t} described above switches networking states as a whole, but you
5181 can switch on-line/off-line per server/port.
5183 Pressing @kbd{C-t} in the folder or summary modes brings you in
5184 wl-plugged-mode shown below, in which you can change the plugged state
5189 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5192 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5193 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5195 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5196 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5202 The first line indicates status of the following three variables, and
5203 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5204 column modifies the values of these variables.
5208 "Queuing" @code{wl-draft-enable-queuing}
5209 "AutoFlushQueue" @code{wl-auto-flush-queue}
5210 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5214 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5217 The second and after lines indicate on-line/off-line states of servers
5218 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5219 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5220 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5222 @dfn{sending queue} means messages accumulated in the folder
5223 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5224 off-line operations when @code{elmo-enable-disconnected-operation} is
5226 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5227 @c off-line operations are enabled.
5229 They are displayed if there are any of them. In the example above, in
5230 the sending queue there are two messages (the first and the second in
5231 the queue folder) for smtp to hosta and one (the third) for nntp to
5232 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5235 If you change @samp{(wl-plugged)} in the second line, the variable
5236 @code{wl-plugged} is changed, so that the mode line indicator and
5237 plugged states of all ports are affected. If you change plugged states
5238 of any servers or ports, @samp{(wl-plugged)} in the second line is
5239 affected depending on @code{elmo-plugged-condition} settings and the
5240 plugged state of each port.
5243 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5244 @section Invoking Wanderlust in the Off-line State
5246 As described before, if you set @code{wl-plugged} to @code{nil} in
5247 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5248 off-line state. You can specify off-line state on a per server or port
5249 basis. Refer to @code{wl-reset-plugged-alist} also.
5251 Usually, when Wanderlust starts up, the plugged state of each port is
5252 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5253 @code{wl-nntp-posting-server} and so on. If you want to change the
5254 plugged state of these ports or to add other ports, configure
5255 @code{wl-make-plugged-hook} with a function.
5259 (add-hook 'wl-make-plugged-hook
5261 (elmo-set-plugged plugged-value(t/nil) server port)
5262 ;; @r{add or change plugged states of the port of the server}
5263 (elmo-set-plugged plugged-value(t/nil) server)
5264 ;; @r{if the port is omitted, all ports are affected}
5265 ;; @r{(you cannot omit the port if you newly add the server)}
5271 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5272 @section Customizable Variables
5277 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5278 mode from the beginning.
5280 @item wl-queue-folder
5281 @vindex wl-queue-folder
5282 The initial setting is @samp{+queue}.
5283 This is the folder in which messages in the transmission queue are
5286 @item wl-auto-flush-queue
5287 @vindex wl-auto-flush-queue
5288 The initial setting is @code{t}.
5289 This flag controls automatic transmission of the queue when Wanderlust
5290 becomes on-line. If non-nil, the queue is automatically transmitted
5291 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5292 manually, press @kbd{F} in the folder mode.
5294 @item elmo-enable-disconnected-operation
5295 @vindex elmo-enable-disconnected-operation
5296 The initial setting is @code{t}. Controls off-line operations
5297 regarding IMAP4. If non-nil, off-line operations are carried out.
5299 @item elmo-lost+found-folder
5300 @vindex elmo-lost+found-folder
5301 The initial setting is @samp{+lost+found}.
5302 This is the folder to which messages are saved when they fails to be
5303 appended while the off-line re-file/copy queue is processed.
5305 @item elmo-plugged-condition
5306 @vindex elmo-plugged-condition
5307 The initial setting is @code{one}.
5308 The value of @code{wl-plugged} reflects the return value of the function
5309 @code{elmo-plugged-p} (without arguments).
5310 This variable @code{elmo-plugged-condition} specifies the condition on
5311 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5312 plugged state of each port.
5315 'one : plugged if one or more ports are plugged.
5316 'all : plugged if all ports are plugged.
5317 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5318 states of the ports.
5319 @var{function} : reflects the return value of the @var{function}
5320 functions available per default
5321 'elmo-plug-on-by-servers
5322 : reflects the plugged state of the servers specified by the
5323 variable elmo-plug-on-servers.
5324 'elmo-plug-on-by-exclude-servers
5325 : reflects the plugged state of the servers that are not
5326 in elmo-plug-on-exclude-servers.
5327 elmo-plug-on-exclude-servers defaults to
5330 (system-name)without the domain part)
5336 (setq elmo-plugged-condition 'all)
5338 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5339 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5341 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5342 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5346 @item wl-reset-plugged-alist
5347 @vindex wl-reset-plugged-alist
5348 The initial setting is @code{t}. If non-nil, plugged states are
5349 initialized on a per server or port basis when Wanderlust starts up.
5351 If @code{nil}, plugged states are retained while Emacs is running. In
5352 other words, they are initialized when Emacs is restarted even if the
5353 value is @code{nil}.
5357 @node Expire and Archive, Scoring, Disconnected Operations, Top
5358 @chapter Automatic Expiration and Archiving of Messages
5359 @cindex Expire and Archive
5362 * Expire:: Expiration and Archiving
5363 * Archive:: Archiving All Messages
5367 @node Expire, Archive, Expire and Archive, Expire and Archive
5369 @cindex Expire Message
5371 Expiration means deletion of old messages which have outlasted a
5372 certain period of time.
5374 @code{wl-expire} supports not only simple deletion, but also moving to
5375 specified archiving folders.
5379 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5380 or @kbd{M-e} in the summary mode.
5382 @subsection Configuring @code{wl-expire-alist}
5384 An example configuration of @code{wl-expire-alist} is shown below.
5385 Everything in this @code{wl-expire-alist} makes a great difference in
5386 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5387 to @code{t}, especially in the initial stage.
5391 (setq wl-expire-alist
5392 '(("^\\+trash$" (date 14) remove)
5394 ("^\\+tmp$" (date 7) trash)
5395 ;; @r{re-file to @code{wl-trash-folder}}
5396 ("^\\+outbox$" (number 300) "$outbox;lha")
5397 ;; @r{re-file to the specific folder}
5399 ;; @r{do not expire}
5400 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5401 ;; @r{archive by message number (retaining numbers)}
5402 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5403 ;; @r{archive by a fixed number (retaining numbers)}
5404 ("^\\+diary$" (date 30) wl-expire-archive-date)
5405 ;; @r{archive by year and month (numbers discarded)}
5410 Items in the list has the format of:
5413 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5417 The folder is examined if it matches @var{regexp-for-folders} from the
5418 beginning of the list. If you invoke expiration on the folder that does
5419 not match any of them, nothing will happen. And if either the second or
5420 the third element of the item is @code{nil}, expiration will not take
5423 You can use any one of the following for
5424 @var{specification-of-message-to-be-deleted}:
5427 @item (number @var{n1} [@var{n2}])
5428 deletes messages depending on the number of messages in the folder.
5430 @var{n1} is the number of messages which should survive deletion, for example
5431 if its value is 500, the newest 500 messages survive and the rests are
5434 @var{n2} is the number of messages in the folder on which expiration should
5435 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5436 folders with 510 or more messages are expired.
5437 If you configured automatic expiration, frequently used folders may
5438 expire every time it receive messages, and you may be annoyed with the
5439 long delay in reading mail.
5440 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5441 expiration would not take place until a certain number of messages
5444 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5445 with important/new/unread) are not deleted.
5446 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5447 will expire so as to have 500 messages including such ones.
5448 Otherwise, it will have 500 messages except such ones.
5450 @item (date @var{d1})
5451 deletes messages depending on the dates.
5453 Messages dated @var{d1} or more days ago are deleted, for example if its
5454 value is seven, messages seven days old or more are deleted. Note that
5455 the date is the one in the @samp{Date:} field of the message, not when
5456 the message entered the folder.
5458 Messages with no or invalid @samp{Date:} field does not expire; you
5459 might have to delete them by hand.
5462 You can use any one of the following in the place of @var{destination}:
5466 deletes the messages instantly.
5469 hide the messages from summary (messages are not deleted).
5472 moves the messages to @code{wl-trash-folder}.
5474 @item @var{string}(folder)
5475 moves the messages to the folder specified with @var{string}.
5477 It would be useful for specifying an archiving folder, but because this
5478 does not move important messages, it might be better to use the
5479 standard functions described below.
5481 @item @var{function}
5482 invokes the specified @var{function}.
5484 To the @var{function}, three arguments are passed: a folder name, a list
5485 of messages to be deleted, and msgdb information of the summary. You
5486 can specify function-specific arguments after the name of the
5487 @var{function}. Note that the list contains messages with marks in
5488 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5491 These are four standard functions; three of them move messages to an archive
5492 folder in the specified way. This means old messages can be compressed
5493 and saved in a file, being deleted from the original folder.
5494 The last one divides messages to some MH folders.
5497 @item wl-expire-archive-number1
5498 re-files to archiving folders corresponding to the message numbers of
5499 the messages being deleted. For example, a message numbered 102 will be
5500 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5501 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5502 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5504 The archiving folders to which messages are re-filed are determined by
5505 the name of the folder as follows (in this case, archiving folders are
5506 handled as if @code{elmo-archive-treat-file} were non-nil).
5509 @item If the folder type is localdir:
5510 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5512 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5513 (@file{~/Mail/ml/wl-00100.zip}).
5515 @item The folder type is other than localdir:
5516 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5518 For example, @samp{%#mh/ml/wl} corresponds to
5519 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5522 As you can see, in the case of localdir, the folder type is not included
5523 in the path name, but otherwise it is included.
5524 And you can control the prefix to the archiving folder name by
5525 @code{wl-expire-archive-folder-prefix}.
5526 Refer to @code{wl-expire-archive-folder-prefix} for details.
5528 @item wl-expire-archive-number2
5529 re-files every certain number of messages to archiving folders.
5531 This differs from @samp{wl-expire-archive-number1} in that this re-files
5532 to the folder up to the specified number regardless of message numbers.
5533 The archiving folders to which messages are re-filed are determined in the
5534 same way as @code{wl-expire-archive-number1}.
5536 @item wl-expire-archive-date
5537 re-files messages depending on its date (year and month) to archive
5540 For example, a message dated December 1998 is re-filed to
5541 @code{$folder-199812;zip}. The name of the archiving folders except the
5542 date part are determined in the same way as
5543 @code{wl-expire-archive-number1}.
5546 You can set the first argument to these three standard functions to non-nil
5547 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5548 For example, it can be specified just after the name of the function:
5551 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5554 If you omit the argument, consecutive numbers from 1 are assigned for
5555 each archiving folder.
5557 @item wl-expire-localdir-date
5558 divedes messages depending on its date (year and month) to MH folders
5559 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5563 @subsection Treatment for Important or Unread Messages
5565 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5566 standard function, messages with marks in
5567 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5568 messages} thereafter) are retained.
5570 Per default, this variable include the important, new, and unread marks,
5571 so that messages with these marks are not removed.
5572 Note that you cannot include the temporary mark (i.e. temporary marks
5573 are removed anyway), and be sure to process temporary marks before you
5576 @subsection Auto Expiration
5578 The following setup invokes expiration when you move into the summary
5579 mode. There will be no confirmation, so make sure you made no mistake
5580 in regexp and other settings before you set up this.
5584 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5588 In the folder mode, you can invoke expiration per group as well as per
5589 folder. Therefore, if you specify @samp{Desktop} group, all folders
5590 matching @code{wl-expire-alist} expire.
5594 @subsection Treating archive folders.
5595 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5596 you must set non-nil value to @code{elmo-archive-treat-file}.
5598 @subsection Confirming
5600 If you are to use @code{remove}, try @code{trash} at first and see
5601 messages move to @code{wl-trash-folder} as expected, then replace it
5602 with @code{remove}. It would be dangerous to use @code{remove} from the
5605 If you are to use @code{wl-expire-archive-number1} and the like, try to
5606 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5607 you can append messages to it. Even if settings in
5608 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5609 would not be saved anywhere and disappeared in case the archiver program
5612 After you make sure you can archive to the folder correctly, you can
5613 invoke expiration and utilize the log.
5615 If you set @code{wl-expire-use-log} to @code{t},
5616 @file{~/.elmo/expired-log} should contain the log, for example:
5620 delete +ml/wl (593 594 595 596 597 598 599)
5621 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5625 The first column indicates the operation, i.e. @samp{delete},
5626 @samp{copy}, or @samp{move}. The next is the name of the folder that
5627 expired. In the case of @samp{copy} and @samp{move}, the destination
5628 folder is recorded after @samp{->}. The last is the list of message
5629 numbers that are actually deleted or moved (in the case of @samp{copy}
5630 and @samp{move}, the number is the one in the source folder, rather than
5631 the destination folder).
5633 @subsection Re-filing Reserved Messages
5635 The three standard functions copy reserved messages to the archive
5636 folder, but do not delete them from the source folder. Because
5637 reserved messages and the like always remain, they are recorded in
5638 @file{~/.elmo/expired-alist} so that they are not copied over and over
5639 again. They are not recorded if copied by @code{wl-summary-archive}.
5641 If you enabled logging, usually @samp{move} is recorded for re-filing,
5642 but instead @samp{copy} and @samp{delete} are recorded separately if
5643 reserved messages are involved. This is because it actually copies
5644 messages including reserved, then deletes ones except reserved in that
5647 @section Customizable Variables
5650 @item wl-expire-alist
5651 @vindex wl-expire-alist
5652 The initial setting is @code{nil}.
5653 This variable specifies folders and methods to expire. For details,
5654 refer to @code{wl-expire-alist} settings above.
5656 @item wl-summary-expire-reserve-marks
5657 @vindex wl-summary-expire-reserve-marks
5658 The initial setting is the list below.
5662 (list wl-summary-important-mark
5663 wl-summary-new-uncached-mark
5664 wl-summary-new-cached-mark
5665 wl-summary-unread-mark
5666 wl-summary-unread-uncached-mark
5667 wl-summary-unread-cached-mark)
5671 Messages with these marks are retained in the folder, even after
5673 Only permanent marks can be listed, not temporary marks.
5675 You can list marks one by one as in the default; you can use the
5676 following settings as well:
5680 All messages with permanent marks are retained,
5681 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5685 All messages are handled as usual ones that are already read, no matter
5686 what marks they have; even important messages are deleted.
5689 @item wl-expire-archive-files
5690 @vindex wl-expire-archive-files
5691 The initial setting is 100.
5692 This variable specifies the number of messages to be retained in one
5695 @item wl-expire-number-with-reserve-marks
5696 @vindex wl-expire-number-with-reserve-marks
5697 The initial setting is @code{nil}.
5698 If non-nil, if expiring messages are specified by @code{number},
5699 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5701 @item wl-expire-archive-get-folder-function
5702 @vindex wl-expire-archive-get-folder-function
5703 The initial setting is @code{wl-expire-archive-get-folder}.
5705 This variable specifies a function that returns the name of an archiving
5706 folder for standard functions in the place of @var{destination}.
5707 You can use the following three variables for simple modification of
5708 folder names; if you want more complex settings, define your own
5709 function in this variable.
5711 @code{wl-expire-archive-get-folder} can be customized by these
5714 @item @code{wl-expire-archive-folder-name-fmt}
5715 @item @code{wl-expire-archive-folder-type}
5716 @item @code{wl-expire-archive-folder-prefix}
5719 @item wl-expire-archive-folder-name-fmt
5720 @vindex wl-expire-archive-folder-name-fmt
5721 The initial setting is @samp{%s-%%05d;%s}.
5722 This is a @code{format} string for archiving folders used in
5723 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5724 Note that you must specify the message number by @samp{%%d}, because it
5725 is parsed twice by @code{format}.
5727 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5730 @item wl-expire-archive-date-folder-name-fmt
5731 @vindex wl-expire-archive-date-folder-name-fmt
5732 The initial setting is @samp{%s-%%04d%%02d;%s}.
5733 This is a @code{format} string for archiving folders used in
5734 @code{wl-expire-archive-date}. Note that you must specify the message
5735 number by @samp{%%d}, because it is parsed twice by @code{format}.
5736 There should be @samp{%%d} twice, one for the year and the other for the
5739 If you modify this, adjust
5740 @code{wl-expire-archive-date-folder-num-regexp} as well.
5742 @item wl-expire-archive-folder-type
5743 @vindex wl-expire-archive-folder-type
5744 The initial setting is @code{zip}.
5745 This variable specifies an archiver type of the archiving folders.
5747 @item wl-expire-archive-folder-prefix
5748 @vindex wl-expire-archive-folder-prefix
5749 The initial setting is @code{nil}.
5750 This variable specifies the prefix (directory structure) to archiving
5752 Exercise extreme caution in using this feature, as it has not been
5754 In the worst case, there is a fear of destructing archiving folders.
5758 There will be no prefix.
5761 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5762 @samp{$ml/wl-00000;zip;wl}.
5765 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5768 @samp{$ml/wl-00000;zip;ml/wl}.
5771 @item wl-expire-archive-folder-num-regexp
5772 @vindex wl-expire-archive-folder-num-regexp
5773 The initial setting is @samp{-\\([-0-9]+\\);}.
5774 This variable specifies the regular expression to be used for getting
5775 message numbers from multiple archiving folders specified by
5776 @code{elmo-list-folders}.
5777 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5779 @item wl-expire-archive-date-folder-num-regexp
5780 @vindex wl-expire-archive-date-folder-num-regexp
5781 The initial setting is @samp{-\\([-0-9]+\\);}.
5782 This is the regular expression to be used for getting message numbers
5783 from multiple archiving folders specified by @code{elmo-list-folders}.
5784 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5786 @item wl-expire-delete-oldmsg-confirm
5787 @vindex wl-expire-delete-oldmsg-confirm
5788 The initial setting is @code{t}.
5789 If non-nil, messages older than the one with the largest number will be
5790 deleted with confirmation.
5791 If @code{nil}, they are deleted without confirmation.
5793 This feature is valid only if non-nil is specified as a argument to the
5794 standard functions so as to retain numbers.
5796 @item wl-expire-use-log
5797 @vindex wl-expire-use-log
5798 The initial setting is @code{nil}.
5799 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5800 They are appended but not truncated or rotated automatically; you might
5801 need to remove it manually.
5803 @item wl-expire-add-seen-list
5804 @vindex wl-expire-add-seen-list
5805 The initial setting is @code{t}.
5807 If non-nil, when messages are re-filed by expiration, read/unread
5808 information is passed to the destination folder.
5810 However if you do not read the destination folder from Wanderlust,
5811 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5812 want to set this to @code{nil} if you are simply saving to some
5813 archiving folders. Even if its value is @code{nil}, messages in the
5814 archiving folders are simply treated as unread; it does not affect
5817 @item wl-expire-folder-update-msgdb
5818 @vindex wl-expire-folder-update-msgdb
5819 The initial setting is @code{t}.
5820 If @code{t}, in the folder mode, expiration is carried out after
5821 updating summary information. If you specified a list of regular
5822 expressions of folder names, summary information is updated for matching
5827 @node Archive, , Expire, Expire and Archive
5828 @section Archiving Messages
5830 @subsection Archiving Messages
5831 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5832 folders. If there are the archiving folders already, only new messages
5835 You can use @code{wl-archive-alist} in order to specify how messages are
5836 archived according to their folder names, as in @code{wl-expire-alist}.
5841 (setq wl-archive-alist
5842 '(("^\\+tmp$" wl-archive-date)
5843 ("^\\+outbox$" wl-archive-number2)
5844 (".*" wl-archive-number1)))
5848 Each item in the list has the following format:
5851 (@var{folders-regexp} @var{deleting-function})
5854 As you can see, you can only use a function after @var{folders-regexp}.
5855 Per default, there are three functions:
5858 @item @code{wl-archive-number1}
5859 @item @code{wl-archive-number2}
5860 @item @code{wl-archive-date}
5863 As inferred from their names, they work similarly to "expire" versions,
5864 other than the following points:
5867 @item No messages are deleted
5868 @item Message numbers are retained even if invoked without arguments
5871 These functions are good to archive all messages in a folder by their
5872 numbers or by their dates.
5873 These are also useful for backup or confirmation purposes before
5875 If you try to re-file them after they are archived, they are deleted but
5878 Per default, the archiving folders to which messages are copied are
5879 determined automatically by @code{wl-expire-archive-get-folder-function}.
5880 You can copy to a specific folder by invoking with a prefix argument,
5881 i.e. @kbd{C-u M-x wl-summary-archive}.
5883 Note that this feature has not been seriously tested, because you can
5884 simply copy to an archiving folder, for example by
5885 @code{wl-summary-copy-region}.
5887 The archiving folders are determined by the same logic as in
5888 @code{wl-summary-expire}; the following customizable variables are
5892 @item @code{wl-expire-archive-files}
5893 @item @code{wl-expire-archive-get-folder-function}
5894 @item @code{wl-expire-archive-folder-name-fmt}
5895 @item @code{wl-expire-archive-folder-type}
5896 @item @code{wl-expire-archive-folder-prefix}
5897 @item @code{wl-expire-archive-folder-num-regexp}
5900 @subsection Customizable Variables
5903 @item wl-archive-alist
5904 @vindex wl-archive-alist
5905 The initial setting is the list shown below:
5909 ((".*" wl-archive-number1))
5914 This variable specifies a function that copies to archiving folders.
5915 To the function, three arguments are passed: a folder name, a list of
5916 messages in the folder, and msgdb information of the summary.
5917 Needless to say, you can use your own function.
5921 @node Scoring, Split messages, Expire and Archive, Top
5922 @chapter Score of the Messages
5924 @c @cindex Kill File
5926 Scoring is the function that associates a score (value) with each
5927 message, and marks as read or deletes from the summary according to it.
5929 You can put target or important marks on essential messages, or read marks
5930 on the ones you do not want to read, for example spam articles.
5932 This scoring function has a capability and a format similar to the one
5933 that Gnus has, although there are some unsupported features and
5934 Wanderlust specifics.
5935 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5938 * Score Commands:: Score Commands
5939 * Score File Format:: Score File Format
5943 @node Score Commands, Score File Format, Scoring, Scoring
5944 @section Score Commands
5945 @cindex Score Commands
5947 @subsection Score File Specification
5949 @code{wl-score-folder-alist} specifies score files or variables in which
5950 scores are defined, corresponding to folder names.
5954 (setq wl-score-folder-alist
5963 If paths to the score files are omitted, the directory specified in the
5964 variable @code{wl-score-files-directory} is assumed.
5966 No matter what you write in @code{wl-score-folder-alist}, the default
5967 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5968 read (it does not have to exist).
5969 Therefore, in the example above, the three score files,
5970 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5971 the folders that matches @samp{^-.*}.
5973 @subsection Scored Messages
5975 Scores are attached to the messages that are specified by
5976 @code{wl-summary-score-marks} temporarily when the summary is updated;
5977 when you exit from the summary, the scores are removed and reverts to
5980 @subsection Creation of Score Files
5982 In the summary buffer, move to an appropriate message and type @kbd{L}.
5983 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5984 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5986 This makes @minus{}1000 are scored for messages with the same
5987 @samp{Subject:} as the string you entered. That is, such a score file
5988 is created automatically.
5990 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5991 The score file you just made appears.
5992 This buffer is called @dfn{score editing buffer} thereafter.
5993 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5994 as you are previously; type @kbd{a}. Then a score entry for "From"
5996 In this way, you can create a score file easily either in the summary
5997 buffer or in the score editing buffer.
5999 By the way, you might be aware the numbers of key strokes are different
6000 between @kbd{s s p} and @kbd{a}.
6001 This is determined by @code{wl-score-header-default-entry}.
6002 This variable specifies the default score entries corresponding to
6004 For example, for "subject" field, a type and a time limit are prompted,
6005 but for "from" field, they are fixed upon automatically as substring and
6006 permanent respectively.
6007 However, score values can be modified by the prefix argument.
6008 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
6011 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
6012 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
6013 erasing contents of the buffer deletes the score file being edited.
6017 @subsubsection Selecting Score Files
6019 You can change score files to which scores are appended by
6020 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
6021 @code{wl-score-change-score-file}.
6023 @subsubsection Summing Up the Score
6025 If you add the same entries by @code{wl-summary-increase-score},
6026 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
6027 scores for the entry is summed up.
6029 For example, if you create @samp{from} entry with the score of @minus{}1000 by
6030 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
6031 @minus{}1200 will be created as a result.
6033 @subsubsection Creating Thread Key
6035 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
6036 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6038 @subsubsection Creating Followup Key
6040 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6041 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6042 at the cursor to @samp{References} key.
6043 If @code{wl-score-auto-make-followup-entry} is non-nil,
6044 @samp{Message-ID} of all messages to be followed up within dates
6045 specified by @code{wl-score-expiry-days}.
6047 @subsection Key Bindings
6052 @findex wl-summary-increase-score
6053 Increases the score for the current message.
6054 And the score entry is appended to the score file at the same moment.
6055 You can specify the score value by a prefix argument.
6059 @findex wl-summary-lower-score
6060 Decreases the score for the current message.
6061 And the score entry is appended to the score file at the same moment.
6062 You can specify the score value by a prefix argument.
6065 @kindex h R (Summary)
6066 @findex wl-summary-rescore
6067 Re-applies the scoring.
6068 However, already scored messages are not scored anew.
6071 @kindex h c (Summary)
6072 @findex wl-score-change-score-file
6073 Changes the score file currently selected.
6076 @kindex h e (Summary)
6077 @findex wl-score-edit-current-scores
6078 Edits the score file currently selected.
6079 If there are multiple score files, the previously specified one is
6083 @kindex h f (Summary)
6084 @findex wl-score-edit-file
6085 Edits an arbitrary score file and selects it.
6088 @kindex h F (Summary)
6089 @findex wl-score-flush-cache
6090 Erases caches associated to the score files that are read.
6091 If you modified score files directly (from other than Wanderlust), you
6092 need to re-read them after erasing the cache.
6095 @kindex h m (Summary)
6096 @findex wl-score-set-mark-below
6097 Specifies the criterion for scores to be marked as read.
6098 Messages with scores less than this value are marked as read.
6101 @kindex h x (Summary)
6102 @findex wl-score-set-expunge-below
6103 Specifies the criterion for scores to be deleted from the summary.
6104 Messages with scores less than this value are deleted.
6105 "Deleted" means it is not shown; they are not removed from the summary
6106 information or the folder.
6107 The deleted messages can be shown by rescan-noscore again.
6110 @subsection Key Bindings in the Score Editing Buffer
6114 @kindex C-c C-k (Score Mode)
6115 @findex wl-score-edit-kill
6116 Abandons the file being edited.
6119 @kindex C-c C-c (Score Mode)
6120 @findex wl-score-edit-exit
6121 Saves the file being edited, and quits from the edit mode.
6124 @kindex C-c C-p (Score Mode)
6125 @findex wl-score-pretty-print
6129 @kindex C-c C-d (Score Mode)
6130 @findex wl-score-edit-insert-date
6131 Inserts the number of dates from Dec. 31, 1 B.C.
6132 It is used for creating the third factor of time-limited scores.
6135 @kindex C-c C-s (Score Mode)
6136 @findex wl-score-edit-insert-header
6137 Inserts the header of the message selected in the summary buffer.
6140 @kindex C-c C-e (Score Mode)
6141 @findex wl-score-edit-insert-entry
6142 Inserts the score entry of the message selected in the summary buffer.
6145 @subsection Customizable Variables
6148 @item wl-summary-default-score
6149 @vindex wl-summary-default-score
6150 The initial setting is 0 (zero).
6151 This variable specifies the default value of the score.
6152 The score is increased or decreased based upon this value.
6154 @item wl-summary-important-above
6155 @vindex wl-summary-important-above
6156 The initial setting is @code{nil}.
6157 Messages with scores larger than this value are attached with the
6158 important mark (@samp{$}).
6159 If @code{nil}, no important marks are attached.
6161 @item wl-summary-target-above
6162 @vindex wl-summary-target-above
6163 The initial setting is @code{nil}.
6164 Messages with scores larger than this value are attached with the target
6166 If @code{nil}, no target marks are attached.
6168 @item wl-summary-mark-below
6169 @vindex wl-summary-mark-below
6170 The initial setting is 0 (zero).
6171 Messages with scores smaller than this value are marked as read.
6173 @item wl-summary-expunge-below
6174 @vindex wl-summary-expunge-below
6175 The initial setting is @code{nil}.
6176 Messages with scores smaller than this value are deleted from the
6178 If @code{nil}, they are not deleted.
6180 @item wl-summary-score-marks
6181 @vindex wl-summary-score-marks
6182 The initial setting is the list shown below:
6186 (list wl-summary-new-uncached-mark
6187 wl-summary-new-cached-mark)
6192 Messages with these marks are scored.
6194 @item wl-use-scoring
6195 @vindex wl-use-scoring
6196 The initial setting is t.
6197 If non-nil, scoring is enabled.
6199 @item wl-score-files-directory
6200 @vindex wl-score-files-directory
6201 The initial setting is @file{~/.elmo/}.
6202 The default directory for score files.
6204 @item wl-score-interactive-default-score
6205 @vindex wl-score-interactive-default-score
6206 The initial setting is 1000.
6207 This value is used as a score when a score factor is @code{nil} in the
6208 score file. It is also used in @code{wl-summary-increase-score} and
6209 @code{wl-summary-lower-score}, on condition that the value of
6210 @code{wl-score-header-default-entry} is @code{nil}.
6212 @item wl-score-expiry-days
6213 @vindex wl-score-expiry-days
6214 The initial setting is 7.
6215 This is the number of days before time-limited scores are deleted.
6217 @item wl-score-update-entry-dates
6218 @vindex wl-score-update-entry-dates
6219 The initial setting is @code{t}.
6220 If non-nil, it enables deletion of time-limited scores.
6222 @item wl-score-header-default-entry
6223 @vindex wl-score-header-default-entry
6224 Specifies the default value for each header field for score entries
6225 created by @code{wl-summary-increase-score},
6226 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6228 @item wl-score-simplify-fuzzy-regexp
6229 @vindex wl-score-simplify-fuzzy-regexp
6230 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6231 regular expression to be deleted from the string.
6232 Because this is usually used for Subject, the default is prefixes that
6233 are attached by mailing list programs.
6235 @item wl-summary-rescore-partial-threshold
6236 @vindex wl-summary-rescore-partial-threshold
6237 The initial setting is 200.
6238 When sync-all or rescan is executed, if there are messages more than
6239 this value, only the last same number of messages as this value are
6242 @item wl-summary-auto-sync-marks
6243 @vindex wl-summary-auto-sync-marks
6244 If non-nil, unread/important marks are synchronized when the summary
6246 Unread marks reflect information on the IMAP4 server.
6247 Important marks reflect information on the IMAP4 server (flagged or
6248 not), and contents of @samp{'mark} folder.
6249 The initial setting is @code{t}.
6253 @node Score File Format, , Score Commands, Scoring
6254 @section Score File Format
6255 @cindex Score File Format
6257 The format of score files are the same as Gnus, and basically you can
6258 use Gnus score files as they are. But they are not fully compatible
6259 because some keys are not supported and there are Wanderlust specifics.
6260 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6265 ("for sale" -1000 nil s)
6266 ("profit" -1000 nil s))
6268 ("spam@@spamspamspam" -10000 nil s))
6270 ("my@@address" 3001 nil s))
6272 (1000000 -10 nil >))
6282 If the key is a string, it is the name of the header to be matched.
6283 The following keys are available:
6284 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6285 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6286 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6287 @code{Chars} and @code{Lines} mean the size and the number of lines of
6288 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6289 are described later.
6290 The rest corresponds the field of the same name.
6292 Arbitrary numbers of core entries are specified after the key.
6293 Each score entry consists of these five factors:
6297 A factor that matches header. This should be a number in the cases of
6298 @code{lines} and @code{chars}, otherwise a string.
6301 A score factor. When the first item matches, the score of the message
6302 is increased or decreased by this value.
6305 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6306 of a number, the score is deleted if it does not match for days
6307 (@code{wl-score-expiry-days}) from the date specified by this.
6308 The date is since Dec. 31, 1 B.C.
6311 A type factor. This specifies the way the first factor matches.
6312 Available types depend on keys.
6315 @item From, Subject, References, Message-ID
6316 For these keys in string, @code{r} and @code{R} (regexp),
6317 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6318 as well as @code{f} and @code{F} (fuzzy) can be used.
6319 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6322 For these keys, the following five numerical relative operators can be
6323 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6326 This key matches @code{From} header, and scores all follow-ups to the
6328 For example, it would be useful for increasing scores for follow-ups to
6331 You can use the same types as @code{From} except for @code{f}.
6332 And a @samp{Followup} entry is automatically appended to the score file.
6335 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6336 A @samp{Thread} entry is automatically appended for each article that
6337 has @var{x} in the @code{References} header.
6338 You can make sure the whole thread including messages that does not have
6339 all ancestors @code{Message-ID} in @code{References} is scored.
6341 You can use the same types as @code{References} except for @code{f}.
6342 And a @samp{Thread} entry is automatically appended to the score file.
6346 A factor for extension header. This is meaningful only if the key is
6348 This specifies headers to be matched other than standard headers like
6349 @code{Subject} and @code{From}.
6350 Note that you should specify the header in
6351 @code{elmo-msgdb-extra-fields} also.
6352 Therefore it does not work in folders where extension headers cannot be
6357 The sum of these scores @emph{after all factors are applied} becomes the
6358 score of the message.
6360 @cindex Score File Atoms
6362 Messages with a score less than this value is marked as read.
6363 The default is @code{wl-summary-mark-below}.
6366 Messages with a score less than this value is deleted from the summary.
6367 The default is @code{wl-summary-expunge-below}.
6369 @item mark-and-expunge
6370 Both @code{mark} and @code{expunge} are applied,
6371 i.e. messages with a score less than this value is marked as read and
6372 deleted from the summary.
6375 Messages with a score greater than this value is attached with temp
6377 The default is @code{wl-summary-target-above}.
6380 Messages with a score greater than this value is attached with important
6382 The default is @code{wl-summary-important-above}.
6387 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6388 are used, you need to set @code{elmo-msgdb-extra-fields}.
6391 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6394 There are other restrictions as shown below:
6397 @item Because @samp{References} field in the summary information
6398 contains only the last @samp{Message-ID}, @code{references} key matches
6402 Keys that can be seen by folder of types:
6406 chars lines xref extra
6407 localdir,localnews Y E E E
6408 nntp (supporting xover) Y E E N
6414 N: cannot be seen (ignored)
6415 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6420 @node Split messages, Address Book, Scoring, Top
6421 @chapter Message splitting
6422 @cindex Split messages
6424 You can use @code{elmo-split} to split message in folder specified by
6425 the variable @code{elmo-split-folder} a la @command{procmail} according
6426 to some specified rules. To use this feature, set as follows in your
6427 @file{~/.emacs} at first.
6430 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
6433 Set source folder like following.
6436 (setq elmo-split-folder "%inbox")
6439 And specify the rule in the variable @code{elmo-split-rule} (its format
6440 will be is described below).
6441 Then you can invoke @kbd{M-x elmo-split} to split messages according to
6442 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
6443 to do a rehearsal and show result (do not split actually).
6446 We will describe how to specify the rule. First of all, see following
6451 (setq elmo-split-rule
6452 ;; @r{Store messages from spammers into @samp{+junk}}
6453 '(((or (address-equal from "i.am@@spammer")
6454 (address-equal from "dull-work@@dull-boy")
6455 (address-equal from "death-march@@software")
6456 (address-equal from "ares@@aon.at")
6457 (address-equal from "get-money@@richman"))
6459 ;; @r{Store messages from mule mailing list into @samp{%mule}}
6460 ((equal x-ml-name "mule") "%mule")
6461 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
6462 ;; @r{and continue evaluating following rules}
6463 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
6464 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
6465 ((match from "\\(.*\\)@@yahoo\\.com")
6467 ;; @r{Store unmatched mails into @samp{+inbox}}
6472 The basic unit of the rule is a combination like
6475 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
6478 If @samp{CONDITION} is true, @samp{ACTION} is performed.
6479 The 1st element @samp{CONDITION} is a condition represented by a
6480 balanced expression (sexp). Its grammar will be explained below.
6481 The 2nd element @samp{ACTION} is the name of the folder to split
6482 messages into, or a symbol. When the 3rd element @code{continue} is
6483 specified as symbol, evaluating rules is not stopped even when the
6484 condition is satisfied.
6486 The grammar for @samp{CONDITION} is as follows. See example above to
6487 learn how to write the condition practically.
6491 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
6492 (@samp{FIELD-NAME} is a symbol that describes the field name)
6496 True if the field value equals to @samp{VALUE}.
6497 Case of the letters are ignored.
6499 True if the field value matches to VALUE.
6500 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6501 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6502 @item @code{address-equal}
6503 True if one of the addresses in the field equals to
6504 @samp{VALUE}. Case of the letters are ignored.
6505 @item @code{address-match}
6506 True if one of the addresses in the field matches to
6508 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6509 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6513 Functions which accept an integer argument (@samp{SIZE}).
6517 True if the size of the message is less than @samp{SIZE}.
6519 True if the size of the message is greater than @samp{SIZE}.
6523 Functions which accept any number of arguments.
6527 True if one of the argument returns true.
6529 True if all of the arguments return true.
6535 When a symbol is specified, it is evaluated.
6538 You can specify followings as 2nd @samp{ACTION}.
6544 If some string is specified, it will be regarded as the destination
6545 folder, and the message will be appended to it.
6550 If the symbol @samp{delete} is specified, delete the substance of the
6551 message in @code{elmo-split-folder}
6556 If the symbol @samp{noop} is specified, do nothing on the message and
6562 If some function is specified, execute it.
6565 If the message passes all rules, it will be dealed along @samp{ACTION}
6566 specified by @code{elmo-split-default-action}.
6569 @node Address Book, Spam Filter, Split messages, Top
6570 @chapter Address Book
6571 @cindex Address Book
6573 With address book, you can utilize address completion, and you have
6574 summary displayed with nicknames.
6577 * Mail Addresses:: Definition of Address Book
6578 * Address Manager:: Address Manager
6582 @node Mail Addresses, Address Manager, Address Book, Address Book
6583 @section Address book
6584 @cindex Address book Definition
6586 @cindex Alias, Address
6588 The file @file{~/.addresses} is a simple address book for Wanderlust.
6589 Make address file @file{~/.addresses}, and edit to suit your requirement.
6591 The data written in @file{~/.addresses} are used for address completion
6592 under draft editing mode. Furthermore, they are used when showing names
6593 in summary display mode. You can safely skip this section, if you don't
6594 want to customize address completion and summary display.
6595 It is possible to add/change/remove addresses from @file{~/.addresses} in
6596 summary buffer after Wanderlust is invoked. @refill
6598 The format is very simple. Like this. @refill
6603 # @r{Lines begin with @samp{#} are comment.}
6604 # @r{Empty lines are ignored}
6606 # @r{Format of each line:}
6607 # @var{email-address} "@var{nickname} "@var{realname}"
6609 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6610 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6611 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6616 One line defines one persons description.
6618 Actually, in default setup, @var{nickname} is used in summary-mode and
6619 @var{realname} is used in draft preparation mode. This behavior is
6620 better understood if you try it and confirmed the function first. You
6621 can write and try a small definition, so you will know the idea of the
6622 address book before writing a big one.
6624 And, if MH alias file is specified in variable @code{wl-alias-file},
6625 it is used as an address information in the draft preparation mode.
6627 If variable @code{wl-use-ldap} is non-nil (initial setting is
6628 @code{nil}), address completion in draft mode uses LDAP information.
6630 If you use LDAP, you have to set @code{wl-ldap-server},
6631 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6632 not have LDAP feature as built-in feature (Currently only XEmacs can
6633 have built-in LDAP feature), you have to set command exec @env{PATH} to
6634 the program @command{ldapsearch}.
6637 @node Address Manager, , Mail Addresses, Address Book
6638 @section Address Manager
6639 @cindex Address Manager
6641 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6642 the address book and insert address to draft buffer.
6644 @subsection Key Bindings
6648 @kindex t (Address Manager)
6649 @findex wl-addrmgr-set-to
6650 Add @samp{To:} mark.
6653 @kindex c (Address Manager)
6654 @findex wl-addrmgr-set-cc
6655 Add @samp{Cc:} mark.
6658 @kindex b (Address Manager)
6659 @findex wl-addrmgr-set-bcc
6660 Add @samp{Bcc:} mark.
6663 @kindex u (Address Manager)
6664 @findex wl-addrmgr-unmark
6668 @kindex x (Address Manager)
6669 @findex wl-addrmgr-apply
6671 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6672 buffer and quit address manager. When no draft buffer, make new draft
6673 with insert marked addresses.
6675 If no mark, quit address manager.
6679 @kindex q (Address Manager)
6680 @findex wl-addrmgr-quit
6681 Quit address manager.
6684 @kindex a (Address Manager)
6685 @findex wl-addrmgr-add
6689 @kindex d (Address Manager)
6690 @findex wl-addrmgr-delete
6694 @kindex e (Address Manager)
6695 @findex wl-addrmgr-edit
6700 @node Spam Filter, Customization, Address Book, Top
6701 @chapter Spam Filter
6704 @code{wl-spam} provides an frontend to external spam filtering programs.
6705 You can register to or judge spam by the filtering program cooperateing
6706 with messages operations on Wanderlust.
6709 * Usage of Spam Filter:: Usage of Spam Filter
6710 * Spam Filter Processors:: Supported spam filters
6713 @node Usage of Spam Filter, Spam Filter Processors, Spam Filter, Spam Filter
6714 @section Usage of Spam Filter
6716 @subsection Initial Setting
6718 To use @code{wl-spam}, write in @file{~/.wl} as follows:
6722 ;; @r{Use @samp{bogofilter} as spam back end}
6723 ;; @r{Set @samp{scheme} here as the spam filter you will use.}
6724 ;; @r{@xref{Spam Filter Processor}}
6725 (setq elmo-spam-scheme 'bogofilter)
6730 @subsection spam mark
6732 The spam mark (@samp{s}) will be provided as new temporary mark.
6733 Messages marked by this will be refiled into @code{wl-spam-folder} when
6734 the action is called for execution. Marked messages will be skipped by
6735 summary walking in ordinary way.
6737 The spam mark is be put on by spam judgement described later, or by
6738 invoking @kbd{k m} at any time.
6740 @subsection spam judgment
6742 You can judge spam messages by following ways:
6746 Make judgement on execution of auto-refile.
6748 Insert @code{wl-refile-guess-by-spam} to arbitrary position in
6749 @code{wl-auto-refile-guess-functions} as follows.
6753 (setq wl-auto-refile-guess-functions
6754 '(wl-refile-guess-by-rule
6755 wl-refile-guess-by-spam))
6759 In this example, judge spam if it could not decide refile destination by
6760 @code{wl-refile-rule-alist}.
6763 Make judgement on entering the summary of specified folder.
6765 Specify the value of @code{wl-spam-auto-check-folder-regexp-list}
6766 as the list of regular expressions for folder names to be
6767 automatically judged by spam filter.
6770 (setq wl-spam-auto-check-folder-regexp-list '("\\+inbox"))
6773 In this example, judgement will be processed when you enter summary of
6774 the folder whose name contains @samp{+inbox}.
6777 Make judgement on splitting messages with @code{elmo-split}.
6779 It provides new function @code{spam-p} to be specified as @samp{CONDITION}
6780 in @code{elmo-split-rule}. This function returns true when the message
6782 @xref{Split messages}
6784 You can also process learning by the result of judgement. (You would
6785 better turn on this feature after learning to some extent)
6791 (setq elmo-split-rule
6792 '(((spam-p) "+spam")
6793 ;; @r{to learn by the judgement, use following instead}
6794 ;((spam-p :register t) "+spam")
6800 @subsection spam learning
6802 @code{wl-spam} automatically learn spam with refiling messages.
6804 At first, @code{wl-spam} classifies the folders controlled by Wanderlust
6805 into following 4 domains by the class of containig messages
6809 Folders containing messages judged as spam.
6810 (The folder specified by @code{wl-spam-folder})
6812 Folders containing messages judged as non-spam.
6814 Folders containing messages not yet judged. Folders without
6815 pre-distribution may belong to this domain e.g. @samp{+inbox}.
6816 (specified by @code{wl-spam-undecided-folder-regexp-list})
6818 Foldes have nothing to do with spam processing e.g.
6819 @code{wl-trash-folder} or @code{wl-draft-folder}. (specified by
6820 @code{wl-spam-ignored-folder-regexp-list})
6823 When you refile messages across different domains, it automatically
6824 learn messages as @samp{spam} or @samp{non-spam} according to domains
6825 it belongs before and after.
6827 To put it concretely, it will learn by following rule:
6830 @item undecide -> spam
6833 learn as spam and cancel previous study as non-spam.
6834 @item undecide -> good
6837 learn as non-spam and cancel previous study as spam.
6840 It do not learn anything in other cases.
6842 @subsection Key Bindings
6843 @cindex Keybind, spam filter
6847 @kindex k m (Summary)
6848 @findex wl-summary-spam
6849 Put spam mark (@samp{s}) on current message.
6852 @kindex k c (Summary)
6853 @findex wl-summary-test-spam
6854 Test current message and put spam mark if judged as spam.
6857 @kindex k C (Summary)
6858 @findex wl-summary-mark-spam
6859 Test messages with the mark in @code{wl-spam-auto-check-marks},
6860 and put spam mark if judged as spam. If it is called with prefix
6861 argument, test all messages regardless of their marks.
6864 @kindex k s (Summary)
6865 @findex wl-summary-register-as-spam
6866 Register current message as spam.
6869 @kindex k S (Summary)
6870 @findex wl-summary-register-as-spam-all
6871 Register all messages in the folder as spam.
6874 @kindex k n (Summary)
6875 @findex wl-summary-register-as-good
6876 Register current message as non-spam.
6879 @kindex k N (Summary)
6880 @findex wl-summary-register-as-good-all
6881 Register all messages in the folder as non-spam.
6884 @kindex m k (Summary)
6885 @findex wl-summary-target-mark-spam
6886 Put spam mark (@samp{s}) on messages with the target mark @samp{*}.
6889 @kindex m s (Summary)
6890 @findex wl-summary-target-mark-register-as-spam
6891 Register messages with the target mark @samp{*} as spam.
6894 @kindex m n (Summary)
6895 @findex wl-summary-target-mark-register-as-good
6896 Register messages with the target mark @samp{*} as non-spam.
6899 @subsection Customizable Variables
6902 @item wl-spam-folder
6903 @vindex wl-spam-folder
6904 Specify the name of destination folder for the spam messages.
6905 The initial setting is @samp{+spam}.
6907 @item wl-spam-undecided-folder-regexp-list
6908 @vindex wl-spam-undecided-folder-regexp-list
6909 Specify the list of regexp of folder names which contain messages
6910 not yet decided as spam or non-spam.
6911 The initial setting is @code{'("inbox")}.
6913 @item wl-spam-ignored-folder-regexp-list
6914 @vindex wl-spam-ignored-folder-regexp-list
6915 The initial setting is as follows.
6919 (list (regexp-opt (list wl-draft-folder
6925 Folders of no effect against spam judgement, specified by the list of
6926 folder name regular expressions.
6928 @item wl-spam-auto-check-folder-regexp-list
6929 @vindex wl-spam-auto-check-folder-regexp-list
6930 Folders to make spam judgement on entering the summary of them,
6931 specified by the list of folder name regular expressions.
6932 The initial setting is @code{nil}.
6934 @item wl-spam-auto-check-marks
6935 @vindex wl-spam-auto-check-marks
6936 The initial setting is the following list:
6940 (list wl-summary-new-uncached-mark
6941 wl-summary-new-cached-mark)
6945 Messages with mark specified by this variable will be processed
6946 by whole-folder judgement including auto test by
6947 @code{wl-spam-auto-check-folder-regexp-list}.
6948 Persistent marks can be used in this method, but temporary marks cannot.
6950 You can specify the list of marks as the initial setting, or you can
6951 specify follwing symbol:
6955 Process all messages regardless of persistent marks.
6960 @node Spam Filter Processors, , Usage of Spam Filter, Spam Filter
6961 @section Supported Spam Filters
6962 @cindex Spam Filter, Bogofilter
6963 @cindex Spam Filter, Spamfilter
6965 Supported spam filtering libraries are following ones.
6968 * bogofilter:: bogofilter
6969 * spamfilter:: spamfilter.el
6970 * bsfilter:: bsfilter
6971 * SpamAssassin:: SpamAssassin
6972 * Regular Expressions Header Matching:: Header regexp
6976 @node bogofilter, spamfilter, Spam Filter Processors, Spam Filter Processors
6977 @subsection bogofilter
6980 bogofilter (@uref{http://bogofilter.sourceforge.net/}) is a spam filter
6981 implemented by C language.
6983 To use spam filter with bogofilter, write following setting in
6984 @file{~/.wl} or somewhere else.
6988 (setq elmo-spam-scheme 'bogofilter)
6992 @subsubsection Customizable Variables
6995 @item elmo-spam-bogofilter-program
6996 @vindex elmo-spam-bogofilter-program
6997 The initial setting is @file{bogofilter}.
6998 Specify the name of executable of bogofilter. If the executable
6999 is not in your environmental variable @env{PATH}, you should
7000 set this by full path.
7002 @item elmo-spam-bogofilter-args
7003 @vindex elmo-spam-bogofilter-args
7004 The initial setting is @code{nil}.
7005 Specify arguments to be supplied for bogofilter executable.
7007 @item elmo-spam-bogofilter-database-directory
7008 @vindex elmo-spam-bogofilter-database-directory
7009 Specify the directory for statistical database to be used.
7010 @code{nil} to use default directory (@file{~/.bogofilter}).
7011 The initial setting is @code{nil}.
7013 @item elmo-spam-bogofilter-max-messages-per-process
7014 @vindex elmo-spam-bogofilter-max-messages-per-process
7015 The initial setting is 30. This variable specifies the number of
7016 messages to be learned by one process.
7018 @item elmo-spam-bogofilter-debug
7019 @vindex elmo-spam-bogofilter-debug
7020 The initial setting is @code{nil}.
7021 If you specify non-nil, the output from @command{bogofilter} is
7022 stored in the buffer named @code{"*Debug ELMO SPAM Bogofilter*"}.
7026 @node spamfilter, bsfilter, bogofilter, Spam Filter Processors
7027 @subsection spamfilter.el
7030 @file{spamfilter.el}
7031 (@uref{http://www.geocities.co.jp/SiliconValley-PaloAlto/7043/}) is a
7032 spam filtering library implemented by Emacs Lisp.
7034 Corresponding modules will be compiled/installed, if you have
7035 @file{spamfilter.el} within @code{load-path} when you are to install wl.
7038 To use @file{spamfilter.el}, write following setting in @file{~/.wl} or
7040 (Of cource, you have to have settings for @file{spamfilter.el} itself)
7044 (setq elmo-spam-scheme 'spamfilter)
7048 @subsubsection Customizable Variables
7051 @item elmo-spam-spamfilter-corpus-filename
7052 @vindex elmo-spam-spamfilter-corpus-filename
7053 The initial setting is @file{~/.elmo/.spamfilter}.
7054 It specifies the name of corpus file.
7057 @node bsfilter, SpamAssassin, spamfilter, Spam Filter Processors
7058 @subsection bsfilter
7061 bsfilter (@uref{http://bsfilter.org/index-e.html}) is a spam filter
7062 implemented by Ruby language.
7064 To use spam filter with bsfilter, write following setting in
7065 @file{~/.wl} or somewhere else.
7069 (setq elmo-spam-scheme 'bsfilter)
7073 @subsubsection Customizable Variables
7076 @item elmo-spam-bsfilter-program
7077 @vindex elmo-spam-bsfilter-program
7078 The initial setting is @file{bsfilter}.
7079 Specify the name of executable of @command{bsfilter}. If the executable
7080 is not in your environmental variable @env{PATH}, you should
7081 set this by full path.
7083 @item elmo-spam-bsfilter-args
7084 @vindex elmo-spam-bsfilter-args
7085 The initial setting is @code{nil}.
7086 Specify arguments to be supplied for bsfilter executable.
7088 @item elmo-spam-bsfilter-database-directory
7089 @vindex elmo-spam-bsfilter-database-directory
7090 Specify the directory for statistical database to be used.
7091 @code{nil} to use default directory (@file{~/.bsfilter}).
7092 The initial setting is @code{nil}.
7094 @item elmo-spam-bsfilter-debug
7095 @vindex elmo-spam-bsfilter-debug
7096 The initial setting is @code{nil}.
7097 If you specify non-nil, the output from @command{bsfilter} is
7098 stored in the buffer named @code{"*Debug ELMO Bsfilter*"}.
7100 @item elmo-spam-bsfilter-shell-program
7101 @vindex elmo-spam-bsfilter-shell-program
7102 The initial setting is @file{ruby}.
7103 Specify the shell to execute @command{bsfilter}. If the shell is not
7104 in your environmental variable @env{PATH}, you should set this by full path.
7106 @item elmo-spam-bsfilter-shell-switch
7107 @vindex elmo-spam-bsfilter-shell-switch
7108 The initial setting is @code{nil}.
7109 Specify options to give to the shell executing @command{bsfilter}.
7111 @item elmo-spam-bsfilter-update-switch
7112 @vindex elmo-spam-bsfilter-update-switch
7113 The initial setting is @code{"--synchronous-auto-update"}.
7114 Specify options to give to @command{bsfilter} for learning messages.
7118 @node SpamAssassin, Regular Expressions Header Matching, bsfilter, Spam Filter Processors
7119 @subsection SpamAssassin
7120 @cindex SpamAssassin
7122 SpamAssassin (@uref{http://spamassassin.org/}) is one of the most
7123 popular spam filtering program implemented on Perl. SpamAssassin
7124 attempts to identify spam using text analysis and several internet-based
7125 realtime blacklists. SpamAssassin also uses a Bayesian learning filter
7126 which enables more accurate spam filtering.
7128 To use @file{SpamAssassin} on Wanderlust, write following setting
7129 in @file{~/.wl} or somewhere else.
7130 (Of course, you have to install SpamAssassin beforehand.)
7134 (setq elmo-spam-scheme 'sa)
7138 @subsubsection Customize Variables
7141 @item elmo-spam-spamassassin-program
7142 @vindex elmo-spam-spamassassin-program
7143 The initial setting is @file{spamassassin}.
7144 Specify the name of executable @command{spamassassin}. If the executable
7145 is not in your environmental variable @env{PATH}, you should
7146 set this by full path.
7148 @item elmo-spam-spamassassin-learn-program
7149 @vindex elmo-spam-spamassassin-learn-program
7150 The initial setting is @file{sa-learn}.
7151 Specify the name of the SpamAssassin's Bayesian filtering learner
7152 program, @command{sa-learn}. If the executable is not in your
7153 environmental variable @env{PATH}, you should set this by full path.
7155 @item elmo-spam-spamassassin-program-arguments
7156 @vindex elmo-spam-spamassassin-program-arguments
7157 The initial setting is @code{'("-e")}.
7158 Specify the arguments to be supplied for @command{spamassassin} executable.
7159 You have to specify the argument to exit the program with an error exit code
7160 when the result is spam. For example, if you want to use @command{spamc}
7161 instead of @command{spamassassin}, you should specify @code{'("-c")}.
7163 @item elmo-spam-spamassassin-learn-program-arguments
7164 @vindex elmo-spam-spamassassin-lern-program-arguments
7165 The initial setting is @code{nil}.
7166 Specify the arguments to be supplied for @command{sa-learn}.
7168 @item elmo-spamassassin-debug
7169 @vindex elmo-spamassassin-debug
7170 The initial setting is @code{nil}.
7171 If you specify @code{t}, the output from @command{spamassassin} is
7172 stored in the buffer named @code{"*Debug ELMO SpamAssassin*"}.
7176 @node Regular Expressions Header Matching, , SpamAssassin, Spam Filter Processors
7177 @subsection Regular Expressions Header Matching
7178 @cindex Regular Expressions Header Matching
7180 Examine if regular expression matches corresponding field in message heaeder,
7181 and decide spam or not. To use this backend, add following setting to @file{~/.wl}.
7185 (setq elmo-spam-scheme 'header)
7189 If you want to check fields not included in the default overview
7190 information, add one into @code{elmo-msgdb-extra-fields}. Then it will
7191 do examination by the overview information and avoid loading whole
7192 message body as far as possible.
7194 @subsubsection Customize Variables
7197 @item elmo-spam-header-good-alist
7198 @vindex elmo-spam-header-good-alist
7199 The initial setting is the following list:
7202 '(("X-Spam-Flag" . "No"))
7205 Specify a list of regular expressions to match with header field name
7206 for making non-spam decision. It takes precedence over
7207 @code{elmo-spam-header-spam-alist}.
7209 @item elmo-spam-header-spam-alist
7210 @vindex elmo-spam-header-spam-alist
7211 The initial setting is the following list:
7214 '(("X-Spam-Flag" . "Yes"))
7217 Specify a list of regular expressions to match with header field name
7218 for making spam decision.
7222 @node Customization, Terminology, Spam Filter, Top
7223 @chapter Customizing Wanderlust
7224 @cindex Customization
7227 * Living with other packages:: Cooperating with other packages
7228 * Highlights:: Highlights
7229 * Biff:: Notify Mail arrival
7230 * Advanced Settings:: Advanced Settings
7231 * Customizable Variables:: Customizable Variables
7236 @node Living with other packages, Highlights, Customization, Customization
7237 @section Living with other packages
7239 Examples with other packages.
7242 * imput:: imput (im-wl.el)
7243 * BBDB:: The Insidious Big Brother Database
7244 * LSDB:: The Lovely Sister Database
7245 * supercite:: supercite.el
7246 * mu-cite:: mu-cite.el
7247 * X-Face:: x-face,bitmap-mule
7248 * dired-dd:: dired-dd.el
7250 * Addrbook:: Addrbook
7251 * mime-w3m:: mime-w3m.el
7255 @node imput, BBDB, Living with other packages, Living with other packages
7260 Place @file{util/im-wl.el} on the @code{load-path} and do the following
7265 (autoload 'wl-draft-send-with-imput-async "im-wl")
7266 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
7271 @node BBDB, LSDB, imput, Living with other packages
7275 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
7276 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
7277 and do the following settings.
7279 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
7280 byte-compiled and installed.
7288 ;; @r{enable pop-ups}
7289 (setq bbdb-use-pop-up t)
7290 ;; @r{auto collection}
7291 (setq bbdb/mail-auto-create-p t)
7292 ;; @r{exceptional folders against auto collection}
7293 (setq bbdb-wl-ignore-folder-regexp "^@@")
7294 (setq signature-use-bbdb t)
7295 (setq bbdb-north-american-phone-numbers-p nil)
7296 ;; @r{shows the name of bbdb in the summary} :-)
7297 (setq wl-summary-from-function 'bbdb-wl-from-func)
7298 ;; @r{automatically add mailing list fields}
7299 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
7300 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
7304 You can complete address with BBDB by @kbd{M-@key{TAB}}
7308 @node LSDB, supercite, BBDB, Living with other packages
7312 The following is an example setting to use
7313 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
7320 (add-hook 'wl-draft-mode-hook
7322 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
7326 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
7327 (complete address with LSDB).
7330 @node supercite, mu-cite, LSDB, Living with other packages
7331 @subsection sc.el(supercite), sc-register.el
7335 The same setting as usual mailers should be OK. The following is an
7336 example of settings:
7340 (autoload 'sc-cite-original "supercite" nil t)
7341 (add-hook 'mail-citation-hook 'sc-cite-original)
7346 @node mu-cite, X-Face, supercite, Living with other packages
7347 @subsection mu-cite.el
7350 The same setting as usual mailers should be OK. The following is an
7351 example of settings.
7353 If you use mu-cite version 8.0 or earlier:
7357 (autoload 'mu-cite/cite-original "mu-cite" nil t)
7358 (setq mail-citation-hook 'mu-cite/cite-original)
7362 If you use mu-cite version 8.1 or later:
7366 (autoload 'mu-cite-original "mu-cite" nil t)
7367 (add-hook 'mail-citation-hook (function mu-cite-original))
7371 @node X-Face, dired-dd, mu-cite, Living with other packages
7375 If you have installed one of the following, you can decode
7376 @samp{X-Face:} field in message buffer and you will see face image.
7379 * x-face-xmas:: XEmacs case
7380 * x-face-mule:: Emacs case
7383 If there is an encoded X-Face string in a file @file{~/.xface} (the
7384 value of the variable @code{wl-x-face-file}), it is inserted as a
7385 @samp{X-Face:} field in the draft buffer (if
7386 @code{wl-auto-insert-x-face} is non-nil).
7388 @node x-face-xmas, x-face-mule, X-Face, X-Face
7389 @subsubsection x-face-xmas (for XEmacs)
7392 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
7393 1.3.6.13 or later, do the following:
7397 (autoload 'x-face-xmas-wl-display-x-face "x-face")
7398 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
7402 @node x-face-mule, , x-face-xmas, X-Face
7403 @subsubsection x-face-mule (for Emacs)
7407 If you use @file{x-face-mule.el} in bitmap-mule
7408 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
7412 (autoload 'x-face-decode-message-header "x-face-mule")
7413 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7417 @subsubsection x-face-e21 (for Emacs 21.x)
7420 With Emacs 21.x, you can use @file{x-face-e21.el}
7421 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
7422 to display X-Face. In this case, bitmap-mule is not required.
7427 (autoload 'x-face-decode-message-header "x-face-e21")
7428 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7433 @node dired-dd, MHC, X-Face, Living with other packages
7434 @subsection dired-dd(Dired-DragDrop)
7435 @pindex Dired-DragDrop
7437 @cindex Drag and Drop
7439 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
7440 compose multi-part by simple Drag-and-Drop from dired to the draft
7441 buffer being edited in GNU Emacs (this feature is not Wanderlust
7442 specific, but general-purpose for SEMI).
7446 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
7452 ;; @r{Set dired-x variables here.}
7453 ;; @r{To and flo@dots{}}
7455 (progn (require 'dired-dd)
7456 (require 'dired-dd-mime))))))
7460 @node MHC, Addrbook, dired-dd, Living with other packages
7464 Message Harmonized Calendaring system
7465 (@uref{http://www.quickhack.net/mhc/})
7467 By using MHC, you can make a calendar from the messages.
7473 (setq mhc-mailer-package 'wl)
7474 (autoload 'mhc-mode "mhc" nil t)
7475 (add-hook 'wl-summary-mode-hook 'mhc-mode)
7476 (add-hook 'wl-folder-mode-hook 'mhc-mode)
7484 (autoload 'mhc-wl-setup "mhc-wl")
7485 (add-hook 'wl-init-hook 'mhc-wl-setup)
7489 @node Addrbook, mime-w3m, MHC, Living with other packages
7490 @subsection wl-addrbook.el
7494 (@uref{http://www.mew.org/})
7496 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
7497 @code{load-path} and do the following settings.
7501 (require 'wl-addrbook)
7506 @node mime-w3m, , Addrbook, Living with other packages
7507 @subsection mime-w3m.el
7510 You can display html part by using @file{mime-w3m.el}
7511 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
7512 You can find the usage in comment region at the head of @file{mime-w3m.el}.
7515 @node Highlights, Biff, Living with other packages, Customization
7518 @subsection Customizable Variables
7521 @item wl-summary-highlight
7522 @vindex wl-summary-highlight
7523 The initial setting is @code{t}.
7524 If non-nil, the summary is highlighted.
7526 @item wl-highlight-max-summary-lines
7527 @vindex wl-highlight-max-summary-lines
7528 The initial setting is 10000.
7529 The summary is not highlighted if it has more lines than this value.
7531 @item wl-summary-highlight-partial-threshold
7532 @vindex wl-summary-highlight-partial-threshold
7533 The initial setting is 1000.
7534 This is a threshold whether the whole summary is highlighted.
7535 If there are more lines of messages in the summary, it is partially
7538 @item wl-summary-partial-highlight-above-lines
7539 @vindex wl-summary-partial-highlight-above-lines
7540 The initial setting is 30. If there are more lines of messages than
7541 @code{wl-summary-highlight-partial-threshold} in the summary, messages
7542 after the point that is the same number of lines as this value above the
7543 cursor line are highlighted partially. (If this value is @code{nil},
7544 the last same number of lines as the value of
7545 @code{wl-summary-highlight-partial-threshold} are highlighted.)
7547 @item wl-highlight-body-too
7548 @vindex wl-highlight-body-too
7549 The initial setting is @code{t}.
7550 If non-nil, bodies of drafts and messages are also highlighted.
7552 @item wl-highlight-message-header-alist
7553 @vindex wl-highlight-message-header-alist
7554 When highlighting headers of drafts and messages, this variable
7555 specifies which faces are allocated to important
7556 (@code{wl-highlight-message-important-header-contents}), secondly
7557 important (@code{wl-highlight-message-important-header-contents2}), and
7558 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7560 Similarly, it can be used for allocating arbitrary faces to arbitrary
7561 regular expressions.
7563 @item wl-highlight-citation-prefix-regexp
7564 @vindex wl-highlight-citation-prefix-regexp
7565 Specifies a regular expression to which quoted lines in bodies of
7566 drafts and messages match.
7567 Bodies matching to this regular expression are highlighted by the faces
7568 specified by (@code{wl-highlight-message-cited-text-*}).
7570 @item wl-highlight-highlight-citation-too
7571 @vindex wl-highlight-highlight-citation-too
7572 The initial setting is @code{nil}.
7573 If non-nil, the quoting regular expression itself given by
7574 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7576 @item wl-highlight-citation-header-regexp
7577 @vindex wl-highlight-citation-header-regexp
7578 Specifies a regular expression that denotes beginning of quotation.
7579 Bodies matching to this regular expression are highlighted by the face
7580 specified by @code{wl-highlight-message-headers}.
7582 @item wl-highlight-max-header-size
7583 @vindex wl-highlight-max-header-size
7584 The initial setting is @code{nil}. If a header size is larger than this
7585 value, it will not be highlighted. If @code{nil}, always highlighted
7586 (ignore header size).
7588 @item wl-highlight-max-message-size
7589 @vindex wl-highlight-max-message-size
7590 The initial setting is 10000.
7591 If a message is larger than this value, it will not be highlighted.
7592 With this variable, highlight is suppressed for uuencode or huge digest
7595 @item wl-highlight-signature-separator
7596 @vindex wl-highlight-signature-separator
7597 Specifies regular expressions that denotes the boundary of a signature.
7598 It can be a regular expression, or a list of ones.
7599 Messages after the place that matches this regular expression are
7600 highlighted by the face specified by
7601 @code{wl-highlight-message-signature}.
7603 @item wl-max-signature-size
7604 @vindex wl-max-signature-size
7605 The initial setting is 400.
7606 This is the largest size for a signature to be highlighted.
7608 @item wl-use-highlight-mouse-line
7609 @vindex wl-use-highlight-mouse-line
7610 The initial setting is @code{t}.
7611 If non-nil, the line pointed by the mouse is highlighted in the folder
7612 mode, summary mode, and the like.
7615 @subsection Setting Colors and Fonts of the Characters
7617 If you want to change colors or fonts of the characters, you need to
7618 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7619 want to change fonts, and @code{set-face-foreground} for colors, and so
7620 on. You cannot write face settings in @file{.emacs}; write in
7623 For example, if you want to change the color for signatures to yellow,
7627 (set-face-foreground 'wl-highlight-message-signature "yellow")
7633 Faces defined in Wanderlust:
7636 @item wl-highlight-message-headers
7637 The face for field names of message headers.
7639 @item wl-highlight-message-header-contents
7640 The face for field bodies of message headers.
7642 @item wl-highlight-message-important-header-contents
7643 The face for important parts of message headers.
7644 Per default, this face is used for a body of @samp{Subject:} field.
7645 You can change its value by editing
7646 @code{wl-highlight-message-header-alist}.
7648 @item wl-highlight-message-important-header-contents2
7649 The face for secondly important parts of message headers.
7650 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7651 fields. You can change its value by editing
7652 @code{wl-highlight-message-header-alist}.
7654 @item wl-highlight-message-unimportant-header-contents
7655 The face for unimportant parts of message headers.
7656 Per default, this face is used for bodies of @samp{X-} fields
7657 @samp{User-Agent:} fields. You can change its value by editing
7658 @code{wl-highlight-message-header-alist}.
7660 @item wl-highlight-message-citation-header
7661 The face for headers of quoted messages.
7663 @item wl-highlight-message-cited-text-*
7664 The face for texts of quoted messages. The last @samp{*} is a
7665 @var{single figure} so that 10 different colors can be used according to
7668 @item wl-highlight-message-signature
7669 The face for signatures of messages. The initial settings are
7670 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7671 dark background colors.
7673 @item wl-highlight-header-separator-face
7674 The face for header separators of draft messages.
7676 @item wl-highlight-summary-important-face
7677 The face for message lines with important marks in the summary.
7679 @item wl-highlight-summary-new-face
7680 The face for message lines with new marks in the summary.
7682 @item wl-highlight-summary-displaying-face
7683 The face for the message line that is currently displayed.
7684 This face is overlaid.
7686 @item wl-highlight-thread-indent-face
7687 The face for the threads that is currently displayed.
7689 @item wl-highlight-summary-unread-face
7690 The face for message lines with unread marks in the summary.
7692 @item wl-highlight-summary-deleted-face
7693 The face for message lines with delete marks in the summary.
7695 @item wl-highlight-summary-refiled-face
7696 The face for message lines with re-file marks in the summary.
7698 @item wl-highlight-refile-destination-face
7699 The face for re-file information part of message lines with re-file
7700 marks in the summary.
7702 @item wl-highlight-summary-copied-face
7703 The face for message lines with copy marks in the summary.
7705 @item wl-highlight-summary-target-face
7706 The face for message lines with target marks @samp{*} in the summary.
7708 @item wl-highlight-summary-thread-top-face
7709 The face for message lines that are on the top of the thread in the
7712 @item wl-highlight-summary-normal-face
7713 The face for message lines that are not on top of the thread in the
7716 @item wl-highlight-folder-unknown-face
7717 The face for folders that are not known to have how many unsync messages
7720 @item wl-highlight-folder-zero-face
7721 The face for folders that have no unsync messages in the folder mode.
7723 @item wl-highlight-folder-few-face
7724 The face for folders that have some unsync messages in the folder mode.
7726 @item wl-highlight-folder-many-face
7727 The face for folders that have many unsync messages in the folder mode.
7728 The boundary between `some' and `many' is specified by the variable
7729 @code{wl-folder-many-unsync-threshold}.
7731 @item wl-highlight-folder-unread-face
7732 The face for folders that have no unsync but unread messages in the
7735 @item wl-highlight-folder-killed-face
7736 The face for folders that are deleted from the access group in the
7739 @item wl-highlight-folder-opened-face
7740 The face for open groups in the folder mode.
7741 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7742 @code{nil} or a @var{number}.
7744 @item wl-highlight-folder-closed-face
7745 The face for close groups in the folder mode.
7746 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7747 @code{nil} or a @var{number}.
7749 @item wl-highlight-folder-path-face
7750 The face for the path to the currently selected folder in the folder
7753 @item wl-highlight-logo-face
7754 The face for logo in the demo.
7756 @item wl-highlight-demo-face
7757 The face for strings (for example, a version number) in the demo.
7761 @node Biff, Advanced Settings, Highlights, Customization
7762 @section Notify Mail arrival
7765 Following setting is to notify mail arrival of @samp{%inbox}
7766 by the indicator on the modeline
7769 (setq wl-biff-check-folder-list '("%inbox"))
7772 @subsection Customizable Variables
7774 @item wl-biff-check-folder-list
7775 @vindex wl-biff-check-folder-list
7776 The initial setting is @code{nil}.
7777 This is the list of folders to check mail arrival.
7778 If @code{nil}, wl doesn't check mail arrival.
7780 @item wl-biff-check-interval
7781 @vindex wl-biff-check-interval
7782 The initial setting is 40 (in seconds).
7783 Check mail arrival in this period.
7785 @item wl-biff-notify-hook
7786 @vindex wl-biff-notify-hook
7787 This hook is run at the arrival of new mail.
7788 To beep with mail arrival(initial setting), set as follows.
7790 (setq wl-biff-notify-hook '(ding))
7792 For silence, set to @code{nil}.
7796 @node Advanced Settings, Customizable Variables, Biff, Customization
7797 @section Advanced Settings
7800 * Draft for Reply:: Draft for Reply
7801 * Thread Format:: Appearance of Thread
7802 * User-Agent Field:: @samp{User-Agent:} Header Field
7806 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
7807 @subsection Draft for Replay
7808 @vindex wl-draft-reply-with-argument-list
7809 @vindex wl-draft-reply-without-argument-list
7810 @vindex wl-draft-reply-myself-with-argument-list
7811 @vindex wl-draft-reply-myself-without-argument-list
7813 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
7814 The addressee for the draft is decided by following rules.
7816 For example, you can set as follows:
7820 (setq wl-draft-reply-without-argument-list
7821 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7822 ("Followup-To" . (nil nil ("Followup-To")))
7823 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7824 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
7828 Where each element of the list @code{wl-draft-reply-without-argument-list}
7832 (key . (to-list cc-list newsgroup-list))
7835 and if the field designated by @samp{key} exist in the parent message,
7836 parent's field values designated by @samp{to-list} are copied to @samp{To:}
7837 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
7838 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
7839 the draft respectively.
7844 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7847 Match if the parent has @samp{Mail-Followup-To} field.
7848 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
7849 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
7853 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7856 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
7857 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
7860 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
7863 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
7864 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
7867 These are evaluated in order and first matched one is used.
7869 Moreover, the behavior of @kbd{a} with prefix argument can
7870 be directed by @code{wl-draft-reply-with-argument-list} as well.
7872 By the way, you can use some function (will be evaluated in the parent
7873 message buffer) in the place of @samp{key} or @samp{to-list} etc.
7874 For example, if you only want to reply to mailing lists in
7875 @code{wl-subscribed-mailing-list} if the parent has some of them,
7880 (defun wl-mailing-list-addresses ()
7884 (nth 1 (std11-extract-address-components addr)))
7887 (elmo-multiple-fields-body-list (list "To" "Cc"))
7889 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
7890 (setq list-addrs (cons to list-addrs))))
7891 (nreverse list-addrs)))
7893 (setq wl-draft-reply-with-argument-list
7894 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
7895 ("Reply-To" . (("Reply-To") nil nil))
7896 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
7897 ("From" . (("From") nil nil))))
7902 Note: To set the behavior when you reply to the message written by yourself,
7903 use @code{wl-draft-reply-myself-without-argument-list} and
7904 @code{wl-draft-reply-myself-with-argument-list} instead of them.
7906 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
7907 @subsection Appearance of Threads
7911 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
7912 390 09/18(Fri)07:25 +-[ Tsumura-san ]
7913 391 09/18(Fri)19:24 +-[ Murata-san ]
7914 392 09/20(Sun)21:49 +-[ Okunishi-san ]
7915 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
7916 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
7917 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
7918 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
7919 412 09/22(Tue)09:28 | +-[ Teranishi ]
7920 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
7921 416 09/22(Tue)12:38 | +-[ Teranishi ]
7922 395 09/20(Sun)21:49 +-[ Okunishi-san ]
7923 397 09/21(Mon)00:15 +-[ Okunishi-san ]
7927 Settings to make appearance of threads like shown above:
7931 (setq wl-thread-indent-level 2)
7932 (setq wl-thread-have-younger-brother-str "+")
7933 (setq wl-thread-youngest-child-str "+")
7934 (setq wl-thread-vertical-str "|")
7935 (setq wl-thread-horizontal-str "-")
7936 (setq wl-thread-space-str " ")
7940 If you do not want to see branches, do the following:
7944 (setq wl-thread-indent-level 2)
7945 (setq wl-thread-have-younger-brother-str " ")
7946 (setq wl-thread-youngest-child-str " ")
7947 (setq wl-thread-vertical-str " ")
7948 (setq wl-thread-horizontal-str " ")
7949 (setq wl-thread-space-str " ")
7954 @node User-Agent Field, , Thread Format, Advanced Settings
7955 @subsection User-Agent Field
7959 If you are eccentric enough to elaborate @samp{X-Mailer:} or
7960 @samp{User-Agent:} fields, define a function that generate appropriate
7961 strings as you like, and set it to variable
7962 @code{wl-generate-mailer-string-function}.
7964 If you do not want verbose @samp{User-Agent:} field, do the following:
7968 (setq wl-generate-mailer-string-function
7969 'wl-generate-user-agent-string-1)
7973 The following is a example:
7977 (setq wl-generate-mailer-string-function nil)
7978 (setq wl-draft-additional-header-alist
7980 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
7985 @node Customizable Variables, Hooks, Advanced Settings, Customization
7986 @section Customizable Variables
7988 Customizable variables that have not been described yet:
7991 @item wl-default-folder
7992 @vindex wl-default-folder
7993 The initial setting is @samp{%inbox}. This is the default value for moving to
7994 a folder and the like.
7996 @item wl-draft-folder
7997 @vindex wl-draft-folder
7998 The initial setting is @samp{+draft}. It is the folder to which drafts are
7999 saved. It must be a localdir folder.
8001 @item wl-trash-folder
8002 @vindex wl-trash-folder
8003 The initial setting is @samp{+trash}. It is the wastebasket folder.
8004 If you changed this variable, you had better restart Wanderlust.
8006 @item wl-interactive-exit
8007 @vindex wl-interactive-exit
8008 The initial setting is @code{t}.
8009 If non-nil, you are asked for confirmation when Wanderlust terminates.
8011 @item wl-interactive-send
8012 @vindex wl-interactive-send
8013 The initial setting is @code{t}.
8014 If non-nil, you are asked for confirmation when mail is sent.
8016 @item wl-default-sync-range
8017 @vindex wl-default-sync-range
8018 The initial setting is @samp{update}.
8019 Default update range of the summary. You can specify
8020 @samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
8021 See description of @code{wl-summary-sync} for the meaning of ranges.
8023 @item wl-folder-sync-range-alist
8024 @vindex wl-folder-sync-range-alist
8025 The initial setting is the alist shown below:
8030 ("^\\+draft$\\|^\\+queue$" . "all"))
8035 This is an associative list of regular expressions of folder names and
8036 update range of the summary. Update range is one of the @samp{all},
8037 @samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
8038 match any of them, the value of @code{wl-default-sync-range} is used
8039 (@samp{update} by default).
8040 See description of @code{wl-summary-sync} for the meaning of ranges.
8043 @vindex wl-ask-range
8044 The initial setting is @code{t}.
8045 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
8046 for updating the summary when you changed folders.
8048 @item wl-mime-charset
8049 @vindex wl-mime-charset
8050 The initial setting is @code{x-ctext}.
8051 This is the MIME charset for messages that are not MIME (e.g. without
8052 @samp{Content-Type:}). This value also used as default charset for
8053 summary. (If you want to share Summary on Nemacs and other Emacsen, set
8054 this value as @code{iso-2022-jp}.)
8056 @item wl-highlight-folder-with-icon
8057 @vindex wl-highlight-folder-with-icon
8058 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
8059 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
8061 @item wl-strict-diff-folders
8062 @vindex wl-strict-diff-folders
8063 This is a list of regular expressions of folders.
8064 Unread messages are checked, for example when you press @kbd{s} in
8065 the folder mode, usually in a brief way (rapidly processed but not
8067 The folders matching this variable are seriously checked.
8068 You may want to set this variable so as to match conditional filter
8069 folders for IMAP4 folders.
8070 The initial setting is @code{nil}.
8072 @item wl-folder-use-server-diff
8073 @vindex wl-folder-use-server-diff
8074 When unread messages are checked, for example when you press @kbd{s} in
8075 the folder mode, usually (the number of messages on the server) @minus{}
8076 (the number of local messages) will be the number of unread messages.
8077 However, if this variable is non-nil, the number of unread messages on
8078 the server is checked. This affects IMAP4 folders only, but IMAP4
8079 folders in mail boxes matching
8080 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
8081 the number of unread messages on the server, even if they matches this
8082 variable. The initial setting is @code{t}.
8084 @item wl-auto-check-folder-name
8085 @vindex wl-auto-check-folder-name
8086 The initial setting is @code{nil}.
8087 You can specify a folder or a group which is checked for unread message
8088 at the start. You can also specify a list of folders (groups) to be checked.
8089 If the value is @code{nil}, whole Desktop is checked at the start.
8090 If it is @code{none}, no folders are checked.
8092 @item wl-auto-uncheck-folder-list
8093 @vindex wl-auto-uncheck-folder-list
8094 The initial setting is the list shown below:
8103 You can set a list of regular expressions to specify folders
8104 which are not automatically checked even if they are included
8105 in some groups assigned by @code{wl-auto-check-folder-name}.
8107 @item wl-auto-check-folder-list
8108 @vindex wl-auto-check-folder-list
8109 The initial setting is @code{nil}.
8110 You can set a list of regular expressions to specify exceptions
8111 for @code{wl-auto-uncheck-folder-list}.
8113 @item wl-no-save-folder-list
8114 @vindex wl-no-save-folder-list
8115 The initial setting is the list shown below:
8124 This is a list of regular expressions of folders not to be saved.
8126 @item wl-save-folder-list
8127 @vindex wl-save-folder-list
8128 The initial setting is @code{nil}.
8129 This is a list of regular expressions of folders to be saved.
8130 This takes precedence over @code{wl-no-save-folder-list}.
8132 @item wl-folder-mime-charset-alist
8133 @vindex wl-folder-mime-charset-alist
8134 The initial setting is the alist shown below:
8138 (("^-alt\\.chinese" . big5)
8139 ("^-relcom\\." . koi8-r)
8141 ("^-han\\." . euc-kr))
8146 This is an associative list of regular expressions of folder names and
8148 If a folder do not match, @code{wl-mime-charset} is used.
8150 @item wl-folder-init-load-access-folders
8151 @vindex wl-folder-init-load-access-folders
8152 The initial setting is @code{nil}.
8153 This is a list of access groups to be loaded specifically at the start.
8154 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
8156 @item wl-folder-init-no-load-access-folders
8157 @vindex wl-folder-init-no-load-access-folders
8158 The initial setting is @code{nil}.
8159 This is a list of access groups not to be loaded specifically at the
8161 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
8163 @item wl-delete-folder-alist
8164 @vindex wl-delete-folder-alist
8165 The initial setting is the alist shown below:
8174 This list determines disposition of messages with delete marks.
8175 Each item in the list is a folder and destination; you can specify any
8176 one of the following in the place of destination:
8179 @code{remove} or @code{null} : deletes the messages instantly.
8180 string : moves the messages to the specific folder.
8181 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
8184 @item wl-x-face-file
8185 @vindex wl-x-face-file
8186 The initial setting is @file{~/.xface}.
8187 The name of the file that contains encoded X-Face strings.
8190 @item wl-demo-display-logo
8191 @vindex wl-demo-display-logo
8192 If non-nil, bitmap image is shown on the opening demo. If you set
8193 @code{xpm} or @code{xbm}, (if possible) display selected image type
8196 @item elmo-use-database
8197 @vindex elmo-use-database
8198 This is meaningful for XEmacs only. The initial setting depends on
8199 XEmacs (@code{t} for XEmacs with dbm).
8200 If non-nil, Message-ID is controlled by dbm.
8202 @item elmo-passwd-alist-file-name
8203 @vindex elmo-passwd-alist-file-name
8204 The initial setting is @file{passwd}.
8205 This is the name of the file in which passwords are saved.
8206 @code{elmo-passwd-alist-save} saves current passwords to the file.
8208 @item elmo-nntp-list-folders-use-cache
8209 @vindex elmo-nntp-list-folders-use-cache
8210 The initial setting is 600 (in seconds).
8211 This is period in seconds during which results of @samp{list} and
8212 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
8215 @item elmo-nntp-max-number-precedes-list-active
8216 @vindex elmo-nntp-max-number-precedes-list-active
8217 The initial setting is @code{nil}.
8218 If non-nil, the number of article obtained by @samp{list active} in NNTP
8219 are used as the maximum article number of the folder.
8220 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
8221 and if the number of read messages is not correct.
8223 @item elmo-nntp-default-use-listgroup
8224 @vindex elmo-nntp-default-use-listgroup
8225 The initial setting is @code{t}.
8226 If non-nil, @samp{listgroup} is used for checking the total number of
8227 articles. If it is @code{nil}, @samp{group} is used. In the latter
8228 case, the processing will be a little faster at the sacrifice of
8231 @item elmo-pop3-send-command-synchronously
8232 @vindex elmo-pop3-send-command-synchronously
8233 The initial setting is @code{nil}.
8234 If non-nil, POP3 commands are issued synchronously. Some implementation
8235 of POP3 server fails to get summary information without this setting.
8236 You may have to set this variable to @code{t}, if the process hangs
8237 while looking up POP3.
8239 @item elmo-dop-flush-confirm
8240 @vindex elmo-dop-flush-confirm
8241 The initial setting is @code{t}.
8242 If non-nil, you are asked for confirmation if accumulated off-line
8243 operations are executed.
8245 @item elmo-display-progress-threshold
8246 @vindex elmo-display-progress-threshold
8247 The initial setting is 20.
8248 Threshold for display of progress gauge. If number of renewal is more than
8249 this value, display progress gauge.
8253 @node Hooks, , Customizable Variables, Customization
8258 @node Terminology, Mailing List, Customization, Top
8259 @chapter Terminology around Wanderlust
8262 Here we explain terminologies used in this manual.
8266 A container in which messages are stored.
8269 A set consists of some folders.
8272 A special group consists of automatically collected folders under
8273 some specified path.
8274 @xref{Folder Definition}.
8276 @item summary buffer
8277 A buffer for displaying list of messages in some folder.
8279 @item sticky summary
8280 Compared with ordinary summary buffer which will be destroyed after
8281 exiting from it, this type of summary will be remain even after exiting
8282 by @kbd{q} or @kbd{g}.
8283 @xref{Sticky Summary}.
8286 To delete or put into the archive expired messages.
8293 To cache messages beforehand in order to read messages after you will be
8294 disconnected from the server.
8298 @node Mailing List, Addition, Terminology, Top
8299 @chapter Wanderlust Mailing List
8303 Topics related to Wanderlust are discussed in following mailing lists.
8304 The latest version is also announced there.
8307 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
8310 In this list Japanese is mainly used for discussion. We also have a list
8311 for discussion in English:
8314 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
8316 (Messages posted to this list are also forwarded to the former one.)
8318 A guide can be obtained automatically by sending mail to
8319 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
8320 the English one) with the body
8326 Please send bug reports or patches to one of those lists. You can post to
8327 the mailing list even though you are not a member of it.
8329 If you send a bug report, please attach Backtrace with it.
8330 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
8333 I would like to express my thanks to the members of the mailing list for
8334 valuable advice and many pieces of code they contributed.
8337 @node Addition, Index, Mailing List, Top
8338 @chapter Additional Information
8340 @section Brief History
8343 1998 3/05 Tried to make a prototype that displays MH messages in threads.
8344 3/10 Made a msgdb mechanism by elisp.
8345 3/26 IMAP and NNTP can be displayed in threads.
8346 4/13 Began to assemble thread display modules as elmo.
8347 5/01 Finished 0.1.0, initial version with many defects.
8348 6/12 I made a slip of the tongue and said I was writing elisp
8349 mailer supporting IMAP
8350 6/16 0.1.3 was announced at tm-ja, elisp ML.
8351 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
8352 7/01 Support for mm-backend (0.3.0).
8353 8/25 multi folder added (0.5.0).
8354 8/28 filter folder added (0.5.1).
8355 9/10 You can open/close threads (0.6.0).
8356 9/11 fldmgr by Murata-san made editing folders easy.
8357 9/18 lha folders added by Okunishi-san (0.6.3).
8358 9/24 Display of branches of threads (0.6.5).
8359 9/28 Compression folder supporting multiple archivers by Okunishi-san.
8360 10/28 Off-line operations (0.7.4).
8361 12/09 Becomes beta version.
8362 12/21 wl-expire by Murata-san.
8363 1999 2/03 auto-refile by Tsumura-san.
8364 4/28 wl-template by Murata-san.
8365 5/18 Released 1.0.0 stable.
8366 7/05 Scoring by Murata-san (2.1.0).
8367 9/26 New plugged system by Murata-san (2.2.2).
8368 12/20 Support Modified UTF7.
8369 2000 3/24 Released 1.1.0 stable.
8370 4/03 CVS development started.
8371 5/07 Thread restoration & Its speed up with Murata-san.
8372 6/12 Address completion with LDAP with Chiba-san & Goto-san.
8373 7/11 killed message feature.
8374 7/18 Use UIDL in POP3.
8375 9/12 biff feature with Satata-san & Yamaoka-san.
8376 10/17 expire-hide by Okada-san.
8377 11/08 Released 2.4.0 stable.
8378 2001 7/04 Released 2.6.0 stable.
8379 8/21 wl-addrmgr by Kitamoto-san.
8380 12/27 Released 2.8.1 stable.
8381 2002 12/11 Released 2.10.0 stable.
8384 See @file{ChangeLog} for details.
8388 According to a dictionary, Wanderlust has the meaning:
8392 n eager longing for or impulse towards travelling in distant lands
8393 [Ger, fr wandern to wander + lust desire, pleasure]
8397 but I had no profound intention. (if farfetched, IMAP @result{} you can
8398 read mail anywhere @result{} desire to wander ?)
8400 Elmo is the abbreviation of @samp{Elisp Library for Message
8401 Orchestration}. At first I meant the red puppet in the Sesame Street,
8402 but you may associate it with Wandering @result{} Drifting @result{}
8403 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
8407 Each versions has code names (they are almost jokes).
8408 Currently they are picked up alphabetically from the top 40 hits of
8409 U.S. Billboard magazines in 1980s.
8411 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
8414 @node Index, , Addition, Top
8418 * Concept Index:: Concept Index
8419 * Key Index:: Key Index
8420 * Variable Index:: Variable Index
8421 * Function Index:: Function Index
8424 @node Concept Index, Key Index, Index, Index
8425 @unnumberedsec Concept Index
8428 @node Key Index, Variable Index, Concept Index, Index
8429 @unnumberedsec Key Index
8432 @node Variable Index, Function Index, Key Index, Index
8433 @unnumberedsec Variable Index
8436 @node Function Index, , Variable Index, Index
8437 @unnumberedsec Function Index