1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
11 @dircategory GNU Emacs Lisp
13 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
16 @c permissions text appears in an Info file before the first node.
18 This file documents Wanderlust, Yet another message interface on
21 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
22 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
23 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada},
24 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
26 This edition is for Wanderlust version @value{VERSION}.
28 Permission is granted to make and distribute verbatim copies of this
29 manual provided the copyright notice and this permission notice are
30 preserved on all copies.
33 Permission is granted to process this file through TeX and print the
34 results, provided the printed document carries copying permission notice
35 identical to this one except for the removal of this paragraph (this
36 paragraph not being relevant to the printed manual).
39 Permission is granted to copy and distribute modified versions of this
40 manual under the conditions for verbatim copying, provided that the
41 entire resulting derived work is distributed under the terms of a
42 permission notice identical to this one.
44 Permission is granted to copy and distribute translations of this manual
45 into another language, under the above conditions for modified versions.
51 @title Wanderlust User's Manual
52 @subtitle Yet another message interface on Emacsen
53 @subtitle for Wanderlust version @value{VERSION}
54 @author Yuuichi Teranishi
55 @author Fujikazu Okunishi
56 @author Masahiro Murata
58 @author Kaoru Takahashi
60 @author Masayuki Osada
61 @author Katsumi Yamaoka
63 @author Yoichi Nakayama
66 @vskip 0pt plus 1filll
67 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
68 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
69 @w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
70 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
72 This manual is for Wanderlust version @value{VERSION}.
74 Permission is granted to make and distribute verbatim copies of this
75 manual provided the copyright notice and this permission notice are
76 preserved on all copies.
78 Permission is granted to copy and distribute modified versions of this
79 manual under the conditions for verbatim copying, provided that the
80 entire resulting derived work is distributed under the terms of a
81 permission notice identical to this one.
83 Permission is granted to copy and distribute translations of this manual
84 into another language, under the above conditions for modified versions.
90 @node Top, Introduction, (dir), (dir)
91 @top Wanderlust User's Manual
106 This manual is for Wanderlust @value{VERSION}.
111 * Introduction:: Read this first
112 * Start Me Up:: Invoking Wanderlust
113 * Folders:: How to specify folders
114 * Folder:: Selecting and editing folders
115 * Summary:: Reading and refiling messages
116 * Message:: Saving and playing MIME multipart entities
117 * Draft:: Draft buffer, sending mail and news
118 * Disconnected Operations:: Off-Line management
119 * Expire and Archive:: Automatic expiration and archiving of messages
120 * Scoring:: Score of the messages
121 * Split messages:: Splitting messages
122 * Address Book:: Management of Address Book
123 * Spam Filter:: Spam filtering
124 * Customization:: Customizing Wanderlust
125 * Terminology:: Terminologies
126 * Mailing List:: Wanderlust mailing list
127 * Addition:: Additional Information
132 @node Introduction, Start Me Up, Top, Top
133 @chapter Introduction of Wanderlust
136 Wanderlust is an mail/news management system on Emacsen.
137 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
139 The main features of Wanderlust:
142 @item Pure elisp implementation.
143 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
144 @item Unified access method to messages based on Mew-like Folder Specification.
145 @item Mew-like Key-bind and mark handling.
146 @item Manages unread messages.
147 @item Interactive thread display.
148 @item Folder Mode shows the list of subscribed folders.
149 @item Message Cache, Disconnected Operation.
150 @item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed).
151 @item MIME compliant (by SEMI).
152 @item Transmission of news and mail are unified by Message transmitting draft.
153 @item Graphical list of folders (XEmacs and Emacs 21).
154 @item View a part of message without retrieving the whole message (IMAP4).
155 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
156 @item Virtual Folders.
157 @item Supports compressed folder using common archiving utilities.
158 @item Old articles in folders are automatically removed/archived (Expiration).
159 @item Automatic re-file.
160 @item Template function makes it convenient to send fixed form messages.
166 We confirm Wanderlust works on following Emacsen:
169 @item Mule 2.3 based on Emacs 19.34
170 @item Emacs 20.2 or later
171 @item XEmacs 20.4 or later
172 @item Meadow 1.00 or later
173 @item NTEmacs 20.4 or later
177 IMAP4 connectivity with following imapd are confirmed to work with
181 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
182 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
183 @item Courier-IMAP 1.3.2 or later
184 @item AIR MAIL (AIRC imapd release 2.00)
186 @item Microsoft Exchange Server 5.5
187 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
190 LDAP connectivity with following LDAPd are confirmed to work with
194 @item OpenLDAP 2.0.6 or later
198 @node Start Me Up, Folders, Introduction, Top
199 @chapter Start up Wanderlust
202 The necessary procedure for starting Wanderlust is explained in steps
205 (Of course, you need a mail/news readable environment in advance)
208 * MIME Modules:: Installing the MIME modules
209 * Download:: Download and extract the packages
210 * Install:: Byte-compile and install
211 * Minimal Settings:: @file{.emacs} setup
212 * Folder Definition:: Folder definition
213 * Start Wanderlust:: Starting Wanderlust
214 * Overview:: Basic components of Wanderlust
218 @node MIME Modules, Download, Start Me Up, Start Me Up
219 @section Installing MIME modules
225 You must install SEMI beforehand to use Wanderlust.
227 SEMI can be downloaded from following site:
231 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
235 You need packages named APEL and FLIM to use SEMI.
236 You can download APEL and FLIM from following URLs:
240 APEL: ftp://ftp.m17n.org/pub/mule/apel/
241 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
245 You have to install APEL, FLIM and SEMI in this order. Generally,
246 @samp{make install} will do the job. (In XEmacs 21, @samp{make
249 Refer to the documents of each package for detailed installation
250 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
251 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
255 Recommended combination of APEL, FLIM and SEMI are following:
258 @item APEL 10.6, FLIM 1.14.6 and SEMI 1.14.6
261 You can also use many other FLIM/SEMI variants. Combination of the
262 latest versions should work. For example, the following combination are
266 @item APEL 10.6, SLIM 1.14.9, SEMI 1.14.5
267 @item APEL 10.6, CLIME 1.14.5, EMIKO 1.14.1
270 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
273 @node Download, Install, MIME Modules, Start Me Up
274 @section Download and Extract the Package
277 You can download Wanderlust package from following sites:
281 ftp://ftp.gohome.org/wl/
284 Mirrored ftp/http sites:
288 @c ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
289 http://www.jpl.org/elips/wl/
290 http://www.ring.gr.jp/archives/text/elisp/wl/
291 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
295 Extract the obtained package to your working directory:
300 % tar zxvf wl-@var{version}.tar.gz
301 % cd wl-@var{version}
305 @subsection To use SSL (Secure Socket Layer)
310 SSL (Secure Socket Layer) can be used for
311 SMTP, IMAP, NNTP and POP connections in Wanderlust.
313 There are two ways to use SSL. One is to start SSL negotiation just
314 after the connection establishment (generic way). The other one is to
315 start SSL negotiation by invoking STARTTLS command in the each session.
317 To use the formal SSL (generic SSL), you must set @env{PATH} to the
318 directory that OpenSSL commands are installed.
320 To use the latter SSL(STARTTLS), you must install starttls package in
322 You can download starttls package from the following site.
325 ftp://opaopa.org/pub/elisp/
328 @node Install, Minimal Settings, Download, Start Me Up
329 @section Byte-compile and install
336 @subsection Installation
338 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
339 Set the Emacs's command name to @code{EMACS}.
340 Set package installation directory to @code{LISPDIR}.
341 Then, please execute following commands.
350 Destination directory is auto-probed if you leave @code{LISPDIR}
351 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
353 If you are using an Emacs variant which does not merge specified directory
354 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
355 then you will see the error message:
358 Cannot open load file: mime-setup
362 In this case, either add destination directories of custom, APEL, FLIM
363 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
364 @code{load-path} in @file{WL-CFG} in extracted directory.
366 If you want to handle shimbun folders or to use BBDB, add directory
367 where emacs-w3m or BBDB is installed to @code{load-path}. Then necessary
368 modules will be byte-compiled and installed.
369 @xref{Shimbun Folder}, @xref{BBDB}.
371 @subsection @file{WL-CFG}
373 Contents of the file @file{WL-CFG} is loaded under installation if a file
374 with that name exists in extracted directory. You can use @file{WL-CFG} to
375 configure @code{load-path} to extra packages such as SEMI if needed.
377 If you want to specify the install directory of Wanderlust related
378 files, then set following variables in @file{WL-CFG}
382 A directory to install WL modules.
383 This directory is relative directory from @code{LISPDIR}.
384 WL modules include @file{wl*.el}, @file{wl*.elc} files.
385 @c Modules under the directory @file{util/} are also installed if
386 @c it detected as necessary.
389 A directory to install ELMO modules.
390 This directory is relative directory from @code{LISPDIR}.
391 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
392 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
396 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
398 If you want to install ELMO related files under a sub-directory
399 such as "elmo" then add following to @file{WL-CFG}:
402 (setq ELMO_PREFIX "elmo")
405 @subsection Install as a XEmacs package
406 @cindex XEmacs package
407 @cindex XEmacs package install
408 @cindex Package, XEmacs
409 @cindex Package install, XEmacs
410 @c @cindex install-package
412 It is possible to install Wanderlust as one of packages of XEmacs (21.0
413 or later). Configuration for autoload and icon-path in local
414 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
417 Follow the next example to install Wanderlust as an XEmacs package.
423 % make install-package
427 package directory is auto-probed, if SEMI is installed.
428 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
430 @subsection Run in place
432 If wl and elmo directories are defined in @code{load-path}, then
433 byte-compilation and installation are not necessary to start Wanderlust.
434 For example, if package is extracted in @file{~/work}, Wanderlust can be
435 invoked with following setting in @file{~/.emacs}.
439 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
440 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
446 Manual is described in Info format. Please do following.
455 If you install Wanderlust as a XEmacs package, Info file is already
456 installed too, so there are no need of these commands.
458 Manual directory is automatically detected. Of course, it can be
459 configured by @code{INFODIR} in @file{Makefile}.
461 You can read manual at the following URL:
464 http://www.gohome.org/wl/doc/wl_toc.html
467 @node Minimal Settings, Folder Definition, Install, Start Me Up
468 @section Set up .emacs
469 @cindex Minimal Settings
471 @cindex Configuration
475 The Wanderlust package contains two module groups.
478 @item ELMO (elmo-*.el)
479 These modules show everything as folders. This is the back-end for WL.
481 These modules controls the behavior of main body of Wanderlust.
482 They are also the front-end for ELMO.
485 You can customize the behavior of Wanderlust by changing the value
486 of environmental variables which begins with @code{elmo-} and @code{wl-}.
488 The minimal requirement for settings is as the following.
492 ;; @r{autoload configuration}
493 ;; @r{(Not required if you have installed Wanderlust as XEmacs package)}
494 (autoload 'wl "wl" "Wanderlust" t)
495 (autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
496 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
498 ;; @r{Directory where icons are placed.}
499 ;; @r{Default: the peculiar value to the running version of Emacs.}
500 ;; @r{(Not required if the default value points properly)}
501 (setq wl-icon-directory "~/work/wl/etc")
503 ;; @r{SMTP server for mail posting. Default: @code{nil}}
504 (setq wl-smtp-posting-server "your.smtp.example.com")
505 ;; @r{NNTP server for news posting. Default: @code{nil}}
506 (setq wl-nntp-posting-server "your.nntp.example.com")
510 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
511 file exists). So it is convenient to gather Wanderlust specific settings
512 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
513 because you can't write them in @file{.emacs}
514 (if you write it to @file{.emacs}, you'll get an error).
517 All above described settings except autoload configuration can be written
520 @subsection @code{mail-user-agent}
521 @cindex Default Mailer
522 @cindex Mailer, Default
523 @vindex mail-user-agent
526 If you write following setting in your @file{~/.emacs}, you can
527 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
528 This means it enables you to run Wanderlust as a default mail composer
531 It is effective only when your Emacs can define @code{mail-user-agent}.
532 @xref{Mail Methods, , ,emacs, The Emacs Editor}.
536 (autoload 'wl-user-agent-compose "wl-draft" nil t)
537 (if (boundp 'mail-user-agent)
538 (setq mail-user-agent 'wl-user-agent))
539 (if (fboundp 'define-mail-user-agent)
540 (define-mail-user-agent
542 'wl-user-agent-compose
551 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
552 @section Folder Definition
553 @cindex Folder Definition
556 You can skip this section because it is possible to add/edit the
557 subscribe folders from the buffer for list of folders.
558 @xref{Folder Manager}.
560 Define the folders you want to subscribe in file @file{~/.folders}. The
561 contents written in @file{~/.folders} become the folders which you
562 subscribe to as it is.
564 Format for @file{~/.folders} is very simple. Here is an example:
569 # @r{Lines begin with @samp{#} are comment.}
570 # @r{Empty lines are ignored}
572 # @var{folder name} "@var{folder nickname}"
573 # @r{(nicknames are not necessary)}
578 %#mh/Backup@@my.imap.example.com "Sent"
581 %#mh/spool/wl "Wanderlust ML"
582 %#mh/spool/elips "ELIPS ML"
583 %#mh/spool/apel-ja "APEL Japanese ML"
584 %#mh/spool/xemacs-beta "XEmacs beta"
585 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
586 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
589 # @r{If folder name ends with @samp{/}, that means an `access group',}
590 # @r{all subfolders automatically included in one folder group.}
592 %#mh/expire@@localhost /
593 # @r{All MH folders are included in one folder group.}
598 Each line contains one folder you want to read. The definition of
599 folders will be explained in detail in the next section.
601 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
602 become one folder group. One folder group is treated as a directory
603 which can be opened and closed in folder mode. It is convenient for
604 collecting some folders and putting them in order.
606 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
607 line and you have to write it that way (It is because the parser sucks).
609 There are two types of groups. One is like @samp{Emacsen} from above
610 example which the user chooses his favorite folders as a group.
612 The other one is @dfn{access group} like @samp{+ /} from above example.
613 It collects all sub-folders in the folder to make a group. (Its
614 behavior differs by the type of the folder. For example, @samp{+}
615 followed by @samp{/} makes entire MH sub-directories to one group)
617 This behavior is better understood if you try it and confirmed the
618 function first. You can write and try a small folder definition, so you
619 will know the idea of the folder function before writing the real one.
621 @node Start Wanderlust, Overview, Folder Definition, Start Me Up
622 @section Start Wanderlust
623 @cindex Start Wanderlust
625 If installation and configuration worked well, you can invoke Wanderlust by
626 typing following command in Emacs.
633 After initialization, Folder Mode which shows the list of folders will
634 appear. That means the folders you defined in the @file{~/.folders} are
637 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
638 can skip folder checking.
641 @node Overview, , Start Wanderlust, Start Me Up
645 Basically, you will handle messages in wanderlust while you come and go
646 from/to each of the following buffers. Details of each ones are
647 explained in following chapters.
651 You can see the list of folders. You can select some folder and go into the summary
652 of it. You can subscribe new folder or edit subscription list.
654 You can see the list of messages in the folder. You can select message
655 and view its contents, and reply to some message. You can delete ones or
656 move ones to another folder.
658 You can see the contents of the message. You can save part to disk or
659 open in external programs.
661 You can edit message.
665 @node Folders, Folder, Start Me Up, Top
666 @chapter Wanderlust's folders
669 This chapter describes the folder types which Wanderlust is able to handle.
671 Wanderlust uses ELMO as it's interface, so you can use every folder types
674 As of version @value{VERSION}, 13 types of folders are predefined. These
675 are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP,
676 Shimbun, Namazu, Multi, Filter, Pipe and Internal folder types.
679 * IMAP Folder:: @samp{%} -- IMAP folder
680 * NNTP Folder:: @samp{-} -- NNTP folder
681 * MH Folder:: @samp{+} -- MH folder
682 * Maildir Folder:: @samp{.} -- Maildir folder
683 * News Spool Folder:: @samp{=} -- News spool folder
684 * Archive Folder:: @samp{$} -- Archive folder
685 * POP Folder:: @samp{&} -- POP folder
686 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
687 * Namazu Folder:: @samp{[} -- Namazu Folder
688 * Multi Folder:: @samp{*} -- Multi folder
689 * Filter Folder:: @samp{/} -- Filter folder
690 * Pipe Folder:: @samp{|} -- Pipe folder
691 * Internal Folder:: @samp{'} -- Internal folder
695 @node IMAP Folder, NNTP Folder, Folders, Folders
703 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
709 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
713 You can specify @code{login} (encoded password transmission),
714 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
715 authentication) or @code{clear} (or @code{nil}, plain password
716 transmission) as @var{authenticate-type}.
721 @var{username} -> The value of @code{elmo-imap4-default-user}.
722 Initial setting is @env{USER} environment variable or
723 @env{LOGNAME} environment variable or return value of
724 @code{(user-login-name)}.
725 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
726 Initial setting is "auth".
727 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
728 Initial setting is "localhost".
729 @var{port} -> The value of @code{elmo-imap4-default-port}.
730 Initial setting is 143.
733 You can omit the @var{hostname} from folder names if you set
734 @code{elmo-imap4-default-server} as your main IMAP server.
735 For example, you can specify a folder as @samp{foo%imap@@gateway} even
736 if you have to go through a firewall.
740 ;; @r{Example: imap4.exaple.org as main IMAP server}
741 (setq elmo-imap4-default-server "imap4.example.org")
745 SSL (Secure Socket Layer) connection will be used if a folder name ends
746 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
747 is @code{ssl}, SSL will be the default connection. If a folder name
748 ends with @samp{!!}, STARTTLS connection will be established. If the
749 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
750 STARTTLS will be the default connection.
754 ;; @r{Example: Use SSL connection}
755 (setq elmo-imap4-default-stream-type 'ssl)
759 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
760 authentication method, the password is sent in encoded form. But, if
761 your server is unable to receive an encoded password, authentication
762 will fall back to @code{clear} (that is, sending password in raw format)
763 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
764 authentication will fall back to @code{clear} without confirmation
765 (default value is @code{nil}).
769 ;; @r{Example: password in raw format}
770 (setq elmo-imap4-default-authenticate-type 'clear)
778 %inbox -> IMAP mailbox "inbox"
779 %#mh/inbox -> IMAP mailbox "#mh/inbox"
781 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
782 %inbox:hoge/clear@@server1
783 -> server1's IMAP mailbox "inbox"
784 of user "hoge", with plain password authentication
789 @subsection International mailbox names (Modified UTF7)
790 @cindex Modified UTF7
797 You can use international mailbox names in @var{mailbox} part, if you
798 are using Emacs with UTF-7 support and
799 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
800 value is @code{nil}).
802 Currently, Mule-UCS package is required to use UTF-7.
803 Mule-UCS works on following Emacsen.
806 @item Emacs 20.3 or later
807 @item XEmacs 21.2.37 or later
810 You can obtain Mule-UCS package from following URL.
813 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
816 @node NNTP Folder, MH Folder, IMAP Folder, Folders
827 A folder to access USENET news via NNTP protocol (RFC 977).
828 One newsgroup is treated as a folder.
834 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
840 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
841 Initial setting is @samp{localhost}.
842 @var{username} -> The value of @code{elmo-nntp-default-user}.
843 Initial setting is @code{nil}.
844 @var{port} -> The value of @code{elmo-nntp-default-port}.
845 Initial setting is 119.
848 AUTHINFO is used as authentication method if the @var{username} is
849 non-nil. SSL will be default method if
850 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
851 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
852 STARTTLS connection will be established. if the value of
853 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
854 be the default connection.
860 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
861 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
866 @node MH Folder, Maildir Folder, NNTP Folder, Folders
873 A folder to access MH format mail (1 file is 1 mail).
878 @samp{+} @var{directory-name}
881 Normally, @var{directory-name} is an relative path to the variable
882 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
883 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
884 (this is also true for drive-letters).
886 Message number is used for the name of the message file.
892 +inbox -> @file{~/Mail/inbox}
893 +from/teranisi -> @file{~/Mail/from/teranisi}
894 +~/test -> @file{~/test}
899 @node Maildir Folder, News Spool Folder, MH Folder, Folders
900 @section Maildir Folder
902 @cindex Maildir Folder
906 A folder to access Maildir format (1 file is 1 mail).
911 @samp{.} [@var{directory-name}]
914 Normally, @var{directory-name} is a relative path to the variable
915 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
916 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
917 (this is also true for drive-letters).
919 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
920 Messages are contained in the @file{cur} directory. All message files
921 in the @file{new} directory are moved to @file{cur} directory when you
922 access the folder. All message files contained in the @file{tmp}
923 directory and not accessed for 36 hours are deleted.
925 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
931 . -> @file{~/Maildir}
932 .inbox -> @file{~/Maildir/inbox}
933 .from/teranisi -> @file{~/Maildir/from/teranisi}
934 .~/test -> @file{~/test}
939 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
940 @section News Spool Folder
942 @cindex News spool Folder
945 This folder handles locally saved news articles which are proposed by
946 Mew/IM. You can also read articles directly from a spool-file which is
947 retrieved by an utility like @command{gnspool}.
952 @samp{=} @var{directory-name}
955 @var{directory-name} is a sub-directory to the directory defined by
956 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
957 You can use @samp{.} as directory delimiter as well as @samp{/}.
963 =fj/os/os2 -> @file{~/News/fj/os/os2}
964 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
969 @node Archive Folder, POP Folder, News Spool Folder, Folders
970 @section Archive Folder
972 @cindex Archive Folder
975 This method can handle archive files, which are compressed by utilities
976 such as Info-ZIP or LHA, as one folder.
982 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
986 @var{path-name} is the relative path from
987 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
988 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
989 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
990 also permitted under the environment of ange-ftp, efs.
992 The actual file name of the archive folder is
993 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
994 under the @var{path-name}. If a file named @var{path-name} exists, it is
995 treated as folder. The suffix is automatically decided for
998 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
999 (Initial setting is @code{zip}) is referred.
1001 @var{prefix} specifies the internal directory structure of the archive.
1002 For example, if the ML server is fml, @file{msend.tar.gz} has a
1003 structure like @file{spool/1}, so you have to specify @samp{spool} as
1010 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1011 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1012 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1013 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1014 $ml;zip/ -> Access group consists of archive folders
1015 under @file{~/Mail/ml}
1020 * Archiver:: Supported Archivers
1021 * Archive Tips:: TIPS
1022 * Archive Vars:: Customization
1026 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1027 @subsection Supported Archives
1037 By default, following archives are supported.
1041 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1042 GNU TAR('tgz, 'tar) ;; read-only
1046 If your archiver can include multiple files in one archive, you have a
1047 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1048 of the candidate. TAR is supported read-only because it cannot delete
1049 file in the archive (@code{mv})).
1051 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1052 archiver of Wanderlust because they cannot include multiple
1053 files. Archivers that cannot extract files to standard output are also
1056 @subsection OS specific information about archiver.
1058 Behaviors of the following archivers are confirmed by further experiences.
1059 (@samp{*} mark means recommended archiver).
1062 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1063 LHA OS/2 version Rel.2.06b Feb 18, 1998
1064 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1065 *Zip 2.2 (November 3rd 1997).
1066 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1067 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1068 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1070 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1071 LHa for UNIX V 1.14c
1072 UnZip 5.32 of 3 November 1997
1073 Zip 2.2 (November 3rd 1997)
1074 GNU tar 1.12 (1.11.x is no good)
1075 gzip 1.2.4 (18 Aug 93)
1077 [Win32] Win.98/Meadow
1081 GNU tar 1.11.8 + 1.5(WIN32)
1088 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1089 Hiramatsu version of LHA is only supported.
1090 In Win32, LHa32 is only supported (DOS version is no good).
1092 * Caution about GNU tar
1094 You have to take care about GNU tar's version because many version has
1095 problem on deleting file from archive.
1097 Please test @option{--delete} @option{-f} options work. Otherwise, your
1098 archive will be destroyed. No problem is reported on above versions of
1102 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1104 @cindex Archive Tips
1106 For comfortable migration, usage of @code{wl-summary-archive}
1107 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1108 archive folders created by expiration, you must set non-nil value to
1109 @code{elmo-archive-treat-file}.
1111 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1112 in processing speed. For comfortable use, Emacs20 is recommended.
1113 (If re-search's performance is the problem, 19.3x or later may be okay.)
1115 If many files are included in one archive,
1116 it takes long time to access the archive folder because
1117 archiver starting overhead is increased (especially LHA).
1118 150-200 messages in one archive is recommended.
1120 Of course, following is possible @t{:-)}
1121 (meanings of these variables are described later.)
1125 (setq wl-fcc "$backup")
1126 (setq wl-trash-folder "$trash;lha")
1130 @node Archive Vars, , Archive Tips, Archive Folder
1131 @subsection Variables About Archive Folder
1132 @cindex Archive variables
1135 @item elmo-archive-default-type
1136 @vindex elmo-archive-default-type
1137 The initial setting is @code{zip}.
1138 Set archiver type by symbol.
1140 @item elmo-archive-@var{type}-method-alist
1141 @vindex elmo-archive-TYPE-method-alist
1142 Define archiver @var{type}'s methods.
1143 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1144 Each element of the alist is following.
1148 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1149 (@var{action} . @var{function}) ;; function
1153 Currently available actions are following.
1157 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1158 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1165 actions enclosed with braces are optional (They are used for better
1168 @item elmo-archive-suffix-alist
1169 @vindex elmo-archive-suffix-alist
1170 An alist of archiver-type (symbol) and suffix.
1172 @item elmo-archive-file-regexp-alist
1173 @vindex elmo-archive-file-regexp-alist
1174 An alist of a regexp to get file number from list output of archiver
1175 and archiver-type (symbol).
1177 @item elmo-archive-method-list
1178 @vindex elmo-archive-method-list
1179 A list of elmo-archive-@var{type}-method-alist
1180 (@var{type} is a symbol of archiver-type).
1182 @item elmo-archive-lha-dos-compatible
1183 @vindex elmo-archive-lha-dos-compatible
1184 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1185 DOS (Mr. Yoshizaki original) compatible.
1187 @item elmo-archive-cmdstr-max-length
1188 @vindex elmo-archive-cmdstr-max-length
1189 The initial setting is 8000.
1191 Max length of command line argument for external archiver program.
1192 Emacs does not have a limit of command line byte length, but some OS
1193 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1194 this limit because it calls external archiver program directly (not
1195 called via shell). For example, you cannot delete messages if archiver
1196 program must receive larger bytes of arguments to delete. OS/2 have a
1197 command line argument limit of 8190 bytes, so we defined default as 8000
1200 However, you don't have an influence of command line argument limit
1201 if the archiver has `actions' to receive target file information from
1202 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1206 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1214 A folder to access e-mails via POP3 protocol (RFC 1939).
1220 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1225 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1226 as @var{authenticate-type}.
1228 You can specify @samp{uidl} (use UIDL command for message numbering) or
1229 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1233 @var{username} -> The value of @code{elmo-pop3-default-user}.
1234 Initial setting is @env{USER} environment variable or
1235 @env{LOGNAME} environment variable or return value of
1236 @code{(user-login-name)}.
1237 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1238 Initial setting is @samp{user}.
1239 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1240 If t, use UIDL for numbering. Initial setting is t.
1241 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1242 Initial setting is @samp{localhost}.
1243 @var{port} -> The value of @code{elmo-pop3-default-port}.
1244 Initial setting is 110.
1251 &hoge@@localhost -> access localhost as user @samp{hoge}.
1252 &hoge@@popserver:109 -> access the server "popserver" on port 109
1253 as user @samp{hoge}.
1257 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1258 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1259 @file{utils/sasl/lisp/} or Emacs/W3 package
1260 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1263 If the last character of the folder name is @samp{!}, Wanderlust
1264 connects to the POP server via SSL (Secure Socket Layer). If you set
1265 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1266 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1267 with @samp{!!}, STARTTLS connection will be established. if the value
1268 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1272 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1273 @section Shimbun Folder
1275 @cindex Shimbun Folder
1276 @cindex Folder, Shimbun
1281 A folder for watching "shimbun" (means "newspaper" in Japanese),
1282 news site and mailing list archives on WWW by using emacs-w3m
1283 (@uref{http://emacs-w3m.namazu.org/}).
1285 You should possess w3m and emacs-w3m to use this.
1291 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1295 Admissible values of @var{module-name} and @var{folder-name} are
1296 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1302 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1303 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1307 @subsection Variables About Shimbun Folder
1310 @item elmo-shimbun-update-overview-folder-list
1311 @vindex elmo-shimbun-update-overview-folder-list
1312 The initial setting is @code{nil}. You can specify a list of regular
1313 expressions of shimbun folder names. The overview of matched shimbun
1314 folder is updated when messages are fetched.
1315 You should @kbd{s rescan} after fetching to update summary.
1319 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1320 @section Namazu Folder
1322 @cindex Namazu Folder
1323 @cindex Folder, Namazu
1324 @cindex Folder, Text Search
1327 A folder to access messages found in namazu-index with some condition.
1328 It uses namazu (@uref{http://www.namazu.org/}) for search.
1334 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1338 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1344 [wanderlust] -> search messages matched with
1345 "wanderlust" from the default index
1346 [semi flim]~/Mail/semi -> search "semi flim" from the index
1347 in the directory "~/Mail/semi"
1353 @subsubsection Enter space to separate keywords
1355 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1357 @subsubsection Alias name for index
1359 You can define an alias name for index.
1364 (setq elmo-nmz-index-alias-alist
1365 '(("cache" . "~/.elmo/cache")
1366 ("docs" . "~/documents")))
1369 Above definition defines two index aliases.
1376 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1377 directory @file{~/.elmo/cache}.
1379 @subsubsection Multiple indices
1381 You can specify a list for @code{elmo-nmz-default-index-path} and
1382 @code{elmo-nmz-index-alias-alist}.
1383 When list is specified, all index contained in the list is used as the
1389 (setq elmo-nmz-index-alias-alist
1390 '(("all" . ("~/.elmo/cache" "~/documents"))
1391 ("cache" . "~/.elmo/cache")))
1394 Using above alias setting, you can specify
1400 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1401 directory @file{~/.elmo/cache} and @file{~/documents}.
1403 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1404 @section Multi Folder
1406 @cindex Multi Folder
1407 @cindex Folder, Multiple
1408 @cindex Folder, Marge
1410 A folder to access virtual folder which collects messages from
1417 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1421 After @samp{*} character, specify multiple folders you want to collect
1422 separated by @samp{,} like
1423 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1429 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1430 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1431 treated as one folder.
1433 *+inbox,-fj.rec.tv,%inbox
1434 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1439 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1440 @section Filter Folder
1442 @cindex Filter Folder
1443 @cindex Folder, Filtering
1444 @cindex Folder, Virtual
1445 @cindex Folder, Conditional
1447 A folder to access virtual folder which collects all messages that
1448 satisfy a condition.
1453 @samp{/} @var{condition} @samp{/} @var{target-folder}
1456 In the @var{condition} part, you can specify following.
1460 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1462 first: @var{number} messages are picked from top of folder.
1463 last: @var{number} messages are picked from bottom of folder.
1469 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1470 /first:20/%inbox -> First 20 messages from %inbox are picked.
1475 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1477 since: only messages arrived since @var{date} are picked.
1478 before: only messages arrived before @var{date} are picked.
1480 You can specify following as @var{date}.
1484 yesterday -> a day before today.
1485 lastweek -> same day of last week.
1486 lastmonth -> same day of last month.
1487 lastyear -> same day of last year.
1488 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1489 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1497 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1499 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1505 Field filter: @samp{@var{field}:@var{value}}
1507 All messages that have @var{field} and its value is @var{value} are picked.
1508 @var{field} and @var{value} are case insensitive.
1514 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1515 and its value includes "teranisi" string are picked.
1516 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1524 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1525 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1527 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1528 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1534 /from:teranisi&!to:teranisi/+inbox
1535 -> In +inbox, messages are picked if the message's
1536 From: field includes "teranisi" and
1537 To: field doesn't include "teranisi".
1539 /tocc:"Yuuichi Teranishi"/+inbox
1540 -> In +inbox, messages are picked if the
1541 message's To: field or Cc: field includes
1542 "Yuuichi Teranishi".
1544 /(from:yt|from:teranisi)&subject:report/+inbox
1545 -> In +inbox, messages are picked if the message's
1546 From: field includes "yt" or "teranisi", and
1547 Subject includes "report".
1553 Tip for string description:
1555 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1556 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1557 should be escaped with @samp{\} in it). You can enclose the string with
1558 @samp{"} even it does not contain these characters.
1564 *%inbox,/from:teranisi/%inbox@@server
1565 -> Messages in %inbox or
1566 message is in the %inbox@@server folder and it's From field
1567 includes "teranisi" are collected.
1569 /last:100//to:teranisi/*+inbox,%inbox
1570 -> Latest 100 messages which is in the +inbox or %inbox folder
1571 and To: field matches "teranisi".
1573 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1574 -> Pick messages which have From: field and it includes "hogehoge"
1575 from latest 20 messages in the %#mh/inbox@@localhost
1576 and To: or Cc: field includes "teranisi".
1579 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1580 @section Pipe Folder
1584 @cindex Download Message
1585 @cindex Incorporate Message
1587 In the pipe folder, messages are automatically transferred from the source
1588 folder to destination folder.
1593 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1596 When you access the pipe folder, messages are automatically transferred
1597 from @var{source-folder} to @var{destination-folder}.
1598 It is convenient if you want to download messages to local disk via POP.
1599 For example, if you specify following
1602 |&username@@popserver|+inbox
1606 and access it, Wanderlust downloads messages from
1607 @samp{&username@@popserver} to @samp{+inbox} automatically.
1609 On the other hand, if you put @samp{|:} instead of second @samp{|},
1610 then messages are copied to the destination folder (not deleted from
1611 source-folder). At the next time you access that folder, copies new
1615 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1618 If you want to copy messages from POP server and view them, specify the
1622 |&username@@popserver|:+inbox
1625 where messages will be kept on the server.
1631 |%inbox|%myinbox -> Download %inbox to %myinbox.
1632 |*&user@@popserver1,&user@@popserver2|+inbox
1633 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1634 |-gnu.emacs.sources|:+sources
1635 -> Copy messages from -gnu.emacs.sources to +sources.
1639 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1641 @node Internal Folder, , Pipe Folder, Folders
1642 @section Internal folder
1644 @cindex Internal Folder
1645 @cindex Folder, @samp{$} mark
1647 @c @cindex Folder, Null
1649 A folder to access internal messages of Wanderlust.
1655 @samp{'flag} [@samp{/} @var{global-flag}]
1657 @samp{'cache/00} - @samp{'cache/1F}
1661 A folder named @samp{'flag} is a special virtual folder which collects
1662 messages which have @var{global-flag}.
1664 Now, @samp{important} flag is supported as @var{global-flag}. You can
1665 review important messages at once after you put important marks on the
1666 messages in the different folders.
1668 In this folder, if you delete message, @var{global-flag} put on the
1669 message is removed. If you append messages to this folder, the message
1670 will have @var{global-flag}.
1673 A folder named @samp{'sendlog} is a virtual folder which collects
1674 cached messages which are recoded on @file{~/.elmo/sendlog}.
1675 It might be useful when you forgot to add cc for yourself.
1676 To use this, you should set @code{wl-draft-use-cache} to non-nil
1677 so that sent messages are cached.
1680 You can access cached messages fetched via network by accessing
1681 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1682 the name of the subdirectories of the cache directory
1683 (@file{~/.elmo/cache}).
1686 @node Folder, Summary, Folders, Top
1687 @chapter Folder mode
1690 After you start Wanderlust, folder mode is appeared firstly.
1691 It contains folder list you subscribed.
1692 You can select and edit folders in this mode.
1695 * Selecting Folder:: Select folder you want to read
1696 * Folder Manager:: Editing folders
1700 @node Selecting Folder, Folder Manager, Folder, Folder
1701 @section Selecting Folder
1702 @cindex Selecting Folder
1704 @subsection Usage (TIPS)
1706 @subsubsection Check new, unread number
1708 Folder mode looks like this.
1709 (In XEmacs, it looks much nicer @t{;-)})
1713 [-]Desktop:14186/35580/67263
1718 [-]Emacsen:0/34/4837
1719 Wanderlust ML:0/0/558
1722 XEmacs Beta:0/29/255
1733 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1737 @kbd{s} key on the folder line updates these numbers.
1738 It changes its color if it has many new messages.
1740 The whole folder mode is a folder group named @samp{Desktop}.
1741 Folder group open/close by return key.
1742 A operation to a folder group is treated as operations on the
1744 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1745 six children folders update its unread number status.
1747 @subsubsection Select Folder
1749 To enter summary mode of the folder, type return (or space) key on
1751 If the variable @code{wl-stay-folder-window} has non-nil value,
1752 summary window appears on the right of the folder mode window.
1754 @subsection Key bindings
1756 Folder mode's key binding (related to selecting folders) is following.
1761 @kindex @key{SPC} (Folder)
1762 @kindex @key{RET} (Folder)
1763 @findex wl-folder-jump-to-current-entity
1764 Enter to the summary mode of the folder at the current cursor point.
1765 With prefix argument, enter the sticky summary.
1766 If the cursor is on the top of folder group line,
1767 the folder group is opened or closed.
1768 When the cursor is on the access group and this command is called
1769 with prefix argument, folder children list is updated to the newest one.
1770 (Children list is updated recursively if the access folder has hierarchical
1772 (@code{wl-folder-jump-to-current-entity})
1775 @kindex M-@key{RET} (Folder)
1776 @findex wl-folder-update-recursive-current-entity
1777 Folder children list of the access group at the current cursor point
1778 is updated to the newest one.
1779 (Children list is updated recursively if the access folder has hierarchical
1781 (@code{wl-folder-update-recursive-current-entity})
1786 Create a new draft message.
1791 @findex wl-folder-write-current-folder
1792 If the current cursor point is on the NNTP folder, create a new draft
1793 message which already has @samp{Newsgroups:} field. If the current
1794 cursor point is on the folder for mailing list (refile destination),
1795 create a new draft message which already has @samp{To:} field with
1796 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1798 (@code{wl-folder-write-current-folder})
1801 @kindex C-c C-o (Folder)
1802 @findex wl-jump-to-draft-buffer
1803 Move to the draft buffer if available. If multiple draft buffer exists,
1804 moved to one after another. If prefix argument is specified, load draft
1805 folder's message to the draft buffer and jump to it.
1806 (@code{wl-jump-to-draft-buffer})
1810 @findex wl-folder-check-current-entity
1811 Update new and unread number information of the folder at the current
1813 (@code{wl-folder-check-current-entity})
1817 @findex wl-folder-sync-current-entity
1818 Update summary information of the folder at the current cursor point.
1819 (@code{wl-folder-sync-current-entity})
1822 @kindex r s (Folder)
1823 @findex wl-folder-check-region
1824 Update new and unread number information of the folders in the currently
1826 (@code{wl-folder-check-region})
1829 @kindex r S (Folder)
1830 @findex wl-folder-sync-region
1831 Update summary information of the folders in the currently selected region.
1832 (@code{wl-folder-sync-region})
1836 @findex wl-status-update
1837 Sync up address book status with @file{~/.addresses}'s content.
1838 (@code{wl-status-update})
1842 @findex wl-folder-prev-unread
1843 Jump cursor to the folder which have unread messages on the upward from
1844 current cursor point.
1845 (@code{wl-folder-prev-unread})
1849 Jump cursor to the folder which have unread messages on the downward
1850 from current cursor point.
1851 (@code{wl-folder-next-unread})
1855 Move cursor to the folder on the previous line.
1856 (@code{wl-folder-prev-entity})
1860 Move cursor to the folder on the next line.
1861 (@code{wl-folder-next-entity})
1865 Jump to the folder specified by the user input.
1866 (@code{wl-folder-jump-folder})
1870 @findex wl-folder-prefetch-current-entity
1871 Prefetch new messages of the folder at the current cursor point by
1872 @code{wl-summary-incorporate}.
1873 If the cursor is on the folder group, it is executed recursively.
1874 (@code{wl-folder-prefetch-current-entity})
1878 @findex wl-folder-mark-as-read-all-current-entity
1879 Mark all unread messages of the folder at the current cursor point as read.
1880 If the cursor is on the folder group, it is executed recursively.
1881 (@code{wl-folder-mark-as-read-all-current-entity})
1885 @findex wl-folder-goto-first-unread-folder
1886 Enter summary mode of the first unread folder.
1887 (@code{wl-folder-goto-first-unread-folder})
1891 @findex wl-folder-empty-trash
1893 (@code{wl-folder-empty-trash})
1897 @findex wl-folder-flush-queue
1899 (@code{wl-folder-flush-queue})
1903 @findex wl-folder-virtual
1904 Move to the virtual folder (filter folder) with the condition specified.
1905 (@code{wl-folder-virtual})
1909 @findex wl-folder-pick
1910 Search the folders with the condition specified.
1911 (@code{wl-folder-pick})
1915 @findex wl-folder-open-all-unread-folder
1916 All unread folder is opened.
1917 (@code{wl-folder-open-all-unread-folder})
1921 @findex wl-folder-open-close
1922 Folder group is opened/closed.
1923 (@code{wl-thread-open-close})
1927 All folder group is opened.
1928 (@code{wl-folder-open-all})
1932 All folder group is closed.
1933 (@code{wl-folder-close-all})
1943 (@code{wl-folder-suspend})
1946 @kindex M-s (Folder)
1947 Save current folder status.
1951 @kindex M-t (Folder)
1952 Toggle Wanderlust's offline/online status.
1953 (@code{wl-toggle-plugged})
1956 @kindex C-t (Folder)
1957 Start Wanderlust's plug-status manager.
1958 (@code{wl-plugged-change})
1961 @subsection Customize variables
1964 @item wl-folders-file
1965 @vindex wl-folders-file
1966 The initial setting is @file{~/.folders}.
1967 Subscribed folders are described (saved) in this file.
1969 @item wl-folder-info-save
1970 @vindex wl-folder-info-save
1971 The initial setting is @code{t}. If non-nil, unread information is
1972 saved and used in the next Wanderlust session.
1974 @item wl-stay-folder-window
1975 @vindex wl-stay-folder-window
1976 The initial setting is @code{nil}.
1977 If non-nil, summary window is appeared on the right side of the folder buffer.
1979 @item wl-folder-window-width
1980 @vindex wl-folder-window-width
1981 The initial setting is 20.
1982 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1984 @item wl-folder-use-frame
1985 @vindex wl-folder-use-frame
1986 The initial setting is @code{nil}.
1987 If non-nil, use new frame for the folder window.
1989 @item wl-folder-many-unsync-threshold
1990 @vindex wl-folder-many-unsync-threshold
1991 The initial setting is 70.
1992 If the number of unread messages is more than this value,
1993 folder color is changed.
1995 @item wl-highlight-folder-by-numbers
1996 @vindex wl-highlight-folder-by-numbers
1997 This option controls how to highlight each line in the folder buffer.
1998 The default value is @code{t}, highlighting with various colors based on
1999 the message numbers. If it is @code{nil}, highlighting with various
2000 colors based on the folder status. In addition, if it is a number
2001 (e.g. 1), highlighting will be done based on both the message numbers
2002 and the folder status.
2004 @item wl-folder-desktop-name
2005 @vindex wl-folder-desktop-name
2006 The initial setting is @samp{Desktop}.
2007 The name of top folder group.
2009 @item wl-folder-petname-alist
2010 @vindex wl-folder-petname-alist
2011 The initial setting is @code{nil}.
2012 An alist of folder's realname and its nickname.
2014 @item wl-folder-access-subscribe-alist
2015 @vindex wl-folder-access-subscribe-alist
2016 The initial setting is @code{nil}.
2018 Control automatic subscribing and unsubscribing of the children list
2024 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2028 If @var{subscribe-flag} is non-nil, folders which have name matched to
2029 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2030 already unsubscribed folder is not displayed even when the
2031 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2038 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2039 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2040 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2041 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2045 @item wl-folder-hierarchy-access-folders
2046 @vindex wl-folder-hierarchy-access-folders
2047 A list of regular expressions for access groups which creates children
2048 folder list hierarchically.
2050 For example, if you specify
2051 @code{wl-folder-hierarchy-access-folders} like following,
2055 (setq wl-folder-hierarchy-access-folders
2056 '("^-[^\\.]*$" "^-comp.unix$" "^-comp.unix.bsd$"))
2061 you obtain the access group hierarchy as follows.
2067 -fj.comp.announce:0/0/2
2068 -fj.comp.dev.cdrom:0/0/0
2070 [+]-japan:238/238/1688
2073 -comp.unix.admin:0/0/0
2074 -comp.unix.dos-under-unix:0/0/0
2075 -comp.unix.programmer:0/0/0
2076 [-]-comp.unix.bsd:0/0/23
2077 -comp.unix.bsd.freebsd.announce:0/0/0
2082 If you opened @samp{-} in this example, only the direct children is created
2083 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2084 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2085 is not created until the children access group is opened.
2089 @node Folder Manager, , Selecting Folder, Folder
2090 @section Editing Folders
2091 @cindex Folder Manager
2092 @cindex Folder, Edit
2093 @cindex Folder, Subscribe
2094 @cindex Folder, Unsubscribe
2096 As described before, subscribed folder list is saved in @file{~/.folders} file.
2097 But you don't have to edit @file{~/.folders} directly.
2098 You can append, delete, edit folders from folder mode.
2100 @subsection Usage (Tips)
2102 @subsubsection Append Folder
2104 @kbd{m a} appends new folder to the folder mode.
2105 @kbd{m g} appends new folder group.
2106 To append new folder to this group, firstly open it,
2107 then execute append command in the next line.
2109 @subsubsection Edit Folder
2111 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2112 Thus, you can change folder position as if you were editing a normal file.
2114 @subsubsection Create Multi Folder.
2118 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2120 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2122 Type @kbd{m m}, then you can create multi folder.
2125 @subsubsection Delete Nickname, Filter
2127 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2128 minibuffer while appending.
2130 @subsubsection Append Folder to Empty Group
2132 To append new folder to the empty folder group
2133 (after you create folder group by typing @kbd{m g}),
2134 firstly open it, then execute append command in the next line.
2135 If it is closed, folder is appended on the same level with
2136 the folder group above. It is difficult to explain by words so try it.
2137 In other words, appended position depends on the
2138 open/close status of the upper one.
2140 @subsubsection Charset of the Folders File.
2142 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2144 @subsubsection Create Filter
2146 @kbd{m f} adds filter to the folder at the current cursor point. To
2147 create new filter folder and leave the current folder unchanged, copy it
2148 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2149 filter can be specified while appending filter. If you put
2150 ``''(@var{NULL}), filter is deleted.
2152 @subsubsection Sort Folders
2154 Sorting of the folders is executed by the function specified by
2155 @code{wl-fldmgr-sort-function}.
2156 The initial setting is @code{wl-fldmgr-sort-standard},
2157 which sorts alphabetically.
2158 Sorting affects only on the current folder group. It does not
2159 affect on the child groups.
2161 @subsubsection Hiding Folders in the Access Group
2163 Usually, access group displays all children folders, but you can set
2164 some folders hidden. Following operations are only available on access
2167 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2168 (subscribe/unsubscribe) of the folder at current cursor point. Against
2169 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2172 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2173 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2174 argument and if the argument has positive number, the unsubscribe it.
2175 If the prefix argument has negative value, folder becomes visible and if
2176 zero, folder visibility is toggled.
2178 The other commands, @code{wl-fldmgr-subscribe} and
2179 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2182 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2183 executed in the access group, they have a same effect with
2184 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2185 The difference is that cut commands deletes folders from the current
2188 @subsubsection Operations in the Access Group
2190 You can insert and delete folders in the access group like usual folder
2191 group. But insert and delete commands can be only available for the
2192 children folders of the access group and they only sets the subscribe
2193 status. In other words, insertion of the folder means subscribing,
2194 deletion means unsubscribing.
2195 @footnote{In the current implementation,
2196 it is faster to delete region than to unsubscribe region.}
2198 To update the access group when children folders are inserted or deleted
2199 by other way (other than Wanderlust),
2200 open the access group by typing @kbd{C-u @key{RET}}.
2201 @xref{Selecting Folder}.
2203 The order of children folders of access group is saved after
2204 insertion/deletion/sorting.
2205 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2206 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2207 newly created folders are inserted on the top of the access group.
2209 @subsection Key bindings
2210 @cindex Keybind, Folder Mode
2211 @cindex Keybind, Folder Buffer
2213 Key bindings on the folder mode related to folder editing are shown below.
2214 All bindings starts with @kbd{m}, and primary commands are binded to
2215 one stroke key binding.
2219 @kindex m a (Folder)
2220 @findex wl-fldmgr-add
2222 (@code{wl-fldmgr-add})
2227 @kindex m g (Folder)
2228 @findex wl-fldmgr-make-group
2229 Create a folder group.
2230 (@code{wl-fldmgr-make-group})
2233 @kindex m A (Folder)
2234 @findex wl-fldmgr-make-access-group
2235 Create an access group.
2236 (@code{wl-fldmgr-make-access-group})
2239 @kindex m d (Folder)
2240 @findex wl-fldmgr-delete
2241 Delete folder itself and msgdb.
2242 If the folder itself cannot be deleted like NNTP folder,
2243 only msgdb is deleted.
2244 (@code{wl-fldmgr-delete})
2249 @kindex m R (Folder)
2250 @findex wl-fldmgr-rename
2251 Change the name of folder or folder group.
2252 msgdb's path is also changed.
2253 (@code{wl-fldmgr-rename})
2259 @findex wl-fldmgr-make-multi
2260 Create a multi folders in the cutlist (cut, copied folders).
2261 (@code{wl-fldmgr-make-multi})
2266 @kindex m f (Folder)
2267 @findex wl-fldmgr-make-filter
2268 Create a filter folder. (Put a filter on the folder).
2269 (@code{wl-fldmgr-make-filter})
2273 @kindex M-c (Folder)
2274 @kindex m c (Folder)
2275 @findex wl-fldmgr-copy
2276 Copy folder (it is not available on folder group).
2277 (@code{wl-fldmgr-copy})
2281 @kindex M-w (Folder)
2282 @kindex m W (Folder)
2283 @findex wl-fldmgr-copy-region
2284 Copy folders in the specified region.
2285 (@code{wl-fldmgr-copy-region})
2289 @kindex C-k (Folder)
2290 @kindex m k (Folder)
2291 @findex wl-fldmgr-cut
2292 Cut folder. Folder itself is not deleted.
2293 (@code{wl-fldmgr-cut})
2297 @kindex C-w (Folder)
2298 @kindex m C-w (Folder)
2299 @findex wl-fldmgr-cut-region
2300 Cut folders in the specified region.
2301 (@code{wl-fldmgr-cut-region})
2305 @kindex C-y (Folder)
2306 @kindex m y (Folder)
2307 @findex wl-fldmgr-yank
2308 Paste folders that are copied or cut (folders in the cut-list).
2309 (@code{wl-fldmgr-yank})
2312 @kindex m p (Folder)
2313 @findex wl-fldmgr-set-petname
2314 Put nickname on the folder.
2315 (@code{wl-fldmgr-set-petname})
2318 @kindex m q (Folder)
2319 @findex wl-fldmgr-clear-cut-entity-list
2320 Clear the cut-list. (cut, copied folder information is cleared,
2321 you cannot paste after this)
2322 (@code{wl-fldmgr-clear-cut-entity-list})
2325 @kindex m s (Folder)
2326 @findex wl-fldmgr-sort
2327 Sort folders in the current folder group.
2328 (@code{wl-fldmgr-sort})
2331 @kindex m C-s (Folder)
2332 @findex wl-fldmgr-save
2333 Save current folder view to the @file{wl-folders-file}.
2334 (@code{wl-fldmgr-save})
2337 [Following commands are only available on the access groups]
2343 @kindex m u (Folder)
2344 @findex wl-fldmgr-unsubscribe
2345 Set the visibility of folder (subscribe/unsubscribe).
2346 (@code{wl-fldmgr-unsubscribe})
2351 @kindex r u (Folder)
2352 @findex wl-fldmgr-unsubscribe-region
2353 Set the visibility of the folders (subscribe/unsubscribe) in the
2355 (@code{wl-fldmgr-unsubscribe-region})
2360 @kindex m l (Folder)
2361 @findex wl-fldmgr-access-display-normal
2362 List folders that are currently available.
2363 (@code{wl-fldmgr-access-display-normal})
2368 @kindex m L (Folder)
2369 @findex wl-fldmgr-access-display-all
2370 List all folders regardless of the subscription status.
2371 (@code{wl-fldmgr-access-display-all})
2375 @subsection Customize variables
2378 @item wl-interactive-save-folders
2379 @vindex wl-interactive-save-folders
2380 The initial setting is @code{t}. If non-nil and folder view is
2381 modified, confirm saving it before Wanderlust or Emacs exits. If
2382 @code{nil}, save without confirmation.
2384 @item wl-fldmgr-make-backup
2385 @vindex wl-fldmgr-make-backup
2386 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2387 created before saving the folder status.
2389 @item wl-fldmgr-sort-function
2390 @vindex wl-fldmgr-sort-function
2391 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2392 sort folders. By default function, folders are sorted alphabetically
2393 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2396 @item wl-fldmgr-sort-group-first
2397 @vindex wl-fldmgr-sort-group-first
2398 The initial setting is @code{t}. If non-nil,
2399 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2400 does not care whether it is folder group or not.
2402 @item wl-folder-check-async
2403 @vindex wl-folder-check-async
2404 The initial setting is @code{t}. If non-nil, check folder's unread
2405 status asynchronously. It boosts newsgroup checking.
2407 @item wl-folder-check-fast
2408 @vindex wl-folder-check-fast
2409 The initial setting is @code{nil}.
2410 If non-nil, it does not update folder status while checking.
2412 @item wl-folder-notify-deleted
2413 @vindex wl-folder-notify-deleted
2414 The initial setting is @code{nil}.
2416 If non-nil, negative value is displayed when the message is deleted. If
2417 @code{sync}, folder is synchronized when the message is deleted. If
2418 @code{nil}, message deletion is ignored.
2420 @item wl-fldmgr-add-complete-with-current-folder-list
2421 @vindex wl-fldmgr-add-complete-with-current-folder-list
2422 The initial setting is @code{nil}.
2423 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2424 candidate for @code{wl-fldmgr-add}.
2427 @subsection Miscellanea
2429 Following is a note for folder editing.
2433 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2434 paste(yank) command pastes the folders on one cut or copy command
2435 (If copy command is executed by region, folders in the region are pasted
2436 by one paste command)
2439 You cannot cut @samp{Desktop} group.
2440 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2443 You cannot copy folder group.
2446 Operations on the access group are only available for the folders
2447 in the same access group.
2450 You cannot create a folder which has same name with the folders already exist.
2453 You cannot insert folders which have same name in one group.
2454 You can insert them in the different groups.
2455 You cannot put same nickname to the different folders.
2459 @node Summary, Message, Folder, Top
2460 @chapter Summary Mode
2462 After you select the folder via folder mode, you enter to the summary
2466 * Usage of Summary Mode:: TIPS
2467 * Thread Operations:: Thread operations
2468 * Cache:: File cache, Buffer cache, and Prefetch
2469 * Auto Refile:: Auto refile settings
2470 * Sticky Summary:: Summary make sticky
2471 * Summary View:: Format of summary lines
2472 * Key Bindings of Summary:: Key bindings
2473 * Variables of Summary:: Customize Summary Mode
2477 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2478 @section Usage (Tips)
2480 @subsection Summary Content
2482 In the summary mode, messages are displayed like following.
2486 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2487 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2488 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2489 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2496 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2500 If you want to know how to change the format for this, please refer
2501 the section format of Summary lines.
2502 @xref{Summary View}.
2504 @var{Message number} is the message's unique number in the folder. In
2505 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2506 in the MH folder, it is the filename of the message.
2508 @var{Temporal mark} and @var{Persistent mark} are described later.
2510 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2511 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2512 Japanese, but if you want to display it in English, set the value of
2513 @code{wl-summary-weekday-name-lang} as @samp{en}.
2515 @var{Sender}'s indentation corresponds to the depth of the thread.
2516 Sender name is displayed as nickname if it is defined in the address
2517 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2518 displaying with nickname.
2520 If number is printed at the head of @var{Sender} part like @samp{+2},
2521 that means the message have 2 follow messages.
2523 @var{Subject} is the @samp{Subject:} header field of the message. If
2524 the message have same @samp{Subject:} with the parent message, it is not
2525 displayed. Some mailing list puts its sequence number in the
2526 @samp{Subject:} field, but it is
2527 ignored. @code{wl-summary-no-subject-message} is displayed when the
2528 message has empty subject field.
2530 @subsection Temporary Marks
2531 @cindex Mark, Temporary
2533 There are four temporary marks,
2534 @samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}.
2535 Temporary marks indicates message operations.
2540 You can execute a command on the all messages that have @samp{*} mark,
2541 with the key bindings which begins with @kbd{m}.
2544 The mark to dispose. You can put @samp{d} by typing @kbd{d} key.
2547 The mark to force delete. You can put @samp{D} by typing @kbd{D} key.
2551 After you type @kbd{o} key, prompt appears to input refile destination.
2552 Your answer is printed in the summary line.
2556 You can put this mark by typing @kbd{O} key.
2557 The difference between this mark and refile mark is,
2558 this mark does not delete the message while latter does.
2561 The mark to prefetch reserved.
2562 You can put this mark by typing @kbd{i} key.
2565 The mark to resend reserved.
2566 After you type @kbd{~} key, prompt appears to input address to resend.
2567 Your answer is printed in the summary line.
2570 @kbd{x} key executes action for temporary marks, respectively.
2572 @subsection Persistent Marks
2574 There are five persistent marks, @samp{N}, @samp{?}, @samp{U}, @samp{!},
2575 @samp{u}, @samp{A}, @samp{&} and @samp{$}.
2577 The persistent mark indicates the message's status and it is saved.
2578 Each persistent mark indicates:
2584 It is new but cached message.
2586 It is unread message.
2588 It is unread but cached message.
2590 It is read but it is not cached.
2592 It is already replied message.
2594 It is already replied but cached message.
2596 It is important message. You can put @samp{$} mark by typing @kbd{$}
2597 key (if already exists, the mark is deleted). It is convenient to put
2598 this mark on the messages to remember (If you want to remember to write
2599 a reply for the message, for example) because this mark remains after
2600 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2601 @samp{'mark} folder even the message itself is deleted in the actual folder.
2604 If the message is read and cached (or local message),there are no
2608 @samp{N}, @samp{U}, @samp{u}, @samp{A} indicates that the message have
2609 no cache. Messages with the marks other than these, you can read them
2610 in the offline status even they are in the IMAP folder or netnews
2613 Among messages with persistent marks, ones with marks specified by
2614 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2615 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2617 @subsection How To Read
2619 Basically, you can read messages only typing space key again and again.
2621 To update summary status to the newest status (synchronize),
2624 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2625 moves cursor to the next message.
2626 Enter message buffer by typing @kbd{j} key.
2627 To operate multipart, you have to enter to the message buffer.
2630 @subsection Pack the Message Numbers
2631 You can pack the message numbers in Summary by
2632 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2633 News Spool Folder and Maildir Folder are supported folder types.
2636 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2637 @section Thread Operations
2639 For example, the following line indicates one thread (a context of a topic).
2642 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2646 If you type @kbd{/} on this line, the thread is opened and it changes
2647 the appearance like following.
2651 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2652 388 09/17(Thu)22:34 +-[ Murata san ]
2656 (Message 388 is the replied message to the message 384.)
2657 If you type @kbd{/} key once again, the thread is closed.
2658 With prefix argument, @kbd{/} opens all children threads.
2660 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2663 Commands with the key binding that begins with @kbd{t} executes commands
2664 on the messages in the thread.
2665 @xref{Key Bindings of Summary}.
2667 @subsection reconstruct thread by hand
2669 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2670 (@code{wl-summary-save-current-message}) at the corresponding message,
2671 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2672 message then you have the reconstructed thread.
2675 @node Cache, Auto Refile, Thread Operations, Summary
2678 @subsection Cache File
2680 The messages which have to access via network (e.x. IMAP, NNTP folder)
2681 are cached as a local file so as to save network traffic or to enable
2682 off-line operation. The cache file is saved under the directory
2683 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2684 elmo-cache-expire-by-size}. The command deletes cache files to the
2685 specified size by the order of last accessed time.
2687 @subsection Buffer Cache and Prefetching
2689 The messages that are read are kept in the cache buffer so as to make
2690 the behavior fast when you are to read the message again. It is called
2691 `buffer cache'. The number of cache buffer is specified by
2692 @code{wl-message-buffer-cache-size}.
2694 There are message prefetching mechanism in the Wanderlust that
2695 prefetches next message while you are reading.
2697 You can control the message prefetching mechanism by these two
2701 @item wl-message-buffer-prefetch-folder-type-list
2702 @vindex wl-message-buffer-prefetch-folder-type-list
2703 The initial setting is @code{t}. In this case, prefetch messages in all
2705 If it is a list of folder types, it specifies the folder types in which
2706 message prefetching is enabled.
2707 Following is an example (prefetch messages in nntp and imap4 folders)
2711 (setq wl-message-buffer-prefetch-folder-type-list
2716 In this case, multi folder that contains localdir and imap4 prefetches
2717 only imap4 messages. This variable precedes the value of
2718 @code{wl-message-buffer-prefetch-folder-list}.
2720 @item wl-message-buffer-prefetch-folder-list
2721 @vindex wl-message-buffer-prefetch-folder-list
2722 The initial setting is @code{nil}.
2723 A list of regexp of folders to enable message prefetching.
2725 @item wl-message-buffer-prefetch-depth
2726 @vindex wl-message-buffer-prefetch-depth
2727 The initial setting is 3. The number of messages for automatical prefetch.
2729 @item wl-message-buffer-prefetch-idle-time
2730 @vindex wl-message-buffer-prefetch-idle-time
2731 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2733 @item wl-message-buffer-prefetch-threshold
2734 @vindex wl-message-buffer-prefetch-threshold
2735 The initial setting is 30000 (bytes). If prefetching message has larger
2736 size than this value, Wanderlust does not prefetch automatically.
2737 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2738 the message is not checked for the size.
2740 @item wl-auto-prefetch-first
2741 @vindex wl-auto-prefetch-first
2742 The initial setting is @code{nil}.
2743 If non-nil, first message is automatically prefetched to the buffer
2744 when you enter the folder.
2748 @node Auto Refile, Sticky Summary, Cache, Summary
2749 @section Auto Refile
2750 @vindex elmo-msgdb-extra-fields
2751 @vindex wl-refile-rule-alist
2752 @findex wl-summary-auto-refile
2754 You can refile messages automatically, by typing @kbd{C-o}
2755 (@code{wl-summary-auto-refile}). It decides destination of refile by
2756 the content of the message header information (information in the msgdb).
2758 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2759 available. If you want to decide destination by other header fields,
2760 set the variable @code{elmo-msgdb-extra-fields} like following.
2764 (setq elmo-msgdb-extra-fields
2774 By this setting, Wanderlust saves extra fields in the msgdb. You have
2775 to type @kbd{s all} to get extra fields for the messages that are
2776 already exists in the summary.
2778 Then, specify the refile rule. The refile target folder of auto
2779 refiling is decided by the value of @code{wl-refile-rule-alist}.
2780 @code{wl-refile-rule-alist} is a list of a rule:
2784 (@var{field} (@var{regexp} . @var{target})
2785 (@var{regexp} . @var{target})
2790 Each rule means `if @var{field} value matches @var{regexp},
2791 then refile to @var{target} folder'.
2792 The rule matched first is applied.
2794 @var{field} is a string of field name. You can specify a list of field name
2795 string, too. In this case, if one of these fields is matched, then the
2796 rule is fired (i.e. OR condition).
2798 @var{regexp} is a regular expression for field value. @var{target} is a target
2799 folder string. You can specify a rule at @var{target} part, too. In this
2800 case, If the field value of the rule and the current rule is matched,
2801 then the current rule is fired (i.e. AND condition).
2803 You can refer matched substring of @var{regexp} to specify @var{target} part.
2804 To refer substring, use following keys:
2808 means substitute original matched text.
2811 means substitute what matched the @var{N}th `\(@dots{}\)'.
2812 (@var{N} is a number.)
2815 Following is an example of @code{wl-refile-rule-alist}.
2819 (setq wl-refile-rule-alist
2821 ("^Wanderlust" . "+wl")
2822 ("^Elisp" . "+elisp"))
2824 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2826 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2827 "+from-me-to-you"))))))
2831 After these settings, refile marks are automatically put on the condition
2832 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2834 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2836 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2837 with these persistent marks are not automatically refiled.
2838 It means Wanderlust does not execute auto refile on unread messages by
2839 the default setting.
2840 To execute auto refile on all messages, set following.
2843 (setq wl-summary-auto-refile-skip-marks nil)
2847 @node Sticky Summary, Summary View, Auto Refile, Summary
2848 @section Sticky Summary
2849 @cindex Summary, Sticky
2850 @cindex Sticky Summary
2852 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2854 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2855 @kbd{G} in some suummary sticky summary buffer is created.
2856 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2857 makes current one sticky.
2859 The buffer name of the sticky summary becomes like
2860 @samp{Summary:@var{folder-name}}.
2861 You can visit the sticky summary at any time by @kbd{C-x b}
2862 (@code{switch-to-buffer}), or you can go round summary buffers by
2863 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2864 (@code{wl-summary-next-buffer}) in summary mode.
2866 In sticky summary, the summary buffer is preserved after @kbd{g} or
2867 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2868 another summary by @kbd{C-u g}. Other operations in the sticky summary
2869 are same as normal summary.
2871 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2872 are automatically stuck.
2875 @node Summary View, Key Bindings of Summary, Sticky Summary, Summary
2876 @section Format of summary lines
2877 @cindex Format of summary lines
2878 You can alter the format of lines in Summary mode.
2880 Summary line format is specified by @code{wl-summary-line-format}.
2881 You can use control strings defined by
2882 @code{wl-summary-line-format-spec-alist}.
2888 ;; @r{number temporary-mark persistent-mark date branch}
2889 ;; @r{[ (number-of-children) sender ] subject}
2890 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
2894 Where the number set the column number of the field (for negative value,
2897 Major control strings defined by @code{wl-summary-line-format-spec-alist}
2898 are displayed in the following list.
2909 %t branch of the thread
2910 %[ [ (< for re-connected child)
2911 %] ] (> for re-connected child)
2915 %c +number-of-children: (display only for opened thread)
2916 %C [+number-of-children] (display only for opened thread)
2917 %T temporary mark (mandatory)
2918 %P persistent mark (mandatory)
2922 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
2923 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
2924 the constant column. For example, if you specify @samp{%T} or
2925 @samp{%P} after the @samp{%t}, which changes its length by thread
2926 position, marks are not treated correctly.
2928 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
2929 column of the enclosed region is justified to the `number'. Multiple
2930 level @samp{%number(} parenthesis can be defined. It is useful to
2931 justify the column of the multiple control strings. For example, in the
2932 above @code{wl-summary-line-format},
2938 means ``Adjust number-of-children and sender string to the 17 column''.
2940 You can specify the format by each folders with
2941 @code{wl-folder-summary-line-format-alist}. Please set regular
2942 expression for folder names and summary line format as the following
2947 (setq wl-folder-summary-line-format-alist
2948 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
2949 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
2953 @subsection on the format for sender name
2955 The format string @samp{%f} displays the return value of the function specified
2956 by @code{wl-summary-from-function}. If you use the function
2957 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
2958 while displays the recipient names if the folder name matches with
2959 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
2960 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
2962 For example, to display recipient names for the message in @samp{+backup} if
2963 its sender is yourself, set up as follows.
2966 (setq wl-summary-showto-folder-regexp "^\\+backup$")
2970 @node Key Bindings of Summary, Variables of Summary, Summary View, Summary
2971 @section Key bindings
2972 @cindex Keybind, Summary Mode
2973 @cindex Keybind, Summary Buffer
2975 Key bindings of the summary mode are shown below.
2979 @kindex @key{SPC} (Summary)
2980 @findex wl-summary-read
2981 Proceed reading a message at the current cursor point.
2982 (@code{wl-summary-read})
2986 @findex wl-summary-redisplay
2987 Redisplay a message at the current cursor point.
2988 If this command is called with prefix argument,
2989 Redisplay message regardless of the message cache (message is re-loaded
2991 (@code{wl-summary-redisplay})
2995 @findex wl-summary-display-top
2996 Display the top message in the folder.
2997 (@code{wl-summary-display-top})
3001 @findex wl-summary-display-bottom
3002 Display the bottom message in the folder.
3003 (@code{wl-summary-display-bottom})
3007 @kindex @key{BS} (Summary)
3008 @kindex @key{DEL} (Summary)
3009 Display the previous page of the message at the current cursor point.
3010 @findex wl-summary-prev-page
3011 (@code{wl-summary-prev-page})
3014 @kindex @key{RET} (Summary)
3015 @findex wl-summary-next-line-content
3016 Display the next line of the message at the current cursor point.
3017 Display the message at the current cursor point if it is not displayed yet.
3018 (@code{wl-summary-next-line-content})
3023 @kindex M-@key{RET} (Summary)
3024 @findex wl-summary-prev-line-content
3025 Display the previous line of the message at the current cursor point.
3026 Display the message at the current cursor point if it is not displayed yet.
3027 (@code{wl-summary-prev-line-content})
3031 @findex wl-thread-open-close
3032 Toggle open or close the thread at the current cursor point.
3033 (@code{wl-thread-open-close})
3038 @findex wl-thread-open-all
3039 (@code{wl-thread-open-all})
3044 @findex wl-thread-close-all
3045 (@code{wl-thread-close-all})
3049 @findex wl-summary-goto-folder
3051 (@code{wl-summary-goto-folder})
3055 Mark all messages in the folder as read.
3056 @findex wl-summary-mark-as-read-all
3057 (@code{wl-summary-mark-as-read-all})
3061 @findex wl-summary-reply
3062 Prepare a draft for reply the message at the current cursor point.
3063 (@code{wl-summary-reply})
3067 @findex wl-summary-reply-with-citation
3068 Prepare a draft for reply the message at the current cursor point.
3069 (@code{wl-summary-reply-with-citation})
3073 @findex wl-summary-cancel-message
3074 If the message at current cursor point is your own netnews article,
3076 (@code{wl-summary-cancel-message})
3080 @findex wl-summary-reedit
3081 Prepare a draft for re-editing the message at current cursor point.
3082 If the message at current cursor point is your own netnews article,
3083 a draft for `supersedes message' for the message is prepared.
3084 (@code{wl-summary-reedit})
3087 @kindex M-E (Summary)
3088 @findex wl-summary-resend-bounced-mail
3089 If the message at current cursor point is a bounced message,
3090 a draft for re-sending original message is prepared.
3091 (@code{wl-summary-resend-bounced-mail})
3095 @findex wl-summary-forward
3096 A draft for forwarding the message at current cursor point is prepared.
3097 (@code{wl-summary-forward})
3101 @findex wl-summary-mark-as-important
3102 Put @samp{$} mark on the message at current cursor point.
3103 If already marked as @samp{$}, remove the mark.
3104 (@code{wl-summary-mark-as-important})
3110 Save the message at current cursor point.
3111 @findex wl-summary-save
3112 (@code{wl-summary-save})
3116 @findex wl-summary-next
3117 Move cursor to the next message.
3118 If message is marked with a temporal mark in
3119 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3120 In the offline mode, cursor is not moved to the messages which are not cached
3122 (@code{wl-summary-next})
3126 @findex wl-summary-prev
3127 Move cursor to the previous message.
3128 If message is marked with a temporal mark in
3129 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3130 In the offline mode, cursor is not moved to the messages which are not cached
3132 (@code{wl-summary-prev})
3136 @findex wl-summary-down
3137 Move cursor to the downward message which is unread or marked
3139 In the offline mode, cursor is not moved to the messages which are not cached
3141 If there are messages which have target mark @samp{*} in the summary,
3142 cursor is moved to the downward message which have a target mark.
3143 This behavior is changed according to the value of @code{wl-summary-move-order}.
3144 (@code{wl-summary-down})
3148 @findex wl-summary-up
3149 Move cursor to the upward message which is unread or marked
3151 In the offline mode, cursor is not moved to the messages which are not cached
3153 If there are messages which have target mark @samp{*} in the summary,
3154 cursor is moved to the downward message which have a target mark.
3155 This behavior is changed according to the value of @code{wl-summary-move-order}.
3156 (@code{wl-summary-up})
3160 @findex wl-summary-write
3161 Prepare a new draft.
3162 (@code{wl-summary-write})
3166 @findex wl-summary-write-current-folder
3167 Prepare a new draft. If the current folder is NNTP folder,
3168 @samp{Newsgroups:} field is completed. If the current folder is mailing
3169 list folder (refile destination), guess @samp{To:} field and completed
3170 (If @code{wl-subscribed-mailing-list} is valid list)
3171 (@code{wl-summary-write-current-folder})
3175 @findex wl-summary-redisplay-all-header
3176 Redisplay the message at current cursor point with all header fields.
3177 (@code{wl-summary-redisplay-all-header})
3181 @findex wl-summary-redisplay-no-mime
3182 Redisplay the message at current cursor point without MIME analysis.
3183 (@code{wl-summary-redisplay-no-mime})
3187 @findex wl-summary-burst
3188 If the message at current cursor point has
3189 encapsulates multiple messages using MIME,
3190 de-capsulate and extract them on the current folder.
3191 If it is invoked in non-writable folder or it is called with prefix
3192 argument, it asks the destination folder.
3193 (@code{wl-summary-burst})
3196 @kindex @@ (Summary)
3197 @findex wl-summary-edit-addresses
3198 Append/change/delete the message's sender information to the address
3199 book @file{~/.addresses} interactively. If this command is called with
3200 prefix argument, arbitrary address can be edited.
3201 (@code{wl-summary-edit-petname})
3205 @findex wl-status-update
3206 Sync up address book status with @file{~/.addresses}'s content.
3207 (@code{wl-status-update})
3211 @findex wl-summary-pipe-message
3212 Pipe current message's content to the external process.
3213 (@code{wl-summary-pipe-message})
3217 @findex wl-summary-print-message
3218 Print out current message's content.
3219 It uses @code{ps-print} module in Emacs 20.x.
3220 If you don't use color printer, you might want to set
3221 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3224 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3227 (@code{wl-summary-print-message})
3231 @findex wl-summary-exit
3232 Exit current folder.
3233 (@code{wl-summary-exit})
3237 @findex wl-summary-jump-to-current-message
3238 Jump cursor to the currently displayed message's window.
3239 (@code{wl-summary-jump-to-current-message})
3243 Jump cursor to the other message.
3244 @findex wl-summary-jump-to-msg
3245 (@code{wl-summary-jump-to-msg})
3249 Update summary status and
3250 prefetch all messages which have marks included in the
3251 @code{wl-summary-incorporate-marks}.
3252 @findex wl-summary-incorporate
3253 (@code{wl-summary-incorporate})
3256 @kindex M-j (Summary)
3257 @findex wl-summary-jump-to-msg-by-message-id
3258 Jump cursor to the message which have specified @samp{Message-Id:}. If
3259 @code{elmo-use-database} is non-nil, other folder is also searched.
3260 (@code{wl-summary-jump-to-msg-by-message-id})
3264 Jump to parent message.
3265 @findex wl-summary-jump-to-parent-message
3266 (@code{wl-summary-jump-to-parent-message})
3270 @findex wl-summary-mark-as-unread
3271 Mark as unread the message at current cursor point.
3272 (@code{wl-summary-mark-as-unread})
3276 @findex wl-summary-sync
3277 Synchronize summary view after prompting the update range.
3278 You can specify one of the follows.
3282 all Discard present msgdb and retrieve all informations.
3283 Do not retrieve killed messages.
3284 all-entirely Discard present msgdb and retrieve all informations.
3285 Retrieve killed messages, too.
3286 update Update the difference between informations in present
3287 msgdb and in current folder instance.
3288 Do not retrieve killed messages.
3289 update-entirely Update the difference between informations in present
3290 msgdb and in current folder instance.
3291 Retrieve killed messages, too.
3292 rescan Redisplay summary by rescanning present msgdb.
3293 rescan-noscore Redisplay summary by rescanning present msgdb.
3294 Display messages killed by score, too.
3295 cache-status Sync the all marks with the real status of cache.
3298 first:NUM Move to the filter folder(partial filter).
3299 last:NUM Move to the filter folder(partial filter).
3304 (@code{wl-summary-sync})
3308 @findex wl-summary-sort
3310 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3311 (@code{wl-summary-sort})
3315 @findex wl-summary-toggle-thread
3316 Toggle the threading. The state will be preserved after exiting
3317 Wanderlust. You can alter default state for newly created summary
3318 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3319 Threading status is displayed on the modeline.
3320 @samp{@{S@}} means threading is off (Sequence) and
3321 @samp{@{T@}} means threading is on (Thread).
3322 (@code{wl-summary-toggle-thread})
3326 @findex wl-summary-toggle-disp-folder
3327 Toggle displaying of folder window.
3328 (@code{wl-summary-toggle-disp-folder})
3332 Toggle displaying of message window.
3333 @findex wl-summary-toggle-disp-msg
3334 (@code{wl-summary-toggle-disp-msg})
3338 Move to the virtual folder (filter folder) with the condition specified.
3339 If called with prefix argument and current folder is virtual, exit it.
3340 @findex wl-summary-virtual
3341 (@code{wl-summary-virtual})
3344 @kindex @key{TAB} (Summary)
3345 @findex wl-summary-goto-last-displayed-msg
3346 Jump to the message which is displayed last.
3347 (@code{wl-summary-goto-last-displayed-msg})
3351 Put @samp{*} mark on the messages that satisfies the specified condition.
3352 @findex wl-summary-pick
3353 (@code{wl-summary-pick})
3357 @findex wl-summary-mark-as-read
3358 Mark as read the message at the current cursor point.
3359 (@code{wl-summary-mark-as-read})
3363 Execute action for all temporary marks in the summary buffer.
3364 @findex wl-summary-exec
3365 (@code{wl-summary-exec})
3369 @findex wl-summary-target-mark-line
3370 Put target mark on the message at the current cursor point.
3371 (@code{wl-summary-target-mark-line})
3375 Put refile mark on the message at the current cursor point.
3376 @findex wl-summary-refile
3377 (@code{wl-summary-refile})
3380 @kindex C-o (Summary)
3381 Execute auto refile.
3382 @findex wl-summary-auto-refile
3383 (@code{wl-summary-auto-refile})
3387 Put copy mark on the message at the current cursor point.
3388 @findex wl-summary-copy
3389 (@code{wl-summary-copy})
3392 @kindex M-o (Summary)
3393 Put refile mark on the message at the current cursor point with the destination
3394 previously specified.
3395 @findex wl-summary-refile-prev-destination
3396 (@code{wl-summary-refile-prev-destination})
3400 @findex wl-summary-dispose
3401 Put disposal mark on the message at the current cursor point.
3402 The result of disposal is controlled by @code{wl-dispose-folder-alist},
3403 refiled to @code{wl-trash-folder} by default.
3404 (@code{wl-summary-dispose})
3408 @findex wl-summary-delete
3409 Put force deletion mark on the message at the current cursor point.
3410 (@code{wl-summary-delete})
3414 Put prefetch reservation mark on the message at the current cursor point.
3415 @findex wl-summary-prefetch
3416 (@code{wl-summary-prefetch})
3420 @findex wl-summary-resend
3421 Put resend reservation mark on the message at the current cursor point.
3422 (@code{wl-summary-resend})
3426 @findex wl-summary-unmark
3427 Unmark the temporal mark on the message at the current cursor point.
3428 (@code{wl-summary-unmark})
3432 Unmark all the temporal marks.
3433 @findex wl-summary-unmark-all
3434 (@code{wl-summary-unmark-all})
3437 @kindex r R (Summary)
3438 @findex wl-summary-mark-as-read-region
3439 Mark as read messages in the specified region.
3440 (@code{wl-summary-mark-as-read-region})
3443 @kindex r $ (Summary)
3444 @findex wl-summary-mark-as-important-region
3445 Mark as important @samp{$} messages in the specified region.
3446 If @samp{$} mark already exists, remove the mark.
3447 (@code{wl-summary-mark-as-important-region})
3450 @kindex r ! (Summary)
3451 @findex wl-summary-mark-as-unread-region
3452 Mark as unread messages in the specified region.
3453 (@code{wl-summary-mark-as-unread-region})
3456 @kindex r x (Summary)
3457 @findex wl-summary-exec-region
3458 Execute action for each temporary marks on the messages in the
3460 (@code{wl-summary-exec-region})
3463 @kindex r * (Summary)
3464 @findex wl-summary-target-mark-region
3465 Put target mark on the messages in the specified region.
3466 (@code{wl-summary-target-mark-region})
3469 @kindex r o (Summary)
3470 @findex wl-summary-refile-region
3471 Put refile mark on the messages in the specified region.
3472 (@code{wl-summary-refile-region})
3475 @kindex r O (Summary)
3476 @findex wl-summary-copy-region
3477 Put copy mark on the messages in the specified region.
3478 (@code{wl-summary-copy-region})
3481 @kindex r d (Summary)
3482 @findex wl-summary-dispose-region
3483 Put disposal mark on the messages in the specified region.
3484 (@code{wl-summary-dispose-region})
3487 @kindex r i (Summary)
3488 @findex wl-summary-prefetch-region
3489 Put prefetch reservation mark on messages in the specified region.
3490 (@code{wl-summary-prefetch-region})
3493 @kindex r u (Summary)
3494 @findex wl-summary-unmark-region
3495 Delete temporal mark on the messages in the specified region.
3496 (@code{wl-summary-unmark-region})
3499 @kindex r y (Summary)
3500 Save messages in the specified region.
3501 @findex wl-summary-save-region
3502 (@code{wl-summary-save-region})
3505 @kindex t R (Summary)
3506 @findex wl-thread-mark-as-read
3507 Mark as read messages which are the descendant of the current thread.
3508 With prefix argument, it affects on the all messages in the thread tree.
3509 (@code{wl-thread-mark-as-read})
3512 @kindex t $ (Summary)
3513 @findex wl-thread-mark-as-important
3514 Put important mark @samp{$} on the messages which are the
3515 descendant of the current thread.
3516 If @samp{$} mark exists, remove the mark.
3517 With prefix argument, it affects on the all messages in the thread tree.
3518 (@code{wl-thread-mark-as-important})
3521 @kindex t ! (Summary)
3522 @findex wl-thread-mark-as-unread
3523 Mark as unread messages which are the descendant of the current thread.
3524 With prefix argument, it affects on the all messages in the thread tree.
3525 (@code{wl-thread-mark-as-unread})
3528 @kindex t x (Summary)
3529 @findex wl-thread-exec
3530 Execute action for temporary marks on the messages which are
3531 the descendant of the current thread. With prefix argument, it affects
3532 on the all messages in the thread tree.
3533 (@code{wl-thread-exec})
3536 @kindex t * (Summary)
3537 @findex wl-thread-target-mark
3538 Put target mark @samp{*} on the messages which are the descendant of the
3539 current thread. With prefix argument, it affects on the all messages in
3541 (@code{wl-thread-target-mark})
3544 @kindex t o (Summary)
3545 @findex wl-thread-refile
3546 Put refile mark on the messages which are the descendant of the current thread.
3547 With prefix argument, it affects on the all messages in the thread tree.
3548 (@code{wl-thread-refile})
3551 @kindex t O (Summary)
3552 @findex wl-thread-copy
3553 Put copy mark on the messages which are the descendant of the current thread.
3554 With prefix argument, it affects on the all messages in the thread tree.
3555 (@code{wl-thread-copy})
3558 @kindex t d (Summary)
3559 @findex wl-thread-dispose
3560 Put disposal mark on the messages which are the descendant of the current thread.
3561 With prefix argument, it affects on the all messages in the thread tree.
3562 (@code{wl-thread-dispose})
3565 @kindex t i (Summary)
3566 @findex wl-thread-prefetch
3567 Put prefetch reservation mark on messages which are the descendant of
3569 (@code{wl-thread-prefetch})
3572 @kindex t u (Summary)
3573 @findex wl-thread-unmark
3574 Unmark temporal mark on the messages which are the descendant of the
3575 current thread. With prefix argument, it affects on the all messages in
3577 (@code{wl-thread-unmark})
3580 @kindex t y (Summary)
3581 @findex wl-thread-save
3582 Save messages which are the descendant of the current thread.
3583 With prefix argument, it affects on the all messages in the thread tree.
3584 (@code{wl-thread-save})
3587 @kindex m R (Summary)
3588 @findex wl-summary-target-mark-mark-as-read
3589 Mark as read all messages which have target mark @samp{*}.
3590 (@code{wl-summary-target-mark-mark-as-read})
3593 @kindex m $ (Summary)
3594 @findex wl-summary-target-mark-mark-as-important
3595 Mark as important all messages which have target mark @samp{*}.
3596 If already marked as @samp{$}, remove the mark.
3597 (@code{wl-summary-target-mark-mark-as-important})
3600 @kindex m ! (Summary)
3601 @findex wl-summary-target-mark-mark-as-unread
3602 Mark as unread all messages which have target mark @samp{*}.
3603 (@code{wl-summary-target-mark-mark-as-unread})
3606 @kindex m o (Summary)
3607 @findex wl-summary-target-mark-refile
3608 Put refile mark on the messages which have target mark @samp{*}.
3609 (@code{wl-summary-target-mark-refile})
3612 @kindex m O (Summary)
3613 @findex wl-summary-target-mark-copy
3614 Put copy mark on the messages which have target mark @samp{*}.
3615 (@code{wl-summary-target-mark-copy})
3618 @kindex m d (Summary)
3619 @findex wl-summary-target-mark-dispose
3620 Put disposal mark on the messages which have target mark @samp{*}.
3621 (@code{wl-summary-target-mark-dispose})
3624 @kindex m i (Summary)
3625 @findex wl-summary-target-mark-prefetch
3626 Put prefetch reservation mark on messages which have target mark @samp{*}.
3627 (@code{wl-summary-target-mark-prefetch})
3630 @kindex m y (Summary)
3631 @findex wl-summary-target-mark-save
3632 Save messages which have target mark @samp{*}.
3633 (@code{wl-summary-target-mark-save})
3636 @kindex m u (Summary)
3637 Unmark all temporal marks.
3638 (@code{wl-summary-delete-all-temp-marks})
3639 @findex wl-summary-delete-all-temp-marks
3642 @kindex m a (Summary)
3643 Put target mark @samp{*} on the all messages.
3644 (@code{wl-summary-target-mark-all})
3645 @findex wl-summary-target-mark-all
3648 @kindex m t (Summary)
3649 Put target mark @samp{*} on the messages in the current thread.
3650 @findex wl-summary-target-mark-thread
3651 (@code{wl-summary-target-mark-thread})
3654 @kindex m r (Summary)
3655 @findex wl-summary-target-mark-region
3656 Put target mark @samp{*} on the messages in the specified region.
3657 (@code{wl-summary-target-mark-region})
3660 @kindex m A (Summary)
3661 @findex wl-summary-target-mark-reply-with-citation
3662 Prepare a draft which cites all messages which have target mark @samp{*}.
3663 (@code{wl-summary-target-mark-reply-with-citation})
3666 @kindex m f (Summary)
3667 @findex wl-summary-target-mark-forward
3668 Prepare a draft which forwards all messages which have target mark @samp{*}.
3669 (@code{wl-summary-target-mark-forward})
3672 @kindex m U (Summary)
3673 @findex wl-summary-target-mark-uudecode
3674 Uudecode the messages which have target mark @samp{*}.
3675 (@code{wl-summary-target-mark-uudecode})
3678 @kindex m ? (Summary)
3679 @findex wl-summary-target-mark-pick
3680 Pick messages from the @samp{*} marked messages.
3681 That is, @samp{*} marks on the messages are remained
3682 if the specified condition is satisfied.
3683 (@code{wl-summary-target-mark-pick})
3686 @kindex m # (Summary)
3687 @findex wl-summary-target-mark-print
3688 Print out all messages which have target mark @samp{*}.
3689 (@code{wl-summary-target-mark-print})
3692 @kindex m | (Summary)
3693 @findex wl-summary-target-mark-pipe
3694 Pipe content of each message with target mark @samp{*} to some specified
3696 (@code{wl-summary-target-mark-pipe})
3699 @kindex M-t (Summary)
3700 @findex wl-toggle-plugged
3701 Toggle offline/online status of Wanderlust.
3702 (@code{wl-toggle-plugged})
3705 @kindex C-t (Summary)
3706 Start Wanderlust's plug-status manager.
3707 (@code{wl-plugged-change})
3710 @kindex C-c C-o (Summary)
3711 @findex wl-jump-to-draft-buffer
3712 Move to the draft buffer if available. If multiple draft buffer exists,
3713 moved to one after another. If prefix argument is specified, load draft
3714 folder's message to the draft buffer and jump to it.
3715 (@code{wl-jump-to-draft-buffer})
3718 @kindex M-w (Summary)
3719 @findex wl-summary-save-current-message
3720 Save the message at the current cursor point.
3721 (@code{wl-summary-save-current-message})
3724 @kindex C-y (Summary)
3725 @findex wl-summary-yank-saved-message
3726 Regard the message at the current cursor point as
3727 parent, connect the message saved by
3728 @code{wl-summary-save-current-message}
3730 (@code{wl-summary-yank-saved-message})
3733 @kindex C-x C-s (Summary)
3734 @findex wl-summary-save-status
3735 Save the current summary.
3736 (@code{wl-summary-save-status})
3740 @node Variables of Summary, , Key Bindings of Summary, Summary
3741 @section Customiziable variables
3744 @item wl-summary-move-order
3745 @vindex wl-summary-move-order
3746 The initial setting is @code{unread}. Specify cursor moving policy. If
3747 you want to precede new messages, set @code{new}. If you want to
3748 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3751 @item wl-auto-select-first
3752 @vindex wl-auto-select-first
3753 The initial setting is @code{nil}.
3754 If non-nil, first message is automatically displayed when you enter
3757 @item wl-auto-select-next
3758 @vindex wl-auto-select-next
3759 The initial setting is @code{nil}. This controls behavior when there is
3760 no unread message in current summary.
3763 nil: asks whether you want to go back to folder mode
3764 'unread: asks whether you want to go to next unread folder
3765 If the next one comes to be possessing no unread message
3766 by treatment of cross-posted messages or Scoring, then
3767 asks whether you want to go to next to next folder.
3768 'skip-no-unread: similar as unread
3769 But does not ask before going to next to next folder.
3770 otherwise: asks whether you want to go to next unread folder
3773 It might be useful to set @code{'skip-no-unread} for people who
3774 want to continue reading by just pressing and pressing space key.
3776 @item wl-thread-insert-opened
3777 @vindex wl-thread-insert-opened
3778 The initial setting is @code{nil}.
3779 If non-nil, thread is inserted as opened.
3781 @item wl-thread-open-reading-thread
3782 @vindex wl-thread-open-reading-thread
3783 The initial setting is @code{t}. If non-nil, reading thread is
3784 automatically opened though it is closed thread.
3786 @item wl-summary-exit-next-move
3787 @vindex wl-summary-exit-next-move
3788 The initial setting is @code{t}. If non-nil, move to next folder at
3791 @item wl-folder-move-cur-folder
3792 @vindex wl-folder-move-cur-folder
3793 The initial setting is @code{nil}. If non-nil, cursor position on the
3796 @item wl-summary-weekday-name-lang
3797 @vindex wl-summary-weekday-name-lang
3798 Specify language of the weekday.
3799 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3800 displays Deutsch. You should rescan summary view after changing this value.
3802 @item wl-summary-fix-timezone
3803 @vindex wl-summary-fix-timezone
3804 The initial setting is @code{nil}.
3805 Time zone of the date string in summary mode is adjusted using this value.
3806 If @code{nil}, it is adjust to the default time zone information
3807 (system's default time zone or environment variable @samp{TZ}).
3809 @item wl-use-petname
3810 @vindex wl-use-petname
3811 The initial setting is @code{t}.
3812 If non-nil, sender part displays nickname.
3814 @item wl-break-pages
3815 @vindex wl-break-pages
3816 The initial setting is @code{t}.
3817 If non-nil, message is split as pages by @samp{^L}.
3819 @item wl-message-window-size
3820 @vindex wl-message-window-size
3821 The initial setting is '(1 . 4).
3822 A cons cell to specify the rate of summary and message window.
3823 car:cdr corresponds summary:message.
3825 @item wl-summary-from-function
3826 @vindex wl-summary-from-function
3827 Format function to display sender in summary.
3828 The initial setting is @code{wl-summary-default-from}.
3830 @item wl-summary-no-from-message
3831 @vindex wl-summary-no-from-message
3832 The initial setting is @samp{nobody@@nowhere?}. A string which is
3833 displayed when there's no @samp{From:} field in the message.
3835 @item wl-summary-subject-function
3836 @vindex wl-summary-subject-function
3837 Format function to display subject in summary.
3838 The initial setting is @code{wl-summary-default-subject} and
3839 it will cut the list name part etc. on the top of the subject.
3840 To display subject as it is, set as follows.
3843 (setq wl-summary-subject-function 'identity)
3846 @item wl-summary-no-subject-message
3847 @vindex wl-summary-no-subject-message
3848 The initial setting is @samp{(WL:No Subject in original.)}. A string
3849 which is displayed when there's no @samp{Subject:} field in the message.
3851 @item wl-summary-default-view
3852 @vindex wl-summary-default-view
3853 The initial setting is @code{'thread}.
3854 The default state for newly created summary. You can set either
3855 @code{'thread} for thread view or @code{'sequence} for sequential view.
3857 @item wl-summary-use-frame
3858 @vindex wl-summary-use-frame
3859 The initial setting is @code{nil}.
3860 If non-nil, use new frame for the summary.
3862 @item wl-use-folder-petname
3863 @vindex wl-use-folder-petname
3864 The initial setting is the list shown below:
3873 A list of display policy (symbol) of folder nickname. Available symbols
3878 Display folder petname on modeline.
3880 Destination folder is notified as nickname if
3881 @code{wl-auto-select-next} is non-nil.
3883 You can input folder name by nickname in the function
3884 @code{wl-summary-read-folder}.
3887 @item wl-summary-move-direction-toggle
3888 @vindex wl-summary-move-direction-toggle
3889 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3890 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3891 want to aware of reading direction, set this to @code{t}.
3893 @item wl-summary-width
3894 @vindex wl-summary-width
3895 The initial setting is 80.
3896 Width of summary line. If @code{nil}, summary line's width is as is.
3898 @item wl-summary-print-argument-within-window
3899 @vindex wl-summary-print-argument-within-window
3900 The initial setting is @code{nil}.
3901 If non-nil, the action argument is always printed on right side of
3904 @item wl-summary-indent-length-limit
3905 @vindex wl-summary-indent-length-limit
3906 The initial setting is 46.
3907 Specify the limit of thread indent level. @code{nil} means unlimited
3909 If you set this to @code{nil} you should set @code{wl-summary-width}
3912 @item wl-summary-max-thread-depth
3913 @vindex wl-summary-max-thread-depth
3914 The initial setting is 15.
3915 If thread depth of the message is larger than this value,
3916 the thread is divided.
3918 @item wl-summary-recenter
3919 @vindex wl-summary-recenter
3920 The initial setting is t.
3921 If non-nil, cursor point is moved to the center of the summary window.
3923 @item wl-summary-divide-thread-when-subject-changed
3924 @vindex wl-summary-divide-thread-when-subject-changed
3925 The initial setting is @code{nil}. If non-nil, thread is split if
3926 the subject is changed.
3928 @item wl-summary-search-via-nntp
3929 @vindex wl-summary-search-via-nntp
3930 The initial setting is @code{confirm}.
3932 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3933 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3934 from the NNTP server @code{elmo-nntp-default-server}. The value of
3935 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3936 @code{elmo-nntp-default-stream-type} are used.
3938 If @code{confirm}, server name can be specified. You can specify NNTP
3939 folder format like @samp{-:username@@servername:119!}.
3941 @item wl-summary-keep-cursor-command
3942 @vindex wl-summary-keep-cursor-command
3943 The initial setting is the list shown below:
3947 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3952 When you entered to summary by these commands and the target summary
3953 buffer already exists, summary status is not automatically updated and
3954 cursor position is saved.
3956 @item elmo-folder-update-threshold
3957 @vindex elmo-folder-update-threshold
3958 The initial setting is 500. If updated message number is larger than
3959 this value, confirm whether drop them or not (in the case where the value
3960 of @code{elmo-folder-update-confirm} is non-nil).
3962 @item elmo-folder-update-confirm
3963 @vindex elmo-folder-update-confirm
3964 The initial setting is @code{t}. If the value is non-nil, do check with
3965 @code{elmo-folder-update-threshold}.
3967 @item wl-summary-always-sticky-folder-list
3968 @vindex wl-summary-always-sticky-folder-list
3969 The initial setting is @code{nil}.
3970 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3971 are automatically stuck. Each element is regexp of folder name.
3973 @item wl-summary-reserve-mark-list
3974 @vindex wl-summary-reserve-mark-list
3975 The initial setting is the list shown below:
3979 ("o" "O" "D" "d" "i")
3984 If a message is already marked as temporal marks in this list, the
3985 message is not marked by any mark command.
3987 @item wl-summary-skip-mark-list
3988 @vindex wl-summary-skip-mark-list
3989 The initial setting is the list shown below:
3998 If a message is already marked as temporal marks in this list, the
3999 message is skipped at cursor move.
4001 @item elmo-message-fetch-threshold
4002 @vindex elmo-message-fetch-threshold
4003 The initial setting is 30000 (bytes). If displaying message has larger
4004 size than this value, Wanderlust confirms whether fetch the message or
4005 not (in the case where the value of @code{elmo-message-fetch-confirm}
4008 @item elmo-message-fetch-confirm
4009 @vindex elmo-message-fetch-confirm
4010 The initial setting is @code{t}. If the value is non-nil, do check with
4011 @code{elmo-message-fetch-threshold}.
4013 @item wl-prefetch-threshold
4014 @vindex wl-prefetch-threshold
4015 The initial setting is 30000 (bytes). If prefetching message has larger
4016 size than this value and @code{wl-prefetch-confirm} is non-nil,
4017 Wanderlust confirms whether prefetch the message or not. If
4018 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
4019 without confirmation.
4021 @item wl-prefetch-confirm
4022 @vindex wl-prefetch-confirm
4023 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4024 prefetch the message or not if the message has larger size than
4025 @code{wl-prefetch-threshold}.
4027 @item elmo-imap4-use-cache
4028 @vindex elmo-imap4-use-cache
4029 The initial setting is @code{t}. If non-nil, messages read via IMAP4
4032 @item elmo-nntp-use-cache
4033 @vindex elmo-nntp-use-cache
4034 The initial setting is @code{t}. If non-nil, messages read via NNTP are
4037 @item elmo-pop3-use-cache
4038 @vindex elmo-pop3-use-cache
4039 The initial setting is @code{t}. If non-nil, messages read via POP3 are
4042 @item elmo-shimbun-use-cache
4043 @vindex elmo-shimbun-use-cache
4044 The initial setting is @code{t}. If non-nil, messages read in Shimbun
4047 @item wl-folder-process-duplicates-alist
4048 @vindex wl-folder-process-duplicates-alist
4049 The initial setting is @code{nil}.
4050 This list determines how to deal with duplicated messages in the same folder.
4051 Each item in the list is regexp of folder name and action; you can specify any
4052 one of the following in the place of action:
4055 @code{nil} : do nothing for duplicated messages.
4056 @code{hide} : hide duplicated messages from the summary.
4057 @code{read} : set duplicated messages as read.
4061 Following is an example (hide duplicated messages in multi folders)
4065 (setq wl-folder-process-duplicates-alist
4066 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4067 ("^\\*.*" . hide) (".*" . read)))
4073 @node Message, Draft, Summary, Top
4074 @chapter Message Buffer
4076 Message Buffers utilize MIME-View mode of SEMI. For operational
4077 procedures and key bindings, refer to respective documents.
4078 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4079 You can also see help by @kbd{?} in message buffer.
4081 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4082 brings you back to Summary mode. @kbd{l} toggles display of Summary
4085 @section Key Bindings
4091 @findex wl-message-toggle-disp-summary
4092 Toggles display of Summary buffer.
4093 (@code{wl-message-toggle-disp-summary})
4096 @findex wl-message-refer-article-or-url
4097 @kindex Button-2 (Message)
4098 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4099 corresponding message if found.
4100 (@code{wl-message-refer-article-or-url})
4102 @item Button-4 (upward movement of a wheel)
4103 @kindex Button-4 (Message)
4104 @findex wl-message-wheel-down
4105 Scrolls the message backwards. When the top of the message is hit,
4106 moves to the previous message.
4107 (@code{wl-message-wheel-down})
4109 @item Button-5 (downward movement of a wheel)
4110 @kindex Button-5 (Message)
4111 @findex wl-message-wheel-up
4112 Scrolls the message forward. When the bottom of the message is hit,
4113 moves to the next message.
4114 (@code{wl-message-wheel-up})
4118 @findex wl-message-delete-current-part
4119 Delete the part under cursor. In fact it appends modified message to
4120 the current folder then moves old one to trash folder. Therefore the
4121 message number will be changed.
4122 (@code{wl-message-delete-current-part})
4125 @section Customizable Variables
4128 @item wl-message-window-size
4129 @vindex wl-message-window-size
4130 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4131 its car and cdr value corresponds to the ratio of Summary and Message
4134 @item wl-message-ignored-field-list
4135 @vindex wl-message-ignored-field-list
4136 Initial setting is @code{nil}.
4137 All fields that match this list will be hidden in message buffer.
4138 Each elements are regexp of field-name.
4139 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4141 @item wl-message-visible-field-list
4142 @vindex wl-message-visible-field-list
4143 Initial setting is @code{nil}.
4144 All fields that match this list will be display in message buffer.
4145 Each elements are regexp of field-name. This value precedes
4146 @code{wl-message-ignored-field-list}.
4147 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4149 @item wl-message-sort-field-list
4150 @vindex wl-message-sort-field-list
4152 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4153 Header fields in message buffer are ordered by this value.
4154 Each elements are regexp of field-name.
4156 @item wl-message-truncate-lines
4157 @vindex wl-message-truncate-lines
4158 The initial value is the value of @code{default-truncate-lines}.
4159 If it is non-nil, truncate long lines in message buffer.
4162 @node Draft, Disconnected Operations, Message, Top
4163 @chapter Draft Buffer
4165 At Summary mode, pressing @kbd{w} and the like creates a new draft
4166 buffer. You can edit and send mail and news articles in this buffer.
4168 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4169 with those if possible.
4172 * Usage of Draft Mode:: TIPS
4173 * Key Bindings of Draft:: Key bindings
4174 * Variables of Draft Mode:: Customize Draft Mode
4177 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4180 Basically it is Emacs-standard mail mode.
4184 * Editing Message Body::
4185 * Dynamical Message Re-arrangement::
4190 @node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
4191 @subsection Editing Message Header
4193 You can freely edit header region above @samp{--text follows this line--},
4194 until you invoke the sending operation.
4196 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4197 addresses. @kbd{@key{TAB}} completes them.
4199 You can use following headers to specify recipients. Add some of them
4200 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4203 @item @samp{Newsgroups:}
4204 Specify newsgroups to which you post the news article.
4207 Specify addresses to send a copy (Carbon Copy) of the message.
4210 Following ones are removed from the header contents before sending.
4214 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4217 Specify folders in which a copy of the message is saved.
4220 Specify recipients to send encapsulated copy of the message.
4223 You can add initial headers by following variables.
4229 The initial setting is @code{nil}.
4230 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4231 the draft when it is prepared. If function is specified, its return
4236 The initial setting is @code{nil}.
4237 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4238 the draft when it is prepared.
4241 @node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4242 @subsection Editing Messages
4244 As a matter of course, editing message body can be performed in the same
4245 way as usual writing. You may write message body under
4246 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4247 @samp{--text follows this line--} intact.)
4249 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4250 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4251 a MIME user interface for GNU Emacs}.
4252 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4254 If you save the draft buffer you are editing, it is appended to the
4255 folder specified by @code{wl-draft-folder}.
4257 @node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
4258 @subsection Dynamic Modification of Messages
4259 @vindex wl-draft-config-alist
4260 @c @cindex Change Message
4261 @c @cindex Message, Change Dynamic
4263 You can set @code{wl-draft-config-alist} so that header and body of the
4264 message will automatically modified depending on information of header
4267 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4269 In the example below, the header is modified when
4270 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4271 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4272 before sending the message.
4276 (setq wl-draft-config-alist
4277 '(((string-match "aaa\\.example\\.com$" (system-name))
4278 ;; @r{applied if the expression is non-nil}
4279 (wl-smtp-posting-server . "mailserver-B")
4280 (wl-nntp-posting-server . "newsserver-B")
4281 ;; @r{settings of temporary variables}
4283 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4284 ;; @r{applied if it matches the header of the draft buffer}
4285 ("Organization" . (format "Go %s" my-webpage)))
4286 ;; @r{you can write elisp expressions here (eval only)}
4287 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4288 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4293 The format of @code{wl-draft-config-alist} is:
4297 '(("@var{regexp of the header}" or @var{elisp expression}
4298 ("@var{Field}" . value(@var{elisp expression}))
4299 (@var{variable} . value(@var{elisp expression}))
4300 (@var{sub-function} . value(@var{elisp expression}))
4303 ("@var{regexp of the header}" or @var{elisp expression}
4304 ("@var{Field}" . value(@var{elisp expression}))
4309 Per default, there are 13 following sub-functions.
4312 'header: Inserts the specified string at the bottom of the header.
4313 'header-top: Inserts the specified string at the top of the header.
4314 'header-file: Inserts the specified file at the bottom of the header.
4315 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4316 'top: Inserts the specified string at the top of the body.
4317 'top-file: Inserts the specified file at the top of the body.
4318 'body: Replaces the body with the specified string.
4319 Specifying @code{nil} deletes the entire body string.
4320 'body-file: Replaces the body with the content of the specified file.
4321 'bottom: Inserts the specified string at the bottom of the body.
4322 'bottom-file: Inserts the specified file at the top of the body.
4323 'part-top: Inserts the specified string at the top of the current part.
4324 'part-bottom: Inserts the specified string at the bottom of the current part.
4325 'template: Applies the specified template.
4326 (refer to the next subsection)
4329 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4330 change them or add your own functions. If you read the code, you can
4331 easily find how to write the functions.
4333 At the first of each item, @var{a regular expression of the header} or
4334 an @var{elisp expression} should be specified. In the case of an elisp
4335 expression, the item is applied when the expression is evaluated
4338 Per default, when multiple items match or are evaluated non-nil, all
4339 such items are applied, but if you set a variable
4340 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4343 At the second of the item, a cons or a list of functions should be
4344 specified. The car part of the cons should be a header field, a
4345 variable, or a sub-function. When a header field is specified, the
4346 field will be modified. If a variable is specified, the value of the
4347 variable will be modified temporarily.
4349 In the cdr part of a cons, not only a variable but also an elisp
4350 expression can be specified as is. If the car part is a header field
4351 and the cdr part is @code{nil}, the field will be deleted.
4353 See the next example as well:
4357 (setq wl-draft-config-alist
4359 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4360 ;; @r{applied if it matches the header of the buffer being replied}
4361 (body . " Hello.\n")
4362 (template . "default")
4367 As in the (1) above, if a header regexp is prepended with @code{reply},
4368 it is applied when the draft is prepared by @code{wl-summary-reply} for
4369 example, and when it matches the header being replied. It is ignored
4370 when there is no buffer being replied, like after @code{wl-draft} was
4373 If you want to use name of parent folder, you can refer the buffer local
4374 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4375 changes From according to the folder name of the summary in which the draft
4380 (setq wl-draft-config-alist
4381 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4382 (\"From\" . \"user@@domain1\"))
4383 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4384 (\"From\" . \"user@@domain2\"))))
4389 Note that @code{wl-draft-config-alist} is applied only once when
4390 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4391 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4392 aborting transmission, execute @kbd{C-c C-e}
4393 (@code{wl-draft-config-exec}) explicitly.
4395 If you don't want to apply @code{wl-draft-config-alist} when
4396 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4400 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4403 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4404 prepared, do the following:
4407 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4410 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4411 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4415 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4418 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4419 @subsection Inserting Templates
4421 @cindex Apply Template
4423 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4424 @kbd{M-x wl-template-select} in the draft buffer.
4426 The format of @code{wl-template-alist} is almost the same as
4427 @code{wl-draft-config-alist}.
4431 (setq wl-template-alist
4434 ("Organization" . "Example Co.Ltd.")
4435 (body . "Hello.\n"))
4437 (template . "default") ;; @r{(a)}
4438 ("To" . "boss@@example.com")
4439 ("Subject" . "Report")
4440 (body-file . "~/work/report.txt")
4446 As you can see, the only difference is item (template) names such as
4447 @samp{default} and @samp{report}, instead of a regexp of header.
4448 Because definition of each item is the same as
4449 @code{wl-draft-config-alist}, you can call another template, like (a).
4451 Executing the command @code{wl-template-select} results in template
4452 selection, but the result differs depending on variable
4453 @code{wl-template-visible-select}.
4455 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4456 window is shown below the draft buffer. You can select a template by
4457 @kbd{n} and @kbd{p} seeing the buffer window.
4459 Press the @key{RET} key and the template is actually applied to the draft
4460 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4461 adjust the window size by @code{wl-template-buffer-lines}.
4463 If @code{wl-template-visible-select} is @code{nil}, you should type the
4464 name of the template in the mini buffer.
4466 As shown in the example in @code{wl-draft-config-alist}, you can select
4467 @samp{default} template by writing:
4470 (template . "default")
4473 @node POP-before-SMTP, , Template, Usage of Draft Mode
4474 @subsection Sending mail by POP-before-SMTP
4475 @cindex POP-before-SMTP
4477 You can send mail by POP-before-SMTP with this single line:
4480 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4484 Configure the following variables if you need.
4487 @item wl-pop-before-smtp-user
4488 The POP user name for POP-before-SMTP authentication.
4489 If unset, @code{elmo-pop3-default-user} is used.
4491 @item wl-pop-before-smtp-server
4492 The POP server name for POP-before-SMTP authentication.
4493 If unset, @code{elmo-pop3-default-server} is used.
4495 @item wl-pop-before-smtp-authenticate-type
4496 The POP authentication method for POP-before-SMTP authentication.
4497 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4499 @item wl-pop-before-smtp-port
4500 The POP port number for POP-before-SMTP authentication.
4501 If unset, @code{elmo-pop3-default-port} is used.
4503 @item wl-pop-before-smtp-stream-type
4504 If non-nil, POP connection is established using SSL. If
4505 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4506 unset, @code{elmo-pop3-default-stream-type} is used.
4509 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4510 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4512 Therefore, if SMTP server and POP server are actually the same, and if
4513 POP folder per default (such as @samp{&}) is available, no settings are
4516 Refer to the following URL about POP-before-SMTP.
4520 http://spam.ayamura.org/tools/smPbS.html
4521 http://www.iecc.com/pop-before-smtp.html
4526 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4527 @section Key Bindings
4528 @cindex Keybind, Draft Mode
4529 @cindex Keybind, Draft Buffer
4534 @kindex C-c C-y (Draft)
4535 @findex wl-draft-yank-original
4536 Cites the content of the current message buffer (the part under cursor).
4537 If the region is active, cites the region (it affects only if
4538 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4539 (on XEmacs) is Non-nil).
4540 (@code{wl-draft-yank-original})
4543 @kindex C-c C-p (Draft)
4544 @findex wl-draft-preview-message
4545 Previews the content of the current draft.
4546 This is useful for previewing MIME multi-part messages.
4547 (@code{wl-draft-preview-message})
4550 @kindex C-c C-s (Draft)
4551 @findex wl-draft-send
4552 Sends the content of the current draft. Does not erase the draft buffer.
4553 This is useful for sending multiple messages, which are a little different
4555 (@code{wl-draft-send})
4558 @kindex C-c C-c (Draft)
4559 @findex wl-draft-send-and-exit
4560 Sends the content of the current draft and erases the draft buffer.
4561 (@code{wl-draft-send-and-exit})
4564 @kindex C-x C-s (Draft)
4565 @findex wl-draft-save
4566 Save the current draft.
4567 (@code{wl-draft-save})
4570 @kindex C-c C-k (Draft)
4571 @findex wl-draft-kill
4572 Kills the current draft.
4573 (@code{wl-draft-kill})
4576 @kindex C-x k (Draft)
4577 @findex wl-draft-mimic-kill-buffer
4578 Kills the current draft.
4579 (@code{wl-draft-mimic-kill-buffer})
4582 @kindex C-c C-z (Draft)
4583 @findex wl-draft-save-and-exit
4584 Saves the current draft, and erases the draft buffer.
4585 This is useful if you want to suspend editing of the draft.
4586 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4587 the @samp{+draft} folder.
4588 (@code{wl-draft-save-and-exit})
4591 @kindex C-c C-r (Draft)
4592 @findex wl-caesar-region
4593 Encodes or decodes the specified region in Caesar cipher.
4594 (@code{wl-caesar-region})
4598 @findex wl-draft-highlight-and-recenter
4599 Recenter and rehighlight current draft.
4600 (@code{wl-draft-highlight-and-recenter})
4604 @findex wl-toggle-plugged
4605 Toggles off-line/on-line states of Wanderlust.
4606 (@code{wl-toggle-plugged})
4609 @kindex C-c C-o (Draft)
4610 @findex wl-jump-to-draft-buffer
4611 Jumps to the other draft buffer, if exists.
4612 With prefix argument, reads a file (if any) from the draft folder when
4613 there is no such buffer.
4614 (@code{wl-jump-to-draft-buffer})
4617 @kindex C-c C-e (Draft)
4618 @findex wl-draft-config-exec
4619 Applies @code{wl-draft-config-alist}.
4620 (@code{wl-draft-config-exec})
4623 @kindex C-c C-j (Draft)
4624 @findex wl-template-select
4626 (@code{wl-template-select})
4629 @kindex C-c C-a (Draft)
4631 Enter Address Manager.
4632 @xref{Address Manager}.
4636 @kindex C-c C-d (Draft)
4637 @findex wl-draft-elide-region
4638 Elide the text between point and mark (@code{wl-draft-elide-region}).
4639 The text is killed and replaced with the contents of the variable
4640 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4644 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4645 @section Customizable Variables
4648 @item wl-subscribed-mailing-list
4649 @vindex wl-subscribed-mailing-list
4650 The initial setting is @code{nil}. Mailing lists to which you
4651 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4652 field of a reply draft, removes your own address from
4653 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4654 contained in @samp{To:} or @samp{Cc:} field of a message to be
4655 automatically re-filed, the destination folder will be leaned in
4656 connection with the address.
4662 (setq wl-subscribed-mailing-list
4663 '("wl@@lists.airs.net"
4665 "emacs-mime-ja@@m17n.org"))
4669 @item wl-insert-mail-followup-to
4670 @vindex wl-insert-mail-followup-to
4671 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4672 field is automatically inserted in the draft buffer.
4674 @item wl-insert-mail-reply-to
4675 @vindex wl-insert-mail-reply-to
4676 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4677 field is automatically inserted in the draft buffer.
4679 @item wl-auto-insert-x-face
4680 @vindex wl-auto-insert-x-face
4681 The initial setting is @code{t}. If non-nil and there is an encoded
4682 X-Face string in a file @file{~/.xface} (the value of the variable
4683 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4684 draft buffer. If @code{nil}, it is not automatically inserted.
4686 @item wl-insert-message-id
4687 @vindex wl-insert-message-id
4688 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4689 is automatically inserted on the transmission.
4691 @item wl-message-id-use-wl-from
4692 @vindex wl-message-id-use-wl-from
4693 The initial setting is @code{nil}. If non-nil, the value of
4694 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4696 @item wl-local-domain
4697 @vindex wl-local-domain
4698 The initial setting is @code{nil}. If @code{nil}, the return value of
4699 the function @code{system-name} will be used as the domain part of
4702 If @code{system-name} does not return FQDN (i.e. the full name of the
4703 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4704 to the string of the local domain name without hostname (like
4705 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4706 @samp{.} @code{wl-local-domain} is used as domain part of the
4709 If your terminal does not have global IP, set the value of
4710 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4711 you use invalid @samp{Message-ID:}.)
4713 Moreover, concatenation of @code{system-name} @samp{.}
4714 @code{wl-local-domain} will be used as an argument to the HELO command
4717 @item wl-message-id-domain
4718 @vindex wl-message-id-domain
4719 The initial setting is @code{nil}. If non-nil, this value is used as a
4720 domain part of the @samp{Message-ID:}. If your terminal does not have
4721 global IP address, set unique string to this value (e.x. your e-mail
4724 @item wl-unique-id-suffix
4725 @vindex wl-unique-id-suffix
4726 The initial setting is @samp{.wl}. You can specify the string in generated
4727 Message-ID which appear just before @samp{@@}.
4729 @item wl-draft-config-alist
4730 @vindex wl-draft-config-alist
4731 The initial setting is @code{nil}. Modifies the draft message just
4732 before the transmission. The content of @code{wl-draft-config-alist}
4733 will be automatically applied only once on the transmission. If you
4734 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4737 @item wl-template-alist
4738 @vindex wl-template-alist
4739 The initial setting is @code{nil}.
4740 This variable specifies the template to be applied in the draft buffer.
4742 @item wl-draft-config-matchone
4743 @vindex wl-draft-config-matchone
4744 The initial setting is @code{nil}. If non-nil, only the first matching
4745 item is used when @code{wl-draft-config-alist} is applied. If
4746 @code{nil}, all matching items are used.
4748 @item wl-template-visible-select
4749 @vindex wl-template-visible-select
4750 The initial setting is @code{t}.
4751 If non-nil, you can preview the result of the template selection in
4754 @item wl-template-confirm
4755 @vindex wl-template-confirm
4756 The initial setting is @code{nil}.
4757 If non-nil, asks for confirmation when you press the enter key to select
4758 template while previewing.
4760 @item wl-template-buffer-lines
4761 @vindex wl-template-buffer-lines
4762 The initial setting is 7.
4763 If @code{wl-template-visible-select} is non-nil, this variable specifies
4764 the size of the preview window.
4766 @item wl-draft-buffer-style
4767 @vindex wl-draft-buffer-style
4768 The initial setting is @code{full}.
4769 Style of draft buffer window (except for replying and forwarding).
4770 @code{keep} is to use current window,
4771 @code{full} is to use full frame window,
4772 @code{split} is to split current window and use it.
4773 If some function is specified, it is called with the draft buffer
4776 @item wl-draft-reply-buffer-style
4777 @vindex wl-draft-reply-buffer-style
4778 The initial setting is @code{split}.
4779 Style of draft buffer for replying and forwarding.
4780 @code{keep} is to use message buffer window,
4781 @code{full} is to use full frame window,
4782 @code{split} is to split message buffer window and use it.
4783 If some function is specified, it is called with the draft buffer
4786 @item wl-draft-use-frame
4787 @vindex wl-draft-use-frame
4788 The initial setting is @code{nil}.
4789 If non-nil, use new frame for the draft.
4791 @item wl-draft-truncate-lines
4792 @vindex wl-draft-truncate-lines
4793 The initial value is the value of @code{default-truncate-lines}.
4794 If it is non-nil, truncate long lines in draft buffer.
4798 The initial setting is the value of the variable
4799 @code{user-mail-address}. The value of this variable is inserted as a
4800 @samp{From:} field of the draft when it is prepared.
4802 @item wl-envelope-from
4803 @vindex wl-envelope-from
4804 The initial setting is @code{nil}.
4805 The value of this variable is used for envelope from (MAIL FROM).
4806 If @code{nil}, the address part of @code{wl-from} is used.
4808 @item wl-user-mail-address-list
4809 @vindex wl-user-mail-address-list
4810 The initial setting is @code{nil}.
4811 This is the User's address list. If you have multiple addresses,
4814 @item wl-reply-subject-prefix
4815 @vindex wl-reply-subject-prefix
4816 The initial setting is @samp{Re: }.
4817 In the @samp{Subject:} of the reply draft, this string is prepended to
4818 the @samp{Subject:} of being replied.
4820 @item wl-forward-subject-prefix
4821 @vindex wl-forward-subject-prefix
4822 The initial setting is @samp{Forward: }.
4823 In the @samp{Subject:} of the forwarding draft, this string is prepended
4824 to the @samp{Subject:} of being forwarded.
4826 @item wl-draft-reply-use-address-with-full-name
4827 @vindex wl-draft-reply-use-address-with-full-name
4828 The initial setting is @code{t}.
4829 If non-nil, insert her full name with address when prepare a draft for
4830 reply a message. If it is @code{nil}, insert her address only.
4832 @item wl-draft-enable-queuing
4833 @vindex wl-draft-enable-queuing
4834 The initial setting is @code{t}.
4835 This flag controls off-line transmission. If non-nil, the draft is
4838 @item wl-draft-use-cache
4839 @vindex wl-draft-use-cache
4840 The initial setting is @code{nil}. If the value is non-nil and
4841 @code{wl-insert-message-id} is nil, cache the message which is sent.
4843 @item wl-fcc-force-as-read
4844 @vindex wl-fcc-force-as-read
4845 The initial setting is @code{nil}. If the value is non-nil,
4846 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4848 @item wl-auto-flush-queue
4849 @vindex wl-auto-flush-queue
4850 The initial setting is t.
4851 This flag controls automatic transmission of the queue when Wanderlust
4852 becomes on-line. If non-nil, the queue is automatically transmitted
4853 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4854 manually, press @kbd{F} in the folder mode.
4856 @item wl-ignored-forwarded-headers
4857 @vindex wl-ignored-forwarded-headers
4858 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4859 All headers that match this regexp will be deleted when forwarding a message.
4861 @item wl-ignored-resent-headers
4862 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4863 All headers that match this regexp will be deleted when resending a message.
4865 @item wl-draft-always-delete-myself
4866 @vindex wl-draft-always-delete-myself
4867 If non-nil, always removes your own address from @samp{To:} and
4868 @samp{Cc:} when you are replying to the mail addressed to you.
4870 @item wl-draft-delete-myself-from-bcc-fcc
4871 @vindex wl-draft-delete-myself-from-bcc-fcc
4872 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4873 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
4875 @item wl-smtp-posting-server
4876 @vindex wl-smtp-posting-server
4877 The initial setting is @code{nil}.
4878 This is the SMTP server name for mail transmission.
4880 @item wl-smtp-posting-port
4881 @vindex wl-smtp-posting-port
4882 The initial setting is @code{nil}.
4883 This is the SMTP port number for mail transmission.
4884 If @code{nil}, default SMTP port number (25) is used.
4886 @item wl-smtp-posting-user
4887 @vindex wl-smtp-posting-user
4888 The initial setting is @code{nil}.
4889 This is the user name for SMTP AUTH authentication. If @code{nil},
4890 @code{smtp-authenticate-user} is used.
4892 @item wl-smtp-authenticate-type
4893 @vindex wl-smtp-authenticate-type
4894 The initial setting is @code{nil}.
4895 This is the authentication method for SMTP AUTH authentication. If
4896 @code{nil}, @code{smtp-authenticate-type} is used. If
4897 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4900 @item wl-smtp-connection-type
4901 @vindex wl-smtp-connection-type
4902 The initial setting is @code{nil}.
4903 This variable specifies how to establish SMTP connections.
4904 If @code{nil}, use default connection type.
4905 If it is @code{starttls}, use STARTTLS (RFC2595).
4906 If it is @code{ssl}, use SSL.
4908 @item wl-nntp-posting-server
4909 @vindex wl-nntp-posting-server
4910 The initial setting is @code{nil}.
4911 This is the NNTP server name used for news submission.
4912 If @code{nil}, @code{elmo-nntp-default-server} is used.
4914 @item wl-nntp-posting-user
4915 @vindex wl-nntp-posting-user
4916 The initial setting is @code{nil}.
4917 This is the user name for AUTHINFO authentication on news submission.
4918 If @code{nil}, @code{elmo-nntp-default-user} is used.
4919 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4921 @item wl-nntp-posting-port
4922 @vindex wl-nntp-posting-port
4923 The initial setting is @code{nil}.
4924 This is the port number of the NNTP server used for news submission.
4925 If @code{nil}, @code{elmo-nntp-default-server} is used.
4927 @item wl-nntp-posting-stream-type
4928 @vindex wl-nntp-posting-stream-type
4929 The initial setting is @code{nil}.
4930 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4931 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4932 connection will be established.
4934 @item wl-nntp-posting-function
4935 @vindex wl-nntp-posting-function
4936 The initial setting is @code{elmo-nntp-post}.
4937 This is the function to post NNTP message.
4939 @item wl-nntp-posting-config-alist
4940 @vindex wl-nntp-posting-config-alist
4941 The initial setting is @code{nil}.
4942 The value takes an alist to define NNTP server like following example.
4943 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
4947 (setq wl-nntp-posting-config-alist
4948 '((",?gmane\\." . "news.gmane.org")
4950 ((server . "news-server")
4951 (user . "newsmaster")
4953 (function . elmo-nntp-post)))
4954 (".*" . "default-news-server")))
4958 @item wl-pop-before-smtp-user
4959 @vindex wl-pop-before-smtp-user
4960 The initial setting is @code{nil}.
4961 This is the POP user name for POP-before-SMTP.
4962 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4964 @item wl-pop-before-smtp-server
4965 @vindex wl-pop-before-smtp-server
4966 The initial setting is @code{nil}.
4967 This is the POP server name for POP-before-SMTP.
4968 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4970 @item wl-pop-before-smtp-authenticate-type
4971 @vindex wl-pop-before-smtp-authenticate-type
4972 The initial setting is @code{nil}.
4973 This is the authentication method for POP-before-SMTP authentication.
4974 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4976 @item wl-pop-before-smtp-port
4977 @vindex wl-pop-before-smtp-port
4978 The initial setting is @code{nil}.
4979 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4980 @code{elmo-pop3-default-port} is used.
4982 @item wl-pop-before-smtp-stream-type
4983 @vindex wl-pop-before-smtp-stream-type
4984 The initial setting is @code{nil}.
4985 This flag controls the use of SSL for POP-before-SMTP. If it is
4986 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4987 STARTTLS (RFC2595) connection will be established.
4989 @item wl-draft-queue-save-variables
4990 @vindex wl-draft-queue-save-variables
4991 Specifies a list of variable to which queued messages are saved on the
4992 off-line transmission.
4994 @item wl-draft-sendlog
4995 @vindex wl-draft-sendlog
4996 The initial setting is @code{t}.
4997 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
5001 @item drafts are sent by smtp or qmail
5002 @item saved into folders by fcc
5003 @item saved into folders by queuing
5006 (it is written even if the transmission fails).
5007 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
5008 and left to the logging function of @command{imput}.
5011 @item wl-draft-sendlog-max-size
5012 @vindex wl-draft-sendlog-max-size
5013 The initial setting is 20000 (in bytes).
5014 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
5015 beyond the size specified by this variable.
5019 The initial setting is @code{nil}.
5020 If non-nil, address completion uses LDAP.
5022 @item wl-ldap-server
5023 @vindex wl-ldap-server
5024 The initial setting is @samp{localhost}.
5025 LDAP server name for address completion.
5028 @vindex wl-ldap-port
5029 The initial setting is @code{nil}.
5030 If non-nil, the value is used as port number.
5033 @vindex wl-ldap-base
5034 The initial setting is @samp{c=US}.
5035 LDAP search starting point (base) for address completion.
5037 @item wl-draft-remove-group-list-contents
5038 @vindex wl-draft-remove-group-list-contents
5039 The initial setting is @code{t}.
5040 If non-nil, remove the group-lists' members in the recipients when
5041 sending the message (group-list means the description such as
5042 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5045 @node Disconnected Operations, Expire and Archive, Draft, Top
5046 @chapter Off-line Management
5047 @cindex Disconnected Operations
5049 Wanderlust has on-line and off-line states.
5052 * Off-line State:: Wanderlust has on-line and off-line states
5053 * Enable Operations:: Enable Disconnected Operations
5054 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5055 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5056 * Variables of Plugged Mode:: Customize Plugged Mode
5060 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5061 @section Off-line State
5063 Wanderlust has on-line and off-line states. In the off-line state, you
5064 cannot access messages via network, unless they are cached.
5066 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5067 in the mode line indicates the off-line state. In folder or summary
5068 modes, press @kbd{M-t} to switch between off- and on-line.
5070 You can invoke Wanderlust in the off-line state by setting
5071 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5073 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5074 ignores uncached messages.
5077 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5078 @section Enable Disconeected Operations
5080 Even in the off-line state, provided that relevant messages are cached,
5081 and the variable @code{elmo-enable-disconnected-operation} (described
5082 later) is non-nil, you can following operations:
5083 @xref{Plugged Mode}, @xref{Off-line State settings}.
5086 * Send Messages off-line:: Transmit Messages
5087 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5088 * Creation of Folders:: Create Folders off-line (IMAP4)
5089 * Marking:: Mark (IMAP4)
5090 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
5093 As soon as Wanderlust becomes on-line, such operations invoked off-line
5094 are reflected in the servers via network.
5097 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5098 @subsection Transmission of Messages
5100 You can proceed sending operation for mail/news messages while you are
5101 off-line, then it will be reserved for sending (if you are using
5102 @file{im-wl.el}, it is irrelevant).
5103 Messages reserved for sending while off-line are accumulated in the
5104 queue folder, @samp{+queue}. These messages are transmitted at once when
5105 Wanderlust becomes on-line.
5107 You can visit @samp{+queue} in the off-line state and confirm content of
5108 messages in the queue. You can also remove messages. Removed messages
5109 are not transmitted even in the on-line state.
5112 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5113 @subsection Re-file and Copy (IMAP4)
5115 Re-file and copy operations to IMAP folders invoked during the off-line
5116 state are accumulated in the queue, and reflected in the server side
5117 when Wanderlust becomes on-line. If you visit destination folders after
5118 off-line re-file or copy, it looks as if messages were appended even in
5121 For the safety reasons, messages re-filed off-line are removed from
5122 source folders only if their @samp{Message-ID:} match messages on the
5123 servers. While the queue is processed, messages that failed to be
5124 re-filed or copied to the specified folders are appended to the folder
5128 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5129 @subsection Creation of Folders (IMAP4)
5131 You can create IMAP folders off-line. The creation of folders are
5132 reflected in the servers when Wanderlust becomes on-line. If the creation
5133 of those folders fails at that time for some reasons, messages
5134 to be re-filed into those are appended to the folder @samp{+lost+found}
5138 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5139 @subsection Marking (IMAP4)
5141 Off-line changes in unread/read and importance mark @samp{$} information
5142 are also reflected in the servers when Wanderlust becomes on-line.
5145 @node Pre-fetching Reservations, , Marking, Enable Operations
5146 @subsection Pre-fetching (IMAP4, NNTP)
5148 You can make reservations for pre-fetching messages in IMAP or NNTP
5149 folders. Reserved messages are marked with @samp{!} but not cached
5150 yet. When Wanderlust becomes on-line, they are pre-fetched from
5153 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5154 these off-line operations for IMAP4 and NNTP do not take place, and
5155 off-line re-file, copy or suchlike simply results in error.
5157 Because off-line operations use cache files, it is a bad idea to erase
5158 them by hand; it may cause Wanderlust to malfunction.
5160 If you want to remove caches, be sure to execute @kbd{M-x
5161 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5162 remove caches for messages relevant to off-line operations.
5165 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5166 @section Switching On-line/Off-line per Server/Port
5168 @kbd{M-t} described above switches networking states as a whole, but you
5169 can switch on-line/off-line per server/port.
5171 Pressing @kbd{C-t} in the folder or summary modes brings you in
5172 wl-plugged-mode shown below, in which you can change the plugged state
5177 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5180 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5181 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5183 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5184 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5190 The first line indicates status of the following three variables, and
5191 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5192 column modifies the values of these variables.
5196 "Queuing" @code{wl-draft-enable-queuing}
5197 "AutoFlushQueue" @code{wl-auto-flush-queue}
5198 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5202 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5205 The second and after lines indicate on-line/off-line states of servers
5206 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5207 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5208 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5210 @dfn{sending queue} means messages accumulated in the folder
5211 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5212 off-line operations when @code{elmo-enable-disconnected-operation} is
5214 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5215 @c off-line operations are enabled.
5217 They are displayed if there are any of them. In the example above, in
5218 the sending queue there are two messages (the first and the second in
5219 the queue folder) for smtp to hosta and one (the third) for nntp to
5220 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5223 If you change @samp{(wl-plugged)} in the second line, the variable
5224 @code{wl-plugged} is changed, so that the mode line indicator and
5225 plugged states of all ports are affected. If you change plugged states
5226 of any servers or ports, @samp{(wl-plugged)} in the second line is
5227 affected depending on @code{elmo-plugged-condition} settings and the
5228 plugged state of each port.
5231 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5232 @section Invoking Wanderlust in the Off-line State
5234 As described before, if you set @code{wl-plugged} to @code{nil} in
5235 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5236 off-line state. You can specify off-line state on a per server or port
5237 basis. Refer to @code{wl-reset-plugged-alist} also.
5239 Usually, when Wanderlust starts up, the plugged state of each port is
5240 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5241 @code{wl-nntp-posting-server} and so on. If you want to change the
5242 plugged state of these ports or to add other ports, configure
5243 @code{wl-make-plugged-hook} with a function.
5247 (add-hook 'wl-make-plugged-hook
5249 (elmo-set-plugged plugged-value(t/nil) server port)
5250 ;; @r{add or change plugged states of the port of the server}
5251 (elmo-set-plugged plugged-value(t/nil) server)
5252 ;; @r{if the port is omitted, all ports are affected}
5253 ;; @r{(you cannot omit the port if you newly add the server)}
5259 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5260 @section Customizable Variables
5265 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5266 mode from the beginning.
5268 @item wl-queue-folder
5269 @vindex wl-queue-folder
5270 The initial setting is @samp{+queue}.
5271 This is the folder in which messages in the transmission queue are
5274 @item wl-auto-flush-queue
5275 @vindex wl-auto-flush-queue
5276 The initial setting is @code{t}.
5277 This flag controls automatic transmission of the queue when Wanderlust
5278 becomes on-line. If non-nil, the queue is automatically transmitted
5279 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5280 manually, press @kbd{F} in the folder mode.
5282 @item elmo-enable-disconnected-operation
5283 @vindex elmo-enable-disconnected-operation
5284 The initial setting is @code{t}. Controls off-line operations
5285 regarding IMAP4. If non-nil, off-line operations are carried out.
5287 @item elmo-lost+found-folder
5288 @vindex elmo-lost+found-folder
5289 The initial setting is @samp{+lost+found}.
5290 This is the folder to which messages are saved when they fails to be
5291 appended while the off-line re-file/copy queue is processed.
5293 @item elmo-plugged-condition
5294 @vindex elmo-plugged-condition
5295 The initial setting is @code{one}.
5296 The value of @code{wl-plugged} reflects the return value of the function
5297 @code{elmo-plugged-p} (without arguments).
5298 This variable @code{elmo-plugged-condition} specifies the condition on
5299 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5300 plugged state of each port.
5303 'one : plugged if one or more ports are plugged.
5304 'all : plugged if all ports are plugged.
5305 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5306 states of the ports.
5307 @var{function} : reflects the return value of the @var{function}
5308 functions available per default
5309 'elmo-plug-on-by-servers
5310 : reflects the plugged state of the servers specified by the
5311 variable elmo-plug-on-servers.
5312 'elmo-plug-on-by-exclude-servers
5313 : reflects the plugged state of the servers that are not
5314 in elmo-plug-on-exclude-servers.
5315 elmo-plug-on-exclude-servers defaults to
5318 (system-name)without the domain part)
5324 (setq elmo-plugged-condition 'all)
5326 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5327 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5329 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5330 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5334 @item wl-reset-plugged-alist
5335 @vindex wl-reset-plugged-alist
5336 The initial setting is @code{t}. If non-nil, plugged states are
5337 initialized on a per server or port basis when Wanderlust starts up.
5339 If @code{nil}, plugged states are retained while Emacs is running. In
5340 other words, they are initialized when Emacs is restarted even if the
5341 value is @code{nil}.
5345 @node Expire and Archive, Scoring, Disconnected Operations, Top
5346 @chapter Automatic Expiration and Archiving of Messages
5347 @cindex Expire and Archive
5350 * Expire:: Expiration and Archiving
5351 * Archive:: Archiving All Messages
5355 @node Expire, Archive, Expire and Archive, Expire and Archive
5357 @cindex Expire Message
5359 Expiration means deletion of old messages which have outlasted a
5360 certain period of time.
5362 @code{wl-expire} supports not only simple deletion, but also moving to
5363 specified archiving folders.
5367 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5368 or @kbd{M-e} in the summary mode.
5370 @subsection Configuring @code{wl-expire-alist}
5372 An example configuration of @code{wl-expire-alist} is shown below.
5373 Everything in this @code{wl-expire-alist} makes a great difference in
5374 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5375 to @code{t}, especially in the initial stage.
5379 (setq wl-expire-alist
5380 '(("^\\+trash$" (date 14) remove)
5382 ("^\\+tmp$" (date 7) trash)
5383 ;; @r{re-file to @code{wl-trash-folder}}
5384 ("^\\+outbox$" (number 300) "$outbox;lha")
5385 ;; @r{re-file to the specific folder}
5387 ;; @r{do not expire}
5388 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5389 ;; @r{archive by message number (retaining numbers)}
5390 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5391 ;; @r{archive by a fixed number (retaining numbers)}
5392 ("^\\+diary$" (date 30) wl-expire-archive-date)
5393 ;; @r{archive by year and month (numbers discarded)}
5398 Items in the list has the format of:
5401 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5405 The folder is examined if it matches @var{regexp-for-folders} from the
5406 beginning of the list. If you invoke expiration on the folder that does
5407 not match any of them, nothing will happen. And if either the second or
5408 the third element of the item is @code{nil}, expiration will not take
5411 You can use any one of the following for
5412 @var{specification-of-message-to-be-deleted}:
5415 @item (number @var{n1} [@var{n2}])
5416 deletes messages depending on the number of messages in the folder.
5418 @var{n1} is the number of messages which should survive deletion, for example
5419 if its value is 500, the newest 500 messages survive and the rests are
5422 @var{n2} is the number of messages in the folder on which expiration should
5423 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5424 folders with 510 or more messages are expired.
5425 If you configured automatic expiration, frequently used folders may
5426 expire every time it receive messages, and you may be annoyed with the
5427 long delay in reading mail.
5428 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5429 expiration would not take place until a certain number of messages
5432 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5433 with important/new/unread) are not deleted.
5434 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5435 will expire so as to have 500 messages including such ones.
5436 Otherwise, it will have 500 messages except such ones.
5438 @item (date @var{d1})
5439 deletes messages depending on the dates.
5441 Messages dated @var{d1} or more days ago are deleted, for example if its
5442 value is seven, messages seven days old or more are deleted. Note that
5443 the date is the one in the @samp{Date:} field of the message, not when
5444 the message entered the folder.
5446 Messages with no or invalid @samp{Date:} field does not expire; you
5447 might have to delete them by hand.
5450 You can use any one of the following in the place of @var{destination}:
5454 deletes the messages instantly.
5457 hide the messages from summary (messages are not deleted).
5460 moves the messages to @code{wl-trash-folder}.
5462 @item @var{string}(folder)
5463 moves the messages to the folder specified with @var{string}.
5465 It would be useful for specifying an archiving folder, but because this
5466 does not move important messages, it might be better to use the
5467 standard functions described below.
5469 @item @var{function}
5470 invokes the specified @var{function}.
5472 To the @var{function}, three arguments are passed: a folder name, a list
5473 of messages to be deleted, and msgdb information of the summary. You
5474 can specify function-specific arguments after the name of the
5475 @var{function}. Note that the list contains messages with marks in
5476 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5479 These are four standard functions; three of them move messages to an archive
5480 folder in the specified way. This means old messages can be compressed
5481 and saved in a file, being deleted from the original folder.
5482 The last one divides messages to some MH folders.
5485 @item wl-expire-archive-number1
5486 re-files to archiving folders corresponding to the message numbers of
5487 the messages being deleted. For example, a message numbered 102 will be
5488 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5489 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5490 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5492 The archiving folders to which messages are re-filed are determined by
5493 the name of the folder as follows (in this case, archiving folders are
5494 handled as if @code{elmo-archive-treat-file} were non-nil).
5497 @item If the folder type is localdir:
5498 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5500 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5501 (@file{~/Mail/ml/wl-00100.zip}).
5503 @item The folder type is other than localdir:
5504 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5506 For example, @samp{%#mh/ml/wl} corresponds to
5507 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5510 As you can see, in the case of localdir, the folder type is not included
5511 in the path name, but otherwise it is included.
5512 And you can control the prefix to the archiving folder name by
5513 @code{wl-expire-archive-folder-prefix}.
5514 Refer to @code{wl-expire-archive-folder-prefix} for details.
5516 @item wl-expire-archive-number2
5517 re-files every certain number of messages to archiving folders.
5519 This differs from @samp{wl-expire-archive-number1} in that this re-files
5520 to the folder up to the specified number regardless of message numbers.
5521 The archiving folders to which messages are re-filed are determined in the
5522 same way as @code{wl-expire-archive-number1}.
5524 @item wl-expire-archive-date
5525 re-files messages depending on its date (year and month) to archive
5528 For example, a message dated December 1998 is re-filed to
5529 @code{$folder-199812;zip}. The name of the archiving folders except the
5530 date part are determined in the same way as
5531 @code{wl-expire-archive-number1}.
5534 You can set the first argument to these three standard functions to non-nil
5535 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5536 For example, it can be specified just after the name of the function:
5539 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5542 If you omit the argument, consecutive numbers from 1 are assigned for
5543 each archiving folder.
5545 @item wl-expire-localdir-date
5546 divedes messages depending on its date (year and month) to MH folders
5547 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5551 @subsection Treatment for Important or Unread Messages
5553 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5554 standard function, messages with marks in
5555 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5556 messages} thereafter) are retained.
5558 Per default, this variable include the important, new, and unread marks,
5559 so that messages with these marks are not removed.
5560 Note that you cannot include the temporary mark (i.e. temporary marks
5561 are removed anyway), and be sure to process temporary marks before you
5564 @subsection Auto Expiration
5566 The following setup invokes expiration when you move into the summary
5567 mode. There will be no confirmation, so make sure you made no mistake
5568 in regexp and other settings before you set up this.
5572 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5576 In the folder mode, you can invoke expiration per group as well as per
5577 folder. Therefore, if you specify @samp{Desktop} group, all folders
5578 matching @code{wl-expire-alist} expire.
5582 @subsection Treating archive folders.
5583 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5584 you must set non-nil value to @code{elmo-archive-treat-file}.
5586 @subsection Confirming
5588 If you are to use @code{remove}, try @code{trash} at first and see
5589 messages move to @code{wl-trash-folder} as expected, then replace it
5590 with @code{remove}. It would be dangerous to use @code{remove} from the
5593 If you are to use @code{wl-expire-archive-number1} and the like, try to
5594 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5595 you can append messages to it. Even if settings in
5596 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5597 would not be saved anywhere and disappeared in case the archiver program
5600 After you make sure you can archive to the folder correctly, you can
5601 invoke expiration and utilize the log.
5603 If you set @code{wl-expire-use-log} to @code{t},
5604 @file{~/.elmo/expired-log} should contain the log, for example:
5608 delete +ml/wl (593 594 595 596 597 598 599)
5609 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5613 The first column indicates the operation, i.e. @samp{delete},
5614 @samp{copy}, or @samp{move}. The next is the name of the folder that
5615 expired. In the case of @samp{copy} and @samp{move}, the destination
5616 folder is recorded after @samp{->}. The last is the list of message
5617 numbers that are actually deleted or moved (in the case of @samp{copy}
5618 and @samp{move}, the number is the one in the source folder, rather than
5619 the destination folder).
5621 @subsection Re-filing Reserved Messages
5623 The three standard functions copy reserved messages to the archive
5624 folder, but do not delete them from the source folder. Because
5625 reserved messages and the like always remain, they are recorded in
5626 @file{~/.elmo/expired-alist} so that they are not copied over and over
5627 again. They are not recorded if copied by @code{wl-summary-archive}.
5629 If you enabled logging, usually @samp{move} is recorded for re-filing,
5630 but instead @samp{copy} and @samp{delete} are recorded separately if
5631 reserved messages are involved. This is because it actually copies
5632 messages including reserved, then deletes ones except reserved in that
5635 @section Customizable Variables
5638 @item wl-expire-alist
5639 @vindex wl-expire-alist
5640 The initial setting is @code{nil}.
5641 This variable specifies folders and methods to expire. For details,
5642 refer to @code{wl-expire-alist} settings above.
5644 @item wl-summary-expire-reserve-marks
5645 @vindex wl-summary-expire-reserve-marks
5646 The initial setting is the list below.
5650 (list wl-summary-important-mark
5651 wl-summary-new-uncached-mark
5652 wl-summary-new-cached-mark
5653 wl-summary-unread-mark
5654 wl-summary-unread-uncached-mark
5655 wl-summary-unread-cached-mark)
5659 Messages with these marks are retained in the folder, even after
5661 Only permanent marks can be listed, not temporary marks.
5663 You can list marks one by one as in the default; you can use the
5664 following settings as well:
5668 All messages with permanent marks are retained,
5669 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5673 All messages are handled as usual ones that are already read, no matter
5674 what marks they have; even important messages are deleted.
5677 @item wl-expire-archive-files
5678 @vindex wl-expire-archive-files
5679 The initial setting is 100.
5680 This variable specifies the number of messages to be retained in one
5683 @item wl-expire-number-with-reserve-marks
5684 @vindex wl-expire-number-with-reserve-marks
5685 The initial setting is @code{nil}.
5686 If non-nil, if expiring messages are specified by @code{number},
5687 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5689 @item wl-expire-archive-get-folder-function
5690 @vindex wl-expire-archive-get-folder-function
5691 The initial setting is @code{wl-expire-archive-get-folder}.
5693 This variable specifies a function that returns the name of an archiving
5694 folder for standard functions in the place of @var{destination}.
5695 You can use the following three variables for simple modification of
5696 folder names; if you want more complex settings, define your own
5697 function in this variable.
5699 @code{wl-expire-archive-get-folder} can be customized by these
5702 @item @code{wl-expire-archive-folder-name-fmt}
5703 @item @code{wl-expire-archive-folder-type}
5704 @item @code{wl-expire-archive-folder-prefix}
5707 @item wl-expire-archive-folder-name-fmt
5708 @vindex wl-expire-archive-folder-name-fmt
5709 The initial setting is @samp{%s-%%05d;%s}.
5710 This is a @code{format} string for archiving folders used in
5711 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5712 Note that you must specify the message number by @samp{%%d}, because it
5713 is parsed twice by @code{format}.
5715 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5718 @item wl-expire-archive-date-folder-name-fmt
5719 @vindex wl-expire-archive-date-folder-name-fmt
5720 The initial setting is @samp{%s-%%04d%%02d;%s}.
5721 This is a @code{format} string for archiving folders used in
5722 @code{wl-expire-archive-date}. Note that you must specify the message
5723 number by @samp{%%d}, because it is parsed twice by @code{format}.
5724 There should be @samp{%%d} twice, one for the year and the other for the
5727 If you modify this, adjust
5728 @code{wl-expire-archive-date-folder-num-regexp} as well.
5730 @item wl-expire-archive-folder-type
5731 @vindex wl-expire-archive-folder-type
5732 The initial setting is @code{zip}.
5733 This variable specifies an archiver type of the archiving folders.
5735 @item wl-expire-archive-folder-prefix
5736 @vindex wl-expire-archive-folder-prefix
5737 The initial setting is @code{nil}.
5738 This variable specifies the prefix (directory structure) to archiving
5740 Exercise extreme caution in using this feature, as it has not been
5742 In the worst case, there is a fear of destructing archiving folders.
5746 There will be no prefix.
5749 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5750 @samp{$ml/wl-00000;zip;wl}.
5753 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5756 @samp{$ml/wl-00000;zip;ml/wl}.
5759 @item wl-expire-archive-folder-num-regexp
5760 @vindex wl-expire-archive-folder-num-regexp
5761 The initial setting is @samp{-\\([-0-9]+\\);}.
5762 This variable specifies the regular expression to be used for getting
5763 message numbers from multiple archiving folders specified by
5764 @code{elmo-list-folders}.
5765 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5767 @item wl-expire-archive-date-folder-num-regexp
5768 @vindex wl-expire-archive-date-folder-num-regexp
5769 The initial setting is @samp{-\\([-0-9]+\\);}.
5770 This is the regular expression to be used for getting message numbers
5771 from multiple archiving folders specified by @code{elmo-list-folders}.
5772 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5774 @item wl-expire-delete-oldmsg-confirm
5775 @vindex wl-expire-delete-oldmsg-confirm
5776 The initial setting is @code{t}.
5777 If non-nil, messages older than the one with the largest number will be
5778 deleted with confirmation.
5779 If @code{nil}, they are deleted without confirmation.
5781 This feature is valid only if non-nil is specified as a argument to the
5782 standard functions so as to retain numbers.
5784 @item wl-expire-use-log
5785 @vindex wl-expire-use-log
5786 The initial setting is @code{nil}.
5787 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5788 They are appended but not truncated or rotated automatically; you might
5789 need to remove it manually.
5791 @item wl-expire-add-seen-list
5792 @vindex wl-expire-add-seen-list
5793 The initial setting is @code{t}.
5795 If non-nil, when messages are re-filed by expiration, read/unread
5796 information is passed to the destination folder.
5798 However if you do not read the destination folder from Wanderlust,
5799 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5800 want to set this to @code{nil} if you are simply saving to some
5801 archiving folders. Even if its value is @code{nil}, messages in the
5802 archiving folders are simply treated as unread; it does not affect
5805 @item wl-expire-folder-update-msgdb
5806 @vindex wl-expire-folder-update-msgdb
5807 The initial setting is @code{t}.
5808 If @code{t}, in the folder mode, expiration is carried out after
5809 updating summary information. If you specified a list of regular
5810 expressions of folder names, summary information is updated for matching
5815 @node Archive, , Expire, Expire and Archive
5816 @section Archiving Messages
5818 @subsection Archiving Messages
5819 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5820 folders. If there are the archiving folders already, only new messages
5823 You can use @code{wl-archive-alist} in order to specify how messages are
5824 archived according to their folder names, as in @code{wl-expire-alist}.
5829 (setq wl-archive-alist
5830 '(("^\\+tmp$" wl-archive-date)
5831 ("^\\+outbox$" wl-archive-number2)
5832 (".*" wl-archive-number1)))
5836 Each item in the list has the following format:
5839 (@var{folders-regexp} @var{deleting-function})
5842 As you can see, you can only use a function after @var{folders-regexp}.
5843 Per default, there are three functions:
5846 @item @code{wl-archive-number1}
5847 @item @code{wl-archive-number2}
5848 @item @code{wl-archive-date}
5851 As inferred from their names, they work similarly to "expire" versions,
5852 other than the following points:
5855 @item No messages are deleted
5856 @item Message numbers are retained even if invoked without arguments
5859 These functions are good to archive all messages in a folder by their
5860 numbers or by their dates.
5861 These are also useful for backup or confirmation purposes before
5863 If you try to re-file them after they are archived, they are deleted but
5866 Per default, the archiving folders to which messages are copied are
5867 determined automatically by @code{wl-expire-archive-get-folder-function}.
5868 You can copy to a specific folder by invoking with a prefix argument,
5869 i.e. @kbd{C-u M-x wl-summary-archive}.
5871 Note that this feature has not been seriously tested, because you can
5872 simply copy to an archiving folder, for example by
5873 @code{wl-summary-copy-region}.
5875 The archiving folders are determined by the same logic as in
5876 @code{wl-summary-expire}; the following customizable variables are
5880 @item @code{wl-expire-archive-files}
5881 @item @code{wl-expire-archive-get-folder-function}
5882 @item @code{wl-expire-archive-folder-name-fmt}
5883 @item @code{wl-expire-archive-folder-type}
5884 @item @code{wl-expire-archive-folder-prefix}
5885 @item @code{wl-expire-archive-folder-num-regexp}
5888 @subsection Customizable Variables
5891 @item wl-archive-alist
5892 @vindex wl-archive-alist
5893 The initial setting is the list shown below:
5897 ((".*" wl-archive-number1))
5902 This variable specifies a function that copies to archiving folders.
5903 To the function, three arguments are passed: a folder name, a list of
5904 messages in the folder, and msgdb information of the summary.
5905 Needless to say, you can use your own function.
5909 @node Scoring, Split messages, Expire and Archive, Top
5910 @chapter Score of the Messages
5912 @c @cindex Kill File
5914 Scoring is the function that associates a score (value) with each
5915 message, and marks as read or deletes from the summary according to it.
5917 You can put target or important marks on essential messages, or read marks
5918 on the ones you do not want to read, for example spam articles.
5920 This scoring function has a capability and a format similar to the one
5921 that Gnus has, although there are some unsupported features and
5922 Wanderlust specifics.
5923 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5926 * Score Commands:: Score Commands
5927 * Score File Format:: Score File Format
5931 @node Score Commands, Score File Format, Scoring, Scoring
5932 @section Score Commands
5933 @cindex Score Commands
5935 @subsection Score File Specification
5937 @code{wl-score-folder-alist} specifies score files or variables in which
5938 scores are defined, corresponding to folder names.
5942 (setq wl-score-folder-alist
5951 If paths to the score files are omitted, the directory specified in the
5952 variable @code{wl-score-files-directory} is assumed.
5954 No matter what you write in @code{wl-score-folder-alist}, the default
5955 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5956 read (it does not have to exist).
5957 Therefore, in the example above, the three score files,
5958 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5959 the folders that matches @samp{^-.*}.
5961 @subsection Scored Messages
5963 Scores are attached to the messages that are specified by
5964 @code{wl-summary-score-marks} temporarily when the summary is updated;
5965 when you exit from the summary, the scores are removed and reverts to
5968 @subsection Creation of Score Files
5970 In the summary buffer, move to an appropriate message and type @kbd{L}.
5971 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5972 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5974 This makes @minus{}1000 are scored for messages with the same
5975 @samp{Subject:} as the string you entered. That is, such a score file
5976 is created automatically.
5978 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5979 The score file you just made appears.
5980 This buffer is called @dfn{score editing buffer} thereafter.
5981 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5982 as you are previously; type @kbd{a}. Then a score entry for "From"
5984 In this way, you can create a score file easily either in the summary
5985 buffer or in the score editing buffer.
5987 By the way, you might be aware the numbers of key strokes are different
5988 between @kbd{s s p} and @kbd{a}.
5989 This is determined by @code{wl-score-header-default-entry}.
5990 This variable specifies the default score entries corresponding to
5992 For example, for "subject" field, a type and a time limit are prompted,
5993 but for "from" field, they are fixed upon automatically as substring and
5994 permanent respectively.
5995 However, score values can be modified by the prefix argument.
5996 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5999 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
6000 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
6001 erasing contents of the buffer deletes the score file being edited.
6005 @subsubsection Selecting Score Files
6007 You can change score files to which scores are appended by
6008 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
6009 @code{wl-score-change-score-file}.
6011 @subsubsection Summing Up the Score
6013 If you add the same entries by @code{wl-summary-increase-score},
6014 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
6015 scores for the entry is summed up.
6017 For example, if you create @samp{from} entry with the score of @minus{}1000 by
6018 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
6019 @minus{}1200 will be created as a result.
6021 @subsubsection Creating Thread Key
6023 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
6024 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6026 @subsubsection Creating Followup Key
6028 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6029 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6030 at the cursor to @samp{References} key.
6031 If @code{wl-score-auto-make-followup-entry} is non-nil,
6032 @samp{Message-ID} of all messages to be followed up within dates
6033 specified by @code{wl-score-expiry-days}.
6035 @subsection Key Bindings
6040 @findex wl-summary-increase-score
6041 Increases the score for the current message.
6042 And the score entry is appended to the score file at the same moment.
6043 You can specify the score value by a prefix argument.
6047 @findex wl-summary-lower-score
6048 Decreases the score for the current message.
6049 And the score entry is appended to the score file at the same moment.
6050 You can specify the score value by a prefix argument.
6053 @kindex h R (Summary)
6054 @findex wl-summary-rescore
6055 Re-applies the scoring.
6056 However, already scored messages are not scored anew.
6059 @kindex h c (Summary)
6060 @findex wl-score-change-score-file
6061 Changes the score file currently selected.
6064 @kindex h e (Summary)
6065 @findex wl-score-edit-current-scores
6066 Edits the score file currently selected.
6067 If there are multiple score files, the previously specified one is
6071 @kindex h f (Summary)
6072 @findex wl-score-edit-file
6073 Edits an arbitrary score file and selects it.
6076 @kindex h F (Summary)
6077 @findex wl-score-flush-cache
6078 Erases caches associated to the score files that are read.
6079 If you modified score files directly (from other than Wanderlust), you
6080 need to re-read them after erasing the cache.
6083 @kindex h m (Summary)
6084 @findex wl-score-set-mark-below
6085 Specifies the criterion for scores to be marked as read.
6086 Messages with scores less than this value are marked as read.
6089 @kindex h x (Summary)
6090 @findex wl-score-set-expunge-below
6091 Specifies the criterion for scores to be deleted from the summary.
6092 Messages with scores less than this value are deleted.
6093 "Deleted" means it is not shown; they are not removed from the summary
6094 information or the folder.
6095 The deleted messages can be shown by rescan-noscore again.
6098 @subsection Key Bindings in the Score Editing Buffer
6102 @kindex C-c C-k (Score Mode)
6103 @findex wl-score-edit-kill
6104 Abandons the file being edited.
6107 @kindex C-c C-c (Score Mode)
6108 @findex wl-score-edit-exit
6109 Saves the file being edited, and quits from the edit mode.
6112 @kindex C-c C-p (Score Mode)
6113 @findex wl-score-pretty-print
6117 @kindex C-c C-d (Score Mode)
6118 @findex wl-score-edit-insert-date
6119 Inserts the number of dates from Dec. 31, 1 B.C.
6120 It is used for creating the third factor of time-limited scores.
6123 @kindex C-c C-s (Score Mode)
6124 @findex wl-score-edit-insert-header
6125 Inserts the header of the message selected in the summary buffer.
6128 @kindex C-c C-e (Score Mode)
6129 @findex wl-score-edit-insert-entry
6130 Inserts the score entry of the message selected in the summary buffer.
6133 @subsection Customizable Variables
6136 @item wl-summary-default-score
6137 @vindex wl-summary-default-score
6138 The initial setting is 0 (zero).
6139 This variable specifies the default value of the score.
6140 The score is increased or decreased based upon this value.
6142 @item wl-summary-important-above
6143 @vindex wl-summary-important-above
6144 The initial setting is @code{nil}.
6145 Messages with scores larger than this value are attached with the
6146 important mark (@samp{$}).
6147 If @code{nil}, no important marks are attached.
6149 @item wl-summary-target-above
6150 @vindex wl-summary-target-above
6151 The initial setting is @code{nil}.
6152 Messages with scores larger than this value are attached with the target
6154 If @code{nil}, no target marks are attached.
6156 @item wl-summary-mark-below
6157 @vindex wl-summary-mark-below
6158 The initial setting is 0 (zero).
6159 Messages with scores smaller than this value are marked as read.
6161 @item wl-summary-expunge-below
6162 @vindex wl-summary-expunge-below
6163 The initial setting is @code{nil}.
6164 Messages with scores smaller than this value are deleted from the
6166 If @code{nil}, they are not deleted.
6168 @item wl-summary-score-marks
6169 @vindex wl-summary-score-marks
6170 The initial setting is the list shown below:
6174 (list wl-summary-new-uncached-mark
6175 wl-summary-new-cached-mark)
6180 Messages with these marks are scored.
6182 @item wl-use-scoring
6183 @vindex wl-use-scoring
6184 The initial setting is t.
6185 If non-nil, scoring is enabled.
6187 @item wl-score-files-directory
6188 @vindex wl-score-files-directory
6189 The initial setting is @file{~/.elmo/}.
6190 The default directory for score files.
6192 @item wl-score-interactive-default-score
6193 @vindex wl-score-interactive-default-score
6194 The initial setting is 1000.
6195 This value is used as a score when a score factor is @code{nil} in the
6196 score file. It is also used in @code{wl-summary-increase-score} and
6197 @code{wl-summary-lower-score}, on condition that the value of
6198 @code{wl-score-header-default-entry} is @code{nil}.
6200 @item wl-score-expiry-days
6201 @vindex wl-score-expiry-days
6202 The initial setting is 7.
6203 This is the number of days before time-limited scores are deleted.
6205 @item wl-score-update-entry-dates
6206 @vindex wl-score-update-entry-dates
6207 The initial setting is @code{t}.
6208 If non-nil, it enables deletion of time-limited scores.
6210 @item wl-score-header-default-entry
6211 @vindex wl-score-header-default-entry
6212 Specifies the default value for each header field for score entries
6213 created by @code{wl-summary-increase-score},
6214 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6216 @item wl-score-simplify-fuzzy-regexp
6217 @vindex wl-score-simplify-fuzzy-regexp
6218 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6219 regular expression to be deleted from the string.
6220 Because this is usually used for Subject, the default is prefixes that
6221 are attached by mailing list programs.
6223 @item wl-summary-rescore-partial-threshold
6224 @vindex wl-summary-rescore-partial-threshold
6225 The initial setting is 200.
6226 When sync-all or rescan is executed, if there are messages more than
6227 this value, only the last same number of messages as this value are
6230 @item wl-summary-auto-sync-marks
6231 @vindex wl-summary-auto-sync-marks
6232 If non-nil, unread/important marks are synchronized when the summary
6234 Unread marks reflect information on the IMAP4 server.
6235 Important marks reflect information on the IMAP4 server (flagged or
6236 not), and contents of @samp{'mark} folder.
6237 The initial setting is @code{t}.
6241 @node Score File Format, , Score Commands, Scoring
6242 @section Score File Format
6243 @cindex Score File Format
6245 The format of score files are the same as Gnus, and basically you can
6246 use Gnus score files as they are. But they are not fully compatible
6247 because some keys are not supported and there are Wanderlust specifics.
6248 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6253 ("for sale" -1000 nil s)
6254 ("profit" -1000 nil s))
6256 ("spam@@spamspamspam" -10000 nil s))
6258 ("my@@address" 3001 nil s))
6260 (1000000 -10 nil >))
6270 If the key is a string, it is the name of the header to be matched.
6271 The following keys are available:
6272 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6273 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6274 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6275 @code{Chars} and @code{Lines} mean the size and the number of lines of
6276 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6277 are described later.
6278 The rest corresponds the field of the same name.
6280 Arbitrary numbers of core entries are specified after the key.
6281 Each score entry consists of these five factors:
6285 A factor that matches header. This should be a number in the cases of
6286 @code{lines} and @code{chars}, otherwise a string.
6289 A score factor. When the first item matches, the score of the message
6290 is increased or decreased by this value.
6293 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6294 of a number, the score is deleted if it does not match for days
6295 (@code{wl-score-expiry-days}) from the date specified by this.
6296 The date is since Dec. 31, 1 B.C.
6299 A type factor. This specifies the way the first factor matches.
6300 Available types depend on keys.
6303 @item From, Subject, References, Message-ID
6304 For these keys in string, @code{r} and @code{R} (regexp),
6305 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6306 as well as @code{f} and @code{F} (fuzzy) can be used.
6307 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6310 For these keys, the following five numerical relative operators can be
6311 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6314 This key matches @code{From} header, and scores all follow-ups to the
6316 For example, it would be useful for increasing scores for follow-ups to
6319 You can use the same types as @code{From} except for @code{f}.
6320 And a @samp{Followup} entry is automatically appended to the score file.
6323 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6324 A @samp{Thread} entry is automatically appended for each article that
6325 has @var{x} in the @code{References} header.
6326 You can make sure the whole thread including messages that does not have
6327 all ancestors @code{Message-ID} in @code{References} is scored.
6329 You can use the same types as @code{References} except for @code{f}.
6330 And a @samp{Thread} entry is automatically appended to the score file.
6334 A factor for extension header. This is meaningful only if the key is
6336 This specifies headers to be matched other than standard headers like
6337 @code{Subject} and @code{From}.
6338 Note that you should specify the header in
6339 @code{elmo-msgdb-extra-fields} also.
6340 Therefore it does not work in folders where extension headers cannot be
6345 The sum of these scores @emph{after all factors are applied} becomes the
6346 score of the message.
6348 @cindex Score File Atoms
6350 Messages with a score less than this value is marked as read.
6351 The default is @code{wl-summary-mark-below}.
6354 Messages with a score less than this value is deleted from the summary.
6355 The default is @code{wl-summary-expunge-below}.
6357 @item mark-and-expunge
6358 Both @code{mark} and @code{expunge} are applied,
6359 i.e. messages with a score less than this value is marked as read and
6360 deleted from the summary.
6363 Messages with a score greater than this value is attached with temp
6365 The default is @code{wl-summary-target-above}.
6368 Messages with a score greater than this value is attached with important
6370 The default is @code{wl-summary-important-above}.
6375 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6376 are used, you need to set @code{elmo-msgdb-extra-fields}.
6379 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6382 There are other restrictions as shown below:
6385 @item Because @samp{References} field in the summary information
6386 contains only the last @samp{Message-ID}, @code{references} key matches
6390 Keys that can be seen by folder of types:
6394 chars lines xref extra
6395 localdir,localnews Y E E E
6396 nntp (supporting xover) Y E E N
6402 N: cannot be seen (ignored)
6403 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6408 @node Split messages, Address Book, Scoring, Top
6409 @chapter Message splitting
6410 @cindex Split messages
6412 You can use @code{elmo-split} to split message in folder specified by
6413 the variable @code{elmo-split-folder} a la @command{procmail} according
6414 to some specified rules. To use this feature, set as follows in your
6415 @file{~/.emacs} at first.
6418 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
6421 Set source folder like following.
6424 (setq elmo-split-folder "%inbox")
6427 And specify the rule in the variable @code{elmo-split-rule} (its format
6428 will be is described below).
6429 Then you can invoke @kbd{M-x elmo-split} to split messages according to
6430 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
6431 to do a rehearsal and show result (do not split actually).
6434 We will describe how to specify the rule. First of all, see following
6439 (setq elmo-split-rule
6440 ;; @r{Store messages from spammers into @samp{+junk}}
6441 '(((or (address-equal from "i.am@@spammer")
6442 (address-equal from "dull-work@@dull-boy")
6443 (address-equal from "death-march@@software")
6444 (address-equal from "ares@@aon.at")
6445 (address-equal from "get-money@@richman"))
6447 ;; @r{Store messages from mule mailing list into @samp{%mule}}
6448 ((equal x-ml-name "mule") "%mule")
6449 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
6450 ;; @r{and continue evaluating following rules}
6451 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
6452 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
6453 ((match from "\\(.*\\)@@yahoo\\.com")
6455 ;; @r{Store unmatched mails into @samp{+inbox}}
6460 The basic unit of the rule is a combination like
6463 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
6466 If @samp{CONDITION} is true, @samp{ACTION} is performed.
6467 The 1st element @samp{CONDITION} is a condition represented by a
6468 balanced expression (sexp). Its grammar will be explained below.
6469 The 2nd element @samp{ACTION} is the name of the folder to split
6470 messages into, or a symbol. When the 3rd element @code{continue} is
6471 specified as symbol, evaluating rules is not stopped even when the
6472 condition is satisfied.
6474 The grammar for @samp{CONDITION} is as follows. See example above to
6475 learn how to write the condition practically.
6479 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
6480 (@samp{FIELD-NAME} is a symbol that describes the field name)
6484 True if the field value equals to @samp{VALUE}.
6485 Case of the letters are ignored.
6487 True if the field value matches to VALUE.
6488 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6489 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6490 @item @code{address-equal}
6491 True if one of the addresses in the field equals to
6492 @samp{VALUE}. Case of the letters are ignored.
6493 @item @code{address-match}
6494 True if one of the addresses in the field matches to
6496 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6497 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6501 Functions which accept an integer argument (@samp{SIZE}).
6505 True if the size of the message is less than @samp{SIZE}.
6507 True if the size of the message is greater than @samp{SIZE}.
6511 Functions which accept any number of arguments.
6515 True if one of the argument returns true.
6517 True if all of the arguments return true.
6523 When a symbol is specified, it is evaluated.
6526 You can specify followings as 2nd @samp{ACTION}.
6532 If some string is specified, it will be regarded as the destination
6533 folder, and the message will be appended to it.
6538 If the symbol @samp{delete} is specified, delete the substance of the
6539 message in @code{elmo-split-folder}
6544 If the symbol @samp{noop} is specified, do nothing on the message and
6550 If some function is specified, execute it.
6553 If the message passes all rules, it will be dealed along @samp{ACTION}
6554 specified by @code{elmo-split-default-action}.
6557 @node Address Book, Spam Filter, Split messages, Top
6558 @chapter Address Book
6559 @cindex Address Book
6561 With address book, you can utilize address completion, and you have
6562 summary displayed with nicknames.
6565 * Mail Addresses:: Definition of Address Book
6566 * Address Manager:: Address Manager
6570 @node Mail Addresses, Address Manager, Address Book, Address Book
6571 @section Address book
6572 @cindex Address book Definition
6574 @cindex Alias, Address
6576 The file @file{~/.addresses} is a simple address book for Wanderlust.
6577 Make address file @file{~/.addresses}, and edit to suit your requirement.
6579 The data written in @file{~/.addresses} are used for address completion
6580 under draft editing mode. Furthermore, they are used when showing names
6581 in summary display mode. You can safely skip this section, if you don't
6582 want to customize address completion and summary display.
6583 It is possible to add/change/remove addresses from @file{~/.addresses} in
6584 summary buffer after Wanderlust is invoked. @refill
6586 The format is very simple. Like this. @refill
6591 # @r{Lines begin with @samp{#} are comment.}
6592 # @r{Empty lines are ignored}
6594 # @r{Format of each line:}
6595 # @var{email-address} "@var{nickname} "@var{realname}"
6597 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6598 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6599 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6604 One line defines one persons description.
6606 Actually, in default setup, @var{nickname} is used in summary-mode and
6607 @var{realname} is used in draft preparation mode. This behavior is
6608 better understood if you try it and confirmed the function first. You
6609 can write and try a small definition, so you will know the idea of the
6610 address book before writing a big one.
6612 And, if MH alias file is specified in variable @code{wl-alias-file},
6613 it is used as an address information in the draft preparation mode.
6615 If variable @code{wl-use-ldap} is non-nil (initial setting is
6616 @code{nil}), address completion in draft mode uses LDAP information.
6618 If you use LDAP, you have to set @code{wl-ldap-server},
6619 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6620 not have LDAP feature as built-in feature (Currently only XEmacs can
6621 have built-in LDAP feature), you have to set command exec @env{PATH} to
6622 the program @command{ldapsearch}.
6625 @node Address Manager, , Mail Addresses, Address Book
6626 @section Address Manager
6627 @cindex Address Manager
6629 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6630 the address book and insert address to draft buffer.
6632 @subsection Key Bindings
6636 @kindex t (Address Manager)
6637 @findex wl-addrmgr-set-to
6638 Add @samp{To:} mark.
6641 @kindex c (Address Manager)
6642 @findex wl-addrmgr-set-cc
6643 Add @samp{Cc:} mark.
6646 @kindex b (Address Manager)
6647 @findex wl-addrmgr-set-bcc
6648 Add @samp{Bcc:} mark.
6651 @kindex u (Address Manager)
6652 @findex wl-addrmgr-unmark
6656 @kindex x (Address Manager)
6657 @findex wl-addrmgr-apply
6659 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6660 buffer and quit address manager. When no draft buffer, make new draft
6661 with insert marked addresses.
6663 If no mark, quit address manager.
6667 @kindex q (Address Manager)
6668 @findex wl-addrmgr-quit
6669 Quit address manager.
6672 @kindex a (Address Manager)
6673 @findex wl-addrmgr-add
6677 @kindex d (Address Manager)
6678 @findex wl-addrmgr-delete
6682 @kindex e (Address Manager)
6683 @findex wl-addrmgr-edit
6688 @node Spam Filter, Customization, Address Book, Top
6689 @chapter Spam Filter
6692 @code{wl-spam} provides an frontend to external spam filtering programs.
6693 You can register to or judge spam by the filtering program cooperateing
6694 with messages operations on Wanderlust.
6697 * Usage of Spam Filter:: Usage of Spam Filter
6698 * Spam Filter Processor:: Supported spam filters
6701 @node Usage of Spam Filter, Spam Filter Processor, Spam Filter, Spam Filter
6702 @section Usage of Spam Filter
6704 @subsection Initial Setting
6706 To use @code{wl-spam}, write in @file{~/.wl} as follows:
6710 ;; @r{Use @samp{bogofilter} as spam back end}
6711 ;; @r{Set @samp{scheme} here as the spam filter you will use.}
6712 ;; @r{@xref{Spam Filter Processor}}
6713 (setq elmo-spam-scheme 'bogofilter)
6718 @subsection spam mark
6720 The spam mark (@samp{s}) will be provided as new temporary mark.
6721 Messages marked by this will be refiled into @code{wl-spam-folder} when
6722 the action is called for execution. Marked messages will be skipped by
6723 summary walking in ordinary way.
6725 The spam mark is be put on by spam judgement described later, or by
6726 invoking @kbd{k m} at any time.
6728 @subsection spam judgment
6730 You can judge spam messages by following ways:
6734 Make judgement on execution of auto-refile.
6736 Insert @code{wl-refile-guess-by-spam} to arbitrary position in
6737 @code{wl-auto-refile-guess-functions} as follows.
6741 (setq wl-auto-refile-guess-functions
6742 '(wl-refile-guess-by-rule
6743 wl-refile-guess-by-spam))
6747 In this example, judge spam if it could not decide refile destination by
6748 @code{wl-refile-rule-alist}.
6751 Make judgement on entering the summary of specified folder.
6753 Specify the value of @code{wl-spam-auto-check-folder-regexp-list}
6754 as the list of regular expressions for folder names to be
6755 automatically judged by spam filter.
6758 (setq wl-spam-auto-check-folder-regexp-list '("\\+inbox"))
6761 In this example, judgement will be processed when you enter summary of
6762 the folder whose name contains @samp{+inbox}.
6765 Make judgement on splitting messages with @code{elmo-split}.
6767 It provides new function @code{spam-p} to be specified as @samp{CONDITION}
6768 in @code{elmo-split-rule}. This function returns true when the message
6770 @xref{Split messages}
6772 You can also process learning by the result of judgement. (You would
6773 better turn on this feature after learning to some extent)
6779 (setq elmo-split-rule
6780 '(((spam-p) "+spam")
6781 ;; @r{to learn by the judgement, use following instead}
6782 ;((spam-p :register t) "+spam")
6788 @subsection spam learning
6790 @code{wl-spam} automatically learn spam with refiling messages.
6792 At first, @code{wl-spam} classifies the folders controlled by Wanderlust
6793 into following 4 domains by the class of containig messages
6797 Folders containing messages judged as spam.
6798 (The folder specified by @code{wl-spam-folder})
6800 Folders containing messages judged as non-spam.
6802 Folders containing messages not yet judged. Folders without
6803 pre-distribution may belong to this domain e.g. @samp{+inbox}.
6804 (specified by @code{wl-spam-undecided-folder-regexp-list})
6806 Foldes have nothing to do with spam processing e.g.
6807 @code{wl-trash-folder} or @code{wl-draft-folder}. (specified by
6808 @code{wl-spam-ignored-folder-regexp-list})
6811 When you refile messages across different domains, it automatically
6812 learn messages as @samp{spam} or @samp{non-spam} according to domains
6813 it belongs before and after.
6815 To put it concretely, it will learn by following rule:
6818 @item undecide -> spam
6821 learn as spam and cancel previous study as non-spam.
6822 @item undecide -> good
6825 learn as non-spam and cancel previous study as spam.
6828 It do not learn anything in other cases.
6830 @subsection Key Bindings
6831 @cindex Keybind, spam filter
6835 @kindex k m (Summary)
6836 @findex wl-summary-spam
6837 Put spam mark (@samp{s}) on current message.
6840 @kindex k c (Summary)
6841 @findex wl-summary-test-spam
6842 Test current message and put spam mark if judged as spam.
6845 @kindex k C (Summary)
6846 @findex wl-summary-mark-spam
6847 Test messages with the mark in @code{wl-spam-auto-check-marks},
6848 and put spam mark if judged as spam. If it is called with prefix
6849 argument, test all messages regardless of their marks.
6852 @kindex k s (Summary)
6853 @findex wl-summary-register-as-spam
6854 Register current message as spam.
6857 @kindex k S (Summary)
6858 @findex wl-summary-register-as-spam-all
6859 Register all messages in the folder as spam.
6862 @kindex k n (Summary)
6863 @findex wl-summary-register-as-good
6864 Register current message as non-spam.
6867 @kindex k N (Summary)
6868 @findex wl-summary-register-as-good-all
6869 Register all messages in the folder as non-spam.
6872 @kindex m k (Summary)
6873 @findex wl-summary-target-mark-spam
6874 Put spam mark (@samp{s}) on messages with the target mark @samp{*}.
6877 @kindex m s (Summary)
6878 @findex wl-summary-target-mark-register-as-spam
6879 Register messages with the target mark @samp{*} as spam.
6882 @kindex m n (Summary)
6883 @findex wl-summary-target-mark-register-as-good
6884 Register messages with the target mark @samp{*} as non-spam.
6887 @subsection Customizable Variables
6890 @item wl-spam-folder
6891 @vindex wl-spam-folder
6892 Specify the name of destination folder for the spam messages.
6893 The initial setting is @samp{+spam}.
6895 @item wl-spam-undecided-folder-regexp-list
6896 @vindex wl-spam-undecided-folder-regexp-list
6897 Specify the list of regexp of folder names which contain messages
6898 not yet decided as spam or non-spam.
6899 The initial setting is @code{'("inbox")}.
6901 @item wl-spam-ignored-folder-regexp-list
6902 @vindex wl-spam-ignored-folder-regexp-list
6903 The initial setting is as follows.
6907 (list (regexp-opt (list wl-draft-folder
6913 Folders of no effect against spam judgement, specified by the list of
6914 folder name regular expressions.
6916 @item wl-spam-auto-check-folder-regexp-list
6917 @vindex wl-spam-auto-check-folder-regexp-list
6918 Folders to make spam judgement on entering the summary of them,
6919 specified by the list of folder name regular expressions.
6920 The initial setting is @code{nil}.
6922 @item wl-spam-auto-check-marks
6923 @vindex wl-spam-auto-check-marks
6924 The initial setting is the following list:
6928 (list wl-summary-new-uncached-mark
6929 wl-summary-new-cached-mark)
6933 Messages with mark specified by this variable will be processed
6934 by whole-folder judgement including auto test by
6935 @code{wl-spam-auto-check-folder-regexp-list}.
6936 Persistent marks can be used in this method, but temporary marks cannot.
6938 You can specify the list of marks as the initial setting, or you can
6939 specify follwing symbol:
6943 Process all messages regardless of persistent marks.
6948 @node Spam Filter Processor, , Usage of Spam Filter, Spam Filter
6949 @section Supported Spam Filters
6950 @cindex Spam Filter, Bogofilter
6951 @cindex Spam Filter, Spamfilter
6953 Supported spam filtering libraries are following ones.
6956 * bogofilter:: bogofilter
6957 * spamfilter:: spamfilter.el
6958 * Bsfilter:: bsfilter
6959 * SpamAssassin:: SpamAssassin
6963 @node bogofilter, spamfilter, Spam Filter Processor, Spam Filter Processor
6964 @subsection bogofilter
6967 bogofilter (@uref{http://bogofilter.sourceforge.net/}) is a spam filter
6968 implemented by C language.
6970 To use spam filter with bogofilter, write following setting in
6971 @file{~/.wl} or somewhere else.
6975 (setq elmo-spam-scheme 'bogofilter)
6979 @subsubsection Customizable Variables
6982 @item elmo-spam-bogofilter-program
6983 @vindex elmo-spam-bogofilter-program
6984 The initial setting is @file{bogofilter}.
6985 Specify the name of executable of bogofiler. If the executable
6986 is not in your environmental variable @env{PATH}, you should
6987 set this by full path.
6989 @item elmo-spam-bogofilter-args
6990 @vindex elmo-spam-bogofilter-args
6991 The initial setting is @code{nil}.
6992 Specify arguments to be supplied for bogofilter executable.
6994 @item elmo-spam-bogofilter-database-directory
6995 @vindex elmo-spam-bogofilter-database-directory
6996 Specify the directory for statistical database to be used.
6997 @code{nil} to use default directory (@file{~/.bogofilter}).
6998 The initial setting is @code{nil}.
7000 @item elmo-spam-bogofilter-max-messages-per-process
7001 @vindex elmo-spam-bogofilter-max-messages-per-process
7002 The initial setting is 30. This variable specifies the number of
7003 messages to be learned by one process.
7005 @item elmo-spam-bogofilter-debug
7006 @vindex elmo-spam-bogofilter-debug
7007 The initial setting is @code{nil}.
7008 If you specify non-nil, the output from @command{bogofilter} is
7009 stored in the buffer named @code{"*Debug ELMO SPAM Bogofilter*"}.
7013 @node spamfilter, Bsfilter, bogofilter, Spam Filter Processor
7014 @subsection spamfilter.el
7017 @file{spamfilter.el}
7018 (@uref{http://www.geocities.co.jp/SiliconValley-PaloAlto/7043/}) is a
7019 spam filtering library implemented by Emacs Lisp.
7021 Corresponding modules will be compiled/installed, if you have
7022 @file{spamfilter.el} within @code{load-path} when you are to install wl.
7025 To use @file{spamfilter.el}, write following setting in @file{~/.wl} or
7027 (Of cource, you have to have settings for @file{spamfilter.el} itself)
7031 (setq elmo-spam-scheme 'spamfilter)
7035 @subsubsection Customizable Variables
7038 @item elmo-spam-spamfilter-corpus-filename
7039 @vindex elmo-spam-spamfilter-corpus-filename
7040 The initial setting is @file{~/.elmo/.spamfilter}.
7041 It specifies the name of corpus file.
7044 @node Bsfilter, SpamAssassin, spamfilter, Spam Filter Processor
7045 @subsection bsfilter
7048 not yet documented...
7050 @node SpamAssassin, , Bsfilter, Spam Filter Processor
7051 @subsection SpamAssassin
7052 @cindex SpamAssassin
7054 SpamAssassin (@uref{http://spamassassin.org/}) is one of the most
7055 popular spam filtering program implemented on Perl. SpamAssassin
7056 attempts to identify spam using text analysis and several internet-based
7057 realtime blacklists. SpamAssassin also uses a Bayesian learning filter
7058 which enables more accurate spam filtering.
7060 To use @file{SpamAssassin} on Wanderlust, write following setting
7061 in @file{~/.wl} or somewhere else.
7062 (Of course, you have to install SpamAssassin beforehand.)
7066 (setq elmo-spam-scheme 'sa)
7070 @subsubsection Customize Variables
7073 @item elmo-spam-spamassassin-program
7074 @vindex elmo-spam-spamassassin-program
7075 The initial setting is @file{spamassassin}.
7076 Specify the name of executable @command{spamassassin}. If the executable
7077 is not in your environmental variable @env{PATH}, you should
7078 set this by full path.
7080 @item elmo-spam-spamassassin-learn-program
7081 @vindex elmo-spam-spamassassin-learn-program
7082 The initial setting is @file{sa-learn}.
7083 Specify the name of the SpamAssassin's Bayesian filtering learner
7084 program, @command{sa-learn}. If the executable is not in your
7085 environmental variable @env{PATH}, you should set this by full path.
7087 @item elmo-spam-spamassassin-program-arguments
7088 @vindex elmo-spam-spamassassin-program-arguments
7089 The initial setting is @code{'("-e")}.
7090 Specify the arguments to be supplied for @command{spamassassin} executable.
7091 You have to specify the argument to exit the program with an error exit code
7092 when the result is spam. For example, if you want to use @command{spamc}
7093 instead of @command{spamassassin}, you should specify @code{'("-c")}.
7095 @item elmo-spam-spamassassin-learn-program-arguments
7096 @vindex elmo-spam-spamassassin-lern-program-arguments
7097 The initial setting is @code{nil}.
7098 Specify the arguments to be supplied for @command{sa-learn}.
7100 @item elmo-spamassassin-debug
7101 @vindex elmo-spamassassin-debug
7102 The initial setting is @code{nil}.
7103 If you specify @code{t}, the output from @command{spamassassin} is
7104 stored in the buffer named @code{"*Debug ELMO SpamAssassin*"}.
7108 @node Customization, Terminology, Spam Filter, Top
7109 @chapter Customizing Wanderlust
7110 @cindex Customization
7113 * Living with other packages:: Cooperating with other packages
7114 * Highlights:: Highlights
7115 * Biff:: Notify Mail arrival
7116 * Advanced Settings:: Advanced Settings
7117 * Customizable Variables:: Customizable Variables
7122 @node Living with other packages, Highlights, Customization, Customization
7123 @section Living with other packages
7125 Examples with other packages.
7128 * imput:: imput (im-wl.el)
7129 * BBDB:: The Insidious Big Brother Database
7130 * LSDB:: The Lovely Sister Database
7131 * supercite:: supercite.el
7132 * mu-cite:: mu-cite.el
7133 * X-Face:: x-face,bitmap-mule
7134 * dired-dd:: dired-dd.el
7136 * Addrbook:: Addrbook
7137 * mime-w3m:: mime-w3m.el
7141 @node imput, BBDB, Living with other packages, Living with other packages
7146 Place @file{util/im-wl.el} on the @code{load-path} and do the following
7151 (autoload 'wl-draft-send-with-imput-async "im-wl")
7152 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
7157 @node BBDB, LSDB, imput, Living with other packages
7161 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
7162 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
7163 and do the following settings.
7165 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
7166 byte-compiled and installed.
7174 ;; @r{enable pop-ups}
7175 (setq bbdb-use-pop-up t)
7176 ;; @r{auto collection}
7177 (setq bbdb/mail-auto-create-p t)
7178 ;; @r{exceptional folders against auto collection}
7179 (setq bbdb-wl-ignore-folder-regexp "^@@")
7180 (setq signature-use-bbdb t)
7181 (setq bbdb-north-american-phone-numbers-p nil)
7182 ;; @r{shows the name of bbdb in the summary} :-)
7183 (setq wl-summary-from-function 'bbdb-wl-from-func)
7184 ;; @r{automatically add mailing list fields}
7185 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
7186 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
7190 You can complete address with BBDB by @kbd{M-@key{TAB}}
7194 @node LSDB, supercite, BBDB, Living with other packages
7198 The following is an example setting to use
7199 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
7206 (add-hook 'wl-draft-mode-hook
7208 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
7212 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
7213 (complete address with LSDB).
7216 @node supercite, mu-cite, LSDB, Living with other packages
7217 @subsection sc.el(supercite), sc-register.el
7221 The same setting as usual mailers should be OK. The following is an
7222 example of settings:
7226 (autoload 'sc-cite-original "supercite" nil t)
7227 (add-hook 'mail-citation-hook 'sc-cite-original)
7232 @node mu-cite, X-Face, supercite, Living with other packages
7233 @subsection mu-cite.el
7236 The same setting as usual mailers should be OK. The following is an
7237 example of settings.
7239 If you use mu-cite version 8.0 or earlier:
7243 (autoload 'mu-cite/cite-original "mu-cite" nil t)
7244 (setq mail-citation-hook 'mu-cite/cite-original)
7248 If you use mu-cite version 8.1 or later:
7252 (autoload 'mu-cite-original "mu-cite" nil t)
7253 (add-hook 'mail-citation-hook (function mu-cite-original))
7257 @node X-Face, dired-dd, mu-cite, Living with other packages
7261 If you have installed one of the following, you can decode
7262 @samp{X-Face:} field in message buffer and you will see face image.
7265 * x-face-xmas:: XEmacs case
7266 * x-face-mule:: Emacs case
7269 If there is an encoded X-Face string in a file @file{~/.xface} (the
7270 value of the variable @code{wl-x-face-file}), it is inserted as a
7271 @samp{X-Face:} field in the draft buffer (if
7272 @code{wl-auto-insert-x-face} is non-nil).
7274 @node x-face-xmas, x-face-mule, X-Face, X-Face
7275 @subsubsection x-face-xmas (for XEmacs)
7278 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
7279 1.3.6.13 or later, do the following:
7283 (autoload 'x-face-xmas-wl-display-x-face "x-face")
7284 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
7288 @node x-face-mule, , x-face-xmas, X-Face
7289 @subsubsection x-face-mule (for Emacs)
7293 If you use @file{x-face-mule.el} in bitmap-mule
7294 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
7298 (autoload 'x-face-decode-message-header "x-face-mule")
7299 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7303 @subsubsection x-face-e21 (for Emacs 21.x)
7306 With Emacs 21.x, you can use @file{x-face-e21.el}
7307 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
7308 to display X-Face. In this case, bitmap-mule is not required.
7313 (autoload 'x-face-decode-message-header "x-face-e21")
7314 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7319 @node dired-dd, MHC, X-Face, Living with other packages
7320 @subsection dired-dd(Dired-DragDrop)
7321 @pindex Dired-DragDrop
7323 @cindex Drag and Drop
7325 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
7326 compose multi-part by simple Drag-and-Drop from dired to the draft
7327 buffer being edited in GNU Emacs (this feature is not Wanderlust
7328 specific, but general-purpose for SEMI).
7332 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
7338 ;; @r{Set dired-x variables here.}
7339 ;; @r{To and flo@dots{}}
7341 (progn (require 'dired-dd)
7342 (require 'dired-dd-mime))))))
7346 @node MHC, Addrbook, dired-dd, Living with other packages
7350 Message Harmonized Calendaring system
7351 (@uref{http://www.quickhack.net/mhc/})
7353 By using MHC, you can make a calendar from the messages.
7359 (setq mhc-mailer-package 'wl)
7360 (autoload 'mhc-mode "mhc" nil t)
7361 (add-hook 'wl-summary-mode-hook 'mhc-mode)
7362 (add-hook 'wl-folder-mode-hook 'mhc-mode)
7370 (autoload 'mhc-wl-setup "mhc-wl")
7371 (add-hook 'wl-init-hook 'mhc-wl-setup)
7375 @node Addrbook, mime-w3m, MHC, Living with other packages
7376 @subsection wl-addrbook.el
7380 (@uref{http://www.mew.org/})
7382 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
7383 @code{load-path} and do the following settings.
7387 (require 'wl-addrbook)
7392 @node mime-w3m, , Addrbook, Living with other packages
7393 @subsection mime-w3m.el
7396 You can display html part by using @file{mime-w3m.el}
7397 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
7398 You can find the usage in comment region at the head of @file{mime-w3m.el}.
7401 @node Highlights, Biff, Living with other packages, Customization
7404 @subsection Customizable Variables
7407 @item wl-summary-highlight
7408 @vindex wl-summary-highlight
7409 The initial setting is @code{t}.
7410 If non-nil, the summary is highlighted.
7412 @item wl-highlight-max-summary-lines
7413 @vindex wl-highlight-max-summary-lines
7414 The initial setting is 10000.
7415 The summary is not highlighted if it has more lines than this value.
7417 @item wl-summary-highlight-partial-threshold
7418 @vindex wl-summary-highlight-partial-threshold
7419 The initial setting is 1000.
7420 This is a threshold whether the whole summary is highlighted.
7421 If there are more lines of messages in the summary, it is partially
7424 @item wl-summary-partial-highlight-above-lines
7425 @vindex wl-summary-partial-highlight-above-lines
7426 The initial setting is 30. If there are more lines of messages than
7427 @code{wl-summary-highlight-partial-threshold} in the summary, messages
7428 after the point that is the same number of lines as this value above the
7429 cursor line are highlighted partially. (If this value is @code{nil},
7430 the last same number of lines as the value of
7431 @code{wl-summary-highlight-partial-threshold} are highlighted.)
7433 @item wl-highlight-body-too
7434 @vindex wl-highlight-body-too
7435 The initial setting is @code{t}.
7436 If non-nil, bodies of drafts and messages are also highlighted.
7438 @item wl-highlight-message-header-alist
7439 @vindex wl-highlight-message-header-alist
7440 When highlighting headers of drafts and messages, this variable
7441 specifies which faces are allocated to important
7442 (@code{wl-highlight-message-important-header-contents}), secondly
7443 important (@code{wl-highlight-message-important-header-contents2}), and
7444 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7446 Similarly, it can be used for allocating arbitrary faces to arbitrary
7447 regular expressions.
7449 @item wl-highlight-citation-prefix-regexp
7450 @vindex wl-highlight-citation-prefix-regexp
7451 Specifies a regular expression to which quoted lines in bodies of
7452 drafts and messages match.
7453 Bodies matching to this regular expression are highlighted by the faces
7454 specified by (@code{wl-highlight-message-cited-text-*}).
7456 @item wl-highlight-highlight-citation-too
7457 @vindex wl-highlight-highlight-citation-too
7458 The initial setting is @code{nil}.
7459 If non-nil, the quoting regular expression itself given by
7460 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7462 @item wl-highlight-citation-header-regexp
7463 @vindex wl-highlight-citation-header-regexp
7464 Specifies a regular expression that denotes beginning of quotation.
7465 Bodies matching to this regular expression are highlighted by the face
7466 specified by @code{wl-highlight-message-headers}.
7468 @item wl-highlight-max-header-size
7469 @vindex wl-highlight-max-header-size
7470 The initial setting is @code{nil}. If a header size is larger than this
7471 value, it will not be highlighted. If @code{nil}, always highlighted
7472 (ignore header size).
7474 @item wl-highlight-max-message-size
7475 @vindex wl-highlight-max-message-size
7476 The initial setting is 10000.
7477 If a message is larger than this value, it will not be highlighted.
7478 With this variable, highlight is suppressed for uuencode or huge digest
7481 @item wl-highlight-signature-separator
7482 @vindex wl-highlight-signature-separator
7483 Specifies regular expressions that denotes the boundary of a signature.
7484 It can be a regular expression, or a list of ones.
7485 Messages after the place that matches this regular expression are
7486 highlighted by the face specified by
7487 @code{wl-highlight-message-signature}.
7489 @item wl-max-signature-size
7490 @vindex wl-max-signature-size
7491 The initial setting is 400.
7492 This is the largest size for a signature to be highlighted.
7494 @item wl-use-highlight-mouse-line
7495 @vindex wl-use-highlight-mouse-line
7496 The initial setting is @code{t}.
7497 If non-nil, the line pointed by the mouse is highlighted in the folder
7498 mode, summary mode, and the like.
7501 @subsection Setting Colors and Fonts of the Characters
7503 If you want to change colors or fonts of the characters, you need to
7504 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7505 want to change fonts, and @code{set-face-foreground} for colors, and so
7506 on. You cannot write face settings in @file{.emacs}; write in
7509 For example, if you want to change the color for signatures to yellow,
7513 (set-face-foreground 'wl-highlight-message-signature "yellow")
7519 Faces defined in Wanderlust:
7522 @item wl-highlight-message-headers
7523 The face for field names of message headers.
7525 @item wl-highlight-message-header-contents
7526 The face for field bodies of message headers.
7528 @item wl-highlight-message-important-header-contents
7529 The face for important parts of message headers.
7530 Per default, this face is used for a body of @samp{Subject:} field.
7531 You can change its value by editing
7532 @code{wl-highlight-message-header-alist}.
7534 @item wl-highlight-message-important-header-contents2
7535 The face for secondly important parts of message headers.
7536 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7537 fields. You can change its value by editing
7538 @code{wl-highlight-message-header-alist}.
7540 @item wl-highlight-message-unimportant-header-contents
7541 The face for unimportant parts of message headers.
7542 Per default, this face is used for bodies of @samp{X-} fields
7543 @samp{User-Agent:} fields. You can change its value by editing
7544 @code{wl-highlight-message-header-alist}.
7546 @item wl-highlight-message-citation-header
7547 The face for headers of quoted messages.
7549 @item wl-highlight-message-cited-text-*
7550 The face for texts of quoted messages. The last @samp{*} is a
7551 @var{single figure} so that 10 different colors can be used according to
7554 @item wl-highlight-message-signature
7555 The face for signatures of messages. The initial settings are
7556 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7557 dark background colors.
7559 @item wl-highlight-header-separator-face
7560 The face for header separators of draft messages.
7562 @item wl-highlight-summary-important-face
7563 The face for message lines with important marks in the summary.
7565 @item wl-highlight-summary-new-face
7566 The face for message lines with new marks in the summary.
7568 @item wl-highlight-summary-displaying-face
7569 The face for the message line that is currently displayed.
7570 This face is overlaid.
7572 @item wl-highlight-thread-indent-face
7573 The face for the threads that is currently displayed.
7575 @item wl-highlight-summary-unread-face
7576 The face for message lines with unread marks in the summary.
7578 @item wl-highlight-summary-deleted-face
7579 The face for message lines with delete marks in the summary.
7581 @item wl-highlight-summary-refiled-face
7582 The face for message lines with re-file marks in the summary.
7584 @item wl-highlight-refile-destination-face
7585 The face for re-file information part of message lines with re-file
7586 marks in the summary.
7588 @item wl-highlight-summary-copied-face
7589 The face for message lines with copy marks in the summary.
7591 @item wl-highlight-summary-target-face
7592 The face for message lines with target marks @samp{*} in the summary.
7594 @item wl-highlight-summary-thread-top-face
7595 The face for message lines that are on the top of the thread in the
7598 @item wl-highlight-summary-normal-face
7599 The face for message lines that are not on top of the thread in the
7602 @item wl-highlight-folder-unknown-face
7603 The face for folders that are not known to have how many unsync messages
7606 @item wl-highlight-folder-zero-face
7607 The face for folders that have no unsync messages in the folder mode.
7609 @item wl-highlight-folder-few-face
7610 The face for folders that have some unsync messages in the folder mode.
7612 @item wl-highlight-folder-many-face
7613 The face for folders that have many unsync messages in the folder mode.
7614 The boundary between `some' and `many' is specified by the variable
7615 @code{wl-folder-many-unsync-threshold}.
7617 @item wl-highlight-folder-unread-face
7618 The face for folders that have no unsync but unread messages in the
7621 @item wl-highlight-folder-killed-face
7622 The face for folders that are deleted from the access group in the
7625 @item wl-highlight-folder-opened-face
7626 The face for open groups in the folder mode.
7627 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7628 @code{nil} or a @var{number}.
7630 @item wl-highlight-folder-closed-face
7631 The face for close groups in the folder mode.
7632 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7633 @code{nil} or a @var{number}.
7635 @item wl-highlight-folder-path-face
7636 The face for the path to the currently selected folder in the folder
7639 @item wl-highlight-logo-face
7640 The face for logo in the demo.
7642 @item wl-highlight-demo-face
7643 The face for strings (for example, a version number) in the demo.
7647 @node Biff, Advanced Settings, Highlights, Customization
7648 @section Notify Mail arrival
7651 Following setting is to notify mail arrival of @samp{%inbox}
7652 by the indicator on the modeline
7655 (setq wl-biff-check-folder-list '("%inbox"))
7658 @subsection Customizable Variables
7660 @item wl-biff-check-folder-list
7661 @vindex wl-biff-check-folder-list
7662 The initial setting is @code{nil}.
7663 This is the list of folders to check mail arrival.
7664 If @code{nil}, wl doesn't check mail arrival.
7666 @item wl-biff-check-interval
7667 @vindex wl-biff-check-interval
7668 The initial setting is 40 (in seconds).
7669 Check mail arrival in this period.
7671 @item wl-biff-notify-hook
7672 @vindex wl-biff-notify-hook
7673 This hook is run at the arrival of new mail.
7674 To beep with mail arrival(initial setting), set as follows.
7676 (setq wl-biff-notify-hook '(ding))
7678 For silence, set to @code{nil}.
7682 @node Advanced Settings, Customizable Variables, Biff, Customization
7683 @section Advanced Settings
7686 * Draft for Reply:: Draft for Reply
7687 * Thread Format:: Appearance of Thread
7688 * User-Agent Field:: @samp{User-Agent:} Header Field
7692 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
7693 @subsection Draft for Replay
7694 @vindex wl-draft-reply-with-argument-list
7695 @vindex wl-draft-reply-without-argument-list
7696 @vindex wl-draft-reply-myself-with-argument-list
7697 @vindex wl-draft-reply-myself-without-argument-list
7699 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
7700 The addressee for the draft is decided by following rules.
7702 For example, you can set as follows:
7706 (setq wl-draft-reply-without-argument-list
7707 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7708 ("Followup-To" . (nil nil ("Followup-To")))
7709 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7710 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
7714 Where each element of the list @code{wl-draft-reply-without-argument-list}
7718 (key . (to-list cc-list newsgroup-list))
7721 and if the field designated by @samp{key} exist in the parent message,
7722 parent's field values designated by @samp{to-list} are copied to @samp{To:}
7723 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
7724 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
7725 the draft respectively.
7730 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7733 Match if the parent has @samp{Mail-Followup-To} field.
7734 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
7735 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
7739 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7742 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
7743 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
7746 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
7749 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
7750 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
7753 These are evaluated in order and first matched one is used.
7755 Moreover, the behavior of @kbd{a} with prefix argument can
7756 be directed by @code{wl-draft-reply-with-argument-list} as well.
7758 By the way, you can use some function (will be evaluated in the parent
7759 message buffer) in the place of @samp{key} or @samp{to-list} etc.
7760 For example, if you only want to reply to mailing lists in
7761 @code{wl-subscribed-mailing-list} if the parent has some of them,
7766 (defun wl-mailing-list-addresses ()
7770 (nth 1 (std11-extract-address-components addr)))
7773 (elmo-multiple-fields-body-list (list "To" "Cc"))
7775 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
7776 (setq list-addrs (cons to list-addrs))))
7777 (nreverse list-addrs)))
7779 (setq wl-draft-reply-with-argument-list
7780 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
7781 ("Reply-To" . (("Reply-To") nil nil))
7782 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
7783 ("From" . (("From") nil nil))))
7788 Note: To set the behavior when you reply to the message written by yourself,
7789 use @code{wl-draft-reply-myself-without-argument-list} and
7790 @code{wl-draft-reply-myself-with-argument-list} instead of them.
7792 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
7793 @subsection Appearance of Threads
7797 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
7798 390 09/18(Fri)07:25 +-[ Tsumura-san ]
7799 391 09/18(Fri)19:24 +-[ Murata-san ]
7800 392 09/20(Sun)21:49 +-[ Okunishi-san ]
7801 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
7802 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
7803 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
7804 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
7805 412 09/22(Tue)09:28 | +-[ Teranishi ]
7806 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
7807 416 09/22(Tue)12:38 | +-[ Teranishi ]
7808 395 09/20(Sun)21:49 +-[ Okunishi-san ]
7809 397 09/21(Mon)00:15 +-[ Okunishi-san ]
7813 Settings to make appearance of threads like shown above:
7817 (setq wl-thread-indent-level 2)
7818 (setq wl-thread-have-younger-brother-str "+")
7819 (setq wl-thread-youngest-child-str "+")
7820 (setq wl-thread-vertical-str "|")
7821 (setq wl-thread-horizontal-str "-")
7822 (setq wl-thread-space-str " ")
7826 If you do not want to see branches, do the following:
7830 (setq wl-thread-indent-level 2)
7831 (setq wl-thread-have-younger-brother-str " ")
7832 (setq wl-thread-youngest-child-str " ")
7833 (setq wl-thread-vertical-str " ")
7834 (setq wl-thread-horizontal-str " ")
7835 (setq wl-thread-space-str " ")
7840 @node User-Agent Field, , Thread Format, Advanced Settings
7841 @subsection User-Agent Field
7845 If you are eccentric enough to elaborate @samp{X-Mailer:} or
7846 @samp{User-Agent:} fields, define a function that generate appropriate
7847 strings as you like, and set it to variable
7848 @code{wl-generate-mailer-string-function}.
7850 If you do not want verbose @samp{User-Agent:} field, do the following:
7854 (setq wl-generate-mailer-string-function
7855 'wl-generate-user-agent-string-1)
7859 The following is a example:
7863 (setq wl-generate-mailer-string-function nil)
7864 (setq wl-draft-additional-header-alist
7866 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
7871 @node Customizable Variables, Hooks, Advanced Settings, Customization
7872 @section Customizable Variables
7874 Customizable variables that have not been described yet:
7877 @item wl-default-folder
7878 @vindex wl-default-folder
7879 The initial setting is @samp{%inbox}. This is the default value for moving to
7880 a folder and the like.
7882 @item wl-draft-folder
7883 @vindex wl-draft-folder
7884 The initial setting is @samp{+draft}. It is the folder to which drafts are
7885 saved. It must be a localdir folder.
7887 @item wl-trash-folder
7888 @vindex wl-trash-folder
7889 The initial setting is @samp{+trash}. It is the wastebasket folder.
7890 If you changed this variable, you had better restart Wanderlust.
7892 @item wl-interactive-exit
7893 @vindex wl-interactive-exit
7894 The initial setting is @code{t}.
7895 If non-nil, you are asked for confirmation when Wanderlust terminates.
7897 @item wl-interactive-send
7898 @vindex wl-interactive-send
7899 The initial setting is @code{t}.
7900 If non-nil, you are asked for confirmation when mail is sent.
7902 @item wl-default-sync-range
7903 @vindex wl-default-sync-range
7904 The initial setting is @samp{update}.
7905 Default update range of the summary. You can specify
7906 @samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
7907 See description of @code{wl-summary-sync} for the meaning of ranges.
7909 @item wl-folder-sync-range-alist
7910 @vindex wl-folder-sync-range-alist
7911 The initial setting is the alist shown below:
7916 ("^\\+draft$\\|^\\+queue$" . "all"))
7921 This is an associative list of regular expressions of folder names and
7922 update range of the summary. Update range is one of the @samp{all},
7923 @samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
7924 match any of them, the value of @code{wl-default-sync-range} is used
7925 (@samp{update} by default).
7926 See description of @code{wl-summary-sync} for the meaning of ranges.
7929 @vindex wl-ask-range
7930 The initial setting is @code{t}.
7931 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
7932 for updating the summary when you changed folders.
7934 @item wl-mime-charset
7935 @vindex wl-mime-charset
7936 The initial setting is @code{x-ctext}.
7937 This is the MIME charset for messages that are not MIME (e.g. without
7938 @samp{Content-Type:}). This value also used as default charset for
7939 summary. (If you want to share Summary on Nemacs and other Emacsen, set
7940 this value as @code{iso-2022-jp}.)
7942 @item wl-highlight-folder-with-icon
7943 @vindex wl-highlight-folder-with-icon
7944 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
7945 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
7947 @item wl-strict-diff-folders
7948 @vindex wl-strict-diff-folders
7949 This is a list of regular expressions of folders.
7950 Unread messages are checked, for example when you press @kbd{s} in
7951 the folder mode, usually in a brief way (rapidly processed but not
7953 The folders matching this variable are seriously checked.
7954 You may want to set this variable so as to match conditional filter
7955 folders for IMAP4 folders.
7956 The initial setting is @code{nil}.
7958 @item wl-folder-use-server-diff
7959 @vindex wl-folder-use-server-diff
7960 When unread messages are checked, for example when you press @kbd{s} in
7961 the folder mode, usually (the number of messages on the server) @minus{}
7962 (the number of local messages) will be the number of unread messages.
7963 However, if this variable is non-nil, the number of unread messages on
7964 the server is checked. This affects IMAP4 folders only, but IMAP4
7965 folders in mail boxes matching
7966 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
7967 the number of unread messages on the server, even if they matches this
7968 variable. The initial setting is @code{t}.
7970 @item wl-auto-check-folder-name
7971 @vindex wl-auto-check-folder-name
7972 The initial setting is @code{nil}.
7973 You can specify a folder or a group which is checked for unread message
7974 at the start. You can also specify a list of folders (groups) to be checked.
7975 If the value is @code{nil}, whole Desktop is checked at the start.
7976 If it is @code{none}, no folders are checked.
7978 @item wl-auto-uncheck-folder-list
7979 @vindex wl-auto-uncheck-folder-list
7980 The initial setting is the list shown below:
7989 You can set a list of regular expressions to specify folders
7990 which are not automatically checked even if they are included
7991 in some groups assigned by @code{wl-auto-check-folder-name}.
7993 @item wl-auto-check-folder-list
7994 @vindex wl-auto-check-folder-list
7995 The initial setting is @code{nil}.
7996 You can set a list of regular expressions to specify exceptions
7997 for @code{wl-auto-uncheck-folder-list}.
7999 @item wl-no-save-folder-list
8000 @vindex wl-no-save-folder-list
8001 The initial setting is the list shown below:
8010 This is a list of regular expressions of folders not to be saved.
8012 @item wl-save-folder-list
8013 @vindex wl-save-folder-list
8014 The initial setting is @code{nil}.
8015 This is a list of regular expressions of folders to be saved.
8016 This takes precedence over @code{wl-no-save-folder-list}.
8018 @item wl-folder-mime-charset-alist
8019 @vindex wl-folder-mime-charset-alist
8020 The initial setting is the alist shown below:
8024 (("^-alt\\.chinese" . big5)
8025 ("^-relcom\\." . koi8-r)
8027 ("^-han\\." . euc-kr))
8032 This is an associative list of regular expressions of folder names and
8034 If a folder do not match, @code{wl-mime-charset} is used.
8036 @item wl-folder-init-load-access-folders
8037 @vindex wl-folder-init-load-access-folders
8038 The initial setting is @code{nil}.
8039 This is a list of access groups to be loaded specifically at the start.
8040 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
8042 @item wl-folder-init-no-load-access-folders
8043 @vindex wl-folder-init-no-load-access-folders
8044 The initial setting is @code{nil}.
8045 This is a list of access groups not to be loaded specifically at the
8047 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
8049 @item wl-delete-folder-alist
8050 @vindex wl-delete-folder-alist
8051 The initial setting is the alist shown below:
8060 This list determines disposition of messages with delete marks.
8061 Each item in the list is a folder and destination; you can specify any
8062 one of the following in the place of destination:
8065 @code{remove} or @code{null} : deletes the messages instantly.
8066 string : moves the messages to the specific folder.
8067 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
8070 @item wl-x-face-file
8071 @vindex wl-x-face-file
8072 The initial setting is @file{~/.xface}.
8073 The name of the file that contains encoded X-Face strings.
8076 @item wl-demo-display-logo
8077 @vindex wl-demo-display-logo
8078 If non-nil, bitmap image is shown on the opening demo. If you set
8079 @code{xpm} or @code{xbm}, (if possible) display selected image type
8082 @item elmo-use-database
8083 @vindex elmo-use-database
8084 This is meaningful for XEmacs only. The initial setting depends on
8085 XEmacs (@code{t} for XEmacs with dbm).
8086 If non-nil, Message-ID is controlled by dbm.
8088 @item elmo-passwd-alist-file-name
8089 @vindex elmo-passwd-alist-file-name
8090 The initial setting is @file{passwd}.
8091 This is the name of the file in which passwords are saved.
8092 @code{elmo-passwd-alist-save} saves current passwords to the file.
8094 @item elmo-nntp-list-folders-use-cache
8095 @vindex elmo-nntp-list-folders-use-cache
8096 The initial setting is 600 (in seconds).
8097 This is period in seconds during which results of @samp{list} and
8098 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
8101 @item elmo-nntp-max-number-precedes-list-active
8102 @vindex elmo-nntp-max-number-precedes-list-active
8103 The initial setting is @code{nil}.
8104 If non-nil, the number of article obtained by @samp{list active} in NNTP
8105 are used as the maximum article number of the folder.
8106 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
8107 and if the number of read messages is not correct.
8109 @item elmo-nntp-default-use-listgroup
8110 @vindex elmo-nntp-default-use-listgroup
8111 The initial setting is @code{t}.
8112 If non-nil, @samp{listgroup} is used for checking the total number of
8113 articles. If it is @code{nil}, @samp{group} is used. In the latter
8114 case, the processing will be a little faster at the sacrifice of
8117 @item elmo-pop3-send-command-synchronously
8118 @vindex elmo-pop3-send-command-synchronously
8119 The initial setting is @code{nil}.
8120 If non-nil, POP3 commands are issued synchronously. Some implementation
8121 of POP3 server fails to get summary information without this setting.
8122 You may have to set this variable to @code{t}, if the process hangs
8123 while looking up POP3.
8125 @item elmo-dop-flush-confirm
8126 @vindex elmo-dop-flush-confirm
8127 The initial setting is @code{t}.
8128 If non-nil, you are asked for confirmation if accumulated off-line
8129 operations are executed.
8131 @item elmo-display-progress-threshold
8132 @vindex elmo-display-progress-threshold
8133 The initial setting is 20.
8134 Threshold for display of progress gauge. If number of renewal is more than
8135 this value, display progress gauge.
8139 @node Hooks, , Customizable Variables, Customization
8144 @node Terminology, Mailing List, Customization, Top
8145 @chapter Terminology around Wanderlust
8148 Here we explain terminologies used in this manual.
8152 A container in which messages are stored.
8155 A set consists of some folders.
8158 A special group consists of automatically collected folders under
8159 some specified path.
8160 @xref{Folder Definition}.
8162 @item summary buffer
8163 A buffer for displaying list of messages in some folder.
8165 @item sticky summary
8166 Compared with ordinary summary buffer which will be destroyed after
8167 exiting from it, this type of summary will be remain even after exiting
8168 by @kbd{q} or @kbd{g}.
8169 @xref{Sticky Summary}.
8172 To delete or put into the archive expired messages.
8179 To cache messages beforehand in order to read messages after you will be
8180 disconnected from the server.
8184 @node Mailing List, Addition, Terminology, Top
8185 @chapter Wanderlust Mailing List
8189 Topics related to Wanderlust are discussed in following mailing lists.
8190 The latest version is also announced there.
8193 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
8196 In this list Japanese is mainly used for discussion. We also have a list
8197 for discussion in English:
8200 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
8202 (Messages posted to this list are also forwarded to the former one.)
8204 A guide can be obtained automatically by sending mail to
8205 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
8206 the English one) with the body
8212 Please send bug reports or patches to one of those lists. You can post to
8213 the mailing list even though you are not a member of it.
8215 If you send a bug report, please attach Backtrace with it.
8216 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
8219 I would like to express my thanks to the members of the mailing list for
8220 valuable advice and many pieces of code they contributed.
8223 @node Addition, Index, Mailing List, Top
8224 @chapter Additional Information
8226 @section Brief History
8229 1998 3/05 Tried to make a prototype that displays MH messages in threads.
8230 3/10 Made a msgdb mechanism by elisp.
8231 3/26 IMAP and NNTP can be displayed in threads.
8232 4/13 Began to assemble thread display modules as elmo.
8233 5/01 Finished 0.1.0, initial version with many defects.
8234 6/12 I made a slip of the tongue and said I was writing elisp
8235 mailer supporting IMAP
8236 6/16 0.1.3 was announced at tm-ja, elisp ML.
8237 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
8238 7/01 Support for mm-backend (0.3.0).
8239 8/25 multi folder added (0.5.0).
8240 8/28 filter folder added (0.5.1).
8241 9/10 You can open/close threads (0.6.0).
8242 9/11 fldmgr by Murata-san made editing folders easy.
8243 9/18 lha folders added by Okunishi-san (0.6.3).
8244 9/24 Display of branches of threads (0.6.5).
8245 9/28 Compression folder supporting multiple archivers by Okunishi-san.
8246 10/28 Off-line operations (0.7.4).
8247 12/09 Becomes beta version.
8248 12/21 wl-expire by Murata-san.
8249 1999 2/03 auto-refile by Tsumura-san.
8250 4/28 wl-template by Murata-san.
8251 5/18 Released 1.0.0 stable.
8252 7/05 Scoring by Murata-san (2.1.0).
8253 9/26 New plugged system by Murata-san (2.2.2).
8254 12/20 Support Modified UTF7.
8255 2000 3/24 Released 1.1.0 stable.
8256 4/03 CVS development started.
8257 5/07 Thread restoration & Its speed up with Murata-san.
8258 6/12 Address completion with LDAP with Chiba-san & Goto-san.
8259 7/11 killed message feature.
8260 7/18 Use UIDL in POP3.
8261 9/12 biff feature with Satata-san & Yamaoka-san.
8262 10/17 expire-hide by Okada-san.
8263 11/08 Released 2.4.0 stable.
8264 2001 7/04 Released 2.6.0 stable.
8265 8/21 wl-addrmgr by Kitamoto-san.
8266 12/27 Released 2.8.1 stable.
8267 2002 12/11 Released 2.10.0 stable.
8270 See @file{ChangeLog} for details.
8274 According to a dictionary, Wanderlust has the meaning:
8278 n eager longing for or impulse towards travelling in distant lands
8279 [Ger, fr wandern to wander + lust desire, pleasure]
8283 but I had no profound intention. (if farfetched, IMAP @result{} you can
8284 read mail anywhere @result{} desire to wander ?)
8286 Elmo is the abbreviation of @samp{Elisp Library for Message
8287 Orchestration}. At first I meant the red puppet in the Sesame Street,
8288 but you may associate it with Wandering @result{} Drifting @result{}
8289 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
8293 Each versions has code names (they are almost jokes).
8294 Currently they are picked up alphabetically from the top 40 hits of
8295 U.S. Billboard magazines in 1980s.
8297 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
8300 @node Index, , Addition, Top
8304 * Concept Index:: Concept Index
8305 * Key Index:: Key Index
8306 * Variable Index:: Variable Index
8307 * Function Index:: Function Index
8310 @node Concept Index, Key Index, Index, Index
8311 @unnumberedsec Concept Index
8314 @node Key Index, Variable Index, Concept Index, Index
8315 @unnumberedsec Key Index
8318 @node Variable Index, Function Index, Key Index, Index
8319 @unnumberedsec Variable Index
8322 @node Function Index, , Variable Index, Index
8323 @unnumberedsec Function Index