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 * Batch Processing:: Invoke commands in batch mode
125 * Customization:: Customizing Wanderlust
126 * Migration:: Switch from older version of Wanderlust
127 * Terminology:: Terminologies
128 * Mailing List:: Wanderlust mailing list
129 * Addition:: Additional Information
134 @node Introduction, Start Me Up, Top, Top
135 @chapter Introduction of Wanderlust
138 Wanderlust is an mail/news management system on Emacsen.
139 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
141 The main features of Wanderlust:
144 @item Pure elisp implementation.
145 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
146 @item Unified access method to messages based on Mew-like Folder Specification.
147 @item Mew-like Key-bind and mark handling.
148 @item Manages unread messages.
149 @item Interactive thread display.
150 @item Folder Mode shows the list of subscribed folders.
151 @item Message Cache, Disconnected Operation.
152 @item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed).
153 @item MIME compliant (by SEMI).
154 @item Transmission of news and mail are unified by Message transmitting draft.
155 @item Graphical list of folders (XEmacs and Emacs 21).
156 @item View a part of message without retrieving the whole message (IMAP4).
157 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
158 @item Virtual Folders.
159 @item Supports compressed folder using common archiving utilities.
160 @item Old articles in folders are automatically removed/archived (Expiration).
161 @item Automatic re-file.
162 @item Template function makes it convenient to send fixed form messages.
168 We confirm Wanderlust works on following Emacsen:
171 @item Mule 2.3 based on Emacs 19.34
172 @item Emacs 20.2 or later
173 @item XEmacs 20.4 or later
174 @item Meadow 1.00 or later
175 @item NTEmacs 20.4 or later
179 IMAP4 connectivity with following imapd are confirmed to work with
183 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
184 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
185 @item Courier-IMAP 1.3.2 or later
186 @item AIR MAIL (AIRC imapd release 2.00)
188 @item Microsoft Exchange Server 5.5
189 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
192 LDAP connectivity with following LDAPd are confirmed to work with
196 @item OpenLDAP 2.0.6 or later
200 @node Start Me Up, Folders, Introduction, Top
201 @chapter Start up Wanderlust
204 The necessary procedure for starting Wanderlust is explained in steps
207 (Of course, you need a mail/news readable environment in advance)
210 * MIME Modules:: Installing the MIME modules
211 * Download:: Download and extract the packages
212 * Install:: Byte-compile and install
213 * Minimal Settings:: @file{.emacs} setup
214 * Folder Definition:: Folder definition
215 * Start Wanderlust:: Starting Wanderlust
216 * Overview:: Basic components of Wanderlust
220 @node MIME Modules, Download, Start Me Up, Start Me Up
221 @section Installing MIME modules
227 You must install SEMI beforehand to use Wanderlust.
229 SEMI can be downloaded from following site:
233 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
237 You need packages named APEL and FLIM to use SEMI.
238 You can download APEL and FLIM from following URLs:
242 APEL: ftp://ftp.m17n.org/pub/mule/apel/
243 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
247 You have to install APEL, FLIM and SEMI in this order. Generally,
248 @samp{make install} will do the job. (In XEmacs 21, @samp{make
251 Refer to the documents of each package for detailed installation
252 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
253 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
257 Recommended combination of APEL, FLIM and SEMI are following:
260 @item APEL 10.6, FLIM 1.14.6 and SEMI 1.14.6
263 You can also use many other FLIM/SEMI variants. Combination of the
264 latest versions should work. For example, the following combination are
268 @item APEL 10.6, SLIM 1.14.9, SEMI 1.14.5
269 @item APEL 10.6, CLIME 1.14.5, EMIKO 1.14.1
272 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
275 @node Download, Install, MIME Modules, Start Me Up
276 @section Download and Extract the Package
279 You can download Wanderlust package from following sites:
283 ftp://ftp.gohome.org/wl/
286 Mirrored ftp/http sites:
290 @c ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
291 http://www.jpl.org/elips/wl/
292 http://www.ring.gr.jp/archives/text/elisp/wl/
293 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
297 Extract the obtained package to your working directory:
302 % tar zxvf wl-@var{version}.tar.gz
303 % cd wl-@var{version}
307 @subsection To use SSL (Secure Socket Layer)
312 SSL (Secure Socket Layer) can be used for
313 SMTP, IMAP, NNTP and POP connections in Wanderlust.
315 There are two ways to use SSL. One is to start SSL negotiation just
316 after the connection establishment (generic way). The other one is to
317 start SSL negotiation by invoking STARTTLS command in the each session.
319 To use the formal SSL (generic SSL), you must set @env{PATH} to the
320 directory that OpenSSL commands are installed.
322 To use the latter SSL(STARTTLS), you must install starttls package in
324 You can download starttls package from the following site.
327 ftp://opaopa.org/pub/elisp/
330 @node Install, Minimal Settings, Download, Start Me Up
331 @section Byte-compile and install
338 @subsection Installation
340 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
341 Set the Emacs's command name to @code{EMACS}.
342 Set package installation directory to @code{LISPDIR}.
343 Then, please execute following commands.
352 Destination directory is auto-probed if you leave @code{LISPDIR}
353 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
355 If you are using an Emacs variant which does not merge specified directory
356 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
357 then you will see the error message:
360 Cannot open load file: mime-setup
364 In this case, either add destination directories of custom, APEL, FLIM
365 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
366 @code{load-path} in @file{WL-CFG} in extracted directory.
368 If you want to handle shimbun folders or to use BBDB, add directory
369 where emacs-w3m or BBDB is installed to @code{load-path}. Then necessary
370 modules will be byte-compiled and installed.
371 @xref{Shimbun Folder}, @xref{BBDB}.
373 @subsection @file{WL-CFG}
375 Contents of the file @file{WL-CFG} is loaded under installation if a file
376 with that name exists in extracted directory. You can use @file{WL-CFG} to
377 configure @code{load-path} to extra packages such as SEMI if needed.
379 If you want to specify the install directory of Wanderlust related
380 files, then set following variables in @file{WL-CFG}
384 A directory to install WL modules.
385 This directory is relative directory from @code{LISPDIR}.
386 WL modules include @file{wl*.el}, @file{wl*.elc} files.
387 @c Modules under the directory @file{util/} are also installed if
388 @c it detected as necessary.
391 A directory to install ELMO modules.
392 This directory is relative directory from @code{LISPDIR}.
393 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
394 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
398 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
400 If you want to install ELMO related files under a sub-directory
401 such as "elmo" then add following to @file{WL-CFG}:
404 (setq ELMO_PREFIX "elmo")
407 @subsection Install as a XEmacs package
408 @cindex XEmacs package
409 @cindex XEmacs package install
410 @cindex Package, XEmacs
411 @cindex Package install, XEmacs
412 @c @cindex install-package
414 It is possible to install Wanderlust as one of packages of XEmacs (21.0
415 or later). Configuration for autoload and icon-path in local
416 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
419 Follow the next example to install Wanderlust as an XEmacs package.
425 % make install-package
429 package directory is auto-probed, if SEMI is installed.
430 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
432 @subsection Run in place
434 If wl and elmo directories are defined in @code{load-path}, then
435 byte-compilation and installation are not necessary to start Wanderlust.
436 For example, if package is extracted in @file{~/work}, Wanderlust can be
437 invoked with following setting in @file{~/.emacs}.
441 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
442 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
448 Manual is described in Info format. Please do following.
457 If you install Wanderlust as a XEmacs package, Info file is already
458 installed too, so there are no need of these commands.
460 Manual directory is automatically detected. Of course, it can be
461 configured by @code{INFODIR} in @file{Makefile}.
463 You can read manual at the following URL:
466 http://www.gohome.org/wl/doc/wl_toc.html
469 @node Minimal Settings, Folder Definition, Install, Start Me Up
470 @section Set up .emacs
471 @cindex Minimal Settings
473 @cindex Configuration
477 The Wanderlust package contains two module groups.
480 @item ELMO (elmo-*.el)
481 These modules show everything as folders. This is the back-end for WL.
483 These modules controls the behavior of main body of Wanderlust.
484 They are also the front-end for ELMO.
487 You can customize the behavior of Wanderlust by changing the value
488 of environmental variables which begins with @code{elmo-} and @code{wl-}.
490 The minimal requirement for settings is as the following.
494 ;; @r{autoload configuration}
495 ;; @r{(Not required if you have installed Wanderlust as XEmacs package)}
496 (autoload 'wl "wl" "Wanderlust" t)
497 (autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
498 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
500 ;; @r{Directory where icons are placed.}
501 ;; @r{Default: the peculiar value to the running version of Emacs.}
502 ;; @r{(Not required if the default value points properly)}
503 (setq wl-icon-directory "~/work/wl/etc")
505 ;; @r{SMTP server for mail posting. Default: @code{nil}}
506 (setq wl-smtp-posting-server "your.smtp.example.com")
507 ;; @r{NNTP server for news posting. Default: @code{nil}}
508 (setq wl-nntp-posting-server "your.nntp.example.com")
512 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
513 file exists). So it is convenient to gather Wanderlust specific settings
514 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
515 because you can't write them in @file{.emacs}
516 (if you write it to @file{.emacs}, you'll get an error).
519 All above described settings except autoload configuration can be written
522 @subsection @code{mail-user-agent}
523 @cindex Default Mailer
524 @cindex Mailer, Default
525 @vindex mail-user-agent
528 If you write following setting in your @file{~/.emacs}, you can
529 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
530 This means it enables you to run Wanderlust as a default mail composer
533 It is effective only when your Emacs can define @code{mail-user-agent}.
534 @xref{Mail Methods, , ,emacs, The Emacs Editor}.
538 (autoload 'wl-user-agent-compose "wl-draft" nil t)
539 (if (boundp 'mail-user-agent)
540 (setq mail-user-agent 'wl-user-agent))
541 (if (fboundp 'define-mail-user-agent)
542 (define-mail-user-agent
544 'wl-user-agent-compose
553 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
554 @section Folder Definition
555 @cindex Folder Definition
558 You can skip this section because it is possible to add/edit the
559 subscribe folders from the buffer for list of folders.
560 @xref{Folder Manager}.
562 Define the folders you want to subscribe in file @file{~/.folders}. The
563 contents written in @file{~/.folders} become the folders which you
564 subscribe to as it is.
566 Format for @file{~/.folders} is very simple. Here is an example:
571 # @r{Lines begin with @samp{#} are comment.}
572 # @r{Empty lines are ignored}
574 # @var{folder name} "@var{folder nickname}"
575 # @r{(nicknames are not necessary)}
580 %#mh/Backup@@my.imap.example.com "Sent"
583 %#mh/spool/wl "Wanderlust ML"
584 %#mh/spool/elips "ELIPS ML"
585 %#mh/spool/apel-ja "APEL Japanese ML"
586 %#mh/spool/xemacs-beta "XEmacs beta"
587 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
588 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
591 # @r{If folder name ends with @samp{/}, that means an `access group',}
592 # @r{all subfolders automatically included in one folder group.}
594 %#mh/expire@@localhost /
595 # @r{All MH folders are included in one folder group.}
600 Each line contains one folder you want to read. The definition of
601 folders will be explained in detail in the next section.
603 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
604 become one folder group. One folder group is treated as a directory
605 which can be opened and closed in folder mode. It is convenient for
606 collecting some folders and putting them in order.
608 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
609 line and you have to write it that way (It is because the parser sucks).
611 There are two types of groups. One is like @samp{Emacsen} from above
612 example which the user chooses his favorite folders as a group.
614 The other one is @dfn{access group} like @samp{+ /} from above example.
615 It collects all sub-folders in the folder to make a group. (Its
616 behavior differs by the type of the folder. For example, @samp{+}
617 followed by @samp{/} makes entire MH sub-directories to one group)
619 This behavior is better understood if you try it and confirmed the
620 function first. You can write and try a small folder definition, so you
621 will know the idea of the folder function before writing the real one.
623 @node Start Wanderlust, Overview, Folder Definition, Start Me Up
624 @section Start Wanderlust
625 @cindex Start Wanderlust
627 If installation and configuration worked well, you can invoke Wanderlust by
628 typing following command in Emacs.
635 After initialization, Folder Mode which shows the list of folders will
636 appear. That means the folders you defined in the @file{~/.folders} are
639 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
640 can skip folder checking.
643 @node Overview, , Start Wanderlust, Start Me Up
647 Basically, you will handle messages in wanderlust while you come and go
648 from/to each of the following buffers. Details of each ones are
649 explained in following chapters.
653 You can see the list of folders. You can select some folder and go into the summary
654 of it. You can subscribe new folder or edit subscription list.
656 You can see the list of messages in the folder. You can select message
657 and view its contents, and reply to some message. You can delete ones or
658 move ones to another folder.
660 You can see the contents of the message. You can save part to disk or
661 open in external programs.
663 You can edit message.
667 @node Folders, Folder, Start Me Up, Top
668 @chapter Wanderlust's folders
671 This chapter describes the folder types which Wanderlust is able to handle.
673 Wanderlust uses ELMO as it's interface, so you can use every folder types
676 As of version @value{VERSION}, 14 types of folders are predefined. These
677 are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP,
678 Shimbun, Namazu, Multi, Filter, Pipe, Internal and File folder types.
681 * IMAP Folder:: @samp{%} -- IMAP folder
682 * NNTP Folder:: @samp{-} -- NNTP folder
683 * MH Folder:: @samp{+} -- MH folder
684 * Maildir Folder:: @samp{.} -- Maildir folder
685 * News Spool Folder:: @samp{=} -- News spool folder
686 * Archive Folder:: @samp{$} -- Archive folder
687 * POP Folder:: @samp{&} -- POP folder
688 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
689 * Namazu Folder:: @samp{[} -- Namazu Folder
690 * Multi Folder:: @samp{*} -- Multi folder
691 * Filter Folder:: @samp{/} -- Filter folder
692 * Pipe Folder:: @samp{|} -- Pipe folder
693 * Internal Folder:: @samp{'} -- Internal folder
694 * File Folder:: -- File folder
698 @node IMAP Folder, NNTP Folder, Folders, Folders
706 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
712 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
716 You can specify @code{login} (encoded password transmission),
717 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
718 authentication) or @code{clear} (or @code{nil}, plain password
719 transmission) as @var{authenticate-type}.
724 @var{username} -> The value of @code{elmo-imap4-default-user}.
725 Initial setting is @env{USER} environment variable or
726 @env{LOGNAME} environment variable or return value of
727 @code{(user-login-name)}.
728 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
729 Initial setting is "auth".
730 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
731 Initial setting is "localhost".
732 @var{port} -> The value of @code{elmo-imap4-default-port}.
733 Initial setting is 143.
736 You can omit the @var{hostname} from folder names if you set
737 @code{elmo-imap4-default-server} as your main IMAP server.
738 For example, you can specify a folder as @samp{foo%imap@@gateway} even
739 if you have to go through a firewall.
743 ;; @r{Example: imap4.exaple.org as main IMAP server}
744 (setq elmo-imap4-default-server "imap4.example.org")
748 SSL (Secure Socket Layer) connection will be used if a folder name ends
749 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
750 is @code{ssl}, SSL will be the default connection. If a folder name
751 ends with @samp{!!}, STARTTLS connection will be established. If the
752 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
753 STARTTLS will be the default connection.
757 ;; @r{Example: Use SSL connection}
758 (setq elmo-imap4-default-stream-type 'ssl)
762 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
763 authentication method, the password is sent in encoded form. But, if
764 your server is unable to receive an encoded password, authentication
765 will fall back to @code{clear} (that is, sending password in raw format)
766 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
767 authentication will fall back to @code{clear} without confirmation
768 (default value is @code{nil}).
772 ;; @r{Example: password in raw format}
773 (setq elmo-imap4-default-authenticate-type 'clear)
781 %inbox -> IMAP mailbox "inbox"
782 %#mh/inbox -> IMAP mailbox "#mh/inbox"
784 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
785 %inbox:hoge/clear@@server1
786 -> server1's IMAP mailbox "inbox"
787 of user "hoge", with plain password authentication
792 @subsection International mailbox names (Modified UTF7)
793 @cindex Modified UTF7
800 You can use international mailbox names in @var{mailbox} part, if you
801 are using Emacs with UTF-7 support and
802 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
803 value is @code{nil}).
805 Currently, Mule-UCS package is required to use UTF-7.
806 Mule-UCS works on following Emacsen.
809 @item Emacs 20.3 or later
810 @item XEmacs 21.2.37 or later
813 You can obtain Mule-UCS package from following URL.
816 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
819 @node NNTP Folder, MH Folder, IMAP Folder, Folders
830 A folder to access USENET news via NNTP protocol (RFC 977).
831 One newsgroup is treated as a folder.
837 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
843 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
844 Initial setting is @samp{localhost}.
845 @var{username} -> The value of @code{elmo-nntp-default-user}.
846 Initial setting is @code{nil}.
847 @var{port} -> The value of @code{elmo-nntp-default-port}.
848 Initial setting is 119.
851 AUTHINFO is used as authentication method if the @var{username} is
852 non-nil. SSL will be default method if
853 @code{elmo-nntp-default-stream-type} is @code{ssl} even if the folder name
854 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
855 STARTTLS connection will be established. if the value of
856 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
857 be the default connection.
863 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
864 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
869 @node MH Folder, Maildir Folder, NNTP Folder, Folders
876 A folder to access MH format mail (1 file is 1 mail).
881 @samp{+} @var{directory-name}
884 Normally, @var{directory-name} is an relative path to the variable
885 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
886 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
887 (this is also true for drive-letters).
889 Message number is used for the name of the message file.
895 +inbox -> @file{~/Mail/inbox}
896 +from/teranisi -> @file{~/Mail/from/teranisi}
897 +~/test -> @file{~/test}
902 @node Maildir Folder, News Spool Folder, MH Folder, Folders
903 @section Maildir Folder
905 @cindex Maildir Folder
909 A folder to access Maildir format (1 file is 1 mail).
914 @samp{.} [@var{directory-name}]
917 Normally, @var{directory-name} is a relative path to the variable
918 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
919 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
920 (this is also true for drive-letters).
922 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
923 Messages are contained in the @file{cur} directory. All message files
924 in the @file{new} directory are moved to @file{cur} directory when you
925 access the folder. All message files contained in the @file{tmp}
926 directory and not accessed for 36 hours are deleted.
928 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
934 . -> @file{~/Maildir}
935 .inbox -> @file{~/Maildir/inbox}
936 .from/teranisi -> @file{~/Maildir/from/teranisi}
937 .~/test -> @file{~/test}
942 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
943 @section News Spool Folder
945 @cindex News spool Folder
948 This folder handles locally saved news articles which are proposed by
949 Mew/IM. You can also read articles directly from a spool-file which is
950 retrieved by an utility like @command{gnspool}.
955 @samp{=} @var{directory-name}
958 @var{directory-name} is a sub-directory to the directory defined by
959 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
960 You can use @samp{.} as directory delimiter as well as @samp{/}.
966 =fj/os/os2 -> @file{~/News/fj/os/os2}
967 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
972 @node Archive Folder, POP Folder, News Spool Folder, Folders
973 @section Archive Folder
975 @cindex Archive Folder
978 This method can handle archive files, which are compressed by utilities
979 such as Info-ZIP or LHA, as one folder.
985 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
989 @var{path-name} is the relative path from
990 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
991 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
992 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
993 also permitted under the environment of ange-ftp, efs.
995 The actual file name of the archive folder is
996 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
997 under the @var{path-name}. If a file named @var{path-name} exists, it is
998 treated as folder. The suffix is automatically decided for
1001 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1002 (Initial setting is @code{zip}) is referred.
1004 @var{prefix} specifies the internal directory structure of the archive.
1005 For example, if the ML server is fml, @file{msend.tar.gz} has a
1006 structure like @file{spool/1}, so you have to specify @samp{spool} as
1013 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1014 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1015 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1016 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1017 $ml;zip/ -> Access group consists of archive folders
1018 under @file{~/Mail/ml}
1023 * Archiver:: Supported Archivers
1024 * Archive Tips:: TIPS
1025 * Archive Vars:: Customization
1029 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1030 @subsection Supported Archives
1040 By default, following archives are supported.
1044 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1045 GNU TAR('tgz, 'tar) ;; read-only
1049 If your archiver can include multiple files in one archive, you have a
1050 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1051 of the candidate. TAR is supported read-only because it cannot delete
1052 file in the archive (@code{mv})).
1054 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1055 archiver of Wanderlust because they cannot include multiple
1056 files. Archivers that cannot extract files to standard output are also
1059 @subsection OS specific information about archiver.
1061 Behaviors of the following archivers are confirmed by further experiences.
1062 (@samp{*} mark means recommended archiver).
1065 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1066 LHA OS/2 version Rel.2.06b Feb 18, 1998
1067 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1068 *Zip 2.2 (November 3rd 1997).
1069 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1070 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1071 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1073 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1074 LHa for UNIX V 1.14c
1075 UnZip 5.32 of 3 November 1997
1076 Zip 2.2 (November 3rd 1997)
1077 GNU tar 1.12 (1.11.x is no good)
1078 gzip 1.2.4 (18 Aug 93)
1080 [Win32] Win.98/Meadow
1084 GNU tar 1.11.8 + 1.5(WIN32)
1091 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1092 Hiramatsu version of LHA is only supported.
1093 In Win32, LHa32 is only supported (DOS version is no good).
1095 * Caution about GNU tar
1097 You have to take care about GNU tar's version because many version has
1098 problem on deleting file from archive.
1100 Please test @option{--delete} @option{-f} options work. Otherwise, your
1101 archive will be destroyed. No problem is reported on above versions of
1105 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1107 @cindex Archive Tips
1109 For comfortable migration, usage of @code{wl-summary-archive}
1110 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1111 archive folders created by expiration, you must set non-nil value to
1112 @code{elmo-archive-treat-file}.
1114 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1115 in processing speed. For comfortable use, Emacs20 is recommended.
1116 (If re-search's performance is the problem, 19.3x or later may be okay.)
1118 If many files are included in one archive,
1119 it takes long time to access the archive folder because
1120 archiver starting overhead is increased (especially LHA).
1121 150-200 messages in one archive is recommended.
1123 Of course, following is possible @t{:-)}
1124 (meanings of these variables are described later.)
1128 (setq wl-fcc "$backup")
1129 (setq wl-trash-folder "$trash;lha")
1133 @node Archive Vars, , Archive Tips, Archive Folder
1134 @subsection Variables About Archive Folder
1135 @cindex Archive variables
1138 @item elmo-archive-default-type
1139 @vindex elmo-archive-default-type
1140 The initial setting is @code{zip}.
1141 Set archiver type by symbol.
1143 @item elmo-archive-@var{type}-method-alist
1144 @vindex elmo-archive-TYPE-method-alist
1145 Define archiver @var{type}'s methods.
1146 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1147 Each element of the alist is following.
1151 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1152 (@var{action} . @var{function}) ;; function
1156 Currently available actions are following.
1160 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1161 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1168 actions enclosed with braces are optional (They are used for better
1171 @item elmo-archive-suffix-alist
1172 @vindex elmo-archive-suffix-alist
1173 An alist of archiver-type (symbol) and suffix.
1175 @item elmo-archive-file-regexp-alist
1176 @vindex elmo-archive-file-regexp-alist
1177 An alist of a regexp to get file number from list output of archiver
1178 and archiver-type (symbol).
1180 @item elmo-archive-method-list
1181 @vindex elmo-archive-method-list
1182 A list of elmo-archive-@var{type}-method-alist
1183 (@var{type} is a symbol of archiver-type).
1185 @item elmo-archive-lha-dos-compatible
1186 @vindex elmo-archive-lha-dos-compatible
1187 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1188 DOS (Mr. Yoshizaki original) compatible.
1190 @item elmo-archive-cmdstr-max-length
1191 @vindex elmo-archive-cmdstr-max-length
1192 The initial setting is 8000.
1194 Max length of command line argument for external archiver program.
1195 Emacs does not have a limit of command line byte length, but some OS
1196 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1197 this limit because it calls external archiver program directly (not
1198 called via shell). For example, you cannot delete messages if archiver
1199 program must receive larger bytes of arguments to delete. OS/2 have a
1200 command line argument limit of 8190 bytes, so we defined default as 8000
1203 However, you don't have an influence of command line argument limit
1204 if the archiver has `actions' to receive target file information from
1205 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1209 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1217 A folder to access e-mails via POP3 protocol (RFC 1939).
1223 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1228 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1229 as @var{authenticate-type}.
1231 You can specify @samp{uidl} (use UIDL command for message numbering) or
1232 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1236 @var{username} -> The value of @code{elmo-pop3-default-user}.
1237 Initial setting is @env{USER} environment variable or
1238 @env{LOGNAME} environment variable or return value of
1239 @code{(user-login-name)}.
1240 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1241 Initial setting is @samp{user}.
1242 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1243 If t, use UIDL for numbering. Initial setting is t.
1244 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1245 Initial setting is @samp{localhost}.
1246 @var{port} -> The value of @code{elmo-pop3-default-port}.
1247 Initial setting is 110.
1254 &hoge@@localhost -> access localhost as user @samp{hoge}.
1255 &hoge@@popserver:109 -> access the server "popserver" on port 109
1256 as user @samp{hoge}.
1260 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1261 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1262 @file{utils/sasl/lisp/} or Emacs/W3 package
1263 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1266 If the last character of the folder name is @samp{!}, Wanderlust
1267 connects to the POP server via SSL (Secure Socket Layer). If you set
1268 @code{ssl} to @code{elmo-pop3-default-stream-type}, you don't have to put
1269 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1270 with @samp{!!}, STARTTLS connection will be established. if the value
1271 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1275 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1276 @section Shimbun Folder
1278 @cindex Shimbun Folder
1279 @cindex Folder, Shimbun
1284 A folder for watching "shimbun" (means "newspaper" in Japanese),
1285 news site and mailing list archives on WWW by using emacs-w3m
1286 (@uref{http://emacs-w3m.namazu.org/}).
1288 You should possess w3m and emacs-w3m to use this.
1294 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1298 Admissible values of @var{module-name} and @var{folder-name} are
1299 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1305 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1306 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1310 @subsection Variables About Shimbun Folder
1313 @item elmo-shimbun-update-overview-folder-list
1314 @vindex elmo-shimbun-update-overview-folder-list
1315 The initial setting is @code{all}. Specify a set of folders to update
1316 overview when messages are fetched. Specify @code{all} to update
1317 overview in all shimbun folders. You can specify a list of regular
1318 expressions of shimbun folder names to restrict affected folders.
1323 (setq elmo-shimbun-update-overview-folder-list
1324 '("^@@airs\\." "^@@namazu\\."))
1327 @kbd{s rescan} is needed after fetching to update summary view.
1331 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1332 @section Namazu Folder
1334 @cindex Namazu Folder
1335 @cindex Folder, Namazu
1336 @cindex Folder, Text Search
1339 A folder to access messages found in namazu-index with some condition.
1340 It uses namazu (@uref{http://www.namazu.org/}) for search.
1346 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1350 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1356 [wanderlust] -> search messages matched with
1357 "wanderlust" from the default index
1358 [semi flim]~/Mail/semi -> search "semi flim" from the index
1359 in the directory "~/Mail/semi"
1365 @subsubsection Enter space to separate keywords
1367 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1369 @subsubsection Alias name for index
1371 You can define an alias name for index.
1376 (setq elmo-nmz-index-alias-alist
1377 '(("cache" . "~/.elmo/cache")
1378 ("docs" . "~/documents")))
1381 Above definition defines two index aliases.
1388 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1389 directory @file{~/.elmo/cache}.
1391 @subsubsection Multiple indices
1393 You can specify a list for @code{elmo-nmz-default-index-path} and
1394 @code{elmo-nmz-index-alias-alist}.
1395 When list is specified, all index contained in the list is used as the
1401 (setq elmo-nmz-index-alias-alist
1402 '(("all" . ("~/.elmo/cache" "~/documents"))
1403 ("cache" . "~/.elmo/cache")))
1406 Using above alias setting, you can specify
1412 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1413 directory @file{~/.elmo/cache} and @file{~/documents}.
1415 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1416 @section Multi Folder
1418 @cindex Multi Folder
1419 @cindex Folder, Multiple
1420 @cindex Folder, Marge
1422 A folder to access virtual folder which collects messages from
1429 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1433 After @samp{*} character, specify multiple folders you want to collect
1434 separated by @samp{,} like
1435 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1441 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1442 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1443 treated as one folder.
1445 *+inbox,-fj.rec.tv,%inbox
1446 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1451 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1452 @section Filter Folder
1454 @cindex Filter Folder
1455 @cindex Folder, Filtering
1456 @cindex Folder, Virtual
1457 @cindex Folder, Conditional
1460 A folder to access virtual folder which collects all messages that
1461 satisfy a condition.
1466 @samp{/} @var{condition} @samp{/} @var{target-folder}
1469 In the @var{condition} part, you can specify following.
1473 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1475 first: @var{number} messages are picked from top of folder.
1476 last: @var{number} messages are picked from bottom of folder.
1482 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1483 /first:20/%inbox -> First 20 messages from %inbox are picked.
1488 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1490 since: only messages arrived since @var{date} are picked.
1491 before: only messages arrived before @var{date} are picked.
1493 You can specify following as @var{date}.
1497 yesterday -> a day before today.
1498 lastweek -> same day of last week.
1499 lastmonth -> same day of last month.
1500 lastyear -> same day of last year.
1501 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1502 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1510 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1512 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1518 Field filter: @samp{@var{field}:@var{value}}
1520 All messages that have @var{field} and its value is @var{value} are picked.
1521 @var{field} and @var{value} are case insensitive.
1527 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1528 and its value includes "teranisi" string are picked.
1529 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1535 Flag filter: @samp{flag:@var{flag-name}}
1537 Pick up messages with flag specified by @var{flag-name}.
1539 You can specify following flag names:
1544 important -> important
1546 digest -> unread or important
1547 any -> unread or important or replied
1551 You can also use flags which you have set as global flag.
1552 @xref{Internal Folder}.
1558 /flag:digest/%inbox -> a folder consist of unread or important
1560 /flag:wl/+ML/Wanderlust -> a folder consist of messages with global flag
1561 wl in +ML/Wanderlust.
1568 A condition starting with @samp{!} indicates a negation.
1569 If you combine conditions by character @samp{|}, it is considered as OR condition.
1570 @samp{&} is considered as AND condition, likewise.
1571 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1573 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1574 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1580 /from:teranisi&!to:teranisi/+inbox
1581 -> In +inbox, messages are picked if the message's
1582 From: field includes "teranisi" and
1583 To: field doesn't include "teranisi".
1585 /tocc:"Yuuichi Teranishi"/+inbox
1586 -> In +inbox, messages are picked if the
1587 message's To: field or Cc: field includes
1588 "Yuuichi Teranishi".
1590 /(from:yt|from:teranisi)&subject:report/+inbox
1591 -> In +inbox, messages are picked if the message's
1592 From: field includes "yt" or "teranisi", and
1593 Subject includes "report".
1599 Tip for string description:
1601 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1602 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1603 should be escaped with @samp{\} in it). You can enclose the string with
1604 @samp{"} even it does not contain these characters.
1610 *%inbox,/from:teranisi/%inbox@@server
1611 -> Messages in %inbox or
1612 message is in the %inbox@@server folder and it's From field
1613 includes "teranisi" are collected.
1615 /last:100//to:teranisi/*+inbox,%inbox
1616 -> Latest 100 messages which is in the +inbox or %inbox folder
1617 and To: field matches "teranisi".
1619 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1620 -> Pick messages which have From: field and it includes "hogehoge"
1621 from latest 20 messages in the %#mh/inbox@@localhost
1622 and To: or Cc: field includes "teranisi".
1625 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1626 @section Pipe Folder
1630 @cindex Download Message
1631 @cindex Incorporate Message
1633 In the pipe folder, messages are automatically transferred from the source
1634 folder to destination folder.
1639 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1642 When you access the pipe folder, messages are automatically transferred
1643 from @var{source-folder} to @var{destination-folder}.
1644 It is convenient if you want to download messages to local disk via POP.
1645 For example, if you specify following
1648 |&username@@popserver|+inbox
1652 and access it, Wanderlust downloads messages from
1653 @samp{&username@@popserver} to @samp{+inbox} automatically.
1655 On the other hand, if you put @samp{|:} instead of second @samp{|},
1656 then messages are copied to the destination folder (not deleted from
1657 source-folder). At the next time you access that folder, copies new
1661 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1664 If you want to copy messages from POP server and view them, specify the
1668 |&username@@popserver|:+inbox
1671 where messages will be kept on the server.
1677 |%inbox|%myinbox -> Download %inbox to %myinbox.
1678 |*&user@@popserver1,&user@@popserver2|+inbox
1679 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1680 |-gnu.emacs.sources|:+sources
1681 -> Copy messages from -gnu.emacs.sources to +sources.
1685 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1687 @node Internal Folder, File Folder, Pipe Folder, Folders
1688 @section Internal folder
1690 @cindex Internal Folder
1691 @cindex Folder, @samp{$} mark
1694 @c @cindex Folder, Null
1696 A folder to access internal messages of Wanderlust.
1702 @samp{'flag} [@samp{/} @var{global-flag}]
1704 @samp{'cache/00} - @samp{'cache/1F}
1708 A folder named @samp{'flag} is a special virtual folder which collects
1709 messages which have @var{global-flag}.
1711 There is @samp{important} flag defined as @var{global-flag} by default.
1712 You can review important messages at once after you put important marks
1713 on the messages in the different folders. If @var{global-flag} is omitted,
1714 it is treated as @samp{important} flag is specified.
1716 In addition, in summary mode, to be described later, you can freely
1717 define global flags and put them on messages.
1718 @xref{Usage of Summary mode}.
1720 In this folder, if you delete message, @var{global-flag} put on the
1721 message is removed. If you append messages to this folder, the message
1722 will have @var{global-flag}.
1725 A folder named @samp{'sendlog} is a virtual folder which collects
1726 cached messages which are recoded on @file{~/.elmo/sendlog}.
1727 It might be useful when you forgot to add cc for yourself.
1728 To use this, you should set @code{wl-draft-use-cache} to non-nil
1729 so that sent messages are cached.
1732 You can access cached messages fetched via network by accessing
1733 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1734 the name of the subdirectories of the cache directory
1735 (@file{~/.elmo/cache}).
1738 @node File Folder, , Internal Folder, Folders
1739 @section File folder
1743 @node Folder, Summary, Folders, Top
1744 @chapter Folder mode
1747 After you start Wanderlust, folder mode is appeared firstly.
1748 It contains folder list you subscribed.
1749 You can select and edit folders in this mode.
1752 * Selecting Folder:: Select folder you want to read
1753 * Folder Manager:: Editing folders
1757 @node Selecting Folder, Folder Manager, Folder, Folder
1758 @section Selecting Folder
1759 @cindex Selecting Folder
1761 @subsection Usage (TIPS)
1763 @subsubsection Check new, unread number
1765 Folder mode looks like this.
1766 (In XEmacs, it looks much nicer @t{;-)})
1770 [-]Desktop:14186/35580/67263
1775 [-]Emacsen:0/34/4837
1776 Wanderlust ML:0/0/558
1779 XEmacs Beta:0/29/255
1790 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1794 @kbd{s} key on the folder line updates these numbers.
1795 It changes its color if it has many new messages.
1797 The whole folder mode is a folder group named @samp{Desktop}.
1798 Folder group open/close by return key.
1799 A operation to a folder group is treated as operations on the
1801 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1802 six children folders update its unread number status.
1804 @subsubsection Select Folder
1806 To enter summary mode of the folder, type return (or space) key on
1808 If the variable @code{wl-stay-folder-window} has non-nil value,
1809 summary window appears on the right of the folder mode window.
1811 @subsection Key bindings
1813 Folder mode's key binding (related to selecting folders) is following.
1818 @kindex @key{SPC} (Folder)
1819 @kindex @key{RET} (Folder)
1820 @findex wl-folder-jump-to-current-entity
1821 Enter to the summary mode of the folder at the current cursor point.
1822 With prefix argument, enter the sticky summary.
1823 If the cursor is on the top of folder group line,
1824 the folder group is opened or closed.
1825 When the cursor is on the access group and this command is called
1826 with prefix argument, folder children list is updated to the newest one.
1827 (Children list is updated recursively if the access folder has hierarchical
1829 (@code{wl-folder-jump-to-current-entity})
1832 @kindex M-@key{RET} (Folder)
1833 @findex wl-folder-update-recursive-current-entity
1834 Folder children list of the access group at the current cursor point
1835 is updated to the newest one.
1836 (Children list is updated recursively if the access folder has hierarchical
1838 (@code{wl-folder-update-recursive-current-entity})
1843 Create a new draft message.
1848 @findex wl-folder-write-current-folder
1849 If the current cursor point is on the NNTP folder, create a new draft
1850 message which already has @samp{Newsgroups:} field. If the current
1851 cursor point is on the folder for mailing list (refile destination),
1852 create a new draft message which already has @samp{To:} field with
1853 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1855 (@code{wl-folder-write-current-folder})
1858 @kindex C-c C-o (Folder)
1859 @findex wl-jump-to-draft-buffer
1860 Move to the draft buffer if available. If multiple draft buffer exists,
1861 moved to one after another. If prefix argument is specified, load draft
1862 folder's message to the draft buffer and jump to it.
1863 (@code{wl-jump-to-draft-buffer})
1867 @findex wl-folder-check-current-entity
1868 Update new and unread number information of the folder at the current
1870 (@code{wl-folder-check-current-entity})
1874 @findex wl-folder-sync-current-entity
1875 Update summary information of the folder at the current cursor point.
1876 (@code{wl-folder-sync-current-entity})
1879 @kindex r s (Folder)
1880 @findex wl-folder-check-region
1881 Update new and unread number information of the folders in the currently
1883 (@code{wl-folder-check-region})
1886 @kindex r S (Folder)
1887 @findex wl-folder-sync-region
1888 Update summary information of the folders in the currently selected region.
1889 (@code{wl-folder-sync-region})
1893 @findex wl-status-update
1894 Sync up address book status with @file{~/.addresses}'s content.
1895 (@code{wl-status-update})
1899 @findex wl-folder-prev-unread
1900 Jump cursor to the folder which have unread messages on the upward from
1901 current cursor point.
1902 (@code{wl-folder-prev-unread})
1906 Jump cursor to the folder which have unread messages on the downward
1907 from current cursor point.
1908 (@code{wl-folder-next-unread})
1912 Move cursor to the folder on the previous line.
1913 (@code{wl-folder-prev-entity})
1917 Move cursor to the folder on the next line.
1918 (@code{wl-folder-next-entity})
1922 Jump to the folder specified by the user input.
1923 (@code{wl-folder-jump-folder})
1927 @findex wl-folder-prefetch-current-entity
1928 Prefetch new messages of the folder at the current cursor point by
1929 @code{wl-summary-incorporate}.
1930 If the cursor is on the folder group, it is executed recursively.
1931 (@code{wl-folder-prefetch-current-entity})
1935 @findex wl-folder-mark-as-read-all-current-entity
1936 Mark all unread messages of the folder at the current cursor point as read.
1937 If the cursor is on the folder group, it is executed recursively.
1938 (@code{wl-folder-mark-as-read-all-current-entity})
1942 @findex wl-folder-goto-first-unread-folder
1943 Enter summary mode of the first unread folder.
1944 (@code{wl-folder-goto-first-unread-folder})
1948 @findex wl-folder-empty-trash
1950 (@code{wl-folder-empty-trash})
1954 @findex wl-folder-flush-queue
1956 (@code{wl-folder-flush-queue})
1960 @findex wl-folder-virtual
1961 Move to the virtual folder (filter folder) with the condition specified.
1962 (@code{wl-folder-virtual})
1966 @findex wl-folder-pick
1967 Search the folders with the condition specified.
1968 (@code{wl-folder-pick})
1972 @findex wl-folder-open-all-unread-folder
1973 All unread folder is opened.
1974 (@code{wl-folder-open-all-unread-folder})
1978 @findex wl-folder-open-close
1979 Folder group is opened/closed.
1980 (@code{wl-thread-open-close})
1984 All folder group is opened.
1985 (@code{wl-folder-open-all})
1989 All folder group is closed.
1990 (@code{wl-folder-close-all})
2000 (@code{wl-folder-suspend})
2003 @kindex M-s (Folder)
2004 Save current folder status.
2008 @kindex M-t (Folder)
2009 Toggle Wanderlust's offline/online status.
2010 (@code{wl-toggle-plugged})
2013 @kindex C-t (Folder)
2014 Start Wanderlust's plug-status manager.
2015 (@code{wl-plugged-change})
2018 @subsection Customize variables
2021 @item wl-folders-file
2022 @vindex wl-folders-file
2023 The initial setting is @file{~/.folders}.
2024 Subscribed folders are described (saved) in this file.
2026 @item wl-folder-info-save
2027 @vindex wl-folder-info-save
2028 The initial setting is @code{t}. If non-nil, unread information is
2029 saved and used in the next Wanderlust session.
2031 @item wl-stay-folder-window
2032 @vindex wl-stay-folder-window
2033 The initial setting is @code{nil}.
2034 If non-nil, summary window is appeared on the right side of the folder buffer.
2036 @item wl-folder-window-width
2037 @vindex wl-folder-window-width
2038 The initial setting is 20.
2039 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
2041 @item wl-folder-use-frame
2042 @vindex wl-folder-use-frame
2043 The initial setting is @code{nil}.
2044 If non-nil, use new frame for the folder window.
2046 @item wl-folder-many-unsync-threshold
2047 @vindex wl-folder-many-unsync-threshold
2048 The initial setting is 70.
2049 If the number of unread messages is more than this value,
2050 folder color is changed.
2052 @item wl-highlight-folder-by-numbers
2053 @vindex wl-highlight-folder-by-numbers
2054 This option controls how to highlight each line in the folder buffer.
2055 The default value is @code{t}, highlighting with various colors based on
2056 the message numbers. If it is @code{nil}, highlighting with various
2057 colors based on the folder status. In addition, if it is a number
2058 (e.g. 1), highlighting will be done based on both the message numbers
2059 and the folder status.
2061 @item wl-folder-desktop-name
2062 @vindex wl-folder-desktop-name
2063 The initial setting is @samp{Desktop}.
2064 The name of top folder group.
2066 @item wl-folder-petname-alist
2067 @vindex wl-folder-petname-alist
2068 The initial setting is @code{nil}.
2069 An alist of folder's realname and its nickname.
2071 @item wl-folder-access-subscribe-alist
2072 @vindex wl-folder-access-subscribe-alist
2073 The initial setting is @code{nil}.
2075 Control automatic subscribing and unsubscribing of the children list
2081 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2085 If @var{subscribe-flag} is non-nil, folders which have name matched to
2086 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2087 already unsubscribed folder is not displayed even when the
2088 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2095 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2096 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2097 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2098 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2102 @item wl-folder-hierarchy-access-folders
2103 @vindex wl-folder-hierarchy-access-folders
2104 A list of regular expressions for access groups which creates children
2105 folder list hierarchically.
2107 For example, if you specify
2108 @code{wl-folder-hierarchy-access-folders} like following,
2112 (setq wl-folder-hierarchy-access-folders
2113 '("^-[^\\.]*$" "^-comp.unix$" "^-comp.unix.bsd$"))
2118 you obtain the access group hierarchy as follows.
2124 -fj.comp.announce:0/0/2
2125 -fj.comp.dev.cdrom:0/0/0
2127 [+]-japan:238/238/1688
2130 -comp.unix.admin:0/0/0
2131 -comp.unix.dos-under-unix:0/0/0
2132 -comp.unix.programmer:0/0/0
2133 [-]-comp.unix.bsd:0/0/23
2134 -comp.unix.bsd.freebsd.announce:0/0/0
2139 If you opened @samp{-} in this example, only the direct children is created
2140 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2141 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2142 is not created until the children access group is opened.
2146 @node Folder Manager, , Selecting Folder, Folder
2147 @section Editing Folders
2148 @cindex Folder Manager
2149 @cindex Folder, Edit
2150 @cindex Folder, Subscribe
2151 @cindex Folder, Unsubscribe
2153 As described before, subscribed folder list is saved in @file{~/.folders} file.
2154 But you don't have to edit @file{~/.folders} directly.
2155 You can append, delete, edit folders from folder mode.
2157 @subsection Usage (Tips)
2159 @subsubsection Append Folder
2161 @kbd{m a} appends new folder to the folder mode.
2162 @kbd{m g} appends new folder group.
2163 To append new folder to this group, firstly open it,
2164 then execute append command in the next line.
2166 @subsubsection Edit Folder
2168 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2169 Thus, you can change folder position as if you were editing a normal file.
2171 @subsubsection Create Multi Folder.
2175 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2177 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2179 Type @kbd{m m}, then you can create multi folder.
2182 @subsubsection Delete Nickname, Filter
2184 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2185 minibuffer while appending.
2187 @subsubsection Append Folder to Empty Group
2189 To append new folder to the empty folder group
2190 (after you create folder group by typing @kbd{m g}),
2191 firstly open it, then execute append command in the next line.
2192 If it is closed, folder is appended on the same level with
2193 the folder group above. It is difficult to explain by words so try it.
2194 In other words, appended position depends on the
2195 open/close status of the upper one.
2197 @subsubsection Charset of the Folders File.
2199 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2201 @subsubsection Create Filter
2203 @kbd{m f} adds filter to the folder at the current cursor point. To
2204 create new filter folder and leave the current folder unchanged, copy it
2205 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2206 filter can be specified while appending filter. If you put
2207 ``''(@var{NULL}), filter is deleted.
2209 @subsubsection Sort Folders
2211 Sorting of the folders is executed by the function specified by
2212 @code{wl-fldmgr-sort-function}.
2213 The initial setting is @code{wl-fldmgr-sort-standard},
2214 which sorts alphabetically.
2215 Sorting affects only on the current folder group. It does not
2216 affect on the child groups.
2218 @subsubsection Hiding Folders in the Access Group
2220 Usually, access group displays all children folders, but you can set
2221 some folders hidden. Following operations are only available on access
2224 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2225 (subscribe/unsubscribe) of the folder at current cursor point. Against
2226 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2229 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2230 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2231 argument and if the argument has positive number, the unsubscribe it.
2232 If the prefix argument has negative value, folder becomes visible and if
2233 zero, folder visibility is toggled.
2235 The other commands, @code{wl-fldmgr-subscribe} and
2236 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2239 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2240 executed in the access group, they have a same effect with
2241 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2242 The difference is that cut commands deletes folders from the current
2245 @subsubsection Operations in the Access Group
2247 You can insert and delete folders in the access group like usual folder
2248 group. But insert and delete commands can be only available for the
2249 children folders of the access group and they only sets the subscribe
2250 status. In other words, insertion of the folder means subscribing,
2251 deletion means unsubscribing.
2252 @footnote{In the current implementation,
2253 it is faster to delete region than to unsubscribe region.}
2255 To update the access group when children folders are inserted or deleted
2256 by other way (other than Wanderlust),
2257 open the access group by typing @kbd{C-u @key{RET}}.
2258 @xref{Selecting Folder}.
2260 The order of children folders of access group is saved after
2261 insertion/deletion/sorting.
2262 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2263 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2264 newly created folders are inserted on the top of the access group.
2266 @subsection Key bindings
2267 @cindex Keybind, Folder Mode
2268 @cindex Keybind, Folder Buffer
2270 Key bindings on the folder mode related to folder editing are shown below.
2271 All bindings starts with @kbd{m}, and primary commands are binded to
2272 one stroke key binding.
2276 @kindex m a (Folder)
2277 @findex wl-fldmgr-add
2279 (@code{wl-fldmgr-add})
2284 @kindex m g (Folder)
2285 @findex wl-fldmgr-make-group
2286 Create a folder group.
2287 (@code{wl-fldmgr-make-group})
2290 @kindex m A (Folder)
2291 @findex wl-fldmgr-make-access-group
2292 Create an access group.
2293 (@code{wl-fldmgr-make-access-group})
2296 @kindex m d (Folder)
2297 @findex wl-fldmgr-delete
2298 Delete folder itself and msgdb.
2299 If the folder itself cannot be deleted like NNTP folder,
2300 only msgdb is deleted.
2301 (@code{wl-fldmgr-delete})
2306 @kindex m R (Folder)
2307 @findex wl-fldmgr-rename
2308 Change the name of folder or folder group.
2309 msgdb's path is also changed.
2310 (@code{wl-fldmgr-rename})
2316 @findex wl-fldmgr-make-multi
2317 Create a multi folders in the cutlist (cut, copied folders).
2318 (@code{wl-fldmgr-make-multi})
2323 @kindex m f (Folder)
2324 @findex wl-fldmgr-make-filter
2325 Create a filter folder. (Put a filter on the folder).
2326 (@code{wl-fldmgr-make-filter})
2330 @kindex M-c (Folder)
2331 @kindex m c (Folder)
2332 @findex wl-fldmgr-copy
2333 Copy folder (it is not available on folder group).
2334 (@code{wl-fldmgr-copy})
2338 @kindex M-w (Folder)
2339 @kindex m W (Folder)
2340 @findex wl-fldmgr-copy-region
2341 Copy folders in the specified region.
2342 (@code{wl-fldmgr-copy-region})
2346 @kindex C-k (Folder)
2347 @kindex m k (Folder)
2348 @findex wl-fldmgr-cut
2349 Cut folder. Folder itself is not deleted.
2350 (@code{wl-fldmgr-cut})
2354 @kindex C-w (Folder)
2355 @kindex m C-w (Folder)
2356 @findex wl-fldmgr-cut-region
2357 Cut folders in the specified region.
2358 (@code{wl-fldmgr-cut-region})
2362 @kindex C-y (Folder)
2363 @kindex m y (Folder)
2364 @findex wl-fldmgr-yank
2365 Paste folders that are copied or cut (folders in the cut-list).
2366 (@code{wl-fldmgr-yank})
2369 @kindex m p (Folder)
2370 @findex wl-fldmgr-set-petname
2371 Put nickname on the folder.
2372 (@code{wl-fldmgr-set-petname})
2375 @kindex m q (Folder)
2376 @findex wl-fldmgr-clear-cut-entity-list
2377 Clear the cut-list. (cut, copied folder information is cleared,
2378 you cannot paste after this)
2379 (@code{wl-fldmgr-clear-cut-entity-list})
2382 @kindex m s (Folder)
2383 @findex wl-fldmgr-sort
2384 Sort folders in the current folder group.
2385 (@code{wl-fldmgr-sort})
2388 @kindex m C-s (Folder)
2389 @findex wl-fldmgr-save
2390 Save current folder view to the @file{wl-folders-file}.
2391 (@code{wl-fldmgr-save})
2394 [Following commands are only available on the access groups]
2400 @kindex m u (Folder)
2401 @findex wl-fldmgr-unsubscribe
2402 Set the visibility of folder (subscribe/unsubscribe).
2403 (@code{wl-fldmgr-unsubscribe})
2408 @kindex r u (Folder)
2409 @findex wl-fldmgr-unsubscribe-region
2410 Set the visibility of the folders (subscribe/unsubscribe) in the
2412 (@code{wl-fldmgr-unsubscribe-region})
2417 @kindex m l (Folder)
2418 @findex wl-fldmgr-access-display-normal
2419 List folders that are currently available.
2420 (@code{wl-fldmgr-access-display-normal})
2425 @kindex m L (Folder)
2426 @findex wl-fldmgr-access-display-all
2427 List all folders regardless of the subscription status.
2428 (@code{wl-fldmgr-access-display-all})
2432 @subsection Customize variables
2435 @item wl-interactive-save-folders
2436 @vindex wl-interactive-save-folders
2437 The initial setting is @code{t}. If non-nil and folder view is
2438 modified, confirm saving it before Wanderlust or Emacs exits. If
2439 @code{nil}, save without confirmation.
2441 @item wl-fldmgr-make-backup
2442 @vindex wl-fldmgr-make-backup
2443 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2444 created before saving the folder status.
2446 @item wl-fldmgr-sort-function
2447 @vindex wl-fldmgr-sort-function
2448 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2449 sort folders. By default function, folders are sorted alphabetically
2450 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2453 @item wl-fldmgr-sort-group-first
2454 @vindex wl-fldmgr-sort-group-first
2455 The initial setting is @code{t}. If non-nil,
2456 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2457 does not care whether it is folder group or not.
2459 @item wl-folder-check-async
2460 @vindex wl-folder-check-async
2461 The initial setting is @code{t}. If non-nil, check folder's unread
2462 status asynchronously. It boosts newsgroup checking.
2464 @item wl-folder-check-fast
2465 @vindex wl-folder-check-fast
2466 The initial setting is @code{nil}.
2467 If non-nil, it does not update folder status while checking.
2469 @item wl-folder-notify-deleted
2470 @vindex wl-folder-notify-deleted
2471 The initial setting is @code{nil}.
2473 If non-nil, negative value is displayed when the message is deleted. If
2474 @code{sync}, folder is synchronized when the message is deleted. If
2475 @code{nil}, message deletion is ignored.
2477 @item wl-fldmgr-add-complete-with-current-folder-list
2478 @vindex wl-fldmgr-add-complete-with-current-folder-list
2479 The initial setting is @code{nil}.
2480 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2481 candidate for @code{wl-fldmgr-add}.
2484 @subsection Miscellanea
2486 Following is a note for folder editing.
2490 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2491 paste(yank) command pastes the folders on one cut or copy command
2492 (If copy command is executed by region, folders in the region are pasted
2493 by one paste command)
2496 You cannot cut @samp{Desktop} group.
2497 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2500 You cannot copy folder group.
2503 Operations on the access group are only available for the folders
2504 in the same access group.
2507 You cannot create a folder which has same name with the folders already exist.
2510 You cannot insert folders which have same name in one group.
2511 You can insert them in the different groups.
2512 You cannot put same nickname to the different folders.
2516 @node Summary, Message, Folder, Top
2517 @chapter Summary Mode
2519 After you select the folder via folder mode, you enter to the summary
2523 * Usage of Summary Mode:: TIPS
2524 * Thread Operations:: Thread operations
2525 * Cache:: File cache, Buffer cache, and Prefetch
2526 * Auto Refile:: Auto refile settings
2527 * Sticky Summary:: Summary make sticky
2528 * Summary View:: Format of summary lines
2529 * Key Bindings of Summary:: Key bindings
2530 * Variables of Summary:: Customize Summary Mode
2534 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2535 @section Usage (Tips)
2537 @subsection Summary Content
2539 In the summary mode, messages are displayed like following.
2543 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2544 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2545 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2546 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2553 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2557 If you want to know how to change the format for this, please refer
2558 the section format of Summary lines.
2559 @xref{Summary View}.
2561 @var{Message number} is the message's unique number in the folder. In
2562 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2563 in the MH folder, it is the filename of the message.
2565 @var{Temporal mark} and @var{Persistent mark} are described later.
2567 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2568 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2569 Japanese, but if you want to display it in English, set the value of
2570 @code{wl-summary-weekday-name-lang} as @samp{en}.
2572 @var{Sender}'s indentation corresponds to the depth of the thread.
2573 Sender name is displayed as nickname if it is defined in the address
2574 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2575 displaying with nickname.
2577 If number is printed at the head of @var{Sender} part like @samp{+2},
2578 that means the message have 2 follow messages.
2580 @var{Subject} is the @samp{Subject:} header field of the message. If
2581 the message have same @samp{Subject:} with the parent message, it is not
2582 displayed. Some mailing list puts its sequence number in the
2583 @samp{Subject:} field, but it is
2584 ignored. @code{wl-summary-no-subject-message} is displayed when the
2585 message has empty subject field.
2587 @subsection Temporary Marks
2588 @cindex Mark, Temporary
2590 There are four temporary marks,
2591 @samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}.
2592 Temporary marks indicates message operations.
2597 You can execute a command on the all messages that have @samp{*} mark,
2598 with the key bindings which begins with @kbd{m}.
2601 The mark to dispose. You can put @samp{d} by typing @kbd{d} key.
2604 The mark to force delete. You can put @samp{D} by typing @kbd{D} key.
2608 After you type @kbd{o} key, prompt appears to input refile destination.
2609 Your answer is printed in the summary line.
2613 You can put this mark by typing @kbd{O} key.
2614 The difference between this mark and refile mark is,
2615 this mark does not delete the message while latter does.
2618 The mark to prefetch reserved.
2619 You can put this mark by typing @kbd{i} key.
2622 The mark to resend reserved.
2623 After you type @kbd{~} key, prompt appears to input address to resend.
2624 Your answer is printed in the summary line.
2627 @kbd{x} key executes action for temporary marks, respectively.
2629 @subsection Persistent Marks
2631 There are five persistent marks, @samp{N}, @samp{?}, @samp{U}, @samp{!},
2632 @samp{u}, @samp{A}, @samp{&} and @samp{$}.
2634 The persistent mark indicates the message's status and it is saved.
2635 Each persistent mark indicates:
2641 It is new but cached message.
2643 It is unread message.
2645 It is unread but cached message.
2647 It is read but it is not cached.
2649 It is already replied message.
2651 It is already replied but cached message.
2653 It is a message with some global flag. It is convenient to put this
2654 mark on the messages to remember (If you want to remember to write a
2655 reply for the message, for example) because this mark remains after
2656 you exited Emacs. Messages with the @samp{$} mark can be reviewed in
2657 the @samp{'flag} folder even the message itself is deleted in the actual
2658 folder. You can put global flag by typing @kbd{$} or @kbd{F} key.
2661 If the message is read and cached (or local message),there are no
2665 @samp{N}, @samp{U}, @samp{u}, @samp{A} indicates that the message have
2666 no cache. Messages with the marks other than these, you can read them
2667 in the offline status even they are in the IMAP folder or netnews
2670 Among messages with persistent marks, ones with marks specified by
2671 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2672 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2674 @subsection How To Read
2676 Basically, you can read messages only typing space key again and again.
2678 To update summary status to the newest status (synchronize),
2681 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2682 moves cursor to the next message.
2683 Enter message buffer by typing @kbd{j} key.
2684 To operate multipart, you have to enter to the message buffer.
2687 @subsection Pack the Message Numbers
2688 You can pack the message numbers in Summary by
2689 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2690 News Spool Folder and Maildir Folder are supported folder types.
2693 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2694 @section Thread Operations
2696 For example, the following line indicates one thread (a context of a topic).
2699 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2703 If you type @kbd{/} on this line, the thread is opened and it changes
2704 the appearance like following.
2708 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2709 388 09/17(Thu)22:34 +-[ Murata san ]
2713 (Message 388 is the replied message to the message 384.)
2714 If you type @kbd{/} key once again, the thread is closed.
2715 With prefix argument, @kbd{/} opens all children threads.
2717 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2720 Commands with the key binding that begins with @kbd{t} executes commands
2721 on the messages in the thread.
2722 @xref{Key Bindings of Summary}.
2724 @subsection reconstruct thread by hand
2726 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2727 (@code{wl-summary-save-current-message}) at the corresponding message,
2728 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2729 message then you have the reconstructed thread.
2732 @node Cache, Auto Refile, Thread Operations, Summary
2735 @subsection Cache File
2737 The messages which have to access via network (e.x. IMAP, NNTP folder)
2738 are cached as a local file so as to save network traffic or to enable
2739 off-line operation. The cache file is saved under the directory
2740 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2741 elmo-cache-expire-by-size}. The command deletes cache files to the
2742 specified size by the order of last accessed time.
2744 @subsection Buffer Cache and Prefetching
2746 The messages that are read are kept in the cache buffer so as to make
2747 the behavior fast when you are to read the message again. It is called
2748 `buffer cache'. The number of cache buffer is specified by
2749 @code{wl-message-buffer-cache-size}.
2751 There are message prefetching mechanism in the Wanderlust that
2752 prefetches next message while you are reading.
2754 You can control the message prefetching mechanism by these two
2758 @item wl-message-buffer-prefetch-folder-type-list
2759 @vindex wl-message-buffer-prefetch-folder-type-list
2760 The initial setting is @code{t}. In this case, prefetch messages in all
2762 If it is a list of folder types, it specifies the folder types in which
2763 message prefetching is enabled.
2764 Following is an example (prefetch messages in nntp and imap4 folders)
2768 (setq wl-message-buffer-prefetch-folder-type-list
2773 In this case, multi folder that contains localdir and imap4 prefetches
2774 only imap4 messages. This variable precedes the value of
2775 @code{wl-message-buffer-prefetch-folder-list}.
2777 @item wl-message-buffer-prefetch-folder-list
2778 @vindex wl-message-buffer-prefetch-folder-list
2779 The initial setting is @code{nil}.
2780 A list of regexp of folders to enable message prefetching.
2782 @item wl-message-buffer-prefetch-depth
2783 @vindex wl-message-buffer-prefetch-depth
2784 The initial setting is 3. The number of messages for automatical prefetch.
2786 @item wl-message-buffer-prefetch-idle-time
2787 @vindex wl-message-buffer-prefetch-idle-time
2788 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2790 @item wl-message-buffer-prefetch-threshold
2791 @vindex wl-message-buffer-prefetch-threshold
2792 The initial setting is 30000 (bytes). If prefetching message has larger
2793 size than this value, Wanderlust does not prefetch automatically.
2794 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2795 the message is not checked for the size.
2797 @item wl-auto-prefetch-first
2798 @vindex wl-auto-prefetch-first
2799 The initial setting is @code{nil}.
2800 If non-nil, first message is automatically prefetched to the buffer
2801 when you enter the folder.
2805 @node Auto Refile, Sticky Summary, Cache, Summary
2806 @section Auto Refile
2807 @vindex elmo-msgdb-extra-fields
2808 @vindex wl-refile-rule-alist
2809 @findex wl-summary-auto-refile
2811 You can refile messages automatically, by typing @kbd{C-o}
2812 (@code{wl-summary-auto-refile}). It decides destination of refile by
2813 the content of the message header information (information in the msgdb).
2815 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2816 available. If you want to decide destination by other header fields,
2817 set the variable @code{elmo-msgdb-extra-fields} like following.
2821 (setq elmo-msgdb-extra-fields
2831 By this setting, Wanderlust saves extra fields in the msgdb. You have
2832 to type @kbd{s all} to get extra fields for the messages that are
2833 already exists in the summary.
2835 Then, specify the refile rule. The refile target folder of auto
2836 refiling is decided by the value of @code{wl-refile-rule-alist}.
2837 @code{wl-refile-rule-alist} is a list of a rule:
2841 (@var{field} (@var{regexp} . @var{target})
2842 (@var{regexp} . @var{target})
2847 Each rule means `if @var{field} value matches @var{regexp},
2848 then refile to @var{target} folder'.
2849 The rule matched first is applied.
2851 @var{field} is a string of field name. You can specify a list of field name
2852 string, too. In this case, if one of these fields is matched, then the
2853 rule is fired (i.e. OR condition).
2855 @var{regexp} is a regular expression for field value. @var{target} is a target
2856 folder string. You can specify a rule at @var{target} part, too. In this
2857 case, If the field value of the rule and the current rule is matched,
2858 then the current rule is fired (i.e. AND condition).
2860 You can refer matched substring of @var{regexp} to specify @var{target} part.
2861 To refer substring, use following keys:
2865 means substitute original matched text.
2868 means substitute what matched the @var{N}th `\(@dots{}\)'.
2869 (@var{N} is a number.)
2872 Following is an example of @code{wl-refile-rule-alist}.
2876 (setq wl-refile-rule-alist
2878 ("^Wanderlust" . "+wl")
2879 ("^Elisp" . "+elisp"))
2881 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2883 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2884 "+from-me-to-you"))))))
2888 After these settings, refile marks are automatically put on the condition
2889 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2891 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2893 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2894 with these persistent marks are not automatically refiled.
2895 It means Wanderlust does not execute auto refile on unread messages by
2896 the default setting.
2897 To execute auto refile on all messages, set following.
2900 (setq wl-summary-auto-refile-skip-marks nil)
2904 @node Sticky Summary, Summary View, Auto Refile, Summary
2905 @section Sticky Summary
2906 @cindex Summary, Sticky
2907 @cindex Sticky Summary
2909 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2911 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2912 @kbd{G} in some suummary sticky summary buffer is created.
2913 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2914 makes current one sticky.
2916 The buffer name of the sticky summary becomes like
2917 @samp{Summary:@var{folder-name}}.
2918 You can visit the sticky summary at any time by @kbd{C-x b}
2919 (@code{switch-to-buffer}), or you can go round summary buffers by
2920 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2921 (@code{wl-summary-next-buffer}) in summary mode.
2923 In sticky summary, the summary buffer is preserved after @kbd{g} or
2924 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2925 another summary by @kbd{C-u g}. Other operations in the sticky summary
2926 are same as normal summary.
2928 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2929 are automatically stuck.
2932 @node Summary View, Key Bindings of Summary, Sticky Summary, Summary
2933 @section Format of summary lines
2934 @cindex Format of summary lines
2935 You can alter the format of lines in Summary mode.
2937 Summary line format is specified by @code{wl-summary-line-format}.
2938 You can use control strings defined by
2939 @code{wl-summary-line-format-spec-alist}.
2945 ;; @r{number temporary-mark persistent-mark date branch}
2946 ;; @r{[ (number-of-children) sender ] subject}
2947 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
2951 Where the number set the column number of the field (for negative value,
2954 Major control strings defined by @code{wl-summary-line-format-spec-alist}
2955 are displayed in the following list.
2966 %t branch of the thread
2967 %[ [ (< for re-connected child)
2968 %] ] (> for re-connected child)
2972 %c +number-of-children: (display only for opened thread)
2973 %C [+number-of-children] (display only for opened thread)
2974 %T temporary mark (mandatory)
2975 %P persistent mark (mandatory)
2979 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
2980 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
2981 the constant column. For example, if you specify @samp{%T} or
2982 @samp{%P} after the @samp{%t}, which changes its length by thread
2983 position, marks are not treated correctly.
2985 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
2986 column of the enclosed region is justified to the `number'. Multiple
2987 level @samp{%number(} parenthesis can be defined. It is useful to
2988 justify the column of the multiple control strings. For example, in the
2989 above @code{wl-summary-line-format},
2995 means ``Adjust number-of-children and sender string to the 17 column''.
2997 You can specify the format by each folders with
2998 @code{wl-folder-summary-line-format-alist}. Please set regular
2999 expression for folder names and summary line format as the following
3004 (setq wl-folder-summary-line-format-alist
3005 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
3006 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
3010 @subsection on the format for sender name
3012 The format string @samp{%f} displays the return value of the function specified
3013 by @code{wl-summary-from-function}. If you use the function
3014 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
3015 while displays the recipient names if the folder name matches with
3016 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
3017 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
3019 For example, to display recipient names for the message in @samp{+backup} if
3020 its sender is yourself, set up as follows.
3023 (setq wl-summary-showto-folder-regexp "^\\+backup$")
3027 @node Key Bindings of Summary, Variables of Summary, Summary View, Summary
3028 @section Key bindings
3029 @cindex Keybind, Summary Mode
3030 @cindex Keybind, Summary Buffer
3032 Key bindings of the summary mode are shown below.
3036 @kindex @key{SPC} (Summary)
3037 @findex wl-summary-read
3038 Proceed reading a message at the current cursor point.
3039 (@code{wl-summary-read})
3043 @findex wl-summary-redisplay
3044 Redisplay a message at the current cursor point.
3045 If this command is called with prefix argument,
3046 Redisplay message regardless of the message cache (message is re-loaded
3048 (@code{wl-summary-redisplay})
3052 @findex wl-summary-display-top
3053 Display the top message in the folder.
3054 (@code{wl-summary-display-top})
3058 @findex wl-summary-display-bottom
3059 Display the bottom message in the folder.
3060 (@code{wl-summary-display-bottom})
3064 @kindex @key{BS} (Summary)
3065 @kindex @key{DEL} (Summary)
3066 Display the previous page of the message at the current cursor point.
3067 @findex wl-summary-prev-page
3068 (@code{wl-summary-prev-page})
3071 @kindex @key{RET} (Summary)
3072 @findex wl-summary-next-line-content
3073 Display the next line of the message at the current cursor point.
3074 Display the message at the current cursor point if it is not displayed yet.
3075 (@code{wl-summary-next-line-content})
3080 @kindex M-@key{RET} (Summary)
3081 @findex wl-summary-prev-line-content
3082 Display the previous line of the message at the current cursor point.
3083 Display the message at the current cursor point if it is not displayed yet.
3084 (@code{wl-summary-prev-line-content})
3088 @findex wl-thread-open-close
3089 Toggle open or close the thread at the current cursor point.
3090 (@code{wl-thread-open-close})
3095 @findex wl-thread-open-all
3096 (@code{wl-thread-open-all})
3101 @findex wl-thread-close-all
3102 (@code{wl-thread-close-all})
3106 @findex wl-summary-goto-folder
3108 (@code{wl-summary-goto-folder})
3112 Mark all messages in the folder as read.
3113 @findex wl-summary-mark-as-read-all
3114 (@code{wl-summary-mark-as-read-all})
3118 @findex wl-summary-reply
3119 Prepare a draft for reply the message at the current cursor point.
3120 (@code{wl-summary-reply})
3124 @findex wl-summary-reply-with-citation
3125 Prepare a draft for reply the message at the current cursor point.
3126 (@code{wl-summary-reply-with-citation})
3130 @findex wl-summary-cancel-message
3131 If the message at current cursor point is your own netnews article,
3133 (@code{wl-summary-cancel-message})
3137 @findex wl-summary-reedit
3138 Prepare a draft for re-editing the message at current cursor point.
3139 If the message at current cursor point is your own netnews article,
3140 a draft for `supersedes message' for the message is prepared.
3141 (@code{wl-summary-reedit})
3144 @kindex M-E (Summary)
3145 @findex wl-summary-resend-bounced-mail
3146 If the message at current cursor point is a bounced message,
3147 a draft for re-sending original message is prepared.
3148 (@code{wl-summary-resend-bounced-mail})
3152 @findex wl-summary-forward
3153 A draft for forwarding the message at current cursor point is prepared.
3154 (@code{wl-summary-forward})
3158 @findex wl-summary-mark-as-important
3159 Put @samp{important} flag on the message at current cursor point.
3160 If already flagged as @samp{important}, remove the flag. If it is
3161 called with prefix argument, ask global flag to put similarly to @kbd{F}.
3162 (@code{wl-summary-mark-as-important})
3166 @findex wl-summary-set-flags
3167 Put arbitrary global flag entered in the minibuffer. If you use Emacs
3168 21 or later, you can specify multiple flags separated by @samp{,}
3169 simultaneously. If it is called with prefix argument, remove existent
3171 (@code{wl-summary-set-flags})
3177 Save the message at current cursor point.
3178 @findex wl-summary-save
3179 (@code{wl-summary-save})
3183 @findex wl-summary-next
3184 Move cursor to the next message.
3185 If message is marked with a temporal mark in
3186 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3187 In the offline mode, cursor is not moved to the messages which are not cached
3189 (@code{wl-summary-next})
3193 @findex wl-summary-prev
3194 Move cursor to the previous message.
3195 If message is marked with a temporal mark in
3196 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3197 In the offline mode, cursor is not moved to the messages which are not cached
3199 (@code{wl-summary-prev})
3203 @findex wl-summary-down
3204 Move cursor to the downward message which is unread or marked
3206 In the offline mode, cursor is not moved to the messages which are not cached
3208 If there are messages which have target mark @samp{*} in the summary,
3209 cursor is moved to the downward message which have a target mark.
3210 This behavior is changed according to the value of @code{wl-summary-move-order}.
3211 (@code{wl-summary-down})
3215 @findex wl-summary-up
3216 Move cursor to the upward message which is unread or marked
3218 In the offline mode, cursor is not moved to the messages which are not cached
3220 If there are messages which have target mark @samp{*} in the summary,
3221 cursor is moved to the downward message which have a target mark.
3222 This behavior is changed according to the value of @code{wl-summary-move-order}.
3223 (@code{wl-summary-up})
3227 @findex wl-summary-write
3228 Prepare a new draft.
3229 (@code{wl-summary-write})
3233 @findex wl-summary-write-current-folder
3234 Prepare a new draft. If the current folder is NNTP folder,
3235 @samp{Newsgroups:} field is completed. If the current folder is mailing
3236 list folder (refile destination), guess @samp{To:} field and completed
3237 (If @code{wl-subscribed-mailing-list} is valid list)
3238 (@code{wl-summary-write-current-folder})
3242 @findex wl-summary-redisplay-all-header
3243 Redisplay the message at current cursor point with all header fields.
3244 (@code{wl-summary-redisplay-all-header})
3248 @findex wl-summary-redisplay-no-mime
3249 Redisplay the message at current cursor point without MIME analysis.
3250 (@code{wl-summary-redisplay-no-mime})
3254 @findex wl-summary-burst
3255 If the message at current cursor point has
3256 encapsulates multiple messages using MIME,
3257 de-capsulate and extract them on the current folder.
3258 If it is invoked in non-writable folder or it is called with prefix
3259 argument, it asks the destination folder.
3260 (@code{wl-summary-burst})
3263 @kindex @@ (Summary)
3264 @findex wl-summary-edit-addresses
3265 Append/change/delete the message's sender information to the address
3266 book @file{~/.addresses} interactively. If this command is called with
3267 prefix argument, arbitrary address can be edited.
3268 (@code{wl-summary-edit-petname})
3272 @findex wl-status-update
3273 Sync up address book status with @file{~/.addresses}'s content.
3274 (@code{wl-status-update})
3278 @findex wl-summary-pipe-message
3279 Pipe current message's content to the external process.
3280 (@code{wl-summary-pipe-message})
3284 @findex wl-summary-print-message
3285 Print out current message's content.
3286 It uses @code{ps-print} module in Emacs 20.x.
3287 If you don't use color printer, you might want to set
3288 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3291 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3294 (@code{wl-summary-print-message})
3298 @findex wl-summary-exit
3299 Exit current folder.
3300 (@code{wl-summary-exit})
3304 @findex wl-summary-jump-to-current-message
3305 Jump cursor to the currently displayed message's window.
3306 (@code{wl-summary-jump-to-current-message})
3310 Jump cursor to the other message.
3311 @findex wl-summary-jump-to-msg
3312 (@code{wl-summary-jump-to-msg})
3316 Update summary status and
3317 prefetch all messages which have marks included in the
3318 @code{wl-summary-incorporate-marks}.
3319 @findex wl-summary-incorporate
3320 (@code{wl-summary-incorporate})
3323 @kindex M-j (Summary)
3324 @findex wl-summary-jump-to-msg-by-message-id
3325 Jump cursor to the message which have specified @samp{Message-Id:}. If
3326 @code{elmo-use-database} is non-nil, other folder is also searched.
3327 (@code{wl-summary-jump-to-msg-by-message-id})
3331 Jump to parent message.
3332 @findex wl-summary-jump-to-parent-message
3333 (@code{wl-summary-jump-to-parent-message})
3337 @findex wl-summary-mark-as-unread
3338 Mark as unread the message at current cursor point.
3339 (@code{wl-summary-mark-as-unread})
3343 @findex wl-summary-sync
3344 Synchronize summary view after prompting the update range.
3345 You can specify one of the follows.
3349 all Discard present msgdb and retrieve all informations.
3350 Do not retrieve killed messages.
3351 all-entirely Discard present msgdb and retrieve all informations.
3352 Retrieve killed messages, too.
3353 update Update the difference between informations in present
3354 msgdb and in current folder instance.
3355 Do not retrieve killed messages.
3356 update-entirely Update the difference between informations in present
3357 msgdb and in current folder instance.
3358 Retrieve killed messages, too.
3359 rescan Redisplay summary by rescanning present msgdb.
3360 rescan-noscore Redisplay summary by rescanning present msgdb.
3361 Display messages killed by score, too.
3362 cache-status Sync the all marks with the real status of cache.
3365 first:NUM Move to the filter folder(partial filter).
3366 last:NUM Move to the filter folder(partial filter).
3371 (@code{wl-summary-sync})
3375 @findex wl-summary-sort
3377 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3378 (@code{wl-summary-sort})
3382 @findex wl-summary-toggle-thread
3383 Toggle the threading. The state will be preserved after exiting
3384 Wanderlust. You can alter default state for newly created summary
3385 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3386 Threading status is displayed on the modeline.
3387 @samp{@{S@}} means threading is off (Sequence) and
3388 @samp{@{T@}} means threading is on (Thread).
3389 (@code{wl-summary-toggle-thread})
3393 @findex wl-summary-toggle-disp-folder
3394 Toggle displaying of folder window.
3395 (@code{wl-summary-toggle-disp-folder})
3399 Toggle displaying of message window.
3400 @findex wl-summary-toggle-disp-msg
3401 (@code{wl-summary-toggle-disp-msg})
3405 Move to the virtual folder (filter folder) with the condition specified.
3406 If called with prefix argument and current folder is virtual, exit it.
3407 @findex wl-summary-virtual
3408 (@code{wl-summary-virtual})
3411 @kindex @key{TAB} (Summary)
3412 @findex wl-summary-goto-last-displayed-msg
3413 Jump to the message which is displayed last.
3414 (@code{wl-summary-goto-last-displayed-msg})
3418 Put @samp{*} mark on the messages that satisfies the specified condition.
3419 @findex wl-summary-pick
3420 (@code{wl-summary-pick})
3424 @findex wl-summary-mark-as-read
3425 Mark as read the message at the current cursor point.
3426 (@code{wl-summary-mark-as-read})
3430 Execute action for all temporary marks in the summary buffer.
3431 @findex wl-summary-exec
3432 (@code{wl-summary-exec})
3436 @findex wl-summary-target-mark-line
3437 Put target mark on the message at the current cursor point.
3438 (@code{wl-summary-target-mark-line})
3442 Put refile mark on the message at the current cursor point.
3443 @findex wl-summary-refile
3444 (@code{wl-summary-refile})
3447 @kindex C-o (Summary)
3448 Execute auto refile.
3449 @findex wl-summary-auto-refile
3450 (@code{wl-summary-auto-refile})
3454 Put copy mark on the message at the current cursor point.
3455 @findex wl-summary-copy
3456 (@code{wl-summary-copy})
3459 @kindex M-o (Summary)
3460 Put refile mark on the message at the current cursor point with the destination
3461 previously specified.
3462 @findex wl-summary-refile-prev-destination
3463 (@code{wl-summary-refile-prev-destination})
3467 @findex wl-summary-dispose
3468 Put disposal mark on the message at the current cursor point.
3469 The result of disposal is controlled by @code{wl-dispose-folder-alist},
3470 refiled to @code{wl-trash-folder} by default.
3471 (@code{wl-summary-dispose})
3475 @findex wl-summary-delete
3476 Put force deletion mark on the message at the current cursor point.
3477 (@code{wl-summary-delete})
3481 Put prefetch reservation mark on the message at the current cursor point.
3482 @findex wl-summary-prefetch
3483 (@code{wl-summary-prefetch})
3487 @findex wl-summary-resend
3488 Put resend reservation mark on the message at the current cursor point.
3489 (@code{wl-summary-resend})
3493 @findex wl-summary-unmark
3494 Unmark the temporal mark on the message at the current cursor point.
3495 (@code{wl-summary-unmark})
3499 Unmark all the temporal marks.
3500 @findex wl-summary-unmark-all
3501 (@code{wl-summary-unmark-all})
3504 @kindex r R (Summary)
3505 @findex wl-summary-mark-as-read-region
3506 Mark as read messages in the specified region.
3507 (@code{wl-summary-mark-as-read-region})
3510 @kindex r $ (Summary)
3511 @findex wl-summary-mark-as-important-region
3512 Put @samp{important} flag on messages in the specified region.
3513 If already flagged as @samp{important}, remove the flag.
3514 (@code{wl-summary-mark-as-important-region})
3517 @kindex r F (Summary)
3518 @findex wl-summary-set-flags-region
3519 Put arbitrary global flag entered in the minibuffer on messages in
3521 (@code{wl-summary-set-flags-region})
3524 @kindex r ! (Summary)
3525 @findex wl-summary-mark-as-unread-region
3526 Mark as unread messages in the specified region.
3527 (@code{wl-summary-mark-as-unread-region})
3530 @kindex r x (Summary)
3531 @findex wl-summary-exec-region
3532 Execute action for each temporary marks on the messages in the
3534 (@code{wl-summary-exec-region})
3537 @kindex r * (Summary)
3538 @findex wl-summary-target-mark-region
3539 Put target mark on the messages in the specified region.
3540 (@code{wl-summary-target-mark-region})
3543 @kindex r o (Summary)
3544 @findex wl-summary-refile-region
3545 Put refile mark on the messages in the specified region.
3546 (@code{wl-summary-refile-region})
3549 @kindex r O (Summary)
3550 @findex wl-summary-copy-region
3551 Put copy mark on the messages in the specified region.
3552 (@code{wl-summary-copy-region})
3555 @kindex r d (Summary)
3556 @findex wl-summary-dispose-region
3557 Put disposal mark on the messages in the specified region.
3558 (@code{wl-summary-dispose-region})
3561 @kindex r i (Summary)
3562 @findex wl-summary-prefetch-region
3563 Put prefetch reservation mark on messages in the specified region.
3564 (@code{wl-summary-prefetch-region})
3567 @kindex r u (Summary)
3568 @findex wl-summary-unmark-region
3569 Delete temporal mark on the messages in the specified region.
3570 (@code{wl-summary-unmark-region})
3573 @kindex r y (Summary)
3574 Save messages in the specified region.
3575 @findex wl-summary-save-region
3576 (@code{wl-summary-save-region})
3579 @kindex t R (Summary)
3580 @findex wl-thread-mark-as-read
3581 Mark as read messages which are the descendant of the current thread.
3582 With prefix argument, it affects on the all messages in the thread tree.
3583 (@code{wl-thread-mark-as-read})
3586 @kindex t $ (Summary)
3587 @findex wl-thread-mark-as-important
3588 Put @samp{important} flag on the messages which are the descendant of
3589 the current thread. If already flagged as @samp{important}, remove the
3590 flag. With prefix argument, it affects on the all messages in the
3592 (@code{wl-thread-mark-as-important})
3595 @kindex t F (Summary)
3596 @findex wl-thread-set-flags
3597 Put arbitrary global flag entered in the minibuffer on the messages
3598 which are the descendant of the current thread. With prefix argument,
3599 it affects on the all messages in the thread tree.
3600 (@code{wl-thread-set-flags})
3603 @kindex t ! (Summary)
3604 @findex wl-thread-mark-as-unread
3605 Mark as unread messages which are the descendant of the current thread.
3606 With prefix argument, it affects on the all messages in the thread tree.
3607 (@code{wl-thread-mark-as-unread})
3610 @kindex t x (Summary)
3611 @findex wl-thread-exec
3612 Execute action for temporary marks on the messages which are
3613 the descendant of the current thread. With prefix argument, it affects
3614 on the all messages in the thread tree.
3615 (@code{wl-thread-exec})
3618 @kindex t * (Summary)
3619 @findex wl-thread-target-mark
3620 Put target mark @samp{*} on the messages which are the descendant of the
3621 current thread. With prefix argument, it affects on the all messages in
3623 (@code{wl-thread-target-mark})
3626 @kindex t o (Summary)
3627 @findex wl-thread-refile
3628 Put refile mark on the messages which are the descendant of the current thread.
3629 With prefix argument, it affects on the all messages in the thread tree.
3630 (@code{wl-thread-refile})
3633 @kindex t O (Summary)
3634 @findex wl-thread-copy
3635 Put copy mark on the messages which are the descendant of the current thread.
3636 With prefix argument, it affects on the all messages in the thread tree.
3637 (@code{wl-thread-copy})
3640 @kindex t d (Summary)
3641 @findex wl-thread-dispose
3642 Put disposal mark on the messages which are the descendant of the current thread.
3643 With prefix argument, it affects on the all messages in the thread tree.
3644 (@code{wl-thread-dispose})
3647 @kindex t i (Summary)
3648 @findex wl-thread-prefetch
3649 Put prefetch reservation mark on messages which are the descendant of
3651 (@code{wl-thread-prefetch})
3654 @kindex t u (Summary)
3655 @findex wl-thread-unmark
3656 Unmark temporal mark on the messages which are the descendant of the
3657 current thread. With prefix argument, it affects on the all messages in
3659 (@code{wl-thread-unmark})
3662 @kindex t y (Summary)
3663 @findex wl-thread-save
3664 Save messages which are the descendant of the current thread.
3665 With prefix argument, it affects on the all messages in the thread tree.
3666 (@code{wl-thread-save})
3669 @kindex m R (Summary)
3670 @findex wl-summary-target-mark-mark-as-read
3671 Mark as read all messages which have target mark @samp{*}.
3672 (@code{wl-summary-target-mark-mark-as-read})
3675 @kindex m $ (Summary)
3676 @findex wl-summary-target-mark-mark-as-important
3677 Put @samp{important} flag on all messages which have target mark @samp{*}.
3678 If already flagged as @samp{important}, remove the flag.
3679 (@code{wl-summary-target-mark-mark-as-important})
3682 @kindex m F (Summary)
3683 @findex wl-summary-target-mark-set-flags
3684 Put arbitrary global flag entered in the minibuffer on all messages
3685 which have target mark @samp{*}.
3686 (@code{wl-summary-target-mark-set-flags})
3689 @kindex m ! (Summary)
3690 @findex wl-summary-target-mark-mark-as-unread
3691 Mark as unread all messages which have target mark @samp{*}.
3692 (@code{wl-summary-target-mark-mark-as-unread})
3695 @kindex m o (Summary)
3696 @findex wl-summary-target-mark-refile
3697 Put refile mark on the messages which have target mark @samp{*}.
3698 (@code{wl-summary-target-mark-refile})
3701 @kindex m O (Summary)
3702 @findex wl-summary-target-mark-copy
3703 Put copy mark on the messages which have target mark @samp{*}.
3704 (@code{wl-summary-target-mark-copy})
3707 @kindex m d (Summary)
3708 @findex wl-summary-target-mark-dispose
3709 Put disposal mark on the messages which have target mark @samp{*}.
3710 (@code{wl-summary-target-mark-dispose})
3713 @kindex m i (Summary)
3714 @findex wl-summary-target-mark-prefetch
3715 Put prefetch reservation mark on messages which have target mark @samp{*}.
3716 (@code{wl-summary-target-mark-prefetch})
3719 @kindex m y (Summary)
3720 @findex wl-summary-target-mark-save
3721 Save messages which have target mark @samp{*}.
3722 (@code{wl-summary-target-mark-save})
3725 @kindex m u (Summary)
3726 Unmark all temporal marks.
3727 (@code{wl-summary-delete-all-temp-marks})
3728 @findex wl-summary-delete-all-temp-marks
3731 @kindex m a (Summary)
3732 Put target mark @samp{*} on the all messages.
3733 (@code{wl-summary-target-mark-all})
3734 @findex wl-summary-target-mark-all
3737 @kindex m t (Summary)
3738 Put target mark @samp{*} on the messages in the current thread.
3739 @findex wl-summary-target-mark-thread
3740 (@code{wl-summary-target-mark-thread})
3743 @kindex m r (Summary)
3744 @findex wl-summary-target-mark-region
3745 Put target mark @samp{*} on the messages in the specified region.
3746 (@code{wl-summary-target-mark-region})
3749 @kindex m A (Summary)
3750 @findex wl-summary-target-mark-reply-with-citation
3751 Prepare a draft which cites all messages which have target mark @samp{*}.
3752 (@code{wl-summary-target-mark-reply-with-citation})
3755 @kindex m f (Summary)
3756 @findex wl-summary-target-mark-forward
3757 Prepare a draft which forwards all messages which have target mark @samp{*}.
3758 (@code{wl-summary-target-mark-forward})
3761 @kindex m U (Summary)
3762 @findex wl-summary-target-mark-uudecode
3763 Uudecode the messages which have target mark @samp{*}.
3764 (@code{wl-summary-target-mark-uudecode})
3767 @kindex m ? (Summary)
3768 @findex wl-summary-target-mark-pick
3769 Pick messages from the @samp{*} marked messages.
3770 That is, @samp{*} marks on the messages are remained
3771 if the specified condition is satisfied.
3772 (@code{wl-summary-target-mark-pick})
3775 @kindex m # (Summary)
3776 @findex wl-summary-target-mark-print
3777 Print out all messages which have target mark @samp{*}.
3778 (@code{wl-summary-target-mark-print})
3781 @kindex m | (Summary)
3782 @findex wl-summary-target-mark-pipe
3783 Pipe content of each message with target mark @samp{*} to some specified
3785 (@code{wl-summary-target-mark-pipe})
3788 @kindex M-t (Summary)
3789 @findex wl-toggle-plugged
3790 Toggle offline/online status of Wanderlust.
3791 (@code{wl-toggle-plugged})
3794 @kindex C-t (Summary)
3795 Start Wanderlust's plug-status manager.
3796 (@code{wl-plugged-change})
3799 @kindex C-c C-o (Summary)
3800 @findex wl-jump-to-draft-buffer
3801 Move to the draft buffer if available. If multiple draft buffer exists,
3802 moved to one after another. If prefix argument is specified, load draft
3803 folder's message to the draft buffer and jump to it.
3804 (@code{wl-jump-to-draft-buffer})
3807 @kindex M-w (Summary)
3808 @findex wl-summary-save-current-message
3809 Save the message at the current cursor point.
3810 (@code{wl-summary-save-current-message})
3813 @kindex C-y (Summary)
3814 @findex wl-summary-yank-saved-message
3815 Regard the message at the current cursor point as
3816 parent, connect the message saved by
3817 @code{wl-summary-save-current-message}
3819 (@code{wl-summary-yank-saved-message})
3822 @kindex C-x C-s (Summary)
3823 @findex wl-summary-save-status
3824 Save the current summary.
3825 (@code{wl-summary-save-status})
3829 @node Variables of Summary, , Key Bindings of Summary, Summary
3830 @section Customiziable variables
3833 @item wl-summary-move-order
3834 @vindex wl-summary-move-order
3835 The initial setting is @code{unread}. Specify cursor moving policy. If
3836 you want to precede new messages, set @code{new}. If you want to
3837 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3840 @item wl-auto-select-first
3841 @vindex wl-auto-select-first
3842 The initial setting is @code{nil}.
3843 If non-nil, first message is automatically displayed when you enter
3846 @item wl-auto-select-next
3847 @vindex wl-auto-select-next
3848 The initial setting is @code{nil}. This controls behavior when there is
3849 no unread message in current summary.
3852 nil: asks whether you want to go back to folder mode
3853 'unread: asks whether you want to go to next unread folder
3854 If the next one comes to be possessing no unread message
3855 by treatment of cross-posted messages or Scoring, then
3856 asks whether you want to go to next to next folder.
3857 'skip-no-unread: similar as unread
3858 But does not ask before going to next to next folder.
3859 otherwise: asks whether you want to go to next unread folder
3862 It might be useful to set @code{'skip-no-unread} for people who
3863 want to continue reading by just pressing and pressing space key.
3865 @item wl-thread-insert-opened
3866 @vindex wl-thread-insert-opened
3867 The initial setting is @code{nil}.
3868 If non-nil, thread is inserted as opened.
3870 @item wl-thread-open-reading-thread
3871 @vindex wl-thread-open-reading-thread
3872 The initial setting is @code{t}. If non-nil, reading thread is
3873 automatically opened though it is closed thread.
3875 @item wl-summary-exit-next-move
3876 @vindex wl-summary-exit-next-move
3877 The initial setting is @code{t}. If non-nil, move to next folder at
3880 @item wl-folder-move-cur-folder
3881 @vindex wl-folder-move-cur-folder
3882 The initial setting is @code{nil}. If non-nil, cursor position on the
3885 @item wl-summary-weekday-name-lang
3886 @vindex wl-summary-weekday-name-lang
3887 Specify language of the weekday.
3888 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3889 displays Deutsch. You should rescan summary view after changing this value.
3891 @item wl-summary-fix-timezone
3892 @vindex wl-summary-fix-timezone
3893 The initial setting is @code{nil}.
3894 Time zone of the date string in summary mode is adjusted using this value.
3895 If @code{nil}, it is adjust to the default time zone information
3896 (system's default time zone or environment variable @samp{TZ}).
3898 @item wl-use-petname
3899 @vindex wl-use-petname
3900 The initial setting is @code{t}.
3901 If non-nil, sender part displays nickname.
3903 @item wl-break-pages
3904 @vindex wl-break-pages
3905 The initial setting is @code{t}.
3906 If non-nil, message is split as pages by @samp{^L}.
3908 @item wl-message-window-size
3909 @vindex wl-message-window-size
3910 The initial setting is '(1 . 4).
3911 A cons cell to specify the rate of summary and message window.
3912 car:cdr corresponds summary:message.
3914 @item wl-summary-from-function
3915 @vindex wl-summary-from-function
3916 Format function to display sender in summary.
3917 The initial setting is @code{wl-summary-default-from}.
3919 @item wl-summary-no-from-message
3920 @vindex wl-summary-no-from-message
3921 The initial setting is @samp{nobody@@nowhere?}. A string which is
3922 displayed when there's no @samp{From:} field in the message.
3924 @item wl-summary-subject-function
3925 @vindex wl-summary-subject-function
3926 Format function to display subject in summary.
3927 The initial setting is @code{wl-summary-default-subject} and
3928 it will cut the list name part etc. on the top of the subject.
3929 To display subject as it is, set as follows.
3932 (setq wl-summary-subject-function 'identity)
3935 @item wl-summary-no-subject-message
3936 @vindex wl-summary-no-subject-message
3937 The initial setting is @samp{(WL:No Subject in original.)}. A string
3938 which is displayed when there's no @samp{Subject:} field in the message.
3940 @item wl-summary-default-view
3941 @vindex wl-summary-default-view
3942 The initial setting is @code{'thread}.
3943 The default state for newly created summary. You can set either
3944 @code{'thread} for thread view or @code{'sequence} for sequential view.
3946 @item wl-summary-use-frame
3947 @vindex wl-summary-use-frame
3948 The initial setting is @code{nil}.
3949 If non-nil, use new frame for the summary.
3951 @item wl-use-folder-petname
3952 @vindex wl-use-folder-petname
3953 The initial setting is the list shown below:
3962 A list of display policy (symbol) of folder nickname. Available symbols
3967 Display folder petname on modeline.
3969 Destination folder is notified as nickname if
3970 @code{wl-auto-select-next} is non-nil.
3972 You can input folder name by nickname in the function
3973 @code{wl-summary-read-folder}.
3976 @item wl-summary-move-direction-toggle
3977 @vindex wl-summary-move-direction-toggle
3978 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3979 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3980 want to aware of reading direction, set this to @code{t}.
3982 @item wl-summary-width
3983 @vindex wl-summary-width
3984 The initial setting is 80.
3985 Width of summary line. If @code{nil}, summary line's width is as is.
3987 @item wl-summary-print-argument-within-window
3988 @vindex wl-summary-print-argument-within-window
3989 The initial setting is @code{nil}.
3990 If non-nil, the action argument is always printed on right side of
3993 @item wl-summary-indent-length-limit
3994 @vindex wl-summary-indent-length-limit
3995 The initial setting is 46.
3996 Specify the limit of thread indent level. @code{nil} means unlimited
3998 If you set this to @code{nil} you should set @code{wl-summary-width}
4001 @item wl-summary-max-thread-depth
4002 @vindex wl-summary-max-thread-depth
4003 The initial setting is 15.
4004 If thread depth of the message is larger than this value,
4005 the thread is divided.
4007 @item wl-summary-recenter
4008 @vindex wl-summary-recenter
4009 The initial setting is t.
4010 If non-nil, cursor point is moved to the center of the summary window.
4012 @item wl-summary-divide-thread-when-subject-changed
4013 @vindex wl-summary-divide-thread-when-subject-changed
4014 The initial setting is @code{nil}. If non-nil, thread is split if
4015 the subject is changed.
4017 @item wl-summary-search-via-nntp
4018 @vindex wl-summary-search-via-nntp
4019 The initial setting is @code{confirm}.
4021 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
4022 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
4023 from the NNTP server @code{elmo-nntp-default-server}. The value of
4024 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
4025 @code{elmo-nntp-default-stream-type} are used.
4027 If @code{confirm}, server name can be specified. You can specify NNTP
4028 folder format like @samp{-:username@@servername:119!}.
4030 @item wl-summary-keep-cursor-command
4031 @vindex wl-summary-keep-cursor-command
4032 The initial setting is the list shown below:
4036 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
4041 When you entered to summary by these commands and the target summary
4042 buffer already exists, summary status is not automatically updated and
4043 cursor position is saved.
4045 @item elmo-folder-update-threshold
4046 @vindex elmo-folder-update-threshold
4047 The initial setting is 500. If updated message number is larger than
4048 this value, confirm whether drop them or not (in the case where the value
4049 of @code{elmo-folder-update-confirm} is non-nil).
4051 @item elmo-folder-update-confirm
4052 @vindex elmo-folder-update-confirm
4053 The initial setting is @code{t}. If the value is non-nil, do check with
4054 @code{elmo-folder-update-threshold}.
4056 @item wl-summary-always-sticky-folder-list
4057 @vindex wl-summary-always-sticky-folder-list
4058 The initial setting is @code{nil}.
4059 @code{wl-summary-always-sticky-folder-list} specifies the folders that
4060 are automatically stuck. Each element is regexp of folder name.
4062 @item wl-summary-reserve-mark-list
4063 @vindex wl-summary-reserve-mark-list
4064 The initial setting is the list shown below:
4068 ("o" "O" "D" "d" "i")
4073 If a message is already marked as temporal marks in this list, the
4074 message is not marked by any mark command.
4076 @item wl-summary-skip-mark-list
4077 @vindex wl-summary-skip-mark-list
4078 The initial setting is the list shown below:
4087 If a message is already marked as temporal marks in this list, the
4088 message is skipped at cursor move.
4090 @item elmo-message-fetch-threshold
4091 @vindex elmo-message-fetch-threshold
4092 The initial setting is 30000 (bytes). If displaying message has larger
4093 size than this value, Wanderlust confirms whether fetch the message or
4094 not (in the case where the value of @code{elmo-message-fetch-confirm}
4097 @item elmo-message-fetch-confirm
4098 @vindex elmo-message-fetch-confirm
4099 The initial setting is @code{t}. If the value is non-nil, do check with
4100 @code{elmo-message-fetch-threshold}.
4102 @item wl-prefetch-threshold
4103 @vindex wl-prefetch-threshold
4104 The initial setting is 30000 (bytes). If prefetching message has larger
4105 size than this value and @code{wl-prefetch-confirm} is non-nil,
4106 Wanderlust confirms whether prefetch the message or not. If
4107 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
4108 without confirmation.
4110 @item wl-prefetch-confirm
4111 @vindex wl-prefetch-confirm
4112 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4113 prefetch the message or not if the message has larger size than
4114 @code{wl-prefetch-threshold}.
4116 @item elmo-imap4-use-cache
4117 @vindex elmo-imap4-use-cache
4118 The initial setting is @code{t}. If non-nil, messages read via IMAP4
4121 @item elmo-nntp-use-cache
4122 @vindex elmo-nntp-use-cache
4123 The initial setting is @code{t}. If non-nil, messages read via NNTP are
4126 @item elmo-pop3-use-cache
4127 @vindex elmo-pop3-use-cache
4128 The initial setting is @code{t}. If non-nil, messages read via POP3 are
4131 @item elmo-shimbun-use-cache
4132 @vindex elmo-shimbun-use-cache
4133 The initial setting is @code{t}. If non-nil, messages read in Shimbun
4136 @item wl-folder-process-duplicates-alist
4137 @vindex wl-folder-process-duplicates-alist
4138 The initial setting is @code{nil}.
4139 This list determines how to deal with duplicated messages in the same folder.
4140 Each item in the list is regexp of folder name and action; you can specify any
4141 one of the following in the place of action:
4144 @code{nil} : do nothing for duplicated messages.
4145 @code{hide} : hide duplicated messages from the summary.
4146 @code{read} : set duplicated messages as read.
4150 Following is an example (hide duplicated messages in multi folders)
4154 (setq wl-folder-process-duplicates-alist
4155 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4156 ("^\\*.*" . hide) (".*" . read)))
4160 @item wl-summary-flag-alist
4161 @vindex wl-summary-flag-alist
4162 The initial setting is as follows:
4166 ((important "orange"))
4170 Specify the color of message in summary buffer with flag. If multiple
4171 global flags are on one message, the former flag in this list is
4172 preferred. It is used as a candidate for complement on entering flags
4177 @node Message, Draft, Summary, Top
4178 @chapter Message Buffer
4180 Message Buffers utilize MIME-View mode of SEMI. For operational
4181 procedures and key bindings, refer to respective documents.
4182 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4183 You can also see help by @kbd{?} in message buffer.
4185 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4186 brings you back to Summary mode. @kbd{l} toggles display of Summary
4189 @section Key Bindings
4195 @findex wl-message-toggle-disp-summary
4196 Toggles display of Summary buffer.
4197 (@code{wl-message-toggle-disp-summary})
4200 @findex wl-message-refer-article-or-url
4201 @kindex Button-2 (Message)
4202 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4203 corresponding message if found.
4204 (@code{wl-message-refer-article-or-url})
4206 @item Button-4 (upward movement of a wheel)
4207 @kindex Button-4 (Message)
4208 @findex wl-message-wheel-down
4209 Scrolls the message backwards. When the top of the message is hit,
4210 moves to the previous message.
4211 (@code{wl-message-wheel-down})
4213 @item Button-5 (downward movement of a wheel)
4214 @kindex Button-5 (Message)
4215 @findex wl-message-wheel-up
4216 Scrolls the message forward. When the bottom of the message is hit,
4217 moves to the next message.
4218 (@code{wl-message-wheel-up})
4222 @findex wl-message-delete-current-part
4223 Delete the part under cursor. In fact it appends modified message to
4224 the current folder then moves old one to trash folder. Therefore the
4225 message number will be changed.
4226 (@code{wl-message-delete-current-part})
4229 @section Customizable Variables
4232 @item wl-message-window-size
4233 @vindex wl-message-window-size
4234 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4235 its car and cdr value corresponds to the ratio of Summary and Message
4238 @item wl-message-ignored-field-list
4239 @vindex wl-message-ignored-field-list
4240 Initial setting is @code{nil}.
4241 All fields that match this list will be hidden in message buffer.
4242 Each elements are regexp of field-name.
4243 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4245 @item wl-message-visible-field-list
4246 @vindex wl-message-visible-field-list
4247 Initial setting is @code{nil}.
4248 All fields that match this list will be display in message buffer.
4249 Each elements are regexp of field-name. This value precedes
4250 @code{wl-message-ignored-field-list}.
4251 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4253 @item wl-message-sort-field-list
4254 @vindex wl-message-sort-field-list
4256 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4257 Header fields in message buffer are ordered by this value.
4258 Each elements are regexp of field-name.
4260 @item wl-message-truncate-lines
4261 @vindex wl-message-truncate-lines
4262 The initial value is the value of @code{default-truncate-lines}.
4263 If it is non-nil, truncate long lines in message buffer.
4266 @node Draft, Disconnected Operations, Message, Top
4267 @chapter Draft Buffer
4269 At Summary mode, pressing @kbd{w} and the like creates a new draft
4270 buffer. You can edit and send mail and news articles in this buffer.
4272 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4273 with those if possible.
4276 * Usage of Draft Mode:: TIPS
4277 * Key Bindings of Draft:: Key bindings
4278 * Variables of Draft Mode:: Customize Draft Mode
4281 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4284 Basically it is Emacs-standard mail mode.
4288 * Editing Message Body::
4289 * Dynamical Message Re-arrangement::
4294 @node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
4295 @subsection Editing Message Header
4297 You can freely edit header region above @samp{--text follows this line--},
4298 until you invoke the sending operation.
4300 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4301 addresses. @kbd{@key{TAB}} completes them.
4303 You can use following headers to specify recipients. Add some of them
4304 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4307 @item @samp{Newsgroups:}
4308 Specify newsgroups to which you post the news article.
4311 Specify addresses to send a copy (Carbon Copy) of the message.
4314 Following ones are removed from the header contents before sending.
4318 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4321 Specify folders in which a copy of the message is saved.
4324 Specify recipients to send encapsulated copy of the message.
4327 You can add initial headers by following variables.
4333 The initial setting is @code{nil}.
4334 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4335 the draft when it is prepared. If function is specified, its return
4340 The initial setting is @code{nil}.
4341 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4342 the draft when it is prepared.
4345 @node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4346 @subsection Editing Messages
4348 As a matter of course, editing message body can be performed in the same
4349 way as usual writing. You may write message body under
4350 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4351 @samp{--text follows this line--} intact.)
4353 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4354 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4355 a MIME user interface for GNU Emacs}.
4356 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4358 If you save the draft buffer you are editing, it is appended to the
4359 folder specified by @code{wl-draft-folder}.
4361 @node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
4362 @subsection Dynamic Modification of Messages
4363 @vindex wl-draft-config-alist
4364 @c @cindex Change Message
4365 @c @cindex Message, Change Dynamic
4367 You can set @code{wl-draft-config-alist} so that header and body of the
4368 message will automatically modified depending on information of header
4371 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4373 In the example below, the header is modified when
4374 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4375 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4376 before sending the message.
4380 (setq wl-draft-config-alist
4381 '(((string-match "aaa\\.example\\.com$" (system-name))
4382 ;; @r{applied if the expression is non-nil}
4383 (wl-smtp-posting-server . "mailserver-B")
4384 (wl-nntp-posting-server . "newsserver-B")
4385 ;; @r{settings of temporary variables}
4387 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4388 ;; @r{applied if it matches the header of the draft buffer}
4389 ("Organization" . (format "Go %s" my-webpage)))
4390 ;; @r{you can write elisp expressions here (eval only)}
4391 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4392 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4397 The format of @code{wl-draft-config-alist} is:
4401 '(("@var{regexp of the header}" or @var{elisp expression}
4402 ("@var{Field}" . value(@var{elisp expression}))
4403 (@var{variable} . value(@var{elisp expression}))
4404 (@var{sub-function} . value(@var{elisp expression}))
4407 ("@var{regexp of the header}" or @var{elisp expression}
4408 ("@var{Field}" . value(@var{elisp expression}))
4413 Per default, there are 13 following sub-functions.
4416 'header: Inserts the specified string at the bottom of the header.
4417 'header-top: Inserts the specified string at the top of the header.
4418 'header-file: Inserts the specified file at the bottom of the header.
4419 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4420 'top: Inserts the specified string at the top of the body.
4421 'top-file: Inserts the specified file at the top of the body.
4422 'body: Replaces the body with the specified string.
4423 Specifying @code{nil} deletes the entire body string.
4424 'body-file: Replaces the body with the content of the specified file.
4425 'bottom: Inserts the specified string at the bottom of the body.
4426 'bottom-file: Inserts the specified file at the top of the body.
4427 'part-top: Inserts the specified string at the top of the current part.
4428 'part-bottom: Inserts the specified string at the bottom of the current part.
4429 'template: Applies the specified template.
4430 (refer to the next subsection)
4433 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4434 change them or add your own functions. If you read the code, you can
4435 easily find how to write the functions.
4437 At the first of each item, @var{a regular expression of the header} or
4438 an @var{elisp expression} should be specified. In the case of an elisp
4439 expression, the item is applied when the expression is evaluated
4442 Per default, when multiple items match or are evaluated non-nil, all
4443 such items are applied, but if you set a variable
4444 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4447 At the second of the item, a cons or a list of functions should be
4448 specified. The car part of the cons should be a header field, a
4449 variable, or a sub-function. When a header field is specified, the
4450 field will be modified. If a variable is specified, the value of the
4451 variable will be modified temporarily.
4453 In the cdr part of a cons, not only a variable but also an elisp
4454 expression can be specified as is. If the car part is a header field
4455 and the cdr part is @code{nil}, the field will be deleted.
4457 See the next example as well:
4461 (setq wl-draft-config-alist
4463 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4464 ;; @r{applied if it matches the header of the buffer being replied}
4465 (body . " Hello.\n")
4466 (template . "default")
4471 As in the (1) above, if a header regexp is prepended with @code{reply},
4472 it is applied when the draft is prepared by @code{wl-summary-reply} for
4473 example, and when it matches the header being replied. It is ignored
4474 when there is no buffer being replied, like after @code{wl-draft} was
4477 If you want to use name of parent folder, you can refer the buffer local
4478 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4479 changes From according to the folder name of the summary in which the draft
4484 (setq wl-draft-config-alist
4485 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4486 (\"From\" . \"user@@domain1\"))
4487 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4488 (\"From\" . \"user@@domain2\"))))
4493 Note that @code{wl-draft-config-alist} is applied only once when
4494 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4495 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4496 aborting transmission, execute @kbd{C-c C-e}
4497 (@code{wl-draft-config-exec}) explicitly.
4499 If you don't want to apply @code{wl-draft-config-alist} when
4500 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4504 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4507 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4508 prepared, do the following:
4511 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4514 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4515 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4519 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4522 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4523 @subsection Inserting Templates
4525 @cindex Apply Template
4527 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4528 @kbd{M-x wl-template-select} in the draft buffer.
4530 The format of @code{wl-template-alist} is almost the same as
4531 @code{wl-draft-config-alist}.
4532 @xref{Dynamical Message Re-arrangement}.
4536 (setq wl-template-alist
4539 ("Organization" . "Example Co.Ltd.")
4540 (body . "Hello.\n"))
4542 (template . "default") ;; @r{(a)}
4543 ("To" . "boss@@example.com")
4544 ("Subject" . "Report")
4545 (body-file . "~/work/report.txt")
4551 As you can see, the only difference is item (template) names such as
4552 @samp{default} and @samp{report}, instead of a regexp of header.
4553 Because definition of each item is the same as
4554 @code{wl-draft-config-alist}, you can call another template, like (a).
4556 Executing the command @code{wl-template-select} results in template
4557 selection, but the result differs depending on variable
4558 @code{wl-template-visible-select}.
4560 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4561 window is shown below the draft buffer. You can select a template by
4562 @kbd{n} and @kbd{p} seeing the buffer window.
4564 Press the @key{RET} key and the template is actually applied to the draft
4565 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4566 adjust the window size by @code{wl-template-buffer-lines}.
4568 If @code{wl-template-visible-select} is @code{nil}, you should type the
4569 name of the template in the mini buffer.
4571 As shown in the example in @code{wl-draft-config-alist}, you can select
4572 @samp{default} template by writing:
4575 (template . "default")
4578 @node POP-before-SMTP, , Template, Usage of Draft Mode
4579 @subsection Sending mail by POP-before-SMTP
4580 @cindex POP-before-SMTP
4582 You can send mail by POP-before-SMTP with this single line:
4585 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4589 Configure the following variables if you need.
4592 @item wl-pop-before-smtp-user
4593 The POP user name for POP-before-SMTP authentication.
4594 If unset, @code{elmo-pop3-default-user} is used.
4596 @item wl-pop-before-smtp-server
4597 The POP server name for POP-before-SMTP authentication.
4598 If unset, @code{elmo-pop3-default-server} is used.
4600 @item wl-pop-before-smtp-authenticate-type
4601 The POP authentication method for POP-before-SMTP authentication.
4602 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4604 @item wl-pop-before-smtp-port
4605 The POP port number for POP-before-SMTP authentication.
4606 If unset, @code{elmo-pop3-default-port} is used.
4608 @item wl-pop-before-smtp-stream-type
4609 If @code{ssl}, POP connection is established using SSL. If
4610 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4611 unset, @code{elmo-pop3-default-stream-type} is used.
4614 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4615 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4617 Therefore, if SMTP server and POP server are actually the same, and if
4618 POP folder per default (such as @samp{&}) is available, no settings are
4621 Refer to the following URL about POP-before-SMTP.
4625 http://spam.ayamura.org/tools/smPbS.html
4626 http://www.iecc.com/pop-before-smtp.html
4631 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4632 @section Key Bindings
4633 @cindex Keybind, Draft Mode
4634 @cindex Keybind, Draft Buffer
4639 @kindex C-c C-y (Draft)
4640 @findex wl-draft-yank-original
4641 Cites the content of the current message buffer (the part under cursor).
4642 If the region is active, cites the region (it affects only if
4643 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4644 (on XEmacs) is Non-nil).
4645 (@code{wl-draft-yank-original})
4648 @kindex C-c C-p (Draft)
4649 @findex wl-draft-preview-message
4650 Previews the content of the current draft.
4651 This is useful for previewing MIME multi-part messages.
4652 (@code{wl-draft-preview-message})
4655 @kindex C-c C-s (Draft)
4656 @findex wl-draft-send
4657 Sends the content of the current draft. Does not erase the draft buffer.
4658 This is useful for sending multiple messages, which are a little different
4660 (@code{wl-draft-send})
4663 @kindex C-c C-c (Draft)
4664 @findex wl-draft-send-and-exit
4665 Sends the content of the current draft and erases the draft buffer.
4666 (@code{wl-draft-send-and-exit})
4669 @kindex C-x C-s (Draft)
4670 @findex wl-draft-save
4671 Save the current draft.
4672 (@code{wl-draft-save})
4675 @kindex C-c C-k (Draft)
4676 @findex wl-draft-kill
4677 Kills the current draft.
4678 (@code{wl-draft-kill})
4681 @kindex C-x k (Draft)
4682 @findex wl-draft-mimic-kill-buffer
4683 Kills the current draft.
4684 (@code{wl-draft-mimic-kill-buffer})
4687 @kindex C-c C-z (Draft)
4688 @findex wl-draft-save-and-exit
4689 Saves the current draft, and erases the draft buffer.
4690 This is useful if you want to suspend editing of the draft.
4691 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4692 the @samp{+draft} folder.
4693 (@code{wl-draft-save-and-exit})
4696 @kindex C-c C-r (Draft)
4697 @findex wl-caesar-region
4698 Encodes or decodes the specified region in Caesar cipher.
4699 (@code{wl-caesar-region})
4703 @findex wl-draft-highlight-and-recenter
4704 Recenter and rehighlight current draft.
4705 (@code{wl-draft-highlight-and-recenter})
4709 @findex wl-toggle-plugged
4710 Toggles off-line/on-line states of Wanderlust.
4711 (@code{wl-toggle-plugged})
4714 @kindex C-c C-o (Draft)
4715 @findex wl-jump-to-draft-buffer
4716 Jumps to the other draft buffer, if exists.
4717 With prefix argument, reads a file (if any) from the draft folder when
4718 there is no such buffer.
4719 (@code{wl-jump-to-draft-buffer})
4722 @kindex C-c C-e (Draft)
4723 @findex wl-draft-config-exec
4724 Applies @code{wl-draft-config-alist}.
4725 (@code{wl-draft-config-exec})
4728 @kindex C-c C-j (Draft)
4729 @findex wl-template-select
4731 (@code{wl-template-select})
4734 @kindex C-c C-a (Draft)
4736 Enter Address Manager.
4737 @xref{Address Manager}.
4741 @kindex C-c C-d (Draft)
4742 @findex wl-draft-elide-region
4743 Elide the text between point and mark (@code{wl-draft-elide-region}).
4744 The text is killed and replaced with the contents of the variable
4745 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4749 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4750 @section Customizable Variables
4754 @item wl-subscribed-mailing-list
4755 @vindex wl-subscribed-mailing-list
4756 The initial setting is @code{nil}. Mailing lists to which you
4757 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4758 field of a reply draft, removes your own address from
4759 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4760 contained in @samp{To:} or @samp{Cc:} field of a message to be
4761 automatically re-filed, the destination folder will be leaned in
4762 connection with the address.
4768 (setq wl-subscribed-mailing-list
4769 '("wl@@lists.airs.net"
4771 "emacs-mime-ja@@m17n.org"))
4775 @item wl-insert-mail-followup-to
4776 @vindex wl-insert-mail-followup-to
4777 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4778 field is automatically inserted in the draft buffer.
4780 @item wl-insert-mail-reply-to
4781 @vindex wl-insert-mail-reply-to
4782 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4783 field is automatically inserted in the draft buffer.
4785 @item wl-auto-insert-x-face
4786 @vindex wl-auto-insert-x-face
4787 The initial setting is @code{t}. If non-nil and there is an encoded
4788 X-Face string in a file @file{~/.xface} (the value of the variable
4789 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4790 draft buffer. If @code{nil}, it is not automatically inserted.
4792 @item wl-insert-message-id
4793 @vindex wl-insert-message-id
4794 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4795 is automatically inserted on the transmission.
4797 @item wl-message-id-use-wl-from
4798 @vindex wl-message-id-use-wl-from
4799 The initial setting is @code{nil}. If non-nil, the value of
4800 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4802 @item wl-local-domain
4803 @vindex wl-local-domain
4804 The initial setting is @code{nil}. If @code{nil}, the return value of
4805 the function @code{system-name} will be used as the domain part of
4808 If @code{system-name} does not return FQDN (i.e. the full name of the
4809 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4810 to the string of the local domain name without hostname (like
4811 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4812 @samp{.} @code{wl-local-domain} is used as domain part of the
4815 If your terminal does not have global IP, set the value of
4816 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4817 you use invalid @samp{Message-ID:}.)
4819 Moreover, concatenation of @code{system-name} @samp{.}
4820 @code{wl-local-domain} will be used as an argument to the HELO command
4823 @item wl-message-id-domain
4824 @vindex wl-message-id-domain
4825 The initial setting is @code{nil}. If non-nil, this value is used as a
4826 domain part of the @samp{Message-ID:}. If your terminal does not have
4827 global IP address, set unique string to this value (e.x. your e-mail
4830 @item wl-unique-id-suffix
4831 @vindex wl-unique-id-suffix
4832 The initial setting is @samp{.wl}. You can specify the string in generated
4833 Message-ID which appear just before @samp{@@}.
4835 @item wl-draft-config-alist
4836 @vindex wl-draft-config-alist
4837 The initial setting is @code{nil}. Modifies the draft message just
4838 before the transmission. The content of @code{wl-draft-config-alist}
4839 will be automatically applied only once on the transmission. If you
4840 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4843 @item wl-template-alist
4844 @vindex wl-template-alist
4845 The initial setting is @code{nil}.
4846 This variable specifies the template to be applied in the draft buffer.
4848 @item wl-draft-config-matchone
4849 @vindex wl-draft-config-matchone
4850 The initial setting is @code{nil}. If non-nil, only the first matching
4851 item is used when @code{wl-draft-config-alist} is applied. If
4852 @code{nil}, all matching items are used.
4854 @item wl-template-visible-select
4855 @vindex wl-template-visible-select
4856 The initial setting is @code{t}.
4857 If non-nil, you can preview the result of the template selection in
4860 @item wl-template-confirm
4861 @vindex wl-template-confirm
4862 The initial setting is @code{nil}.
4863 If non-nil, asks for confirmation when you press the enter key to select
4864 template while previewing.
4866 @item wl-template-buffer-lines
4867 @vindex wl-template-buffer-lines
4868 The initial setting is 7.
4869 If @code{wl-template-visible-select} is non-nil, this variable specifies
4870 the size of the preview window.
4872 @item wl-draft-buffer-style
4873 @vindex wl-draft-buffer-style
4874 The initial setting is @code{full}.
4875 Style of draft buffer window (except for replying and forwarding).
4876 @code{keep} is to use current window,
4877 @code{full} is to use full frame window,
4878 @code{split} is to split current window and use it.
4879 If some function is specified, it is called with the draft buffer
4882 @item wl-draft-reply-buffer-style
4883 @vindex wl-draft-reply-buffer-style
4884 The initial setting is @code{split}.
4885 Style of draft buffer for replying and forwarding.
4886 @code{keep} is to use message buffer window,
4887 @code{full} is to use full frame window,
4888 @code{split} is to split message buffer window and use it.
4889 If some function is specified, it is called with the draft buffer
4892 @item wl-draft-use-frame
4893 @vindex wl-draft-use-frame
4894 The initial setting is @code{nil}.
4895 If non-nil, use new frame for the draft.
4897 @item wl-draft-truncate-lines
4898 @vindex wl-draft-truncate-lines
4899 The initial value is the value of @code{default-truncate-lines}.
4900 If it is non-nil, truncate long lines in draft buffer.
4904 The initial setting is the value of the variable
4905 @code{user-mail-address}. The value of this variable is inserted as a
4906 @samp{From:} field of the draft when it is prepared.
4908 @item wl-envelope-from
4909 @vindex wl-envelope-from
4910 The initial setting is @code{nil}.
4911 The value of this variable is used for envelope from (MAIL FROM).
4912 If @code{nil}, the address part of @code{wl-from} is used.
4914 @item wl-user-mail-address-list
4915 @vindex wl-user-mail-address-list
4916 The initial setting is @code{nil}.
4917 This is the User's address list. If you have multiple addresses,
4920 @item wl-reply-subject-prefix
4921 @vindex wl-reply-subject-prefix
4922 The initial setting is @samp{Re: }.
4923 In the @samp{Subject:} of the reply draft, this string is prepended to
4924 the @samp{Subject:} of being replied.
4926 @item wl-forward-subject-prefix
4927 @vindex wl-forward-subject-prefix
4928 The initial setting is @samp{Forward: }.
4929 In the @samp{Subject:} of the forwarding draft, this string is prepended
4930 to the @samp{Subject:} of being forwarded.
4932 @item wl-draft-reply-use-address-with-full-name
4933 @vindex wl-draft-reply-use-address-with-full-name
4934 The initial setting is @code{t}.
4935 If non-nil, insert her full name with address when prepare a draft for
4936 reply a message. If it is @code{nil}, insert her address only.
4938 @item wl-draft-enable-queuing
4939 @vindex wl-draft-enable-queuing
4940 The initial setting is @code{t}.
4941 This flag controls off-line transmission. If non-nil, the draft is
4944 @item wl-draft-use-cache
4945 @vindex wl-draft-use-cache
4946 The initial setting is @code{nil}. If the value is non-nil and
4947 @code{wl-insert-message-id} is nil, cache the message which is sent.
4949 @item wl-fcc-force-as-read
4950 @vindex wl-fcc-force-as-read
4951 The initial setting is @code{nil}. If the value is non-nil,
4952 Mark as read the message saved by @samp{Fcc:}.
4954 @item wl-auto-flush-queue
4955 @vindex wl-auto-flush-queue
4956 The initial setting is t.
4957 This flag controls automatic transmission of the queue when Wanderlust
4958 becomes on-line. If non-nil, the queue is automatically transmitted
4959 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4960 manually, press @kbd{F} in the folder mode.
4962 @item wl-ignored-forwarded-headers
4963 @vindex wl-ignored-forwarded-headers
4964 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4965 All headers that match this regexp will be deleted when forwarding a message.
4967 @item wl-ignored-resent-headers
4968 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4969 All headers that match this regexp will be deleted when resending a message.
4971 @item wl-draft-always-delete-myself
4972 @vindex wl-draft-always-delete-myself
4973 If non-nil, always removes your own address from @samp{To:} and
4974 @samp{Cc:} when you are replying to the mail addressed to you.
4976 @item wl-draft-delete-myself-from-bcc-fcc
4977 @vindex wl-draft-delete-myself-from-bcc-fcc
4978 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4979 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
4981 @item wl-smtp-posting-server
4982 @vindex wl-smtp-posting-server
4983 The initial setting is @code{nil}.
4984 This is the SMTP server name for mail transmission.
4986 @item wl-smtp-posting-port
4987 @vindex wl-smtp-posting-port
4988 The initial setting is @code{nil}.
4989 This is the SMTP port number for mail transmission.
4990 If @code{nil}, default SMTP port number (25) is used.
4992 @item wl-smtp-posting-user
4993 @vindex wl-smtp-posting-user
4994 The initial setting is @code{nil}.
4995 This is the user name for SMTP AUTH authentication. If @code{nil},
4996 @code{smtp-authenticate-user} is used.
4998 @item wl-smtp-authenticate-type
4999 @vindex wl-smtp-authenticate-type
5000 The initial setting is @code{nil}.
5001 This is the authentication method for SMTP AUTH authentication. If
5002 @code{nil}, @code{smtp-authenticate-type} is used. If
5003 @code{smtp-authenticate-type} is still @code{nil}, authentication will
5006 @item wl-smtp-connection-type
5007 @vindex wl-smtp-connection-type
5008 The initial setting is @code{nil}.
5009 This variable specifies how to establish SMTP connections.
5010 If @code{nil}, use default connection type.
5011 If it is @code{starttls}, use STARTTLS (RFC2595).
5012 If it is @code{ssl}, use SSL.
5014 @item wl-nntp-posting-server
5015 @vindex wl-nntp-posting-server
5016 The initial setting is @code{nil}.
5017 This is the NNTP server name used for news submission.
5018 If @code{nil}, @code{elmo-nntp-default-server} is used.
5020 @item wl-nntp-posting-user
5021 @vindex wl-nntp-posting-user
5022 The initial setting is @code{nil}.
5023 This is the user name for AUTHINFO authentication on news submission.
5024 If @code{nil}, @code{elmo-nntp-default-user} is used.
5025 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
5027 @item wl-nntp-posting-port
5028 @vindex wl-nntp-posting-port
5029 The initial setting is @code{nil}.
5030 This is the port number of the NNTP server used for news submission.
5031 If @code{nil}, @code{elmo-nntp-default-server} is used.
5033 @item wl-nntp-posting-stream-type
5034 @vindex wl-nntp-posting-stream-type
5035 The initial setting is @code{nil}.
5036 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If @code{ssl},
5037 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
5038 connection will be established.
5040 @item wl-nntp-posting-function
5041 @vindex wl-nntp-posting-function
5042 The initial setting is @code{elmo-nntp-post}.
5043 This is the function to post NNTP message.
5045 @item wl-nntp-posting-config-alist
5046 @vindex wl-nntp-posting-config-alist
5047 The initial setting is @code{nil}.
5048 The value takes an alist to define NNTP server like following example.
5049 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
5053 (setq wl-nntp-posting-config-alist
5054 '((",?gmane\\." . "news.gmane.org")
5056 ((server . "news-server")
5057 (user . "newsmaster")
5059 (function . elmo-nntp-post)))
5060 (".*" . "default-news-server")))
5064 @item wl-pop-before-smtp-user
5065 @vindex wl-pop-before-smtp-user
5066 The initial setting is @code{nil}.
5067 This is the POP user name for POP-before-SMTP.
5068 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
5070 @item wl-pop-before-smtp-server
5071 @vindex wl-pop-before-smtp-server
5072 The initial setting is @code{nil}.
5073 This is the POP server name for POP-before-SMTP.
5074 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
5076 @item wl-pop-before-smtp-authenticate-type
5077 @vindex wl-pop-before-smtp-authenticate-type
5078 The initial setting is @code{nil}.
5079 This is the authentication method for POP-before-SMTP authentication.
5080 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
5082 @item wl-pop-before-smtp-port
5083 @vindex wl-pop-before-smtp-port
5084 The initial setting is @code{nil}.
5085 This is the POP port number for POP-before-SMTP. If it is @code{nil},
5086 @code{elmo-pop3-default-port} is used.
5088 @item wl-pop-before-smtp-stream-type
5089 @vindex wl-pop-before-smtp-stream-type
5090 The initial setting is @code{nil}.
5091 This flag controls the use of SSL for POP-before-SMTP. If it is
5092 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{ssl},
5093 SSL is used. If @code{starttls}, STARTTLS (RFC2595) connection will be
5096 @item wl-draft-queue-save-variables
5097 @vindex wl-draft-queue-save-variables
5098 Specifies a list of variable to which queued messages are saved on the
5099 off-line transmission.
5101 @item wl-draft-sendlog
5102 @vindex wl-draft-sendlog
5103 The initial setting is @code{t}.
5104 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
5108 @item drafts are sent by smtp or qmail
5109 @item saved into folders by fcc
5110 @item saved into folders by queuing
5113 (it is written even if the transmission fails).
5114 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
5115 and left to the logging function of @command{imput}.
5118 @item wl-draft-sendlog-max-size
5119 @vindex wl-draft-sendlog-max-size
5120 The initial setting is 20000 (in bytes).
5121 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
5122 beyond the size specified by this variable.
5126 The initial setting is @code{nil}.
5127 If non-nil, address completion uses LDAP.
5129 @item wl-ldap-server
5130 @vindex wl-ldap-server
5131 The initial setting is @samp{localhost}.
5132 LDAP server name for address completion.
5135 @vindex wl-ldap-port
5136 The initial setting is @code{nil}.
5137 If non-nil, the value is used as port number.
5140 @vindex wl-ldap-base
5141 The initial setting is @samp{c=US}.
5142 LDAP search starting point (base) for address completion.
5144 @item wl-draft-remove-group-list-contents
5145 @vindex wl-draft-remove-group-list-contents
5146 The initial setting is @code{t}.
5147 If non-nil, remove the group-lists' members in the recipients when
5148 sending the message (group-list means the description such as
5149 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5152 @node Disconnected Operations, Expire and Archive, Draft, Top
5153 @chapter Off-line Management
5154 @cindex Disconnected Operations
5156 Wanderlust has on-line and off-line states.
5159 * Off-line State:: Wanderlust has on-line and off-line states
5160 * Enable Operations:: Enable Disconnected Operations
5161 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5162 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5163 * Variables of Plugged Mode:: Customize Plugged Mode
5167 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5168 @section Off-line State
5170 Wanderlust has on-line and off-line states. In the off-line state, you
5171 cannot access messages via network, unless they are cached.
5173 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5174 in the mode line indicates the off-line state. In folder or summary
5175 modes, press @kbd{M-t} to switch between off- and on-line.
5177 You can invoke Wanderlust in the off-line state by setting
5178 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5180 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5181 ignores uncached messages.
5184 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5185 @section Enable Disconeected Operations
5187 Even in the off-line state, provided that relevant messages are cached,
5188 and the variable @code{elmo-enable-disconnected-operation} (described
5189 later) is non-nil, you can following operations:
5190 @xref{Plugged Mode}, @xref{Off-line State settings}.
5193 * Send Messages off-line:: Transmit Messages
5194 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5195 * Creation of Folders:: Create Folders off-line (IMAP4)
5196 * Marking:: Mark (IMAP4)
5197 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
5200 As soon as Wanderlust becomes on-line, such operations invoked off-line
5201 are reflected in the servers via network.
5204 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5205 @subsection Transmission of Messages
5207 You can proceed sending operation for mail/news messages while you are
5208 off-line, then it will be reserved for sending (if you are using
5209 @file{im-wl.el}, it is irrelevant).
5210 Messages reserved for sending while off-line are accumulated in the
5211 queue folder, @samp{+queue}. These messages are transmitted at once when
5212 Wanderlust becomes on-line.
5214 You can visit @samp{+queue} in the off-line state and confirm content of
5215 messages in the queue. You can also remove messages. Removed messages
5216 are not transmitted even in the on-line state.
5219 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5220 @subsection Re-file and Copy (IMAP4)
5222 Re-file and copy operations to IMAP folders invoked during the off-line
5223 state are accumulated in the queue, and reflected in the server side
5224 when Wanderlust becomes on-line. If you visit destination folders after
5225 off-line re-file or copy, it looks as if messages were appended even in
5228 For the safety reasons, messages re-filed off-line are removed from
5229 source folders only if their @samp{Message-ID:} match messages on the
5230 servers. While the queue is processed, messages that failed to be
5231 re-filed or copied to the specified folders are appended to the folder
5235 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5236 @subsection Creation of Folders (IMAP4)
5238 You can create IMAP folders off-line. The creation of folders are
5239 reflected in the servers when Wanderlust becomes on-line. If the creation
5240 of those folders fails at that time for some reasons, messages
5241 to be re-filed into those are appended to the folder @samp{+lost+found}
5245 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5246 @subsection Marking (IMAP4)
5248 Off-line changes in unread/read and importance mark @samp{$} information
5249 are also reflected in the servers when Wanderlust becomes on-line.
5252 @node Pre-fetching Reservations, , Marking, Enable Operations
5253 @subsection Pre-fetching (IMAP4, NNTP)
5255 You can make reservations for pre-fetching messages in IMAP or NNTP
5256 folders. Reserved messages are marked with @samp{!} but not cached
5257 yet. When Wanderlust becomes on-line, they are pre-fetched from
5260 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5261 these off-line operations for IMAP4 and NNTP do not take place, and
5262 off-line re-file, copy or suchlike simply results in error.
5264 Because off-line operations use cache files, it is a bad idea to erase
5265 them by hand; it may cause Wanderlust to malfunction.
5267 If you want to remove caches, be sure to execute @kbd{M-x
5268 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5269 remove caches for messages relevant to off-line operations.
5272 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5273 @section Switching On-line/Off-line per Server/Port
5275 @kbd{M-t} described above switches networking states as a whole, but you
5276 can switch on-line/off-line per server/port.
5278 Pressing @kbd{C-t} in the folder or summary modes brings you in
5279 wl-plugged-mode shown below, in which you can change the plugged state
5284 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5287 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5288 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5290 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5291 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5297 The first line indicates status of the following three variables, and
5298 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5299 column modifies the values of these variables.
5303 "Queuing" @code{wl-draft-enable-queuing}
5304 "AutoFlushQueue" @code{wl-auto-flush-queue}
5305 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5309 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5312 The second and after lines indicate on-line/off-line states of servers
5313 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5314 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5315 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5317 @dfn{sending queue} means messages accumulated in the folder
5318 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5319 off-line operations when @code{elmo-enable-disconnected-operation} is
5321 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5322 @c off-line operations are enabled.
5324 They are displayed if there are any of them. In the example above, in
5325 the sending queue there are two messages (the first and the second in
5326 the queue folder) for smtp to hosta and one (the third) for nntp to
5327 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5330 If you change @samp{(wl-plugged)} in the second line, the variable
5331 @code{wl-plugged} is changed, so that the mode line indicator and
5332 plugged states of all ports are affected. If you change plugged states
5333 of any servers or ports, @samp{(wl-plugged)} in the second line is
5334 affected depending on @code{elmo-plugged-condition} settings and the
5335 plugged state of each port.
5338 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5339 @section Invoking Wanderlust in the Off-line State
5341 As described before, if you set @code{wl-plugged} to @code{nil} in
5342 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5343 off-line state. You can specify off-line state on a per server or port
5344 basis. Refer to @code{wl-reset-plugged-alist} also.
5346 Usually, when Wanderlust starts up, the plugged state of each port is
5347 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5348 @code{wl-nntp-posting-server} and so on. If you want to change the
5349 plugged state of these ports or to add other ports, configure
5350 @code{wl-make-plugged-hook} with a function.
5354 (add-hook 'wl-make-plugged-hook
5356 (elmo-set-plugged plugged-value(t/nil) server port)
5357 ;; @r{add or change plugged states of the port of the server}
5358 (elmo-set-plugged plugged-value(t/nil) server)
5359 ;; @r{if the port is omitted, all ports are affected}
5360 ;; @r{(you cannot omit the port if you newly add the server)}
5366 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5367 @section Customizable Variables
5372 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5373 mode from the beginning.
5375 @item wl-queue-folder
5376 @vindex wl-queue-folder
5377 The initial setting is @samp{+queue}.
5378 This is the folder in which messages in the transmission queue are
5381 @item wl-auto-flush-queue
5382 @vindex wl-auto-flush-queue
5383 The initial setting is @code{t}.
5384 This flag controls automatic transmission of the queue when Wanderlust
5385 becomes on-line. If non-nil, the queue is automatically transmitted
5386 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5387 manually, press @kbd{F} in the folder mode.
5389 @item elmo-enable-disconnected-operation
5390 @vindex elmo-enable-disconnected-operation
5391 The initial setting is @code{t}. Controls off-line operations
5392 regarding IMAP4. If non-nil, off-line operations are carried out.
5394 @item elmo-lost+found-folder
5395 @vindex elmo-lost+found-folder
5396 The initial setting is @samp{+lost+found}.
5397 This is the folder to which messages are saved when they fails to be
5398 appended while the off-line re-file/copy queue is processed.
5400 @item elmo-plugged-condition
5401 @vindex elmo-plugged-condition
5402 The initial setting is @code{one}.
5403 The value of @code{wl-plugged} reflects the return value of the function
5404 @code{elmo-plugged-p} (without arguments).
5405 This variable @code{elmo-plugged-condition} specifies the condition on
5406 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5407 plugged state of each port.
5410 'one : plugged if one or more ports are plugged.
5411 'all : plugged if all ports are plugged.
5412 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5413 states of the ports.
5414 @var{function} : reflects the return value of the @var{function}
5415 functions available per default
5416 'elmo-plug-on-by-servers
5417 : reflects the plugged state of the servers specified by the
5418 variable elmo-plug-on-servers.
5419 'elmo-plug-on-by-exclude-servers
5420 : reflects the plugged state of the servers that are not
5421 in elmo-plug-on-exclude-servers.
5422 elmo-plug-on-exclude-servers defaults to
5425 (system-name)without the domain part)
5431 (setq elmo-plugged-condition 'all)
5433 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5434 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5436 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5437 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5441 @item wl-reset-plugged-alist
5442 @vindex wl-reset-plugged-alist
5443 The initial setting is @code{t}. If non-nil, plugged states are
5444 initialized on a per server or port basis when Wanderlust starts up.
5446 If @code{nil}, plugged states are retained while Emacs is running. In
5447 other words, they are initialized when Emacs is restarted even if the
5448 value is @code{nil}.
5452 @node Expire and Archive, Scoring, Disconnected Operations, Top
5453 @chapter Automatic Expiration and Archiving of Messages
5454 @cindex Expire and Archive
5457 * Expire:: Expiration and Archiving
5458 * Archive:: Archiving All Messages
5462 @node Expire, Archive, Expire and Archive, Expire and Archive
5464 @cindex Expire Message
5466 Expiration means deletion of old messages which have outlasted a
5467 certain period of time.
5469 @code{wl-expire} supports not only simple deletion, but also moving to
5470 specified archiving folders.
5474 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5475 or @kbd{M-e} in the summary mode.
5477 @subsection Configuring @code{wl-expire-alist}
5479 An example configuration of @code{wl-expire-alist} is shown below.
5480 Everything in this @code{wl-expire-alist} makes a great difference in
5481 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5482 to @code{t}, especially in the initial stage.
5486 (setq wl-expire-alist
5487 '(("^\\+trash$" (date 14) remove)
5489 ("^\\+tmp$" (date 7) trash)
5490 ;; @r{re-file to @code{wl-trash-folder}}
5491 ("^\\+outbox$" (number 300) "$outbox;lha")
5492 ;; @r{re-file to the specific folder}
5494 ;; @r{do not expire}
5495 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5496 ;; @r{archive by message number (retaining numbers)}
5497 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5498 ;; @r{archive by a fixed number (retaining numbers)}
5499 ("^\\+diary$" (date 30) wl-expire-archive-date)
5500 ;; @r{archive by year and month (numbers discarded)}
5505 Items in the list has the format of:
5508 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5512 The folder is examined if it matches @var{regexp-for-folders} from the
5513 beginning of the list. If you invoke expiration on the folder that does
5514 not match any of them, nothing will happen. And if either the second or
5515 the third element of the item is @code{nil}, expiration will not take
5518 You can use any one of the following for
5519 @var{specification-of-message-to-be-deleted}:
5522 @item (number @var{n1} [@var{n2}])
5523 deletes messages depending on the number of messages in the folder.
5525 @var{n1} is the number of messages which should survive deletion, for example
5526 if its value is 500, the newest 500 messages survive and the rests are
5529 @var{n2} is the number of messages in the folder on which expiration should
5530 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5531 folders with 510 or more messages are expired.
5532 If you configured automatic expiration, frequently used folders may
5533 expire every time it receive messages, and you may be annoyed with the
5534 long delay in reading mail.
5535 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5536 expiration would not take place until a certain number of messages
5539 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5540 with important/new/unread) are not deleted.
5541 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5542 will expire so as to have 500 messages including such ones.
5543 Otherwise, it will have 500 messages except such ones.
5545 @item (date @var{d1})
5546 deletes messages depending on the dates.
5548 Messages dated @var{d1} or more days ago are deleted, for example if its
5549 value is seven, messages seven days old or more are deleted. Note that
5550 the date is the one in the @samp{Date:} field of the message, not when
5551 the message entered the folder.
5553 Messages with no or invalid @samp{Date:} field does not expire; you
5554 might have to delete them by hand.
5557 You can use any one of the following in the place of @var{destination}:
5561 deletes the messages instantly.
5564 hide the messages from summary (messages are not deleted).
5567 moves the messages to @code{wl-trash-folder}.
5569 @item @var{string}(folder)
5570 moves the messages to the folder specified with @var{string}.
5572 It would be useful for specifying an archiving folder, but because this
5573 does not move important messages, it might be better to use the
5574 standard functions described below.
5576 @item @var{function}
5577 invokes the specified @var{function}.
5579 To the @var{function}, three arguments are passed: a folder name, a list
5580 of messages to be deleted, and msgdb information of the summary. You
5581 can specify function-specific arguments after the name of the
5582 @var{function}. Note that the list contains messages with marks in
5583 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5586 These are four standard functions; three of them move messages to an archive
5587 folder in the specified way. This means old messages can be compressed
5588 and saved in a file, being deleted from the original folder.
5589 The last one divides messages to some MH folders.
5592 @item wl-expire-archive-number1
5593 re-files to archiving folders corresponding to the message numbers of
5594 the messages being deleted. For example, a message numbered 102 will be
5595 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5596 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5597 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5599 The archiving folders to which messages are re-filed are determined by
5600 the name of the folder as follows (in this case, archiving folders are
5601 handled as if @code{elmo-archive-treat-file} were non-nil).
5604 @item If the folder type is localdir:
5605 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5607 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5608 (@file{~/Mail/ml/wl-00100.zip}).
5610 @item The folder type is other than localdir:
5611 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5613 For example, @samp{%#mh/ml/wl} corresponds to
5614 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5617 As you can see, in the case of localdir, the folder type is not included
5618 in the path name, but otherwise it is included.
5619 And you can control the prefix to the archiving folder name by
5620 @code{wl-expire-archive-folder-prefix}.
5621 Refer to @code{wl-expire-archive-folder-prefix} for details.
5623 @item wl-expire-archive-number2
5624 re-files every certain number of messages to archiving folders.
5626 This differs from @samp{wl-expire-archive-number1} in that this re-files
5627 to the folder up to the specified number regardless of message numbers.
5628 The archiving folders to which messages are re-filed are determined in the
5629 same way as @code{wl-expire-archive-number1}.
5631 @item wl-expire-archive-date
5632 re-files messages depending on its date (year and month) to archive
5635 For example, a message dated December 1998 is re-filed to
5636 @code{$folder-199812;zip}. The name of the archiving folders except the
5637 date part are determined in the same way as
5638 @code{wl-expire-archive-number1}.
5641 You can set the first argument to these three standard functions to non-nil
5642 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5643 For example, it can be specified just after the name of the function:
5646 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5649 If you omit the argument, consecutive numbers from 1 are assigned for
5650 each archiving folder.
5652 @item wl-expire-localdir-date
5653 divedes messages depending on its date (year and month) to MH folders
5654 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5658 @subsection Treatment for Important or Unread Messages
5660 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5661 standard function, messages with marks in
5662 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5663 messages} thereafter) are retained.
5665 Per default, this variable include the important, new, and unread marks,
5666 so that messages with these marks are not removed.
5667 Note that you cannot include the temporary mark (i.e. temporary marks
5668 are removed anyway), and be sure to process temporary marks before you
5671 @subsection Auto Expiration
5673 The following setup invokes expiration when you move into the summary
5674 mode. There will be no confirmation, so make sure you made no mistake
5675 in regexp and other settings before you set up this.
5679 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5683 In the folder mode, you can invoke expiration per group as well as per
5684 folder. Therefore, if you specify @samp{Desktop} group, all folders
5685 matching @code{wl-expire-alist} expire.
5689 @subsection Treating archive folders.
5690 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5691 you must set non-nil value to @code{elmo-archive-treat-file}.
5693 @subsection Confirming
5695 If you are to use @code{remove}, try @code{trash} at first and see
5696 messages move to @code{wl-trash-folder} as expected, then replace it
5697 with @code{remove}. It would be dangerous to use @code{remove} from the
5700 If you are to use @code{wl-expire-archive-number1} and the like, try to
5701 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5702 you can append messages to it. Even if settings in
5703 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5704 would not be saved anywhere and disappeared in case the archiver program
5707 After you make sure you can archive to the folder correctly, you can
5708 invoke expiration and utilize the log.
5710 If you set @code{wl-expire-use-log} to @code{t},
5711 @file{~/.elmo/expired-log} should contain the log, for example:
5715 delete +ml/wl (593 594 595 596 597 598 599)
5716 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5720 The first column indicates the operation, i.e. @samp{delete},
5721 @samp{copy}, or @samp{move}. The next is the name of the folder that
5722 expired. In the case of @samp{copy} and @samp{move}, the destination
5723 folder is recorded after @samp{->}. The last is the list of message
5724 numbers that are actually deleted or moved (in the case of @samp{copy}
5725 and @samp{move}, the number is the one in the source folder, rather than
5726 the destination folder).
5728 @subsection Re-filing Reserved Messages
5730 The three standard functions copy reserved messages to the archive
5731 folder, but do not delete them from the source folder. Because
5732 reserved messages and the like always remain, they are recorded in
5733 @file{~/.elmo/expired-alist} so that they are not copied over and over
5734 again. They are not recorded if copied by @code{wl-summary-archive}.
5736 If you enabled logging, usually @samp{move} is recorded for re-filing,
5737 but instead @samp{copy} and @samp{delete} are recorded separately if
5738 reserved messages are involved. This is because it actually copies
5739 messages including reserved, then deletes ones except reserved in that
5742 @section Customizable Variables
5745 @item wl-expire-alist
5746 @vindex wl-expire-alist
5747 The initial setting is @code{nil}.
5748 This variable specifies folders and methods to expire. For details,
5749 refer to @code{wl-expire-alist} settings above.
5751 @item wl-summary-expire-reserve-marks
5752 @vindex wl-summary-expire-reserve-marks
5753 The initial setting is the list below.
5757 (list wl-summary-important-mark
5758 wl-summary-new-uncached-mark
5759 wl-summary-new-cached-mark
5760 wl-summary-unread-mark
5761 wl-summary-unread-uncached-mark
5762 wl-summary-unread-cached-mark)
5766 Messages with these marks are retained in the folder, even after
5768 Only permanent marks can be listed, not temporary marks.
5770 You can list marks one by one as in the default; you can use the
5771 following settings as well:
5775 All messages with permanent marks are retained,
5776 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5780 All messages are handled as usual ones that are already read, no matter
5781 what marks they have; even important messages are deleted.
5784 @item wl-expire-archive-files
5785 @vindex wl-expire-archive-files
5786 The initial setting is 100.
5787 This variable specifies the number of messages to be retained in one
5790 @item wl-expire-number-with-reserve-marks
5791 @vindex wl-expire-number-with-reserve-marks
5792 The initial setting is @code{nil}.
5793 If non-nil, if expiring messages are specified by @code{number},
5794 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5796 @item wl-expire-archive-get-folder-function
5797 @vindex wl-expire-archive-get-folder-function
5798 The initial setting is @code{wl-expire-archive-get-folder}.
5800 This variable specifies a function that returns the name of an archiving
5801 folder for standard functions in the place of @var{destination}.
5802 You can use the following three variables for simple modification of
5803 folder names; if you want more complex settings, define your own
5804 function in this variable.
5806 @code{wl-expire-archive-get-folder} can be customized by these
5809 @item @code{wl-expire-archive-folder-name-fmt}
5810 @item @code{wl-expire-archive-folder-type}
5811 @item @code{wl-expire-archive-folder-prefix}
5814 @item wl-expire-archive-folder-name-fmt
5815 @vindex wl-expire-archive-folder-name-fmt
5816 The initial setting is @samp{%s-%%05d;%s}.
5817 This is a @code{format} string for archiving folders used in
5818 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5819 Note that you must specify the message number by @samp{%%d}, because it
5820 is parsed twice by @code{format}.
5822 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5825 @item wl-expire-archive-date-folder-name-fmt
5826 @vindex wl-expire-archive-date-folder-name-fmt
5827 The initial setting is @samp{%s-%%04d%%02d;%s}.
5828 This is a @code{format} string for archiving folders used in
5829 @code{wl-expire-archive-date}. Note that you must specify the message
5830 number by @samp{%%d}, because it is parsed twice by @code{format}.
5831 There should be @samp{%%d} twice, one for the year and the other for the
5834 If you modify this, adjust
5835 @code{wl-expire-archive-date-folder-num-regexp} as well.
5837 @item wl-expire-archive-folder-type
5838 @vindex wl-expire-archive-folder-type
5839 The initial setting is @code{zip}.
5840 This variable specifies an archiver type of the archiving folders.
5842 @item wl-expire-archive-folder-prefix
5843 @vindex wl-expire-archive-folder-prefix
5844 The initial setting is @code{nil}.
5845 This variable specifies the prefix (directory structure) to archiving
5847 Exercise extreme caution in using this feature, as it has not been
5849 In the worst case, there is a fear of destructing archiving folders.
5853 There will be no prefix.
5856 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5857 @samp{$ml/wl-00000;zip;wl}.
5860 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5863 @samp{$ml/wl-00000;zip;ml/wl}.
5866 @item wl-expire-archive-folder-num-regexp
5867 @vindex wl-expire-archive-folder-num-regexp
5868 The initial setting is @samp{-\\([-0-9]+\\);}.
5869 This variable specifies the regular expression to be used for getting
5870 message numbers from multiple archiving folders specified by
5871 @code{elmo-list-folders}.
5872 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5874 @item wl-expire-archive-date-folder-num-regexp
5875 @vindex wl-expire-archive-date-folder-num-regexp
5876 The initial setting is @samp{-\\([-0-9]+\\);}.
5877 This is the regular expression to be used for getting message numbers
5878 from multiple archiving folders specified by @code{elmo-list-folders}.
5879 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5881 @item wl-expire-delete-oldmsg-confirm
5882 @vindex wl-expire-delete-oldmsg-confirm
5883 The initial setting is @code{t}.
5884 If non-nil, messages older than the one with the largest number will be
5885 deleted with confirmation.
5886 If @code{nil}, they are deleted without confirmation.
5888 This feature is valid only if non-nil is specified as a argument to the
5889 standard functions so as to retain numbers.
5891 @item wl-expire-use-log
5892 @vindex wl-expire-use-log
5893 The initial setting is @code{nil}.
5894 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5895 They are appended but not truncated or rotated automatically; you might
5896 need to remove it manually.
5898 @item wl-expire-add-seen-list
5899 @vindex wl-expire-add-seen-list
5900 The initial setting is @code{t}.
5902 If non-nil, when messages are re-filed by expiration, read/unread
5903 information is passed to the destination folder.
5905 However if you do not read the destination folder from Wanderlust,
5906 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5907 want to set this to @code{nil} if you are simply saving to some
5908 archiving folders. Even if its value is @code{nil}, messages in the
5909 archiving folders are simply treated as unread; it does not affect
5912 @item wl-expire-folder-update-msgdb
5913 @vindex wl-expire-folder-update-msgdb
5914 The initial setting is @code{t}.
5915 If @code{t}, in the folder mode, expiration is carried out after
5916 updating summary information. If you specified a list of regular
5917 expressions of folder names, summary information is updated for matching
5922 @node Archive, , Expire, Expire and Archive
5923 @section Archiving Messages
5925 @subsection Archiving Messages
5926 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5927 folders. If there are the archiving folders already, only new messages
5930 You can use @code{wl-archive-alist} in order to specify how messages are
5931 archived according to their folder names, as in @code{wl-expire-alist}.
5936 (setq wl-archive-alist
5937 '(("^\\+tmp$" wl-archive-date)
5938 ("^\\+outbox$" wl-archive-number2)
5939 (".*" wl-archive-number1)))
5943 Each item in the list has the following format:
5946 (@var{folders-regexp} @var{deleting-function})
5949 As you can see, you can only use a function after @var{folders-regexp}.
5950 Per default, there are three functions:
5953 @item @code{wl-archive-number1}
5954 @item @code{wl-archive-number2}
5955 @item @code{wl-archive-date}
5958 As inferred from their names, they work similarly to "expire" versions,
5959 other than the following points:
5962 @item No messages are deleted
5963 @item Message numbers are retained even if invoked without arguments
5966 These functions are good to archive all messages in a folder by their
5967 numbers or by their dates.
5968 These are also useful for backup or confirmation purposes before
5970 If you try to re-file them after they are archived, they are deleted but
5973 Per default, the archiving folders to which messages are copied are
5974 determined automatically by @code{wl-expire-archive-get-folder-function}.
5975 You can copy to a specific folder by invoking with a prefix argument,
5976 i.e. @kbd{C-u M-x wl-summary-archive}.
5978 Note that this feature has not been seriously tested, because you can
5979 simply copy to an archiving folder, for example by
5980 @code{wl-summary-copy-region}.
5982 The archiving folders are determined by the same logic as in
5983 @code{wl-summary-expire}; the following customizable variables are
5987 @item @code{wl-expire-archive-files}
5988 @item @code{wl-expire-archive-get-folder-function}
5989 @item @code{wl-expire-archive-folder-name-fmt}
5990 @item @code{wl-expire-archive-folder-type}
5991 @item @code{wl-expire-archive-folder-prefix}
5992 @item @code{wl-expire-archive-folder-num-regexp}
5995 @subsection Customizable Variables
5998 @item wl-archive-alist
5999 @vindex wl-archive-alist
6000 The initial setting is the list shown below:
6004 ((".*" wl-archive-number1))
6009 This variable specifies a function that copies to archiving folders.
6010 To the function, three arguments are passed: a folder name, a list of
6011 messages in the folder, and msgdb information of the summary.
6012 Needless to say, you can use your own function.
6016 @node Scoring, Split messages, Expire and Archive, Top
6017 @chapter Score of the Messages
6019 @c @cindex Kill File
6021 Scoring is the function that associates a score (value) with each
6022 message, and marks as read or deletes from the summary according to it.
6024 You can put target or important marks on essential messages, or read marks
6025 on the ones you do not want to read, for example spam articles.
6027 This scoring function has a capability and a format similar to the one
6028 that Gnus has, although there are some unsupported features and
6029 Wanderlust specifics.
6030 @xref{Scoring, , ,gnus, The gnus Newsreader}.
6033 * Score Commands:: Score Commands
6034 * Score File Format:: Score File Format
6038 @node Score Commands, Score File Format, Scoring, Scoring
6039 @section Score Commands
6040 @cindex Score Commands
6042 @subsection Score File Specification
6044 @code{wl-score-folder-alist} specifies score files or variables in which
6045 scores are defined, corresponding to folder names.
6049 (setq wl-score-folder-alist
6058 If paths to the score files are omitted, the directory specified in the
6059 variable @code{wl-score-files-directory} is assumed.
6061 No matter what you write in @code{wl-score-folder-alist}, the default
6062 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
6063 read (it does not have to exist).
6064 Therefore, in the example above, the three score files,
6065 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
6066 the folders that matches @samp{^-.*}.
6068 @subsection Scored Messages
6070 Scores are attached to the messages that are specified by
6071 @code{wl-summary-score-marks} temporarily when the summary is updated;
6072 when you exit from the summary, the scores are removed and reverts to
6075 @subsection Creation of Score Files
6077 In the summary buffer, move to an appropriate message and type @kbd{L}.
6078 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
6079 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
6081 This makes @minus{}1000 are scored for messages with the same
6082 @samp{Subject:} as the string you entered. That is, such a score file
6083 is created automatically.
6085 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
6086 The score file you just made appears.
6087 This buffer is called @dfn{score editing buffer} thereafter.
6088 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
6089 as you are previously; type @kbd{a}. Then a score entry for "From"
6091 In this way, you can create a score file easily either in the summary
6092 buffer or in the score editing buffer.
6094 By the way, you might be aware the numbers of key strokes are different
6095 between @kbd{s s p} and @kbd{a}.
6096 This is determined by @code{wl-score-header-default-entry}.
6097 This variable specifies the default score entries corresponding to
6099 For example, for "subject" field, a type and a time limit are prompted,
6100 but for "from" field, they are fixed upon automatically as substring and
6101 permanent respectively.
6102 However, score values can be modified by the prefix argument.
6103 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
6106 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
6107 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
6108 erasing contents of the buffer deletes the score file being edited.
6112 @subsubsection Selecting Score Files
6114 You can change score files to which scores are appended by
6115 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
6116 @code{wl-score-change-score-file}.
6118 @subsubsection Summing Up the Score
6120 If you add the same entries by @code{wl-summary-increase-score},
6121 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
6122 scores for the entry is summed up.
6124 For example, if you create @samp{from} entry with the score of @minus{}1000 by
6125 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
6126 @minus{}1200 will be created as a result.
6128 @subsubsection Creating Thread Key
6130 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
6131 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6133 @subsubsection Creating Followup Key
6135 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6136 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6137 at the cursor to @samp{References} key.
6138 If @code{wl-score-auto-make-followup-entry} is non-nil,
6139 @samp{Message-ID} of all messages to be followed up within dates
6140 specified by @code{wl-score-expiry-days}.
6142 @subsection Key Bindings
6147 @findex wl-summary-increase-score
6148 Increases the score for the current message.
6149 And the score entry is appended to the score file at the same moment.
6150 You can specify the score value by a prefix argument.
6154 @findex wl-summary-lower-score
6155 Decreases the score for the current message.
6156 And the score entry is appended to the score file at the same moment.
6157 You can specify the score value by a prefix argument.
6160 @kindex h R (Summary)
6161 @findex wl-summary-rescore
6162 Re-applies the scoring.
6163 However, already scored messages are not scored anew.
6166 @kindex h c (Summary)
6167 @findex wl-score-change-score-file
6168 Changes the score file currently selected.
6171 @kindex h e (Summary)
6172 @findex wl-score-edit-current-scores
6173 Edits the score file currently selected.
6174 If there are multiple score files, the previously specified one is
6178 @kindex h f (Summary)
6179 @findex wl-score-edit-file
6180 Edits an arbitrary score file and selects it.
6183 @kindex h F (Summary)
6184 @findex wl-score-flush-cache
6185 Erases caches associated to the score files that are read.
6186 If you modified score files directly (from other than Wanderlust), you
6187 need to re-read them after erasing the cache.
6190 @kindex h m (Summary)
6191 @findex wl-score-set-mark-below
6192 Specifies the criterion for scores to be marked as read.
6193 Messages with scores less than this value are marked as read.
6196 @kindex h x (Summary)
6197 @findex wl-score-set-expunge-below
6198 Specifies the criterion for scores to be deleted from the summary.
6199 Messages with scores less than this value are deleted.
6200 "Deleted" means it is not shown; they are not removed from the summary
6201 information or the folder.
6202 The deleted messages can be shown by rescan-noscore again.
6205 @subsection Key Bindings in the Score Editing Buffer
6209 @kindex C-c C-k (Score Mode)
6210 @findex wl-score-edit-kill
6211 Abandons the file being edited.
6214 @kindex C-c C-c (Score Mode)
6215 @findex wl-score-edit-exit
6216 Saves the file being edited, and quits from the edit mode.
6219 @kindex C-c C-p (Score Mode)
6220 @findex wl-score-pretty-print
6224 @kindex C-c C-d (Score Mode)
6225 @findex wl-score-edit-insert-date
6226 Inserts the number of dates from Dec. 31, 1 B.C.
6227 It is used for creating the third factor of time-limited scores.
6230 @kindex C-c C-s (Score Mode)
6231 @findex wl-score-edit-insert-header
6232 Inserts the header of the message selected in the summary buffer.
6235 @kindex C-c C-e (Score Mode)
6236 @findex wl-score-edit-insert-entry
6237 Inserts the score entry of the message selected in the summary buffer.
6240 @subsection Customizable Variables
6243 @item wl-summary-default-score
6244 @vindex wl-summary-default-score
6245 The initial setting is 0 (zero).
6246 This variable specifies the default value of the score.
6247 The score is increased or decreased based upon this value.
6249 @item wl-summary-important-above
6250 @vindex wl-summary-important-above
6251 The initial setting is @code{nil}.
6252 Messages with scores larger than this value are attached with the
6253 important mark (@samp{$}).
6254 If @code{nil}, no important marks are attached.
6256 @item wl-summary-target-above
6257 @vindex wl-summary-target-above
6258 The initial setting is @code{nil}.
6259 Messages with scores larger than this value are attached with the target
6261 If @code{nil}, no target marks are attached.
6263 @item wl-summary-mark-below
6264 @vindex wl-summary-mark-below
6265 The initial setting is 0 (zero).
6266 Messages with scores smaller than this value are marked as read.
6268 @item wl-summary-expunge-below
6269 @vindex wl-summary-expunge-below
6270 The initial setting is @code{nil}.
6271 Messages with scores smaller than this value are deleted from the
6273 If @code{nil}, they are not deleted.
6275 @item wl-summary-score-marks
6276 @vindex wl-summary-score-marks
6277 The initial setting is the list shown below:
6281 (list wl-summary-new-uncached-mark
6282 wl-summary-new-cached-mark)
6287 Messages with these marks are scored.
6289 @item wl-use-scoring
6290 @vindex wl-use-scoring
6291 The initial setting is t.
6292 If non-nil, scoring is enabled.
6294 @item wl-score-files-directory
6295 @vindex wl-score-files-directory
6296 The initial setting is @file{~/.elmo/}.
6297 The default directory for score files.
6299 @item wl-score-interactive-default-score
6300 @vindex wl-score-interactive-default-score
6301 The initial setting is 1000.
6302 This value is used as a score when a score factor is @code{nil} in the
6303 score file. It is also used in @code{wl-summary-increase-score} and
6304 @code{wl-summary-lower-score}, on condition that the value of
6305 @code{wl-score-header-default-entry} is @code{nil}.
6307 @item wl-score-expiry-days
6308 @vindex wl-score-expiry-days
6309 The initial setting is 7.
6310 This is the number of days before time-limited scores are deleted.
6312 @item wl-score-update-entry-dates
6313 @vindex wl-score-update-entry-dates
6314 The initial setting is @code{t}.
6315 If non-nil, it enables deletion of time-limited scores.
6317 @item wl-score-header-default-entry
6318 @vindex wl-score-header-default-entry
6319 Specifies the default value for each header field for score entries
6320 created by @code{wl-summary-increase-score},
6321 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6323 @item wl-score-simplify-fuzzy-regexp
6324 @vindex wl-score-simplify-fuzzy-regexp
6325 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6326 regular expression to be deleted from the string.
6327 Because this is usually used for Subject, the default is prefixes that
6328 are attached by mailing list programs.
6330 @item wl-summary-rescore-partial-threshold
6331 @vindex wl-summary-rescore-partial-threshold
6332 The initial setting is 200.
6333 When sync-all or rescan is executed, if there are messages more than
6334 this value, only the last same number of messages as this value are
6337 @item wl-summary-auto-sync-marks
6338 @vindex wl-summary-auto-sync-marks
6339 If non-nil, unread/important marks are synchronized when the summary
6341 Unread marks reflect information on the IMAP4 server.
6342 Important marks reflect information on the IMAP4 server (flagged or
6343 not), and contents of @samp{'mark} folder.
6344 The initial setting is @code{t}.
6348 @node Score File Format, , Score Commands, Scoring
6349 @section Score File Format
6350 @cindex Score File Format
6352 The format of score files are the same as Gnus, and basically you can
6353 use Gnus score files as they are. But they are not fully compatible
6354 because some keys are not supported and there are Wanderlust specifics.
6355 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6360 ("for sale" -1000 nil s)
6361 ("profit" -1000 nil s))
6363 ("spam@@spamspamspam" -10000 nil s))
6365 ("my@@address" 3001 nil s))
6367 (1000000 -10 nil >))
6377 If the key is a string, it is the name of the header to be matched.
6378 The following keys are available:
6379 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6380 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6381 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6382 @code{Chars} and @code{Lines} mean the size and the number of lines of
6383 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6384 are described later.
6385 The rest corresponds the field of the same name.
6387 Arbitrary numbers of core entries are specified after the key.
6388 Each score entry consists of these five factors:
6392 A factor that matches header. This should be a number in the cases of
6393 @code{lines} and @code{chars}, otherwise a string.
6396 A score factor. When the first item matches, the score of the message
6397 is increased or decreased by this value.
6400 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6401 of a number, the score is deleted if it does not match for days
6402 (@code{wl-score-expiry-days}) from the date specified by this.
6403 The date is since Dec. 31, 1 B.C.
6406 A type factor. This specifies the way the first factor matches.
6407 Available types depend on keys.
6410 @item From, Subject, References, Message-ID
6411 For these keys in string, @code{r} and @code{R} (regexp),
6412 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6413 as well as @code{f} and @code{F} (fuzzy) can be used.
6414 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6417 For these keys, the following five numerical relative operators can be
6418 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6421 This key matches @code{From} header, and scores all follow-ups to the
6423 For example, it would be useful for increasing scores for follow-ups to
6426 You can use the same types as @code{From} except for @code{f}.
6427 And a @samp{Followup} entry is automatically appended to the score file.
6430 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6431 A @samp{Thread} entry is automatically appended for each article that
6432 has @var{x} in the @code{References} header.
6433 You can make sure the whole thread including messages that does not have
6434 all ancestors @code{Message-ID} in @code{References} is scored.
6436 You can use the same types as @code{References} except for @code{f}.
6437 And a @samp{Thread} entry is automatically appended to the score file.
6441 A factor for extension header. This is meaningful only if the key is
6443 This specifies headers to be matched other than standard headers like
6444 @code{Subject} and @code{From}.
6445 Note that you should specify the header in
6446 @code{elmo-msgdb-extra-fields} also.
6447 Therefore it does not work in folders where extension headers cannot be
6452 The sum of these scores @emph{after all factors are applied} becomes the
6453 score of the message.
6455 @cindex Score File Atoms
6457 Messages with a score less than this value is marked as read.
6458 The default is @code{wl-summary-mark-below}.
6461 Messages with a score less than this value is deleted from the summary.
6462 The default is @code{wl-summary-expunge-below}.
6464 @item mark-and-expunge
6465 Both @code{mark} and @code{expunge} are applied,
6466 i.e. messages with a score less than this value is marked as read and
6467 deleted from the summary.
6470 Messages with a score greater than this value is attached with temp
6472 The default is @code{wl-summary-target-above}.
6475 Messages with a score greater than this value is attached with important
6477 The default is @code{wl-summary-important-above}.
6482 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6483 are used, you need to set @code{elmo-msgdb-extra-fields}.
6486 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6489 There are other restrictions as shown below:
6492 @item Because @samp{References} field in the summary information
6493 contains only the last @samp{Message-ID}, @code{references} key matches
6497 Keys that can be seen by folder of types:
6501 chars lines xref extra
6502 localdir,localnews Y E E E
6503 nntp (supporting xover) Y E E N
6509 N: cannot be seen (ignored)
6510 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6515 @node Split messages, Address Book, Scoring, Top
6516 @chapter Message splitting
6517 @cindex Split messages
6519 You can use @code{elmo-split} to split message in folder specified by
6520 the variable @code{elmo-split-folder} a la @command{procmail} according
6521 to some specified rules. To use this feature, set as follows in your
6522 @file{~/.emacs} at first.
6525 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
6528 Set source folder like following.
6531 (setq elmo-split-folder "%inbox")
6534 And specify the rule in the variable @code{elmo-split-rule} (its format
6535 will be is described below).
6536 Then you can invoke @kbd{M-x elmo-split} to split messages according to
6537 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
6538 to do a rehearsal and show result (do not split actually).
6541 We will describe how to specify the rule. First of all, see following
6546 (setq elmo-split-rule
6547 ;; @r{Store messages from spammers into @samp{+junk}}
6548 '(((or (address-equal from "i.am@@spammer")
6549 (address-equal from "dull-work@@dull-boy")
6550 (address-equal from "death-march@@software")
6551 (address-equal from "ares@@aon.at")
6552 (address-equal from "get-money@@richman"))
6554 ;; @r{Store messages from mule mailing list into @samp{%mule}}
6555 ((equal x-ml-name "mule") "%mule")
6556 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
6557 ;; @r{and continue evaluating following rules}
6558 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
6559 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
6560 ((match from "\\(.*\\)@@yahoo\\.com")
6562 ;; @r{Store unmatched mails into @samp{+inbox}}
6567 The basic unit of the rule is a combination like
6570 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
6573 If @samp{CONDITION} is true, @samp{ACTION} is performed.
6574 The 1st element @samp{CONDITION} is a condition represented by a
6575 balanced expression (sexp). Its grammar will be explained below.
6576 The 2nd element @samp{ACTION} is the name of the folder to split
6577 messages into, or a symbol. When the 3rd element @code{continue} is
6578 specified as symbol, evaluating rules is not stopped even when the
6579 condition is satisfied.
6581 The grammar for @samp{CONDITION} is as follows. See example above to
6582 learn how to write the condition practically.
6586 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
6587 (@samp{FIELD-NAME} is a symbol that describes the field name)
6591 True if the field value equals to @samp{VALUE}.
6592 Case of the letters are ignored.
6594 True if the field value matches to VALUE.
6595 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6596 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6597 @item @code{address-equal}
6598 True if one of the addresses in the field equals to
6599 @samp{VALUE}. Case of the letters are ignored.
6600 @item @code{address-match}
6601 True if one of the addresses in the field matches to
6603 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6604 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6608 Functions which accept an integer argument (@samp{SIZE}).
6612 True if the size of the message is less than @samp{SIZE}.
6614 True if the size of the message is greater than @samp{SIZE}.
6618 Functions which accept any number of arguments.
6622 True if one of the argument returns true.
6624 True if all of the arguments return true.
6630 When a symbol is specified, it is evaluated.
6633 You can specify followings as 2nd @samp{ACTION}.
6639 If some string is specified, it will be regarded as the destination
6640 folder, and the message will be appended to it.
6645 If the symbol @samp{delete} is specified, delete the substance of the
6646 message in @code{elmo-split-folder}
6651 If the symbol @samp{noop} is specified, do nothing on the message and
6657 If some function is specified, execute it.
6660 If the message passes all rules, it will be dealed along @samp{ACTION}
6661 specified by @code{elmo-split-default-action}.
6664 @node Address Book, Spam Filter, Split messages, Top
6665 @chapter Address Book
6666 @cindex Address Book
6668 With address book, you can utilize address completion, and you have
6669 summary displayed with nicknames.
6672 * Mail Addresses:: Definition of Address Book
6673 * Address Manager:: Address Manager
6677 @node Mail Addresses, Address Manager, Address Book, Address Book
6678 @section Address book
6679 @cindex Address book Definition
6681 @cindex Alias, Address
6683 The file @file{~/.addresses} is a simple address book for Wanderlust.
6684 Make address file @file{~/.addresses}, and edit to suit your requirement.
6686 The data written in @file{~/.addresses} are used for address completion
6687 under draft editing mode. Furthermore, they are used when showing names
6688 in summary display mode. You can safely skip this section, if you don't
6689 want to customize address completion and summary display.
6690 It is possible to add/change/remove addresses from @file{~/.addresses} in
6691 summary buffer after Wanderlust is invoked. @refill
6693 The format is very simple. Like this. @refill
6698 # @r{Lines begin with @samp{#} are comment.}
6699 # @r{Empty lines are ignored}
6701 # @r{Format of each line:}
6702 # @var{email-address} "@var{nickname} "@var{realname}"
6704 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6705 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6706 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6711 One line defines one persons description.
6713 Actually, in default setup, @var{nickname} is used in summary-mode and
6714 @var{realname} is used in draft preparation mode. This behavior is
6715 better understood if you try it and confirmed the function first. You
6716 can write and try a small definition, so you will know the idea of the
6717 address book before writing a big one.
6719 And, if MH alias file is specified in variable @code{wl-alias-file},
6720 it is used as an address information in the draft preparation mode.
6722 If variable @code{wl-use-ldap} is non-nil (initial setting is
6723 @code{nil}), address completion in draft mode uses LDAP information.
6725 If you use LDAP, you have to set @code{wl-ldap-server},
6726 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6727 not have LDAP feature as built-in feature (Currently only XEmacs can
6728 have built-in LDAP feature), you have to set command exec @env{PATH} to
6729 the program @command{ldapsearch}.
6732 @node Address Manager, , Mail Addresses, Address Book
6733 @section Address Manager
6734 @cindex Address Manager
6736 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6737 the address book and insert address to draft buffer.
6739 @subsection Key Bindings
6743 @kindex t (Address Manager)
6744 @findex wl-addrmgr-set-to
6745 Add @samp{To:} mark.
6748 @kindex c (Address Manager)
6749 @findex wl-addrmgr-set-cc
6750 Add @samp{Cc:} mark.
6753 @kindex b (Address Manager)
6754 @findex wl-addrmgr-set-bcc
6755 Add @samp{Bcc:} mark.
6758 @kindex u (Address Manager)
6759 @findex wl-addrmgr-unmark
6763 @kindex x (Address Manager)
6764 @findex wl-addrmgr-apply
6766 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6767 buffer and quit address manager. When no draft buffer, make new draft
6768 with insert marked addresses.
6770 If no mark, quit address manager.
6774 @kindex q (Address Manager)
6775 @findex wl-addrmgr-quit
6776 Quit address manager.
6779 @kindex a (Address Manager)
6780 @findex wl-addrmgr-add
6784 @kindex d (Address Manager)
6785 @findex wl-addrmgr-delete
6789 @kindex e (Address Manager)
6790 @findex wl-addrmgr-edit
6795 @node Spam Filter, Batch Processing, Address Book, Top
6796 @chapter Spam Filter
6799 @code{wl-spam} provides an frontend to external spam filtering programs.
6800 You can register to or judge spam by the filtering program cooperateing
6801 with messages operations on Wanderlust.
6804 * Usage of Spam Filter:: Usage of Spam Filter
6805 * Spam Filter Processors:: Supported spam filters
6808 @node Usage of Spam Filter, Spam Filter Processors, Spam Filter, Spam Filter
6809 @section Usage of Spam Filter
6811 @subsection Initial Setting
6813 To use @code{wl-spam}, write in @file{~/.wl} as follows:
6817 ;; @r{Use @samp{bogofilter} as spam back end}
6818 ;; @r{Set @samp{scheme} here as the spam filter you will use.}
6819 ;; @r{@xref{Spam Filter Processor}}
6820 (setq elmo-spam-scheme 'bogofilter)
6825 @subsection spam mark
6827 The spam mark (@samp{s}) will be provided as new temporary mark.
6828 Messages marked by this will be refiled into @code{wl-spam-folder} when
6829 the action is called for execution. Marked messages will be skipped by
6830 summary walking in ordinary way.
6832 The spam mark is be put on by spam judgement described later, or by
6833 invoking @kbd{k m} at any time.
6835 @subsection spam judgment
6837 You can judge spam messages by following ways:
6841 Make judgement on execution of auto-refile.
6843 Insert @code{wl-refile-guess-by-spam} to arbitrary position in
6844 @code{wl-auto-refile-guess-functions} as follows.
6848 (setq wl-auto-refile-guess-functions
6849 '(wl-refile-guess-by-rule
6850 wl-refile-guess-by-spam))
6854 In this example, judge spam if it could not decide refile destination by
6855 @code{wl-refile-rule-alist}.
6858 Make judgement on entering the summary of specified folder.
6860 Specify the value of @code{wl-spam-auto-check-folder-regexp-list}
6861 as the list of regular expressions for folder names to be
6862 automatically judged by spam filter.
6865 (setq wl-spam-auto-check-folder-regexp-list '("\\+inbox"))
6868 In this example, judgement will be processed when you enter summary of
6869 the folder whose name contains @samp{+inbox}.
6872 Make judgement on splitting messages with @code{elmo-split}.
6874 It provides new function @code{spam-p} to be specified as @samp{CONDITION}
6875 in @code{elmo-split-rule}. This function returns true when the message
6877 @xref{Split messages}
6879 You can also process learning by the result of judgement. (You would
6880 better turn on this feature after learning to some extent)
6886 (setq elmo-split-rule
6887 '(((spam-p) "+spam")
6888 ;; @r{to learn by the judgement, use following instead}
6889 ;((spam-p :register t) "+spam")
6895 @subsection spam learning
6897 @code{wl-spam} automatically learn spam with refiling messages.
6899 At first, @code{wl-spam} classifies the folders controlled by Wanderlust
6900 into following 4 domains by the class of containig messages
6904 Folders containing messages judged as spam.
6905 (The folder specified by @code{wl-spam-folder})
6907 Folders containing messages judged as non-spam.
6909 Folders containing messages not yet judged. Folders without
6910 pre-distribution may belong to this domain e.g. @samp{+inbox}.
6911 (specified by @code{wl-spam-undecided-folder-regexp-list})
6913 Foldes have nothing to do with spam processing e.g.
6914 @code{wl-trash-folder} or @code{wl-draft-folder}. (specified by
6915 @code{wl-spam-ignored-folder-regexp-list})
6918 When you refile messages across different domains, it automatically
6919 learn messages as @samp{spam} or @samp{non-spam} according to domains
6920 it belongs before and after.
6922 To put it concretely, it will learn by following rule:
6925 @item undecide -> spam
6928 learn as spam and cancel previous study as non-spam.
6929 @item undecide -> good
6932 learn as non-spam and cancel previous study as spam.
6935 It do not learn anything in other cases.
6937 @subsection Key Bindings
6938 @cindex Keybind, spam filter
6942 @kindex k m (Summary)
6943 @findex wl-summary-spam
6944 Put spam mark (@samp{s}) on current message.
6947 @kindex k c (Summary)
6948 @findex wl-summary-test-spam
6949 Test current message and put spam mark if judged as spam.
6952 @kindex k C (Summary)
6953 @findex wl-summary-mark-spam
6954 Test messages with the mark in @code{wl-spam-auto-check-marks},
6955 and put spam mark if judged as spam. If it is called with prefix
6956 argument, test all messages regardless of their marks.
6959 @kindex k s (Summary)
6960 @findex wl-summary-register-as-spam
6961 Register current message as spam.
6964 @kindex k S (Summary)
6965 @findex wl-summary-register-as-spam-all
6966 Register all messages in the folder as spam.
6969 @kindex k n (Summary)
6970 @findex wl-summary-register-as-good
6971 Register current message as non-spam.
6974 @kindex k N (Summary)
6975 @findex wl-summary-register-as-good-all
6976 Register all messages in the folder as non-spam.
6979 @kindex m k (Summary)
6980 @findex wl-summary-target-mark-spam
6981 Put spam mark (@samp{s}) on messages with the target mark @samp{*}.
6984 @kindex m s (Summary)
6985 @findex wl-summary-target-mark-register-as-spam
6986 Register messages with the target mark @samp{*} as spam.
6989 @kindex m n (Summary)
6990 @findex wl-summary-target-mark-register-as-good
6991 Register messages with the target mark @samp{*} as non-spam.
6994 @subsection Customizable Variables
6997 @item wl-spam-folder
6998 @vindex wl-spam-folder
6999 Specify the name of destination folder for the spam messages.
7000 The initial setting is @samp{+spam}.
7002 @item wl-spam-undecided-folder-regexp-list
7003 @vindex wl-spam-undecided-folder-regexp-list
7004 Specify the list of regexp of folder names which contain messages
7005 not yet decided as spam or non-spam.
7006 The initial setting is @code{'("inbox")}.
7008 @item wl-spam-ignored-folder-regexp-list
7009 @vindex wl-spam-ignored-folder-regexp-list
7010 The initial setting is as follows.
7014 (list (regexp-opt (list wl-draft-folder
7020 Folders of no effect against spam judgement, specified by the list of
7021 folder name regular expressions.
7023 @item wl-spam-auto-check-folder-regexp-list
7024 @vindex wl-spam-auto-check-folder-regexp-list
7025 Folders to make spam judgement on entering the summary of them,
7026 specified by the list of folder name regular expressions.
7027 The initial setting is @code{nil}.
7029 @item wl-spam-auto-check-marks
7030 @vindex wl-spam-auto-check-marks
7031 The initial setting is the following list:
7035 (list wl-summary-new-uncached-mark
7036 wl-summary-new-cached-mark)
7040 Messages with mark specified by this variable will be processed
7041 by whole-folder judgement including auto test by
7042 @code{wl-spam-auto-check-folder-regexp-list}.
7043 Persistent marks can be used in this method, but temporary marks cannot.
7045 You can specify the list of marks as the initial setting, or you can
7046 specify follwing symbol:
7050 Process all messages regardless of persistent marks.
7055 @node Spam Filter Processors, , Usage of Spam Filter, Spam Filter
7056 @section Supported Spam Filters
7057 @cindex Spam Filter, Bogofilter
7058 @cindex Spam Filter, Spamfilter
7060 Supported spam filtering libraries are following ones.
7063 * bogofilter:: bogofilter
7064 * spamfilter:: spamfilter.el
7065 * bsfilter:: bsfilter
7066 * SpamAssassin:: SpamAssassin
7067 * Regular Expressions Header Matching:: Header regexp
7071 @node bogofilter, spamfilter, Spam Filter Processors, Spam Filter Processors
7072 @subsection bogofilter
7075 bogofilter (@uref{http://bogofilter.sourceforge.net/}) is a spam filter
7076 implemented by C language.
7078 To use spam filter with bogofilter, write following setting in
7079 @file{~/.wl} or somewhere else.
7083 (setq elmo-spam-scheme 'bogofilter)
7087 @subsubsection Customizable Variables
7090 @item elmo-spam-bogofilter-program
7091 @vindex elmo-spam-bogofilter-program
7092 The initial setting is @file{bogofilter}.
7093 Specify the name of executable of bogofilter. If the executable
7094 is not in your environmental variable @env{PATH}, you should
7095 set this by full path.
7097 @item elmo-spam-bogofilter-args
7098 @vindex elmo-spam-bogofilter-args
7099 The initial setting is @code{nil}.
7100 Specify arguments to be supplied for bogofilter executable.
7102 @item elmo-spam-bogofilter-database-directory
7103 @vindex elmo-spam-bogofilter-database-directory
7104 Specify the directory for statistical database to be used.
7105 @code{nil} to use default directory (@file{~/.bogofilter}).
7106 The initial setting is @code{nil}.
7108 @item elmo-spam-bogofilter-max-messages-per-process
7109 @vindex elmo-spam-bogofilter-max-messages-per-process
7110 The initial setting is 30. This variable specifies the number of
7111 messages to be learned by one process.
7113 @item elmo-spam-bogofilter-debug
7114 @vindex elmo-spam-bogofilter-debug
7115 The initial setting is @code{nil}.
7116 If you specify non-nil, the output from @command{bogofilter} is
7117 stored in the buffer named @code{"*Debug ELMO SPAM Bogofilter*"}.
7121 @node spamfilter, bsfilter, bogofilter, Spam Filter Processors
7122 @subsection spamfilter.el
7125 @file{spamfilter.el}
7126 (@uref{http://www.geocities.co.jp/SiliconValley-PaloAlto/7043/}) is a
7127 spam filtering library implemented by Emacs Lisp.
7129 Corresponding modules will be compiled/installed, if you have
7130 @file{spamfilter.el} within @code{load-path} when you are to install wl.
7133 To use @file{spamfilter.el}, write following setting in @file{~/.wl} or
7135 (Of cource, you have to have settings for @file{spamfilter.el} itself)
7139 (setq elmo-spam-scheme 'spamfilter)
7143 @subsubsection Customizable Variables
7146 @item elmo-spam-spamfilter-corpus-filename
7147 @vindex elmo-spam-spamfilter-corpus-filename
7148 The initial setting is @file{~/.elmo/.spamfilter}.
7149 It specifies the name of corpus file.
7152 @node bsfilter, SpamAssassin, spamfilter, Spam Filter Processors
7153 @subsection bsfilter
7156 bsfilter (@uref{http://bsfilter.org/index-e.html}) is a spam filter
7157 implemented by Ruby language.
7159 To use spam filter with bsfilter, write following setting in
7160 @file{~/.wl} or somewhere else.
7164 (setq elmo-spam-scheme 'bsfilter)
7168 @subsubsection Customizable Variables
7171 @item elmo-spam-bsfilter-program
7172 @vindex elmo-spam-bsfilter-program
7173 The initial setting is @file{bsfilter}.
7174 Specify the name of executable of @command{bsfilter}. If the executable
7175 is not in your environmental variable @env{PATH}, you should
7176 set this by full path.
7178 @item elmo-spam-bsfilter-args
7179 @vindex elmo-spam-bsfilter-args
7180 The initial setting is @code{nil}.
7181 Specify arguments to be supplied for bsfilter executable.
7183 @item elmo-spam-bsfilter-database-directory
7184 @vindex elmo-spam-bsfilter-database-directory
7185 Specify the directory for statistical database to be used.
7186 @code{nil} to use default directory (@file{~/.bsfilter}).
7187 The initial setting is @code{nil}.
7189 @item elmo-spam-bsfilter-debug
7190 @vindex elmo-spam-bsfilter-debug
7191 The initial setting is @code{nil}.
7192 If you specify non-nil, the output from @command{bsfilter} is
7193 stored in the buffer named @code{"*Debug ELMO Bsfilter*"}.
7195 @item elmo-spam-bsfilter-shell-program
7196 @vindex elmo-spam-bsfilter-shell-program
7197 The initial setting is @file{ruby}.
7198 Specify the shell to execute @command{bsfilter}. If the shell is not
7199 in your environmental variable @env{PATH}, you should set this by full path.
7201 @item elmo-spam-bsfilter-shell-switch
7202 @vindex elmo-spam-bsfilter-shell-switch
7203 The initial setting is @code{nil}.
7204 Specify options to give to the shell executing @command{bsfilter}.
7206 @item elmo-spam-bsfilter-update-switch
7207 @vindex elmo-spam-bsfilter-update-switch
7208 The initial setting is @code{"--synchronous-auto-update"}.
7209 Specify options to give to @command{bsfilter} for learning messages.
7213 @node SpamAssassin, Regular Expressions Header Matching, bsfilter, Spam Filter Processors
7214 @subsection SpamAssassin
7215 @cindex SpamAssassin
7217 SpamAssassin (@uref{http://spamassassin.org/}) is one of the most
7218 popular spam filtering program implemented on Perl. SpamAssassin
7219 attempts to identify spam using text analysis and several internet-based
7220 realtime blacklists. SpamAssassin also uses a Bayesian learning filter
7221 which enables more accurate spam filtering.
7223 To use @file{SpamAssassin} on Wanderlust, write following setting
7224 in @file{~/.wl} or somewhere else.
7225 (Of course, you have to install SpamAssassin beforehand.)
7229 (setq elmo-spam-scheme 'sa)
7233 @subsubsection Customize Variables
7236 @item elmo-spam-spamassassin-program
7237 @vindex elmo-spam-spamassassin-program
7238 The initial setting is @file{spamassassin}.
7239 Specify the name of executable @command{spamassassin}. If the executable
7240 is not in your environmental variable @env{PATH}, you should
7241 set this by full path.
7243 @item elmo-spam-spamassassin-learn-program
7244 @vindex elmo-spam-spamassassin-learn-program
7245 The initial setting is @file{sa-learn}.
7246 Specify the name of the SpamAssassin's Bayesian filtering learner
7247 program, @command{sa-learn}. If the executable is not in your
7248 environmental variable @env{PATH}, you should set this by full path.
7250 @item elmo-spam-spamassassin-program-arguments
7251 @vindex elmo-spam-spamassassin-program-arguments
7252 The initial setting is @code{'("-e")}.
7253 Specify the arguments to be supplied for @command{spamassassin} executable.
7254 You have to specify the argument to exit the program with an error exit code
7255 when the result is spam. For example, if you want to use @command{spamc}
7256 instead of @command{spamassassin}, you should specify @code{'("-c")}.
7258 @item elmo-spam-spamassassin-learn-program-arguments
7259 @vindex elmo-spam-spamassassin-lern-program-arguments
7260 The initial setting is @code{nil}.
7261 Specify the arguments to be supplied for @command{sa-learn}.
7263 @item elmo-spamassassin-debug
7264 @vindex elmo-spamassassin-debug
7265 The initial setting is @code{nil}.
7266 If you specify @code{t}, the output from @command{spamassassin} is
7267 stored in the buffer named @code{"*Debug ELMO SpamAssassin*"}.
7271 @node Regular Expressions Header Matching, , SpamAssassin, Spam Filter Processors
7272 @subsection Regular Expressions Header Matching
7273 @cindex Regular Expressions Header Matching
7275 Examine if regular expression matches corresponding field in message heaeder,
7276 and decide spam or not. To use this backend, add following setting to @file{~/.wl}.
7280 (setq elmo-spam-scheme 'header)
7284 If you want to check fields not included in the default overview
7285 information, add one into @code{elmo-msgdb-extra-fields}. Then it will
7286 do examination by the overview information and avoid loading whole
7287 message body as far as possible.
7289 @subsubsection Customize Variables
7292 @item elmo-spam-header-good-alist
7293 @vindex elmo-spam-header-good-alist
7294 The initial setting is the following list:
7297 '(("X-Spam-Flag" . "No"))
7300 Specify a list of regular expressions to match with header field name
7301 for making non-spam decision. It takes precedence over
7302 @code{elmo-spam-header-spam-alist}.
7304 @item elmo-spam-header-spam-alist
7305 @vindex elmo-spam-header-spam-alist
7306 The initial setting is the following list:
7309 '(("X-Spam-Flag" . "Yes"))
7312 Specify a list of regular expressions to match with header field name
7313 for making spam decision.
7317 @node Batch Processing, Customization, Spam Filter, Top
7318 @chapter Batch Processing
7319 @cindex Batch Processing
7321 You can request wanderlust to do some job on the command line.
7322 For now, you can invoke prefetching new messages in specified folders.
7324 Specify target folders in @code{wl-batch-prefetch-folder-list} then
7325 invoke as follows to execute prefetching:
7328 emacs -batch -l wl-batch -f wl-batch-prefetch
7331 @section Customize Variables
7334 @item wl-batch-prefetch-folder-list
7335 @vindex wl-batch-prefetch-folder-list
7336 Target folders of prefetching by @code{wl-batch-prefetch}, specified as
7337 a list of folder names.
7341 @node Customization, Migration, Batch Processing, Top
7342 @chapter Customizing Wanderlust
7343 @cindex Customization
7346 * Living with other packages:: Cooperating with other packages
7347 * Highlights:: Highlights
7348 * Biff:: Notify Mail arrival
7349 * Advanced Settings:: Advanced Settings
7350 * Customizable Variables:: Customizable Variables
7355 @node Living with other packages, Highlights, Customization, Customization
7356 @section Living with other packages
7358 Examples with other packages.
7361 * imput:: imput (im-wl.el)
7362 * BBDB:: The Insidious Big Brother Database
7363 * LSDB:: The Lovely Sister Database
7364 * supercite:: supercite.el
7365 * mu-cite:: mu-cite.el
7366 * X-Face:: x-face,bitmap-mule
7367 * dired-dd:: dired-dd.el
7369 * Addrbook:: Addrbook
7370 * mime-w3m:: mime-w3m.el
7374 @node imput, BBDB, Living with other packages, Living with other packages
7379 Place @file{util/im-wl.el} on the @code{load-path} and do the following
7384 (autoload 'wl-draft-send-with-imput-async "im-wl")
7385 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
7390 @node BBDB, LSDB, imput, Living with other packages
7394 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
7395 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
7396 and do the following settings.
7398 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
7399 byte-compiled and installed.
7407 ;; @r{enable pop-ups}
7408 (setq bbdb-use-pop-up t)
7409 ;; @r{auto collection}
7410 (setq bbdb/mail-auto-create-p t)
7411 ;; @r{exceptional folders against auto collection}
7412 (setq bbdb-wl-ignore-folder-regexp "^@@")
7413 (setq signature-use-bbdb t)
7414 (setq bbdb-north-american-phone-numbers-p nil)
7415 ;; @r{shows the name of bbdb in the summary} :-)
7416 (setq wl-summary-from-function 'bbdb-wl-from-func)
7417 ;; @r{automatically add mailing list fields}
7418 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
7419 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
7423 You can complete address with BBDB by @kbd{M-@key{TAB}}
7427 @node LSDB, supercite, BBDB, Living with other packages
7431 The following is an example setting to use
7432 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
7439 (add-hook 'wl-draft-mode-hook
7441 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
7445 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
7446 (complete address with LSDB).
7449 @node supercite, mu-cite, LSDB, Living with other packages
7450 @subsection sc.el(supercite), sc-register.el
7454 The same setting as usual mailers should be OK. The following is an
7455 example of settings:
7459 (autoload 'sc-cite-original "supercite" nil t)
7460 (add-hook 'mail-citation-hook 'sc-cite-original)
7465 @node mu-cite, X-Face, supercite, Living with other packages
7466 @subsection mu-cite.el
7469 The same setting as usual mailers should be OK. The following is an
7470 example of settings.
7472 If you use mu-cite version 8.0 or earlier:
7476 (autoload 'mu-cite/cite-original "mu-cite" nil t)
7477 (setq mail-citation-hook 'mu-cite/cite-original)
7481 If you use mu-cite version 8.1 or later:
7485 (autoload 'mu-cite-original "mu-cite" nil t)
7486 (add-hook 'mail-citation-hook (function mu-cite-original))
7490 @node X-Face, dired-dd, mu-cite, Living with other packages
7494 If you have installed one of the following, you can decode
7495 @samp{X-Face:} field in message buffer and you will see face image.
7498 * x-face-xmas:: XEmacs case
7499 * x-face-mule:: Emacs case
7502 If there is an encoded X-Face string in a file @file{~/.xface} (the
7503 value of the variable @code{wl-x-face-file}), it is inserted as a
7504 @samp{X-Face:} field in the draft buffer (if
7505 @code{wl-auto-insert-x-face} is non-nil).
7507 @node x-face-xmas, x-face-mule, X-Face, X-Face
7508 @subsubsection x-face-xmas (for XEmacs)
7511 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
7512 1.3.6.13 or later, do the following:
7516 (autoload 'x-face-xmas-wl-display-x-face "x-face")
7517 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
7521 @node x-face-mule, , x-face-xmas, X-Face
7522 @subsubsection x-face-mule (for Emacs)
7526 If you use @file{x-face-mule.el} in bitmap-mule
7527 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
7531 (autoload 'x-face-decode-message-header "x-face-mule")
7532 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7536 @subsubsection x-face-e21 (for Emacs 21.x)
7539 With Emacs 21.x, you can use @file{x-face-e21.el}
7540 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
7541 to display X-Face. In this case, bitmap-mule is not required.
7546 (autoload 'x-face-decode-message-header "x-face-e21")
7547 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7552 @node dired-dd, MHC, X-Face, Living with other packages
7553 @subsection dired-dd(Dired-DragDrop)
7554 @pindex Dired-DragDrop
7556 @cindex Drag and Drop
7558 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
7559 compose multi-part by simple Drag-and-Drop from dired to the draft
7560 buffer being edited in GNU Emacs (this feature is not Wanderlust
7561 specific, but general-purpose for SEMI).
7565 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
7571 ;; @r{Set dired-x variables here.}
7572 ;; @r{To and flo@dots{}}
7574 (progn (require 'dired-dd)
7575 (require 'dired-dd-mime))))))
7579 @node MHC, Addrbook, dired-dd, Living with other packages
7583 Message Harmonized Calendaring system
7584 (@uref{http://www.quickhack.net/mhc/})
7586 By using MHC, you can make a calendar from the messages.
7592 (setq mhc-mailer-package 'wl)
7593 (autoload 'mhc-mode "mhc" nil t)
7594 (add-hook 'wl-summary-mode-hook 'mhc-mode)
7595 (add-hook 'wl-folder-mode-hook 'mhc-mode)
7603 (autoload 'mhc-wl-setup "mhc-wl")
7604 (add-hook 'wl-init-hook 'mhc-wl-setup)
7608 @node Addrbook, mime-w3m, MHC, Living with other packages
7609 @subsection wl-addrbook.el
7613 (@uref{http://www.mew.org/})
7615 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
7616 @code{load-path} and do the following settings.
7620 (require 'wl-addrbook)
7625 @node mime-w3m, , Addrbook, Living with other packages
7626 @subsection mime-w3m.el
7629 You can display html part by using @file{mime-w3m.el}
7630 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
7631 You can find the usage in comment region at the head of @file{mime-w3m.el}.
7634 @node Highlights, Biff, Living with other packages, Customization
7637 @subsection Customizable Variables
7640 @item wl-summary-highlight
7641 @vindex wl-summary-highlight
7642 The initial setting is @code{t}.
7643 If non-nil, the summary is highlighted.
7645 @item wl-highlight-max-summary-lines
7646 @vindex wl-highlight-max-summary-lines
7647 The initial setting is 10000.
7648 The summary is not highlighted if it has more lines than this value.
7650 @item wl-summary-highlight-partial-threshold
7651 @vindex wl-summary-highlight-partial-threshold
7652 The initial setting is 1000.
7653 This is a threshold whether the whole summary is highlighted.
7654 If there are more lines of messages in the summary, it is partially
7657 @item wl-summary-partial-highlight-above-lines
7658 @vindex wl-summary-partial-highlight-above-lines
7659 The initial setting is 30. If there are more lines of messages than
7660 @code{wl-summary-highlight-partial-threshold} in the summary, messages
7661 after the point that is the same number of lines as this value above the
7662 cursor line are highlighted partially. (If this value is @code{nil},
7663 the last same number of lines as the value of
7664 @code{wl-summary-highlight-partial-threshold} are highlighted.)
7666 @item wl-highlight-body-too
7667 @vindex wl-highlight-body-too
7668 The initial setting is @code{t}.
7669 If non-nil, bodies of drafts and messages are also highlighted.
7671 @item wl-highlight-message-header-alist
7672 @vindex wl-highlight-message-header-alist
7673 When highlighting headers of drafts and messages, this variable
7674 specifies which faces are allocated to important
7675 (@code{wl-highlight-message-important-header-contents}), secondly
7676 important (@code{wl-highlight-message-important-header-contents2}), and
7677 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7679 Similarly, it can be used for allocating arbitrary faces to arbitrary
7680 regular expressions.
7682 @item wl-highlight-citation-prefix-regexp
7683 @vindex wl-highlight-citation-prefix-regexp
7684 Specifies a regular expression to which quoted lines in bodies of
7685 drafts and messages match.
7686 Bodies matching to this regular expression are highlighted by the faces
7687 specified by (@code{wl-highlight-message-cited-text-*}).
7689 @item wl-highlight-highlight-citation-too
7690 @vindex wl-highlight-highlight-citation-too
7691 The initial setting is @code{nil}.
7692 If non-nil, the quoting regular expression itself given by
7693 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7695 @item wl-highlight-citation-header-regexp
7696 @vindex wl-highlight-citation-header-regexp
7697 Specifies a regular expression that denotes beginning of quotation.
7698 Bodies matching to this regular expression are highlighted by the face
7699 specified by @code{wl-highlight-message-headers}.
7701 @item wl-highlight-max-header-size
7702 @vindex wl-highlight-max-header-size
7703 The initial setting is @code{nil}. If a header size is larger than this
7704 value, it will not be highlighted. If @code{nil}, always highlighted
7705 (ignore header size).
7707 @item wl-highlight-max-message-size
7708 @vindex wl-highlight-max-message-size
7709 The initial setting is 10000.
7710 If a message is larger than this value, it will not be highlighted.
7711 With this variable, highlight is suppressed for uuencode or huge digest
7714 @item wl-highlight-signature-separator
7715 @vindex wl-highlight-signature-separator
7716 Specifies regular expressions that denotes the boundary of a signature.
7717 It can be a regular expression, or a list of ones.
7718 Messages after the place that matches this regular expression are
7719 highlighted by the face specified by
7720 @code{wl-highlight-message-signature}.
7722 @item wl-max-signature-size
7723 @vindex wl-max-signature-size
7724 The initial setting is 400.
7725 This is the largest size for a signature to be highlighted.
7727 @item wl-use-highlight-mouse-line
7728 @vindex wl-use-highlight-mouse-line
7729 The initial setting is @code{t}.
7730 If non-nil, the line pointed by the mouse is highlighted in the folder
7731 mode, summary mode, and the like.
7734 @subsection Setting Colors and Fonts of the Characters
7736 If you want to change colors or fonts of the characters, you need to
7737 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7738 want to change fonts, and @code{set-face-foreground} for colors, and so
7739 on. You cannot write face settings in @file{.emacs}; write in
7742 For example, if you want to change the color for signatures to yellow,
7746 (set-face-foreground 'wl-highlight-message-signature "yellow")
7752 Faces defined in Wanderlust:
7755 @item wl-highlight-message-headers
7756 The face for field names of message headers.
7758 @item wl-highlight-message-header-contents
7759 The face for field bodies of message headers.
7761 @item wl-highlight-message-important-header-contents
7762 The face for important parts of message headers.
7763 Per default, this face is used for a body of @samp{Subject:} field.
7764 You can change its value by editing
7765 @code{wl-highlight-message-header-alist}.
7767 @item wl-highlight-message-important-header-contents2
7768 The face for secondly important parts of message headers.
7769 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7770 fields. You can change its value by editing
7771 @code{wl-highlight-message-header-alist}.
7773 @item wl-highlight-message-unimportant-header-contents
7774 The face for unimportant parts of message headers.
7775 Per default, this face is used for bodies of @samp{X-} fields
7776 @samp{User-Agent:} fields. You can change its value by editing
7777 @code{wl-highlight-message-header-alist}.
7779 @item wl-highlight-message-citation-header
7780 The face for headers of quoted messages.
7782 @item wl-highlight-message-cited-text-*
7783 The face for texts of quoted messages. The last @samp{*} is a
7784 @var{single figure} so that 10 different colors can be used according to
7787 @item wl-highlight-message-signature
7788 The face for signatures of messages. The initial settings are
7789 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7790 dark background colors.
7792 @item wl-highlight-header-separator-face
7793 The face for header separators of draft messages.
7795 @item wl-highlight-summary-important-face
7796 The face for message lines with important marks in the summary.
7798 @item wl-highlight-summary-new-face
7799 The face for message lines with new marks in the summary.
7801 @item wl-highlight-summary-displaying-face
7802 The face for the message line that is currently displayed.
7803 This face is overlaid.
7805 @item wl-highlight-thread-indent-face
7806 The face for the threads that is currently displayed.
7808 @item wl-highlight-summary-unread-face
7809 The face for message lines with unread marks in the summary.
7811 @item wl-highlight-summary-deleted-face
7812 The face for message lines with delete marks in the summary.
7814 @item wl-highlight-summary-refiled-face
7815 The face for message lines with re-file marks in the summary.
7817 @item wl-highlight-refile-destination-face
7818 The face for re-file information part of message lines with re-file
7819 marks in the summary.
7821 @item wl-highlight-summary-copied-face
7822 The face for message lines with copy marks in the summary.
7824 @item wl-highlight-summary-target-face
7825 The face for message lines with target marks @samp{*} in the summary.
7827 @item wl-highlight-summary-thread-top-face
7828 The face for message lines that are on the top of the thread in the
7831 @item wl-highlight-summary-normal-face
7832 The face for message lines that are not on top of the thread in the
7835 @item wl-highlight-folder-unknown-face
7836 The face for folders that are not known to have how many unsync messages
7839 @item wl-highlight-folder-zero-face
7840 The face for folders that have no unsync messages in the folder mode.
7842 @item wl-highlight-folder-few-face
7843 The face for folders that have some unsync messages in the folder mode.
7845 @item wl-highlight-folder-many-face
7846 The face for folders that have many unsync messages in the folder mode.
7847 The boundary between `some' and `many' is specified by the variable
7848 @code{wl-folder-many-unsync-threshold}.
7850 @item wl-highlight-folder-unread-face
7851 The face for folders that have no unsync but unread messages in the
7854 @item wl-highlight-folder-killed-face
7855 The face for folders that are deleted from the access group in the
7858 @item wl-highlight-folder-opened-face
7859 The face for open groups in the folder mode.
7860 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7861 @code{nil} or a @var{number}.
7863 @item wl-highlight-folder-closed-face
7864 The face for close groups in the folder mode.
7865 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7866 @code{nil} or a @var{number}.
7868 @item wl-highlight-folder-path-face
7869 The face for the path to the currently selected folder in the folder
7872 @item wl-highlight-logo-face
7873 The face for logo in the demo.
7875 @item wl-highlight-demo-face
7876 The face for strings (for example, a version number) in the demo.
7880 @node Biff, Advanced Settings, Highlights, Customization
7881 @section Notify Mail arrival
7884 Following setting is to notify mail arrival of @samp{%inbox}
7885 by the indicator on the modeline
7888 (setq wl-biff-check-folder-list '("%inbox"))
7891 @subsection Customizable Variables
7893 @item wl-biff-check-folder-list
7894 @vindex wl-biff-check-folder-list
7895 The initial setting is @code{nil}.
7896 This is the list of folders to check mail arrival.
7897 If @code{nil}, wl doesn't check mail arrival.
7899 @item wl-biff-check-interval
7900 @vindex wl-biff-check-interval
7901 The initial setting is 40 (in seconds).
7902 Check mail arrival in this period.
7904 @item wl-biff-notify-hook
7905 @vindex wl-biff-notify-hook
7906 This hook is run at the arrival of new mail.
7907 To beep with mail arrival(initial setting), set as follows.
7909 (setq wl-biff-notify-hook '(ding))
7911 For silence, set to @code{nil}.
7915 @node Advanced Settings, Customizable Variables, Biff, Customization
7916 @section Advanced Settings
7919 * Draft for Reply:: Draft for Reply
7920 * Thread Format:: Appearance of Thread
7921 * User-Agent Field:: @samp{User-Agent:} Header Field
7925 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
7926 @subsection Draft for Replay
7927 @vindex wl-draft-reply-with-argument-list
7928 @vindex wl-draft-reply-without-argument-list
7929 @vindex wl-draft-reply-myself-with-argument-list
7930 @vindex wl-draft-reply-myself-without-argument-list
7932 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
7933 The addressee for the draft is decided by following rules.
7935 For example, you can set as follows:
7939 (setq wl-draft-reply-without-argument-list
7940 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7941 ("Followup-To" . (nil nil ("Followup-To")))
7942 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7943 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
7947 Where each element of the list @code{wl-draft-reply-without-argument-list}
7951 (key . (to-list cc-list newsgroup-list))
7954 and if the field designated by @samp{key} exist in the parent message,
7955 parent's field values designated by @samp{to-list} are copied to @samp{To:}
7956 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
7957 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
7958 the draft respectively.
7963 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7966 Match if the parent has @samp{Mail-Followup-To} field.
7967 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
7968 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
7972 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7975 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
7976 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
7979 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
7982 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
7983 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
7986 These are evaluated in order and first matched one is used.
7988 Moreover, the behavior of @kbd{a} with prefix argument can
7989 be directed by @code{wl-draft-reply-with-argument-list} as well.
7991 By the way, you can use some function (will be evaluated in the parent
7992 message buffer) in the place of @samp{key} or @samp{to-list} etc.
7993 For example, if you only want to reply to mailing lists in
7994 @code{wl-subscribed-mailing-list} if the parent has some of them,
7999 (defun wl-mailing-list-addresses ()
8003 (nth 1 (std11-extract-address-components addr)))
8006 (elmo-multiple-fields-body-list (list "To" "Cc"))
8008 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
8009 (setq list-addrs (cons to list-addrs))))
8010 (nreverse list-addrs)))
8012 (setq wl-draft-reply-with-argument-list
8013 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
8014 ("Reply-To" . (("Reply-To") nil nil))
8015 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
8016 ("From" . (("From") nil nil))))
8021 Note: To set the behavior when you reply to the message written by yourself,
8022 use @code{wl-draft-reply-myself-without-argument-list} and
8023 @code{wl-draft-reply-myself-with-argument-list} instead of them.
8025 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
8026 @subsection Appearance of Threads
8030 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
8031 390 09/18(Fri)07:25 +-[ Tsumura-san ]
8032 391 09/18(Fri)19:24 +-[ Murata-san ]
8033 392 09/20(Sun)21:49 +-[ Okunishi-san ]
8034 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
8035 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
8036 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
8037 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
8038 412 09/22(Tue)09:28 | +-[ Teranishi ]
8039 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
8040 416 09/22(Tue)12:38 | +-[ Teranishi ]
8041 395 09/20(Sun)21:49 +-[ Okunishi-san ]
8042 397 09/21(Mon)00:15 +-[ Okunishi-san ]
8046 Settings to make appearance of threads like shown above:
8050 (setq wl-thread-indent-level 2)
8051 (setq wl-thread-have-younger-brother-str "+")
8052 (setq wl-thread-youngest-child-str "+")
8053 (setq wl-thread-vertical-str "|")
8054 (setq wl-thread-horizontal-str "-")
8055 (setq wl-thread-space-str " ")
8059 If you do not want to see branches, do the following:
8063 (setq wl-thread-indent-level 2)
8064 (setq wl-thread-have-younger-brother-str " ")
8065 (setq wl-thread-youngest-child-str " ")
8066 (setq wl-thread-vertical-str " ")
8067 (setq wl-thread-horizontal-str " ")
8068 (setq wl-thread-space-str " ")
8073 @node User-Agent Field, , Thread Format, Advanced Settings
8074 @subsection User-Agent Field
8078 If you are eccentric enough to elaborate @samp{X-Mailer:} or
8079 @samp{User-Agent:} fields, define a function that generate appropriate
8080 strings as you like, and set it to variable
8081 @code{wl-generate-mailer-string-function}.
8083 If you do not want verbose @samp{User-Agent:} field, do the following:
8087 (setq wl-generate-mailer-string-function
8088 'wl-generate-user-agent-string-1)
8092 The following is a example:
8096 (setq wl-generate-mailer-string-function nil)
8097 (setq wl-draft-additional-header-alist
8099 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
8104 @node Customizable Variables, Hooks, Advanced Settings, Customization
8105 @section Customizable Variables
8107 Customizable variables that have not been described yet:
8110 @item wl-default-folder
8111 @vindex wl-default-folder
8112 The initial setting is @samp{%inbox}. This is the default value for moving to
8113 a folder and the like.
8115 @item wl-draft-folder
8116 @vindex wl-draft-folder
8117 The initial setting is @samp{+draft}. It is the folder to which drafts are
8118 saved. It must be a writable folder.
8119 Note that variable settings applied by @code{wl-draft-config-exec} is saved
8120 under @code{elmo-msgdb-directory}. That is to say, if you specified remote
8121 folder as @code{wl-draft-folder}, variable settings which are applied by
8122 @code{wl-draft-config-exec} before saving the draft will not affect on the
8123 draft buffer on another host by invoking @code{wl-summary-reedit}.
8125 @item wl-trash-folder
8126 @vindex wl-trash-folder
8127 The initial setting is @samp{+trash}. It is the wastebasket folder.
8128 If you changed this variable, you had better restart Wanderlust.
8130 @item wl-interactive-exit
8131 @vindex wl-interactive-exit
8132 The initial setting is @code{t}.
8133 If non-nil, you are asked for confirmation when Wanderlust terminates.
8135 @item wl-interactive-send
8136 @vindex wl-interactive-send
8137 The initial setting is @code{t}.
8138 If non-nil, you are asked for confirmation when mail is sent.
8140 @item wl-default-sync-range
8141 @vindex wl-default-sync-range
8142 The initial setting is @samp{update}.
8143 Default update range of the summary. You can specify
8144 @samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
8145 See description of @code{wl-summary-sync} for the meaning of ranges.
8147 @item wl-folder-sync-range-alist
8148 @vindex wl-folder-sync-range-alist
8149 The initial setting is the alist shown below:
8154 ("^\\+draft$\\|^\\+queue$" . "all"))
8159 This is an associative list of regular expressions of folder names and
8160 update range of the summary. Update range is one of the @samp{all},
8161 @samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
8162 match any of them, the value of @code{wl-default-sync-range} is used
8163 (@samp{update} by default).
8164 See description of @code{wl-summary-sync} for the meaning of ranges.
8167 @vindex wl-ask-range
8168 The initial setting is @code{t}.
8169 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
8170 for updating the summary when you changed folders.
8172 @item wl-mime-charset
8173 @vindex wl-mime-charset
8174 The initial setting is @code{x-ctext}.
8175 This is the MIME charset for messages that are not MIME (e.g. without
8176 @samp{Content-Type:}). This value also used as default charset for
8177 summary. (If you want to share Summary on Nemacs and other Emacsen, set
8178 this value as @code{iso-2022-jp}.)
8180 @item wl-highlight-folder-with-icon
8181 @vindex wl-highlight-folder-with-icon
8182 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
8183 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
8185 @item wl-strict-diff-folders
8186 @vindex wl-strict-diff-folders
8187 This is a list of regular expressions of folders.
8188 Unread messages are checked, for example when you press @kbd{s} in
8189 the folder mode, usually in a brief way (rapidly processed but not
8191 The folders matching this variable are seriously checked.
8192 You may want to set this variable so as to match conditional filter
8193 folders for IMAP4 folders.
8194 The initial setting is @code{nil}.
8196 @item wl-folder-use-server-diff
8197 @vindex wl-folder-use-server-diff
8198 When unread messages are checked, for example when you press @kbd{s} in
8199 the folder mode, usually (the number of messages on the server) @minus{}
8200 (the number of local messages) will be the number of unread messages.
8201 However, if this variable is non-nil, the number of unread messages on
8202 the server is checked. This affects IMAP4 folders only, but IMAP4
8203 folders in mail boxes matching
8204 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
8205 the number of unread messages on the server, even if they matches this
8206 variable. The initial setting is @code{t}.
8208 @item wl-auto-check-folder-name
8209 @vindex wl-auto-check-folder-name
8210 The initial setting is @code{nil}.
8211 You can specify a folder or a group which is checked for unread message
8212 at the start. You can also specify a list of folders (groups) to be checked.
8213 If the value is @code{nil}, whole Desktop is checked at the start.
8214 If it is @code{none}, no folders are checked.
8216 @item wl-auto-uncheck-folder-list
8217 @vindex wl-auto-uncheck-folder-list
8218 The initial setting is the list shown below:
8227 You can set a list of regular expressions to specify folders
8228 which are not automatically checked even if they are included
8229 in some groups assigned by @code{wl-auto-check-folder-name}.
8231 @item wl-auto-check-folder-list
8232 @vindex wl-auto-check-folder-list
8233 The initial setting is @code{nil}.
8234 You can set a list of regular expressions to specify exceptions
8235 for @code{wl-auto-uncheck-folder-list}.
8237 @item wl-no-save-folder-list
8238 @vindex wl-no-save-folder-list
8239 The initial setting is the list shown below:
8248 This is a list of regular expressions of folders not to be saved.
8250 @item wl-save-folder-list
8251 @vindex wl-save-folder-list
8252 The initial setting is @code{nil}.
8253 This is a list of regular expressions of folders to be saved.
8254 This takes precedence over @code{wl-no-save-folder-list}.
8256 @item wl-folder-mime-charset-alist
8257 @vindex wl-folder-mime-charset-alist
8258 The initial setting is the alist shown below:
8262 (("^-alt\\.chinese" . big5)
8263 ("^-relcom\\." . koi8-r)
8265 ("^-han\\." . euc-kr))
8270 This is an associative list of regular expressions of folder names and
8272 If a folder do not match, @code{wl-mime-charset} is used.
8274 @item wl-folder-init-load-access-folders
8275 @vindex wl-folder-init-load-access-folders
8276 The initial setting is @code{nil}.
8277 This is a list of access groups to be loaded specifically at the start.
8278 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
8280 @item wl-folder-init-no-load-access-folders
8281 @vindex wl-folder-init-no-load-access-folders
8282 The initial setting is @code{nil}.
8283 This is a list of access groups not to be loaded specifically at the
8285 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
8287 @item wl-delete-folder-alist
8288 @vindex wl-delete-folder-alist
8289 The initial setting is the alist shown below:
8298 This list determines disposition of messages with delete marks.
8299 Each item in the list is a folder and destination; you can specify any
8300 one of the following in the place of destination:
8303 @code{remove} or @code{null} : deletes the messages instantly.
8304 string : moves the messages to the specific folder.
8305 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
8308 @item wl-x-face-file
8309 @vindex wl-x-face-file
8310 The initial setting is @file{~/.xface}.
8311 The name of the file that contains encoded X-Face strings.
8314 @item wl-demo-display-logo
8315 @vindex wl-demo-display-logo
8316 If non-nil, bitmap image is shown on the opening demo. If you set
8317 @code{xpm} or @code{xbm}, (if possible) display selected image type
8320 @item elmo-use-database
8321 @vindex elmo-use-database
8322 This is meaningful for XEmacs only. The initial setting depends on
8323 XEmacs (@code{t} for XEmacs with dbm).
8324 If non-nil, Message-ID is controlled by dbm.
8326 @item elmo-passwd-alist-file-name
8327 @vindex elmo-passwd-alist-file-name
8328 The initial setting is @file{passwd}.
8329 This is the name of the file in which passwords are saved.
8330 @code{elmo-passwd-alist-save} saves current passwords to the file.
8332 @item elmo-nntp-list-folders-use-cache
8333 @vindex elmo-nntp-list-folders-use-cache
8334 The initial setting is 600 (in seconds).
8335 This is period in seconds during which results of @samp{list} and
8336 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
8339 @item elmo-nntp-max-number-precedes-list-active
8340 @vindex elmo-nntp-max-number-precedes-list-active
8341 The initial setting is @code{nil}.
8342 If non-nil, the number of article obtained by @samp{list active} in NNTP
8343 are used as the maximum article number of the folder.
8344 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
8345 and if the number of read messages is not correct.
8347 @item elmo-nntp-default-use-listgroup
8348 @vindex elmo-nntp-default-use-listgroup
8349 The initial setting is @code{t}.
8350 If non-nil, @samp{listgroup} is used for checking the total number of
8351 articles. If it is @code{nil}, @samp{group} is used. In the latter
8352 case, the processing will be a little faster at the sacrifice of
8355 @item elmo-pop3-send-command-synchronously
8356 @vindex elmo-pop3-send-command-synchronously
8357 The initial setting is @code{nil}.
8358 If non-nil, POP3 commands are issued synchronously. Some implementation
8359 of POP3 server fails to get summary information without this setting.
8360 You may have to set this variable to @code{t}, if the process hangs
8361 while looking up POP3.
8363 @item elmo-dop-flush-confirm
8364 @vindex elmo-dop-flush-confirm
8365 The initial setting is @code{t}.
8366 If non-nil, you are asked for confirmation if accumulated off-line
8367 operations are executed.
8369 @item elmo-display-progress-threshold
8370 @vindex elmo-display-progress-threshold
8371 The initial setting is 20.
8372 Threshold for display of progress gauge. If number of renewal is more than
8373 this value, display progress gauge.
8377 @node Hooks, , Customizable Variables, Customization
8383 @node Migration, Terminology, Customization, Top
8384 @chapter Switch from older version of Wanderlust
8387 @node Terminology, Mailing List, Migration, Top
8388 @chapter Terminology around Wanderlust
8391 Here we explain terminologies used in this manual.
8395 A container in which messages are stored.
8398 A set consists of some folders.
8401 A special group consists of automatically collected folders under
8402 some specified path.
8403 @xref{Folder Definition}.
8405 @item summary buffer
8406 A buffer for displaying list of messages in some folder.
8408 @item sticky summary
8409 Compared with ordinary summary buffer which will be destroyed after
8410 exiting from it, this type of summary will be remain even after exiting
8411 by @kbd{q} or @kbd{g}.
8412 @xref{Sticky Summary}.
8415 To delete or put into the archive expired messages.
8422 To cache messages beforehand in order to read messages after you will be
8423 disconnected from the server.
8427 @node Mailing List, Addition, Terminology, Top
8428 @chapter Wanderlust Mailing List
8432 Topics related to Wanderlust are discussed in following mailing lists.
8433 The latest version is also announced there.
8436 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
8439 In this list Japanese is mainly used for discussion. We also have a list
8440 for discussion in English:
8443 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
8445 (Messages posted to this list are also forwarded to the former one.)
8447 A guide can be obtained automatically by sending mail to
8448 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
8449 the English one) with the body
8455 Please send bug reports or patches to one of those lists. You can post to
8456 the mailing list even though you are not a member of it.
8458 If you send a bug report, please attach Backtrace with it.
8459 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
8462 I would like to express my thanks to the members of the mailing list for
8463 valuable advice and many pieces of code they contributed.
8466 @node Addition, Index, Mailing List, Top
8467 @chapter Additional Information
8469 @section Brief History
8472 1998 3/05 Tried to make a prototype that displays MH messages in threads.
8473 3/10 Made a msgdb mechanism by elisp.
8474 3/26 IMAP and NNTP can be displayed in threads.
8475 4/13 Began to assemble thread display modules as elmo.
8476 5/01 Finished 0.1.0, initial version with many defects.
8477 6/12 I made a slip of the tongue and said I was writing elisp
8478 mailer supporting IMAP
8479 6/16 0.1.3 was announced at tm-ja, elisp ML.
8480 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
8481 7/01 Support for mm-backend (0.3.0).
8482 8/25 multi folder added (0.5.0).
8483 8/28 filter folder added (0.5.1).
8484 9/10 You can open/close threads (0.6.0).
8485 9/11 fldmgr by Murata-san made editing folders easy.
8486 9/18 lha folders added by Okunishi-san (0.6.3).
8487 9/24 Display of branches of threads (0.6.5).
8488 9/28 Compression folder supporting multiple archivers by Okunishi-san.
8489 10/28 Off-line operations (0.7.4).
8490 12/09 Becomes beta version.
8491 12/21 wl-expire by Murata-san.
8492 1999 2/03 auto-refile by Tsumura-san.
8493 4/28 wl-template by Murata-san.
8494 5/18 Released 1.0.0 stable.
8495 7/05 Scoring by Murata-san (2.1.0).
8496 9/26 New plugged system by Murata-san (2.2.2).
8497 12/20 Support Modified UTF7.
8498 2000 3/24 Released 1.1.0 stable.
8499 4/03 CVS development started.
8500 5/07 Thread restoration & Its speed up with Murata-san.
8501 6/12 Address completion with LDAP with Chiba-san & Goto-san.
8502 7/11 killed message feature.
8503 7/18 Use UIDL in POP3.
8504 9/12 biff feature with Satata-san & Yamaoka-san.
8505 10/17 expire-hide by Okada-san.
8506 11/08 Released 2.4.0 stable.
8507 2001 7/04 Released 2.6.0 stable.
8508 8/21 wl-addrmgr by Kitamoto-san.
8509 12/27 Released 2.8.1 stable.
8510 2002 12/11 Released 2.10.0 stable.
8513 See @file{ChangeLog} for details.
8517 According to a dictionary, Wanderlust has the meaning:
8521 n eager longing for or impulse towards travelling in distant lands
8522 [Ger, fr wandern to wander + lust desire, pleasure]
8526 but I had no profound intention. (if farfetched, IMAP @result{} you can
8527 read mail anywhere @result{} desire to wander ?)
8529 Elmo is the abbreviation of @samp{Elisp Library for Message
8530 Orchestration}. At first I meant the red puppet in the Sesame Street,
8531 but you may associate it with Wandering @result{} Drifting @result{}
8532 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
8536 Each versions has code names (they are almost jokes).
8537 Currently they are picked up alphabetically from the top 40 hits of
8538 U.S. Billboard magazines in 1980s.
8540 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
8543 @node Index, , Addition, Top
8547 * Concept Index:: Concept Index
8548 * Key Index:: Key Index
8549 * Variable Index:: Variable Index
8550 * Function Index:: Function Index
8553 @node Concept Index, Key Index, Index, Index
8554 @unnumberedsec Concept Index
8557 @node Key Index, Variable Index, Concept Index, Index
8558 @unnumberedsec Key Index
8561 @node Variable Index, Function Index, Key Index, Index
8562 @unnumberedsec Variable Index
8565 @node Function Index, , Variable Index, Index
8566 @unnumberedsec Function Index