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 * Customization:: Customizing Wanderlust
124 * Terminology:: Terminologies
125 * Mailing List:: Wanderlust mailing list
126 * Addition:: Additional Information
131 @node Introduction, Start Me Up, Top, Top
132 @chapter Introduction of Wanderlust
135 Wanderlust is an mail/news management system on Emacsen.
136 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
138 The main features of Wanderlust:
141 @item Pure elisp implementation.
142 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
143 @item Unified access method to messages based on Mew-like Folder Specification.
144 @item Mew-like Key-bind and mark handling.
145 @item Manages unread messages.
146 @item Interactive thread display.
147 @item Folder Mode shows the list of subscribed folders.
148 @item Message Cache, Disconnected Operation (Read Only).
149 @item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed).
150 @item MIME compliant (by SEMI).
151 @item Transmission of news and mail are unified by Message transmitting draft.
152 @item Graphical list of folders (XEmacs and Emacs 21).
153 @item View a part of message without retrieving the whole message (IMAP4).
154 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
155 @item Virtual Folders.
156 @item Supports compressed folder using common archiving utilities.
157 @item Old articles in folders are automatically removed/archived (Expiration).
158 @item Automatic re-file.
159 @item Template function makes it convenient to send fixed form messages.
165 We confirm Wanderlust works on following Emacsen:
168 @item Mule 2.3 based on Emacs 19.34
169 @item Emacs 20.2 or later
170 @item XEmacs 20.4 or later
171 @item Meadow 1.00 or later
172 @item NTEmacs 20.4 or later
176 IMAP4 connectivity with following imapd are confirmed to work with
180 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
181 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
182 @item Courier-IMAP 1.3.2 or later
183 @item AIR MAIL (AIRC imapd release 2.00)
185 @item Microsoft Exchange Server 5.5
186 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
189 LDAP connectivity with following LDAPd are confirmed to work with
193 @item OpenLDAP 2.0.6 or later
197 @node Start Me Up, Folders, Introduction, Top
198 @chapter Start up Wanderlust
201 The necessary procedure for starting Wanderlust is explained in steps
204 (Of course, you need a mail/news readable environment in advance)
207 * MIME Modules:: Installing the MIME modules
208 * Download:: Download and extract the packages
209 * Install:: Byte-compile and install
210 * Minimal Settings:: @file{.emacs} setup
211 * Folder Definition:: Folder definition
212 * Start Wanderlust:: Starting Wanderlust
213 * Overview:: Basic components of Wanderlust
217 @node MIME Modules, Download, Start Me Up, Start Me Up
218 @section Installing MIME modules
224 You must install SEMI beforehand to use Wanderlust.
226 SEMI can be downloaded from following site:
230 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
234 You need packages named APEL and FLIM to use SEMI.
235 You can download APEL and FLIM from following URLs:
239 APEL: ftp://ftp.m17n.org/pub/mule/apel/
240 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
244 You have to install APEL, FLIM and SEMI in this order. Generally,
245 @samp{make install} will do the job. (In XEmacs 21, @samp{make
248 Refer to the documents of each package for detailed installation
249 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
250 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
254 Recommended combination of APEL, FLIM and SEMI are following:
257 @item APEL 10.4, FLIM 1.14.5 and SEMI 1.14.5
260 You can also use many other FLIM/SEMI variants. Combination of the
261 latest versions should work. For example, the following combination are
265 @item APEL 10.4, SLIM 1.14.9, SEMI 1.14.5
266 @item APEL 10.4, CLIME 1.14.5, EMIKO 1.14.1
269 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
272 @node Download, Install, MIME Modules, Start Me Up
273 @section Download and Extract the Package
276 You can download Wanderlust package from following sites:
280 ftp://ftp.gohome.org/wl/
283 Mirrored ftp/http sites:
287 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
288 http://www.jpl.org/elips/wl/
289 http://www.ring.gr.jp/archives/text/elisp/wl/
290 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
291 ftp://opaopa.org/pub/mirror/elisp/wl/
292 @c ftp://roguelife.org/pub/tsumura/wl/
296 Extract the obtained package to your working directory:
301 % tar zxvf wl-@var{version}.tar.gz
302 % cd wl-@var{version}
306 @subsection To use SSL (Secure Socket Layer)
311 SSL (Secure Socket Layer) can be used for
312 SMTP, IMAP, NNTP and POP connections in Wanderlust.
314 There are two ways to use SSL. One is to start SSL negotiation just
315 after the connection establishment (generic way). The other one is to
316 start SSL negotiation by invoking STARTTLS command in the each session.
318 To use the formal SSL (generic SSL), you must set @env{PATH} to the
319 directory that OpenSSL commands are installed.
321 To use the latter SSL(STARTTLS), you must install starttls package in
323 You can download starttls package from the following site.
326 ftp://opaopa.org/pub/elisp/
329 @node Install, Minimal Settings, Download, Start Me Up
330 @section Byte-compile and install
337 @subsection Installation
339 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
340 Set the Emacs's command name to @code{EMACS}.
341 Set package installation directory to @code{LISPDIR}.
342 Then, please execute following commands.
351 Destination directory is auto-probed if you leave @code{LISPDIR}
352 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
354 If you are using an Emacs variant which does not merge specified directory
355 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
356 then you will see the error message:
359 Cannot open load file: mime-setup
363 In this case, either add destination directories of custom, APEL, FLIM
364 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
365 @code{load-path} in @file{WL-CFG} in extracted directory.
367 If you want to handle shimbun folders or to use BBDB, add directory
368 where emacs-w3m or BBDB is installed to @code{load-path}. Then necessary
369 modules will be byte-compiled and installed.
370 @xref{Shimbun Folder}, @xref{BBDB}.
372 @subsection @file{WL-CFG}
374 Contents of the file @file{WL-CFG} is loaded under installation if a file
375 with that name exists in extracted directory. You can use @file{WL-CFG} to
376 configure @code{load-path} to extra packages such as SEMI if needed.
378 If you want to specify the install directory of Wanderlust related
379 files, then set following variables in @file{WL-CFG}
383 A directory to install WL modules.
384 This directory is relative directory from @code{LISPDIR}.
385 WL modules include @file{wl*.el}, @file{wl*.elc} files.
386 @c Modules under the directory @file{util/} are also installed if
387 @c it detected as necessary.
390 A directory to install ELMO modules.
391 This directory is relative directory from @code{LISPDIR}.
392 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
393 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
397 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
399 If you want to install ELMO related files under a sub-directory
400 such as "elmo" then add following to @file{WL-CFG}:
403 (setq ELMO_PREFIX "elmo")
406 @subsection Install as a XEmacs package
407 @cindex XEmacs package
408 @cindex XEmacs package install
409 @cindex Package, XEmacs
410 @cindex Package install, XEmacs
411 @c @cindex install-package
413 It is possible to install Wanderlust as one of packages of XEmacs (21.0
414 or later). Configuration for autoload and icon-path in local
415 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
418 Follow the next example to install Wanderlust as an XEmacs package.
424 % make install-package
428 package directory is auto-probed, if SEMI is installed.
429 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
431 @subsection Run in place
433 If wl and elmo directories are defined in @code{load-path}, then
434 byte-compilation and installation are not necessary to start Wanderlust.
435 For example, if package is extracted in @file{~/work}, Wanderlust can be
436 invoked with following setting in @file{~/.emacs}.
440 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
441 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
447 Manual is described in Info format. Please do following.
456 If you install Wanderlust as a XEmacs package, Info file is already
457 installed too, so there are no need of these commands.
459 Manual directory is automatically detected. Of course, it can be
460 configured by @code{INFODIR} in @file{Makefile}.
462 You can read manual at the following URL:
465 http://www.gohome.org/wl/doc/wl_toc.html
468 @node Minimal Settings, Folder Definition, Install, Start Me Up
469 @section Set up .emacs
470 @cindex Minimal Settings
472 @cindex Configuration
476 The Wanderlust package contains two module groups.
479 @item ELMO (elmo-*.el)
480 These modules show everything as folders. This is the back-end for WL.
482 These modules controls the behavior of main body of Wanderlust.
483 They are also the front-end for ELMO.
486 You can customize the behavior of Wanderlust by changing the value
487 of environmental variables which begins with @code{elmo-} and @code{wl-}.
489 The minimal requirement for settings is as the following.
493 ;; @r{autoload configuration}
494 ;; @r{(Not required if you have installed Wanderlust as XEmacs package)}
495 (autoload 'wl "wl" "Wanderlust" t)
496 (autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
497 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
499 ;; @r{Directory where icons are placed.}
500 ;; @r{Default: the peculiar value to the running version of Emacs.}
501 ;; @r{(Not required if the default value points properly)}
502 (setq wl-icon-directory "~/work/wl/etc")
504 ;; @r{SMTP server for mail posting. Default: @code{nil}}
505 (setq wl-smtp-posting-server "your.smtp.example.com")
506 ;; @r{NNTP server for news posting. Default: @code{nil}}
507 (setq wl-nntp-posting-server "your.nntp.example.com")
511 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
512 file exists). So it is convenient to gather Wanderlust specific settings
513 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
514 because you can't write them in @file{.emacs}
515 (if you write it to @file{.emacs}, you'll get an error).
518 All above described settings except autoload configuration can be written
521 @subsection @code{mail-user-agent}
522 @cindex Default Mailer
523 @cindex Mailer, Default
524 @vindex mail-user-agent
527 If you write following setting in your @file{~/.emacs}, you can
528 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
529 This means it enables you to run Wanderlust as a default mail composer
532 It is effective only when your Emacs can define @code{mail-user-agent}.
533 @xref{Mail Methods, , ,emacs, The Emacs Editor}.
537 (autoload 'wl-user-agent-compose "wl-draft" nil t)
538 (if (boundp 'mail-user-agent)
539 (setq mail-user-agent 'wl-user-agent))
540 (if (fboundp 'define-mail-user-agent)
541 (define-mail-user-agent
543 'wl-user-agent-compose
552 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
553 @section Folder Definition
554 @cindex Folder Definition
557 You can skip this section because it is possible to add/edit the
558 subscribe folders from the buffer for list of folders.
559 @xref{Folder Manager}.
561 Define the folders you want to subscribe in file @file{~/.folders}. The
562 contents written in @file{~/.folders} become the folders which you
563 subscribe to as it is.
565 Format for @file{~/.folders} is very simple. Here is an example:
570 # @r{Lines begin with @samp{#} are comment.}
571 # @r{Empty lines are ignored}
573 # @var{folder name} "@var{folder nickname}"
574 # @r{(nicknames are not necessary)}
579 %#mh/Backup@@my.imap.example.com "Sent"
582 %#mh/spool/wl "Wanderlust ML"
583 %#mh/spool/elips "ELIPS ML"
584 %#mh/spool/apel-ja "APEL Japanese ML"
585 %#mh/spool/xemacs-beta "XEmacs beta"
586 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
587 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
590 # @r{If folder name ends with @samp{/}, that means an `access group',}
591 # @r{all subfolders automatically included in one folder group.}
593 %#mh/expire@@localhost /
594 # @r{All MH folders are included in one folder group.}
599 Each line contains one folder you want to read. The definition of
600 folders will be explained in detail in the next section.
602 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
603 become one folder group. One folder group is treated as a directory
604 which can be opened and closed in folder mode. It is convenient for
605 collecting some folders and putting them in order.
607 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
608 line and you have to write it that way (It is because the parser sucks).
610 There are two types of groups. One is like @samp{Emacsen} from above
611 example which the user chooses his favorite folders as a group.
613 The other one is @dfn{access group} like @samp{+ /} from above example.
614 It collects all sub-folders in the folder to make a group. (Its
615 behavior differs by the type of the folder. For example, @samp{+}
616 followed by @samp{/} makes entire MH sub-directories to one group)
618 This behavior is better understood if you try it and confirmed the
619 function first. You can write and try a small folder definition, so you
620 will know the idea of the folder function before writing the real one.
622 @node Start Wanderlust, Overview, Folder Definition, Start Me Up
623 @section Start Wanderlust
624 @cindex Start Wanderlust
626 If installation and configuration worked well, you can invoke Wanderlust by
627 typing following command in Emacs.
634 After initialization, Folder Mode which shows the list of folders will
635 appear. That means the folders you defined in the @file{~/.folders} are
638 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
639 can skip folder checking.
642 @node Overview, , Start Wanderlust, Start Me Up
646 Basically, you will handle messages in wanderlust while you come and go
647 from/to each of the following buffers. Details of each ones are
648 explained in following chapters.
652 You can see the list of folders. You can select some folder and go into the summary
653 of it. You can subscribe new folder or edit subscription list.
655 You can see the list of messages in the folder. You can select message
656 and view its contents, and reply to some message. You can delete ones or
657 move ones to another folder.
659 You can see the contents of the message. You can save part to disk or
660 open in external programs.
662 You can edit message.
666 @node Folders, Folder, Start Me Up, Top
667 @chapter Wanderlust's folders
670 This chapter describes the folder types which Wanderlust is able to handle.
672 Wanderlust uses ELMO as it's interface, so you can use every folder types
675 As of version @value{VERSION}, 11 types of folders are predefined. These are
676 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
677 Pipe and Internal folder types.
680 * IMAP Folder:: @samp{%} -- IMAP folder
681 * NNTP Folder:: @samp{-} -- NNTP folder
682 * MH Folder:: @samp{+} -- MH folder
683 * Maildir Folder:: @samp{.} -- Maildir folder
684 * News Spool Folder:: @samp{=} -- News spool folder
685 * Archive Folder:: @samp{$} -- Archive folder
686 * POP Folder:: @samp{&} -- POP folder
687 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
688 * Namazu Folder:: @samp{[} -- Namazu Folder
689 * Multi Folder:: @samp{*} -- Multi folder
690 * Filter Folder:: @samp{/} -- Filter folder
691 * Pipe Folder:: @samp{|} -- Pipe folder
692 * Internal Folder:: @samp{'} -- Internal folder
696 @node IMAP Folder, NNTP Folder, Folders, Folders
704 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
710 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
714 You can specify @code{login} (encoded password transmission),
715 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
716 authentication) or @code{clear} (or @code{nil}, plain password
717 transmission) as @var{authenticate-type}.
722 @var{username} -> The value of @code{elmo-imap4-default-user}.
723 Initial setting is @env{USER} environment variable or
724 @env{LOGNAME} environment variable or return value of
725 @code{(user-login-name)}.
726 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
727 Initial setting is "auth".
728 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
729 Initial setting is "localhost".
730 @var{port} -> The value of @code{elmo-imap4-default-port}.
731 Initial setting is 143.
734 You can omit the @var{hostname} from folder names if you set
735 @code{elmo-imap4-default-server} as your main IMAP server.
736 For example, you can specify a folder as @samp{foo%imap@@gateway} even
737 if you have to go through a firewall.
741 ;; @r{Example: imap4.exaple.org as main IMAP server}
742 (setq elmo-imap4-default-server "imap4.example.org")
746 SSL (Secure Socket Layer) connection will be used if a folder name ends
747 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
748 is @code{ssl}, SSL will be the default connection. If a folder name
749 ends with @samp{!!}, STARTTLS connection will be established. If the
750 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
751 STARTTLS will be the default connection.
755 ;; @r{Example: Use SSL connection}
756 (setq elmo-imap4-default-stream-type 'ssl)
760 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
761 authentication method, the password is sent in encoded form. But, if
762 your server is unable to receive an encoded password, authentication
763 will fall back to @code{clear} (that is, sending password in raw format)
764 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
765 authentication will fall back to @code{clear} without confirmation
766 (default value is @code{nil}).
770 ;; @r{Example: password in raw format}
771 (setq elmo-imap4-default-authenticate-type 'clear)
779 %inbox -> IMAP mailbox "inbox"
780 %#mh/inbox -> IMAP mailbox "#mh/inbox"
782 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
783 %inbox:hoge/clear@@server1
784 -> server1's IMAP mailbox "inbox"
785 of user "hoge", with plain password authentication
790 @subsection International mailbox names (Modified UTF7)
791 @cindex Modified UTF7
798 You can use international mailbox names in @var{mailbox} part, if you
799 are using Emacs with UTF-7 support and
800 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
801 value is @code{nil}).
803 Currently, Mule-UCS package is required to use UTF-7.
804 Mule-UCS works on following Emacsen.
807 @item Emacs 20.3 or later
808 @item XEmacs 21.2.37 or later
811 You can obtain Mule-UCS package from following URL.
814 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
817 @node NNTP Folder, MH Folder, IMAP Folder, Folders
828 A folder to access USENET news via NNTP protocol (RFC 977).
829 One newsgroup is treated as a folder.
835 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
841 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
842 Initial setting is @samp{localhost}.
843 @var{username} -> The value of @code{elmo-nntp-default-user}.
844 Initial setting is @code{nil}.
845 @var{port} -> The value of @code{elmo-nntp-default-port}.
846 Initial setting is 119.
849 AUTHINFO is used as authentication method if the @var{username} is
850 non-nil. SSL will be default method if
851 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
852 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
853 STARTTLS connection will be established. if the value of
854 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
855 be the default connection.
861 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
862 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
867 @node MH Folder, Maildir Folder, NNTP Folder, Folders
874 A folder to access MH format mail (1 file is 1 mail).
879 @samp{+} @var{directory-name}
882 Normally, @var{directory-name} is an relative path to the variable
883 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
884 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
885 (this is also true for drive-letters).
887 Message number is used for the name of the message file.
893 +inbox -> @file{~/Mail/inbox}
894 +from/teranisi -> @file{~/Mail/from/teranisi}
895 +~/test -> @file{~/test}
900 @node Maildir Folder, News Spool Folder, MH Folder, Folders
901 @section Maildir Folder
903 @cindex Maildir Folder
907 A folder to access Maildir format (1 file is 1 mail).
912 @samp{.} [@var{directory-name}]
915 Normally, @var{directory-name} is a relative path to the variable
916 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
917 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
918 (this is also true for drive-letters).
920 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
921 Messages are contained in the @file{cur} directory. All message files
922 in the @file{new} directory are moved to @file{cur} directory when you
923 access the folder. All message files contained in the @file{tmp}
924 directory and not accessed for 36 hours are deleted.
926 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
932 . -> @file{~/Maildir}
933 .inbox -> @file{~/Maildir/inbox}
934 .from/teranisi -> @file{~/Maildir/from/teranisi}
935 .~/test -> @file{~/test}
940 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
941 @section News Spool Folder
943 @cindex News spool Folder
946 This folder handles locally saved news articles which are proposed by
947 Mew/IM. You can also read articles directly from a spool-file which is
948 retrieved by an utility like @command{gnspool}.
953 @samp{=} @var{directory-name}
956 @var{directory-name} is a sub-directory to the directory defined by
957 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
958 You can use @samp{.} as directory delimiter as well as @samp{/}.
964 =fj/os/os2 -> @file{~/News/fj/os/os2}
965 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
970 @node Archive Folder, POP Folder, News Spool Folder, Folders
971 @section Archive Folder
973 @cindex Archive Folder
976 This method can handle archive files, which are compressed by utilities
977 such as Info-ZIP or LHA, as one folder.
983 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
987 @var{path-name} is the relative path from
988 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
989 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
990 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
991 also permitted under the environment of ange-ftp, efs.
993 The actual file name of the archive folder is
994 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
995 under the @var{path-name}. If a file named @var{path-name} exists, it is
996 treated as folder. The suffix is automatically decided for
999 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1000 (Initial setting is @code{zip}) is referred.
1002 @var{prefix} specifies the internal directory structure of the archive.
1003 For example, if the ML server is fml, @file{msend.tar.gz} has a
1004 structure like @file{spool/1}, so you have to specify @samp{spool} as
1011 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1012 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1013 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1014 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1015 $ml;zip/ -> Access group consists of archive folders
1016 under @file{~/Mail/ml}
1021 * Archiver:: Supported Archivers
1022 * Archive Tips:: TIPS
1023 * Archive Vars:: Customization
1027 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1028 @subsection Supported Archives
1038 By default, following archives are supported.
1042 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1043 GNU TAR('tgz, 'tar) ;; read-only
1047 If your archiver can include multiple files in one archive, you have a
1048 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1049 of the candidate. TAR is supported read-only because it cannot delete
1050 file in the archive (@code{mv})).
1052 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1053 archiver of Wanderlust because they cannot include multiple
1054 files. Archivers that cannot extract files to standard output are also
1057 @subsection OS specific information about archiver.
1059 Behaviors of the following archivers are confirmed by further experiences.
1060 (@samp{*} mark means recommended archiver).
1063 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1064 LHA OS/2 version Rel.2.06b Feb 18, 1998
1065 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1066 *Zip 2.2 (November 3rd 1997).
1067 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1068 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1069 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1071 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1072 LHa for UNIX V 1.14c
1073 UnZip 5.32 of 3 November 1997
1074 Zip 2.2 (November 3rd 1997)
1075 GNU tar 1.12 (1.11.x is no good)
1076 gzip 1.2.4 (18 Aug 93)
1078 [Win32] Win.98/Meadow
1082 GNU tar 1.11.8 + 1.5(WIN32)
1089 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1090 Hiramatsu version of LHA is only supported.
1091 In Win32, LHa32 is only supported (DOS version is no good).
1093 * Caution about GNU tar
1095 You have to take care about GNU tar's version because many version has
1096 problem on deleting file from archive.
1098 Please test @option{--delete} @option{-f} options work. Otherwise, your
1099 archive will be destroyed. No problem is reported on above versions of
1103 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1105 @cindex Archive Tips
1107 For comfortable migration, usage of @code{wl-summary-archive}
1108 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1109 archive folders created by expiration, you must set non-nil value to
1110 @code{elmo-archive-treat-file}.
1112 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1113 in processing speed. For comfortable use, Emacs20 is recommended.
1114 (If re-search's performance is the problem, 19.3x or later may be okay.)
1116 If many files are included in one archive,
1117 it takes long time to access the archive folder because
1118 archiver starting overhead is increased (especially LHA).
1119 150-200 messages in one archive is recommended.
1121 Of course, following is possible @t{:-)}
1122 (meanings of these variables are described later.)
1126 (setq wl-fcc "$backup")
1127 (setq wl-trash-folder "$trash;lha")
1131 @node Archive Vars, , Archive Tips, Archive Folder
1132 @subsection Variables About Archive Folder
1133 @cindex Archive variables
1136 @item elmo-archive-default-type
1137 @vindex elmo-archive-default-type
1138 The initial setting is @code{zip}.
1139 Set archiver type by symbol.
1141 @item elmo-archive-@var{type}-method-alist
1142 @vindex elmo-archive-TYPE-method-alist
1143 Define archiver @var{type}'s methods.
1144 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1145 Each element of the alist is following.
1149 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1150 (@var{action} . @var{function}) ;; function
1154 Currently available actions are following.
1158 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1159 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1166 actions enclosed with braces are optional (They are used for better
1169 @item elmo-archive-suffix-alist
1170 @vindex elmo-archive-suffix-alist
1171 An alist of archiver-type (symbol) and suffix.
1173 @item elmo-archive-file-regexp-alist
1174 @vindex elmo-archive-file-regexp-alist
1175 An alist of a regexp to get file number from list output of archiver
1176 and archiver-type (symbol).
1178 @item elmo-archive-method-list
1179 @vindex elmo-archive-method-list
1180 A list of elmo-archive-@var{type}-method-alist
1181 (@var{type} is a symbol of archiver-type).
1183 @item elmo-archive-lha-dos-compatible
1184 @vindex elmo-archive-lha-dos-compatible
1185 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1186 DOS (Mr. Yoshizaki original) compatible.
1188 @item elmo-archive-cmdstr-max-length
1189 @vindex elmo-archive-cmdstr-max-length
1190 The initial setting is 8000.
1192 Max length of command line argument for external archiver program.
1193 Emacs does not have a limit of command line byte length, but some OS
1194 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1195 this limit because it calls external archiver program directly (not
1196 called via shell). For example, you cannot delete messages if archiver
1197 program must receive larger bytes of arguments to delete. OS/2 have a
1198 command line argument limit of 8190 bytes, so we defined default as 8000
1201 However, you don't have an influence of command line argument limit
1202 if the archiver has `actions' to receive target file information from
1203 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1207 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1215 A folder to access e-mails via POP3 protocol (RFC 1939).
1221 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1226 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1227 as @var{authenticate-type}.
1229 You can specify @samp{uidl} (use UIDL command for message numbering) or
1230 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1234 @var{username} -> The value of @code{elmo-pop3-default-user}.
1235 Initial setting is @env{USER} environment variable or
1236 @env{LOGNAME} environment variable or return value of
1237 @code{(user-login-name)}.
1238 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1239 Initial setting is @samp{user}.
1240 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1241 If t, use UIDL for numbering. Initial setting is t.
1242 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1243 Initial setting is @samp{localhost}.
1244 @var{port} -> The value of @code{elmo-pop3-default-port}.
1245 Initial setting is 110.
1252 &hoge@@localhost -> access localhost as user @samp{hoge}.
1253 &hoge@@popserver:109 -> access the server "popserver" on port 109
1254 as user @samp{hoge}.
1258 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1259 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1260 @file{utils/sasl/lisp/} or Emacs/W3 package
1261 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1264 If the last character of the folder name is @samp{!}, Wanderlust
1265 connects to the POP server via SSL (Secure Socket Layer). If you set
1266 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1267 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1268 with @samp{!!}, STARTTLS connection will be established. if the value
1269 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1273 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1274 @section Shimbun Folder
1276 @cindex Shimbun Folder
1277 @cindex Folder, Shimbun
1282 A folder for watching "shimbun" (means "newspaper" in Japanese),
1283 news site and mailing list archives on WWW by using emacs-w3m
1284 (@uref{http://emacs-w3m.namazu.org/}).
1286 You should possess w3m and emacs-w3m to use this.
1292 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1296 Admissible values of @var{module-name} and @var{folder-name} are
1297 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1303 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1304 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1308 @subsection Variables About Shimbun Folder
1311 @item elmo-shimbun-update-overview-folder-list
1312 @vindex elmo-shimbun-update-overview-folder-list
1313 The initial setting is @code{nil}. You can specify a list of regular
1314 expressions of shimbun folder names. The overview of matched shimbun
1315 folder is updated when messages are fetched.
1316 You should @kbd{s rescan} after fetching to update summary.
1320 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1321 @section Namazu Folder
1323 @cindex Namazu Folder
1324 @cindex Folder, Namazu
1325 @cindex Folder, Text Search
1328 A folder to access messages found in namazu-index with some condition.
1329 It uses namazu (@uref{http://www.namazu.org/}) for search.
1335 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1339 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1345 [wanderlust] -> search messages matched with
1346 "wanderlust" from the default index
1347 [semi flim]~/Mail/semi -> search "semi flim" from the index
1348 in the directory "~/Mail/semi"
1354 @subsubsection Enter space to separate keywords
1356 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1358 @subsubsection Alias name for index
1360 You can define an alias name for index.
1365 (setq elmo-nmz-index-alias-alist
1366 '(("cache" . "~/.elmo/cache")
1367 ("docs" . "~/documents")))
1370 Above definition defines two index aliases.
1377 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1378 directory @file{~/.elmo/cache}.
1380 @subsubsection Multiple indices
1382 You can specify a list for @code{elmo-nmz-default-index-path} and
1383 @code{elmo-nmz-index-alias-alist}.
1384 When list is specified, all index contained in the list is used as the
1390 (setq elmo-nmz-index-alias-alist
1391 '(("all" . ("~/.elmo/cache" "~/documents"))
1392 ("cache" . "~/.elmo/cache")))
1395 Using above alias setting, you can specify
1401 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1402 directory @file{~/.elmo/cache} and @file{~/documents}.
1404 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1405 @section Multi Folder
1407 @cindex Multi Folder
1408 @cindex Folder, Multiple
1409 @cindex Folder, Marge
1411 A folder to access virtual folder which collects messages from
1418 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1422 After @samp{*} character, specify multiple folders you want to collect
1423 separated by @samp{,} like
1424 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1430 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1431 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1432 treated as one folder.
1434 *+inbox,-fj.rec.tv,%inbox
1435 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1440 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1441 @section Filter Folder
1443 @cindex Filter Folder
1444 @cindex Folder, Filtering
1445 @cindex Folder, Virtual
1446 @cindex Folder, Conditional
1448 A folder to access virtual folder which collects all messages that
1449 satisfy a condition.
1454 @samp{/} @var{condition} @samp{/} @var{target-folder}
1457 In the @var{condition} part, you can specify following.
1461 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1463 first: @var{number} messages are picked from top of folder.
1464 last: @var{number} messages are picked from bottom of folder.
1470 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1471 /first:20/%inbox -> First 20 messages from %inbox are picked.
1476 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1478 since: only messages arrived since @var{date} are picked.
1479 before: only messages arrived before @var{date} are picked.
1481 You can specify following as @var{date}.
1485 yesterday -> a day before today.
1486 lastweek -> same day of last week.
1487 lastmonth -> same day of last month.
1488 lastyear -> same day of last year.
1489 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1490 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1498 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1500 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1506 Field filter: @samp{@var{field}:@var{value}}
1508 All messages that have @var{field} and its value is @var{value} are picked.
1509 @var{field} and @var{value} are case insensitive.
1515 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1516 and its value includes "teranisi" string are picked.
1517 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1525 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1526 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1528 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1529 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1535 /from:teranisi&!to:teranisi/+inbox
1536 -> In +inbox, messages are picked if the message's
1537 From: field includes "teranisi" and
1538 To: field doesn't include "teranisi".
1540 /tocc:"Yuuichi Teranishi"/+inbox
1541 -> In +inbox, messages are picked if the
1542 message's To: field or Cc: field includes
1543 "Yuuichi Teranishi".
1545 /(from:yt|from:teranisi)&subject:report/+inbox
1546 -> In +inbox, messages are picked if the message's
1547 From: field includes "yt" or "teranisi", and
1548 Subject includes "report".
1554 Tip for string description:
1556 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1557 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1558 should be escaped with @samp{\} in it). You can enclose the string with
1559 @samp{"} even it does not contain these characters.
1565 *%inbox,/from:teranisi/%inbox@@server
1566 -> Messages in %inbox or
1567 message is in the %inbox@@server folder and it's From field
1568 includes "teranisi" are collected.
1570 /last:100//to:teranisi/*+inbox,%inbox
1571 -> Latest 100 messages which is in the +inbox or %inbox folder
1572 and To: field matches "teranisi".
1574 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1575 -> Pick messages which have From: field and it includes "hogehoge"
1576 from latest 20 messages in the %#mh/inbox@@localhost
1577 and To: or Cc: field includes "teranisi".
1580 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1581 @section Pipe Folder
1585 @cindex Download Message
1586 @cindex Incorporate Message
1588 In the pipe folder, messages are automatically transferred from the source
1589 folder to destination folder.
1594 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1597 When you access the pipe folder, messages are automatically transferred
1598 from @var{source-folder} to @var{destination-folder}.
1599 It is convenient if you want to download messages to local disk via POP.
1600 For example, if you specify following
1603 |&username@@popserver|+inbox
1607 and access it, Wanderlust downloads messages from
1608 @samp{&username@@popserver} to @samp{+inbox} automatically.
1610 On the other hand, if you put @samp{|:} instead of second @samp{|},
1611 then messages are copied to the destination folder (not deleted from
1612 source-folder). At the next time you access that folder, copies new
1616 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1619 If you want to copy messages from POP server and view them, specify the
1623 |&username@@popserver|:+inbox
1626 where messages will be kept on the server.
1632 |%inbox|%myinbox -> Download %inbox to %myinbox.
1633 |*&user@@popserver1,&user@@popserver2|+inbox
1634 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1635 |-gnu.emacs.sources|:+sources
1636 -> Copy messages from -gnu.emacs.sources to +sources.
1640 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1642 @node Internal Folder, , Pipe Folder, Folders
1643 @section Internal folder
1645 @cindex Internal Folder
1646 @cindex Folder, @samp{$} mark
1648 @c @cindex Folder, Null
1650 A folder to access internal messages of Wanderlust.
1662 A folder named @samp{'mark} is a special virtual folder which collects
1663 messages which have important mark @samp{$}.
1665 You can review important messages at once after you put important marks
1666 on the messages in the different folders.
1668 In this folder, if you delete message, important mark @samp{$} put on
1669 the message is removed. If you append messages to this folder, the
1670 message will have @samp{$} mark.
1672 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1673 folder. If you want IMAP folder's message remove from @samp{'mark}
1674 folder, remove important mark at IMAP Folder.)
1677 A folder named @samp{'sendlog} is a virtual folder which collects
1678 cached messages which are recoded on @file{~/.elmo/sendlog}.
1679 It might be useful when you forgot to add cc for yourself.
1680 To use this, you should set @code{wl-draft-use-cache} to non-nil
1681 so that sent messages are cached.
1684 You can access cached messages fetched via network by accessing
1685 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1686 the name of the subdirectories of the cache directory
1687 (@file{~/.elmo/cache}).
1690 @node Folder, Summary, Folders, Top
1691 @chapter Folder mode
1694 After you start Wanderlust, folder mode is appeared firstly.
1695 It contains folder list you subscribed.
1696 You can select and edit folders in this mode.
1699 * Selecting Folder:: Select folder you want to read
1700 * Folder Manager:: Editing folders
1704 @node Selecting Folder, Folder Manager, Folder, Folder
1705 @section Selecting Folder
1706 @cindex Selecting Folder
1708 @subsection Usage (TIPS)
1710 @subsubsection Check new, unread number
1712 Folder mode looks like this.
1713 (In XEmacs, it looks much nicer @t{;-)})
1717 [-]Desktop:14186/35580/67263
1722 [-]Emacsen:0/34/4837
1723 Wanderlust ML:0/0/558
1726 XEmacs Beta:0/29/255
1737 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1741 @kbd{s} key on the folder line updates these numbers.
1742 It changes its color if it has many new messages.
1744 The whole folder mode is a folder group named @samp{Desktop}.
1745 Folder group open/close by return key.
1746 A operation to a folder group is treated as operations on the
1748 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1749 six children folders update its unread number status.
1751 @subsubsection Select Folder
1753 To enter summary mode of the folder, type return (or space) key on
1755 If the variable @code{wl-stay-folder-window} has non-nil value,
1756 summary window appears on the right of the folder mode window.
1758 @subsection Key bindings
1760 Folder mode's key binding (related to selecting folders) is following.
1765 @kindex @key{SPC} (Folder)
1766 @kindex @key{RET} (Folder)
1767 @findex wl-folder-jump-to-current-entity
1768 Enter to the summary mode of the folder at the current cursor point.
1769 With prefix argument, enter the sticky summary.
1770 If the cursor is on the top of folder group line,
1771 the folder group is opened or closed.
1772 When the cursor is on the access group and this command is called
1773 with prefix argument, folder children list is updated to the newest one.
1774 (Children list is updated recursively if the access folder has hierarchical
1776 (@code{wl-folder-jump-to-current-entity})
1779 @kindex M-@key{RET} (Folder)
1780 @findex wl-folder-update-recursive-current-entity
1781 Folder children list of the access group at the current cursor point
1782 is updated to the newest one.
1783 (Children list is updated recursively if the access folder has hierarchical
1785 (@code{wl-folder-update-recursive-current-entity})
1790 Create a new draft message.
1795 @findex wl-folder-write-current-folder
1796 If the current cursor point is on the NNTP folder, create a new draft
1797 message which already has @samp{Newsgroups:} field. If the current
1798 cursor point is on the folder for mailing list (refile destination),
1799 create a new draft message which already has @samp{To:} field with
1800 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1802 (@code{wl-folder-write-current-folder})
1805 @kindex C-c C-o (Folder)
1806 @findex wl-jump-to-draft-buffer
1807 Move to the draft buffer if available. If multiple draft buffer exists,
1808 moved to one after another. If prefix argument is specified, load draft
1809 folder's message to the draft buffer and jump to it.
1810 (@code{wl-jump-to-draft-buffer})
1814 @findex wl-folder-check-current-entity
1815 Update new and unread number information of the folder at the current
1817 (@code{wl-folder-check-current-entity})
1821 @findex wl-folder-sync-current-entity
1822 Update summary information of the folder at the current cursor point.
1823 (@code{wl-folder-sync-current-entity})
1826 @kindex r s (Folder)
1827 @findex wl-folder-check-region
1828 Update new and unread number information of the folders in the currently
1830 (@code{wl-folder-check-region})
1833 @kindex r S (Folder)
1834 @findex wl-folder-sync-region
1835 Update summary information of the folders in the currently selected region.
1836 (@code{wl-folder-sync-region})
1840 @findex wl-status-update
1841 Sync up address book status with @file{~/.addresses}'s content.
1842 (@code{wl-status-update})
1846 @findex wl-folder-prev-unread
1847 Jump cursor to the folder which have unread messages on the upward from
1848 current cursor point.
1849 (@code{wl-folder-prev-unread})
1853 Jump cursor to the folder which have unread messages on the downward
1854 from current cursor point.
1855 (@code{wl-folder-next-unread})
1859 Move cursor to the folder on the previous line.
1860 (@code{wl-folder-prev-entity})
1864 Move cursor to the folder on the next line.
1865 (@code{wl-folder-next-entity})
1869 Jump to the folder specified by the user input.
1870 (@code{wl-folder-jump-folder})
1874 @findex wl-folder-prefetch-current-entity
1875 Prefetch new messages of the folder at the current cursor point by
1876 @code{wl-summary-incorporate}.
1877 If the cursor is on the folder group, it is executed recursively.
1878 (@code{wl-folder-prefetch-current-entity})
1882 @findex wl-folder-mark-as-read-all-current-entity
1883 Mark all unread messages of the folder at the current cursor point as read.
1884 If the cursor is on the folder group, it is executed recursively.
1885 (@code{wl-folder-mark-as-read-all-current-entity})
1889 @findex wl-folder-goto-first-unread-folder
1890 Enter summary mode of the first unread folder.
1891 (@code{wl-folder-goto-first-unread-folder})
1895 @findex wl-folder-empty-trash
1897 (@code{wl-folder-empty-trash})
1901 @findex wl-folder-flush-queue
1903 (@code{wl-folder-flush-queue})
1907 @findex wl-folder-virtual
1908 Move to the virtual folder with the condition specified.
1909 (@code{wl-folder-virtual})
1913 @findex wl-folder-pick
1914 Search the folders with the condition specified.
1915 (@code{wl-folder-pick})
1919 @findex wl-folder-open-all-unread-folder
1920 All unread folder is opened.
1921 (@code{wl-folder-open-all-unread-folder})
1925 @findex wl-folder-open-close
1926 Folder group is opened/closed.
1927 (@code{wl-thread-open-close})
1931 All folder group is opened.
1932 (@code{wl-folder-open-all})
1936 All folder group is closed.
1937 (@code{wl-folder-close-all})
1947 (@code{wl-folder-suspend})
1950 @kindex M-s (Folder)
1951 Save current folder status.
1955 @kindex M-t (Folder)
1956 Toggle Wanderlust's offline/online status.
1957 (@code{wl-toggle-plugged})
1960 @kindex C-t (Folder)
1961 Start Wanderlust's plug-status manager.
1962 (@code{wl-plugged-change})
1965 @subsection Customize variables
1968 @item wl-folders-file
1969 @vindex wl-folders-file
1970 The initial setting is @file{~/.folders}.
1971 Subscribed folders are described (saved) in this file.
1973 @item wl-folder-info-save
1974 @vindex wl-folder-info-save
1975 The initial setting is @code{t}. If non-nil, unread information is
1976 saved and used in the next Wanderlust session.
1978 @item wl-stay-folder-window
1979 @vindex wl-stay-folder-window
1980 The initial setting is @code{nil}.
1981 If non-nil, summary window is appeared on the right side of the folder buffer.
1983 @item wl-folder-window-width
1984 @vindex wl-folder-window-width
1985 The initial setting is 20.
1986 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1988 @item wl-folder-use-frame
1989 @vindex wl-folder-use-frame
1990 The initial setting is @code{nil}.
1991 If non-nil, use new frame for the folder window.
1993 @item wl-folder-many-unsync-threshold
1994 @vindex wl-folder-many-unsync-threshold
1995 The initial setting is 70.
1996 If the number of unread messages is more than this value,
1997 folder color is changed.
1999 @item wl-highlight-folder-by-numbers
2000 @vindex wl-highlight-folder-by-numbers
2001 This option controls how to highlight each line in the folder buffer.
2002 The default value is @code{t}, highlighting with various colors based on
2003 the message numbers. If it is @code{nil}, highlighting with various
2004 colors based on the folder status. In addition, if it is a number
2005 (e.g. 1), highlighting will be done based on both the message numbers
2006 and the folder status.
2008 @item wl-folder-desktop-name
2009 @vindex wl-folder-desktop-name
2010 The initial setting is @samp{Desktop}.
2011 The name of top folder group.
2013 @item wl-folder-petname-alist
2014 @vindex wl-folder-petname-alist
2015 The initial setting is @code{nil}.
2016 An alist of folder's realname and its nickname.
2018 @item wl-folder-access-subscribe-alist
2019 @vindex wl-folder-access-subscribe-alist
2020 The initial setting is @code{nil}.
2022 Control automatic subscribing and unsubscribing of the children list
2028 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2032 If @var{subscribe-flag} is non-nil, folders which have name matched to
2033 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2034 already unsubscribed folder is not displayed even when the
2035 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2042 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2043 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2044 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2045 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2049 @item wl-folder-hierarchy-access-folders
2050 @vindex wl-folder-hierarchy-access-folders
2051 The initial setting is the list shown below:
2060 A list of regular expressions for access groups which creates children
2061 folder list hierarchically.
2063 For example, if you specify
2064 @code{wl-folder-hierarchy-access-folders} like following,
2068 (setq wl-folder-hierarchy-access-folders
2069 '("^-$" "^-alt$" "^-japan$" "^-comp$" "^-comp.unix$"))
2074 you obtain the access group hierarchy as follows.
2080 -fj.comp.announce:0/0/2
2081 -fj.comp.dev.cdrom:0/0/0
2083 [+]-japan:238/238/1688
2086 -comp.unix.admin:0/0/0
2087 -comp.unix.dos-under-unix:0/0/0
2088 -comp.unix.programmer:0/0/0
2089 [-]-comp.unix.bsd:0/0/23
2090 -comp.unix.bsd.freebsd.announce:0/0/0
2095 If you opened @samp{-} in this example, only the direct children is created
2096 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2097 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2098 is not created until the children access group is opened.
2102 @node Folder Manager, , Selecting Folder, Folder
2103 @section Editing Folders
2104 @cindex Folder Manager
2105 @cindex Folder, Edit
2106 @cindex Folder, Subscribe
2107 @cindex Folder, Unsubscribe
2109 As described before, subscribed folder list is saved in @file{~/.folders} file.
2110 But you don't have to edit @file{~/.folders} directly.
2111 You can append, delete, edit folders from folder mode.
2113 @subsection Usage (Tips)
2115 @subsubsection Append Folder
2117 @kbd{m a} appends new folder to the folder mode.
2118 @kbd{m g} appends new folder group.
2119 To append new folder to this group, firstly open it,
2120 then execute append command in the next line.
2122 @subsubsection Edit Folder
2124 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2125 Thus, you can change folder position as if you were editing a normal file.
2127 @subsubsection Create Multi Folder.
2131 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2133 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2135 Type @kbd{m m}, then you can create multi folder.
2138 @subsubsection Delete Nickname, Filter
2140 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2141 minibuffer while appending.
2143 @subsubsection Append Folder to Empty Group
2145 To append new folder to the empty folder group
2146 (after you create folder group by typing @kbd{m g}),
2147 firstly open it, then execute append command in the next line.
2148 If it is closed, folder is appended on the same level with
2149 the folder group above. It is difficult to explain by words so try it.
2150 In other words, appended position depends on the
2151 open/close status of the upper one.
2153 @subsubsection Charset of the Folders File.
2155 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2157 @subsubsection Create Filter
2159 @kbd{m f} adds filter to the folder at the current cursor point. To
2160 create new filter folder and leave the current folder unchanged, copy it
2161 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2162 filter can be specified while appending filter. If you put
2163 ``''(@var{NULL}), filter is deleted.
2165 @subsubsection Sort Folders
2167 Sorting of the folders is executed by the function specified by
2168 @code{wl-fldmgr-sort-function}.
2169 The initial setting is @code{wl-fldmgr-sort-standard},
2170 which sorts alphabetically.
2171 Sorting affects only on the current folder group. It does not
2172 affect on the child groups.
2174 @subsubsection Hiding Folders in the Access Group
2176 Usually, access group displays all children folders, but you can set
2177 some folders hidden. Following operations are only available on access
2180 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2181 (subscribe/unsubscribe) of the folder at current cursor point. Against
2182 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2185 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2186 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2187 argument and if the argument has positive number, the unsubscribe it.
2188 If the prefix argument has negative value, folder becomes visible and if
2189 zero, folder visibility is toggled.
2191 The other commands, @code{wl-fldmgr-subscribe} and
2192 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2195 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2196 executed in the access group, they have a same effect with
2197 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2198 The difference is that cut commands deletes folders from the current
2201 @subsubsection Operations in the Access Group
2203 You can insert and delete folders in the access group like usual folder
2204 group. But insert and delete commands can be only available for the
2205 children folders of the access group and they only sets the subscribe
2206 status. In other words, insertion of the folder means subscribing,
2207 deletion means unsubscribing.
2208 @footnote{In the current implementation,
2209 it is faster to delete region than to unsubscribe region.}
2211 To update the access group when children folders are inserted or deleted
2212 by other way (other than Wanderlust),
2213 open the access group by typing @kbd{C-u @key{RET}}.
2214 @xref{Selecting Folder}.
2216 The order of children folders of access group is saved after
2217 insertion/deletion/sorting.
2218 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2219 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2220 newly created folders are inserted on the top of the access group.
2222 @subsection Key bindings
2223 @cindex Keybind, Folder Mode
2224 @cindex Keybind, Folder Buffer
2226 Key bindings on the folder mode related to folder editing are shown below.
2227 All bindings starts with @kbd{m}, and primary commands are binded to
2228 one stroke key binding.
2232 @kindex m a (Folder)
2233 @findex wl-fldmgr-add
2235 (@code{wl-fldmgr-add})
2240 @kindex m g (Folder)
2241 @findex wl-fldmgr-make-group
2242 Create a folder group.
2243 (@code{wl-fldmgr-make-group})
2246 @kindex m A (Folder)
2247 @findex wl-fldmgr-make-access-group
2248 Create an access group.
2249 (@code{wl-fldmgr-make-access-group})
2252 @kindex m d (Folder)
2253 @findex wl-fldmgr-delete
2254 Delete folder itself and msgdb.
2255 If the folder itself cannot be deleted like NNTP folder,
2256 only msgdb is deleted.
2257 (@code{wl-fldmgr-delete})
2262 @kindex m R (Folder)
2263 @findex wl-fldmgr-rename
2264 Change the name of folder or folder group.
2265 msgdb's path is also changed.
2266 (@code{wl-fldmgr-rename})
2272 @findex wl-fldmgr-make-multi
2273 Create a multi folders in the cutlist (cut, copied folders).
2274 (@code{wl-fldmgr-make-multi})
2279 @kindex m f (Folder)
2280 @findex wl-fldmgr-make-filter
2281 Create a filter folder. (Put a filter on the folder).
2282 (@code{wl-fldmgr-make-filter})
2286 @kindex M-c (Folder)
2287 @kindex m c (Folder)
2288 @findex wl-fldmgr-copy
2289 Copy folder (it is not available on folder group).
2290 (@code{wl-fldmgr-copy})
2294 @kindex M-w (Folder)
2295 @kindex m W (Folder)
2296 @findex wl-fldmgr-copy-region
2297 Copy folders in the specified region.
2298 (@code{wl-fldmgr-copy-region})
2302 @kindex C-k (Folder)
2303 @kindex m k (Folder)
2304 @findex wl-fldmgr-cut
2305 Cut folder. Folder itself is not deleted.
2306 (@code{wl-fldmgr-cut})
2310 @kindex C-w (Folder)
2311 @kindex m C-w (Folder)
2312 @findex wl-fldmgr-cut-region
2313 Cut folders in the specified region.
2314 (@code{wl-fldmgr-cut-region})
2318 @kindex C-y (Folder)
2319 @kindex m y (Folder)
2320 @findex wl-fldmgr-yank
2321 Paste folders that are copied or cut (folders in the cut-list).
2322 (@code{wl-fldmgr-yank})
2325 @kindex m p (Folder)
2326 @findex wl-fldmgr-set-petname
2327 Put nickname on the folder.
2328 (@code{wl-fldmgr-set-petname})
2331 @kindex m q (Folder)
2332 @findex wl-fldmgr-clear-cut-entity-list
2333 Clear the cut-list. (cut, copied folder information is cleared,
2334 you cannot paste after this)
2335 (@code{wl-fldmgr-clear-cut-entity-list})
2338 @kindex m s (Folder)
2339 @findex wl-fldmgr-sort
2340 Sort folders in the current folder group.
2341 (@code{wl-fldmgr-sort})
2344 @kindex m C-s (Folder)
2345 @findex wl-fldmgr-save
2346 Save current folder view to the @file{wl-folders-file}.
2347 (@code{wl-fldmgr-save})
2350 [Following commands are only available on the access groups]
2356 @kindex m u (Folder)
2357 @findex wl-fldmgr-unsubscribe
2358 Set the visibility of folder (subscribe/unsubscribe).
2359 (@code{wl-fldmgr-unsubscribe})
2364 @kindex r u (Folder)
2365 @findex wl-fldmgr-unsubscribe-region
2366 Set the visibility of the folders (subscribe/unsubscribe) in the
2368 (@code{wl-fldmgr-unsubscribe-region})
2373 @kindex m l (Folder)
2374 @findex wl-fldmgr-access-display-normal
2375 List folders that are currently available.
2376 (@code{wl-fldmgr-access-display-normal})
2381 @kindex m L (Folder)
2382 @findex wl-fldmgr-access-display-all
2383 List all folders regardless of the subscription status.
2384 (@code{wl-fldmgr-access-display-all})
2388 @subsection Customize variables
2391 @item wl-interactive-save-folders
2392 @vindex wl-interactive-save-folders
2393 The initial setting is @code{t}. If non-nil and folder view is
2394 modified, confirm saving it before Wanderlust or Emacs exits. If
2395 @code{nil}, save without confirmation.
2397 @item wl-fldmgr-make-backup
2398 @vindex wl-fldmgr-make-backup
2399 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2400 created before saving the folder status.
2402 @item wl-fldmgr-sort-function
2403 @vindex wl-fldmgr-sort-function
2404 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2405 sort folders. By default function, folders are sorted alphabetically
2406 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2409 @item wl-fldmgr-sort-group-first
2410 @vindex wl-fldmgr-sort-group-first
2411 The initial setting is @code{t}. If non-nil,
2412 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2413 does not care whether it is folder group or not.
2415 @item wl-folder-check-async
2416 @vindex wl-folder-check-async
2417 The initial setting is @code{t}. If non-nil, check folder's unread
2418 status asynchronously. It boosts newsgroup checking.
2420 @item wl-folder-check-fast
2421 @vindex wl-folder-check-fast
2422 The initial setting is @code{nil}.
2423 If non-nil, it does not update folder status while checking.
2425 @item wl-folder-notify-deleted
2426 @vindex wl-folder-notify-deleted
2427 The initial setting is @code{nil}.
2429 If non-nil, negative value is displayed when the message is deleted. If
2430 @code{sync}, folder is synchronized when the message is deleted. If
2431 @code{nil}, message deletion is ignored.
2433 @item wl-fldmgr-add-complete-with-current-folder-list
2434 @vindex wl-fldmgr-add-complete-with-current-folder-list
2435 The initial setting is @code{nil}.
2436 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2437 candidate for @code{wl-fldmgr-add}.
2440 @subsection Miscellanea
2442 Following is a note for folder editing.
2446 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2447 paste(yank) command pastes the folders on one cut or copy command
2448 (If copy command is executed by region, folders in the region are pasted
2449 by one paste command)
2452 You cannot cut @samp{Desktop} group.
2453 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2456 You cannot copy folder group.
2459 Operations on the access group are only available for the folders
2460 in the same access group.
2463 You cannot create a folder which has same name with the folders already exist.
2466 You cannot insert folders which have same name in one group.
2467 You can insert them in the different groups.
2468 You cannot put same nickname to the different folders.
2472 @node Summary, Message, Folder, Top
2473 @chapter Summary Mode
2475 After you select the folder via folder mode, you enter to the summary
2479 * Usage of Summary Mode:: TIPS
2480 * Thread Operations:: Thread operations
2481 * Cache:: File cache, Buffer cache, and Prefetch
2482 * Auto Refile:: Auto refile settings
2483 * Sticky Summary:: Summary make sticky
2484 * Summary View:: Format of summary lines
2485 * Key Bindings of Summary:: Key bindings
2486 * Variables of Summary:: Customize Summary Mode
2490 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2491 @section Usage (Tips)
2493 @subsection Summary Content
2495 In the summary mode, messages are displayed like following.
2499 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2500 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2501 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2502 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2509 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2513 If you want to know how to change the format for this, please refer
2514 the section format of Summary lines.
2515 @xref{Summary View}.
2517 @var{Message number} is the message's unique number in the folder. In
2518 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2519 in the MH folder, it is the filename of the message.
2521 @var{Temporal mark} and @var{Persistent mark} are described later.
2523 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2524 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2525 Japanese, but if you want to display it in English, set the value of
2526 @code{wl-summary-weekday-name-lang} as @samp{en}.
2528 @var{Sender}'s indentation corresponds to the depth of the thread.
2529 Sender name is displayed as nickname if it is defined in the address
2530 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2531 displaying with nickname.
2533 If number is printed at the head of @var{Sender} part like @samp{+2},
2534 that means the message have 2 follow messages.
2536 @var{Subject} is the @samp{Subject:} header field of the message. If
2537 the message have same @samp{Subject:} with the parent message, it is not
2538 displayed. Some mailing list puts its sequence number in the
2539 @samp{Subject:} field, but it is
2540 ignored. @code{wl-summary-no-subject-message} is displayed when the
2541 message has empty subject field.
2543 @subsection Temporary Marks
2544 @cindex Mark, Temporary
2546 There are four temporary marks,
2547 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2548 Temporary marks indicates message operations.
2553 You can execute a command on the all messages that have @samp{*} mark,
2554 with the key bindings which begins with @kbd{m}.
2557 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2561 After you type @kbd{o} key, prompt appears to input refile destination.
2562 Your answer is printed in the summary line.
2566 You can put this mark by typing @kbd{O} key.
2567 The difference between this mark and refile mark is,
2568 this mark does not delete the message while latter does.
2571 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2573 @subsection Persistent Marks
2575 There are five persistent marks,
2576 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2578 The persistent mark indicates the message's status and it is saved.
2579 Each persistent mark indicates:
2585 It is unread message.
2587 It is unread but cached message.
2589 It is read but it is not cached.
2591 It is important message. You can put @samp{$} mark by typing @kbd{$}
2592 key (if already exists, the mark is deleted). It is convenient to put
2593 this mark on the messages to remember (If you want to remember to write
2594 a reply for the message, for example) because this mark remains after
2595 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2596 @samp{'mark} folder even the message itself is deleted in the actual folder.
2599 If the message is read and cached (or local message),there are no
2603 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2604 cache. Messages with the marks other than these, you can read them in
2605 the offline status even they are in the IMAP folder or netnews folder.
2607 Among messages with persistent marks, ones with marks specified by
2608 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2609 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2611 @subsection How To Read
2613 Basically, you can read messages only typing space key again and again.
2615 To update summary status to the newest status (synchronize),
2618 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2619 moves cursor to the next message.
2620 Enter message buffer by typing @kbd{j} key.
2621 To operate multipart, you have to enter to the message buffer.
2624 @subsection Pack the Message Numbers
2625 You can pack the message numbers in Summary by
2626 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2627 News Spool Folder and Maildir Folder are supported folder types.
2630 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2631 @section Thread Operations
2633 For example, the following line indicates one thread (a context of a topic).
2636 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2640 If you type @kbd{/} on this line, the thread is opened and it changes
2641 the appearance like following.
2645 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2646 388 09/17(Thu)22:34 +-[ Murata san ]
2650 (Message 388 is the replied message to the message 384.)
2651 If you type @kbd{/} key once again, the thread is closed.
2652 With prefix argument, @kbd{/} opens all children threads.
2654 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2657 Commands with the key binding that begins with @kbd{t} executes commands
2658 on the messages in the thread.
2659 @xref{Key Bindings of Summary}.
2661 @subsection reconstruct thread by hand
2663 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2664 (@code{wl-summary-save-current-message}) at the corresponding message,
2665 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2666 message then you have the reconstructed thread.
2669 @node Cache, Auto Refile, Thread Operations, Summary
2672 @subsection Cache File
2674 The messages which have to access via network (e.x. IMAP, NNTP folder)
2675 are cached as a local file so as to save network traffic or to enable
2676 off-line operation. The cache file is saved under the directory
2677 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2678 elmo-cache-expire-by-size}. The command deletes cache files to the
2679 specified size by the order of last accessed time.
2681 @subsection Buffer Cache and Prefetching
2683 The messages that are read are kept in the cache buffer so as to make
2684 the behavior fast when you are to read the message again. It is called
2685 `buffer cache'. The number of cache buffer is specified by
2686 @code{wl-message-buffer-cache-size}.
2688 There are message prefetching mechanism in the Wanderlust that
2689 prefetches next message while you are reading.
2691 You can control the message prefetching mechanism by these two
2695 @item wl-message-buffer-prefetch-folder-type-list
2696 @vindex wl-message-buffer-prefetch-folder-type-list
2697 The initial setting is @code{t}. In this case, prefetch messages in all
2699 If it is a list of folder types, it specifies the folder types in which
2700 message prefetching is enabled.
2701 Following is an example (prefetch messages in nntp and imap4 folders)
2705 (setq wl-message-buffer-prefetch-folder-type-list
2710 In this case, multi folder that contains localdir and imap4 prefetches
2711 only imap4 messages. This variable precedes the value of
2712 @code{wl-message-buffer-prefetch-folder-list}.
2714 @item wl-message-buffer-prefetch-folder-list
2715 @vindex wl-message-buffer-prefetch-folder-list
2716 The initial setting is @code{nil}.
2717 A list of regexp of folders to enable message prefetching.
2719 @item wl-message-buffer-prefetch-depth
2720 @vindex wl-message-buffer-prefetch-depth
2721 The initial setting is 3. The number of messages for automatical prefetch.
2723 @item wl-message-buffer-prefetch-idle-time
2724 @vindex wl-message-buffer-prefetch-idle-time
2725 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2727 @item wl-message-buffer-prefetch-threshold
2728 @vindex wl-message-buffer-prefetch-threshold
2729 The initial setting is 30000 (bytes). If prefetching message has larger
2730 size than this value, Wanderlust does not prefetch automatically.
2731 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2732 the message is not checked for the size.
2734 @item wl-auto-prefetch-first
2735 @vindex wl-auto-prefetch-first
2736 The initial setting is @code{nil}.
2737 If non-nil, first message is automatically prefetched to the buffer
2738 when you enter the folder.
2742 @node Auto Refile, Sticky Summary, Cache, Summary
2743 @section Auto Refile
2744 @vindex elmo-msgdb-extra-fields
2745 @vindex wl-refile-rule-alist
2746 @findex wl-summary-auto-refile
2748 You can refile messages automatically, by typing @kbd{C-o}
2749 (@code{wl-summary-auto-refile}). It decides destination of refile by
2750 the content of the message header information (information in the msgdb).
2752 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2753 available. If you want to decide destination by other header fields,
2754 set the variable @code{elmo-msgdb-extra-fields} like following.
2758 (setq elmo-msgdb-extra-fields
2768 By this setting, Wanderlust saves extra fields in the msgdb. You have
2769 to type @kbd{s all} to get extra fields for the messages that are
2770 already exists in the summary.
2772 Then, specify the refile rule. The refile target folder of auto
2773 refiling is decided by the value of @code{wl-refile-rule-alist}.
2774 @code{wl-refile-rule-alist} is a list of a rule:
2778 (@var{field} (@var{regexp} . @var{target})
2779 (@var{regexp} . @var{target})
2784 Each rule means `if @var{field} value matches @var{regexp},
2785 then refile to @var{target} folder'.
2786 The rule matched first is applied.
2788 @var{field} is a string of field name. You can specify a list of field name
2789 string, too. In this case, if one of these fields is matched, then the
2790 rule is fired (i.e. OR condition).
2792 @var{regexp} is a regular expression for field value. @var{target} is a target
2793 folder string. You can specify a rule at @var{target} part, too. In this
2794 case, If the field value of the rule and the current rule is matched,
2795 then the current rule is fired (i.e. AND condition).
2797 You can refer matched substring of @var{regexp} to specify @var{target} part.
2798 To refer substring, use following keys:
2802 means substitute original matched text.
2805 means substitute what matched the @var{N}th `\(@dots{}\)'.
2806 (@var{N} is a number.)
2809 Following is an example of @code{wl-refile-rule-alist}.
2813 (setq wl-refile-rule-alist
2815 ("^Wanderlust" . "+wl")
2816 ("^Elisp" . "+elisp"))
2818 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2820 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2821 "+from-me-to-you"))))))
2825 After these settings, refile marks are automatically put on the condition
2826 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2828 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2830 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2831 with these persistent marks are not automatically refiled.
2832 It means Wanderlust does not execute auto refile on unread messages by
2833 the default setting.
2834 To execute auto refile on all messages, set following.
2837 (setq wl-summary-auto-refile-skip-marks nil)
2841 @node Sticky Summary, Summary View, Auto Refile, Summary
2842 @section Sticky Summary
2843 @cindex Summary, Sticky
2844 @cindex Sticky Summary
2846 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2848 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2849 @kbd{G} in some suummary sticky summary buffer is created.
2850 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2851 makes current one sticky.
2853 The buffer name of the sticky summary becomes like
2854 @samp{Summary:@var{folder-name}}.
2855 You can visit the sticky summary at any time by @kbd{C-x b}
2856 (@code{switch-to-buffer}), or you can go round summary buffers by
2857 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2858 (@code{wl-summary-next-buffer}) in summary mode.
2860 In sticky summary, the summary buffer is preserved after @kbd{g} or
2861 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2862 another summary by @kbd{C-u g}. Other operations in the sticky summary
2863 are same as normal summary.
2865 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2866 are automatically stuck.
2869 @node Summary View, Key Bindings of Summary, Sticky Summary, Summary
2870 @section Format of summary lines
2871 @cindex Format of summary lines
2872 You can alter the format of lines in Summary mode.
2874 Summary line format is specified by @code{wl-summary-line-format}.
2875 You can use control strings defined by
2876 @code{wl-summary-line-format-spec-alist}.
2882 ;; @r{number temporary-mark persistent-mark date branch}
2883 ;; @r{[ (number-of-children) sender ] subject}
2884 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
2888 Where the number set the column number of the field (for negative value,
2891 Major control strings defined by @code{wl-summary-line-format-spec-alist}
2892 are displayed in the following list.
2903 %t branch of the thread
2904 %[ [ (< for re-connected child)
2905 %] ] (> for re-connected child)
2909 %c +number-of-children: (display only for opened thread)
2910 %C [+number-of-children] (display only for opened thread)
2911 %T temporary mark (mandatory)
2912 %P persistent mark (mandatory)
2916 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
2917 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
2918 the constant column. For example, if you specify @samp{%T} or
2919 @samp{%P} after the @samp{%t}, which changes its length by thread
2920 position, marks are not treated correctly.
2922 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
2923 column of the enclosed region is justified to the `number'. Multiple
2924 level @samp{%number(} parenthesis can be defined. It is useful to
2925 justify the column of the multiple control strings. For example, in the
2926 above @code{wl-summary-line-format},
2932 means ``Adjust number-of-children and sender string to the 17 column''.
2934 You can specify the format by each folders with
2935 @code{wl-folder-summary-line-format-alist}. Please set regular
2936 expression for folder names and summary line format as the following
2941 (setq wl-folder-summary-line-format-alist
2942 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
2943 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
2947 @subsection on the format for sender name
2949 The format string @samp{%f} displays the return value of the function specified
2950 by @code{wl-summary-from-function}. If you use the function
2951 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
2952 while displays the recipient names if the folder name matches with
2953 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
2954 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
2956 For example, to display recipient names for the message in @samp{+backup} if
2957 its sender is yourself, set up as follows.
2960 (setq wl-summary-showto-folder-regexp "^\\+backup$")
2964 @node Key Bindings of Summary, Variables of Summary, Summary View, Summary
2965 @section Key bindings
2966 @cindex Keybind, Summary Mode
2967 @cindex Keybind, Summary Buffer
2969 Key bindings of the summary mode are shown below.
2973 @kindex @key{SPC} (Summary)
2974 @findex wl-summary-read
2975 Proceed reading a message at the current cursor point.
2976 (@code{wl-summary-read})
2980 @findex wl-summary-redisplay
2981 Redisplay a message at the current cursor point.
2982 If this command is called with prefix argument,
2983 Redisplay message regardless of the message cache (message is re-loaded
2985 (@code{wl-summary-redisplay})
2989 @findex wl-summary-display-top
2990 Display the top message in the folder.
2991 (@code{wl-summary-display-top})
2995 @findex wl-summary-display-bottom
2996 Display the bottom message in the folder.
2997 (@code{wl-summary-display-bottom})
3001 @kindex @key{BS} (Summary)
3002 @kindex @key{DEL} (Summary)
3003 Display the previous page of the message at the current cursor point.
3004 @findex wl-summary-prev-page
3005 (@code{wl-summary-prev-page})
3008 @kindex @key{RET} (Summary)
3009 @findex wl-summary-next-line-content
3010 Display the next line of the message at the current cursor point.
3011 Display the message at the current cursor point if it is not displayed yet.
3012 (@code{wl-summary-next-line-content})
3017 @kindex M-@key{RET} (Summary)
3018 @findex wl-summary-prev-line-content
3019 Display the previous line of the message at the current cursor point.
3020 Display the message at the current cursor point if it is not displayed yet.
3021 (@code{wl-summary-prev-line-content})
3025 @findex wl-thread-open-close
3026 Toggle open or close the thread at the current cursor point.
3027 (@code{wl-thread-open-close})
3032 @findex wl-thread-open-all
3033 (@code{wl-thread-open-all})
3038 @findex wl-thread-close-all
3039 (@code{wl-thread-close-all})
3043 @findex wl-summary-goto-folder
3045 (@code{wl-summary-goto-folder})
3049 Mark all messages in the folder as read.
3050 @findex wl-summary-mark-as-read-all
3051 (@code{wl-summary-mark-as-read-all})
3055 @findex wl-summary-reply
3056 Prepare a draft for reply the message at the current cursor point.
3057 (@code{wl-summary-reply})
3061 @findex wl-summary-reply-with-citation
3062 Prepare a draft for reply the message at the current cursor point.
3063 (@code{wl-summary-reply-with-citation})
3067 @findex wl-summary-cancel-message
3068 If the message at current cursor point is your own netnews article,
3070 (@code{wl-summary-cancel-message})
3074 @findex wl-summary-reedit
3075 Prepare a draft for re-editing the message at current cursor point.
3076 If the message at current cursor point is your own netnews article,
3077 a draft for `supersedes message' for the message is prepared.
3078 (@code{wl-summary-reedit})
3081 @kindex M-E (Summary)
3082 @findex wl-summary-resend-bounced-mail
3083 If the message at current cursor point is a bounced message,
3084 a draft for re-sending original message is prepared.
3085 (@code{wl-summary-resend-bounced-mail})
3089 @findex wl-summary-forward
3090 A draft for forwarding the message at current cursor point is prepared.
3091 (@code{wl-summary-forward})
3095 @findex wl-summary-mark-as-important
3096 Put @samp{$} mark on the message at current cursor point.
3097 If already marked as @samp{$}, delete it.
3098 (@code{wl-summary-mark-as-important})
3104 Save the message at current cursor point.
3105 @findex wl-summary-save
3106 (@code{wl-summary-save})
3110 @findex wl-summary-next
3111 Move cursor to the next message.
3112 If message is marked with a temporal mark in
3113 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3114 In the offline mode, cursor is not moved to the messages which are not cached
3116 (@code{wl-summary-next})
3120 @findex wl-summary-prev
3121 Move cursor to the previous message.
3122 If message is marked with a temporal mark in
3123 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3124 In the offline mode, cursor is not moved to the messages which are not cached
3126 (@code{wl-summary-prev})
3130 @findex wl-summary-down
3131 Move cursor to the downward message which is unread or marked
3133 In the offline mode, cursor is not moved to the messages which are not cached
3135 If there are messages which have target mark @samp{*} in the summary,
3136 cursor is moved to the downward message which have a target mark.
3137 This behavior is changed according to the value of @code{wl-summary-move-order}.
3138 (@code{wl-summary-down})
3142 @findex wl-summary-up
3143 Move cursor to the upward message which is unread or marked
3145 In the offline mode, cursor is not moved to the messages which are not cached
3147 If there are messages which have target mark @samp{*} in the summary,
3148 cursor is moved to the downward message which have a target mark.
3149 This behavior is changed according to the value of @code{wl-summary-move-order}.
3150 (@code{wl-summary-up})
3154 @findex wl-summary-write
3155 Prepare a new draft.
3156 (@code{wl-summary-write})
3160 @findex wl-summary-write-current-folder
3161 Prepare a new draft. If the current folder is NNTP folder,
3162 @samp{Newsgroups:} field is completed. If the current folder is mailing
3163 list folder (refile destination), guess @samp{To:} field and completed
3164 (If @code{wl-subscribed-mailing-list} is valid list)
3165 (@code{wl-summary-write-current-folder})
3169 @findex wl-summary-redisplay-all-header
3170 Redisplay the message at current cursor point with all header fields.
3171 (@code{wl-summary-redisplay-all-header})
3175 @findex wl-summary-redisplay-no-mime
3176 Redisplay the message at current cursor point without MIME analysis.
3177 (@code{wl-summary-redisplay-no-mime})
3181 @findex wl-summary-burst
3182 If the message at current cursor point has
3183 encapsulates multiple messages using MIME,
3184 de-capsulate and extract them on the current folder.
3185 If it is invoked in non-writable folder or it is called with prefix
3186 argument, it asks the destination folder.
3187 (@code{wl-summary-burst})
3190 @kindex @@ (Summary)
3191 @findex wl-summary-edit-addresses
3192 Append/change/delete the message's sender information to the address
3193 book @file{~/.addresses} interactively. If this command is called with
3194 prefix argument, arbitrary address can be edited.
3195 (@code{wl-summary-edit-petname})
3199 @findex wl-status-update
3200 Sync up address book status with @file{~/.addresses}'s content.
3201 (@code{wl-status-update})
3205 @findex wl-summary-pipe-message
3206 Pipe current message's content to the external process.
3207 (@code{wl-summary-pipe-message})
3211 @findex wl-summary-print-message
3212 Print out current message's content.
3213 It uses @code{ps-print} module in Emacs 20.x.
3214 If you don't use color printer, you might want to set
3215 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3218 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3221 (@code{wl-summary-print-message})
3225 @findex wl-summary-exit
3226 Exit current folder.
3227 (@code{wl-summary-exit})
3231 @findex wl-summary-jump-to-current-message
3232 Jump cursor to the currently displayed message's window.
3233 (@code{wl-summary-jump-to-current-message})
3237 Jump cursor to the other message.
3238 @findex wl-summary-jump-to-msg
3239 (@code{wl-summary-jump-to-msg})
3243 Update summary status and
3244 prefetch all messages which have marks included in the
3245 @code{wl-summary-incorporate-marks}.
3246 @findex wl-summary-incorporate
3247 (@code{wl-summary-incorporate})
3250 @kindex M-j (Summary)
3251 @findex wl-summary-jump-to-msg-by-message-id
3252 Jump cursor to the message which have specified @samp{Message-Id:}. If
3253 @code{elmo-use-database} is non-nil, other folder is also searched.
3254 (@code{wl-summary-jump-to-msg-by-message-id})
3258 Jump to parent message.
3259 @findex wl-summary-jump-to-parent-message
3260 (@code{wl-summary-jump-to-parent-message})
3264 @findex wl-summary-mark-as-unread
3265 Mark as unread the message at current cursor point.
3266 (@code{wl-summary-mark-as-unread})
3270 @findex wl-summary-sync
3271 Synchronize summary view after prompting the update range
3272 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3276 all ...Discard current summary and update all message.
3277 all-visible ...Discard current summary and update all visible message.
3278 update ...Update the difference between summary and the folder itself.
3279 rescan ...Rescan the msgdb and display again.
3280 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3281 cache-status ...Sync the all marks with the real status of cache.
3282 first, last ...Move to the filter folder(partial filter).
3287 (@code{wl-summary-sync})
3291 @findex wl-summary-sort
3293 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3294 (@code{wl-summary-sort})
3298 @findex wl-summary-toggle-thread
3299 Toggle the threading. The state will be preserved after exiting
3300 Wanderlust. You can alter default state for newly created summary
3301 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3302 Threading status is displayed on the modeline.
3303 @samp{@{S@}} means threading is off (Sequence) and
3304 @samp{@{T@}} means threading is on (Thread).
3305 (@code{wl-summary-toggle-thread})
3309 @findex wl-summary-toggle-disp-folder
3310 Toggle displaying of folder window.
3311 (@code{wl-summary-toggle-disp-folder})
3315 Toggle displaying of message window.
3316 @findex wl-summary-toggle-disp-msg
3317 (@code{wl-summary-toggle-disp-msg})
3321 Move to the virtual folder with the condition specified.
3322 If called with prefix argument and current folder is virtual, exit it.
3323 @findex wl-summary-virtual
3324 (@code{wl-summary-virtual})
3327 @kindex @key{TAB} (Summary)
3328 @findex wl-summary-goto-last-displayed-msg
3329 Jump to the message which is displayed last.
3330 (@code{wl-summary-goto-last-displayed-msg})
3334 Put @samp{*} mark on the messages that satisfies the specified condition.
3335 @findex wl-summary-pick
3336 (@code{wl-summary-pick})
3340 @findex wl-summary-mark-as-read
3341 Mark as read the message at the current cursor point.
3342 (@code{wl-summary-mark-as-read})
3346 Prefetch the message at the current cursor point.
3347 With prefix argument, prefetch the message even if it is cached.
3348 @findex wl-summary-prefetch
3349 (@code{wl-summary-prefetch})
3353 Execute @samp{D}, @samp{o} and @samp{O} marks.
3354 @findex wl-summary-exec
3355 (@code{wl-summary-exec})
3359 @findex wl-summary-target-mark-line
3360 Put target mark on the message at the current cursor point.
3361 (@code{wl-summary-target-mark-line})
3365 Put refile mark on the message at the current cursor point.
3366 @findex wl-summary-refile
3367 (@code{wl-summary-refile})
3370 @kindex C-o (Summary)
3371 Execute auto refile.
3372 @findex wl-summary-auto-refile
3373 (@code{wl-summary-auto-refile})
3377 Put copy mark on the message at the current cursor point.
3378 @findex wl-summary-copy
3379 (@code{wl-summary-copy})
3382 @kindex M-o (Summary)
3383 Put refile mark on the message at the current cursor point with the destination
3384 previously specified.
3385 @findex wl-summary-refile-prev-destination
3386 (@code{wl-summary-refile-prev-destination})
3390 @findex wl-summary-delete
3391 Put delete mark on the message at the current cursor point.
3392 (@code{wl-summary-delete})
3396 @findex wl-summary-unmark
3397 Unmark the temporal mark on the message at the current cursor point.
3398 (@code{wl-summary-unmark})
3402 Unmark all the temporal marks.
3403 @findex wl-summary-unmark-all
3404 (@code{wl-summary-unmark-all})
3407 @kindex r R (Summary)
3408 @findex wl-summary-mark-as-read-region
3409 Mark as read messages in the specified region.
3410 (@code{wl-summary-mark-as-read-region})
3413 @kindex r $ (Summary)
3414 @findex wl-summary-mark-as-important-region
3415 Mark as important @samp{$} messages in the specified region.
3416 If @samp{$} already exists, it is deleted.
3417 (@code{wl-summary-mark-as-important-region})
3420 @kindex r ! (Summary)
3421 @findex wl-summary-mark-as-unread-region
3422 Mark as unread messages in the specified region.
3423 (@code{wl-summary-mark-as-unread-region})
3426 @kindex r i (Summary)
3427 @findex wl-summary-prefetch-region
3428 Prefetch messages in the specified region.
3429 (@code{wl-summary-prefetch-region})
3432 @kindex r x (Summary)
3433 @findex wl-summary-exec-region
3434 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3436 (@code{wl-summary-exec-region})
3439 @kindex r * (Summary)
3440 @findex wl-summary-target-mark-region
3441 Put target mark on the messages in the specified region.
3442 (@code{wl-summary-target-mark-region})
3445 @kindex r o (Summary)
3446 @findex wl-summary-refile-region
3447 Put refile mark on the messages in the specified region.
3448 (@code{wl-summary-refile-region})
3451 @kindex r O (Summary)
3452 @findex wl-summary-copy-region
3453 Put copy mark on the messages in the specified region.
3454 (@code{wl-summary-copy-region})
3457 @kindex r d (Summary)
3458 @findex wl-summary-delete-region
3459 Put delete mark on the messages in the specified region.
3460 (@code{wl-summary-delete-region})
3463 @kindex r u (Summary)
3464 @findex wl-summary-unmark-region
3465 Delete temporal mark on the messages in the specified region.
3466 (@code{wl-summary-unmark-region})
3469 @kindex r y (Summary)
3470 Save messages in the specified region.
3471 @findex wl-summary-save-region
3472 (@code{wl-summary-save-region})
3475 @kindex t R (Summary)
3476 @findex wl-thread-mark-as-read
3477 Mark as read messages which are the descendant of the current thread.
3478 With prefix argument, it affects on the all messages in the thread tree.
3479 (@code{wl-thread-mark-as-read})
3482 @kindex t $ (Summary)
3483 @findex wl-thread-mark-as-important
3484 Put important mark @samp{$} on the messages which are the
3485 descendant of the current thread.
3486 If @samp{$} mark exists, it is deleted.
3487 With prefix argument, it affects on the all messages in the thread tree.
3488 (@code{wl-thread-mark-as-important})
3491 @kindex t ! (Summary)
3492 @findex wl-thread-mark-as-unread
3493 Mark as unread messages which are the descendant of the current thread.
3494 With prefix argument, it affects on the all messages in the thread tree.
3495 (@code{wl-thread-mark-as-unread})
3498 @kindex t i (Summary)
3499 @findex wl-thread-prefetch
3500 Prefetch messages which are the descendant of the current thread.
3501 With prefix argument, it affects on the all messages in the thread tree.
3502 (@code{wl-thread-prefetch})
3505 @kindex t x (Summary)
3506 @findex wl-thread-exec
3507 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3508 the descendant of the current thread. With prefix argument, it affects
3509 on the all messages in the thread tree.
3510 (@code{wl-thread-exec})
3513 @kindex t * (Summary)
3514 @findex wl-thread-target-mark
3515 Put target mark @samp{*} on the messages which are the descendant of the
3516 current thread. With prefix argument, it affects on the all messages in
3518 (@code{wl-thread-target-mark})
3521 @kindex t o (Summary)
3522 @findex wl-thread-refile
3523 Put refile mark on the messages which are the descendant of the current thread.
3524 With prefix argument, it affects on the all messages in the thread tree.
3525 (@code{wl-thread-refile})
3528 @kindex t O (Summary)
3529 @findex wl-thread-copy
3530 Put copy mark on the messages which are the descendant of the current thread.
3531 With prefix argument, it affects on the all messages in the thread tree.
3532 (@code{wl-thread-copy})
3535 @kindex t d (Summary)
3536 @findex wl-thread-delete
3537 Put delete mar on the messages which are the descendant of the current thread.
3538 With prefix argument, it affects on the all messages in the thread tree.
3539 (@code{wl-thread-delete})
3542 @kindex t u (Summary)
3543 @findex wl-thread-unmark
3544 Unmark temporal mark on the messages which are the descendant of the
3545 current thread. With prefix argument, it affects on the all messages in
3547 (@code{wl-thread-unmark})
3550 @kindex t y (Summary)
3551 @findex wl-thread-save
3552 Save messages which are the descendant of the current thread.
3553 With prefix argument, it affects on the all messages in the thread tree.
3554 (@code{wl-thread-save})
3557 @kindex m i (Summary)
3558 @findex wl-summary-target-mark-prefetch
3559 Prefetch all messages which have target mark @samp{*}.
3560 With prefix argument, prefetch all targets even if some of them are cached.
3561 (@code{wl-summary-target-mark-prefetch})
3564 @kindex m R (Summary)
3565 @findex wl-summary-target-mark-mark-as-read
3566 Mark as read all messages which have target mark @samp{*}.
3567 (@code{wl-summary-target-mark-mark-as-read})
3570 @kindex m $ (Summary)
3571 @findex wl-summary-target-mark-mark-as-important
3572 Mark as important all messages which have target mark @samp{*}.
3573 If already marked as @samp{$}, it is deleted.
3574 (@code{wl-summary-target-mark-mark-as-important})
3577 @kindex m ! (Summary)
3578 @findex wl-summary-target-mark-mark-as-unread
3579 Mark as unread all messages which have target mark @samp{*}.
3580 (@code{wl-summary-target-mark-mark-as-unread})
3583 @kindex m o (Summary)
3584 @findex wl-summary-target-mark-refile
3585 Put refile mark on the messages which have target mark @samp{*}.
3586 (@code{wl-summary-target-mark-refile})
3589 @kindex m O (Summary)
3590 @findex wl-summary-target-mark-copy
3591 Put copy mark on the messages which have target mark @samp{*}.
3592 (@code{wl-summary-target-mark-copy})
3595 @kindex m d (Summary)
3596 @findex wl-summary-target-mark-delete
3597 Put delete mark on the messages which have target mark @samp{*}.
3598 (@code{wl-summary-target-mark-delete})
3601 @kindex m y (Summary)
3602 @findex wl-summary-target-mark-save
3603 Save messages which have target mark @samp{*}.
3604 (@code{wl-summary-target-mark-save})
3607 @kindex m u (Summary)
3608 Unmark all temporal marks.
3609 (@code{wl-summary-delete-all-temp-marks})
3610 @findex wl-summary-delete-all-temp-marks
3613 @kindex m a (Summary)
3614 Put target mark @samp{*} on the all messages.
3615 (@code{wl-summary-target-mark-all})
3616 @findex wl-summary-target-mark-all
3619 @kindex m t (Summary)
3620 Put target mark @samp{*} on the messages in the current thread.
3621 @findex wl-summary-target-mark-thread
3622 (@code{wl-summary-target-mark-thread})
3625 @kindex m r (Summary)
3626 @findex wl-summary-target-mark-region
3627 Put target mark @samp{*} on the messages in the specified region.
3628 (@code{wl-summary-target-mark-region})
3631 @kindex m A (Summary)
3632 @findex wl-summary-target-mark-reply-with-citation
3633 Prepare a draft which cites all messages which have target mark @samp{*}.
3634 (@code{wl-summary-target-mark-reply-with-citation})
3637 @kindex m f (Summary)
3638 @findex wl-summary-target-mark-forward
3639 Prepare a draft which forwards all messages which have target mark @samp{*}.
3640 (@code{wl-summary-target-mark-forward})
3643 @kindex m U (Summary)
3644 @findex wl-summary-target-mark-uudecode
3645 Uudecode the messages which have target mark @samp{*}.
3646 (@code{wl-summary-target-mark-uudecode})
3649 @kindex m ? (Summary)
3650 @findex wl-summary-target-mark-pick
3651 Pick messages from the @samp{*} marked messages.
3652 That is, @samp{*} marks on the messages are remained
3653 if the specified condition is satisfied.
3654 (@code{wl-summary-target-mark-pick})
3657 @kindex m # (Summary)
3658 @findex wl-summary-target-mark-print
3659 Print out all messages which have target mark @samp{*}.
3660 (@code{wl-summary-target-mark-print})
3663 @kindex m | (Summary)
3664 @findex wl-summary-target-mark-pipe
3665 Pipe content of each message with target mark @samp{*} to some specified
3667 (@code{wl-summary-target-mark-pipe})
3671 @findex wl-summary-erase
3672 Actually erase the message at once, without moving it to trash.
3673 (@code{wl-summary-erase})
3676 @kindex M-t (Summary)
3677 @findex wl-toggle-plugged
3678 Toggle offline/online status of Wanderlust.
3679 (@code{wl-toggle-plugged})
3682 @kindex C-t (Summary)
3683 Start Wanderlust's plug-status manager.
3684 (@code{wl-plugged-change})
3687 @kindex C-c C-o (Summary)
3688 @findex wl-jump-to-draft-buffer
3689 Move to the draft buffer if available. If multiple draft buffer exists,
3690 moved to one after another. If prefix argument is specified, load draft
3691 folder's message to the draft buffer and jump to it.
3692 (@code{wl-jump-to-draft-buffer})
3695 @kindex M-w (Summary)
3696 @findex wl-summary-save-current-message
3697 Save the message at the current cursor point.
3698 (@code{wl-summary-save-current-message})
3701 @kindex C-y (Summary)
3702 @findex wl-summary-yank-saved-message
3703 Regard the message at the current cursor point as
3704 parent, connect the message saved by
3705 @code{wl-summary-save-current-message}
3707 (@code{wl-summary-yank-saved-message})
3710 @kindex C-x C-s (Summary)
3711 @findex wl-summary-save-status
3712 Save the current summary.
3713 (@code{wl-summary-save-status})
3717 @node Variables of Summary, , Key Bindings of Summary, Summary
3718 @section Customiziable variables
3721 @item wl-summary-move-order
3722 @vindex wl-summary-move-order
3723 The initial setting is @code{unread}. Specify cursor moving policy. If
3724 you want to precede new messages, set @code{new}. If you want to
3725 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3728 @item wl-auto-select-first
3729 @vindex wl-auto-select-first
3730 The initial setting is @code{nil}.
3731 If non-nil, first message is automatically displayed when you enter
3734 @item wl-auto-select-next
3735 @vindex wl-auto-select-next
3736 The initial setting is @code{nil}. This controls behavior when there is
3737 no unread message in current summary.
3740 nil: asks whether you want to go back to folder mode
3741 'unread: asks whether you want to go to next unread folder
3742 If the next one comes to be possessing no unread message
3743 by treatment of cross-posted messages or Scoring, then
3744 asks whether you want to go to next to next folder.
3745 'skip-no-unread: similar as unread
3746 But does not ask before going to next to next folder.
3747 otherwise: asks whether you want to go to next unread folder
3750 It might be useful to set @code{'skip-no-unread} for people who
3751 want to continue reading by just pressing and pressing space key.
3753 @item wl-thread-insert-opened
3754 @vindex wl-thread-insert-opened
3755 The initial setting is @code{nil}.
3756 If non-nil, thread is inserted as opened.
3758 @item wl-thread-open-reading-thread
3759 @vindex wl-thread-open-reading-thread
3760 The initial setting is @code{t}. If non-nil, reading thread is
3761 automatically opened though it is closed thread.
3763 @item wl-summary-exit-next-move
3764 @vindex wl-summary-exit-next-move
3765 The initial setting is @code{t}. If non-nil, move to next folder at
3768 @item wl-folder-move-cur-folder
3769 @vindex wl-folder-move-cur-folder
3770 The initial setting is @code{nil}. If non-nil, cursor position on the
3773 @item wl-summary-weekday-name-lang
3774 @vindex wl-summary-weekday-name-lang
3775 Specify language of the weekday.
3776 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3777 displays Deutsch. You should rescan summary view after changing this value.
3779 @item wl-summary-fix-timezone
3780 @vindex wl-summary-fix-timezone
3781 The initial setting is @code{nil}.
3782 Time zone of the date string in summary mode is adjusted using this value.
3783 If @code{nil}, it is adjust to the default time zone information
3784 (system's default time zone or environment variable @samp{TZ}).
3786 @item wl-use-petname
3787 @vindex wl-use-petname
3788 The initial setting is @code{t}.
3789 If non-nil, sender part displays nickname.
3791 @item wl-break-pages
3792 @vindex wl-break-pages
3793 The initial setting is @code{t}.
3794 If non-nil, message is split as pages by @samp{^L}.
3796 @item wl-message-window-size
3797 @vindex wl-message-window-size
3798 The initial setting is '(1 . 4).
3799 A cons cell to specify the rate of summary and message window.
3800 car:cdr corresponds summary:message.
3802 @item wl-summary-from-function
3803 @vindex wl-summary-from-function
3804 Format function to display sender in summary.
3805 The initial setting is @code{wl-summary-default-from}.
3807 @item wl-summary-no-from-message
3808 @vindex wl-summary-no-from-message
3809 The initial setting is @samp{nobody@@nowhere?}. A string which is
3810 displayed when there's no @samp{From:} field in the message.
3812 @item wl-summary-subject-function
3813 @vindex wl-summary-subject-function
3814 Format function to display subject in summary.
3815 The initial setting is @code{wl-summary-default-subject} and
3816 it will cut the list name part etc. on the top of the subject.
3817 To display subject as it is, set as follows.
3820 (setq wl-summary-subject-function 'identity)
3823 @item wl-summary-no-subject-message
3824 @vindex wl-summary-no-subject-message
3825 The initial setting is @samp{(WL:No Subject in original.)}. A string
3826 which is displayed when there's no @samp{Subject:} field in the message.
3828 @item wl-summary-default-view
3829 @vindex wl-summary-default-view
3830 The initial setting is @code{'thread}.
3831 The default state for newly created summary. You can set either
3832 @code{'thread} for thread view or @code{'sequence} for sequential view.
3834 @item wl-summary-use-frame
3835 @vindex wl-summary-use-frame
3836 The initial setting is @code{nil}.
3837 If non-nil, use new frame for the summary.
3839 @item wl-use-folder-petname
3840 @vindex wl-use-folder-petname
3841 The initial setting is the list shown below:
3850 A list of display policy (symbol) of folder nickname. Available symbols
3855 Display folder petname on modeline.
3857 Destination folder is notified as nickname if
3858 @code{wl-auto-select-next} is non-nil.
3860 You can input folder name by nickname in the function
3861 @code{wl-summary-read-folder}.
3864 @item wl-summary-move-direction-toggle
3865 @vindex wl-summary-move-direction-toggle
3866 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3867 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3868 want to aware of reading direction, set this to @code{t}.
3870 @item wl-summary-width
3871 @vindex wl-summary-width
3872 The initial setting is 80.
3873 Width of summary line. If @code{nil}, summary line's width is as is.
3875 @item wl-summary-from-width
3876 @vindex wl-summary-from-width
3877 The initial setting is 17.
3878 Width of sender part of summary line.
3880 @item wl-summary-indent-length-limit
3881 @vindex wl-summary-indent-length-limit
3882 The initial setting is 46.
3883 Specify the limit of thread indent level. @code{nil} means unlimited
3885 If you set this to @code{nil} you should set @code{wl-summary-width}
3888 @item wl-summary-max-thread-depth
3889 @vindex wl-summary-max-thread-depth
3890 The initial setting is 15.
3891 If thread depth of the message is larger than this value,
3892 the thread is divided.
3894 @item wl-summary-recenter
3895 @vindex wl-summary-recenter
3896 The initial setting is t.
3897 If non-nil, cursor point is moved to the center of the summary window.
3899 @item wl-summary-divide-thread-when-subject-changed
3900 @vindex wl-summary-divide-thread-when-subject-changed
3901 The initial setting is @code{nil}. If non-nil, thread is split if
3902 the subject is changed.
3904 @item wl-summary-search-via-nntp
3905 @vindex wl-summary-search-via-nntp
3906 The initial setting is @code{confirm}.
3908 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3909 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3910 from the NNTP server @code{elmo-nntp-default-server}. The value of
3911 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3912 @code{elmo-nntp-default-stream-type} are used.
3914 If @code{confirm}, server name can be specified. You can specify NNTP
3915 folder format like @samp{-:username@@servername:119!}.
3917 @item wl-summary-keep-cursor-command
3918 @vindex wl-summary-keep-cursor-command
3919 The initial setting is the list shown below:
3923 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3928 When you entered to summary by these commands and the target summary
3929 buffer already exists, summary status is not automatically updated and
3930 cursor position is saved.
3932 @item elmo-folder-update-threshold
3933 @vindex elmo-folder-update-threshold
3934 The initial setting is 500. If updated message number is larger than
3935 this value, confirm whether drop them or not (in the case where the value
3936 of @code{elmo-folder-update-confirm} is non-nil).
3938 @item elmo-folder-update-confirm
3939 @vindex elmo-folder-update-confirm
3940 The initial setting is @code{t}. If the value is non-nil, do check with
3941 @code{elmo-folder-update-threshold}.
3943 @item wl-summary-always-sticky-folder-list
3944 @vindex wl-summary-always-sticky-folder-list
3945 The initial setting is @code{nil}.
3946 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3947 are automatically stuck. Each element is regexp of folder name.
3949 @item wl-summary-reserve-mark-list
3950 @vindex wl-summary-reserve-mark-list
3951 The initial setting is the list shown below:
3960 If a message is already marked as temporal marks in this list, the
3961 message is not marked by any mark command.
3963 @item wl-summary-skip-mark-list
3964 @vindex wl-summary-skip-mark-list
3965 The initial setting is the list shown below:
3974 If a message is already marked as temporal marks in this list, the
3975 message is skipped at cursor move.
3977 @item elmo-message-fetch-threshold
3978 @vindex elmo-message-fetch-threshold
3979 The initial setting is 30000 (bytes). If displaying message has larger
3980 size than this value, Wanderlust confirms whether fetch the message or
3981 not (in the case where the value of @code{elmo-message-fetch-confirm}
3984 @item elmo-message-fetch-confirm
3985 @vindex elmo-message-fetch-confirm
3986 The initial setting is @code{t}. If the value is non-nil, do check with
3987 @code{elmo-message-fetch-threshold}.
3989 @item wl-prefetch-threshold
3990 @vindex wl-prefetch-threshold
3991 The initial setting is 30000 (bytes). If prefetching message has larger
3992 size than this value and @code{wl-prefetch-confirm} is non-nil,
3993 Wanderlust confirms whether prefetch the message or not. If
3994 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3995 without confirmation.
3997 @item wl-prefetch-confirm
3998 @vindex wl-prefetch-confirm
3999 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4000 prefetch the message or not if the message has larger size than
4001 @code{wl-prefetch-threshold}.
4003 @item elmo-imap4-use-cache
4004 @vindex elmo-imap4-use-cache
4005 The initial setting is @code{t}. If non-nil, messages read via IMAP4
4008 @item elmo-nntp-use-cache
4009 @vindex elmo-nntp-use-cache
4010 The initial setting is @code{t}. If non-nil, messages read via NNTP are
4013 @item elmo-pop3-use-cache
4014 @vindex elmo-pop3-use-cache
4015 The initial setting is @code{t}. If non-nil, messages read via POP3 are
4018 @item elmo-shimbun-use-cache
4019 @vindex elmo-shimbun-use-cache
4020 The initial setting is @code{t}. If non-nil, messages read in Shimbun
4023 @item wl-folder-process-duplicates-alist
4024 @vindex wl-folder-process-duplicates-alist
4025 The initial setting is @code{nil}.
4026 This list determines how to deal with duplicated messages in the same folder.
4027 Each item in the list is regexp of folder name and action; you can specify any
4028 one of the following in the place of action:
4031 @code{nil} : do nothing for duplicated messages.
4032 @code{hide} : hide duplicated messages from the summary.
4033 @code{read} : set duplicated messages as read.
4037 Following is an example (hide duplicated messages in multi folders)
4041 (setq wl-folder-process-duplicates-alist
4042 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4043 ("^\\*.*" . hide) (".*" . read)))
4049 @node Message, Draft, Summary, Top
4050 @chapter Message Buffer
4052 Message Buffers utilize MIME-View mode of SEMI. For operational
4053 procedures and key bindings, refer to respective documents.
4054 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4055 You can also see help by @kbd{?} in message buffer.
4057 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4058 brings you back to Summary mode. @kbd{l} toggles display of Summary
4061 @section Key Bindings
4067 @findex wl-message-toggle-disp-summary
4068 Toggles display of Summary buffer.
4069 (@code{wl-message-toggle-disp-summary})
4072 @findex wl-message-refer-article-or-url
4073 @kindex Button-2 (Message)
4074 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4075 corresponding message if found.
4076 (@code{wl-message-refer-article-or-url})
4078 @item Button-4 (upward movement of a wheel)
4079 @kindex Button-4 (Message)
4080 @findex wl-message-wheel-down
4081 Scrolls the message backwards. When the top of the message is hit,
4082 moves to the previous message.
4083 (@code{wl-message-wheel-down})
4085 @item Button-5 (downward movement of a wheel)
4086 @kindex Button-5 (Message)
4087 @findex wl-message-wheel-up
4088 Scrolls the message forward. When the bottom of the message is hit,
4089 moves to the next message.
4090 (@code{wl-message-wheel-up})
4094 @findex wl-message-delete-current-part
4095 Delete the part under cursor. In fact it appends modified message to
4096 the current folder then moves old one to trash folder. Therefore the
4097 message number will be changed.
4098 (@code{wl-message-delete-current-part})
4101 @section Customizable Variables
4104 @item wl-message-window-size
4105 @vindex wl-message-window-size
4106 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4107 its car and cdr value corresponds to the ratio of Summary and Message
4110 @item wl-message-ignored-field-list
4111 @vindex wl-message-ignored-field-list
4112 (SEMI only) Initial setting is @code{nil}.
4113 All fields that match this list will be hidden in message buffer.
4114 Each elements are regexp of field-name.
4115 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4117 @item wl-message-visible-field-list
4118 @vindex wl-message-visible-field-list
4119 (SEMI only) Initial setting is @code{nil}.
4120 All fields that match this list will be display in message buffer.
4121 Each elements are regexp of field-name. This value precedes
4122 @code{wl-message-ignored-field-list}.
4123 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4125 @item wl-message-sort-field-list
4126 @vindex wl-message-sort-field-list
4127 (SEMI only) Initial setting is
4128 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4129 Header fields in message buffer are ordered by this value.
4130 Each elements are regexp of field-name.
4132 @item wl-message-truncate-lines
4133 @vindex wl-message-truncate-lines
4134 The initial value is the value of @code{default-truncate-lines}.
4135 If it is non-nil, truncate long lines in message buffer.
4138 @node Draft, Disconnected Operations, Message, Top
4139 @chapter Draft Buffer
4141 At Summary mode, pressing @kbd{w} and the like creates a new draft
4142 buffer. You can edit and send mail and news articles in this buffer.
4144 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4145 with those if possible.
4148 * Usage of Draft Mode:: TIPS
4149 * Key Bindings of Draft:: Key bindings
4150 * Variables of Draft Mode:: Customize Draft Mode
4153 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4156 Basically it is Emacs-standard mail mode.
4160 * Editing Message Body::
4161 * Dynamical Message Re-arrangement::
4166 @node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
4167 @subsection Editing Message Header
4169 You can freely edit header region above @samp{--text follows this line--},
4170 until you invoke the sending operation.
4172 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4173 addresses. @kbd{@key{TAB}} completes them.
4175 You can use following headers to specify recipients. Add some of them
4176 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4179 @item @samp{Newsgroups:}
4180 Specify newsgroups to which you post the news article.
4183 Specify addresses to send a copy (Carbon Copy) of the message.
4186 Following ones are removed from the header contents before sending.
4190 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4193 Specify folders in which a copy of the message is saved.
4196 Specify recipients to send encapsulated copy of the message.
4199 You can add initial headers by following variables.
4205 The initial setting is @code{nil}.
4206 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4207 the draft when it is prepared. If function is specified, its return
4212 The initial setting is @code{nil}.
4213 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4214 the draft when it is prepared.
4217 @node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4218 @subsection Editing Messages
4220 As a matter of course, editing message body can be performed in the same
4221 way as usual writing. You may write message body under
4222 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4223 @samp{--text follows this line--} intact.)
4225 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4226 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4227 a MIME user interface for GNU Emacs}.
4228 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4230 If you save the draft buffer you are editing, it is appended to the
4231 folder specified by @code{wl-draft-folder}.
4233 @node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
4234 @subsection Dynamic Modification of Messages
4235 @vindex wl-draft-config-alist
4236 @c @cindex Change Message
4237 @c @cindex Message, Change Dynamic
4239 You can set @code{wl-draft-config-alist} so that header and body of the
4240 message will automatically modified depending on information of header
4243 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4245 In the example below, the header is modified when
4246 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4247 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4248 before sending the message.
4252 (setq wl-draft-config-alist
4253 '(((string-match "aaa\\.example\\.com$" (system-name))
4254 ;; @r{applied if the expression is non-nil}
4255 (wl-smtp-posting-server . "mailserver-B")
4256 (wl-nntp-posting-server . "newsserver-B")
4257 ;; @r{settings of temporary variables}
4259 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4260 ;; @r{applied if it matches the header of the draft buffer}
4261 ("Organization" . (format "Go %s" my-webpage)))
4262 ;; @r{you can write elisp expressions here (eval only)}
4263 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4264 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4269 The format of @code{wl-draft-config-alist} is:
4273 '(("@var{regexp of the header}" or @var{elisp expression}
4274 ("@var{Field}" . value(@var{elisp expression}))
4275 (@var{variable} . value(@var{elisp expression}))
4276 (@var{sub-function} . value(@var{elisp expression}))
4279 ("@var{regexp of the header}" or @var{elisp expression}
4280 ("@var{Field}" . value(@var{elisp expression}))
4285 Per default, there are 10 following sub-functions.
4288 'header: Inserts the specified string at the bottom of the header.
4289 'header-top: Inserts the specified string at the top of the header.
4290 'header-file: Inserts the specified file at the bottom of the header.
4291 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4292 'top: Inserts the specified string at the top of the body.
4293 'top-file: Inserts the specified file at the top of the body.
4294 'body: Replaces the body with the specified string.
4295 Specifying @code{nil} deletes the entire body string.
4296 'body-file: Replaces the body with the content of the specified file.
4297 'bottom: Inserts the specified string at the bottom of the body.
4298 'bottom-file: Inserts the specified file at the top of the body.
4299 'part-top: Inserts the specified string at the top of the current part.
4300 'part-bottom: Inserts the specified string at the bottom of the current part.
4301 'template: Applies the specified template.
4302 (refer to the next subsection)
4305 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4306 change them or add your own functions. If you read the code, you can
4307 easily find how to write the functions.
4309 At the first of each item, @var{a regular expression of the header} or
4310 an @var{elisp expression} should be specified. In the case of an elisp
4311 expression, the item is applied when the expression is evaluated
4314 Per default, when multiple items match or are evaluated non-nil, all
4315 such items are applied, but if you set a variable
4316 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4319 At the second of the item, a cons or a list of functions should be
4320 specified. The car part of the cons should be a header field, a
4321 variable, or a sub-function. When a header field is specified, the
4322 field will be modified. If a variable is specified, the value of the
4323 variable will be modified temporarily.
4325 In the cdr part of a cons, not only a variable but also an elisp
4326 expression can be specified as is. If the car part is a header field
4327 and the cdr part is @code{nil}, the field will be deleted.
4329 See the next example as well:
4333 (setq wl-draft-config-alist
4335 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4336 ;; @r{applied if it matches the header of the buffer being replied}
4337 (body . " Hello.\n")
4338 (template . "default")
4343 As in the (1) above, if a header regexp is prepended with @code{reply},
4344 it is applied when the draft is prepared by @code{wl-summary-reply} for
4345 example, and when it matches the header being replied. It is ignored
4346 when there is no buffer being replied, like after @code{wl-draft} was
4349 If you want to use name of parent folder, you can refer the buffer local
4350 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4351 changes From according to the folder name of the summary in which the draft
4356 (setq wl-draft-config-alist
4357 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4358 (\"From\" . \"user@@domain1\"))
4359 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4360 (\"From\" . \"user@@domain2\"))))
4365 Note that @code{wl-draft-config-alist} is applied only once when
4366 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4367 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4368 aborting transmission, execute @kbd{C-c C-e}
4369 (@code{wl-draft-config-exec}) explicitly.
4371 If you don't want to apply @code{wl-draft-config-alist} when
4372 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4376 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4379 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4380 prepared, do the following:
4383 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4386 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4387 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4391 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4394 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4395 @subsection Inserting Templates
4397 @cindex Apply Template
4399 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4400 @kbd{M-x wl-template-select} in the draft buffer.
4402 The format of @code{wl-template-alist} is almost the same as
4403 @code{wl-draft-config-alist}.
4407 (setq wl-template-alist
4410 ("Organization" . "Example Co.Ltd.")
4411 (body . "Hello.\n"))
4413 (template . "default") ;; @r{(a)}
4414 ("To" . "boss@@example.com")
4415 ("Subject" . "Report")
4416 (body-file . "~/work/report.txt")
4422 As you can see, the only difference is item (template) names such as
4423 @samp{default} and @samp{report}, instead of a regexp of header.
4424 Because definition of each item is the same as
4425 @code{wl-draft-config-alist}, you can call another template, like (a).
4427 Executing the command @code{wl-template-select} results in template
4428 selection, but the result differs depending on variable
4429 @code{wl-template-visible-select}.
4431 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4432 window is shown below the draft buffer. You can select a template by
4433 @kbd{n} and @kbd{p} seeing the buffer window.
4435 Press the @key{RET} key and the template is actually applied to the draft
4436 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4437 adjust the window size by @code{wl-template-buffer-lines}.
4439 If @code{wl-template-visible-select} is @code{nil}, you should type the
4440 name of the template in the mini buffer.
4442 As shown in the example in @code{wl-draft-config-alist}, you can select
4443 @samp{default} template by writing:
4446 (template . "default")
4449 @node POP-before-SMTP, , Template, Usage of Draft Mode
4450 @subsection Sending mail by POP-before-SMTP
4451 @cindex POP-before-SMTP
4453 You can send mail by POP-before-SMTP with this single line:
4456 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4460 Configure the following variables if you need.
4463 @item wl-pop-before-smtp-user
4464 The POP user name for POP-before-SMTP authentication.
4465 If unset, @code{elmo-pop3-default-user} is used.
4467 @item wl-pop-before-smtp-server
4468 The POP server name for POP-before-SMTP authentication.
4469 If unset, @code{elmo-pop3-default-server} is used.
4471 @item wl-pop-before-smtp-authenticate-type
4472 The POP authentication method for POP-before-SMTP authentication.
4473 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4475 @item wl-pop-before-smtp-port
4476 The POP port number for POP-before-SMTP authentication.
4477 If unset, @code{elmo-pop3-default-port} is used.
4479 @item wl-pop-before-smtp-stream-type
4480 If non-nil, POP connection is established using SSL. If
4481 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4482 unset, @code{elmo-pop3-default-stream-type} is used.
4485 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4486 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4488 Therefore, if SMTP server and POP server are actually the same, and if
4489 POP folder per default (such as @samp{&}) is available, no settings are
4492 Refer to the following URL about POP-before-SMTP.
4496 http://spam.ayamura.org/tools/smPbS.html
4497 http://www.iecc.com/pop-before-smtp.html
4502 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4503 @section Key Bindings
4504 @cindex Keybind, Draft Mode
4505 @cindex Keybind, Draft Buffer
4510 @kindex C-c C-y (Draft)
4511 @findex wl-draft-yank-original
4512 Cites the content of the current message buffer (the part under cursor).
4513 If the region is active, cites the region (it affects only if
4514 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4515 (on XEmacs) is Non-nil).
4516 (@code{wl-draft-yank-original})
4519 @kindex C-c C-p (Draft)
4520 @findex wl-draft-preview-message
4521 Previews the content of the current draft.
4522 This is useful for previewing MIME multi-part messages.
4523 (@code{wl-draft-preview-message})
4526 @kindex C-c C-s (Draft)
4527 @findex wl-draft-send
4528 Sends the content of the current draft. Does not erase the draft buffer.
4529 This is useful for sending multiple messages, which are a little different
4531 (@code{wl-draft-send})
4534 @kindex C-c C-c (Draft)
4535 @findex wl-draft-send-and-exit
4536 Sends the content of the current draft and erases the draft buffer.
4537 (@code{wl-draft-send-and-exit})
4540 @kindex C-x C-s (Draft)
4541 @findex wl-draft-save
4542 Save the current draft.
4543 (@code{wl-draft-save})
4546 @kindex C-c C-k (Draft)
4547 @findex wl-draft-kill
4548 Kills the current draft.
4549 (@code{wl-draft-kill})
4552 @kindex C-x k (Draft)
4553 @findex wl-draft-mimic-kill-buffer
4554 Kills the current draft.
4555 (@code{wl-draft-mimic-kill-buffer})
4558 @kindex C-c C-z (Draft)
4559 @findex wl-draft-save-and-exit
4560 Saves the current draft, and erases the draft buffer.
4561 This is useful if you want to suspend editing of the draft.
4562 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4563 the @samp{+draft} folder.
4564 (@code{wl-draft-save-and-exit})
4567 @kindex C-c C-r (Draft)
4568 @findex wl-caesar-region
4569 Encodes or decodes the specified region in Caesar cipher.
4570 (@code{wl-caesar-region})
4574 @findex wl-draft-highlight-and-recenter
4575 Recenter and rehighlight current draft.
4576 (@code{wl-draft-highlight-and-recenter})
4580 @findex wl-toggle-plugged
4581 Toggles off-line/on-line states of Wanderlust.
4582 (@code{wl-toggle-plugged})
4585 @kindex C-c C-o (Draft)
4586 @findex wl-jump-to-draft-buffer
4587 Jumps to the other draft buffer, if exists.
4588 With prefix argument, reads a file (if any) from the draft folder when
4589 there is no such buffer.
4590 (@code{wl-jump-to-draft-buffer})
4593 @kindex C-c C-e (Draft)
4594 @findex wl-draft-config-exec
4595 Applies @code{wl-draft-config-alist}.
4596 (@code{wl-draft-config-exec})
4599 @kindex C-c C-j (Draft)
4600 @findex wl-template-select
4602 (@code{wl-template-select})
4605 @kindex C-c C-a (Draft)
4607 Enter Address Manager.
4608 @xref{Address Manager}.
4612 @kindex C-c C-d (Draft)
4613 @findex wl-draft-elide-region
4614 Elide the text between point and mark (@code{wl-draft-elide-region}).
4615 The text is killed and replaced with the contents of the variable
4616 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4620 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4621 @section Customizable Variables
4624 @item wl-subscribed-mailing-list
4625 @vindex wl-subscribed-mailing-list
4626 The initial setting is @code{nil}. Mailing lists to which you
4627 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4628 field of a reply draft, removes your own address from
4629 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4630 contained in @samp{To:} or @samp{Cc:} field of a message to be
4631 automatically re-filed, the destination folder will be leaned in
4632 connection with the address.
4638 (setq wl-subscribed-mailing-list
4639 '("wl@@lists.airs.net"
4641 "emacs-mime-ja@@m17n.org"))
4645 @item wl-insert-mail-followup-to
4646 @vindex wl-insert-mail-followup-to
4647 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4648 field is automatically inserted in the draft buffer.
4650 @item wl-insert-mail-reply-to
4651 @vindex wl-insert-mail-reply-to
4652 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4653 field is automatically inserted in the draft buffer.
4655 @item wl-auto-insert-x-face
4656 @vindex wl-auto-insert-x-face
4657 The initial setting is @code{t}. If non-nil and there is an encoded
4658 X-Face string in a file @file{~/.xface} (the value of the variable
4659 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4660 draft buffer. If @code{nil}, it is not automatically inserted.
4662 @item wl-insert-message-id
4663 @vindex wl-insert-message-id
4664 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4665 is automatically inserted on the transmission.
4667 @item wl-message-id-use-wl-from
4668 @vindex wl-message-id-use-wl-from
4669 The initial setting is @code{nil}. If non-nil, the value of
4670 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4672 @item wl-local-domain
4673 @vindex wl-local-domain
4674 The initial setting is @code{nil}. If @code{nil}, the return value of
4675 the function @code{system-name} will be used as the domain part of
4678 If @code{system-name} does not return FQDN (i.e. the full name of the
4679 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4680 to the string of the local domain name without hostname (like
4681 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4682 @samp{.} @code{wl-local-domain} is used as domain part of the
4685 If your terminal does not have global IP, set the value of
4686 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4687 you use invalid @samp{Message-ID:}.)
4689 Moreover, concatenation of @code{system-name} @samp{.}
4690 @code{wl-local-domain} will be used as an argument to the HELO command
4693 @item wl-message-id-domain
4694 @vindex wl-message-id-domain
4695 The initial setting is @code{nil}. If non-nil, this value is used as a
4696 domain part of the @samp{Message-ID:}. If your terminal does not have
4697 global IP address, set unique string to this value (e.x. your e-mail
4700 @item wl-unique-id-suffix
4701 @vindex wl-unique-id-suffix
4702 The initial setting is @samp{.wl}. You can specify the string in generated
4703 Message-ID which appear just before @samp{@@}.
4705 @item wl-draft-config-alist
4706 @vindex wl-draft-config-alist
4707 The initial setting is @code{nil}. Modifies the draft message just
4708 before the transmission. The content of @code{wl-draft-config-alist}
4709 will be automatically applied only once on the transmission. If you
4710 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4713 @item wl-template-alist
4714 @vindex wl-template-alist
4715 The initial setting is @code{nil}.
4716 This variable specifies the template to be applied in the draft buffer.
4718 @item wl-draft-config-matchone
4719 @vindex wl-draft-config-matchone
4720 The initial setting is @code{nil}. If non-nil, only the first matching
4721 item is used when @code{wl-draft-config-alist} is applied. If
4722 @code{nil}, all matching items are used.
4724 @item wl-template-visible-select
4725 @vindex wl-template-visible-select
4726 The initial setting is @code{t}.
4727 If non-nil, you can preview the result of the template selection in
4730 @item wl-template-confirm
4731 @vindex wl-template-confirm
4732 The initial setting is @code{nil}.
4733 If non-nil, asks for confirmation when you press the enter key to select
4734 template while previewing.
4736 @item wl-template-buffer-lines
4737 @vindex wl-template-buffer-lines
4738 The initial setting is 7.
4739 If @code{wl-template-visible-select} is non-nil, this variable specifies
4740 the size of the preview window.
4742 @item wl-draft-buffer-style
4743 @vindex wl-draft-buffer-style
4744 The initial setting is @code{full}.
4745 Style of draft buffer window (except for replying and forwarding).
4746 @code{keep} is to use current window,
4747 @code{full} is to use full frame window,
4748 @code{split} is to split current window and use it.
4749 If some function is specified, it is called with the draft buffer
4752 @item wl-draft-reply-buffer-style
4753 @vindex wl-draft-reply-buffer-style
4754 The initial setting is @code{split}.
4755 Style of draft buffer for replying and forwarding.
4756 @code{keep} is to use message buffer window,
4757 @code{full} is to use full frame window,
4758 @code{split} is to split message buffer window and use it.
4759 If some function is specified, it is called with the draft buffer
4762 @item wl-draft-use-frame
4763 @vindex wl-draft-use-frame
4764 The initial setting is @code{nil}.
4765 If non-nil, use new frame for the draft.
4767 @item wl-draft-truncate-lines
4768 @vindex wl-draft-truncate-lines
4769 The initial value is the value of @code{default-truncate-lines}.
4770 If it is non-nil, truncate long lines in draft buffer.
4774 The initial setting is the value of the variable
4775 @code{user-mail-address}. The value of this variable is inserted as a
4776 @samp{From:} field of the draft when it is prepared.
4778 @item wl-envelope-from
4779 @vindex wl-envelope-from
4780 The initial setting is @code{nil}.
4781 The value of this variable is used for envelope from (MAIL FROM).
4782 If @code{nil}, the address part of @code{wl-from} is used.
4784 @item wl-user-mail-address-list
4785 @vindex wl-user-mail-address-list
4786 The initial setting is @code{nil}.
4787 This is the User's address list. If you have multiple addresses,
4790 @item wl-reply-subject-prefix
4791 @vindex wl-reply-subject-prefix
4792 The initial setting is @samp{Re: }.
4793 In the @samp{Subject:} of the reply draft, this string is prepended to
4794 the @samp{Subject:} of being replied.
4796 @item wl-forward-subject-prefix
4797 @vindex wl-forward-subject-prefix
4798 The initial setting is @samp{Forward: }.
4799 In the @samp{Subject:} of the forwarding draft, this string is prepended
4800 to the @samp{Subject:} of being forwarded.
4802 @item wl-draft-reply-use-address-with-full-name
4803 @vindex wl-draft-reply-use-address-with-full-name
4804 The initial setting is @code{t}.
4805 If non-nil, insert her full name with address when prepare a draft for
4806 reply a message. If it is @code{nil}, insert her address only.
4808 @item wl-draft-enable-queuing
4809 @vindex wl-draft-enable-queuing
4810 The initial setting is @code{t}.
4811 This flag controls off-line transmission. If non-nil, the draft is
4814 @item wl-draft-use-cache
4815 @vindex wl-draft-use-cache
4816 The initial setting is @code{nil}. If the value is non-nil and
4817 @code{wl-insert-message-id} is nil, cache the message which is sent.
4819 @item wl-fcc-force-as-read
4820 @vindex wl-fcc-force-as-read
4821 The initial setting is @code{nil}. If the value is non-nil,
4822 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4824 @item wl-auto-flush-queue
4825 @vindex wl-auto-flush-queue
4826 The initial setting is t.
4827 This flag controls automatic transmission of the queue when Wanderlust
4828 becomes on-line. If non-nil, the queue is automatically transmitted
4829 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4830 manually, press @kbd{F} in the folder mode.
4832 @item wl-ignored-forwarded-headers
4833 @vindex wl-ignored-forwarded-headers
4834 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4835 All headers that match this regexp will be deleted when forwarding a message.
4837 @item wl-ignored-resent-headers
4838 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4839 All headers that match this regexp will be deleted when resending a message.
4841 @item wl-draft-always-delete-myself
4842 @vindex wl-draft-always-delete-myself
4843 If non-nil, always removes your own address from @samp{To:} and
4844 @samp{Cc:} when you are replying to the mail addressed to you.
4846 @item wl-draft-delete-myself-from-bcc-fcc
4847 @vindex wl-draft-delete-myself-from-bcc-fcc
4848 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4849 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
4851 @item wl-smtp-posting-server
4852 @vindex wl-smtp-posting-server
4853 The initial setting is @code{nil}.
4854 This is the SMTP server name for mail transmission.
4856 @item wl-smtp-posting-port
4857 @vindex wl-smtp-posting-port
4858 The initial setting is @code{nil}.
4859 This is the SMTP port number for mail transmission.
4860 If @code{nil}, default SMTP port number (25) is used.
4862 @item wl-smtp-posting-user
4863 @vindex wl-smtp-posting-user
4864 The initial setting is @code{nil}.
4865 This is the user name for SMTP AUTH authentication. If @code{nil},
4866 @code{smtp-authenticate-user} is used.
4868 @item wl-smtp-authenticate-type
4869 @vindex wl-smtp-authenticate-type
4870 The initial setting is @code{nil}.
4871 This is the authentication method for SMTP AUTH authentication. If
4872 @code{nil}, @code{smtp-authenticate-type} is used. If
4873 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4876 @item wl-smtp-connection-type
4877 @vindex wl-smtp-connection-type
4878 The initial setting is @code{nil}.
4879 This variable specifies how to establish SMTP connections.
4880 If @code{nil}, @code{smtp-connection-type} is used.
4881 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4883 @item wl-nntp-posting-server
4884 @vindex wl-nntp-posting-server
4885 The initial setting is @code{nil}.
4886 This is the NNTP server name used for news submission.
4887 If @code{nil}, @code{elmo-nntp-default-server} is used.
4889 @item wl-nntp-posting-user
4890 @vindex wl-nntp-posting-user
4891 The initial setting is @code{nil}.
4892 This is the user name for AUTHINFO authentication on news submission.
4893 If @code{nil}, @code{elmo-nntp-default-user} is used.
4894 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4896 @item wl-nntp-posting-port
4897 @vindex wl-nntp-posting-port
4898 The initial setting is @code{nil}.
4899 This is the port number of the NNTP server used for news submission.
4900 If @code{nil}, @code{elmo-nntp-default-server} is used.
4902 @item wl-nntp-posting-stream-type
4903 @vindex wl-nntp-posting-stream-type
4904 The initial setting is @code{nil}.
4905 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4906 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4907 connection will be established.
4909 @item wl-nntp-posting-function
4910 @vindex wl-nntp-posting-function
4911 The initial setting is @code{elmo-nntp-post}.
4912 This is the function to post NNTP message.
4914 @item wl-nntp-posting-config-alist
4915 @vindex wl-nntp-posting-config-alist
4916 The initial setting is @code{nil}.
4917 The value takes an alist to define NNTP server like following example.
4918 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
4922 (setq wl-nntp-posting-config-alist
4923 '((",?gmane\\." . "news.gmane.org")
4925 ((server . "news-server")
4926 (user . "newsmaster")
4928 (function . elmo-nntp-post)))
4929 (".*" . "default-news-server")))
4933 @item wl-pop-before-smtp-user
4934 @vindex wl-pop-before-smtp-user
4935 The initial setting is @code{nil}.
4936 This is the POP user name for POP-before-SMTP.
4937 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4939 @item wl-pop-before-smtp-server
4940 @vindex wl-pop-before-smtp-server
4941 The initial setting is @code{nil}.
4942 This is the POP server name for POP-before-SMTP.
4943 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4945 @item wl-pop-before-smtp-authenticate-type
4946 @vindex wl-pop-before-smtp-authenticate-type
4947 The initial setting is @code{nil}.
4948 This is the authentication method for POP-before-SMTP authentication.
4949 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4951 @item wl-pop-before-smtp-port
4952 @vindex wl-pop-before-smtp-port
4953 The initial setting is @code{nil}.
4954 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4955 @code{elmo-pop3-default-port} is used.
4957 @item wl-pop-before-smtp-stream-type
4958 @vindex wl-pop-before-smtp-stream-type
4959 The initial setting is @code{nil}.
4960 This flag controls the use of SSL for POP-before-SMTP. If it is
4961 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4962 STARTTLS (RFC2595) connection will be established.
4964 @item wl-draft-queue-save-variables
4965 @vindex wl-draft-queue-save-variables
4966 Specifies a list of variable to which queued messages are saved on the
4967 off-line transmission.
4969 @item wl-draft-sendlog
4970 @vindex wl-draft-sendlog
4971 The initial setting is @code{t}.
4972 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4976 @item drafts are sent by smtp or qmail
4977 @item saved into folders by fcc
4978 @item saved into folders by queuing
4981 (it is written even if the transmission fails).
4982 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4983 and left to the logging function of @command{imput}.
4986 @item wl-draft-sendlog-max-size
4987 @vindex wl-draft-sendlog-max-size
4988 The initial setting is 20000 (in bytes).
4989 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4990 beyond the size specified by this variable.
4994 The initial setting is @code{nil}.
4995 If non-nil, address completion uses LDAP.
4997 @item wl-ldap-server
4998 @vindex wl-ldap-server
4999 The initial setting is @samp{localhost}.
5000 LDAP server name for address completion.
5003 @vindex wl-ldap-port
5004 The initial setting is @code{nil}.
5005 If non-nil, the value is used as port number.
5008 @vindex wl-ldap-base
5009 The initial setting is @samp{c=US}.
5010 LDAP search starting point (base) for address completion.
5012 @item wl-draft-remove-group-list-contents
5013 @vindex wl-draft-remove-group-list-contents
5014 The initial setting is @code{t}.
5015 If non-nil, remove the group-lists' members in the recipients when
5016 sending the message (group-list means the description such as
5017 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5020 @node Disconnected Operations, Expire and Archive, Draft, Top
5021 @chapter Off-line Management
5022 @cindex Disconnected Operations
5024 Wanderlust has on-line and off-line states.
5027 * Off-line State:: Wanderlust has on-line and off-line states
5028 * Enable Operations:: Enable Disconnected Operations
5029 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5030 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5031 * Variables of Plugged Mode:: Customize Plugged Mode
5035 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5036 @section Off-line State
5038 Wanderlust has on-line and off-line states. In the off-line state, you
5039 cannot access messages via network, unless they are cached.
5041 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5042 in the mode line indicates the off-line state. In folder or summary
5043 modes, press @kbd{M-t} to switch between off- and on-line.
5045 You can invoke Wanderlust in the off-line state by setting
5046 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5048 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5049 ignores uncached messages.
5052 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5053 @section Enable Disconeected Operations
5055 Even in the off-line state, provided that relevant messages are cached,
5056 and the variable @code{elmo-enable-disconnected-operation} (described
5057 later) is non-nil, you can following operations:
5058 @xref{Plugged Mode}, @xref{Off-line State settings}.
5061 * Send Messages off-line:: Transmit Messages
5062 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5063 * Creation of Folders:: Create Folders off-line (IMAP4)
5064 * Marking:: Mark (IMAP4)
5065 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
5068 As soon as Wanderlust becomes on-line, such operations invoked off-line
5069 are reflected in the servers via network.
5072 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5073 @subsection Transmission of Messages
5075 You can proceed sending operation for mail/news messages while you are
5076 off-line, then it will be reserved for sending (if you are using
5077 @file{im-wl.el}, it is irrelevant).
5078 Messages reserved for sending while off-line are accumulated in the
5079 queue folder, @samp{+queue}. These messages are transmitted at once when
5080 Wanderlust becomes on-line.
5082 You can visit @samp{+queue} in the off-line state and confirm content of
5083 messages in the queue. You can also remove messages. Removed messages
5084 are not transmitted even in the on-line state.
5087 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5088 @subsection Re-file and Copy (IMAP4)
5090 Re-file and copy operations to IMAP folders invoked during the off-line
5091 state are accumulated in the queue, and reflected in the server side
5092 when Wanderlust becomes on-line. If you visit destination folders after
5093 off-line re-file or copy, it looks as if messages were appended even in
5096 For the safety reasons, messages re-filed off-line are removed from
5097 source folders only if their @samp{Message-ID:} match messages on the
5098 servers. While the queue is processed, messages that failed to be
5099 re-filed or copied to the specified folders are appended to the folder
5103 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5104 @subsection Creation of Folders (IMAP4)
5106 You can create IMAP folders off-line. The creation of folders are
5107 reflected in the servers when Wanderlust becomes on-line. If the creation
5108 of those folders fails at that time for some reasons, messages
5109 to be re-filed into those are appended to the folder @samp{+lost+found}
5113 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5114 @subsection Marking (IMAP4)
5116 Off-line changes in unread/read and importance mark @samp{$} information
5117 are also reflected in the servers when Wanderlust becomes on-line.
5120 @node Pre-fetching Reservations, , Marking, Enable Operations
5121 @subsection Pre-fetching (IMAP4, NNTP)
5123 You can make reservations for pre-fetching messages in IMAP or NNTP
5124 folders. Reserved messages are marked with @samp{!} but not cached
5125 yet. When Wanderlust becomes on-line, they are pre-fetched from
5128 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5129 these off-line operations for IMAP4 and NNTP do not take place, and
5130 off-line re-file, copy or suchlike simply results in error.
5132 Because off-line operations use cache files, it is a bad idea to erase
5133 them by hand; it may cause Wanderlust to malfunction.
5135 If you want to remove caches, be sure to execute @kbd{M-x
5136 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5137 remove caches for messages relevant to off-line operations.
5140 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5141 @section Switching On-line/Off-line per Server/Port
5143 @kbd{M-t} described above switches networking states as a whole, but you
5144 can switch on-line/off-line per server/port.
5146 Pressing @kbd{C-t} in the folder or summary modes brings you in
5147 wl-plugged-mode shown below, in which you can change the plugged state
5152 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5155 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5156 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5158 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5159 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5165 The first line indicates status of the following three variables, and
5166 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5167 column modifies the values of these variables.
5171 "Queuing" @code{wl-draft-enable-queuing}
5172 "AutoFlushQueue" @code{wl-auto-flush-queue}
5173 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5177 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5180 The second and after lines indicate on-line/off-line states of servers
5181 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5182 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5183 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5185 @dfn{sending queue} means messages accumulated in the folder
5186 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5187 off-line operations when @code{elmo-enable-disconnected-operation} is
5189 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5190 @c off-line operations are enabled.
5192 They are displayed if there are any of them. In the example above, in
5193 the sending queue there are two messages (the first and the second in
5194 the queue folder) for smtp to hosta and one (the third) for nntp to
5195 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5198 If you change @samp{(wl-plugged)} in the second line, the variable
5199 @code{wl-plugged} is changed, so that the mode line indicator and
5200 plugged states of all ports are affected. If you change plugged states
5201 of any servers or ports, @samp{(wl-plugged)} in the second line is
5202 affected depending on @code{elmo-plugged-condition} settings and the
5203 plugged state of each port.
5206 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5207 @section Invoking Wanderlust in the Off-line State
5209 As described before, if you set @code{wl-plugged} to @code{nil} in
5210 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5211 off-line state. You can specify off-line state on a per server or port
5212 basis. Refer to @code{wl-reset-plugged-alist} also.
5214 Usually, when Wanderlust starts up, the plugged state of each port is
5215 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5216 @code{wl-nntp-posting-server} and so on. If you want to change the
5217 plugged state of these ports or to add other ports, configure
5218 @code{wl-make-plugged-hook} with a function.
5222 (add-hook 'wl-make-plugged-hook
5224 (elmo-set-plugged plugged-value(t/nil) server port)
5225 ;; @r{add or change plugged states of the port of the server}
5226 (elmo-set-plugged plugged-value(t/nil) server)
5227 ;; @r{if the port is omitted, all ports are affected}
5228 ;; @r{(you cannot omit the port if you newly add the server)}
5234 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5235 @section Customizable Variables
5240 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5241 mode from the beginning.
5243 @item wl-queue-folder
5244 @vindex wl-queue-folder
5245 The initial setting is @samp{+queue}.
5246 This is the folder in which messages in the transmission queue are
5249 @item wl-auto-flush-queue
5250 @vindex wl-auto-flush-queue
5251 The initial setting is @code{t}.
5252 This flag controls automatic transmission of the queue when Wanderlust
5253 becomes on-line. If non-nil, the queue is automatically transmitted
5254 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5255 manually, press @kbd{F} in the folder mode.
5257 @item elmo-enable-disconnected-operation
5258 @vindex elmo-enable-disconnected-operation
5259 The initial setting is @code{t}. Controls off-line operations
5260 regarding IMAP4. If non-nil, off-line operations are carried out.
5262 @item elmo-lost+found-folder
5263 @vindex elmo-lost+found-folder
5264 The initial setting is @samp{+lost+found}.
5265 This is the folder to which messages are saved when they fails to be
5266 appended while the off-line re-file/copy queue is processed.
5268 @item elmo-plugged-condition
5269 @vindex elmo-plugged-condition
5270 The initial setting is @code{one}.
5271 The value of @code{wl-plugged} reflects the return value of the function
5272 @code{elmo-plugged-p} (without arguments).
5273 This variable @code{elmo-plugged-condition} specifies the condition on
5274 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5275 plugged state of each port.
5278 'one : plugged if one or more ports are plugged.
5279 'all : plugged if all ports are plugged.
5280 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5281 states of the ports.
5282 @var{function} : reflects the return value of the @var{function}
5283 functions available per default
5284 'elmo-plug-on-by-servers
5285 : reflects the plugged state of the servers specified by the
5286 variable elmo-plug-on-servers.
5287 'elmo-plug-on-by-exclude-servers
5288 : reflects the plugged state of the servers that are not
5289 in elmo-plug-on-exclude-servers.
5290 elmo-plug-on-exclude-servers defaults to
5293 (system-name)without the domain part)
5299 (setq elmo-plugged-condition 'all)
5301 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5302 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5304 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5305 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5309 @item wl-reset-plugged-alist
5310 @vindex wl-reset-plugged-alist
5311 The initial setting is @code{t}. If non-nil, plugged states are
5312 initialized on a per server or port basis when Wanderlust starts up.
5314 If @code{nil}, plugged states are retained while Emacs is running. In
5315 other words, they are initialized when Emacs is restarted even if the
5316 value is @code{nil}.
5320 @node Expire and Archive, Scoring, Disconnected Operations, Top
5321 @chapter Automatic Expiration and Archiving of Messages
5322 @cindex Expire and Archive
5325 * Expire:: Expiration and Archiving
5326 * Archive:: Archiving All Messages
5330 @node Expire, Archive, Expire and Archive, Expire and Archive
5332 @cindex Expire Message
5334 Expiration means deletion of old messages which have outlasted a
5335 certain period of time.
5337 @code{wl-expire} supports not only simple deletion, but also moving to
5338 specified archiving folders.
5342 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5343 or @kbd{M-e} in the summary mode.
5345 @subsection Configuring @code{wl-expire-alist}
5347 An example configuration of @code{wl-expire-alist} is shown below.
5348 Everything in this @code{wl-expire-alist} makes a great difference in
5349 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5350 to @code{t}, especially in the initial stage.
5354 (setq wl-expire-alist
5355 '(("^\\+trash$" (date 14) remove)
5357 ("^\\+tmp$" (date 7) trash)
5358 ;; @r{re-file to @code{wl-trash-folder}}
5359 ("^\\+outbox$" (number 300) "$outbox;lha")
5360 ;; @r{re-file to the specific folder}
5362 ;; @r{do not expire}
5363 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5364 ;; @r{archive by message number (retaining numbers)}
5365 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5366 ;; @r{archive by a fixed number (retaining numbers)}
5367 ("^\\+diary$" (date 30) wl-expire-archive-date)
5368 ;; @r{archive by year and month (numbers discarded)}
5373 Items in the list has the format of:
5376 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5380 The folder is examined if it matches @var{regexp-for-folders} from the
5381 beginning of the list. If you invoke expiration on the folder that does
5382 not match any of them, nothing will happen. And if either the second or
5383 the third element of the item is @code{nil}, expiration will not take
5386 You can use any one of the following for
5387 @var{specification-of-message-to-be-deleted}:
5390 @item (number @var{n1} [@var{n2}])
5391 deletes messages depending on the number of messages in the folder.
5393 @var{n1} is the number of messages which should survive deletion, for example
5394 if its value is 500, the newest 500 messages survive and the rests are
5397 @var{n2} is the number of messages in the folder on which expiration should
5398 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5399 folders with 510 or more messages are expired.
5400 If you configured automatic expiration, frequently used folders may
5401 expire every time it receive messages, and you may be annoyed with the
5402 long delay in reading mail.
5403 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5404 expiration would not take place until a certain number of messages
5407 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5408 with important/new/unread) are not deleted.
5409 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5410 will expire so as to have 500 messages including such ones.
5411 Otherwise, it will have 500 messages except such ones.
5413 @item (date @var{d1})
5414 deletes messages depending on the dates.
5416 Messages dated @var{d1} or more days ago are deleted, for example if its
5417 value is seven, messages seven days old or more are deleted. Note that
5418 the date is the one in the @samp{Date:} field of the message, not when
5419 the message entered the folder.
5421 Messages with no or invalid @samp{Date:} field does not expire; you
5422 might have to delete them by hand.
5425 You can use any one of the following in the place of @var{destination}:
5429 deletes the messages instantly.
5432 hide the messages from summary (messages are not deleted).
5435 moves the messages to @code{wl-trash-folder}.
5437 @item @var{string}(folder)
5438 moves the messages to the folder specified with @var{string}.
5440 It would be useful for specifying an archiving folder, but because this
5441 does not move important messages, it might be better to use the
5442 standard functions described below.
5444 @item @var{function}
5445 invokes the specified @var{function}.
5447 To the @var{function}, three arguments are passed: a folder name, a list
5448 of messages to be deleted, and msgdb information of the summary. You
5449 can specify function-specific arguments after the name of the
5450 @var{function}. Note that the list contains messages with marks in
5451 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5454 These are four standard functions; three of them move messages to an archive
5455 folder in the specified way. This means old messages can be compressed
5456 and saved in a file, being deleted from the original folder.
5457 The last one divides messages to some MH folders.
5460 @item wl-expire-archive-number1
5461 re-files to archiving folders corresponding to the message numbers of
5462 the messages being deleted. For example, a message numbered 102 will be
5463 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5464 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5465 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5467 The archiving folders to which messages are re-filed are determined by
5468 the name of the folder as follows (in this case, archiving folders are
5469 handled as if @code{elmo-archive-treat-file} were non-nil).
5472 @item If the folder type is localdir:
5473 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5475 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5476 (@file{~/Mail/ml/wl-00100.zip}).
5478 @item The folder type is other than localdir:
5479 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5481 For example, @samp{%#mh/ml/wl} corresponds to
5482 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5485 As you can see, in the case of localdir, the folder type is not included
5486 in the path name, but otherwise it is included.
5487 And you can control the prefix to the archiving folder name by
5488 @code{wl-expire-archive-folder-prefix}.
5489 Refer to @code{wl-expire-archive-folder-prefix} for details.
5491 @item wl-expire-archive-number2
5492 re-files every certain number of messages to archiving folders.
5494 This differs from @samp{wl-expire-archive-number1} in that this re-files
5495 to the folder up to the specified number regardless of message numbers.
5496 The archiving folders to which messages are re-filed are determined in the
5497 same way as @code{wl-expire-archive-number1}.
5499 @item wl-expire-archive-date
5500 re-files messages depending on its date (year and month) to archive
5503 For example, a message dated December 1998 is re-filed to
5504 @code{$folder-199812;zip}. The name of the archiving folders except the
5505 date part are determined in the same way as
5506 @code{wl-expire-archive-number1}.
5509 You can set the first argument to these three standard functions to non-nil
5510 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5511 For example, it can be specified just after the name of the function:
5514 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5517 If you omit the argument, consecutive numbers from 1 are assigned for
5518 each archiving folder.
5520 @item wl-expire-localdir-date
5521 divedes messages depending on its date (year and month) to MH folders
5522 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5526 @subsection Treatment for Important or Unread Messages
5528 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5529 standard function, messages with marks in
5530 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5531 messages} thereafter) are retained.
5533 Per default, this variable include the important, new, and unread marks,
5534 so that messages with these marks are not removed.
5535 Note that you cannot include the temporary mark (i.e. temporary marks
5536 are removed anyway), and be sure to process temporary marks before you
5539 @subsection Auto Expiration
5541 The following setup invokes expiration when you move into the summary
5542 mode. There will be no confirmation, so make sure you made no mistake
5543 in regexp and other settings before you set up this.
5547 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5551 In the folder mode, you can invoke expiration per group as well as per
5552 folder. Therefore, if you specify @samp{Desktop} group, all folders
5553 matching @code{wl-expire-alist} expire.
5557 @subsection Treating archive folders.
5558 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5559 you must set non-nil value to @code{elmo-archive-treat-file}.
5561 @subsection Confirming
5563 If you are to use @code{remove}, try @code{trash} at first and see
5564 messages move to @code{wl-trash-folder} as expected, then replace it
5565 with @code{remove}. It would be dangerous to use @code{remove} from the
5568 If you are to use @code{wl-expire-archive-number1} and the like, try to
5569 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5570 you can append messages to it. Even if settings in
5571 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5572 would not be saved anywhere and disappeared in case the archiver program
5575 After you make sure you can archive to the folder correctly, you can
5576 invoke expiration and utilize the log.
5578 If you set @code{wl-expire-use-log} to @code{t},
5579 @file{~/.elmo/expired-log} should contain the log, for example:
5583 delete +ml/wl (593 594 595 596 597 598 599)
5584 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5588 The first column indicates the operation, i.e. @samp{delete},
5589 @samp{copy}, or @samp{move}. The next is the name of the folder that
5590 expired. In the case of @samp{copy} and @samp{move}, the destination
5591 folder is recorded after @samp{->}. The last is the list of message
5592 numbers that are actually deleted or moved (in the case of @samp{copy}
5593 and @samp{move}, the number is the one in the source folder, rather than
5594 the destination folder).
5596 @subsection Re-filing Reserved Messages
5598 The three standard functions copy reserved messages to the archive
5599 folder, but do not delete them from the source folder. Because
5600 reserved messages and the like always remain, they are recorded in
5601 @file{~/.elmo/expired-alist} so that they are not copied over and over
5602 again. They are not recorded if copied by @code{wl-summary-archive}.
5604 If you enabled logging, usually @samp{move} is recorded for re-filing,
5605 but instead @samp{copy} and @samp{delete} are recorded separately if
5606 reserved messages are involved. This is because it actually copies
5607 messages including reserved, then deletes ones except reserved in that
5610 @section Customizable Variables
5613 @item wl-expire-alist
5614 @vindex wl-expire-alist
5615 The initial setting is @code{nil}.
5616 This variable specifies folders and methods to expire. For details,
5617 refer to @code{wl-expire-alist} settings above.
5619 @item wl-summary-expire-reserve-marks
5620 @vindex wl-summary-expire-reserve-marks
5621 The initial setting is the list below.
5625 (list wl-summary-important-mark
5627 wl-summary-unread-mark
5628 wl-summary-unread-uncached-mark
5629 wl-summary-unread-cached-mark)
5633 Messages with these marks are retained in the folder, even after
5635 Only permanent marks can be listed, not temporary marks.
5637 You can list marks one by one as in the default; you can use the
5638 following settings as well:
5642 All messages with permanent marks are retained,
5643 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5647 All messages are handled as usual ones that are already read, no matter
5648 what marks they have; even important messages are deleted.
5651 @item wl-expire-archive-files
5652 @vindex wl-expire-archive-files
5653 The initial setting is 100.
5654 This variable specifies the number of messages to be retained in one
5657 @item wl-expire-number-with-reserve-marks
5658 @vindex wl-expire-number-with-reserve-marks
5659 The initial setting is @code{nil}.
5660 If non-nil, if expiring messages are specified by @code{number},
5661 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5663 @item wl-expire-archive-get-folder-function
5664 @vindex wl-expire-archive-get-folder-function
5665 The initial setting is @code{wl-expire-archive-get-folder}.
5667 This variable specifies a function that returns the name of an archiving
5668 folder for standard functions in the place of @var{destination}.
5669 You can use the following three variables for simple modification of
5670 folder names; if you want more complex settings, define your own
5671 function in this variable.
5673 @code{wl-expire-archive-get-folder} can be customized by these
5676 @item @code{wl-expire-archive-folder-name-fmt}
5677 @item @code{wl-expire-archive-folder-type}
5678 @item @code{wl-expire-archive-folder-prefix}
5681 @item wl-expire-archive-folder-name-fmt
5682 @vindex wl-expire-archive-folder-name-fmt
5683 The initial setting is @samp{%s-%%05d;%s}.
5684 This is a @code{format} string for archiving folders used in
5685 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5686 Note that you must specify the message number by @samp{%%d}, because it
5687 is parsed twice by @code{format}.
5689 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5692 @item wl-expire-archive-date-folder-name-fmt
5693 @vindex wl-expire-archive-date-folder-name-fmt
5694 The initial setting is @samp{%s-%%04d%%02d;%s}.
5695 This is a @code{format} string for archiving folders used in
5696 @code{wl-expire-archive-date}. Note that you must specify the message
5697 number by @samp{%%d}, because it is parsed twice by @code{format}.
5698 There should be @samp{%%d} twice, one for the year and the other for the
5701 If you modify this, adjust
5702 @code{wl-expire-archive-date-folder-num-regexp} as well.
5704 @item wl-expire-archive-folder-type
5705 @vindex wl-expire-archive-folder-type
5706 The initial setting is @code{zip}.
5707 This variable specifies an archiver type of the archiving folders.
5709 @item wl-expire-archive-folder-prefix
5710 @vindex wl-expire-archive-folder-prefix
5711 The initial setting is @code{nil}.
5712 This variable specifies the prefix (directory structure) to archiving
5714 Exercise extreme caution in using this feature, as it has not been
5716 In the worst case, there is a fear of destructing archiving folders.
5720 There will be no prefix.
5723 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5724 @samp{$ml/wl-00000;zip;wl}.
5727 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5730 @samp{$ml/wl-00000;zip;ml/wl}.
5733 @item wl-expire-archive-folder-num-regexp
5734 @vindex wl-expire-archive-folder-num-regexp
5735 The initial setting is @samp{-\\([-0-9]+\\);}.
5736 This variable specifies the regular expression to be used for getting
5737 message numbers from multiple archiving folders specified by
5738 @code{elmo-list-folders}.
5739 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5741 @item wl-expire-archive-date-folder-num-regexp
5742 @vindex wl-expire-archive-date-folder-num-regexp
5743 The initial setting is @samp{-\\([-0-9]+\\);}.
5744 This is the regular expression to be used for getting message numbers
5745 from multiple archiving folders specified by @code{elmo-list-folders}.
5746 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5748 @item wl-expire-delete-oldmsg-confirm
5749 @vindex wl-expire-delete-oldmsg-confirm
5750 The initial setting is @code{t}.
5751 If non-nil, messages older than the one with the largest number will be
5752 deleted with confirmation.
5753 If @code{nil}, they are deleted without confirmation.
5755 This feature is valid only if non-nil is specified as a argument to the
5756 standard functions so as to retain numbers.
5758 @item wl-expire-use-log
5759 @vindex wl-expire-use-log
5760 The initial setting is @code{nil}.
5761 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5762 They are appended but not truncated or rotated automatically; you might
5763 need to remove it manually.
5765 @item wl-expire-add-seen-list
5766 @vindex wl-expire-add-seen-list
5767 The initial setting is @code{t}.
5769 If non-nil, when messages are re-filed by expiration, read/unread
5770 information is passed to the destination folder.
5772 However if you do not read the destination folder from Wanderlust,
5773 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5774 want to set this to @code{nil} if you are simply saving to some
5775 archiving folders. Even if its value is @code{nil}, messages in the
5776 archiving folders are simply treated as unread; it does not affect
5779 @item wl-expire-folder-update-msgdb
5780 @vindex wl-expire-folder-update-msgdb
5781 The initial setting is @code{t}.
5782 If @code{t}, in the folder mode, expiration is carried out after
5783 updating summary information. If you specified a list of regular
5784 expressions of folder names, summary information is updated for matching
5789 @node Archive, , Expire, Expire and Archive
5790 @section Archiving Messages
5792 @subsection Archiving Messages
5793 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5794 folders. If there are the archiving folders already, only new messages
5797 You can use @code{wl-archive-alist} in order to specify how messages are
5798 archived according to their folder names, as in @code{wl-expire-alist}.
5803 (setq wl-archive-alist
5804 '(("^\\+tmp$" wl-archive-date)
5805 ("^\\+outbox$" wl-archive-number2)
5806 (".*" wl-archive-number1)))
5810 Each item in the list has the following format:
5813 (@var{folders-regexp} @var{deleting-function})
5816 As you can see, you can only use a function after @var{folders-regexp}.
5817 Per default, there are three functions:
5820 @item @code{wl-archive-number1}
5821 @item @code{wl-archive-number2}
5822 @item @code{wl-archive-date}
5825 As inferred from their names, they work similarly to "expire" versions,
5826 other than the following points:
5829 @item No messages are deleted
5830 @item Message numbers are retained even if invoked without arguments
5833 These functions are good to archive all messages in a folder by their
5834 numbers or by their dates.
5835 These are also useful for backup or confirmation purposes before
5837 If you try to re-file them after they are archived, they are deleted but
5840 Per default, the archiving folders to which messages are copied are
5841 determined automatically by @code{wl-expire-archive-get-folder-function}.
5842 You can copy to a specific folder by invoking with a prefix argument,
5843 i.e. @kbd{C-u M-x wl-summary-archive}.
5845 Note that this feature has not been seriously tested, because you can
5846 simply copy to an archiving folder, for example by
5847 @code{wl-summary-copy-region}.
5849 The archiving folders are determined by the same logic as in
5850 @code{wl-summary-expire}; the following customizable variables are
5854 @item @code{wl-expire-archive-files}
5855 @item @code{wl-expire-archive-get-folder-function}
5856 @item @code{wl-expire-archive-folder-name-fmt}
5857 @item @code{wl-expire-archive-folder-type}
5858 @item @code{wl-expire-archive-folder-prefix}
5859 @item @code{wl-expire-archive-folder-num-regexp}
5862 @subsection Customizable Variables
5865 @item wl-archive-alist
5866 @vindex wl-archive-alist
5867 The initial setting is the list shown below:
5871 ((".*" wl-archive-number1))
5876 This variable specifies a function that copies to archiving folders.
5877 To the function, three arguments are passed: a folder name, a list of
5878 messages in the folder, and msgdb information of the summary.
5879 Needless to say, you can use your own function.
5883 @node Scoring, Split messages, Expire and Archive, Top
5884 @chapter Score of the Messages
5886 @c @cindex Kill File
5888 Scoring is the function that associates a score (value) with each
5889 message, and marks as read or deletes from the summary according to it.
5891 You can put target or important marks on essential messages, or read marks
5892 on the ones you do not want to read, for example spam articles.
5894 This scoring function has a capability and a format similar to the one
5895 that Gnus has, although there are some unsupported features and
5896 Wanderlust specifics.
5897 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5900 * Score Commands:: Score Commands
5901 * Score File Format:: Score File Format
5905 @node Score Commands, Score File Format, Scoring, Scoring
5906 @section Score Commands
5907 @cindex Score Commands
5909 @subsection Score File Specification
5911 @code{wl-score-folder-alist} specifies score files or variables in which
5912 scores are defined, corresponding to folder names.
5916 (setq wl-score-folder-alist
5925 If paths to the score files are omitted, the directory specified in the
5926 variable @code{wl-score-files-directory} is assumed.
5928 No matter what you write in @code{wl-score-folder-alist}, the default
5929 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5930 read (it does not have to exist).
5931 Therefore, in the example above, the three score files,
5932 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5933 the folders that matches @samp{^-.*}.
5935 @subsection Scored Messages
5937 Scores are attached to the messages that are specified by
5938 @code{wl-summary-score-marks} temporarily when the summary is updated;
5939 when you exit from the summary, the scores are removed and reverts to
5942 @subsection Creation of Score Files
5944 In the summary buffer, move to an appropriate message and type @kbd{L}.
5945 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5946 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5948 This makes @minus{}1000 are scored for messages with the same
5949 @samp{Subject:} as the string you entered. That is, such a score file
5950 is created automatically.
5952 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5953 The score file you just made appears.
5954 This buffer is called @dfn{score editing buffer} thereafter.
5955 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5956 as you are previously; type @kbd{a}. Then a score entry for "From"
5958 In this way, you can create a score file easily either in the summary
5959 buffer or in the score editing buffer.
5961 By the way, you might be aware the numbers of key strokes are different
5962 between @kbd{s s p} and @kbd{a}.
5963 This is determined by @code{wl-score-header-default-entry}.
5964 This variable specifies the default score entries corresponding to
5966 For example, for "subject" field, a type and a time limit are prompted,
5967 but for "from" field, they are fixed upon automatically as substring and
5968 permanent respectively.
5969 However, score values can be modified by the prefix argument.
5970 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5973 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5974 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5975 erasing contents of the buffer deletes the score file being edited.
5979 @subsubsection Selecting Score Files
5981 You can change score files to which scores are appended by
5982 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5983 @code{wl-score-change-score-file}.
5985 @subsubsection Summing Up the Score
5987 If you add the same entries by @code{wl-summary-increase-score},
5988 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5989 scores for the entry is summed up.
5991 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5992 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5993 @minus{}1200 will be created as a result.
5995 @subsubsection Creating Thread Key
5997 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5998 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6000 @subsubsection Creating Followup Key
6002 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6003 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6004 at the cursor to @samp{References} key.
6005 If @code{wl-score-auto-make-followup-entry} is non-nil,
6006 @samp{Message-ID} of all messages to be followed up within dates
6007 specified by @code{wl-score-expiry-days}.
6009 @subsection Key Bindings
6014 @findex wl-summary-increase-score
6015 Increases the score for the current message.
6016 And the score entry is appended to the score file at the same moment.
6017 You can specify the score value by a prefix argument.
6021 @findex wl-summary-lower-score
6022 Decreases the score for the current message.
6023 And the score entry is appended to the score file at the same moment.
6024 You can specify the score value by a prefix argument.
6027 @kindex h R (Summary)
6028 @findex wl-summary-rescore
6029 Re-applies the scoring.
6030 However, already scored messages are not scored anew.
6033 @kindex h c (Summary)
6034 @findex wl-score-change-score-file
6035 Changes the score file currently selected.
6038 @kindex h e (Summary)
6039 @findex wl-score-edit-current-scores
6040 Edits the score file currently selected.
6041 If there are multiple score files, the previously specified one is
6045 @kindex h f (Summary)
6046 @findex wl-score-edit-file
6047 Edits an arbitrary score file and selects it.
6050 @kindex h F (Summary)
6051 @findex wl-score-flush-cache
6052 Erases caches associated to the score files that are read.
6053 If you modified score files directly (from other than Wanderlust), you
6054 need to re-read them after erasing the cache.
6057 @kindex h m (Summary)
6058 @findex wl-score-set-mark-below
6059 Specifies the criterion for scores to be marked as read.
6060 Messages with scores less than this value are marked as read.
6063 @kindex h x (Summary)
6064 @findex wl-score-set-expunge-below
6065 Specifies the criterion for scores to be deleted from the summary.
6066 Messages with scores less than this value are deleted.
6067 "Deleted" means it is not shown; they are not removed from the summary
6068 information or the folder.
6069 The deleted messages can be shown by rescan-noscore again.
6072 @subsection Key Bindings in the Score Editing Buffer
6076 @kindex C-c C-k (Score Mode)
6077 @findex wl-score-edit-kill
6078 Abandons the file being edited.
6081 @kindex C-c C-c (Score Mode)
6082 @findex wl-score-edit-exit
6083 Saves the file being edited, and quits from the edit mode.
6086 @kindex C-c C-p (Score Mode)
6087 @findex wl-score-pretty-print
6091 @kindex C-c C-d (Score Mode)
6092 @findex wl-score-edit-insert-date
6093 Inserts the number of dates from Dec. 31, 1 B.C.
6094 It is used for creating the third factor of time-limited scores.
6097 @kindex C-c C-s (Score Mode)
6098 @findex wl-score-edit-insert-header
6099 Inserts the header of the message selected in the summary buffer.
6102 @kindex C-c C-e (Score Mode)
6103 @findex wl-score-edit-insert-entry
6104 Inserts the score entry of the message selected in the summary buffer.
6107 @subsection Customizable Variables
6110 @item wl-summary-default-score
6111 @vindex wl-summary-default-score
6112 The initial setting is 0 (zero).
6113 This variable specifies the default value of the score.
6114 The score is increased or decreased based upon this value.
6116 @item wl-summary-important-above
6117 @vindex wl-summary-important-above
6118 The initial setting is @code{nil}.
6119 Messages with scores larger than this value are attached with the
6120 important mark (@samp{$}).
6121 If @code{nil}, no important marks are attached.
6123 @item wl-summary-target-above
6124 @vindex wl-summary-target-above
6125 The initial setting is @code{nil}.
6126 Messages with scores larger than this value are attached with the target
6128 If @code{nil}, no target marks are attached.
6130 @item wl-summary-mark-below
6131 @vindex wl-summary-mark-below
6132 The initial setting is 0 (zero).
6133 Messages with scores smaller than this value are marked as read.
6135 @item wl-summary-expunge-below
6136 @vindex wl-summary-expunge-below
6137 The initial setting is @code{nil}.
6138 Messages with scores smaller than this value are deleted from the
6140 If @code{nil}, they are not deleted.
6142 @item wl-summary-score-marks
6143 @vindex wl-summary-score-marks
6144 The initial setting is the list shown below:
6148 (list wl-summary-new-mark)
6153 Messages with these marks are scored.
6155 @item wl-use-scoring
6156 @vindex wl-use-scoring
6157 The initial setting is t.
6158 If non-nil, scoring is enabled.
6160 @item wl-score-files-directory
6161 @vindex wl-score-files-directory
6162 The initial setting is @file{~/.elmo/}.
6163 The default directory for score files.
6165 @item wl-score-interactive-default-score
6166 @vindex wl-score-interactive-default-score
6167 The initial setting is 1000.
6168 This value is used as a score when a score factor is @code{nil} in the
6169 score file. It is also used in @code{wl-summary-increase-score} and
6170 @code{wl-summary-lower-score}, on condition that the value of
6171 @code{wl-score-header-default-entry} is @code{nil}.
6173 @item wl-score-expiry-days
6174 @vindex wl-score-expiry-days
6175 The initial setting is 7.
6176 This is the number of days before time-limited scores are deleted.
6178 @item wl-score-update-entry-dates
6179 @vindex wl-score-update-entry-dates
6180 The initial setting is @code{t}.
6181 If non-nil, it enables deletion of time-limited scores.
6183 @item wl-score-header-default-entry
6184 @vindex wl-score-header-default-entry
6185 Specifies the default value for each header field for score entries
6186 created by @code{wl-summary-increase-score},
6187 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6189 @item wl-score-simplify-fuzzy-regexp
6190 @vindex wl-score-simplify-fuzzy-regexp
6191 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6192 regular expression to be deleted from the string.
6193 Because this is usually used for Subject, the default is prefixes that
6194 are attached by mailing list programs.
6196 @item wl-summary-rescore-partial-threshold
6197 @vindex wl-summary-rescore-partial-threshold
6198 The initial setting is 200.
6199 When sync-all or rescan is executed, if there are messages more than
6200 this value, only the last same number of messages as this value are
6203 @item wl-summary-auto-sync-marks
6204 @vindex wl-summary-auto-sync-marks
6205 If non-nil, unread/important marks are synchronized when the summary
6207 Unread marks reflect information on the IMAP4 server.
6208 Important marks reflect information on the IMAP4 server (flagged or
6209 not), and contents of @samp{'mark} folder.
6210 The initial setting is @code{t}.
6214 @node Score File Format, , Score Commands, Scoring
6215 @section Score File Format
6216 @cindex Score File Format
6218 The format of score files are the same as Gnus, and basically you can
6219 use Gnus score files as they are. But they are not fully compatible
6220 because some keys are not supported and there are Wanderlust specifics.
6221 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6226 ("for sale" -1000 nil s)
6227 ("profit" -1000 nil s))
6229 ("spam@@spamspamspam" -10000 nil s))
6231 ("my@@address" 3001 nil s))
6233 (1000000 -10 nil >))
6243 If the key is a string, it is the name of the header to be matched.
6244 The following keys are available:
6245 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6246 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6247 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6248 @code{Chars} and @code{Lines} mean the size and the number of lines of
6249 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6250 are described later.
6251 The rest corresponds the field of the same name.
6253 Arbitrary numbers of core entries are specified after the key.
6254 Each score entry consists of these five factors:
6258 A factor that matches header. This should be a number in the cases of
6259 @code{lines} and @code{chars}, otherwise a string.
6262 A score factor. When the first item matches, the score of the message
6263 is increased or decreased by this value.
6266 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6267 of a number, the score is deleted if it does not match for days
6268 (@code{wl-score-expiry-days}) from the date specified by this.
6269 The date is since Dec. 31, 1 B.C.
6272 A type factor. This specifies the way the first factor matches.
6273 Available types depend on keys.
6276 @item From, Subject, References, Message-ID
6277 For these keys in string, @code{r} and @code{R} (regexp),
6278 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6279 as well as @code{f} and @code{F} (fuzzy) can be used.
6280 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6283 For these keys, the following five numerical relative operators can be
6284 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6287 This key matches @code{From} header, and scores all follow-ups to the
6289 For example, it would be useful for increasing scores for follow-ups to
6292 You can use the same types as @code{From} except for @code{f}.
6293 And a @samp{Followup} entry is automatically appended to the score file.
6296 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6297 A @samp{Thread} entry is automatically appended for each article that
6298 has @var{x} in the @code{References} header.
6299 You can make sure the whole thread including messages that does not have
6300 all ancestors @code{Message-ID} in @code{References} is scored.
6302 You can use the same types as @code{References} except for @code{f}.
6303 And a @samp{Thread} entry is automatically appended to the score file.
6307 A factor for extension header. This is meaningful only if the key is
6309 This specifies headers to be matched other than standard headers like
6310 @code{Subject} and @code{From}.
6311 Note that you should specify the header in
6312 @code{elmo-msgdb-extra-fields} also.
6313 Therefore it does not work in folders where extension headers cannot be
6318 The sum of these scores @emph{after all factors are applied} becomes the
6319 score of the message.
6321 @cindex Score File Atoms
6323 Messages with a score less than this value is marked as read.
6324 The default is @code{wl-summary-mark-below}.
6327 Messages with a score less than this value is deleted from the summary.
6328 The default is @code{wl-summary-expunge-below}.
6330 @item mark-and-expunge
6331 Both @code{mark} and @code{expunge} are applied,
6332 i.e. messages with a score less than this value is marked as read and
6333 deleted from the summary.
6336 Messages with a score greater than this value is attached with temp
6338 The default is @code{wl-summary-target-above}.
6341 Messages with a score greater than this value is attached with important
6343 The default is @code{wl-summary-important-above}.
6348 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6349 are used, you need to set @code{elmo-msgdb-extra-fields}.
6352 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6355 There are other restrictions as shown below:
6358 @item Because @samp{References} field in the summary information
6359 contains only the last @samp{Message-ID}, @code{references} key matches
6363 Keys that can be seen by folder of types:
6367 chars lines xref extra
6368 localdir,localnews Y E E E
6369 nntp (supporting xover) Y E E N
6375 N: cannot be seen (ignored)
6376 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6381 @node Split messages, Address Book, Scoring, Top
6382 @chapter Message splitting
6383 @cindex Split messages
6385 You can use @code{elmo-split} to split message in folder specified by
6386 the variable @code{elmo-split-folder} a la @command{procmail} according
6387 to some specified rules. To use this feature, set as follows in your
6388 @file{~/.emacs} at first.
6391 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
6394 Set source folder like following.
6397 (setq elmo-split-folder "%inbox")
6400 And specify the rule in the variable @code{elmo-split-rule} (its format
6401 will be is described below).
6402 Then you can invoke @kbd{M-x elmo-split} to split messages according to
6403 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
6404 to do a rehearsal and show result (do not split actually).
6407 We will describe how to specify the rule. First of all, see following
6412 (setq elmo-split-rule
6413 ;; @r{Store messages from spammers into @samp{+junk}}
6414 '(((or (address-equal from "i.am@@spammer")
6415 (address-equal from "dull-work@@dull-boy")
6416 (address-equal from "death-march@@software")
6417 (address-equal from "ares@@aon.at")
6418 (address-equal from "get-money@@richman"))
6420 ;; @r{Store messages from mule mailing list into @samp{%mule}}
6421 ((equal x-ml-name "mule") "%mule")
6422 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
6423 ;; @r{and continue evaluating following rules}
6424 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
6425 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
6426 ((match from "\\(.*\\)@@yahoo\\.com")
6428 ;; @r{Store unmatched mails into @samp{+inbox}}
6433 The basic unit of the rule is a combination like
6436 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
6439 If @samp{CONDITION} is true, @samp{ACTION} is performed.
6440 The 1st element @samp{CONDITION} is a condition represented by a
6441 balanced expression (sexp). Its grammar will be explained below.
6442 The 2nd element @samp{ACTION} is the name of the folder to split
6443 messages into, or a symbol. When the 3rd element @code{continue} is
6444 specified as symbol, evaluating rules is not stopped even when the
6445 condition is satisfied.
6447 The grammar for @samp{CONDITION} is as follows. See example above to
6448 learn how to write the condition practically.
6452 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
6453 (@samp{FIELD-NAME} is a symbol that describes the field name)
6457 True if the field value equals to @samp{VALUE}.
6458 Case of the letters are ignored.
6460 True if the field value matches to VALUE.
6461 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6462 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6463 @item @code{address-equal}
6464 True if one of the addresses in the field equals to
6465 @samp{VALUE}. Case of the letters are ignored.
6466 @item @code{address-match}
6467 True if one of the addresses in the field matches to
6469 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6470 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6474 Functions which accept an integer argument (@samp{SIZE}).
6478 True if the size of the message is less than @samp{SIZE}.
6480 True if the size of the message is greater than @samp{SIZE}.
6484 Functions which accept any number of arguments.
6488 True if one of the argument returns true.
6490 True if all of the arguments return true.
6496 When a symbol is specified, it is evaluated.
6499 You can specify followings as 2nd @samp{ACTION}.
6505 If some string is specified, it will be regarded as the destination
6506 folder, and the message will be appended to it.
6511 If the symbol @samp{delete} is specified, delete the substance of the
6512 message in @code{elmo-split-folder}
6517 If the symbol @samp{noop} is specified, do nothing on the message and
6523 If some function is specified, execute it.
6526 If the message passes all rules, it will be dealed along @samp{ACTION}
6527 specified by @code{elmo-split-default-action}.
6530 @node Address Book, Customization, Split messages, Top
6531 @chapter Address Book
6532 @cindex Address Book
6534 With address book, you can utilize address completion, and you have
6535 summary displayed with nicknames.
6538 * Mail Addresses:: Definition of Address Book
6539 * Address Manager:: Address Manager
6543 @node Mail Addresses, Address Manager, Address Book, Address Book
6544 @section Address book
6545 @cindex Address book Definition
6547 @cindex Alias, Address
6549 The file @file{~/.addresses} is a simple address book for Wanderlust.
6550 Make address file @file{~/.addresses}, and edit to suit your requirement.
6552 The data written in @file{~/.addresses} are used for address completion
6553 under draft editing mode. Furthermore, they are used when showing names
6554 in summary display mode. You can safely skip this section, if you don't
6555 want to customize address completion and summary display.
6556 It is possible to add/change/remove addresses from @file{~/.addresses} in
6557 summary buffer after Wanderlust is invoked. @refill
6559 The format is very simple. Like this. @refill
6564 # @r{Lines begin with @samp{#} are comment.}
6565 # @r{Empty lines are ignored}
6567 # @r{Format of each line:}
6568 # @var{email-address} "@var{nickname} "@var{realname}"
6570 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6571 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6572 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6577 One line defines one persons description.
6579 Actually, in default setup, @var{nickname} is used in summary-mode and
6580 @var{realname} is used in draft preparation mode. This behavior is
6581 better understood if you try it and confirmed the function first. You
6582 can write and try a small definition, so you will know the idea of the
6583 address book before writing a big one.
6585 And, if MH alias file is specified in variable @code{wl-alias-file},
6586 it is used as an address information in the draft preparation mode.
6588 If variable @code{wl-use-ldap} is non-nil (initial setting is
6589 @code{nil}), address completion in draft mode uses LDAP information.
6591 If you use LDAP, you have to set @code{wl-ldap-server},
6592 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6593 not have LDAP feature as built-in feature (Currently only XEmacs can
6594 have built-in LDAP feature), you have to set command exec @env{PATH} to
6595 the program @command{ldapsearch}.
6598 @node Address Manager, , Mail Addresses, Address Book
6599 @section Address Manager
6600 @cindex Address Manager
6602 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6603 the address book and insert address to draft buffer.
6605 @subsection Key Bindings
6609 @kindex t (Address Manager)
6610 @findex wl-addrmgr-set-to
6611 Add @samp{To:} mark.
6614 @kindex c (Address Manager)
6615 @findex wl-addrmgr-set-cc
6616 Add @samp{Cc:} mark.
6619 @kindex b (Address Manager)
6620 @findex wl-addrmgr-set-bcc
6621 Add @samp{Bcc:} mark.
6624 @kindex u (Address Manager)
6625 @findex wl-addrmgr-unmark
6629 @kindex x (Address Manager)
6630 @findex wl-addrmgr-apply
6632 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6633 buffer and quit address manager. When no draft buffer, make new draft
6634 with insert marked addresses.
6636 If no mark, quit address manager.
6640 @kindex q (Address Manager)
6641 @findex wl-addrmgr-quit
6642 Quit address manager.
6645 @kindex a (Address Manager)
6646 @findex wl-addrmgr-add
6650 @kindex d (Address Manager)
6651 @findex wl-addrmgr-delete
6655 @kindex e (Address Manager)
6656 @findex wl-addrmgr-edit
6661 @node Customization, Terminology, Address Book, Top
6662 @chapter Customizing Wanderlust
6663 @cindex Customization
6666 * Living with other packages:: Cooperating with other packages
6667 * Highlights:: Highlights
6668 * Biff:: Notify Mail arrival
6669 * Advanced Settings:: Advanced Settings
6670 * Customizable Variables:: Customizable Variables
6675 @node Living with other packages, Highlights, Customization, Customization
6676 @section Living with other packages
6678 Examples with other packages.
6681 * imput:: imput (im-wl.el)
6682 * BBDB:: The Insidious Big Brother Database
6683 * LSDB:: The Lovely Sister Database
6684 * supercite:: supercite.el
6685 * mu-cite:: mu-cite.el
6686 * X-Face:: x-face,bitmap-mule
6687 * dired-dd:: dired-dd.el
6689 * Addrbook:: Addrbook
6690 * mime-w3m:: mime-w3m.el
6694 @node imput, BBDB, Living with other packages, Living with other packages
6699 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6702 If @command{imput} is on the @code{exec-path} at the installation,
6703 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6707 (autoload 'wl-draft-send-with-imput-async "im-wl")
6708 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6713 @node BBDB, LSDB, imput, Living with other packages
6717 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
6718 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
6719 and do the following settings.
6721 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6722 byte-compiled and installed.
6730 ;; @r{enable pop-ups}
6731 (setq bbdb-use-pop-up t)
6732 ;; @r{auto collection}
6733 (setq bbdb/mail-auto-create-p t)
6734 ;; @r{exceptional folders against auto collection}
6735 (setq bbdb-wl-ignore-folder-regexp "^@@")
6736 (setq signature-use-bbdb t)
6737 (setq bbdb-north-american-phone-numbers-p nil)
6738 ;; @r{shows the name of bbdb in the summary} :-)
6739 (setq wl-summary-from-function 'bbdb-wl-from-func)
6740 ;; @r{automatically add mailing list fields}
6741 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6742 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6746 You can complete address with BBDB by @kbd{M-@key{TAB}}
6750 @node LSDB, supercite, BBDB, Living with other packages
6754 The following is an example setting to use
6755 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
6762 (add-hook 'wl-draft-mode-hook
6764 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
6768 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
6769 (complete address with LSDB).
6772 @node supercite, mu-cite, LSDB, Living with other packages
6773 @subsection sc.el(supercite), sc-register.el
6777 The same setting as usual mailers should be OK. The following is an
6778 example of settings:
6782 (autoload 'sc-cite-original "supercite" nil t)
6783 (add-hook 'mail-citation-hook 'sc-cite-original)
6788 @node mu-cite, X-Face, supercite, Living with other packages
6789 @subsection mu-cite.el
6792 The same setting as usual mailers should be OK. The following is an
6793 example of settings.
6795 If you use mu-cite version 8.0 or earlier:
6799 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6800 (setq mail-citation-hook 'mu-cite/cite-original)
6804 If you use mu-cite version 8.1 or later:
6808 (autoload 'mu-cite-original "mu-cite" nil t)
6809 (add-hook 'mail-citation-hook (function mu-cite-original))
6813 @node X-Face, dired-dd, mu-cite, Living with other packages
6817 If you have installed one of the following, you can decode
6818 @samp{X-Face:} field in message buffer and you will see face image.
6821 * x-face-xmas:: XEmacs case
6822 * x-face-mule:: Emacs case
6825 If there is an encoded X-Face string in a file @file{~/.xface} (the
6826 value of the variable @code{wl-x-face-file}), it is inserted as a
6827 @samp{X-Face:} field in the draft buffer (if
6828 @code{wl-auto-insert-x-face} is non-nil).
6830 @node x-face-xmas, x-face-mule, X-Face, X-Face
6831 @subsubsection x-face-xmas (for XEmacs)
6834 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6835 1.3.6.13 or later, do the following:
6839 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6840 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6844 @node x-face-mule, , x-face-xmas, X-Face
6845 @subsubsection x-face-mule (for Emacs)
6849 If you use @file{x-face-mule.el} in bitmap-mule
6850 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6854 (autoload 'x-face-decode-message-header "x-face-mule")
6855 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6859 @subsubsection x-face-e21 (for Emacs 21.x)
6862 With Emacs 21.x, you can use @file{x-face-e21.el}
6863 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6864 to display X-Face. In this case, bitmap-mule is not required.
6869 (autoload 'x-face-decode-message-header "x-face-e21")
6870 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6875 @node dired-dd, MHC, X-Face, Living with other packages
6876 @subsection dired-dd(Dired-DragDrop)
6877 @pindex Dired-DragDrop
6879 @cindex Drag and Drop
6881 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6882 compose multi-part by simple Drag-and-Drop from dired to the draft
6883 buffer being edited in GNU Emacs (this feature is not Wanderlust
6884 specific, but general-purpose for SEMI).
6888 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6894 ;; @r{Set dired-x variables here.}
6895 ;; @r{To and flo@dots{}}
6897 (progn (require 'dired-dd)
6898 (require 'dired-dd-mime))))))
6902 @node MHC, Addrbook, dired-dd, Living with other packages
6906 Message Harmonized Calendaring system
6907 (@uref{http://www.quickhack.net/mhc/})
6909 By using MHC, you can make a calendar from the messages.
6915 (setq mhc-mailer-package 'wl)
6916 (autoload 'mhc-mode "mhc" nil t)
6917 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6918 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6926 (autoload 'mhc-wl-setup "mhc-wl")
6927 (add-hook 'wl-init-hook 'mhc-wl-setup)
6931 @node Addrbook, mime-w3m, MHC, Living with other packages
6932 @subsection wl-addrbook.el
6936 (@uref{http://www.mew.org/})
6938 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6939 @code{load-path} and do the following settings.
6943 (require 'wl-addrbook)
6948 @node mime-w3m, , Addrbook, Living with other packages
6949 @subsection mime-w3m.el
6952 You can display html part by using @file{mime-w3m.el}
6953 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6954 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6957 @node Highlights, Biff, Living with other packages, Customization
6960 @subsection Customizable Variables
6963 @item wl-summary-highlight
6964 @vindex wl-summary-highlight
6965 The initial setting is @code{t}.
6966 If non-nil, the summary is highlighted.
6968 @item wl-highlight-max-summary-lines
6969 @vindex wl-highlight-max-summary-lines
6970 The initial setting is 10000.
6971 The summary is not highlighted if it has more lines than this value.
6973 @item wl-summary-highlight-partial-threshold
6974 @vindex wl-summary-highlight-partial-threshold
6975 The initial setting is 1000.
6976 This is a threshold whether the whole summary is highlighted.
6977 If there are more lines of messages in the summary, it is partially
6980 @item wl-summary-partial-highlight-above-lines
6981 @vindex wl-summary-partial-highlight-above-lines
6982 The initial setting is 30. If there are more lines of messages than
6983 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6984 after the point that is the same number of lines as this value above the
6985 cursor line are highlighted partially. (If this value is @code{nil},
6986 the last same number of lines as the value of
6987 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6989 @item wl-highlight-body-too
6990 @vindex wl-highlight-body-too
6991 The initial setting is @code{t}.
6992 If non-nil, bodies of drafts and messages are also highlighted.
6994 @item wl-highlight-message-header-alist
6995 @vindex wl-highlight-message-header-alist
6996 When highlighting headers of drafts and messages, this variable
6997 specifies which faces are allocated to important
6998 (@code{wl-highlight-message-important-header-contents}), secondly
6999 important (@code{wl-highlight-message-important-header-contents2}), and
7000 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7002 Similarly, it can be used for allocating arbitrary faces to arbitrary
7003 regular expressions.
7005 @item wl-highlight-citation-prefix-regexp
7006 @vindex wl-highlight-citation-prefix-regexp
7007 Specifies a regular expression to which quoted lines in bodies of
7008 drafts and messages match.
7009 Bodies matching to this regular expression are highlighted by the faces
7010 specified by (@code{wl-highlight-message-cited-text-*}).
7012 @item wl-highlight-highlight-citation-too
7013 @vindex wl-highlight-highlight-citation-too
7014 The initial setting is @code{nil}.
7015 If non-nil, the quoting regular expression itself given by
7016 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7018 @item wl-highlight-citation-header-regexp
7019 @vindex wl-highlight-citation-header-regexp
7020 Specifies a regular expression that denotes beginning of quotation.
7021 Bodies matching to this regular expression are highlighted by the face
7022 specified by @code{wl-highlight-message-headers}.
7024 @item wl-highlight-max-header-size
7025 @vindex wl-highlight-max-header-size
7026 The initial setting is @code{nil}. If a header size is larger than this
7027 value, it will not be highlighted. If @code{nil}, always highlighted
7028 (ignore header size).
7030 @item wl-highlight-max-message-size
7031 @vindex wl-highlight-max-message-size
7032 The initial setting is 10000.
7033 If a message is larger than this value, it will not be highlighted.
7034 With this variable, highlight is suppressed for uuencode or huge digest
7037 @item wl-highlight-signature-separator
7038 @vindex wl-highlight-signature-separator
7039 Specifies regular expressions that denotes the boundary of a signature.
7040 It can be a regular expression, or a list of ones.
7041 Messages after the place that matches this regular expression are
7042 highlighted by the face specified by
7043 @code{wl-highlight-message-signature}.
7045 @item wl-max-signature-size
7046 @vindex wl-max-signature-size
7047 The initial setting is 400.
7048 This is the largest size for a signature to be highlighted.
7050 @item wl-use-highlight-mouse-line
7051 @vindex wl-use-highlight-mouse-line
7052 The initial setting is @code{t}.
7053 If non-nil, the line pointed by the mouse is highlighted in the folder
7054 mode, summary mode, and the like.
7057 @subsection Setting Colors and Fonts of the Characters
7059 If you want to change colors or fonts of the characters, you need to
7060 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7061 want to change fonts, and @code{set-face-foreground} for colors, and so
7062 on. You cannot write face settings in @file{.emacs}; write in
7065 For example, if you want to change the color for signatures to yellow,
7069 (set-face-foreground 'wl-highlight-message-signature "yellow")
7075 Faces defined in Wanderlust:
7078 @item wl-highlight-message-headers
7079 The face for field names of message headers.
7081 @item wl-highlight-message-header-contents
7082 The face for field bodies of message headers.
7084 @item wl-highlight-message-important-header-contents
7085 The face for important parts of message headers.
7086 Per default, this face is used for a body of @samp{Subject:} field.
7087 You can change its value by editing
7088 @code{wl-highlight-message-header-alist}.
7090 @item wl-highlight-message-important-header-contents2
7091 The face for secondly important parts of message headers.
7092 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7093 fields. You can change its value by editing
7094 @code{wl-highlight-message-header-alist}.
7096 @item wl-highlight-message-unimportant-header-contents
7097 The face for unimportant parts of message headers.
7098 Per default, this face is used for bodies of @samp{X-} fields
7099 @samp{User-Agent:} fields. You can change its value by editing
7100 @code{wl-highlight-message-header-alist}.
7102 @item wl-highlight-message-citation-header
7103 The face for headers of quoted messages.
7105 @item wl-highlight-message-cited-text-*
7106 The face for texts of quoted messages. The last @samp{*} is a
7107 @var{single figure} so that 10 different colors can be used according to
7110 @item wl-highlight-message-signature
7111 The face for signatures of messages. The initial settings are
7112 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7113 dark background colors.
7115 @item wl-highlight-header-separator-face
7116 The face for header separators of draft messages.
7118 @item wl-highlight-summary-important-face
7119 The face for message lines with important marks in the summary.
7121 @item wl-highlight-summary-new-face
7122 The face for message lines with new marks in the summary.
7124 @item wl-highlight-summary-displaying-face
7125 The face for the message line that is currently displayed.
7126 This face is overlaid.
7128 @item wl-highlight-thread-indent-face
7129 The face for the threads that is currently displayed.
7131 @item wl-highlight-summary-unread-face
7132 The face for message lines with unread marks in the summary.
7134 @item wl-highlight-summary-deleted-face
7135 The face for message lines with delete marks in the summary.
7137 @item wl-highlight-summary-refiled-face
7138 The face for message lines with re-file marks in the summary.
7140 @item wl-highlight-refile-destination-face
7141 The face for re-file information part of message lines with re-file
7142 marks in the summary.
7144 @item wl-highlight-summary-copied-face
7145 The face for message lines with copy marks in the summary.
7147 @item wl-highlight-summary-target-face
7148 The face for message lines with target marks @samp{*} in the summary.
7150 @item wl-highlight-summary-thread-top-face
7151 The face for message lines that are on the top of the thread in the
7154 @item wl-highlight-summary-normal-face
7155 The face for message lines that are not on top of the thread in the
7158 @item wl-highlight-folder-unknown-face
7159 The face for folders that are not known to have how many unsync messages
7162 @item wl-highlight-folder-zero-face
7163 The face for folders that have no unsync messages in the folder mode.
7165 @item wl-highlight-folder-few-face
7166 The face for folders that have some unsync messages in the folder mode.
7168 @item wl-highlight-folder-many-face
7169 The face for folders that have many unsync messages in the folder mode.
7170 The boundary between `some' and `many' is specified by the variable
7171 @code{wl-folder-many-unsync-threshold}.
7173 @item wl-highlight-folder-unread-face
7174 The face for folders that have no unsync but unread messages in the
7177 @item wl-highlight-folder-killed-face
7178 The face for folders that are deleted from the access group in the
7181 @item wl-highlight-folder-opened-face
7182 The face for open groups in the folder mode.
7183 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7184 @code{nil} or a @var{number}.
7186 @item wl-highlight-folder-closed-face
7187 The face for close groups in the folder mode.
7188 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7189 @code{nil} or a @var{number}.
7191 @item wl-highlight-folder-path-face
7192 The face for the path to the currently selected folder in the folder
7195 @item wl-highlight-logo-face
7196 The face for logo in the demo.
7198 @item wl-highlight-demo-face
7199 The face for strings (for example, a version number) in the demo.
7203 @node Biff, Advanced Settings, Highlights, Customization
7204 @section Notify Mail arrival
7207 Following setting is to notify mail arrival of @samp{%inbox}
7208 by the indicator on the modeline
7211 (setq wl-biff-check-folder-list '("%inbox"))
7214 @subsection Customizable Variables
7216 @item wl-biff-check-folder-list
7217 @vindex wl-biff-check-folder-list
7218 The initial setting is @code{nil}.
7219 This is the list of folders to check mail arrival.
7220 If @code{nil}, wl doesn't check mail arrival.
7222 @item wl-biff-check-interval
7223 @vindex wl-biff-check-interval
7224 The initial setting is 40 (in seconds).
7225 Check mail arrival in this period.
7227 @item wl-biff-notify-hook
7228 @vindex wl-biff-notify-hook
7229 This hook is run at the arrival of new mail.
7230 To beep with mail arrival(initial setting), set as follows.
7232 (setq wl-biff-notify-hook '(ding))
7234 For silence, set to @code{nil}.
7238 @node Advanced Settings, Customizable Variables, Biff, Customization
7239 @section Advanced Settings
7242 * Draft for Reply:: Draft for Reply
7243 * Thread Format:: Appearance of Thread
7244 * User-Agent Field:: @samp{User-Agent:} Header Field
7248 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
7249 @subsection Draft for Replay
7250 @vindex wl-draft-reply-with-argument-list
7251 @vindex wl-draft-reply-without-argument-list
7252 @vindex wl-draft-reply-myself-with-argument-list
7253 @vindex wl-draft-reply-myself-without-argument-list
7255 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
7256 The addressee for the draft is decided by following rules.
7258 For example, you can set as follows:
7262 (setq wl-draft-reply-without-argument-list
7263 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7264 ("Followup-To" . (nil nil ("Followup-To")))
7265 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7266 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
7270 Where each element of the list @code{wl-draft-reply-without-argument-list}
7274 (key . (to-list cc-list newsgroup-list))
7277 and if the field designated by @samp{key} exist in the parent message,
7278 parent's field values designated by @samp{to-list} are copied to @samp{To:}
7279 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
7280 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
7281 the draft respectively.
7286 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7289 Match if the parent has @samp{Mail-Followup-To} field.
7290 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
7291 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
7295 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7298 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
7299 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
7302 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
7305 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
7306 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
7309 These are evaluated in order and first matched one is used.
7311 Moreover, the behavior of @kbd{a} with prefix argument can
7312 be directed by @code{wl-draft-reply-with-argument-list} as well.
7314 By the way, you can use some function (will be evaluated in the parent
7315 message buffer) in the place of @samp{key} or @samp{to-list} etc.
7316 For example, if you only want to reply to mailing lists in
7317 @code{wl-subscribed-mailing-list} if the parent has some of them,
7322 (defun wl-mailing-list-addresses ()
7326 (nth 1 (std11-extract-address-components addr)))
7329 (elmo-multiple-fields-body-list (list "To" "Cc"))
7331 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
7332 (setq list-addrs (cons to list-addrs))))
7333 (nreverse list-addrs)))
7335 (setq wl-draft-reply-with-argument-list
7336 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
7337 ("Reply-To" . (("Reply-To") nil nil))
7338 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
7339 ("From" . (("From") nil nil))))
7344 Note: To set the behavior when you reply to the message written by yourself,
7345 use @code{wl-draft-reply-myself-without-argument-list} and
7346 @code{wl-draft-reply-myself-with-argument-list} instead of them.
7348 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
7349 @subsection Appearance of Threads
7353 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
7354 390 09/18(Fri)07:25 +-[ Tsumura-san ]
7355 391 09/18(Fri)19:24 +-[ Murata-san ]
7356 392 09/20(Sun)21:49 +-[ Okunishi-san ]
7357 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
7358 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
7359 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
7360 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
7361 412 09/22(Tue)09:28 | +-[ Teranishi ]
7362 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
7363 416 09/22(Tue)12:38 | +-[ Teranishi ]
7364 395 09/20(Sun)21:49 +-[ Okunishi-san ]
7365 397 09/21(Mon)00:15 +-[ Okunishi-san ]
7369 Settings to make appearance of threads like shown above:
7373 (setq wl-thread-indent-level 2)
7374 (setq wl-thread-have-younger-brother-str "+")
7375 (setq wl-thread-youngest-child-str "+")
7376 (setq wl-thread-vertical-str "|")
7377 (setq wl-thread-horizontal-str "-")
7378 (setq wl-thread-space-str " ")
7382 If you do not want to see branches, do the following:
7386 (setq wl-thread-indent-level 2)
7387 (setq wl-thread-have-younger-brother-str " ")
7388 (setq wl-thread-youngest-child-str " ")
7389 (setq wl-thread-vertical-str " ")
7390 (setq wl-thread-horizontal-str " ")
7391 (setq wl-thread-space-str " ")
7396 @node User-Agent Field, , Thread Format, Advanced Settings
7397 @subsection User-Agent Field
7401 If you are eccentric enough to elaborate @samp{X-Mailer:} or
7402 @samp{User-Agent:} fields, define a function that generate appropriate
7403 strings as you like, and set it to variable
7404 @code{wl-generate-mailer-string-function}.
7406 If you do not want verbose @samp{User-Agent:} field, do the following:
7410 (setq wl-generate-mailer-string-function
7411 'wl-generate-user-agent-string-1)
7415 The following is a example:
7419 (setq wl-generate-mailer-string-function nil)
7420 (setq wl-draft-additional-header-alist
7422 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
7427 @node Customizable Variables, Hooks, Advanced Settings, Customization
7428 @section Customizable Variables
7430 Customizable variables that have not been described yet:
7433 @item wl-default-folder
7434 @vindex wl-default-folder
7435 The initial setting is @samp{%inbox}. This is the default value for moving to
7436 a folder and the like.
7438 @item wl-draft-folder
7439 @vindex wl-draft-folder
7440 The initial setting is @samp{+draft}. It is the folder to which drafts are
7441 saved. It must be a localdir folder.
7443 @item wl-trash-folder
7444 @vindex wl-trash-folder
7445 The initial setting is @samp{+trash}. It is the wastebasket folder.
7446 If you changed this variable, you had better restart Wanderlust.
7448 @item wl-interactive-exit
7449 @vindex wl-interactive-exit
7450 The initial setting is @code{t}.
7451 If non-nil, you are asked for confirmation when Wanderlust terminates.
7453 @item wl-interactive-send
7454 @vindex wl-interactive-send
7455 The initial setting is @code{t}.
7456 If non-nil, you are asked for confirmation when mail is sent.
7458 @item wl-folder-sync-range-alist
7459 @vindex wl-folder-sync-range-alist
7460 The initial setting is the alist shown below:
7465 ("^\\+draft$\\|^\\+queue$" . "all"))
7470 This is an associative list of regular expressions of folder names and
7471 update range of the summary. Update range is one of the @samp{all},
7472 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
7473 @samp{last}. If a folder do not match, @samp{update} is used.
7476 @vindex wl-ask-range
7477 The initial setting is @code{t}.
7478 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
7479 for updating the summary when you changed folders.
7481 @item wl-mime-charset
7482 @vindex wl-mime-charset
7483 The initial setting is @code{x-ctext}.
7484 This is the MIME charset for messages that are not MIME (e.g. without
7485 @samp{Content-Type:}). This value also used as default charset for
7486 summary. (If you want to share Summary on Nemacs and other Emacsen, set
7487 this value as @code{iso-2022-jp}.)
7489 @item wl-highlight-folder-with-icon
7490 @vindex wl-highlight-folder-with-icon
7491 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
7492 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
7494 @item wl-strict-diff-folders
7495 @vindex wl-strict-diff-folders
7496 This is a list of regular expressions of folders.
7497 Unread messages are checked, for example when you press @kbd{s} in
7498 the folder mode, usually in a brief way (rapidly processed but not
7500 The folders matching this variable are seriously checked.
7501 You may want to set this variable so as to match conditional filter
7502 folders for IMAP4 folders.
7503 The initial setting is @code{nil}.
7505 @item wl-folder-use-server-diff
7506 @vindex wl-folder-use-server-diff
7507 When unread messages are checked, for example when you press @kbd{s} in
7508 the folder mode, usually (the number of messages on the server) @minus{}
7509 (the number of local messages) will be the number of unread messages.
7510 However, if this variable is non-nil, the number of unread messages on
7511 the server is checked. This affects IMAP4 folders only, but IMAP4
7512 folders in mail boxes matching
7513 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
7514 the number of unread messages on the server, even if they matches this
7515 variable. The initial setting is @code{t}.
7517 @item wl-auto-check-folder-name
7518 @vindex wl-auto-check-folder-name
7519 The initial setting is @code{nil}.
7520 You can specify a folder or a group which is checked for unread message
7521 at the start. You can also specify a list of folders (groups) to be checked.
7522 If the value is @code{nil}, whole Desktop is checked at the start.
7523 If it is @code{none}, no folders are checked.
7525 @item wl-auto-uncheck-folder-list
7526 @vindex wl-auto-uncheck-folder-list
7527 The initial setting is the list shown below:
7536 You can set a list of regular expressions to specify folders
7537 which are not automatically checked even if they are included
7538 in some groups assigned by @code{wl-auto-check-folder-name}.
7540 @item wl-auto-check-folder-list
7541 @vindex wl-auto-check-folder-list
7542 The initial setting is @code{nil}.
7543 You can set a list of regular expressions to specify exceptions
7544 for @code{wl-auto-uncheck-folder-list}.
7546 @item wl-no-save-folder-list
7547 @vindex wl-no-save-folder-list
7548 The initial setting is the list shown below:
7557 This is a list of regular expressions of folders not to be saved.
7559 @item wl-save-folder-list
7560 @vindex wl-save-folder-list
7561 The initial setting is @code{nil}.
7562 This is a list of regular expressions of folders to be saved.
7563 This takes precedence over @code{wl-no-save-folder-list}.
7565 @item wl-folder-mime-charset-alist
7566 @vindex wl-folder-mime-charset-alist
7567 The initial setting is the alist shown below:
7571 (("^-alt\\.chinese" . big5)
7572 ("^-relcom\\." . koi8-r)
7574 ("^-han\\." . euc-kr))
7579 This is an associative list of regular expressions of folder names and
7581 If a folder do not match, @code{wl-mime-charset} is used.
7583 @item wl-folder-init-load-access-folders
7584 @vindex wl-folder-init-load-access-folders
7585 The initial setting is @code{nil}.
7586 This is a list of access groups to be loaded specifically at the start.
7587 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7589 @item wl-folder-init-no-load-access-folders
7590 @vindex wl-folder-init-no-load-access-folders
7591 The initial setting is @code{nil}.
7592 This is a list of access groups not to be loaded specifically at the
7594 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7596 @item wl-delete-folder-alist
7597 @vindex wl-delete-folder-alist
7598 The initial setting is the alist shown below:
7607 This list determines disposition of messages with delete marks.
7608 Each item in the list is a folder and destination; you can specify any
7609 one of the following in the place of destination:
7612 @code{remove} or @code{null} : deletes the messages instantly.
7613 string : moves the messages to the specific folder.
7614 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7617 @item wl-refile-policy-alist
7618 @vindex wl-refile-policy-alist
7619 The initial setting is the list shown below:
7629 This list determines whether messages with re-file marks are moved or
7630 copied. Each item in the list is a cons cell of a folder and
7631 @code{copy} or @code{move}.
7633 @item wl-x-face-file
7634 @vindex wl-x-face-file
7635 The initial setting is @file{~/.xface}.
7636 The name of the file that contains encoded X-Face strings.
7639 @item wl-demo-display-logo
7640 @vindex wl-demo-display-logo
7641 If non-nil, bitmap image is shown on the opening demo. If you set
7642 @code{xpm} or @code{xbm}, (if possible) display selected image type
7645 @item elmo-use-database
7646 @vindex elmo-use-database
7647 This is meaningful for XEmacs only. The initial setting depends on
7648 XEmacs (@code{t} for XEmacs with dbm).
7649 If non-nil, Message-ID is controlled by dbm.
7651 @item elmo-passwd-alist-file-name
7652 @vindex elmo-passwd-alist-file-name
7653 The initial setting is @file{passwd}.
7654 This is the name of the file in which passwords are saved.
7655 @code{elmo-passwd-alist-save} saves current passwords to the file.
7657 @item elmo-nntp-list-folders-use-cache
7658 @vindex elmo-nntp-list-folders-use-cache
7659 The initial setting is 600 (in seconds).
7660 This is period in seconds during which results of @samp{list} and
7661 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7664 @item elmo-nntp-max-number-precedes-list-active
7665 @vindex elmo-nntp-max-number-precedes-list-active
7666 The initial setting is @code{nil}.
7667 If non-nil, the number of article obtained by @samp{list active} in NNTP
7668 are used as the maximum article number of the folder.
7669 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7670 and if the number of read messages is not correct.
7672 @item elmo-nntp-default-use-listgroup
7673 @vindex elmo-nntp-default-use-listgroup
7674 The initial setting is @code{t}.
7675 If non-nil, @samp{listgroup} is used for checking the total number of
7676 articles. If it is @code{nil}, @samp{group} is used. In the latter
7677 case, the processing will be a little faster at the sacrifice of
7680 @item elmo-pop3-send-command-synchronously
7681 @vindex elmo-pop3-send-command-synchronously
7682 The initial setting is @code{nil}.
7683 If non-nil, POP3 commands are issued synchronously. Some implementation
7684 of POP3 server fails to get summary information without this setting.
7685 You may have to set this variable to @code{t}, if the process hangs
7686 while looking up POP3.
7688 @item elmo-dop-flush-confirm
7689 @vindex elmo-dop-flush-confirm
7690 The initial setting is @code{t}.
7691 If non-nil, you are asked for confirmation if accumulated off-line
7692 operations are executed.
7694 @item elmo-display-progress-threshold
7695 @vindex elmo-display-progress-threshold
7696 The initial setting is 20.
7697 Threshold for display of progress gauge. If number of renewal is more than
7698 this value, display progress gauge.
7702 @node Hooks, , Customizable Variables, Customization
7707 @node Terminology, Mailing List, Customization, Top
7708 @chapter Terminology around Wanderlust
7711 Here we explain terminologies used in this manual.
7715 A container in which messages are stored.
7718 A set consists of some folders.
7721 A special group consists of automatically collected folders under
7722 some specified path.
7723 @xref{Folder Definition}.
7725 @item summary buffer
7726 A buffer for displaying list of messages in some folder.
7728 @item sticky summary
7729 Compared with ordinary summary buffer which will be destroyed after
7730 exiting from it, this type of summary will be remain even after exiting
7731 by @kbd{q} or @kbd{g}.
7732 @xref{Sticky Summary}.
7735 To delete or put into the archive expired messages.
7742 To cache messages beforehand in order to read messages after you will be
7743 disconnected from the server.
7747 @node Mailing List, Addition, Terminology, Top
7748 @chapter Wanderlust Mailing List
7752 Topics related to Wanderlust are discussed in following mailing lists.
7753 The latest version is also announced there.
7756 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7759 In this list Japanese is mainly used for discussion. We also have a list
7760 for discussion in English:
7763 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
7765 (Messages posted to this list are also forwarded to the former one.)
7767 A guide can be obtained automatically by sending mail to
7768 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
7769 the English one) with the body
7775 Please send bug reports or patches to one of those lists. You can post to
7776 the mailing list even though you are not a member of it.
7778 If you send a bug report, please attach Backtrace with it.
7779 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7782 I would like to express my thanks to the members of the mailing list for
7783 valuable advice and many pieces of code they contributed.
7786 @node Addition, Index, Mailing List, Top
7787 @chapter Additional Information
7789 @section Brief History
7792 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7793 3/10 Made a msgdb mechanism by elisp.
7794 3/26 IMAP and NNTP can be displayed in threads.
7795 4/13 Began to assemble thread display modules as elmo.
7796 5/01 Finished 0.1.0, initial version with many defects.
7797 6/12 I made a slip of the tongue and said I was writing elisp
7798 mailer supporting IMAP
7799 6/16 0.1.3 was announced at tm-ja, elisp ML.
7800 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7801 7/01 Support for mm-backend (0.3.0).
7802 8/25 multi folder added (0.5.0).
7803 8/28 filter folder added (0.5.1).
7804 9/10 You can open/close threads (0.6.0).
7805 9/11 fldmgr by Murata-san made editing folders easy.
7806 9/18 lha folders added by Okunishi-san (0.6.3).
7807 9/24 Display of branches of threads (0.6.5).
7808 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7809 10/28 Off-line operations (0.7.4).
7810 12/09 Becomes beta version.
7811 12/21 wl-expire by Murata-san.
7812 1999 2/03 auto-refile by Tsumura-san.
7813 4/28 wl-template by Murata-san.
7814 5/18 Released 1.0.0 stable.
7815 7/05 Scoring by Murata-san (2.1.0).
7816 9/26 New plugged system by Murata-san (2.2.2).
7817 12/20 Support Modified UTF7.
7818 2000 3/24 Released 1.1.0 stable.
7819 4/03 CVS development started.
7820 5/07 Thread restoration & Its speed up with Murata-san.
7821 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7822 7/11 killed message feature.
7823 7/18 Use UIDL in POP3.
7824 9/12 biff feature with Satata-san & Yamaoka-san.
7825 10/17 expire-hide by Okada-san.
7826 11/08 Released 2.4.0 stable.
7827 2001 7/04 Released 2.6.0 stable.
7828 8/21 wl-addrmgr by Kitamoto-san.
7829 12/27 Released 2.8.1 stable.
7832 See @file{ChangeLog} for details.
7836 According to a dictionary, Wanderlust has the meaning:
7840 n eager longing for or impulse towards travelling in distant lands
7841 [Ger, fr wandern to wander + lust desire, pleasure]
7845 but I had no profound intention. (if farfetched, IMAP @result{} you can
7846 read mail anywhere @result{} desire to wander ?)
7848 Elmo is the abbreviation of @samp{Elisp Library for Message
7849 Orchestration}. At first I meant the red puppet in the Sesame Street,
7850 but you may associate it with Wandering @result{} Drifting @result{}
7851 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7855 Each versions has code names (they are almost jokes).
7856 Currently they are picked up alphabetically from the top 40 hits of
7857 U.S. Billboard magazines in 1980s.
7859 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7862 @node Index, , Addition, Top
7866 * Concept Index:: Concept Index
7867 * Key Index:: Key Index
7868 * Variable Index:: Variable Index
7869 * Function Index:: Function Index
7872 @node Concept Index, Key Index, Index, Index
7873 @unnumberedsec Concept Index
7876 @node Key Index, Variable Index, Concept Index, Index
7877 @unnumberedsec Key Index
7880 @node Variable Index, Function Index, Key Index, Index
7881 @unnumberedsec Variable Index
7884 @node Function Index, , Variable Index, Index
7885 @unnumberedsec Function Index