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.4 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.
3300 Threading status is displayed on the modeline.
3301 @samp{@{S@}} means threading is off (Sequence) and
3302 @samp{@{T@}} means threading is on (Thread).
3303 (@code{wl-summary-toggle-thread})
3307 @findex wl-summary-toggle-disp-folder
3308 Toggle displaying of folder window.
3309 (@code{wl-summary-toggle-disp-folder})
3313 Toggle displaying of message window.
3314 @findex wl-summary-toggle-disp-msg
3315 (@code{wl-summary-toggle-disp-msg})
3319 Move to the virtual folder with the condition specified.
3320 If called with prefix argument and current folder is virtual, exit it.
3321 @findex wl-summary-virtual
3322 (@code{wl-summary-virtual})
3325 @kindex @key{TAB} (Summary)
3326 @findex wl-summary-goto-last-displayed-msg
3327 Jump to the message which is displayed last.
3328 (@code{wl-summary-goto-last-displayed-msg})
3332 Put @samp{*} mark on the messages that satisfies the specified condition.
3333 @findex wl-summary-pick
3334 (@code{wl-summary-pick})
3338 @findex wl-summary-mark-as-read
3339 Mark as read the message at the current cursor point.
3340 (@code{wl-summary-mark-as-read})
3344 Prefetch the message at the current cursor point.
3345 With prefix argument, prefetch the message even if it is cached.
3346 @findex wl-summary-prefetch
3347 (@code{wl-summary-prefetch})
3351 Execute @samp{D}, @samp{o} and @samp{O} marks.
3352 @findex wl-summary-exec
3353 (@code{wl-summary-exec})
3357 @findex wl-summary-target-mark-line
3358 Put target mark on the message at the current cursor point.
3359 (@code{wl-summary-target-mark-line})
3363 Put refile mark on the message at the current cursor point.
3364 @findex wl-summary-refile
3365 (@code{wl-summary-refile})
3368 @kindex C-o (Summary)
3369 Execute auto refile.
3370 @findex wl-summary-auto-refile
3371 (@code{wl-summary-auto-refile})
3375 Put copy mark on the message at the current cursor point.
3376 @findex wl-summary-copy
3377 (@code{wl-summary-copy})
3380 @kindex M-o (Summary)
3381 Put refile mark on the message at the current cursor point with the destination
3382 previously specified.
3383 @findex wl-summary-refile-prev-destination
3384 (@code{wl-summary-refile-prev-destination})
3388 @findex wl-summary-delete
3389 Put delete mark on the message at the current cursor point.
3390 (@code{wl-summary-delete})
3394 @findex wl-summary-unmark
3395 Unmark the temporal mark on the message at the current cursor point.
3396 (@code{wl-summary-unmark})
3400 Unmark all the temporal marks.
3401 @findex wl-summary-unmark-all
3402 (@code{wl-summary-unmark-all})
3405 @kindex r R (Summary)
3406 @findex wl-summary-mark-as-read-region
3407 Mark as read messages in the specified region.
3408 (@code{wl-summary-mark-as-read-region})
3411 @kindex r $ (Summary)
3412 @findex wl-summary-mark-as-important-region
3413 Mark as important @samp{$} messages in the specified region.
3414 If @samp{$} already exists, it is deleted.
3415 (@code{wl-summary-mark-as-important-region})
3418 @kindex r ! (Summary)
3419 @findex wl-summary-mark-as-unread-region
3420 Mark as unread messages in the specified region.
3421 (@code{wl-summary-mark-as-unread-region})
3424 @kindex r i (Summary)
3425 @findex wl-summary-prefetch-region
3426 Prefetch messages in the specified region.
3427 (@code{wl-summary-prefetch-region})
3430 @kindex r x (Summary)
3431 @findex wl-summary-exec-region
3432 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3434 (@code{wl-summary-exec-region})
3437 @kindex r * (Summary)
3438 @findex wl-summary-target-mark-region
3439 Put target mark on the messages in the specified region.
3440 (@code{wl-summary-target-mark-region})
3443 @kindex r o (Summary)
3444 @findex wl-summary-refile-region
3445 Put refile mark on the messages in the specified region.
3446 (@code{wl-summary-refile-region})
3449 @kindex r O (Summary)
3450 @findex wl-summary-copy-region
3451 Put copy mark on the messages in the specified region.
3452 (@code{wl-summary-copy-region})
3455 @kindex r d (Summary)
3456 @findex wl-summary-delete-region
3457 Put delete mark on the messages in the specified region.
3458 (@code{wl-summary-delete-region})
3461 @kindex r u (Summary)
3462 @findex wl-summary-unmark-region
3463 Delete temporal mark on the messages in the specified region.
3464 (@code{wl-summary-unmark-region})
3467 @kindex r y (Summary)
3468 Save messages in the specified region.
3469 @findex wl-summary-save-region
3470 (@code{wl-summary-save-region})
3473 @kindex t R (Summary)
3474 @findex wl-thread-mark-as-read
3475 Mark as read messages which are the descendant of the current thread.
3476 With prefix argument, it affects on the all messages in the thread tree.
3477 (@code{wl-thread-mark-as-read})
3480 @kindex t $ (Summary)
3481 @findex wl-thread-mark-as-important
3482 Put important mark @samp{$} on the messages which are the
3483 descendant of the current thread.
3484 If @samp{$} mark exists, it is deleted.
3485 With prefix argument, it affects on the all messages in the thread tree.
3486 (@code{wl-thread-mark-as-important})
3489 @kindex t ! (Summary)
3490 @findex wl-thread-mark-as-unread
3491 Mark as unread messages which are the descendant of the current thread.
3492 With prefix argument, it affects on the all messages in the thread tree.
3493 (@code{wl-thread-mark-as-unread})
3496 @kindex t i (Summary)
3497 @findex wl-thread-prefetch
3498 Prefetch messages which are the descendant of the current thread.
3499 With prefix argument, it affects on the all messages in the thread tree.
3500 (@code{wl-thread-prefetch})
3503 @kindex t x (Summary)
3504 @findex wl-thread-exec
3505 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3506 the descendant of the current thread. With prefix argument, it affects
3507 on the all messages in the thread tree.
3508 (@code{wl-thread-exec})
3511 @kindex t * (Summary)
3512 @findex wl-thread-target-mark
3513 Put target mark @samp{*} on the messages which are the descendant of the
3514 current thread. With prefix argument, it affects on the all messages in
3516 (@code{wl-thread-target-mark})
3519 @kindex t o (Summary)
3520 @findex wl-thread-refile
3521 Put refile mark on the messages which are the descendant of the current thread.
3522 With prefix argument, it affects on the all messages in the thread tree.
3523 (@code{wl-thread-refile})
3526 @kindex t O (Summary)
3527 @findex wl-thread-copy
3528 Put copy mark on the messages which are the descendant of the current thread.
3529 With prefix argument, it affects on the all messages in the thread tree.
3530 (@code{wl-thread-copy})
3533 @kindex t d (Summary)
3534 @findex wl-thread-delete
3535 Put delete mar on the messages which are the descendant of the current thread.
3536 With prefix argument, it affects on the all messages in the thread tree.
3537 (@code{wl-thread-delete})
3540 @kindex t u (Summary)
3541 @findex wl-thread-unmark
3542 Unmark temporal mark on the messages which are the descendant of the
3543 current thread. With prefix argument, it affects on the all messages in
3545 (@code{wl-thread-unmark})
3548 @kindex t y (Summary)
3549 @findex wl-thread-save
3550 Save messages which are the descendant of the current thread.
3551 With prefix argument, it affects on the all messages in the thread tree.
3552 (@code{wl-thread-save})
3555 @kindex m i (Summary)
3556 @findex wl-summary-target-mark-prefetch
3557 Prefetch all messages which have target mark @samp{*}.
3558 With prefix argument, prefetch all targets even if some of them are cached.
3559 (@code{wl-summary-target-mark-prefetch})
3562 @kindex m R (Summary)
3563 @findex wl-summary-target-mark-mark-as-read
3564 Mark as read all messages which have target mark @samp{*}.
3565 (@code{wl-summary-target-mark-mark-as-read})
3568 @kindex m $ (Summary)
3569 @findex wl-summary-target-mark-mark-as-important
3570 Mark as important all messages which have target mark @samp{*}.
3571 If already marked as @samp{$}, it is deleted.
3572 (@code{wl-summary-target-mark-mark-as-important})
3575 @kindex m ! (Summary)
3576 @findex wl-summary-target-mark-mark-as-unread
3577 Mark as unread all messages which have target mark @samp{*}.
3578 (@code{wl-summary-target-mark-mark-as-unread})
3581 @kindex m o (Summary)
3582 @findex wl-summary-target-mark-refile
3583 Put refile mark on the messages which have target mark @samp{*}.
3584 (@code{wl-summary-target-mark-refile})
3587 @kindex m O (Summary)
3588 @findex wl-summary-target-mark-copy
3589 Put copy mark on the messages which have target mark @samp{*}.
3590 (@code{wl-summary-target-mark-copy})
3593 @kindex m d (Summary)
3594 @findex wl-summary-target-mark-delete
3595 Put delete mark on the messages which have target mark @samp{*}.
3596 (@code{wl-summary-target-mark-delete})
3599 @kindex m y (Summary)
3600 @findex wl-summary-target-mark-save
3601 Save messages which have target mark @samp{*}.
3602 (@code{wl-summary-target-mark-save})
3605 @kindex m u (Summary)
3606 Unmark all temporal marks.
3607 (@code{wl-summary-delete-all-temp-marks})
3608 @findex wl-summary-delete-all-temp-marks
3611 @kindex m a (Summary)
3612 Put target mark @samp{*} on the all messages.
3613 (@code{wl-summary-target-mark-all})
3614 @findex wl-summary-target-mark-all
3617 @kindex m t (Summary)
3618 Put target mark @samp{*} on the messages in the current thread.
3619 @findex wl-summary-target-mark-thread
3620 (@code{wl-summary-target-mark-thread})
3623 @kindex m r (Summary)
3624 @findex wl-summary-target-mark-region
3625 Put target mark @samp{*} on the messages in the specified region.
3626 (@code{wl-summary-target-mark-region})
3629 @kindex m A (Summary)
3630 @findex wl-summary-target-mark-reply-with-citation
3631 Prepare a draft which cites all messages which have target mark @samp{*}.
3632 (@code{wl-summary-target-mark-reply-with-citation})
3635 @kindex m f (Summary)
3636 @findex wl-summary-target-mark-forward
3637 Prepare a draft which forwards all messages which have target mark @samp{*}.
3638 (@code{wl-summary-target-mark-forward})
3641 @kindex m U (Summary)
3642 @findex wl-summary-target-mark-uudecode
3643 Uudecode the messages which have target mark @samp{*}.
3644 (@code{wl-summary-target-mark-uudecode})
3647 @kindex m ? (Summary)
3648 @findex wl-summary-target-mark-pick
3649 Pick messages from the @samp{*} marked messages.
3650 That is, @samp{*} marks on the messages are remained
3651 if the specified condition is satisfied.
3652 (@code{wl-summary-target-mark-pick})
3655 @kindex m # (Summary)
3656 @findex wl-summary-target-mark-print
3657 Print out all messages which have target mark @samp{*}.
3658 (@code{wl-summary-target-mark-print})
3661 @kindex m | (Summary)
3662 @findex wl-summary-target-mark-pipe
3663 Pipe content of each message with target mark @samp{*} to some specified
3665 (@code{wl-summary-target-mark-pipe})
3669 @findex wl-summary-erase
3670 Actually erase the message at once, without moving it to trash.
3671 (@code{wl-summary-erase})
3674 @kindex M-t (Summary)
3675 @findex wl-toggle-plugged
3676 Toggle offline/online status of Wanderlust.
3677 (@code{wl-toggle-plugged})
3680 @kindex C-t (Summary)
3681 Start Wanderlust's plug-status manager.
3682 (@code{wl-plugged-change})
3685 @kindex C-c C-o (Summary)
3686 @findex wl-jump-to-draft-buffer
3687 Move to the draft buffer if available. If multiple draft buffer exists,
3688 moved to one after another. If prefix argument is specified, load draft
3689 folder's message to the draft buffer and jump to it.
3690 (@code{wl-jump-to-draft-buffer})
3693 @kindex M-w (Summary)
3694 @findex wl-summary-save-current-message
3695 Save the message at the current cursor point.
3696 (@code{wl-summary-save-current-message})
3699 @kindex C-y (Summary)
3700 @findex wl-summary-yank-saved-message
3701 Regard the message at the current cursor point as
3702 parent, connect the message saved by
3703 @code{wl-summary-save-current-message}
3705 (@code{wl-summary-yank-saved-message})
3708 @kindex C-x C-s (Summary)
3709 @findex wl-summary-save-status
3710 Save the current summary.
3711 (@code{wl-summary-save-status})
3715 @node Variables of Summary, , Key Bindings of Summary, Summary
3716 @section Customiziable variables
3719 @item wl-summary-move-order
3720 @vindex wl-summary-move-order
3721 The initial setting is @code{unread}. Specify cursor moving policy. If
3722 you want to precede new messages, set @code{new}. If you want to
3723 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3726 @item wl-auto-select-first
3727 @vindex wl-auto-select-first
3728 The initial setting is @code{nil}.
3729 If non-nil, first message is automatically displayed when you enter
3732 @item wl-auto-select-next
3733 @vindex wl-auto-select-next
3734 The initial setting is @code{nil}. This controls behavior when there is
3735 no unread message in current summary.
3738 nil: asks whether you want to go back to folder mode
3739 'unread: asks whether you want to go to next unread folder
3740 If the next one comes to be possessing no unread message
3741 by treatment of cross-posted messages or Scoring, then
3742 asks whether you want to go to next to next folder.
3743 'skip-no-unread: similar as unread
3744 But does not ask before going to next to next folder.
3745 otherwise: asks whether you want to go to next unread folder
3748 It might be useful to set @code{'skip-no-unread} for people who
3749 want to continue reading by just pressing and pressing space key.
3751 @item wl-thread-insert-opened
3752 @vindex wl-thread-insert-opened
3753 The initial setting is @code{nil}.
3754 If non-nil, thread is inserted as opened.
3756 @item wl-thread-open-reading-thread
3757 @vindex wl-thread-open-reading-thread
3758 The initial setting is @code{t}. If non-nil, reading thread is
3759 automatically opened though it is closed thread.
3761 @item wl-summary-exit-next-move
3762 @vindex wl-summary-exit-next-move
3763 The initial setting is @code{t}. If non-nil, move to next folder at
3766 @item wl-folder-move-cur-folder
3767 @vindex wl-folder-move-cur-folder
3768 The initial setting is @code{nil}. If non-nil, cursor position on the
3771 @item wl-summary-weekday-name-lang
3772 @vindex wl-summary-weekday-name-lang
3773 The initial setting is @samp{ja}. Specify language of the weekday.
3774 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3775 displays Deutsch. You should rescan summary view after changing this value.
3777 @item wl-summary-fix-timezone
3778 @vindex wl-summary-fix-timezone
3779 The initial setting is @code{nil}.
3780 Time zone of the date string in summary mode is adjusted using this value.
3781 If @code{nil}, it is adjust to the default time zone information
3782 (system's default time zone or environment variable @samp{TZ}).
3784 @item wl-use-petname
3785 @vindex wl-use-petname
3786 The initial setting is @code{t}.
3787 If non-nil, sender part displays nickname.
3789 @item wl-break-pages
3790 @vindex wl-break-pages
3791 The initial setting is @code{t}.
3792 If non-nil, message is split as pages by @samp{^L}.
3794 @item wl-message-window-size
3795 @vindex wl-message-window-size
3796 The initial setting is '(1 . 4).
3797 A cons cell to specify the rate of summary and message window.
3798 car:cdr corresponds summary:message.
3800 @item wl-summary-no-from-message
3801 @vindex wl-summary-no-from-message
3802 The initial setting is @samp{nobody@@nowhere?}. A string which is
3803 displayed when there's no @samp{From:} field in the message.
3805 @item wl-summary-no-subject-message
3806 @vindex wl-summary-no-subject-message
3807 The initial setting is @samp{(WL:No Subject in original.)}. A string
3808 which is displayed when there's no @samp{Subject:} field in the message.
3810 @item wl-summary-use-frame
3811 @vindex wl-summary-use-frame
3812 The initial setting is @code{nil}.
3813 If non-nil, use new frame for the summary.
3815 @item wl-use-folder-petname
3816 @vindex wl-use-folder-petname
3817 The initial setting is the list shown below:
3826 A list of display policy (symbol) of folder nickname. Available symbols
3831 Display folder petname on modeline.
3833 Destination folder is notified as nickname if
3834 @code{wl-auto-select-next} is non-nil.
3836 You can input folder name by nickname in the function
3837 @code{wl-summary-read-folder}.
3840 @item wl-summary-move-direction-toggle
3841 @vindex wl-summary-move-direction-toggle
3842 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3843 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3844 want to aware of reading direction, set this to @code{t}.
3846 @item wl-summary-width
3847 @vindex wl-summary-width
3848 The initial setting is 80.
3849 Width of summary line. If @code{nil}, summary line's width is as is.
3851 @item wl-summary-from-width
3852 @vindex wl-summary-from-width
3853 The initial setting is 17.
3854 Width of sender part of summary line.
3856 @item wl-summary-indent-length-limit
3857 @vindex wl-summary-indent-length-limit
3858 The initial setting is 46.
3859 Specify the limit of thread indent level. @code{nil} means unlimited
3861 If you set this to @code{nil} you should set @code{wl-summary-width}
3864 @item wl-summary-max-thread-depth
3865 @vindex wl-summary-max-thread-depth
3866 The initial setting is 15.
3867 If thread depth of the message is larger than this value,
3868 the thread is divided.
3870 @item wl-summary-recenter
3871 @vindex wl-summary-recenter
3872 The initial setting is t.
3873 If non-nil, cursor point is moved to the center of the summary window.
3875 @item wl-summary-divide-thread-when-subject-changed
3876 @vindex wl-summary-divide-thread-when-subject-changed
3877 The initial setting is @code{nil}. If non-nil, thread is split if
3878 the subject is changed.
3880 @item wl-summary-search-via-nntp
3881 @vindex wl-summary-search-via-nntp
3882 The initial setting is @code{confirm}.
3884 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3885 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3886 from the NNTP server @code{elmo-nntp-default-server}. The value of
3887 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3888 @code{elmo-nntp-default-stream-type} are used.
3890 If @code{confirm}, server name can be specified. You can specify NNTP
3891 folder format like @samp{-:username@@servername:119!}.
3893 @item wl-summary-keep-cursor-command
3894 @vindex wl-summary-keep-cursor-command
3895 The initial setting is the list shown below:
3899 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3904 When you entered to summary by these commands and the target summary
3905 buffer already exists, summary status is not automatically updated and
3906 cursor position is saved.
3908 @item elmo-folder-update-threshold
3909 @vindex elmo-folder-update-threshold
3910 The initial setting is 500. If updated message number is larger than
3911 this value, confirm whether drop them or not (in the case where the value
3912 of @code{elmo-folder-update-confirm} is non-nil).
3914 @item elmo-folder-update-confirm
3915 @vindex elmo-folder-update-confirm
3916 The initial setting is @code{t}. If the value is non-nil, do check with
3917 @code{elmo-folder-update-threshold}.
3919 @item wl-summary-always-sticky-folder-list
3920 @vindex wl-summary-always-sticky-folder-list
3921 The initial setting is @code{nil}.
3922 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3923 are automatically stuck. Each element is regexp of folder name.
3925 @item wl-summary-reserve-mark-list
3926 @vindex wl-summary-reserve-mark-list
3927 The initial setting is the list shown below:
3936 If a message is already marked as temporal marks in this list, the
3937 message is not marked by any mark command.
3939 @item wl-summary-skip-mark-list
3940 @vindex wl-summary-skip-mark-list
3941 The initial setting is the list shown below:
3950 If a message is already marked as temporal marks in this list, the
3951 message is skipped at cursor move.
3953 @item elmo-message-fetch-threshold
3954 @vindex elmo-message-fetch-threshold
3955 The initial setting is 30000 (bytes). If displaying message has larger
3956 size than this value, Wanderlust confirms whether fetch the message or
3957 not (in the case where the value of @code{elmo-message-fetch-confirm}
3960 @item elmo-message-fetch-confirm
3961 @vindex elmo-message-fetch-confirm
3962 The initial setting is @code{t}. If the value is non-nil, do check with
3963 @code{elmo-message-fetch-threshold}.
3965 @item wl-prefetch-threshold
3966 @vindex wl-prefetch-threshold
3967 The initial setting is 30000 (bytes). If prefetching message has larger
3968 size than this value and @code{wl-prefetch-confirm} is non-nil,
3969 Wanderlust confirms whether prefetch the message or not. If
3970 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3971 without confirmation.
3973 @item wl-prefetch-confirm
3974 @vindex wl-prefetch-confirm
3975 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3976 prefetch the message or not if the message has larger size than
3977 @code{wl-prefetch-threshold}.
3979 @item elmo-imap4-use-cache
3980 @vindex elmo-imap4-use-cache
3981 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3984 @item elmo-nntp-use-cache
3985 @vindex elmo-nntp-use-cache
3986 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3989 @item elmo-pop3-use-cache
3990 @vindex elmo-pop3-use-cache
3991 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3994 @item elmo-shimbun-use-cache
3995 @vindex elmo-shimbun-use-cache
3996 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3999 @item wl-folder-process-duplicates-alist
4000 @vindex wl-folder-process-duplicates-alist
4001 The initial setting is @code{nil}.
4002 This list determines how to deal with duplicated messages in the same folder.
4003 Each item in the list is regexp of folder name and action; you can specify any
4004 one of the following in the place of action:
4007 @code{nil} : do nothing for duplicated messages.
4008 @code{hide} : hide duplicated messages from the summary.
4009 @code{read} : set duplicated messages as read.
4013 Following is an example (hide duplicated messages in multi folders)
4017 (setq wl-folder-process-duplicates-alist
4018 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4019 ("^\\*.*" . hide) (".*" . read)))
4025 @node Message, Draft, Summary, Top
4026 @chapter Message Buffer
4028 Message Buffers utilize MIME-View mode of SEMI. For operational
4029 procedures and key bindings, refer to respective documents.
4030 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4031 You can also see help by @kbd{?} in message buffer.
4033 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4034 brings you back to Summary mode. @kbd{l} toggles display of Summary
4037 @section Key Bindings
4043 @findex wl-message-toggle-disp-summary
4044 Toggles display of Summary buffer.
4045 (@code{wl-message-toggle-disp-summary})
4048 @findex wl-message-refer-article-or-url
4049 @kindex Button-2 (Message)
4050 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4051 corresponding message if found.
4052 (@code{wl-message-refer-article-or-url})
4054 @item Button-4 (upward movement of a wheel)
4055 @kindex Button-4 (Message)
4056 @findex wl-message-wheel-down
4057 Scrolls the message backwards. When the top of the message is hit,
4058 moves to the previous message.
4059 (@code{wl-message-wheel-down})
4061 @item Button-5 (downward movement of a wheel)
4062 @kindex Button-5 (Message)
4063 @findex wl-message-wheel-up
4064 Scrolls the message forward. When the bottom of the message is hit,
4065 moves to the next message.
4066 (@code{wl-message-wheel-up})
4070 @findex wl-message-delete-current-part
4071 Delete the part under cursor. In fact it appends modified message to
4072 the current folder then moves old one to trash folder. Therefore the
4073 message number will be changed.
4074 (@code{wl-message-delete-current-part})
4077 @section Customizable Variables
4080 @item wl-message-window-size
4081 @vindex wl-message-window-size
4082 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4083 its car and cdr value corresponds to the ratio of Summary and Message
4086 @item wl-message-ignored-field-list
4087 @vindex wl-message-ignored-field-list
4088 (SEMI only) Initial setting is @code{nil}.
4089 All fields that match this list will be hidden in message buffer.
4090 Each elements are regexp of field-name.
4091 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4093 @item wl-message-visible-field-list
4094 @vindex wl-message-visible-field-list
4095 (SEMI only) Initial setting is @code{nil}.
4096 All fields that match this list will be display in message buffer.
4097 Each elements are regexp of field-name. This value precedes
4098 @code{wl-message-ignored-field-list}.
4099 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4101 @item wl-message-sort-field-list
4102 @vindex wl-message-sort-field-list
4103 (SEMI only) Initial setting is
4104 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4105 Header fields in message buffer are ordered by this value.
4106 Each elements are regexp of field-name.
4108 @item wl-message-truncate-lines
4109 @vindex wl-message-truncate-lines
4110 The initial value is the value of @code{default-truncate-lines}.
4111 If it is non-nil, truncate long lines in message buffer.
4114 @node Draft, Disconnected Operations, Message, Top
4115 @chapter Draft Buffer
4117 At Summary mode, pressing @kbd{w} and the like creates a new draft
4118 buffer. You can edit and send mail and news articles in this buffer.
4120 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4121 with those if possible.
4124 * Usage of Draft Mode:: TIPS
4125 * Key Bindings of Draft:: Key bindings
4126 * Variables of Draft Mode:: Customize Draft Mode
4129 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4132 Basically it is Emacs-standard mail mode.
4136 * Editing Message Body::
4137 * Dynamical Message Re-arrangement::
4142 @node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
4143 @subsection Editing Message Header
4145 You can freely edit header region above @samp{--text follows this line--},
4146 until you invoke the sending operation.
4148 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4149 addresses. @kbd{@key{TAB}} completes them.
4151 You can use following headers to specify recipients. Add some of them
4152 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4155 @item @samp{Newsgroups:}
4156 Specify newsgroups to which you post the news article.
4159 Specify addresses to send a copy (Carbon Copy) of the message.
4162 Following ones are removed from the header contents before sending.
4166 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4169 Specify folders in which a copy of the message is saved.
4172 Specify recipients to send encapsulated copy of the message.
4175 You can add initial headers by following variables.
4181 The initial setting is @code{nil}.
4182 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4183 the draft when it is prepared. If function is specified, its return
4188 The initial setting is @code{nil}.
4189 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4190 the draft when it is prepared.
4193 @node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4194 @subsection Editing Messages
4196 As a matter of course, editing message body can be performed in the same
4197 way as usual writing. You may write message body under
4198 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4199 @samp{--text follows this line--} intact.)
4201 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4202 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4203 a MIME user interface for GNU Emacs}.
4204 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4206 If you save the draft buffer you are editing, it is appended to the
4207 folder specified by @code{wl-draft-folder}.
4209 @node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
4210 @subsection Dynamic Modification of Messages
4211 @vindex wl-draft-config-alist
4212 @c @cindex Change Message
4213 @c @cindex Message, Change Dynamic
4215 You can set @code{wl-draft-config-alist} so that header and body of the
4216 message will automatically modified depending on information of header
4219 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4221 In the example below, the header is modified when
4222 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4223 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4224 before sending the message.
4228 (setq wl-draft-config-alist
4229 '(((string-match "aaa\\.example\\.com$" (system-name))
4230 ;; @r{applied if the expression is non-nil}
4231 (wl-smtp-posting-server . "mailserver-B")
4232 (wl-nntp-posting-server . "newsserver-B")
4233 ;; @r{settings of temporary variables}
4235 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4236 ;; @r{applied if it matches the header of the draft buffer}
4237 ("Organization" . (format "Go %s" my-webpage)))
4238 ;; @r{you can write elisp expressions here (eval only)}
4239 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4240 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4245 The format of @code{wl-draft-config-alist} is:
4249 '(("@var{regexp of the header}" or @var{elisp expression}
4250 ("@var{Field}" . value(@var{elisp expression}))
4251 (@var{variable} . value(@var{elisp expression}))
4252 (@var{sub-function} . value(@var{elisp expression}))
4255 ("@var{regexp of the header}" or @var{elisp expression}
4256 ("@var{Field}" . value(@var{elisp expression}))
4261 Per default, there are 10 following sub-functions.
4264 'header: Inserts the specified string at the bottom of the header.
4265 'header-top: Inserts the specified string at the top of the header.
4266 'header-file: Inserts the specified file at the bottom of the header.
4267 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4268 'top: Inserts the specified string at the top of the body.
4269 'top-file: Inserts the specified file at the top of the body.
4270 'body: Replaces the body with the specified string.
4271 Specifying @code{nil} deletes the entire body string.
4272 'body-file: Replaces the body with the content of the specified file.
4273 'bottom: Inserts the specified string at the bottom of the body.
4274 'bottom-file: Inserts the specified file at the top of the body.
4275 'part-top: Inserts the specified string at the top of the current part.
4276 'part-bottom: Inserts the specified string at the bottom of the current part.
4277 'template: Applies the specified template.
4278 (refer to the next subsection)
4281 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4282 change them or add your own functions. If you read the code, you can
4283 easily find how to write the functions.
4285 At the first of each item, @var{a regular expression of the header} or
4286 an @var{elisp expression} should be specified. In the case of an elisp
4287 expression, the item is applied when the expression is evaluated
4290 Per default, when multiple items match or are evaluated non-nil, all
4291 such items are applied, but if you set a variable
4292 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4295 At the second of the item, a cons or a list of functions should be
4296 specified. The car part of the cons should be a header field, a
4297 variable, or a sub-function. When a header field is specified, the
4298 field will be modified. If a variable is specified, the value of the
4299 variable will be modified temporarily.
4301 In the cdr part of a cons, not only a variable but also an elisp
4302 expression can be specified as is. If the car part is a header field
4303 and the cdr part is @code{nil}, the field will be deleted.
4305 See the next example as well:
4309 (setq wl-draft-config-alist
4311 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4312 ;; @r{applied if it matches the header of the buffer being replied}
4313 (body . " Hello.\n")
4314 (template . "default")
4319 As in the (1) above, if a header regexp is prepended with @code{reply},
4320 it is applied when the draft is prepared by @code{wl-summary-reply} for
4321 example, and when it matches the header being replied. It is ignored
4322 when there is no buffer being replied, like after @code{wl-draft} was
4325 If you want to use name of parent folder, you can refer the buffer local
4326 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4327 changes From according to the folder name of the summary in which the draft
4332 (setq wl-draft-config-alist
4333 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4334 (\"From\" . \"user@@domain1\"))
4335 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4336 (\"From\" . \"user@@domain2\"))))
4341 Note that @code{wl-draft-config-alist} is applied only once when
4342 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4343 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4344 aborting transmission, execute @kbd{C-c C-e}
4345 (@code{wl-draft-config-exec}) explicitly.
4347 If you don't want to apply @code{wl-draft-config-alist} when
4348 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4352 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4355 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4356 prepared, do the following:
4359 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4362 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4363 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4367 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4370 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4371 @subsection Inserting Templates
4373 @cindex Apply Template
4375 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4376 @kbd{M-x wl-template-select} in the draft buffer.
4378 The format of @code{wl-template-alist} is almost the same as
4379 @code{wl-draft-config-alist}.
4383 (setq wl-template-alist
4386 ("Organization" . "Example Co.Ltd.")
4387 (body . "Hello.\n"))
4389 (template . "default") ;; @r{(a)}
4390 ("To" . "boss@@example.com")
4391 ("Subject" . "Report")
4392 (body-file . "~/work/report.txt")
4398 As you can see, the only difference is item (template) names such as
4399 @samp{default} and @samp{report}, instead of a regexp of header.
4400 Because definition of each item is the same as
4401 @code{wl-draft-config-alist}, you can call another template, like (a).
4403 Executing the command @code{wl-template-select} results in template
4404 selection, but the result differs depending on variable
4405 @code{wl-template-visible-select}.
4407 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4408 window is shown below the draft buffer. You can select a template by
4409 @kbd{n} and @kbd{p} seeing the buffer window.
4411 Press the @key{RET} key and the template is actually applied to the draft
4412 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4413 adjust the window size by @code{wl-template-buffer-lines}.
4415 If @code{wl-template-visible-select} is @code{nil}, you should type the
4416 name of the template in the mini buffer.
4418 As shown in the example in @code{wl-draft-config-alist}, you can select
4419 @samp{default} template by writing:
4422 (template . "default")
4425 @node POP-before-SMTP, , Template, Usage of Draft Mode
4426 @subsection Sending mail by POP-before-SMTP
4427 @cindex POP-before-SMTP
4429 You can send mail by POP-before-SMTP with this single line:
4432 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4436 Configure the following variables if you need.
4439 @item wl-pop-before-smtp-user
4440 The POP user name for POP-before-SMTP authentication.
4441 If unset, @code{elmo-pop3-default-user} is used.
4443 @item wl-pop-before-smtp-server
4444 The POP server name for POP-before-SMTP authentication.
4445 If unset, @code{elmo-pop3-default-server} is used.
4447 @item wl-pop-before-smtp-authenticate-type
4448 The POP authentication method for POP-before-SMTP authentication.
4449 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4451 @item wl-pop-before-smtp-port
4452 The POP port number for POP-before-SMTP authentication.
4453 If unset, @code{elmo-pop3-default-port} is used.
4455 @item wl-pop-before-smtp-stream-type
4456 If non-nil, POP connection is established using SSL. If
4457 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4458 unset, @code{elmo-pop3-default-stream-type} is used.
4461 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4462 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4464 Therefore, if SMTP server and POP server are actually the same, and if
4465 POP folder per default (such as @samp{&}) is available, no settings are
4468 Refer to the following URL about POP-before-SMTP.
4472 http://spam.ayamura.org/tools/smPbS.html
4473 http://www.iecc.com/pop-before-smtp.html
4478 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4479 @section Key Bindings
4480 @cindex Keybind, Draft Mode
4481 @cindex Keybind, Draft Buffer
4486 @kindex C-c C-y (Draft)
4487 @findex wl-draft-yank-original
4488 Cites the content of the current message buffer (the part under cursor).
4489 If the region is active, cites the region (it affects only if
4490 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4491 (on XEmacs) is Non-nil).
4492 (@code{wl-draft-yank-original})
4495 @kindex C-c C-p (Draft)
4496 @findex wl-draft-preview-message
4497 Previews the content of the current draft.
4498 This is useful for previewing MIME multi-part messages.
4499 (@code{wl-draft-preview-message})
4502 @kindex C-c C-s (Draft)
4503 @findex wl-draft-send
4504 Sends the content of the current draft. Does not erase the draft buffer.
4505 This is useful for sending multiple messages, which are a little different
4507 (@code{wl-draft-send})
4510 @kindex C-c C-c (Draft)
4511 @findex wl-draft-send-and-exit
4512 Sends the content of the current draft and erases the draft buffer.
4513 (@code{wl-draft-send-and-exit})
4516 @kindex C-x C-s (Draft)
4517 @findex wl-draft-save
4518 Save the current draft.
4519 (@code{wl-draft-save})
4522 @kindex C-c C-k (Draft)
4523 @findex wl-draft-kill
4524 Kills the current draft.
4525 (@code{wl-draft-kill})
4528 @kindex C-x k (Draft)
4529 @findex wl-draft-mimic-kill-buffer
4530 Kills the current draft.
4531 (@code{wl-draft-mimic-kill-buffer})
4534 @kindex C-c C-z (Draft)
4535 @findex wl-draft-save-and-exit
4536 Saves the current draft, and erases the draft buffer.
4537 This is useful if you want to suspend editing of the draft.
4538 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4539 the @samp{+draft} folder.
4540 (@code{wl-draft-save-and-exit})
4543 @kindex C-c C-r (Draft)
4544 @findex wl-caesar-region
4545 Encodes or decodes the specified region in Caesar cipher.
4546 (@code{wl-caesar-region})
4550 @findex wl-draft-highlight-and-recenter
4551 Recenter and rehighlight current draft.
4552 (@code{wl-draft-highlight-and-recenter})
4556 @findex wl-toggle-plugged
4557 Toggles off-line/on-line states of Wanderlust.
4558 (@code{wl-toggle-plugged})
4561 @kindex C-c C-o (Draft)
4562 @findex wl-jump-to-draft-buffer
4563 Jumps to the other draft buffer, if exists.
4564 With prefix argument, reads a file (if any) from the draft folder when
4565 there is no such buffer.
4566 (@code{wl-jump-to-draft-buffer})
4569 @kindex C-c C-e (Draft)
4570 @findex wl-draft-config-exec
4571 Applies @code{wl-draft-config-alist}.
4572 (@code{wl-draft-config-exec})
4575 @kindex C-c C-j (Draft)
4576 @findex wl-template-select
4578 (@code{wl-template-select})
4581 @kindex C-c C-a (Draft)
4583 Enter Address Manager.
4584 @xref{Address Manager}.
4588 @kindex C-c C-d (Draft)
4589 @findex wl-draft-elide-region
4590 Elide the text between point and mark (@code{wl-draft-elide-region}).
4591 The text is killed and replaced with the contents of the variable
4592 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4596 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4597 @section Customizable Variables
4600 @item wl-subscribed-mailing-list
4601 @vindex wl-subscribed-mailing-list
4602 The initial setting is @code{nil}. Mailing lists to which you
4603 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4604 field of a reply draft, removes your own address from
4605 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4606 contained in @samp{To:} or @samp{Cc:} field of a message to be
4607 automatically re-filed, the destination folder will be leaned in
4608 connection with the address.
4614 (setq wl-subscribed-mailing-list
4615 '("wl@@lists.airs.net"
4617 "emacs-mime-ja@@m17n.org"))
4621 @item wl-insert-mail-followup-to
4622 @vindex wl-insert-mail-followup-to
4623 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4624 field is automatically inserted in the draft buffer.
4626 @item wl-insert-mail-reply-to
4627 @vindex wl-insert-mail-reply-to
4628 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4629 field is automatically inserted in the draft buffer.
4631 @item wl-auto-insert-x-face
4632 @vindex wl-auto-insert-x-face
4633 The initial setting is @code{t}. If non-nil and there is an encoded
4634 X-Face string in a file @file{~/.xface} (the value of the variable
4635 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4636 draft buffer. If @code{nil}, it is not automatically inserted.
4638 @item wl-insert-message-id
4639 @vindex wl-insert-message-id
4640 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4641 is automatically inserted on the transmission.
4643 @item wl-message-id-use-wl-from
4644 @vindex wl-message-id-use-wl-from
4645 The initial setting is @code{nil}. If non-nil, the value of
4646 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4648 @item wl-local-domain
4649 @vindex wl-local-domain
4650 The initial setting is @code{nil}. If @code{nil}, the return value of
4651 the function @code{system-name} will be used as the domain part of
4654 If @code{system-name} does not return FQDN (i.e. the full name of the
4655 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4656 to the string of the local domain name without hostname (like
4657 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4658 @samp{.} @code{wl-local-domain} is used as domain part of the
4661 If your terminal does not have global IP, set the value of
4662 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4663 you use invalid @samp{Message-ID:}.)
4665 Moreover, concatenation of @code{system-name} @samp{.}
4666 @code{wl-local-domain} will be used as an argument to the HELO command
4669 @item wl-message-id-domain
4670 @vindex wl-message-id-domain
4671 The initial setting is @code{nil}. If non-nil, this value is used as a
4672 domain part of the @samp{Message-ID:}. If your terminal does not have
4673 global IP address, set unique string to this value (e.x. your e-mail
4676 @item wl-unique-id-suffix
4677 @vindex wl-unique-id-suffix
4678 The initial setting is @samp{.wl}. You can specify the string in generated
4679 Message-ID which appear just before @samp{@@}.
4681 @item wl-draft-config-alist
4682 @vindex wl-draft-config-alist
4683 The initial setting is @code{nil}. Modifies the draft message just
4684 before the transmission. The content of @code{wl-draft-config-alist}
4685 will be automatically applied only once on the transmission. If you
4686 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4689 @item wl-template-alist
4690 @vindex wl-template-alist
4691 The initial setting is @code{nil}.
4692 This variable specifies the template to be applied in the draft buffer.
4694 @item wl-draft-config-matchone
4695 @vindex wl-draft-config-matchone
4696 The initial setting is @code{nil}. If non-nil, only the first matching
4697 item is used when @code{wl-draft-config-alist} is applied. If
4698 @code{nil}, all matching items are used.
4700 @item wl-template-visible-select
4701 @vindex wl-template-visible-select
4702 The initial setting is @code{t}.
4703 If non-nil, you can preview the result of the template selection in
4706 @item wl-template-confirm
4707 @vindex wl-template-confirm
4708 The initial setting is @code{nil}.
4709 If non-nil, asks for confirmation when you press the enter key to select
4710 template while previewing.
4712 @item wl-template-buffer-lines
4713 @vindex wl-template-buffer-lines
4714 The initial setting is 7.
4715 If @code{wl-template-visible-select} is non-nil, this variable specifies
4716 the size of the preview window.
4718 @item wl-draft-buffer-style
4719 @vindex wl-draft-buffer-style
4720 The initial setting is @code{full}.
4721 Style of draft buffer window (except for replying and forwarding).
4722 @code{keep} is to use current window,
4723 @code{full} is to use full frame window,
4724 @code{split} is to split current window and use it.
4725 If some function is specified, it is called with the draft buffer
4728 @item wl-draft-reply-buffer-style
4729 @vindex wl-draft-reply-buffer-style
4730 The initial setting is @code{split}.
4731 Style of draft buffer for replying and forwarding.
4732 @code{keep} is to use message buffer window,
4733 @code{full} is to use full frame window,
4734 @code{split} is to split message buffer window and use it.
4735 If some function is specified, it is called with the draft buffer
4738 @item wl-draft-use-frame
4739 @vindex wl-draft-use-frame
4740 The initial setting is @code{nil}.
4741 If non-nil, use new frame for the draft.
4743 @item wl-draft-truncate-lines
4744 @vindex wl-draft-truncate-lines
4745 The initial value is the value of @code{default-truncate-lines}.
4746 If it is non-nil, truncate long lines in draft buffer.
4750 The initial setting is the value of the variable
4751 @code{user-mail-address}. The value of this variable is inserted as a
4752 @samp{From:} field of the draft when it is prepared.
4754 @item wl-envelope-from
4755 @vindex wl-envelope-from
4756 The initial setting is @code{nil}.
4757 The value of this variable is used for envelope from (MAIL FROM).
4758 If @code{nil}, the address part of @code{wl-from} is used.
4760 @item wl-user-mail-address-list
4761 @vindex wl-user-mail-address-list
4762 The initial setting is @code{nil}.
4763 This is the User's address list. If you have multiple addresses,
4766 @item wl-reply-subject-prefix
4767 @vindex wl-reply-subject-prefix
4768 The initial setting is @samp{Re: }.
4769 In the @samp{Subject:} of the reply draft, this string is prepended to
4770 the @samp{Subject:} of being replied.
4772 @item wl-forward-subject-prefix
4773 @vindex wl-forward-subject-prefix
4774 The initial setting is @samp{Forward: }.
4775 In the @samp{Subject:} of the forwarding draft, this string is prepended
4776 to the @samp{Subject:} of being forwarded.
4778 @item wl-draft-reply-use-address-with-full-name
4779 @vindex wl-draft-reply-use-address-with-full-name
4780 The initial setting is @code{t}.
4781 If non-nil, insert her full name with address when prepare a draft for
4782 reply a message. If it is @code{nil}, insert her address only.
4784 @item wl-draft-enable-queuing
4785 @vindex wl-draft-enable-queuing
4786 The initial setting is @code{t}.
4787 This flag controls off-line transmission. If non-nil, the draft is
4790 @item wl-draft-use-cache
4791 @vindex wl-draft-use-cache
4792 The initial setting is @code{nil}. If the value is non-nil and
4793 @code{wl-insert-message-id} is nil, cache the message which is sent.
4795 @item wl-fcc-force-as-read
4796 @vindex wl-fcc-force-as-read
4797 The initial setting is @code{nil}. If the value is non-nil,
4798 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4800 @item wl-auto-flush-queue
4801 @vindex wl-auto-flush-queue
4802 The initial setting is t.
4803 This flag controls automatic transmission of the queue when Wanderlust
4804 becomes on-line. If non-nil, the queue is automatically transmitted
4805 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4806 manually, press @kbd{F} in the folder mode.
4808 @item wl-ignored-forwarded-headers
4809 @vindex wl-ignored-forwarded-headers
4810 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4811 All headers that match this regexp will be deleted when forwarding a message.
4813 @item wl-ignored-resent-headers
4814 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4815 All headers that match this regexp will be deleted when resending a message.
4817 @item wl-draft-always-delete-myself
4818 @vindex wl-draft-always-delete-myself
4819 If non-nil, always removes your own address from @samp{To:} and
4820 @samp{Cc:} when you are replying to the mail addressed to you.
4822 @item wl-draft-delete-myself-from-bcc-fcc
4823 @vindex wl-draft-delete-myself-from-bcc-fcc
4824 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4825 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
4827 @item wl-smtp-posting-server
4828 @vindex wl-smtp-posting-server
4829 The initial setting is @code{nil}.
4830 This is the SMTP server name for mail transmission.
4832 @item wl-smtp-posting-port
4833 @vindex wl-smtp-posting-port
4834 The initial setting is @code{nil}.
4835 This is the SMTP port number for mail transmission.
4836 If @code{nil}, default SMTP port number (25) is used.
4838 @item wl-smtp-posting-user
4839 @vindex wl-smtp-posting-user
4840 The initial setting is @code{nil}.
4841 This is the user name for SMTP AUTH authentication. If @code{nil},
4842 @code{smtp-authenticate-user} is used.
4844 @item wl-smtp-authenticate-type
4845 @vindex wl-smtp-authenticate-type
4846 The initial setting is @code{nil}.
4847 This is the authentication method for SMTP AUTH authentication. If
4848 @code{nil}, @code{smtp-authenticate-type} is used. If
4849 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4852 @item wl-smtp-connection-type
4853 @vindex wl-smtp-connection-type
4854 The initial setting is @code{nil}.
4855 This variable specifies how to establish SMTP connections.
4856 If @code{nil}, @code{smtp-connection-type} is used.
4857 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4859 @item wl-nntp-posting-server
4860 @vindex wl-nntp-posting-server
4861 The initial setting is @code{nil}.
4862 This is the NNTP server name used for news submission.
4863 If @code{nil}, @code{elmo-nntp-default-server} is used.
4865 @item wl-nntp-posting-user
4866 @vindex wl-nntp-posting-user
4867 The initial setting is @code{nil}.
4868 This is the user name for AUTHINFO authentication on news submission.
4869 If @code{nil}, @code{elmo-nntp-default-user} is used.
4870 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4872 @item wl-nntp-posting-port
4873 @vindex wl-nntp-posting-port
4874 The initial setting is @code{nil}.
4875 This is the port number of the NNTP server used for news submission.
4876 If @code{nil}, @code{elmo-nntp-default-server} is used.
4878 @item wl-nntp-posting-stream-type
4879 @vindex wl-nntp-posting-stream-type
4880 The initial setting is @code{nil}.
4881 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4882 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4883 connection will be established.
4885 @item wl-nntp-posting-function
4886 @vindex wl-nntp-posting-function
4887 The initial setting is @code{elmo-nntp-post}.
4888 This is the function to post NNTP message.
4890 @item wl-nntp-posting-config-alist
4891 @vindex wl-nntp-posting-config-alist
4892 The initial setting is @code{nil}.
4893 The value takes an alist to define NNTP server like following example.
4894 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
4898 (setq wl-nntp-posting-config-alist
4899 '((",?gmane\\." . "news.gmane.org")
4901 ((server . "news-server")
4902 (user . "newsmaster")
4904 (function . elmo-nntp-post)))
4905 (".*" . "default-news-server")))
4909 @item wl-pop-before-smtp-user
4910 @vindex wl-pop-before-smtp-user
4911 The initial setting is @code{nil}.
4912 This is the POP user name for POP-before-SMTP.
4913 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4915 @item wl-pop-before-smtp-server
4916 @vindex wl-pop-before-smtp-server
4917 The initial setting is @code{nil}.
4918 This is the POP server name for POP-before-SMTP.
4919 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4921 @item wl-pop-before-smtp-authenticate-type
4922 @vindex wl-pop-before-smtp-authenticate-type
4923 The initial setting is @code{nil}.
4924 This is the authentication method for POP-before-SMTP authentication.
4925 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4927 @item wl-pop-before-smtp-port
4928 @vindex wl-pop-before-smtp-port
4929 The initial setting is @code{nil}.
4930 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4931 @code{elmo-pop3-default-port} is used.
4933 @item wl-pop-before-smtp-stream-type
4934 @vindex wl-pop-before-smtp-stream-type
4935 The initial setting is @code{nil}.
4936 This flag controls the use of SSL for POP-before-SMTP. If it is
4937 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4938 STARTTLS (RFC2595) connection will be established.
4940 @item wl-draft-queue-save-variables
4941 @vindex wl-draft-queue-save-variables
4942 Specifies a list of variable to which queued messages are saved on the
4943 off-line transmission.
4945 @item wl-draft-sendlog
4946 @vindex wl-draft-sendlog
4947 The initial setting is @code{t}.
4948 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4952 @item drafts are sent by smtp or qmail
4953 @item saved into folders by fcc
4954 @item saved into folders by queuing
4957 (it is written even if the transmission fails).
4958 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4959 and left to the logging function of @command{imput}.
4962 @item wl-draft-sendlog-max-size
4963 @vindex wl-draft-sendlog-max-size
4964 The initial setting is 20000 (in bytes).
4965 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4966 beyond the size specified by this variable.
4970 The initial setting is @code{nil}.
4971 If non-nil, address completion uses LDAP.
4973 @item wl-ldap-server
4974 @vindex wl-ldap-server
4975 The initial setting is @samp{localhost}.
4976 LDAP server name for address completion.
4979 @vindex wl-ldap-port
4980 The initial setting is @code{nil}.
4981 If non-nil, the value is used as port number.
4984 @vindex wl-ldap-base
4985 The initial setting is @samp{c=US}.
4986 LDAP search starting point (base) for address completion.
4988 @item wl-draft-remove-group-list-contents
4989 @vindex wl-draft-remove-group-list-contents
4990 The initial setting is @code{t}.
4991 If non-nil, remove the group-lists' members in the recipients when
4992 sending the message (group-list means the description such as
4993 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4996 @node Disconnected Operations, Expire and Archive, Draft, Top
4997 @chapter Off-line Management
4998 @cindex Disconnected Operations
5000 Wanderlust has on-line and off-line states.
5003 * Off-line State:: Wanderlust has on-line and off-line states
5004 * Enable Operations:: Enable Disconnected Operations
5005 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5006 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5007 * Variables of Plugged Mode:: Customize Plugged Mode
5011 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5012 @section Off-line State
5014 Wanderlust has on-line and off-line states. In the off-line state, you
5015 cannot access messages via network, unless they are cached.
5017 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5018 in the mode line indicates the off-line state. In folder or summary
5019 modes, press @kbd{M-t} to switch between off- and on-line.
5021 You can invoke Wanderlust in the off-line state by setting
5022 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5024 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5025 ignores uncached messages.
5028 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5029 @section Enable Disconeected Operations
5031 Even in the off-line state, provided that relevant messages are cached,
5032 and the variable @code{elmo-enable-disconnected-operation} (described
5033 later) is non-nil, you can following operations:
5034 @xref{Plugged Mode}, @xref{Off-line State settings}.
5037 * Send Messages off-line:: Transmit Messages
5038 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5039 * Creation of Folders:: Create Folders off-line (IMAP4)
5040 * Marking:: Mark (IMAP4)
5041 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
5044 As soon as Wanderlust becomes on-line, such operations invoked off-line
5045 are reflected in the servers via network.
5048 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5049 @subsection Transmission of Messages
5051 You can proceed sending operation for mail/news messages while you are
5052 off-line, then it will be reserved for sending (if you are using
5053 @file{im-wl.el}, it is irrelevant).
5054 Messages reserved for sending while off-line are accumulated in the
5055 queue folder, @samp{+queue}. These messages are transmitted at once when
5056 Wanderlust becomes on-line.
5058 You can visit @samp{+queue} in the off-line state and confirm content of
5059 messages in the queue. You can also remove messages. Removed messages
5060 are not transmitted even in the on-line state.
5063 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5064 @subsection Re-file and Copy (IMAP4)
5066 Re-file and copy operations to IMAP folders invoked during the off-line
5067 state are accumulated in the queue, and reflected in the server side
5068 when Wanderlust becomes on-line. If you visit destination folders after
5069 off-line re-file or copy, it looks as if messages were appended even in
5072 For the safety reasons, messages re-filed off-line are removed from
5073 source folders only if their @samp{Message-ID:} match messages on the
5074 servers. While the queue is processed, messages that failed to be
5075 re-filed or copied to the specified folders are appended to the folder
5079 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5080 @subsection Creation of Folders (IMAP4)
5082 You can create IMAP folders off-line. The creation of folders are
5083 reflected in the servers when Wanderlust becomes on-line. If the creation
5084 of those folders fails at that time for some reasons, messages
5085 to be re-filed into those are appended to the folder @samp{+lost+found}
5089 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5090 @subsection Marking (IMAP4)
5092 Off-line changes in unread/read and importance mark @samp{$} information
5093 are also reflected in the servers when Wanderlust becomes on-line.
5096 @node Pre-fetching Reservations, , Marking, Enable Operations
5097 @subsection Pre-fetching (IMAP4, NNTP)
5099 You can make reservations for pre-fetching messages in IMAP or NNTP
5100 folders. Reserved messages are marked with @samp{!} but not cached
5101 yet. When Wanderlust becomes on-line, they are pre-fetched from
5104 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5105 these off-line operations for IMAP4 and NNTP do not take place, and
5106 off-line re-file, copy or suchlike simply results in error.
5108 Because off-line operations use cache files, it is a bad idea to erase
5109 them by hand; it may cause Wanderlust to malfunction.
5111 If you want to remove caches, be sure to execute @kbd{M-x
5112 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5113 remove caches for messages relevant to off-line operations.
5116 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5117 @section Switching On-line/Off-line per Server/Port
5119 @kbd{M-t} described above switches networking states as a whole, but you
5120 can switch on-line/off-line per server/port.
5122 Pressing @kbd{C-t} in the folder or summary modes brings you in
5123 wl-plugged-mode shown below, in which you can change the plugged state
5128 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5131 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5132 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5134 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5135 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5141 The first line indicates status of the following three variables, and
5142 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5143 column modifies the values of these variables.
5147 "Queuing" @code{wl-draft-enable-queuing}
5148 "AutoFlushQueue" @code{wl-auto-flush-queue}
5149 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5153 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5156 The second and after lines indicate on-line/off-line states of servers
5157 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5158 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5159 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5161 @dfn{sending queue} means messages accumulated in the folder
5162 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5163 off-line operations when @code{elmo-enable-disconnected-operation} is
5165 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5166 @c off-line operations are enabled.
5168 They are displayed if there are any of them. In the example above, in
5169 the sending queue there are two messages (the first and the second in
5170 the queue folder) for smtp to hosta and one (the third) for nntp to
5171 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5174 If you change @samp{(wl-plugged)} in the second line, the variable
5175 @code{wl-plugged} is changed, so that the mode line indicator and
5176 plugged states of all ports are affected. If you change plugged states
5177 of any servers or ports, @samp{(wl-plugged)} in the second line is
5178 affected depending on @code{elmo-plugged-condition} settings and the
5179 plugged state of each port.
5182 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5183 @section Invoking Wanderlust in the Off-line State
5185 As described before, if you set @code{wl-plugged} to @code{nil} in
5186 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5187 off-line state. You can specify off-line state on a per server or port
5188 basis. Refer to @code{wl-reset-plugged-alist} also.
5190 Usually, when Wanderlust starts up, the plugged state of each port is
5191 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5192 @code{wl-nntp-posting-server} and so on. If you want to change the
5193 plugged state of these ports or to add other ports, configure
5194 @code{wl-make-plugged-hook} with a function.
5198 (add-hook 'wl-make-plugged-hook
5200 (elmo-set-plugged plugged-value(t/nil) server port)
5201 ;; @r{add or change plugged states of the port of the server}
5202 (elmo-set-plugged plugged-value(t/nil) server)
5203 ;; @r{if the port is omitted, all ports are affected}
5204 ;; @r{(you cannot omit the port if you newly add the server)}
5210 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5211 @section Customizable Variables
5216 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5217 mode from the beginning.
5219 @item wl-queue-folder
5220 @vindex wl-queue-folder
5221 The initial setting is @samp{+queue}.
5222 This is the folder in which messages in the transmission queue are
5225 @item wl-auto-flush-queue
5226 @vindex wl-auto-flush-queue
5227 The initial setting is @code{t}.
5228 This flag controls automatic transmission of the queue when Wanderlust
5229 becomes on-line. If non-nil, the queue is automatically transmitted
5230 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5231 manually, press @kbd{F} in the folder mode.
5233 @item elmo-enable-disconnected-operation
5234 @vindex elmo-enable-disconnected-operation
5235 The initial setting is @code{t}. Controls off-line operations
5236 regarding IMAP4. If non-nil, off-line operations are carried out.
5238 @item elmo-lost+found-folder
5239 @vindex elmo-lost+found-folder
5240 The initial setting is @samp{+lost+found}.
5241 This is the folder to which messages are saved when they fails to be
5242 appended while the off-line re-file/copy queue is processed.
5244 @item elmo-plugged-condition
5245 @vindex elmo-plugged-condition
5246 The initial setting is @code{one}.
5247 The value of @code{wl-plugged} reflects the return value of the function
5248 @code{elmo-plugged-p} (without arguments).
5249 This variable @code{elmo-plugged-condition} specifies the condition on
5250 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5251 plugged state of each port.
5254 'one : plugged if one or more ports are plugged.
5255 'all : plugged if all ports are plugged.
5256 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5257 states of the ports.
5258 @var{function} : reflects the return value of the @var{function}
5259 functions available per default
5260 'elmo-plug-on-by-servers
5261 : reflects the plugged state of the servers specified by the
5262 variable elmo-plug-on-servers.
5263 'elmo-plug-on-by-exclude-servers
5264 : reflects the plugged state of the servers that are not
5265 in elmo-plug-on-exclude-servers.
5266 elmo-plug-on-exclude-servers defaults to
5269 (system-name)without the domain part)
5275 (setq elmo-plugged-condition 'all)
5277 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5278 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5280 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5281 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5285 @item wl-reset-plugged-alist
5286 @vindex wl-reset-plugged-alist
5287 The initial setting is @code{t}. If non-nil, plugged states are
5288 initialized on a per server or port basis when Wanderlust starts up.
5290 If @code{nil}, plugged states are retained while Emacs is running. In
5291 other words, they are initialized when Emacs is restarted even if the
5292 value is @code{nil}.
5296 @node Expire and Archive, Scoring, Disconnected Operations, Top
5297 @chapter Automatic Expiration and Archiving of Messages
5298 @cindex Expire and Archive
5301 * Expire:: Expiration and Archiving
5302 * Archive:: Archiving All Messages
5306 @node Expire, Archive, Expire and Archive, Expire and Archive
5308 @cindex Expire Message
5310 Expiration means deletion of old messages which have outlasted a
5311 certain period of time.
5313 @code{wl-expire} supports not only simple deletion, but also moving to
5314 specified archiving folders.
5318 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5319 or @kbd{M-e} in the summary mode.
5321 @subsection Configuring @code{wl-expire-alist}
5323 An example configuration of @code{wl-expire-alist} is shown below.
5324 Everything in this @code{wl-expire-alist} makes a great difference in
5325 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5326 to @code{t}, especially in the initial stage.
5330 (setq wl-expire-alist
5331 '(("^\\+trash$" (date 14) remove)
5333 ("^\\+tmp$" (date 7) trash)
5334 ;; @r{re-file to @code{wl-trash-folder}}
5335 ("^\\+outbox$" (number 300) "$outbox;lha")
5336 ;; @r{re-file to the specific folder}
5338 ;; @r{do not expire}
5339 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5340 ;; @r{archive by message number (retaining numbers)}
5341 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5342 ;; @r{archive by a fixed number (retaining numbers)}
5343 ("^\\+diary$" (date 30) wl-expire-archive-date)
5344 ;; @r{archive by year and month (numbers discarded)}
5349 Items in the list has the format of:
5352 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5356 The folder is examined if it matches @var{regexp-for-folders} from the
5357 beginning of the list. If you invoke expiration on the folder that does
5358 not match any of them, nothing will happen. And if either the second or
5359 the third element of the item is @code{nil}, expiration will not take
5362 You can use any one of the following for
5363 @var{specification-of-message-to-be-deleted}:
5366 @item (number @var{n1} [@var{n2}])
5367 deletes messages depending on the number of messages in the folder.
5369 @var{n1} is the number of messages which should survive deletion, for example
5370 if its value is 500, the newest 500 messages survive and the rests are
5373 @var{n2} is the number of messages in the folder on which expiration should
5374 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5375 folders with 510 or more messages are expired.
5376 If you configured automatic expiration, frequently used folders may
5377 expire every time it receive messages, and you may be annoyed with the
5378 long delay in reading mail.
5379 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5380 expiration would not take place until a certain number of messages
5383 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5384 with important/new/unread) are not deleted.
5385 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5386 will expire so as to have 500 messages including such ones.
5387 Otherwise, it will have 500 messages except such ones.
5389 @item (date @var{d1})
5390 deletes messages depending on the dates.
5392 Messages dated @var{d1} or more days ago are deleted, for example if its
5393 value is seven, messages seven days old or more are deleted. Note that
5394 the date is the one in the @samp{Date:} field of the message, not when
5395 the message entered the folder.
5397 Messages with no or invalid @samp{Date:} field does not expire; you
5398 might have to delete them by hand.
5401 You can use any one of the following in the place of @var{destination}:
5405 deletes the messages instantly.
5408 hide the messages from summary (messages are not deleted).
5411 moves the messages to @code{wl-trash-folder}.
5413 @item @var{string}(folder)
5414 moves the messages to the folder specified with @var{string}.
5416 It would be useful for specifying an archiving folder, but because this
5417 does not move important messages, it might be better to use the
5418 standard functions described below.
5420 @item @var{function}
5421 invokes the specified @var{function}.
5423 To the @var{function}, three arguments are passed: a folder name, a list
5424 of messages to be deleted, and msgdb information of the summary. You
5425 can specify function-specific arguments after the name of the
5426 @var{function}. Note that the list contains messages with marks in
5427 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5430 These are four standard functions; three of them move messages to an archive
5431 folder in the specified way. This means old messages can be compressed
5432 and saved in a file, being deleted from the original folder.
5433 The last one divides messages to some MH folders.
5436 @item wl-expire-archive-number1
5437 re-files to archiving folders corresponding to the message numbers of
5438 the messages being deleted. For example, a message numbered 102 will be
5439 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5440 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5441 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5443 The archiving folders to which messages are re-filed are determined by
5444 the name of the folder as follows (in this case, archiving folders are
5445 handled as if @code{elmo-archive-treat-file} were non-nil).
5448 @item If the folder type is localdir:
5449 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5451 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5452 (@file{~/Mail/ml/wl-00100.zip}).
5454 @item The folder type is other than localdir:
5455 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5457 For example, @samp{%#mh/ml/wl} corresponds to
5458 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5461 As you can see, in the case of localdir, the folder type is not included
5462 in the path name, but otherwise it is included.
5463 And you can control the prefix to the archiving folder name by
5464 @code{wl-expire-archive-folder-prefix}.
5465 Refer to @code{wl-expire-archive-folder-prefix} for details.
5467 @item wl-expire-archive-number2
5468 re-files every certain number of messages to archiving folders.
5470 This differs from @samp{wl-expire-archive-number1} in that this re-files
5471 to the folder up to the specified number regardless of message numbers.
5472 The archiving folders to which messages are re-filed are determined in the
5473 same way as @code{wl-expire-archive-number1}.
5475 @item wl-expire-archive-date
5476 re-files messages depending on its date (year and month) to archive
5479 For example, a message dated December 1998 is re-filed to
5480 @code{$folder-199812;zip}. The name of the archiving folders except the
5481 date part are determined in the same way as
5482 @code{wl-expire-archive-number1}.
5485 You can set the first argument to these three standard functions to non-nil
5486 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5487 For example, it can be specified just after the name of the function:
5490 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5493 If you omit the argument, consecutive numbers from 1 are assigned for
5494 each archiving folder.
5496 @item wl-expire-localdir-date
5497 divedes messages depending on its date (year and month) to MH folders
5498 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5502 @subsection Treatment for Important or Unread Messages
5504 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5505 standard function, messages with marks in
5506 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5507 messages} thereafter) are retained.
5509 Per default, this variable include the important, new, and unread marks,
5510 so that messages with these marks are not removed.
5511 Note that you cannot include the temporary mark (i.e. temporary marks
5512 are removed anyway), and be sure to process temporary marks before you
5515 @subsection Auto Expiration
5517 The following setup invokes expiration when you move into the summary
5518 mode. There will be no confirmation, so make sure you made no mistake
5519 in regexp and other settings before you set up this.
5523 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5527 In the folder mode, you can invoke expiration per group as well as per
5528 folder. Therefore, if you specify @samp{Desktop} group, all folders
5529 matching @code{wl-expire-alist} expire.
5533 @subsection Treating archive folders.
5534 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5535 you must set non-nil value to @code{elmo-archive-treat-file}.
5537 @subsection Confirming
5539 If you are to use @code{remove}, try @code{trash} at first and see
5540 messages move to @code{wl-trash-folder} as expected, then replace it
5541 with @code{remove}. It would be dangerous to use @code{remove} from the
5544 If you are to use @code{wl-expire-archive-number1} and the like, try to
5545 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5546 you can append messages to it. Even if settings in
5547 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5548 would not be saved anywhere and disappeared in case the archiver program
5551 After you make sure you can archive to the folder correctly, you can
5552 invoke expiration and utilize the log.
5554 If you set @code{wl-expire-use-log} to @code{t},
5555 @file{~/.elmo/expired-log} should contain the log, for example:
5559 delete +ml/wl (593 594 595 596 597 598 599)
5560 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5564 The first column indicates the operation, i.e. @samp{delete},
5565 @samp{copy}, or @samp{move}. The next is the name of the folder that
5566 expired. In the case of @samp{copy} and @samp{move}, the destination
5567 folder is recorded after @samp{->}. The last is the list of message
5568 numbers that are actually deleted or moved (in the case of @samp{copy}
5569 and @samp{move}, the number is the one in the source folder, rather than
5570 the destination folder).
5572 @subsection Re-filing Reserved Messages
5574 The three standard functions copy reserved messages to the archive
5575 folder, but do not delete them from the source folder. Because
5576 reserved messages and the like always remain, they are recorded in
5577 @file{~/.elmo/expired-alist} so that they are not copied over and over
5578 again. They are not recorded if copied by @code{wl-summary-archive}.
5580 If you enabled logging, usually @samp{move} is recorded for re-filing,
5581 but instead @samp{copy} and @samp{delete} are recorded separately if
5582 reserved messages are involved. This is because it actually copies
5583 messages including reserved, then deletes ones except reserved in that
5586 @section Customizable Variables
5589 @item wl-expire-alist
5590 @vindex wl-expire-alist
5591 The initial setting is @code{nil}.
5592 This variable specifies folders and methods to expire. For details,
5593 refer to @code{wl-expire-alist} settings above.
5595 @item wl-summary-expire-reserve-marks
5596 @vindex wl-summary-expire-reserve-marks
5597 The initial setting is the list below.
5601 (list wl-summary-important-mark
5603 wl-summary-unread-mark
5604 wl-summary-unread-uncached-mark
5605 wl-summary-unread-cached-mark)
5609 Messages with these marks are retained in the folder, even after
5611 Only permanent marks can be listed, not temporary marks.
5613 You can list marks one by one as in the default; you can use the
5614 following settings as well:
5618 All messages with permanent marks are retained,
5619 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5623 All messages are handled as usual ones that are already read, no matter
5624 what marks they have; even important messages are deleted.
5627 @item wl-expire-archive-files
5628 @vindex wl-expire-archive-files
5629 The initial setting is 100.
5630 This variable specifies the number of messages to be retained in one
5633 @item wl-expire-number-with-reserve-marks
5634 @vindex wl-expire-number-with-reserve-marks
5635 The initial setting is @code{nil}.
5636 If non-nil, if expiring messages are specified by @code{number},
5637 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5639 @item wl-expire-archive-get-folder-function
5640 @vindex wl-expire-archive-get-folder-function
5641 The initial setting is @code{wl-expire-archive-get-folder}.
5643 This variable specifies a function that returns the name of an archiving
5644 folder for standard functions in the place of @var{destination}.
5645 You can use the following three variables for simple modification of
5646 folder names; if you want more complex settings, define your own
5647 function in this variable.
5649 @code{wl-expire-archive-get-folder} can be customized by these
5652 @item @code{wl-expire-archive-folder-name-fmt}
5653 @item @code{wl-expire-archive-folder-type}
5654 @item @code{wl-expire-archive-folder-prefix}
5657 @item wl-expire-archive-folder-name-fmt
5658 @vindex wl-expire-archive-folder-name-fmt
5659 The initial setting is @samp{%s-%%05d;%s}.
5660 This is a @code{format} string for archiving folders used in
5661 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5662 Note that you must specify the message number by @samp{%%d}, because it
5663 is parsed twice by @code{format}.
5665 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5668 @item wl-expire-archive-date-folder-name-fmt
5669 @vindex wl-expire-archive-date-folder-name-fmt
5670 The initial setting is @samp{%s-%%04d%%02d;%s}.
5671 This is a @code{format} string for archiving folders used in
5672 @code{wl-expire-archive-date}. Note that you must specify the message
5673 number by @samp{%%d}, because it is parsed twice by @code{format}.
5674 There should be @samp{%%d} twice, one for the year and the other for the
5677 If you modify this, adjust
5678 @code{wl-expire-archive-date-folder-num-regexp} as well.
5680 @item wl-expire-archive-folder-type
5681 @vindex wl-expire-archive-folder-type
5682 The initial setting is @code{zip}.
5683 This variable specifies an archiver type of the archiving folders.
5685 @item wl-expire-archive-folder-prefix
5686 @vindex wl-expire-archive-folder-prefix
5687 The initial setting is @code{nil}.
5688 This variable specifies the prefix (directory structure) to archiving
5690 Exercise extreme caution in using this feature, as it has not been
5692 In the worst case, there is a fear of destructing archiving folders.
5696 There will be no prefix.
5699 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5700 @samp{$ml/wl-00000;zip;wl}.
5703 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5706 @samp{$ml/wl-00000;zip;ml/wl}.
5709 @item wl-expire-archive-folder-num-regexp
5710 @vindex wl-expire-archive-folder-num-regexp
5711 The initial setting is @samp{-\\([-0-9]+\\);}.
5712 This variable specifies the regular expression to be used for getting
5713 message numbers from multiple archiving folders specified by
5714 @code{elmo-list-folders}.
5715 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5717 @item wl-expire-archive-date-folder-num-regexp
5718 @vindex wl-expire-archive-date-folder-num-regexp
5719 The initial setting is @samp{-\\([-0-9]+\\);}.
5720 This is the regular expression to be used for getting message numbers
5721 from multiple archiving folders specified by @code{elmo-list-folders}.
5722 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5724 @item wl-expire-delete-oldmsg-confirm
5725 @vindex wl-expire-delete-oldmsg-confirm
5726 The initial setting is @code{t}.
5727 If non-nil, messages older than the one with the largest number will be
5728 deleted with confirmation.
5729 If @code{nil}, they are deleted without confirmation.
5731 This feature is valid only if non-nil is specified as a argument to the
5732 standard functions so as to retain numbers.
5734 @item wl-expire-use-log
5735 @vindex wl-expire-use-log
5736 The initial setting is @code{nil}.
5737 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5738 They are appended but not truncated or rotated automatically; you might
5739 need to remove it manually.
5741 @item wl-expire-add-seen-list
5742 @vindex wl-expire-add-seen-list
5743 The initial setting is @code{t}.
5745 If non-nil, when messages are re-filed by expiration, read/unread
5746 information is passed to the destination folder.
5748 However if you do not read the destination folder from Wanderlust,
5749 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5750 want to set this to @code{nil} if you are simply saving to some
5751 archiving folders. Even if its value is @code{nil}, messages in the
5752 archiving folders are simply treated as unread; it does not affect
5755 @item wl-expire-folder-update-msgdb
5756 @vindex wl-expire-folder-update-msgdb
5757 The initial setting is @code{t}.
5758 If @code{t}, in the folder mode, expiration is carried out after
5759 updating summary information. If you specified a list of regular
5760 expressions of folder names, summary information is updated for matching
5765 @node Archive, , Expire, Expire and Archive
5766 @section Archiving Messages
5768 @subsection Archiving Messages
5769 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5770 folders. If there are the archiving folders already, only new messages
5773 You can use @code{wl-archive-alist} in order to specify how messages are
5774 archived according to their folder names, as in @code{wl-expire-alist}.
5779 (setq wl-archive-alist
5780 '(("^\\+tmp$" wl-archive-date)
5781 ("^\\+outbox$" wl-archive-number2)
5782 (".*" wl-archive-number1)))
5786 Each item in the list has the following format:
5789 (@var{folders-regexp} @var{deleting-function})
5792 As you can see, you can only use a function after @var{folders-regexp}.
5793 Per default, there are three functions:
5796 @item @code{wl-archive-number1}
5797 @item @code{wl-archive-number2}
5798 @item @code{wl-archive-date}
5801 As inferred from their names, they work similarly to "expire" versions,
5802 other than the following points:
5805 @item No messages are deleted
5806 @item Message numbers are retained even if invoked without arguments
5809 These functions are good to archive all messages in a folder by their
5810 numbers or by their dates.
5811 These are also useful for backup or confirmation purposes before
5813 If you try to re-file them after they are archived, they are deleted but
5816 Per default, the archiving folders to which messages are copied are
5817 determined automatically by @code{wl-expire-archive-get-folder-function}.
5818 You can copy to a specific folder by invoking with a prefix argument,
5819 i.e. @kbd{C-u M-x wl-summary-archive}.
5821 Note that this feature has not been seriously tested, because you can
5822 simply copy to an archiving folder, for example by
5823 @code{wl-summary-copy-region}.
5825 The archiving folders are determined by the same logic as in
5826 @code{wl-summary-expire}; the following customizable variables are
5830 @item @code{wl-expire-archive-files}
5831 @item @code{wl-expire-archive-get-folder-function}
5832 @item @code{wl-expire-archive-folder-name-fmt}
5833 @item @code{wl-expire-archive-folder-type}
5834 @item @code{wl-expire-archive-folder-prefix}
5835 @item @code{wl-expire-archive-folder-num-regexp}
5838 @subsection Customizable Variables
5841 @item wl-archive-alist
5842 @vindex wl-archive-alist
5843 The initial setting is the list shown below:
5847 ((".*" wl-archive-number1))
5852 This variable specifies a function that copies to archiving folders.
5853 To the function, three arguments are passed: a folder name, a list of
5854 messages in the folder, and msgdb information of the summary.
5855 Needless to say, you can use your own function.
5859 @node Scoring, Split messages, Expire and Archive, Top
5860 @chapter Score of the Messages
5862 @c @cindex Kill File
5864 Scoring is the function that associates a score (value) with each
5865 message, and marks as read or deletes from the summary according to it.
5867 You can put target or important marks on essential messages, or read marks
5868 on the ones you do not want to read, for example spam articles.
5870 This scoring function has a capability and a format similar to the one
5871 that Gnus has, although there are some unsupported features and
5872 Wanderlust specifics.
5873 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5876 * Score Commands:: Score Commands
5877 * Score File Format:: Score File Format
5881 @node Score Commands, Score File Format, Scoring, Scoring
5882 @section Score Commands
5883 @cindex Score Commands
5885 @subsection Score File Specification
5887 @code{wl-score-folder-alist} specifies score files or variables in which
5888 scores are defined, corresponding to folder names.
5892 (setq wl-score-folder-alist
5901 If paths to the score files are omitted, the directory specified in the
5902 variable @code{wl-score-files-directory} is assumed.
5904 No matter what you write in @code{wl-score-folder-alist}, the default
5905 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5906 read (it does not have to exist).
5907 Therefore, in the example above, the three score files,
5908 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5909 the folders that matches @samp{^-.*}.
5911 @subsection Scored Messages
5913 Scores are attached to the messages that are specified by
5914 @code{wl-summary-score-marks} temporarily when the summary is updated;
5915 when you exit from the summary, the scores are removed and reverts to
5918 @subsection Creation of Score Files
5920 In the summary buffer, move to an appropriate message and type @kbd{L}.
5921 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5922 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5924 This makes @minus{}1000 are scored for messages with the same
5925 @samp{Subject:} as the string you entered. That is, such a score file
5926 is created automatically.
5928 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5929 The score file you just made appears.
5930 This buffer is called @dfn{score editing buffer} thereafter.
5931 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5932 as you are previously; type @kbd{a}. Then a score entry for "From"
5934 In this way, you can create a score file easily either in the summary
5935 buffer or in the score editing buffer.
5937 By the way, you might be aware the numbers of key strokes are different
5938 between @kbd{s s p} and @kbd{a}.
5939 This is determined by @code{wl-score-header-default-entry}.
5940 This variable specifies the default score entries corresponding to
5942 For example, for "subject" field, a type and a time limit are prompted,
5943 but for "from" field, they are fixed upon automatically as substring and
5944 permanent respectively.
5945 However, score values can be modified by the prefix argument.
5946 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5949 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5950 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5951 erasing contents of the buffer deletes the score file being edited.
5955 @subsubsection Selecting Score Files
5957 You can change score files to which scores are appended by
5958 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5959 @code{wl-score-change-score-file}.
5961 @subsubsection Summing Up the Score
5963 If you add the same entries by @code{wl-summary-increase-score},
5964 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5965 scores for the entry is summed up.
5967 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5968 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5969 @minus{}1200 will be created as a result.
5971 @subsubsection Creating Thread Key
5973 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5974 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5976 @subsubsection Creating Followup Key
5978 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5979 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5980 at the cursor to @samp{References} key.
5981 If @code{wl-score-auto-make-followup-entry} is non-nil,
5982 @samp{Message-ID} of all messages to be followed up within dates
5983 specified by @code{wl-score-expiry-days}.
5985 @subsection Key Bindings
5990 @findex wl-summary-increase-score
5991 Increases the score for the current message.
5992 And the score entry is appended to the score file at the same moment.
5993 You can specify the score value by a prefix argument.
5997 @findex wl-summary-lower-score
5998 Decreases the score for the current message.
5999 And the score entry is appended to the score file at the same moment.
6000 You can specify the score value by a prefix argument.
6003 @kindex h R (Summary)
6004 @findex wl-summary-rescore
6005 Re-applies the scoring.
6006 However, already scored messages are not scored anew.
6009 @kindex h c (Summary)
6010 @findex wl-score-change-score-file
6011 Changes the score file currently selected.
6014 @kindex h e (Summary)
6015 @findex wl-score-edit-current-scores
6016 Edits the score file currently selected.
6017 If there are multiple score files, the previously specified one is
6021 @kindex h f (Summary)
6022 @findex wl-score-edit-file
6023 Edits an arbitrary score file and selects it.
6026 @kindex h F (Summary)
6027 @findex wl-score-flush-cache
6028 Erases caches associated to the score files that are read.
6029 If you modified score files directly (from other than Wanderlust), you
6030 need to re-read them after erasing the cache.
6033 @kindex h m (Summary)
6034 @findex wl-score-set-mark-below
6035 Specifies the criterion for scores to be marked as read.
6036 Messages with scores less than this value are marked as read.
6039 @kindex h x (Summary)
6040 @findex wl-score-set-expunge-below
6041 Specifies the criterion for scores to be deleted from the summary.
6042 Messages with scores less than this value are deleted.
6043 "Deleted" means it is not shown; they are not removed from the summary
6044 information or the folder.
6045 The deleted messages can be shown by rescan-noscore again.
6048 @subsection Key Bindings in the Score Editing Buffer
6052 @kindex C-c C-k (Score Mode)
6053 @findex wl-score-edit-kill
6054 Abandons the file being edited.
6057 @kindex C-c C-c (Score Mode)
6058 @findex wl-score-edit-exit
6059 Saves the file being edited, and quits from the edit mode.
6062 @kindex C-c C-p (Score Mode)
6063 @findex wl-score-pretty-print
6067 @kindex C-c C-d (Score Mode)
6068 @findex wl-score-edit-insert-date
6069 Inserts the number of dates from Dec. 31, 1 B.C.
6070 It is used for creating the third factor of time-limited scores.
6073 @kindex C-c C-s (Score Mode)
6074 @findex wl-score-edit-insert-header
6075 Inserts the header of the message selected in the summary buffer.
6078 @kindex C-c C-e (Score Mode)
6079 @findex wl-score-edit-insert-entry
6080 Inserts the score entry of the message selected in the summary buffer.
6083 @subsection Customizable Variables
6086 @item wl-summary-default-score
6087 @vindex wl-summary-default-score
6088 The initial setting is 0 (zero).
6089 This variable specifies the default value of the score.
6090 The score is increased or decreased based upon this value.
6092 @item wl-summary-important-above
6093 @vindex wl-summary-important-above
6094 The initial setting is @code{nil}.
6095 Messages with scores larger than this value are attached with the
6096 important mark (@samp{$}).
6097 If @code{nil}, no important marks are attached.
6099 @item wl-summary-target-above
6100 @vindex wl-summary-target-above
6101 The initial setting is @code{nil}.
6102 Messages with scores larger than this value are attached with the target
6104 If @code{nil}, no target marks are attached.
6106 @item wl-summary-mark-below
6107 @vindex wl-summary-mark-below
6108 The initial setting is 0 (zero).
6109 Messages with scores smaller than this value are marked as read.
6111 @item wl-summary-expunge-below
6112 @vindex wl-summary-expunge-below
6113 The initial setting is @code{nil}.
6114 Messages with scores smaller than this value are deleted from the
6116 If @code{nil}, they are not deleted.
6118 @item wl-summary-score-marks
6119 @vindex wl-summary-score-marks
6120 The initial setting is the list shown below:
6124 (list wl-summary-new-mark)
6129 Messages with these marks are scored.
6131 @item wl-use-scoring
6132 @vindex wl-use-scoring
6133 The initial setting is t.
6134 If non-nil, scoring is enabled.
6136 @item wl-score-files-directory
6137 @vindex wl-score-files-directory
6138 The initial setting is @file{~/.elmo/}.
6139 The default directory for score files.
6141 @item wl-score-interactive-default-score
6142 @vindex wl-score-interactive-default-score
6143 The initial setting is 1000.
6144 This value is used as a score when a score factor is @code{nil} in the
6145 score file. It is also used in @code{wl-summary-increase-score} and
6146 @code{wl-summary-lower-score}, on condition that the value of
6147 @code{wl-score-header-default-entry} is @code{nil}.
6149 @item wl-score-expiry-days
6150 @vindex wl-score-expiry-days
6151 The initial setting is 7.
6152 This is the number of days before time-limited scores are deleted.
6154 @item wl-score-update-entry-dates
6155 @vindex wl-score-update-entry-dates
6156 The initial setting is @code{t}.
6157 If non-nil, it enables deletion of time-limited scores.
6159 @item wl-score-header-default-entry
6160 @vindex wl-score-header-default-entry
6161 Specifies the default value for each header field for score entries
6162 created by @code{wl-summary-increase-score},
6163 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6165 @item wl-score-simplify-fuzzy-regexp
6166 @vindex wl-score-simplify-fuzzy-regexp
6167 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6168 regular expression to be deleted from the string.
6169 Because this is usually used for Subject, the default is prefixes that
6170 are attached by mailing list programs.
6172 @item wl-summary-rescore-partial-threshold
6173 @vindex wl-summary-rescore-partial-threshold
6174 The initial setting is 200.
6175 When sync-all or rescan is executed, if there are messages more than
6176 this value, only the last same number of messages as this value are
6179 @item wl-summary-auto-sync-marks
6180 @vindex wl-summary-auto-sync-marks
6181 If non-nil, unread/important marks are synchronized when the summary
6183 Unread marks reflect information on the IMAP4 server.
6184 Important marks reflect information on the IMAP4 server (flagged or
6185 not), and contents of @samp{'mark} folder.
6186 The initial setting is @code{t}.
6190 @node Score File Format, , Score Commands, Scoring
6191 @section Score File Format
6192 @cindex Score File Format
6194 The format of score files are the same as Gnus, and basically you can
6195 use Gnus score files as they are. But they are not fully compatible
6196 because some keys are not supported and there are Wanderlust specifics.
6197 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6202 ("for sale" -1000 nil s)
6203 ("profit" -1000 nil s))
6205 ("spam@@spamspamspam" -10000 nil s))
6207 ("my@@address" 3001 nil s))
6209 (1000000 -10 nil >))
6219 If the key is a string, it is the name of the header to be matched.
6220 The following keys are available:
6221 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6222 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6223 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6224 @code{Chars} and @code{Lines} mean the size and the number of lines of
6225 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6226 are described later.
6227 The rest corresponds the field of the same name.
6229 Arbitrary numbers of core entries are specified after the key.
6230 Each score entry consists of these five factors:
6234 A factor that matches header. This should be a number in the cases of
6235 @code{lines} and @code{chars}, otherwise a string.
6238 A score factor. When the first item matches, the score of the message
6239 is increased or decreased by this value.
6242 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6243 of a number, the score is deleted if it does not match for days
6244 (@code{wl-score-expiry-days}) from the date specified by this.
6245 The date is since Dec. 31, 1 B.C.
6248 A type factor. This specifies the way the first factor matches.
6249 Available types depend on keys.
6252 @item From, Subject, References, Message-ID
6253 For these keys in string, @code{r} and @code{R} (regexp),
6254 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6255 as well as @code{f} and @code{F} (fuzzy) can be used.
6256 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6259 For these keys, the following five numerical relative operators can be
6260 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6263 This key matches @code{From} header, and scores all follow-ups to the
6265 For example, it would be useful for increasing scores for follow-ups to
6268 You can use the same types as @code{From} except for @code{f}.
6269 And a @samp{Followup} entry is automatically appended to the score file.
6272 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6273 A @samp{Thread} entry is automatically appended for each article that
6274 has @var{x} in the @code{References} header.
6275 You can make sure the whole thread including messages that does not have
6276 all ancestors @code{Message-ID} in @code{References} is scored.
6278 You can use the same types as @code{References} except for @code{f}.
6279 And a @samp{Thread} entry is automatically appended to the score file.
6283 A factor for extension header. This is meaningful only if the key is
6285 This specifies headers to be matched other than standard headers like
6286 @code{Subject} and @code{From}.
6287 Note that you should specify the header in
6288 @code{elmo-msgdb-extra-fields} also.
6289 Therefore it does not work in folders where extension headers cannot be
6294 The sum of these scores @emph{after all factors are applied} becomes the
6295 score of the message.
6297 @cindex Score File Atoms
6299 Messages with a score less than this value is marked as read.
6300 The default is @code{wl-summary-mark-below}.
6303 Messages with a score less than this value is deleted from the summary.
6304 The default is @code{wl-summary-expunge-below}.
6306 @item mark-and-expunge
6307 Both @code{mark} and @code{expunge} are applied,
6308 i.e. messages with a score less than this value is marked as read and
6309 deleted from the summary.
6312 Messages with a score greater than this value is attached with temp
6314 The default is @code{wl-summary-target-above}.
6317 Messages with a score greater than this value is attached with important
6319 The default is @code{wl-summary-important-above}.
6324 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6325 are used, you need to set @code{elmo-msgdb-extra-fields}.
6328 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6331 There are other restrictions as shown below:
6334 @item Because @samp{References} field in the summary information
6335 contains only the last @samp{Message-ID}, @code{references} key matches
6339 Keys that can be seen by folder of types:
6343 chars lines xref extra
6344 localdir,localnews Y E E E
6345 nntp (supporting xover) Y E E N
6351 N: cannot be seen (ignored)
6352 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6357 @node Split messages, Address Book, Scoring, Top
6358 @chapter Message splitting
6359 @cindex Split messages
6361 You can use @code{elmo-split} to split message in folder
6362 @code{elmo-split-folder} a la @command{procmail} according to some
6363 specified rules. To use this feature, set as follows in your
6364 @file{~/.emacs} at first.
6367 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
6370 Then you can invoke @kbd{M-x elmo-split} to split messages according to
6371 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
6372 to do a rehearsal (do not split actually).
6374 We will describe how to specify the rule. First of all, see following
6379 (setq elmo-split-rule
6380 ;; @r{Store messages from spammers into @samp{+junk}}
6381 '(((or (address-equal from "i.am@@spammer")
6382 (address-equal from "dull-work@@dull-boy")
6383 (address-equal from "death-march@@software")
6384 (address-equal from "ares@@aon.at")
6385 (address-equal from "get-money@@richman"))
6387 ;; @r{Store messages from mule mailing list into @samp{%mule}}
6388 ((equal x-ml-name "mule") "%mule")
6389 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
6390 ;; @r{and continue evaluating following rules}
6391 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
6392 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
6393 ((match from "\\(.*\\)@@yahoo\\.com")
6395 ;; @r{Store unmatched mails into @samp{+inbox}}
6400 The basic unit of the rule is a combination like
6403 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
6406 If @samp{CONDITION} is true, @samp{ACTION} is performed.
6407 The 1st element @samp{CONDITION} is a condition represented by a
6408 balanced expression (sexp). Its grammar will be explained below.
6409 The 2nd element @samp{ACTION} is the name of the folder to split
6410 messages into, or a symbol. When the 3rd element @code{continue} is
6411 specified as symbol, evaluating rules is not stopped even when the
6412 condition is satisfied.
6414 The grammar for @samp{CONDITION} is as follows. See example above to
6415 learn how to write the condition practically.
6419 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
6420 (@samp{FIELD-NAME} is a symbol that describes the field name)
6424 True if the field value equals to @samp{VALUE}.
6425 Case of the letters are ignored.
6427 True if the field value matches to VALUE.
6428 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6429 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6430 @item @code{address-equal}
6431 True if one of the addresses in the field equals to
6432 @samp{VALUE}. Case of the letters are ignored.
6433 @item @code{address-match}
6434 True if one of the addresses in the field matches to
6436 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6437 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6441 Functions which accept an integer argument (@samp{SIZE}).
6445 True if the size of the message is less than @samp{SIZE}.
6447 True if the size of the message is greater than @samp{SIZE}.
6451 Functions which accept any number of arguments.
6455 True if one of the argument returns true.
6457 True if all of the arguments return true.
6463 When a symbol is specified, it is evaluated.
6466 You can specify followings as 2nd @samp{ACTION}.
6472 If some string is specified, it will be regarded as the destination
6473 folder, and the message will be appended to it.
6478 If the symbol @samp{delete} is specified, delete the substance of the
6479 message in @code{elmo-split-folder}
6484 If the symbol @samp{noop} is specified, do nothing on the message and
6490 If some function is specified, execute it.
6493 If the message passes all rules, it will be dealed along @samp{ACTION}
6494 specified by @code{elmo-split-default-action}.
6497 @node Address Book, Customization, Split messages, Top
6498 @chapter Address Book
6499 @cindex Address Book
6501 With address book, you can utilize address completion, and you have
6502 summary displayed with nicknames.
6505 * Mail Addresses:: Definition of Address Book
6506 * Address Manager:: Address Manager
6510 @node Mail Addresses, Address Manager, Address Book, Address Book
6511 @section Address book
6512 @cindex Address book Definition
6514 @cindex Alias, Address
6516 The file @file{~/.addresses} is a simple address book for Wanderlust.
6517 Make address file @file{~/.addresses}, and edit to suit your requirement.
6519 The data written in @file{~/.addresses} are used for address completion
6520 under draft editing mode. Furthermore, they are used when showing names
6521 in summary display mode. You can safely skip this section, if you don't
6522 want to customize address completion and summary display.
6523 It is possible to add/change/remove addresses from @file{~/.addresses} in
6524 summary buffer after Wanderlust is invoked. @refill
6526 The format is very simple. Like this. @refill
6531 # @r{Lines begin with @samp{#} are comment.}
6532 # @r{Empty lines are ignored}
6534 # @r{Format of each line:}
6535 # @var{email-address} "@var{nickname} "@var{realname}"
6537 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6538 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6539 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6544 One line defines one persons description.
6546 Actually, in default setup, @var{nickname} is used in summary-mode and
6547 @var{realname} is used in draft preparation mode. This behavior is
6548 better understood if you try it and confirmed the function first. You
6549 can write and try a small definition, so you will know the idea of the
6550 address book before writing a big one.
6552 And, if MH alias file is specified in variable @code{wl-alias-file},
6553 it is used as an address information in the draft preparation mode.
6555 If variable @code{wl-use-ldap} is non-nil (initial setting is
6556 @code{nil}), address completion in draft mode uses LDAP information.
6558 If you use LDAP, you have to set @code{wl-ldap-server},
6559 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6560 not have LDAP feature as built-in feature (Currently only XEmacs can
6561 have built-in LDAP feature), you have to set command exec @env{PATH} to
6562 the program @command{ldapsearch}.
6565 @node Address Manager, , Mail Addresses, Address Book
6566 @section Address Manager
6567 @cindex Address Manager
6569 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6570 the address book and insert address to draft buffer.
6572 @subsection Key Bindings
6576 @kindex t (Address Manager)
6577 @findex wl-addrmgr-set-to
6578 Add @samp{To:} mark.
6581 @kindex c (Address Manager)
6582 @findex wl-addrmgr-set-cc
6583 Add @samp{Cc:} mark.
6586 @kindex b (Address Manager)
6587 @findex wl-addrmgr-set-bcc
6588 Add @samp{Bcc:} mark.
6591 @kindex u (Address Manager)
6592 @findex wl-addrmgr-unmark
6596 @kindex x (Address Manager)
6597 @findex wl-addrmgr-apply
6599 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6600 buffer and quit address manager. When no draft buffer, make new draft
6601 with insert marked addresses.
6603 If no mark, quit address manager.
6607 @kindex q (Address Manager)
6608 @findex wl-addrmgr-quit
6609 Quit address manager.
6612 @kindex a (Address Manager)
6613 @findex wl-addrmgr-add
6617 @kindex d (Address Manager)
6618 @findex wl-addrmgr-delete
6622 @kindex e (Address Manager)
6623 @findex wl-addrmgr-edit
6628 @node Customization, Terminology, Address Book, Top
6629 @chapter Customizing Wanderlust
6630 @cindex Customization
6633 * Living with other packages:: Cooperating with other packages
6634 * Highlights:: Highlights
6635 * Biff:: Notify Mail arrival
6636 * Advanced Settings:: Advanced Settings
6637 * Customizable Variables:: Customizable Variables
6642 @node Living with other packages, Highlights, Customization, Customization
6643 @section Living with other packages
6645 Examples with other packages.
6648 * imput:: imput (im-wl.el)
6649 * BBDB:: The Insidious Big Brother Database
6650 * LSDB:: The Lovely Sister Database
6651 * supercite:: supercite.el
6652 * mu-cite:: mu-cite.el
6653 * X-Face:: x-face,bitmap-mule
6654 * dired-dd:: dired-dd.el
6656 * Addrbook:: Addrbook
6657 * mime-w3m:: mime-w3m.el
6661 @node imput, BBDB, Living with other packages, Living with other packages
6666 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6669 If @command{imput} is on the @code{exec-path} at the installation,
6670 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6674 (autoload 'wl-draft-send-with-imput-async "im-wl")
6675 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6680 @node BBDB, LSDB, imput, Living with other packages
6684 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
6685 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
6686 and do the following settings.
6688 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6689 byte-compiled and installed.
6697 ;; @r{enable pop-ups}
6698 (setq bbdb-use-pop-up t)
6699 ;; @r{auto collection}
6700 (setq bbdb/mail-auto-create-p t)
6701 ;; @r{exceptional folders against auto collection}
6702 (setq bbdb-wl-ignore-folder-regexp "^@@")
6703 (setq signature-use-bbdb t)
6704 (setq bbdb-north-american-phone-numbers-p nil)
6705 ;; @r{shows the name of bbdb in the summary} :-)
6706 (setq wl-summary-from-function 'bbdb-wl-from-func)
6707 ;; @r{automatically add mailing list fields}
6708 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6709 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6713 You can complete address with BBDB by @kbd{M-@key{TAB}}
6717 @node LSDB, supercite, BBDB, Living with other packages
6721 The following is an example setting to use
6722 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
6729 (add-hook 'wl-draft-mode-hook
6731 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
6735 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
6736 (complete address with LSDB).
6739 @node supercite, mu-cite, LSDB, Living with other packages
6740 @subsection sc.el(supercite), sc-register.el
6744 The same setting as usual mailers should be OK. The following is an
6745 example of settings:
6749 (autoload 'sc-cite-original "supercite" nil t)
6750 (add-hook 'mail-citation-hook 'sc-cite-original)
6755 @node mu-cite, X-Face, supercite, Living with other packages
6756 @subsection mu-cite.el
6759 The same setting as usual mailers should be OK. The following is an
6760 example of settings.
6762 If you use mu-cite version 8.0 or earlier:
6766 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6767 (setq mail-citation-hook 'mu-cite/cite-original)
6771 If you use mu-cite version 8.1 or later:
6775 (autoload 'mu-cite-original "mu-cite" nil t)
6776 (add-hook 'mail-citation-hook (function mu-cite-original))
6780 @node X-Face, dired-dd, mu-cite, Living with other packages
6784 If you have installed one of the following, you can decode
6785 @samp{X-Face:} field in message buffer and you will see face image.
6788 * x-face-xmas:: XEmacs case
6789 * x-face-mule:: Emacs case
6792 If there is an encoded X-Face string in a file @file{~/.xface} (the
6793 value of the variable @code{wl-x-face-file}), it is inserted as a
6794 @samp{X-Face:} field in the draft buffer (if
6795 @code{wl-auto-insert-x-face} is non-nil).
6797 @node x-face-xmas, x-face-mule, X-Face, X-Face
6798 @subsubsection x-face-xmas (for XEmacs)
6801 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6802 1.3.6.13 or later, do the following:
6806 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6807 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6811 @node x-face-mule, , x-face-xmas, X-Face
6812 @subsubsection x-face-mule (for Emacs)
6816 If you use @file{x-face-mule.el} in bitmap-mule
6817 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6821 (autoload 'x-face-decode-message-header "x-face-mule")
6822 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6826 @subsubsection x-face-e21 (for Emacs 21.x)
6829 With Emacs 21.x, you can use @file{x-face-e21.el}
6830 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6831 to display X-Face. In this case, bitmap-mule is not required.
6836 (autoload 'x-face-decode-message-header "x-face-e21")
6837 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6842 @node dired-dd, MHC, X-Face, Living with other packages
6843 @subsection dired-dd(Dired-DragDrop)
6844 @pindex Dired-DragDrop
6846 @cindex Drag and Drop
6848 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6849 compose multi-part by simple Drag-and-Drop from dired to the draft
6850 buffer being edited in GNU Emacs (this feature is not Wanderlust
6851 specific, but general-purpose for SEMI).
6855 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6861 ;; @r{Set dired-x variables here.}
6862 ;; @r{To and flo@dots{}}
6864 (progn (require 'dired-dd)
6865 (require 'dired-dd-mime))))))
6869 @node MHC, Addrbook, dired-dd, Living with other packages
6873 Message Harmonized Calendaring system
6874 (@uref{http://www.quickhack.net/mhc/})
6876 By using MHC, you can make a calendar from the messages.
6882 (setq mhc-mailer-package 'wl)
6883 (autoload 'mhc-mode "mhc" nil t)
6884 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6885 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6893 (autoload 'mhc-wl-setup "mhc-wl")
6894 (add-hook 'wl-init-hook 'mhc-wl-setup)
6898 @node Addrbook, mime-w3m, MHC, Living with other packages
6899 @subsection wl-addrbook.el
6903 (@uref{http://www.mew.org/})
6905 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6906 @code{load-path} and do the following settings.
6910 (require 'wl-addrbook)
6915 @node mime-w3m, , Addrbook, Living with other packages
6916 @subsection mime-w3m.el
6919 You can display html part by using @file{mime-w3m.el}
6920 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6921 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6924 @node Highlights, Biff, Living with other packages, Customization
6927 @subsection Customizable Variables
6930 @item wl-summary-highlight
6931 @vindex wl-summary-highlight
6932 The initial setting is @code{t}.
6933 If non-nil, the summary is highlighted.
6935 @item wl-highlight-max-summary-lines
6936 @vindex wl-highlight-max-summary-lines
6937 The initial setting is 10000.
6938 The summary is not highlighted if it has more lines than this value.
6940 @item wl-summary-highlight-partial-threshold
6941 @vindex wl-summary-highlight-partial-threshold
6942 The initial setting is 1000.
6943 This is a threshold whether the whole summary is highlighted.
6944 If there are more lines of messages in the summary, it is partially
6947 @item wl-summary-partial-highlight-above-lines
6948 @vindex wl-summary-partial-highlight-above-lines
6949 The initial setting is 30. If there are more lines of messages than
6950 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6951 after the point that is the same number of lines as this value above the
6952 cursor line are highlighted partially. (If this value is @code{nil},
6953 the last same number of lines as the value of
6954 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6956 @item wl-highlight-body-too
6957 @vindex wl-highlight-body-too
6958 The initial setting is @code{t}.
6959 If non-nil, bodies of drafts and messages are also highlighted.
6961 @item wl-highlight-message-header-alist
6962 @vindex wl-highlight-message-header-alist
6963 When highlighting headers of drafts and messages, this variable
6964 specifies which faces are allocated to important
6965 (@code{wl-highlight-message-important-header-contents}), secondly
6966 important (@code{wl-highlight-message-important-header-contents2}), and
6967 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6969 Similarly, it can be used for allocating arbitrary faces to arbitrary
6970 regular expressions.
6972 @item wl-highlight-citation-prefix-regexp
6973 @vindex wl-highlight-citation-prefix-regexp
6974 Specifies a regular expression to which quoted lines in bodies of
6975 drafts and messages match.
6976 Bodies matching to this regular expression are highlighted by the faces
6977 specified by (@code{wl-highlight-message-cited-text-*}).
6979 @item wl-highlight-highlight-citation-too
6980 @vindex wl-highlight-highlight-citation-too
6981 The initial setting is @code{nil}.
6982 If non-nil, the quoting regular expression itself given by
6983 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6985 @item wl-highlight-citation-header-regexp
6986 @vindex wl-highlight-citation-header-regexp
6987 Specifies a regular expression that denotes beginning of quotation.
6988 Bodies matching to this regular expression are highlighted by the face
6989 specified by @code{wl-highlight-message-headers}.
6991 @item wl-highlight-max-header-size
6992 @vindex wl-highlight-max-header-size
6993 The initial setting is @code{nil}. If a header size is larger than this
6994 value, it will not be highlighted. If @code{nil}, always highlighted
6995 (ignore header size).
6997 @item wl-highlight-max-message-size
6998 @vindex wl-highlight-max-message-size
6999 The initial setting is 10000.
7000 If a message is larger than this value, it will not be highlighted.
7001 With this variable, highlight is suppressed for uuencode or huge digest
7004 @item wl-highlight-signature-separator
7005 @vindex wl-highlight-signature-separator
7006 Specifies regular expressions that denotes the boundary of a signature.
7007 It can be a regular expression, or a list of ones.
7008 Messages after the place that matches this regular expression are
7009 highlighted by the face specified by
7010 @code{wl-highlight-message-signature}.
7012 @item wl-max-signature-size
7013 @vindex wl-max-signature-size
7014 The initial setting is 400.
7015 This is the largest size for a signature to be highlighted.
7017 @item wl-use-highlight-mouse-line
7018 @vindex wl-use-highlight-mouse-line
7019 The initial setting is @code{t}.
7020 If non-nil, the line pointed by the mouse is highlighted in the folder
7021 mode, summary mode, and the like.
7024 @subsection Setting Colors and Fonts of the Characters
7026 If you want to change colors or fonts of the characters, you need to
7027 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7028 want to change fonts, and @code{set-face-foreground} for colors, and so
7029 on. You cannot write face settings in @file{.emacs}; write in
7032 For example, if you want to change the color for signatures to yellow,
7036 (set-face-foreground 'wl-highlight-message-signature "yellow")
7042 Faces defined in Wanderlust:
7045 @item wl-highlight-message-headers
7046 The face for field names of message headers.
7048 @item wl-highlight-message-header-contents
7049 The face for field bodies of message headers.
7051 @item wl-highlight-message-important-header-contents
7052 The face for important parts of message headers.
7053 Per default, this face is used for a body of @samp{Subject:} field.
7054 You can change its value by editing
7055 @code{wl-highlight-message-header-alist}.
7057 @item wl-highlight-message-important-header-contents2
7058 The face for secondly important parts of message headers.
7059 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7060 fields. You can change its value by editing
7061 @code{wl-highlight-message-header-alist}.
7063 @item wl-highlight-message-unimportant-header-contents
7064 The face for unimportant parts of message headers.
7065 Per default, this face is used for bodies of @samp{X-} fields
7066 @samp{User-Agent:} fields. You can change its value by editing
7067 @code{wl-highlight-message-header-alist}.
7069 @item wl-highlight-message-citation-header
7070 The face for headers of quoted messages.
7072 @item wl-highlight-message-cited-text-*
7073 The face for texts of quoted messages. The last @samp{*} is a
7074 @var{single figure} so that 10 different colors can be used according to
7077 @item wl-highlight-message-signature
7078 The face for signatures of messages. The initial settings are
7079 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7080 dark background colors.
7082 @item wl-highlight-header-separator-face
7083 The face for header separators of draft messages.
7085 @item wl-highlight-summary-important-face
7086 The face for message lines with important marks in the summary.
7088 @item wl-highlight-summary-new-face
7089 The face for message lines with new marks in the summary.
7091 @item wl-highlight-summary-displaying-face
7092 The face for the message line that is currently displayed.
7093 This face is overlaid.
7095 @item wl-highlight-thread-indent-face
7096 The face for the threads that is currently displayed.
7098 @item wl-highlight-summary-unread-face
7099 The face for message lines with unread marks in the summary.
7101 @item wl-highlight-summary-deleted-face
7102 The face for message lines with delete marks in the summary.
7104 @item wl-highlight-summary-refiled-face
7105 The face for message lines with re-file marks in the summary.
7107 @item wl-highlight-refile-destination-face
7108 The face for re-file information part of message lines with re-file
7109 marks in the summary.
7111 @item wl-highlight-summary-copied-face
7112 The face for message lines with copy marks in the summary.
7114 @item wl-highlight-summary-target-face
7115 The face for message lines with target marks @samp{*} in the summary.
7117 @item wl-highlight-summary-thread-top-face
7118 The face for message lines that are on the top of the thread in the
7121 @item wl-highlight-summary-normal-face
7122 The face for message lines that are not on top of the thread in the
7125 @item wl-highlight-folder-unknown-face
7126 The face for folders that are not known to have how many unsync messages
7129 @item wl-highlight-folder-zero-face
7130 The face for folders that have no unsync messages in the folder mode.
7132 @item wl-highlight-folder-few-face
7133 The face for folders that have some unsync messages in the folder mode.
7135 @item wl-highlight-folder-many-face
7136 The face for folders that have many unsync messages in the folder mode.
7137 The boundary between `some' and `many' is specified by the variable
7138 @code{wl-folder-many-unsync-threshold}.
7140 @item wl-highlight-folder-unread-face
7141 The face for folders that have no unsync but unread messages in the
7144 @item wl-highlight-folder-killed-face
7145 The face for folders that are deleted from the access group in the
7148 @item wl-highlight-folder-opened-face
7149 The face for open groups in the folder mode.
7150 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7151 @code{nil} or a @var{number}.
7153 @item wl-highlight-folder-closed-face
7154 The face for close groups in the folder mode.
7155 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7156 @code{nil} or a @var{number}.
7158 @item wl-highlight-folder-path-face
7159 The face for the path to the currently selected folder in the folder
7162 @item wl-highlight-logo-face
7163 The face for logo in the demo.
7165 @item wl-highlight-demo-face
7166 The face for strings (for example, a version number) in the demo.
7170 @node Biff, Advanced Settings, Highlights, Customization
7171 @section Notify Mail arrival
7174 Following setting is to notify mail arrival of @samp{%inbox}
7175 by the indicator on the modeline
7178 (setq wl-biff-check-folder-list '("%inbox"))
7181 @subsection Customizable Variables
7183 @item wl-biff-check-folder-list
7184 @vindex wl-biff-check-folder-list
7185 The initial setting is @code{nil}.
7186 This is the list of folders to check mail arrival.
7187 If @code{nil}, wl doesn't check mail arrival.
7189 @item wl-biff-check-interval
7190 @vindex wl-biff-check-interval
7191 The initial setting is 40 (in seconds).
7192 Check mail arrival in this period.
7194 @item wl-biff-notify-hook
7195 @vindex wl-biff-notify-hook
7196 This hook is run at the arrival of new mail.
7197 To beep with mail arrival(initial setting), set as follows.
7199 (setq wl-biff-notify-hook '(ding))
7201 For silence, set to @code{nil}.
7205 @node Advanced Settings, Customizable Variables, Biff, Customization
7206 @section Advanced Settings
7209 * Draft for Reply:: Draft for Reply
7210 * Thread Format:: Appearance of Thread
7211 * User-Agent Field:: @samp{User-Agent:} Header Field
7215 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
7216 @subsection Draft for Replay
7217 @vindex wl-draft-reply-with-argument-list
7218 @vindex wl-draft-reply-without-argument-list
7219 @vindex wl-draft-reply-myself-with-argument-list
7220 @vindex wl-draft-reply-myself-without-argument-list
7222 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
7223 The addressee for the draft is decided by following rules.
7225 For example, you can set as follows:
7229 (setq wl-draft-reply-without-argument-list
7230 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7231 ("Followup-To" . (nil nil ("Followup-To")))
7232 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7233 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
7237 Where each element of the list @code{wl-draft-reply-without-argument-list}
7241 (key . (to-list cc-list newsgroup-list))
7244 and if the field designated by @samp{key} exist in the parent message,
7245 parent's field values designated by @samp{to-list} are copied to @samp{To:}
7246 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
7247 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
7248 the draft respectively.
7253 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7256 Match if the parent has @samp{Mail-Followup-To} field.
7257 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
7258 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
7262 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7265 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
7266 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
7269 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
7272 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
7273 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
7276 These are evaluated in order and first matched one is used.
7278 Moreover, the behavior of @kbd{a} with prefix argument can
7279 be directed by @code{wl-draft-reply-with-argument-list} as well.
7281 By the way, you can use some function (will be evaluated in the parent
7282 message buffer) in the place of @samp{key} or @samp{to-list} etc.
7283 For example, if you only want to reply to mailing lists in
7284 @code{wl-subscribed-mailing-list} if the parent has some of them,
7289 (defun wl-mailing-list-addresses ()
7293 (nth 1 (std11-extract-address-components addr)))
7296 (elmo-multiple-fields-body-list (list "To" "Cc"))
7298 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
7299 (setq list-addrs (cons to list-addrs))))
7300 (nreverse list-addrs)))
7302 (setq wl-draft-reply-with-argument-list
7303 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
7304 ("Reply-To" . (("Reply-To") nil nil))
7305 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
7306 ("From" . (("From") nil nil))))
7311 Note: To set the behavior when you reply to the message written by yourself,
7312 use @code{wl-draft-reply-myself-without-argument-list} and
7313 @code{wl-draft-reply-myself-with-argument-list} instead of them.
7315 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
7316 @subsection Appearance of Threads
7320 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
7321 390 09/18(Fri)07:25 +-[ Tsumura-san ]
7322 391 09/18(Fri)19:24 +-[ Murata-san ]
7323 392 09/20(Sun)21:49 +-[ Okunishi-san ]
7324 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
7325 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
7326 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
7327 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
7328 412 09/22(Tue)09:28 | +-[ Teranishi ]
7329 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
7330 416 09/22(Tue)12:38 | +-[ Teranishi ]
7331 395 09/20(Sun)21:49 +-[ Okunishi-san ]
7332 397 09/21(Mon)00:15 +-[ Okunishi-san ]
7336 Settings to make appearance of threads like shown above:
7340 (setq wl-thread-indent-level 2)
7341 (setq wl-thread-have-younger-brother-str "+")
7342 (setq wl-thread-youngest-child-str "+")
7343 (setq wl-thread-vertical-str "|")
7344 (setq wl-thread-horizontal-str "-")
7345 (setq wl-thread-space-str " ")
7349 If you do not want to see branches, do the following:
7353 (setq wl-thread-indent-level 2)
7354 (setq wl-thread-have-younger-brother-str " ")
7355 (setq wl-thread-youngest-child-str " ")
7356 (setq wl-thread-vertical-str " ")
7357 (setq wl-thread-horizontal-str " ")
7358 (setq wl-thread-space-str " ")
7363 @node User-Agent Field, , Thread Format, Advanced Settings
7364 @subsection User-Agent Field
7368 If you are eccentric enough to elaborate @samp{X-Mailer:} or
7369 @samp{User-Agent:} fields, define a function that generate appropriate
7370 strings as you like, and set it to variable
7371 @code{wl-generate-mailer-string-function}.
7373 If you do not want verbose @samp{User-Agent:} field, do the following:
7377 (setq wl-generate-mailer-string-function
7378 'wl-generate-user-agent-string-1)
7382 The following is a example:
7386 (setq wl-generate-mailer-string-function nil)
7387 (setq wl-draft-additional-header-alist
7389 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
7394 @node Customizable Variables, Hooks, Advanced Settings, Customization
7395 @section Customizable Variables
7397 Customizable variables that have not been described yet:
7400 @item wl-default-folder
7401 @vindex wl-default-folder
7402 The initial setting is @samp{%inbox}. This is the default value for moving to
7403 a folder and the like.
7405 @item wl-draft-folder
7406 @vindex wl-draft-folder
7407 The initial setting is @samp{+draft}. It is the folder to which drafts are
7408 saved. It must be a localdir folder.
7410 @item wl-trash-folder
7411 @vindex wl-trash-folder
7412 The initial setting is @samp{+trash}. It is the wastebasket folder.
7413 If you changed this variable, you had better restart Wanderlust.
7415 @item wl-interactive-exit
7416 @vindex wl-interactive-exit
7417 The initial setting is @code{t}.
7418 If non-nil, you are asked for confirmation when Wanderlust terminates.
7420 @item wl-interactive-send
7421 @vindex wl-interactive-send
7422 The initial setting is @code{t}.
7423 If non-nil, you are asked for confirmation when mail is sent.
7425 @item wl-folder-sync-range-alist
7426 @vindex wl-folder-sync-range-alist
7427 The initial setting is the alist shown below:
7432 ("^\\+draft$\\|^\\+queue$" . "all"))
7437 This is an associative list of regular expressions of folder names and
7438 update range of the summary. Update range is one of the @samp{all},
7439 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
7440 @samp{last}. If a folder do not match, @samp{update} is used.
7443 @vindex wl-ask-range
7444 The initial setting is @code{t}.
7445 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
7446 for updating the summary when you changed folders.
7448 @item wl-mime-charset
7449 @vindex wl-mime-charset
7450 The initial setting is @code{x-ctext}.
7451 This is the MIME charset for messages that are not MIME (e.g. without
7452 @samp{Content-Type:}). This value also used as default charset for
7453 summary. (If you want to share Summary on Nemacs and other Emacsen, set
7454 this value as @code{iso-2022-jp}.)
7456 @item wl-highlight-folder-with-icon
7457 @vindex wl-highlight-folder-with-icon
7458 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
7459 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
7461 @item wl-strict-diff-folders
7462 @vindex wl-strict-diff-folders
7463 This is a list of regular expressions of folders.
7464 Unread messages are checked, for example when you press @kbd{s} in
7465 the folder mode, usually in a brief way (rapidly processed but not
7467 The folders matching this variable are seriously checked.
7468 You may want to set this variable so as to match conditional filter
7469 folders for IMAP4 folders.
7470 The initial setting is @code{nil}.
7472 @item wl-folder-use-server-diff
7473 @vindex wl-folder-use-server-diff
7474 When unread messages are checked, for example when you press @kbd{s} in
7475 the folder mode, usually (the number of messages on the server) @minus{}
7476 (the number of local messages) will be the number of unread messages.
7477 However, if this variable is non-nil, the number of unread messages on
7478 the server is checked. This affects IMAP4 folders only, but IMAP4
7479 folders in mail boxes matching
7480 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
7481 the number of unread messages on the server, even if they matches this
7482 variable. The initial setting is @code{t}.
7484 @item wl-auto-check-folder-name
7485 @vindex wl-auto-check-folder-name
7486 The initial setting is @code{nil}.
7487 You can specify a folder or a group which is checked for unread message
7488 at the start. You can also specify a list of folders (groups) to be checked.
7489 If the value is @code{nil}, whole Desktop is checked at the start.
7490 If it is @code{none}, no folders are checked.
7492 @item wl-auto-uncheck-folder-list
7493 @vindex wl-auto-uncheck-folder-list
7494 The initial setting is the list shown below:
7503 You can set a list of regular expressions to specify folders
7504 which are not automatically checked even if they are included
7505 in some groups assigned by @code{wl-auto-check-folder-name}.
7507 @item wl-auto-check-folder-list
7508 @vindex wl-auto-check-folder-list
7509 The initial setting is @code{nil}.
7510 You can set a list of regular expressions to specify exceptions
7511 for @code{wl-auto-uncheck-folder-list}.
7513 @item wl-no-save-folder-list
7514 @vindex wl-no-save-folder-list
7515 The initial setting is the list shown below:
7524 This is a list of regular expressions of folders not to be saved.
7526 @item wl-save-folder-list
7527 @vindex wl-save-folder-list
7528 The initial setting is @code{nil}.
7529 This is a list of regular expressions of folders to be saved.
7530 This takes precedence over @code{wl-no-save-folder-list}.
7532 @item wl-folder-mime-charset-alist
7533 @vindex wl-folder-mime-charset-alist
7534 The initial setting is the alist shown below:
7538 (("^-alt\\.chinese" . big5)
7539 ("^-relcom\\." . koi8-r)
7541 ("^-han\\." . euc-kr))
7546 This is an associative list of regular expressions of folder names and
7548 If a folder do not match, @code{wl-mime-charset} is used.
7550 @item wl-folder-init-load-access-folders
7551 @vindex wl-folder-init-load-access-folders
7552 The initial setting is @code{nil}.
7553 This is a list of access groups to be loaded specifically at the start.
7554 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7556 @item wl-folder-init-no-load-access-folders
7557 @vindex wl-folder-init-no-load-access-folders
7558 The initial setting is @code{nil}.
7559 This is a list of access groups not to be loaded specifically at the
7561 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7563 @item wl-delete-folder-alist
7564 @vindex wl-delete-folder-alist
7565 The initial setting is the alist shown below:
7574 This list determines disposition of messages with delete marks.
7575 Each item in the list is a folder and destination; you can specify any
7576 one of the following in the place of destination:
7579 @code{remove} or @code{null} : deletes the messages instantly.
7580 string : moves the messages to the specific folder.
7581 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7584 @item wl-refile-policy-alist
7585 @vindex wl-refile-policy-alist
7586 The initial setting is the list shown below:
7596 This list determines whether messages with re-file marks are moved or
7597 copied. Each item in the list is a cons cell of a folder and
7598 @code{copy} or @code{move}.
7600 @item wl-x-face-file
7601 @vindex wl-x-face-file
7602 The initial setting is @file{~/.xface}.
7603 The name of the file that contains encoded X-Face strings.
7606 @item wl-demo-display-logo
7607 @vindex wl-demo-display-logo
7608 If non-nil, bitmap image is shown on the opening demo. If you set
7609 @code{xpm} or @code{xbm}, (if possible) display selected image type
7612 @item elmo-use-database
7613 @vindex elmo-use-database
7614 This is meaningful for XEmacs only. The initial setting depends on
7615 XEmacs (@code{t} for XEmacs with dbm).
7616 If non-nil, Message-ID is controlled by dbm.
7618 @item elmo-passwd-alist-file-name
7619 @vindex elmo-passwd-alist-file-name
7620 The initial setting is @file{passwd}.
7621 This is the name of the file in which passwords are saved.
7622 @code{elmo-passwd-alist-save} saves current passwords to the file.
7624 @item elmo-nntp-list-folders-use-cache
7625 @vindex elmo-nntp-list-folders-use-cache
7626 The initial setting is 600 (in seconds).
7627 This is period in seconds during which results of @samp{list} and
7628 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7631 @item elmo-nntp-max-number-precedes-list-active
7632 @vindex elmo-nntp-max-number-precedes-list-active
7633 The initial setting is @code{nil}.
7634 If non-nil, the number of article obtained by @samp{list active} in NNTP
7635 are used as the maximum article number of the folder.
7636 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7637 and if the number of read messages is not correct.
7639 @item elmo-nntp-default-use-listgroup
7640 @vindex elmo-nntp-default-use-listgroup
7641 The initial setting is @code{t}.
7642 If non-nil, @samp{listgroup} is used for checking the total number of
7643 articles. If it is @code{nil}, @samp{group} is used. In the latter
7644 case, the processing will be a little faster at the sacrifice of
7647 @item elmo-pop3-send-command-synchronously
7648 @vindex elmo-pop3-send-command-synchronously
7649 The initial setting is @code{nil}.
7650 If non-nil, POP3 commands are issued synchronously. Some implementation
7651 of POP3 server fails to get summary information without this setting.
7652 You may have to set this variable to @code{t}, if the process hangs
7653 while looking up POP3.
7655 @item elmo-dop-flush-confirm
7656 @vindex elmo-dop-flush-confirm
7657 The initial setting is @code{t}.
7658 If non-nil, you are asked for confirmation if accumulated off-line
7659 operations are executed.
7661 @item elmo-display-progress-threshold
7662 @vindex elmo-display-progress-threshold
7663 The initial setting is 20.
7664 Threshold for display of progress gauge. If number of renewal is more than
7665 this value, display progress gauge.
7669 @node Hooks, , Customizable Variables, Customization
7674 @node Terminology, Mailing List, Customization, Top
7675 @chapter Terminology around Wanderlust
7678 Here we explain terminologies used in this manual.
7682 A container in which messages are stored.
7685 A set consists of some folders.
7688 A special group consists of automatically collected folders under
7689 some specified path.
7690 @xref{Folder Definition}.
7692 @item summary buffer
7693 A buffer for displaying list of messages in some folder.
7695 @item sticky summary
7696 Compared with ordinary summary buffer which will be destroyed after
7697 exiting from it, this type of summary will be remain even after exiting
7698 by @kbd{q} or @kbd{g}.
7699 @xref{Sticky Summary}.
7702 To delete or put into the archive expired messages.
7709 To cache messages beforehand in order to read messages after you will be
7710 disconnected from the server.
7714 @node Mailing List, Addition, Terminology, Top
7715 @chapter Wanderlust Mailing List
7719 Topics related to Wanderlust are discussed in following mailing lists.
7720 The latest version is also announced there.
7723 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7726 In this list Japanese is mainly used for discussion. We also have a list
7727 for discussion in English:
7730 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
7732 (Messages posted to this list are also forwarded to the former one.)
7734 A guide can be obtained automatically by sending mail to
7735 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
7736 the English one) with the body
7742 Please send bug reports or patches to one of those lists. You can post to
7743 the mailing list even though you are not a member of it.
7745 If you send a bug report, please attach Backtrace with it.
7746 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7749 I would like to express my thanks to the members of the mailing list for
7750 valuable advice and many pieces of code they contributed.
7753 @node Addition, Index, Mailing List, Top
7754 @chapter Additional Information
7756 @section Brief History
7759 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7760 3/10 Made a msgdb mechanism by elisp.
7761 3/26 IMAP and NNTP can be displayed in threads.
7762 4/13 Began to assemble thread display modules as elmo.
7763 5/01 Finished 0.1.0, initial version with many defects.
7764 6/12 I made a slip of the tongue and said I was writing elisp
7765 mailer supporting IMAP
7766 6/16 0.1.3 was announced at tm-ja, elisp ML.
7767 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7768 7/01 Support for mm-backend (0.3.0).
7769 8/25 multi folder added (0.5.0).
7770 8/28 filter folder added (0.5.1).
7771 9/10 You can open/close threads (0.6.0).
7772 9/11 fldmgr by Murata-san made editing folders easy.
7773 9/18 lha folders added by Okunishi-san (0.6.3).
7774 9/24 Display of branches of threads (0.6.5).
7775 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7776 10/28 Off-line operations (0.7.4).
7777 12/09 Becomes beta version.
7778 12/21 wl-expire by Murata-san.
7779 1999 2/03 auto-refile by Tsumura-san.
7780 4/28 wl-template by Murata-san.
7781 5/18 Released 1.0.0 stable.
7782 7/05 Scoring by Murata-san (2.1.0).
7783 9/26 New plugged system by Murata-san (2.2.2).
7784 12/20 Support Modified UTF7.
7785 2000 3/24 Released 1.1.0 stable.
7786 4/03 CVS development started.
7787 5/07 Thread restoration & Its speed up with Murata-san.
7788 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7789 7/11 killed message feature.
7790 7/18 Use UIDL in POP3.
7791 9/12 biff feature with Satata-san & Yamaoka-san.
7792 10/17 expire-hide by Okada-san.
7793 11/08 Released 2.4.0 stable.
7794 2001 7/04 Released 2.6.0 stable.
7795 8/21 wl-addrmgr by Kitamoto-san.
7796 12/27 Released 2.8.1 stable.
7799 See @file{ChangeLog} for details.
7803 According to a dictionary, Wanderlust has the meaning:
7807 n eager longing for or impulse towards travelling in distant lands
7808 [Ger, fr wandern to wander + lust desire, pleasure]
7812 but I had no profound intention. (if farfetched, IMAP @result{} you can
7813 read mail anywhere @result{} desire to wander ?)
7815 Elmo is the abbreviation of @samp{Elisp Library for Message
7816 Orchestration}. At first I meant the red puppet in the Sesame Street,
7817 but you may associate it with Wandering @result{} Drifting @result{}
7818 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7822 Each versions has code names (they are almost jokes).
7823 Currently they are picked up alphabetically from the top 40 hits of
7824 U.S. Billboard magazines in 1980s.
7826 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7829 @node Index, , Addition, Top
7833 * Concept Index:: Concept Index
7834 * Key Index:: Key Index
7835 * Variable Index:: Variable Index
7836 * Function Index:: Function Index
7839 @node Concept Index, Key Index, Index, Index
7840 @unnumberedsec Concept Index
7843 @node Key Index, Variable Index, Concept Index, Index
7844 @unnumberedsec Key Index
7847 @node Variable Index, Function Index, Key Index, Index
7848 @unnumberedsec Variable Index
7851 @node Function Index, , Variable Index, Index
7852 @unnumberedsec Function Index