New feature: toggle visibility of mime buttons.
[more-wl.git] / doc / wl.texi
blobe09414cc667f82270106202c43fa5afb0f052e5b
1 \input texinfo @c -*-texinfo -*-
2 @c %**start of header
3 @setfilename wl.info
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
5 @c %**end of header
6 @documentlanguage en
7 @include version.texi
8 @synindex pg cp
9 @finalout
11 @dircategory GNU Emacs Lisp
12 @direntry
13 * Wanderlust: (wl).         Yet Another Message Interface On Emacsen
14 @end direntry
16 @c permissions text appears in an Info file before the first node.
17 @ifinfo
18 This file documents Wanderlust, Yet another message interface on
19 Emacsen.
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.
32 @ignore
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).
38 @end ignore
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.
47 @end ifinfo
49 @titlepage
50 @sp 10
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
57 @author Kenichi Okada
58 @author Kaoru Takahashi
59 @author Bun Mizuhara
60 @author Masayuki Osada
61 @author Katsumi Yamaoka
62 @author Hiroya Murata
63 @author Yoichi Nakayama
64 @page
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.
86 @end titlepage
89 @ifinfo
90 @node Top, Introduction, (dir), (dir)
91 @top Wanderlust User's Manual
93 @flushright
94 Yuuichi Teranishi
95 Fujikazu Okunishi
96 Masahiro Murata
97 Kenichi Okada
98 Kaoru Takahashi
99 Bun Mizuhara
100 Masayuki Osada
101 Katsumi Yamaoka
102 Hiroya Murata
103 Yoichi Nakayama
104 @end flushright
106 This manual is for Wanderlust @value{VERSION}.
108 @end ifinfo
110 @menu
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 * Address Book::             Management of Address Book
122 * Spam Filter::              Spam filtering
123 * Advanced Issues::          Advanced Issues
124 * Migration::                Switch from older version of Wanderlust
125 * Terminology::              Terminologies
126 * Mailing List::             Wanderlust mailing list
127 * Addition::                 Additional Information
128 * Index::                    Key index
129 @end menu
132 @node Introduction, Start Me Up, Top, Top
133 @chapter Introduction of Wanderlust
134 @cindex Introduction
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:
141 @itemize @minus
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.
161 @end itemize
164 @section Environment
166 We confirm Wanderlust works on following Emacsen:
168 @itemize @bullet
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
174 @item PMMule
175 @end itemize
177 IMAP4 connectivity with following imapd are confirmed to work with
178 Wanderlust:
180 @itemize @bullet
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)
185 @item Express Mail
186 @item Microsoft Exchange Server 5.5
187 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
188 @end itemize
190 LDAP connectivity with following LDAPd are confirmed to work with
191 Wanderlust:
193 @itemize @bullet
194 @item OpenLDAP 2.0.6 or later
195 @end itemize
198 @node Start Me Up, Folders, Introduction, Top
199 @chapter Start up Wanderlust
200 @cindex Start up
202 The necessary procedure for starting Wanderlust is explained in steps
203 here.
205 (Of course, you need a mail/news readable environment in advance)
207 @menu
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
215 @end menu
218 @node MIME Modules, Download, Start Me Up, Start Me Up
219 @section Installing MIME modules
220 @cindex MIME modules
221 @pindex APEL
222 @pindex FLIM
223 @pindex SEMI
225 You must install SEMI beforehand to use Wanderlust.
227 SEMI can be downloaded from following site:
229 @example
230 @group
231 SEMI:   ftp://ftp.m17n.org/pub/mule/semi/
232 @end group
233 @end example
235 You need packages named APEL and FLIM to use SEMI.
236 You can download APEL and FLIM from following URLs:
238 @example
239 @group
240 APEL:   ftp://ftp.m17n.org/pub/mule/apel/
241 FLIM:   ftp://ftp.m17n.org/pub/mule/flim/
242 @end group
243 @end example
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
247 install-package}.)
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)
252 may help you.}.
255 Recommended combination of APEL, FLIM and SEMI are following:
257 @itemize @minus
258 @item APEL 10.6, FLIM 1.14.6 and SEMI 1.14.6
259 @end itemize
261 You can also use many other FLIM/SEMI variants. Combination of the
262 latest versions should work.  For example, the following combination are
263 confirmed to work.
265 @itemize @minus
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
268 @end itemize
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
275 @cindex Download
277 You can download Wanderlust package from following sites:
279 Original site:
280 @example
281 ftp://ftp.gohome.org/wl/
282 @end example
284 Mirrored ftp/http sites:
286 @example
287 @group
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/
292 @end group
293 @end example
295 Extract the obtained package to your working directory:
297 @example
298 @group
299 % cd ~/work
300 % tar zxvf wl-@var{version}.tar.gz
301 % cd wl-@var{version}
302 @end group
303 @end example
305 @subsection To use SSL (Secure Socket Layer)
306 @cindex SSL
307 @pindex OpenSSL
308 @pindex starttls
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
321 addition to above.
322 You can download starttls package from the following site.
324 @example
325 ftp://opaopa.org/pub/elisp/
326 @end example
328 @node Install, Minimal Settings, Download, Start Me Up
329 @section Byte-compile and install
330 @cindex Byte-compile
331 @cindex Compile
332 @cindex Install
333 @cindex Makefile
334 @cindex Make
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.
343 @example
344 @group
345 % make
346 % make install
347 @end group
348 @end example
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:
357 @example
358 Cannot open load file: mime-setup
359 @end example
361 @noindent
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}
380 @table @code
381 @item WL_PREFIX
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.
388 @item ELMO_PREFIX
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.
393 @end table
395 @noindent
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}:
401 @lisp
402 (setq ELMO_PREFIX "elmo")
403 @end lisp
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
415 as a package.
417 Follow the next example to install Wanderlust as an XEmacs package.
419 @example
420 @group
421 % vi Makefile
422 % make package
423 % make install-package
424 @end group
425 @end example
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}.
437 @lisp
438 @group
439 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
440 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
441 @end group
442 @end lisp
444 @subsection Manual
446 Manual is described in Info format. Please do following.
448 @example
449 @group
450 % make info
451 % make install-info
452 @end group
453 @end example
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:
463 @example
464 http://www.gohome.org/wl/doc/wl_toc.html
465 @end example
467 @node Minimal Settings, Folder Definition, Install, Start Me Up
468 @section Set up .emacs
469 @cindex Minimal Settings
470 @cindex Settings
471 @cindex Configuration
472 @cindex .emacs
473 @cindex .wl
475 The Wanderlust package contains two module groups.
477 @table @samp
478 @item ELMO (elmo-*.el)
479 These modules show everything as folders. This is the back-end for WL.
480 @item WL (wl-*.el)
481 These modules controls the behavior of main body of Wanderlust.
482 They are also the front-end for ELMO.
483 @end table
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.
490 @lisp
491 @group
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")
507 @end group
508 @end lisp
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).
515 @xref{Highlights}.
517 All above described settings except autoload configuration can be written
518 in @file{~/.wl}).
520 @subsection @code{mail-user-agent}
521 @cindex Default Mailer
522 @cindex Mailer, Default
523 @vindex mail-user-agent
524 @findex compose-mail
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
529  of Emacsen.
531 It is effective only when your Emacs can define @code{mail-user-agent}.
532 @xref{Mail Methods, , ,emacs, The Emacs Editor}.
534 @lisp
535 @group
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
541       'wl-user-agent
542       'wl-user-agent-compose
543       'wl-draft-send
544       'wl-draft-kill
545       'mail-send-hook))
546 @end group
547 @end lisp
551 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
552 @section Folder Definition
553 @cindex Folder Definition
554 @cindex .folders
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:
566 @example
567 @group
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)}
575 %inbox  "Inbox"
576 +trash  "Trash"
577 +draft  "Drafts"
578 %#mh/Backup@@my.imap.example.com "Sent"
579 # Folder Group
580 Emacsen@{
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.}
594 + /
595 @end group
596 @end example
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.
628 @example
629 M-x wl
630 @end example
632 @noindent
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
635 listed.
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
642 @section Overview
643 @cindex Overview
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.
649 @table @samp
650 @item Folder Buffer
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.
653 @item Summary Buffer
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.
657 @item Message Buffer
658 You can see the contents of the message. You can save part to disk or
659 open in external programs.
660 @item Draft Buffer
661 You can edit message.
662 @end table
665 @node Folders, Folder, Start Me Up, Top
666 @chapter Wanderlust's folders
667 @cindex Folder Type
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
672 supported by ELMO.
674 As of version @value{VERSION}, 15 types of folders are predefined. These
675 are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP,
676 Shimbun, Search, Multi, Filter, Pipe, File, Access and Internal folder
677 types.
679 @menu
680 * IMAP Folder::                 @samp{%} -- IMAP folder
681 * NNTP Folder::                 @samp{-} -- NNTP folder
682 * MH Folder::                   @samp{+} -- MH folder
683 * Maildir Folder::              @samp{.} -- Maildir folder
684 * News Spool Folder::           @samp{=} -- News spool folder
685 * Archive Folder::              @samp{$} -- Archive folder
686 * POP Folder::                  @samp{&} -- POP folder
687 * Shimbun Folder::              @samp{@@} -- Shimbun Folder
688 * Search Folder::               @samp{[} -- Search Folder
689 * Multi Folder::                @samp{*} -- Multi folder
690 * Filter Folder::               @samp{/} -- Filter folder
691 * Pipe Folder::                 @samp{|} -- Pipe folder
692 * Internal Folder::             @samp{'} -- Internal folder
693 * File Folder::                          -- File folder
694 * Access Folder::                        -- Access folder
695 @end menu
698 @node IMAP Folder, NNTP Folder, Folders, Folders
699 @section IMAP Folder
700 @cindex @samp{%}
701 @cindex IMAP Folder
702 @cindex Folder, IMAP
703 @cindex RFC 2060
704 @cindex IMAP4rev1
706 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
708 Format:
710 @example
711 @group
712 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
713 @end group
714 @end example
716 You can specify @code{login} (encoded password transmission),
717 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
718 authentication) or @code{clear} (or @code{nil}, plain password
719 transmission) as @var{authenticate-type}.
721 default:
723 @example
724 @var{username}  -> The value of @code{elmo-imap4-default-user}.
725              Initial setting is @env{USER} environment variable or
726              @env{LOGNAME} environment variable or return value of
727              @code{(user-login-name)}.
728 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
729              Initial setting is "auth".
730 @var{hostname}  -> The value of @code{elmo-imap4-default-server}.
731              Initial setting is "localhost".
732 @var{port} -> The value of @code{elmo-imap4-default-port}.
733              Initial setting is 143.
734 @end example
736 You can omit the @var{hostname} from folder names if you set
737 @code{elmo-imap4-default-server} as your main IMAP server.
738 For example, you can specify a folder as @samp{foo%imap@@gateway} even
739 if you have to go through a firewall.
741 @lisp
742 @group
743 ;; @r{Example: imap4.exaple.org as main IMAP server}
744 (setq elmo-imap4-default-server "imap4.example.org")
745 @end group
746 @end lisp
748 SSL (Secure Socket Layer) connection will be used if a folder name ends
749 with @samp{!}.  If a folder name ends with @samp{!!}, STARTTLS
750 connection will be established.
752 If the value of @code{elmo-imap4-default-stream-type} is @code{ssl},
753 SSL will be the default connection, i.e. you can omit @samp{!}.  If it
754 is is @code{starttls}, STARTTLS will be the default connection.  To use
755 normal connection in these cases, add @samp{!direct} at the end of
756 folder name.
758 @lisp
759 @group
760 ;; @r{Example: Use SSL connection}
761 (setq elmo-imap4-default-stream-type 'ssl)
762 @end group
763 @end lisp
765 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
766 authentication method, the password is sent in encoded form. But, if
767 your server is unable to receive an encoded password, authentication
768 will fall back to @code{clear} (that is, sending password in raw format)
769 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
770 authentication will fall back to @code{clear} without confirmation
771 (default value is @code{nil}).
773 @lisp
774 @group
775 ;; @r{Example: password in raw format}
776 (setq elmo-imap4-default-authenticate-type 'clear)
777 @end group
778 @end lisp
780 Example:
782 @example
783 @group
784 %inbox     -> IMAP mailbox "inbox"
785 %#mh/inbox -> IMAP mailbox "#mh/inbox"
787 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
788 %inbox:hoge/clear@@server1
789             -> server1's IMAP mailbox "inbox"
790                of user "hoge", with plain password authentication
791                ('clear).
792 @end group
793 @end example
795 @subsection International mailbox names (Modified UTF7)
796 @cindex Modified UTF7
797 @cindex UTF7
798 @cindex UTF8
799 @cindex Unicode
800 @pindex Mule-UCS
801 @pindex ucs-conv
803 You can use international mailbox names in @var{mailbox} part, if you
804 are using Emacs with UTF-7 support and
805 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
806 value is @code{nil}).
808 Currently, Mule-UCS package is required to use UTF-7.
809 Mule-UCS works on following Emacsen.
811 @itemize @bullet
812 @item Emacs 20.3 or later
813 @item XEmacs 21.2.37 or later
814 @end itemize
816 You can obtain Mule-UCS package from following URL.
818 @example
819 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
820 @end example
822 @node NNTP Folder, MH Folder, IMAP Folder, Folders
823 @section NNTP Folder
824 @cindex @samp{-}
825 @cindex NNTP Folder
826 @cindex Folder, NNTP
827 @cindex Folder, News
828 @cindex NetNews
829 @cindex News
830 @cindex Newsgroup
831 @cindex RFC 977
833 A folder to access USENET news via NNTP protocol (RFC 977).
834 One newsgroup is treated as a folder.
836 Format:
838 @example
839 @group
840 @samp{-} @var{newsgroup} [@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
841 @end group
842 @end example
844 default:
845 @example
846 @var{hostname}  -> The value of @code{elmo-nntp-default-server}.
847              Initial setting is @samp{localhost}.
848 @var{username}  -> The value of @code{elmo-nntp-default-user}.
849              Initial setting is @code{nil}.
850 @var{port}      -> The value of @code{elmo-nntp-default-port}.
851              Initial setting is 119.
852 @end example
854 AUTHINFO is used as authentication method if the @var{username} is
855 non-nil.  SSL connection will be used if a folder name ends with @samp{!}.
856 If a folder name ends with @samp{!!}, STARTTLS connection will be
857 established.
859 If the value of @code{elmo-nntp-default-stream-type} is @code{ssl},
860 SSL will be the default connection, i.e. you can omit @samp{!}.  If it
861 is is @code{starttls}, STARTTLS will be the default connection.  To use
862 normal connection in these cases, add @samp{!direct} at the end of
863 folder name.
865 Example:
867 @example
868 @group
869 -fj.rec.tv            -> Newsgroup @samp{fj.rec.tv}.
870 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
871 @end group
872 @end example
875 @node MH Folder, Maildir Folder, NNTP Folder, Folders
876 @section MH Folder
877 @cindex @samp{+}
878 @cindex MH Folder
879 @cindex Folder, MH
880 @pindex MH
882 A folder to access MH format mail (1 file is 1 mail).
884 Format:
886 @example
887 @samp{+} @var{directory-name}
888 @end example
890 Normally, @var{directory-name} is an relative path to the variable
891 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
892 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
893 (this is also true for drive-letters).
895 Message number is used for the name of the message file.
897 Example:
899 @example
900 @group
901 +inbox         -> @file{~/Mail/inbox}
902 +from/teranisi -> @file{~/Mail/from/teranisi}
903 +~/test        -> @file{~/test}
904 @end group
905 @end example
908 @node Maildir Folder, News Spool Folder, MH Folder, Folders
909 @section Maildir Folder
910 @cindex @samp{.}
911 @cindex Maildir Folder
912 @pindex Maildir
913 @pindex qmail
915 A folder to access Maildir format (1 file is 1 mail).
917 Format:
919 @example
920 @samp{.} [@var{directory-name}]
921 @end example
923 Normally, @var{directory-name} is a relative path to the variable
924 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
925 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
926 (this is also true for drive-letters).
928 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
929 Messages are contained in the @file{cur} directory.  All message files
930 in the @file{new} directory are moved to @file{cur} directory when you
931 access the folder. All message files contained in the @file{tmp}
932 directory and not accessed for 36 hours are deleted.
934 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
936 Example:
938 @example
939 @group
940 .              -> @file{~/Maildir}
941 .inbox         -> @file{~/Maildir/inbox}
942 .from/teranisi -> @file{~/Maildir/from/teranisi}
943 .~/test        -> @file{~/test}
944 @end group
945 @end example
948 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
949 @section News Spool Folder
950 @cindex @samp{=}
951 @cindex News spool Folder
952 @pindex gnspool
954 This folder handles locally saved news articles which are proposed by
955 Mew/IM.  You can also read articles directly from a spool-file which is
956 retrieved by an utility like @command{gnspool}.
958 Format:
960 @example
961 @samp{=} @var{directory-name}
962 @end example
964 @var{directory-name} is a sub-directory to the directory defined by
965 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
966 You can use @samp{.} as directory delimiter as well as @samp{/}.
968 Example:
970 @example
971 @group
972 =fj/os/os2         -> @file{~/News/fj/os/os2}
973 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
974 @end group
975 @end example
978 @node Archive Folder, POP Folder, News Spool Folder, Folders
979 @section Archive Folder
980 @cindex @samp{$}
981 @cindex Archive Folder
982 @c @pindex ange-ftp
984 This method can handle archive files, which are compressed by utilities
985 such as Info-ZIP or LHA, as one folder.
987 Format:
989 @example
990 @group
991 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
992 @end group
993 @end example
995 @var{path-name} is the relative path from
996 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}).  If
997 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
998 DOS', @var{path-name} is treated as absolute path.  ange-ftp format is
999 also permitted under the environment of ange-ftp, efs.
1001 The actual file name of the archive folder is
1002 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1003 under the @var{path-name}. If a file named @var{path-name} exists, it is
1004 treated as folder. The suffix is automatically decided for
1005 @var{archiver-type}.
1007 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1008 (Initial setting is @code{zip}) is referred.
1010 @var{prefix} specifies the internal directory structure of the archive.
1011 For example, if the ML server is fml, @file{msend.tar.gz} has a
1012 structure like @file{spool/1}, so you have to specify @samp{spool} as
1013 @var{prefix}.
1015 Example:
1017 @example
1018 @group
1019 $teranisi         -> @file{~/Mail/teranisi/elmo-archive.zip}
1020 $bsd/freebsd;lha  -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1021 $/foo@@server:~/bar;zoo     -> @file{~/bar/elmo-archive.zoo} on ftp server
1022 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1023 $ml;zip/        -> Access group consists of archive folders
1024                    under @file{~/Mail/ml}
1025 @end group
1026 @end example
1028 @menu
1029 * Archiver::     Supported Archivers
1030 * Archive Tips:: TIPS
1031 * Archive Vars:: Customization
1032 @end menu
1035 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1036 @subsection Supported Archives
1037 @cindex Archiver
1038 @pindex LHA
1039 @pindex Info-ZIP
1040 @pindex UNZIP
1041 @pindex ZOO
1042 @pindex RAR
1043 @pindex TAR
1044 @pindex GNU TAR
1046 By default, following archives are supported.
1048 @example
1049 @group
1050         LHA, Info-ZIP/UNZIP, ZOO, RAR  ;; full-access
1051         GNU TAR('tgz, 'tar)            ;; read-only
1052 @end group
1053 @end example
1055 If your archiver can include multiple files in one archive, you have a
1056 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1057 of the candidate. TAR is supported read-only because it cannot delete
1058 file in the archive (@code{mv})).
1060 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1061 archiver of Wanderlust because they cannot include multiple
1062 files. Archivers that cannot extract files to standard output are also
1063 not supported.
1065 @subsection OS specific information about archiver.
1067 Behaviors of the following archivers are confirmed by further experiences.
1068 (@samp{*} mark means recommended archiver).
1070 @example
1071 [OS/2]  Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1072          LHA  OS/2 version Rel.2.06b    Feb 18, 1998
1073         *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1074         *Zip 2.2 (November 3rd 1997).
1075          Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1076          GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1077          gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1079 [UN|X]  FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1080          LHa for UNIX  V 1.14c
1081          UnZip 5.32 of 3 November 1997
1082          Zip 2.2 (November 3rd 1997)
1083          GNU tar 1.12 (1.11.x is no good)
1084          gzip 1.2.4 (18 Aug 93)
1086 [Win32] Win.98/Meadow
1087          Lha32 version 1.28
1088          Zip 2.2
1089          UnZip 5.40
1090          GNU tar 1.11.8 + 1.5(WIN32)
1091          GZIP 1.2.4
1092          RAR 2.06
1093 @end example
1095 * Caution about LHA
1097 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1098 Hiramatsu version of LHA is only supported.
1099 In Win32, LHa32 is only supported (DOS version is no good).
1101 * Caution about GNU tar
1103 You have to take care about GNU tar's version because many version has
1104 problem on deleting file from archive.
1106 Please test @option{--delete} @option{-f} options work. Otherwise, your
1107 archive will be destroyed. No problem is reported on above versions of
1108 GNU tar.
1111 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1112 @subsection TIPS
1113 @cindex Archive Tips
1115 For comfortable migration, usage of @code{wl-summary-archive}
1116 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended.  To treat
1117 archive folders created by expiration, you must set non-nil value to
1118 @code{elmo-archive-treat-file}.
1120 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1121 in processing speed. For comfortable use, Emacs20 is recommended.
1122 (If re-search's performance is the problem, 19.3x or later may be okay.)
1124 If many files are included in one archive,
1125 it takes long time to access the archive folder because
1126 archiver starting overhead is increased (especially LHA).
1127 150-200 messages in one archive is recommended.
1129 Of course, following is possible @t{:-)}
1130 (meanings of these variables are described later.)
1132 @lisp
1133 @group
1134 (setq wl-fcc "$backup")
1135 (setq wl-trash-folder "$trash;lha")
1136 @end group
1137 @end lisp
1139 @node Archive Vars,  , Archive Tips, Archive Folder
1140 @subsection Variables About Archive Folder
1141 @cindex Archive variables
1143 @table @code
1144 @item elmo-archive-default-type
1145 @vindex elmo-archive-default-type
1146 The initial setting is @code{zip}.
1147 Set archiver type by symbol.
1149 @item elmo-archive-@var{type}-method-alist
1150 @vindex elmo-archive-TYPE-method-alist
1151 Define archiver @var{type}'s methods.
1152 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1153 Each element of the alist is following.
1155 @example
1156 @group
1157 (@var{action} . (@var{exec-name} @var{options}))   ;; external program and its option.
1158 (@var{action} . @var{function})              ;; function
1159 @end group
1160 @end example
1162 Currently available actions are following.
1164 @example
1165 @group
1166 'ls, 'cat ('cat-headers)        ;; Minimal setting(read-only)
1167 'mv ('mv-pipe), 'rm ('rm-pipe)  ;; full-access (with above)
1168 'cp ('cp-pipe)                  ;;
1169 @end group
1170 @end example
1172 @noindent
1173 In above actions,
1174 actions enclosed with braces are optional (They are used for better
1175 performance).
1177 @item elmo-archive-suffix-alist
1178 @vindex elmo-archive-suffix-alist
1179 An alist of archiver-type (symbol) and suffix.
1181 @item elmo-archive-file-regexp-alist
1182 @vindex elmo-archive-file-regexp-alist
1183 An alist of a regexp to get file number from list output of archiver
1184 and archiver-type (symbol).
1186 @item elmo-archive-method-list
1187 @vindex elmo-archive-method-list
1188 A list of elmo-archive-@var{type}-method-alist
1189 (@var{type} is a symbol of archiver-type).
1191 @item elmo-archive-lha-dos-compatible
1192 @vindex elmo-archive-lha-dos-compatible
1193 The initial setting is @code{t} on OS/2 and Win32.  If non-nil, LHA is
1194 DOS (Mr. Yoshizaki original) compatible.
1196 @item elmo-archive-cmdstr-max-length
1197 @vindex elmo-archive-cmdstr-max-length
1198 The initial setting is 8000.
1200 Max length of command line argument for external archiver program.
1201 Emacs does not have a limit of command line byte length, but some OS
1202 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1203 this limit because it calls external archiver program directly (not
1204 called via shell).  For example, you cannot delete messages if archiver
1205 program must receive larger bytes of arguments to delete.  OS/2 have a
1206 command line argument limit of 8190 bytes, so we defined default as 8000
1207 with some margin.
1209 However, you don't have an influence of command line argument limit
1210 if the archiver has `actions' to receive target file information from
1211 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1212 @end table
1215 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1216 @section POP Folder
1217 @cindex @samp{&}
1218 @cindex POP Folder
1219 @cindex RFC 1939
1220 @cindex POP3
1221 @cindex APOP
1223 A folder to access e-mails via POP3 protocol (RFC 1939).
1225 Format:
1227 @example
1228 @group
1229 @samp{&} [@var{username}][@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
1230 @end group
1231 @end example
1233 You can specify
1234 @samp{user}  (plain password transmission) or @samp{apop}  (APOP authentication)
1235 as @var{authenticate-type}.
1237 You can specify @samp{uidl} (use UIDL command for message numbering) or
1238 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1240 default:
1241 @example
1242 @var{username}   -> The value of @code{elmo-pop3-default-user}.
1243               Initial setting is @env{USER} environment variable or
1244              @env{LOGNAME} environment variable or return value of
1245              @code{(user-login-name)}.
1246 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1247               Initial setting is @samp{user}.
1248 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1249               If t, use UIDL for numbering. Initial setting is t.
1250 @var{hostname}   -> The value of @code{elmo-pop3-default-server}.
1251               Initial setting is @samp{localhost}.
1252 @var{port}       -> The value of @code{elmo-pop3-default-port}.
1253               Initial setting is 110.
1254 @end example
1256 Example:
1258 @example
1259 @group
1260 &hoge@@localhost     -> access localhost as user @samp{hoge}.
1261 &hoge@@popserver:109 -> access the server "popserver" on port 109
1262                         as user @samp{hoge}.
1263 @end group
1264 @end example
1266 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1267 (XEmacs doesn't need @file{md5.el}).  @file{md5.el} is included in
1268 @file{utils/sasl/lisp/} or Emacs/W3 package
1269 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1270 (GPL2).
1272 If the last character of the folder name is @samp{!}, Wanderlust
1273 connects to the POP server via SSL (Secure Socket Layer).  If a folder
1274 name ends with @samp{!!}, STARTTLS connection will be established.
1276 If the value of @code{elmo-pop3-default-stream-type} is @code{ssl},
1277 SSL will be the default connection, i.e. you can omit @samp{!}.  If it
1278 is is @code{starttls}, STARTTLS will be the default connection.  To use
1279 normal connection in these cases, add @samp{!direct} at the end of
1280 folder name.
1283 @node Shimbun Folder, Search Folder, POP Folder, Folders
1284 @section Shimbun Folder
1285 @cindex @samp{@@}
1286 @cindex Shimbun Folder
1287 @cindex Folder, Shimbun
1288 @cindex Folder, Web
1289 @pindex w3m
1290 @pindex emacs-w3m
1292 A folder for watching "shimbun" (means "newspaper" in Japanese),
1293 news site and mailing list archives on WWW by using emacs-w3m
1294 (@uref{http://emacs-w3m.namazu.org/}).
1296 You should possess w3m and emacs-w3m to use this.
1298 Format:
1300 @example
1301 @group
1302 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1303 @end group
1304 @end example
1306 Admissible values of @var{module-name} and @var{folder-name} are
1307 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1309 Example:
1311 @example
1312 @group
1313 @@airs.wl  -> archive of wanderlust ML (using module @file{sb-airs.el})
1314 @@asahi/   -> access group of all folders in module @file{sb-asahi.el}
1315 @end group
1316 @end example
1318 @subsection Variables About Shimbun Folder
1320 @table @code
1321 @item elmo-shimbun-update-overview-folder-list
1322 @vindex elmo-shimbun-update-overview-folder-list
1323 The initial setting is @code{all}. Specify a set of folders to update
1324 overview when messages are fetched. Specify @code{all} to update
1325 overview in all shimbun folders. You can specify a list of regular
1326 expressions of shimbun folder names to restrict affected folders.
1328 Example:
1330 @example
1331 (setq elmo-shimbun-update-overview-folder-list
1332       '("^@@airs\\." "^@@namazu\\."))
1333 @end example
1335 Update summary view automatically after fetching.
1336 @end table
1339 @node Search Folder, Multi Folder, Shimbun Folder, Folders
1340 @section Search Folder
1341 @cindex @samp{[}
1342 @cindex Search Folder
1343 @cindex Folder, Search
1344 @cindex Folder, Text Search
1346 A folder to access messages found by an external program with some
1347 condition.
1349 Format:
1351 @example
1352 @group
1353 @samp{[} @var{search condition} @samp{]} [ @var{search target} [ @samp{!} @var{search engine} ] ]
1354 @end group
1355 @end example
1357 The format of the @var{search condition} and @var{search target} depend
1358 on the @var{search engine}.
1360 @subsection Supported search engines
1362 Supported search engines are following ones.  Default search engine can
1363 be assigned by @code{elmo-search-default-engine}.
1365 @menu
1366 * namazu::      namazu
1367 * grep::        grep
1368 @end menu
1371 @node namazu, grep, Search Folder, Search Folder
1372 @subsection namazu
1373 @pindex namazu
1375 The messages registered in the namazu-index is found by using namazu
1376 (@uref{http://www.namazu.org/}).
1378 @var{search condition} is a query of namazu.  Please refer to the
1379 document of the attached to namazu for details.
1381 @var{search target} is a namazu-index used for search.  The directory
1382 with the index or the alias that explain in the following can be
1383 specified.  Default value of the path of namazu index can be assigned by
1384 @code{elmo-search-namazu-default-index-path}.
1386 Example:
1388 @example
1389 @group
1390 [wanderlust]           -> search messages matched with
1391                        "wanderlust" from the default index
1392 [semi flim]~/Mail/semi -> search "semi flim" from the index
1393                        in the directory "~/Mail/semi"
1394 @end group
1395 @end example
1397 @c @subsection TIPS
1399 @subsubsection Enter space to separate keywords
1401 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1403 @subsubsection Alias name for index
1405 You can define an alias name for index.
1407 Example:
1409 @example
1410 (setq elmo-search-namazu-index-alias-alist
1411       '(("cache" . "~/.elmo/cache")
1412         ("docs" . "~/documents")))
1413 @end example
1415 Above definition defines two index aliases.
1416 You can specify
1418 @example
1419 [wanderlust]cache
1420 @end example
1422 to execute a namazu search with keyword @samp{wanderlust} using a index in the 
1423 directory @file{~/.elmo/cache}.
1425 @subsubsection Multiple indices
1427 You can specify a list for @code{elmo-search-namazu-default-index-path} and
1428 @code{elmo-search-namazu-index-alias-alist}.
1429 When list is specified, all index contained in the list is used as the 
1430 namazu indices.
1432 Example:
1434 @example
1435 (setq elmo-search-namazu-index-alias-alist
1436       '(("all" . ("~/.elmo/cache" "~/documents"))
1437         ("cache" . "~/.elmo/cache")))
1438 @end example
1440 Using above alias setting, you can specify
1442 @example
1443 [wanderlust]all
1444 @end example
1446 to execute a namazu search with keyword @samp{wanderlust} using indices in the 
1447 directory @file{~/.elmo/cache} and @file{~/documents}.
1449 @node grep,  , namazu, Search Folder
1450 @subsection grep
1451 @pindex grep
1453 The files that exists in the directory specified with the @var{search
1454 target} are found by using grep.
1456 @var{search condition} is a regular expression of grep.  The directory
1457 as @var{search target} cannot be omitted.
1459 Example:
1461 @example
1462 @group
1463 [wanderlust]~/Mail/inbox!grep
1464     -> search messages matched with "wanderlust"
1465        from the directory "~/Mail/inbox"
1467 ["[sr]emi"]~/Mail/semi!grep
1468     -> If @samp{]} is included in regular expression,
1469        @var{search condition} should be enclosed with @samp{"}.
1470 @end group
1471 @end example
1474 @node Multi Folder, Filter Folder, Search Folder, Folders
1475 @section Multi Folder
1476 @cindex @samp{*}
1477 @cindex Multi Folder
1478 @cindex Folder, Multiple
1479 @cindex Folder, Marge
1481 A folder to access virtual folder which collects messages from
1482 multiple folders.
1484 Format:
1486 @example
1487 @group
1488 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1489 @end group
1490 @end example
1492 After @samp{*} character, specify multiple folders you want to collect
1493 separated by @samp{,} like
1494 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1496 Example:
1498 @example
1499 @group
1500 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1501 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1502    treated as one folder.
1504 *+inbox,-fj.rec.tv,%inbox
1505 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1506 @end group
1507 @end example
1510 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1511 @section Filter Folder
1512 @cindex @samp{/}
1513 @cindex Filter Folder
1514 @cindex Folder, Filtering
1515 @cindex Folder, Virtual
1516 @cindex Folder, Conditional
1517 @cindex Flag
1519 A folder to access virtual folder which collects all messages that
1520 satisfy a condition.
1522 Format:
1524 @example
1525 @samp{/} @var{condition} @samp{/} @var{target-folder}
1526 @end example
1528 In the @var{condition} part, you can specify following.
1530 @enumerate
1531 @item
1532 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1534 first: @var{number} messages are picked from top of folder.
1535 last:  @var{number} messages are picked from bottom of folder.
1537 Example:
1539 @example
1540 @group
1541 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1542 /first:20/%inbox      -> First 20 messages from %inbox are picked.
1543 @end group
1544 @end example
1546 @item
1547 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1549 since: only messages arrived since @var{date} are picked (@var{date} is included).
1550 before: only messages arrived before @var{date} are picked (@var{date} is not included).
1552 You can specify following as @var{date}.
1554 @example
1555 @group
1556 yesterday ->  a day before today.
1557 lastweek  ->  same day of last week.
1558 lastmonth ->  same day of last month.
1559 lastyear  ->  same day of last year.
1560 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1561 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1562 @end group
1563 @end example
1565 Example:
1567 @example
1568 @group
1569 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1570                           are picked.
1571 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1572                           are picked.
1573 @end group
1574 @end example
1576 @item
1577 Field filter: @samp{@var{field}:@var{value}}
1579 All messages that have @var{field} and its value is @var{value} are picked.
1580 @var{field} and @var{value} are case insensitive.
1582 Example:
1584 @example
1585 @group
1586 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1587                          and its value includes "teranisi" string are picked.
1588 /body:foo/%inbox      -> In %inbox, messages which have "foo" text
1589                          are picked.
1590 @end group
1591 @end example
1593 @item
1594 Flag filter: @samp{flag:@var{flag-name}}
1596 Pick up messages with flag specified by @var{flag-name}.
1598 You can specify following flag names:
1600 @example
1601 @group
1602 unread    -> unread
1603 important -> important
1604 answered  -> replied
1605 forwarded -> forwarded
1606 digest    -> unread or important
1607 any       -> unread or replied or forwarded or global-flag.
1608 @end group
1609 @end example
1611 You can also use flags which you have set as `global-flag'.  global-flag
1612 is a flag which has arbitrary name. You can put global-flag on messages
1613 by invoking @code{wl-summary-set-flags} (Key @key{F}). By default,
1614 @samp{important} flag is prepared.  You can view messages with
1615 global-flag by visiting the subfolder of @samp{'flag} folder.
1617 @xref{Internal Folder}.
1619 Example:
1621 @example
1622 @group
1623 /flag:digest/%inbox     -> a folder consist of unread or important
1624                            message in %inbox.
1625 /flag:wl/+ML/Wanderlust -> a folder consist of messages with global flag
1626                            wl in +ML/Wanderlust.
1627 @end group
1628 @end example
1630 @item
1631 Compound condition
1633 A condition starting with @samp{!} indicates a negation.
1634 If you combine conditions by character @samp{|}, it is considered as OR condition.
1635 @samp{&} is considered as AND condition, likewise.
1636 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1638 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1639 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1641 Example:
1643 @example
1644 @group
1645 /from:teranisi&!to:teranisi/+inbox
1646                       -> In +inbox, messages are picked if the message's
1647                          From: field includes "teranisi" and
1648                          To: field doesn't include "teranisi".
1650 /tocc:"Yuuichi Teranishi"/+inbox
1651                       -> In +inbox, messages are picked if the
1652                          message's To: field or Cc: field includes
1653                          "Yuuichi Teranishi".
1655 /(from:yt|from:teranisi)&subject:report/+inbox
1656                       -> In +inbox, messages are picked if the message's
1657                          From: field includes "yt" or "teranisi", and
1658                         Subject includes "report".
1659 @end group
1660 @end example
1661 @end enumerate
1663 @noindent
1664 Tip for string description:
1666 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1667 should be enclosed with @samp{"} in @var{value} string.  (@samp{"}
1668 should be escaped with @samp{\} in it).  You can enclose the string with
1669 @samp{"} even it does not contain these characters.
1671 @noindent
1672 Advanced example:
1674 @example
1675 *%inbox,/from:teranisi/%inbox@@server
1676        -> Messages in %inbox or
1677           message is in the %inbox@@server folder and it's From field
1678           includes "teranisi" are collected.
1680 /last:100//to:teranisi/*+inbox,%inbox
1681        -> Latest 100 messages which is in the +inbox or %inbox folder
1682           and To: field matches "teranisi".
1684 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1685        -> Pick messages which have From: field and it includes "hogehoge"
1686           from latest 20 messages in the %#mh/inbox@@localhost
1687           and To: or Cc: field includes "teranisi".
1688 @end example
1690 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1691 @section Pipe Folder
1692 @cindex @samp{|}
1693 @cindex Pipe Folder
1694 @cindex Get Message
1695 @cindex Download Message
1696 @cindex Incorporate Message
1698 In the pipe folder, messages are automatically transferred from the source
1699 folder to destination folder.
1701 Format:
1703 @example
1704 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1705 @end example
1707 When you access the pipe folder, messages are automatically transferred
1708 from @var{source-folder} to @var{destination-folder}.
1709 It is convenient if you want to download messages to local disk via POP.
1710 For example, if you specify following
1712 @example
1713 |&username@@popserver|+inbox
1714 @end example
1716 @noindent
1717 and access it, Wanderlust downloads messages from
1718 @samp{&username@@popserver} to @samp{+inbox} automatically.
1720 On the other hand, if you put @samp{|:} instead of second @samp{|},
1721 then messages are copied to the destination folder (not deleted from
1722 source-folder). At the next time you access that folder, copies new
1723 messages only.
1725 @example
1726 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1727 @end example
1729 If you want to copy messages from POP server and view them, specify the
1730 folder as follows:
1732 @example
1733 |&username@@popserver|:+inbox
1734 @end example
1736 where messages will be kept on the server.
1738 Example:
1740 @example
1741 @group
1742 |%inbox|%myinbox   -> Download %inbox to %myinbox.
1743 |*&user@@popserver1,&user@@popserver2|+inbox
1744          -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1745 |-gnu.emacs.sources|:+sources
1746          -> Copy messages from -gnu.emacs.sources to +sources.
1747 @end group
1748 @end example
1750 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1752 @node Internal Folder, File Folder, Pipe Folder, Folders
1753 @section Internal folder
1754 @cindex @samp{'}
1755 @cindex Internal Folder
1756 @cindex Folder, @samp{$} mark
1757 @cindex Flag
1758 @cindex Cache
1759 @c @cindex Folder, Null
1761 A folder to access internal messages of Wanderlust.
1763 Format:
1765 @example
1766 @group
1767 @samp{'flag} [@samp{/} @var{global-flag}]
1768 @samp{'sendlog}
1769 @samp{'cache/00} - @samp{'cache/1F}
1770 @end group
1771 @end example
1773 A folder named @samp{'flag} is a special virtual folder which collects
1774 messages which have @var{global-flag}.
1776 There is @samp{important} flag defined as @var{global-flag} by default.
1777 You can review important messages at once after you put important marks
1778 on the messages in the different folders.  If @var{global-flag} is omitted,
1779 it is treated as @samp{important} flag is specified.
1781 In addition, in summary mode, to be described later, you can freely
1782 define global flags and put them on messages.
1783 @xref{Usage of Summary Mode}.
1785 In this folder, if you delete message, @var{global-flag} put on the
1786 message is removed.  If you append messages to this folder, the message
1787 will have @var{global-flag}.
1790 A folder named @samp{'sendlog} is a virtual folder which collects
1791 cached messages which are recoded on @file{~/.elmo/sendlog}.
1792 It might be useful when you forgot to add cc for yourself.
1793 To use this, you should set @code{wl-draft-use-cache} to non-nil
1794 so that sent messages are cached.
1797 You can access cached messages fetched via network by accessing
1798 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1799 the name of the subdirectories of the cache directory
1800 (@file{~/.elmo/cache}).
1803 @node File Folder, Access Folder, Internal Folder, Folders
1804 @section File folder
1805 @cindex File Folder
1807 File Folder gives the view for local file system. 
1808 The one File Folder corresponds to the one directory.
1810 Format:
1812 @example
1813 @samp{file:} @var{Path-of-the-directory}
1814 @end example
1816 Example:
1818 @example
1819 @group
1820 file:~/work     -> @file{~/work}
1821 file:/etc       -> @file{/etc}
1822 @end group
1823 @end example
1826 @node Access Folder,  , File Folder, Folders
1827 @section Access folder
1828 @cindex Access Folder
1830 A folder to access virtual folder which collects messages from a root
1831 folder and subfolders of one.  The add and remove of the subfolder is
1832 automatically reflected.
1835 Format:
1837 @example
1838 @samp{access:} @var{root-folder}
1839 @end example
1841 Example:
1843 @example
1844 @group
1845 access:%INBOX -> All subfolders of IMAP mailbox "inbox".
1846 access:'cache -> All of 'cache folder
1847 @end group
1848 @end example
1851 @node Folder, Summary, Folders, Top
1852 @chapter Folder mode
1853 @cindex Folder
1855 After you start Wanderlust, folder mode is appeared firstly.
1856 It contains folder list you subscribed.
1857 You can select and edit folders in this mode.
1859 @menu
1860 * Selecting Folder:: Select folder you want to read
1861 * Folder Manager::   Editing folders
1862 @end menu
1865 @node Selecting Folder, Folder Manager, Folder, Folder
1866 @section Selecting Folder
1867 @cindex Selecting Folder
1869 @subsection Usage (TIPS)
1871 @subsubsection Check new, unread number
1873 Folder mode looks like this.
1874 (In XEmacs, it looks much nicer @t{;-)})
1876 @example
1877 @group
1878 [-]Desktop:14186/35580/67263
1879    Inbox:3/10/10
1880    Trash:2/7/10
1881    Drafts:0/0/3
1882    Sent:0/9/348
1883    [-]Emacsen:0/34/4837
1884      Wanderlust ML:0/0/558
1885      ELIPS ML:0/0/626
1886      tm:0/0/821
1887      XEmacs Beta:0/29/255
1888      Mew:0/0/998
1889      Mule-Win32:0/0/1491
1890      fj's Emacsen:0/5/88
1891 @end group
1892 @end example
1895 Each line means:
1897 @example
1898 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1899 @end example
1901 @noindent
1902 @kbd{s} key on the folder line updates these numbers.
1903 It changes its color if it has many new messages.
1905 The whole folder mode is a folder group named @samp{Desktop}.
1906 Folder group open/close by return key.
1907 A operation to a folder group is treated as operations on the
1908 children folders.
1909 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1910 six children folders update its unread number status.
1912 @subsubsection Select Folder
1914 To enter summary mode of the folder, type return (or space) key on
1915 the folder line.
1916 If the variable @code{wl-stay-folder-window} has non-nil value,
1917 summary window appears on the right of the folder mode window.
1919 @subsection Key bindings
1921 Folder mode's key binding (related to selecting folders) is following.
1923 @table @kbd
1924 @item @key{SPC}
1925 @itemx @key{RET}
1926 @kindex @key{SPC} (Folder)
1927 @kindex @key{RET} (Folder)
1928 @findex wl-folder-jump-to-current-entity
1929 Enter to the summary mode of the folder at the current cursor point.
1930 With prefix argument, enter the sticky summary.
1931 If the cursor is on the top of folder group line,
1932 the folder group is opened or closed.
1933 When the cursor is on the access group and this command is called
1934 with prefix argument, folder children list is updated to the newest one.
1935 (Children list is updated recursively if the access folder has hierarchical
1936 structure.)
1937 (@code{wl-folder-jump-to-current-entity})
1939 @item M-@key{RET}
1940 @kindex M-@key{RET} (Folder)
1941 @findex wl-folder-update-recursive-current-entity
1942 Folder children list of the access group at the current cursor point
1943 is updated to the newest one.
1944 (Children list is updated recursively if the access folder has hierarchical
1945 structure.)
1946 (@code{wl-folder-update-recursive-current-entity})
1948 @item w
1949 @kindex w (Folder)
1950 @findex wl-draft
1951 Create a new draft message.
1952 (@code{wl-draft})
1954 @item W
1955 @kindex W (Folder)
1956 @findex wl-folder-write-current-folder
1957 If the current cursor point is on the NNTP folder, create a new draft
1958 message which already has @samp{Newsgroups:} field.  If the current
1959 cursor point is on the folder for mailing list (refile destination),
1960 create a new draft message which already has @samp{To:} field with
1961 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1962 valid list).
1963 (@code{wl-folder-write-current-folder})
1965 @item C-c C-o
1966 @kindex C-c C-o (Folder)
1967 @findex wl-jump-to-draft-buffer
1968 Move to the draft buffer if available.  If multiple draft buffer exists,
1969 moved to one after another.  If prefix argument is specified, load draft
1970 folder's message to the draft buffer and jump to it.
1971 (@code{wl-jump-to-draft-buffer})
1973 @item s
1974 @kindex s (Folder)
1975 @findex wl-folder-check-current-entity
1976 Update new and unread number information of the folder at the current
1977 cursor point.
1978 (@code{wl-folder-check-current-entity})
1980 @item S
1981 @kindex S (Folder)
1982 @findex wl-folder-sync-current-entity
1983 Update summary information of the folder at the current cursor point.
1984 (@code{wl-folder-sync-current-entity})
1986 @item r s
1987 @kindex r s (Folder)
1988 @findex wl-folder-check-region
1989 Update new and unread number information of the folders in the currently
1990 selected region.
1991 (@code{wl-folder-check-region})
1993 @item r S
1994 @kindex r S (Folder)
1995 @findex wl-folder-sync-region
1996 Update summary information of the folders in the currently selected region.
1997 (@code{wl-folder-sync-region})
1999 @item Z
2000 @kindex Z (Folder)
2001 @findex wl-status-update
2002 Sync up address book status with @file{~/.addresses}'s content.
2003 (@code{wl-status-update})
2005 @item P
2006 @kindex P (Folder)
2007 @findex wl-folder-prev-unread
2008 Jump cursor to the folder which have unread messages on the upward from
2009 current cursor point.
2010 (@code{wl-folder-prev-unread})
2012 @item N
2013 @kindex N (Folder)
2014 @findex wl-folder-next-unread
2015 Jump cursor to the folder which have unread messages on the downward
2016 from current cursor point.
2017 (@code{wl-folder-next-unread})
2019 @item p
2020 @kindex p (Folder)
2021 @findex wl-folder-prev-entity
2022 Move cursor to the folder on the previous line.
2023 (@code{wl-folder-prev-entity})
2025 @item n
2026 @kindex n (Folder)
2027 @findex wl-folder-next-entity
2028 Move cursor to the folder on the next line.
2029 (@code{wl-folder-next-entity})
2031 @item J
2032 @kindex J (Folder)
2033 @findex wl-folder-jump-folder
2034 Jump to the folder specified by the user input.
2035 (@code{wl-folder-jump-folder})
2037 @item I
2038 @kindex I (Folder)
2039 @findex wl-folder-prefetch-current-entity
2040 Prefetch new messages of the folder at the current cursor point by
2041 @code{wl-summary-incorporate}.
2042 If the cursor is on the folder group, it is executed recursively.
2043 (@code{wl-folder-prefetch-current-entity})
2045 @item c
2046 @kindex c (Folder)
2047 @findex wl-folder-mark-as-read-all-current-entity
2048 Mark all unread messages of the folder at the current cursor point as read.
2049 If the cursor is on the folder group, it is executed recursively.
2050 (@code{wl-folder-mark-as-read-all-current-entity})
2052 @item f
2053 @kindex f (Folder)
2054 @findex wl-folder-goto-first-unread-folder
2055 Enter summary mode of the first unread folder.
2056 (@code{wl-folder-goto-first-unread-folder})
2058 @item E
2059 @kindex E (Folder)
2060 @findex wl-folder-empty-trash
2061 Empty trash.
2062 (@code{wl-folder-empty-trash})
2064 @item F
2065 @kindex F (Folder)
2066 @findex wl-folder-flush-queue
2067 Flush queue.
2068 (@code{wl-folder-flush-queue})
2070 @item V
2071 @kindex V (Folder)
2072 @findex wl-folder-virtual
2073 Move to the virtual folder (filter folder) with the condition specified.
2074 (@code{wl-folder-virtual})
2076 @item ?
2077 @kindex ? (Folder)
2078 @findex wl-folder-pick
2079 Search the folders with the condition specified.
2080 (@code{wl-folder-pick})
2082 @item o
2083 @kindex o (Folder)
2084 @findex wl-folder-open-all-unread-folder
2085 All unread folder is opened.
2086 (@code{wl-folder-open-all-unread-folder})
2088 @item x
2089 @kindex x (Folder)
2090 @findex wl-execute-temp-marks
2091 Execute marks in summary buffers. @xref{Sticky Summary}.
2092 (@code{wl-execute-temp-marks})
2094 @item /
2095 @kindex / (Folder)
2096 @findex wl-folder-open-close
2097 Folder group is opened/closed.
2098 (@code{wl-folder-open-close})
2100 @item [
2101 @kindex [ (Folder)
2102 @findex wl-folder-open-all
2103 All folder group is opened.
2104 (@code{wl-folder-open-all})
2106 @item ]
2107 @kindex ] (Folder)
2108 @findex wl-folder-close-all
2109 All folder group is closed.
2110 (@code{wl-folder-close-all})
2112 @item q
2113 @kindex q (Folder)
2114 @findex wl-exit
2115 Quit Wanderlust.
2116 (@code{wl-exit})
2118 @item z
2119 @kindex z (Folder)
2120 @findex wl-folder-suspend
2121 Suspend Wanderlust.
2122 (@code{wl-folder-suspend})
2124 @item M-s
2125 @kindex M-s (Folder)
2126 @findex wl-save
2127 Save current folder status.
2128 (@code{wl-save})
2130 @item M-t
2131 @kindex M-t (Folder)
2132 @findex wl-toggle-plugged
2133 Toggle Wanderlust's offline/online status.
2134 (@code{wl-toggle-plugged})
2136 @item C-t
2137 @kindex C-t (Folder)
2138 @findex wl-plugged-change
2139 Start Wanderlust's plug-status manager.
2140 (@code{wl-plugged-change})
2141 @end table
2143 @subsection Customize variables
2145 @table @code
2146 @item wl-folders-file
2147 @vindex wl-folders-file
2148 The initial setting is @file{~/.folders}.
2149 Subscribed folders are described (saved) in this file.
2151 @item wl-folder-info-save
2152 @vindex wl-folder-info-save
2153 The initial setting is @code{t}.  If non-nil, unread information is
2154 saved and used in the next Wanderlust session.
2156 @item wl-stay-folder-window
2157 @vindex wl-stay-folder-window
2158 The initial setting is @code{nil}.
2159 If non-nil, summary window is appeared on the right side of the folder buffer.
2161 @item wl-folder-window-width
2162 @vindex wl-folder-window-width
2163 The initial setting is 20.
2164 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
2166 @item wl-folder-use-frame
2167 @vindex wl-folder-use-frame
2168 The initial setting is @code{nil}.
2169 If non-nil, use new frame for the folder window.
2171 @item wl-folder-many-unsync-threshold
2172 @vindex wl-folder-many-unsync-threshold
2173 The initial setting is 70.
2174 If the number of unread messages is more than this value,
2175 folder color is changed.
2177 @item wl-highlight-folder-by-numbers
2178 @vindex wl-highlight-folder-by-numbers
2179 This option controls how to highlight each line in the folder buffer.
2180 The default value is @code{t}, highlighting with various colors based on
2181 the message numbers.  If it is @code{nil}, highlighting with various
2182 colors based on the folder status.  In addition, if it is a number
2183 (e.g. 1), highlighting will be done based on both the message numbers
2184 and the folder status.
2186 @item wl-folder-desktop-name
2187 @vindex wl-folder-desktop-name
2188 The initial setting is @samp{Desktop}.
2189 The name of top folder group.
2191 @item wl-folder-petname-alist
2192 @vindex wl-folder-petname-alist
2193 The initial setting is @code{nil}.
2194 An alist of folder's realname and its nickname.
2196 @item wl-folder-access-subscribe-alist
2197 @vindex wl-folder-access-subscribe-alist
2198 The initial setting is @code{nil}.
2200 Control automatic subscribing and unsubscribing of the children list
2201 of access groups.
2203 Each element is:
2205 @example
2206 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2207 @end example
2209 @noindent
2210 If @var{subscribe-flag} is non-nil, folders which have name matched to
2211 @var{regexp-of-folders} are displayed. Otherwise, hidden.  However,
2212 already unsubscribed folder is not displayed even when the
2213 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2214 specified.
2216 Example:
2218 @lisp
2219 @group
2220 '(("^-fj$" . (t   "^-fj\\.\\(comp\\|editor\\|mail\\)"
2221                   "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2222   ("^-$" . (t   "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2223   ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2224 @end group
2225 @end lisp
2227 @item wl-folder-hierarchy-access-folders
2228 @vindex wl-folder-hierarchy-access-folders
2229 A list of regular expressions for access groups which creates children
2230 folder list hierarchically.
2232 For example, if you specify
2233 @code{wl-folder-hierarchy-access-folders} like following,
2235 @lisp
2236 @group
2237 (setq wl-folder-hierarchy-access-folders
2238      '("^-[^\\.]*$" "^-comp.unix$" "^-comp.unix.bsd$"))
2239 @end group
2240 @end lisp
2242 @noindent
2243 you obtain the access group hierarchy as follows.
2245 @example
2246 @group
2247    [-]-:912/912/3011
2248      [-]-fj:674/674/1314
2249        -fj.comp.announce:0/0/2
2250        -fj.comp.dev.cdrom:0/0/0
2251        @dots{}
2252      [+]-japan:238/238/1688
2253      [-]-comp:0/0/4
2254        [-]-comp.unix:0/0/0
2255          -comp.unix.admin:0/0/0
2256          -comp.unix.dos-under-unix:0/0/0
2257          -comp.unix.programmer:0/0/0
2258          [-]-comp.unix.bsd:0/0/23
2259            -comp.unix.bsd.freebsd.announce:0/0/0
2260      @dots{}
2261 @end group
2262 @end example
2264 If you opened @samp{-} in this example, only the direct children is created
2265 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2266 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2267 is not created until the children access group is opened.
2268 @end table
2271 @node Folder Manager,  , Selecting Folder, Folder
2272 @section Editing Folders
2273 @cindex Folder Manager
2274 @cindex Folder, Edit
2275 @cindex Folder, Subscribe
2276 @cindex Folder, Unsubscribe
2278 As described before, subscribed folder list is saved in @file{~/.folders} file.
2279 But you don't have to edit @file{~/.folders} directly.
2280 You can append, delete, edit folders from folder mode.
2282 @subsection Usage (Tips)
2284 @subsubsection Append Folder
2286 @kbd{m a} appends new folder to your folder list. If you enter non-existent
2287 folder, it will ask you to create a new one.
2288 @kbd{m g} appends new folder group.
2289 To append new folder to this group, firstly open it,
2290 then execute append command in the next line.
2292 @subsubsection Edit Folder
2294 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2295 Thus, you can change folder position as if you were editing a normal file.
2297 @subsubsection Create Multi Folder.
2299 @enumerate
2300 @item
2301 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2302 @item
2303 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2304 @item
2305 Type @kbd{m m}, then you can create multi folder.
2306 @end enumerate
2308 @subsubsection Delete Nickname, Filter
2310 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2311 minibuffer while appending.
2313 @subsubsection Append Folder to Empty Group
2315 To append new folder to the empty folder group
2316 (after you create folder group by typing @kbd{m g}),
2317 firstly open it, then execute append command in the next line.
2318 If it is closed, folder is appended on the same level with
2319 the folder group above. It is difficult to explain by words so try it.
2320 In other words, appended position depends on the
2321 open/close status of the upper one.
2323 @subsubsection Charset of the Folders File.
2325 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2327 @subsubsection Create Filter
2329 @kbd{m f} adds filter to the folder at the current cursor point.  To
2330 create new filter folder and leave the current folder unchanged, copy it
2331 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}.  Multiple
2332 filter can be specified while appending filter.  If you put
2333 ``''(@var{NULL}), filter is deleted.
2335 @subsubsection Sort Folders
2337 Sorting of the folders is executed by the function specified by
2338 @code{wl-fldmgr-sort-function}.
2339 The initial setting is @code{wl-fldmgr-sort-standard},
2340 which sorts alphabetically.
2341 Sorting affects only on the current folder group. It does not
2342 affect on the child groups.
2344 @subsubsection Hiding Folders in the Access Group
2346 Usually, access group displays all children folders, but you can set
2347 some folders hidden. Following operations are only available on access
2348 group.
2350 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2351 (subscribe/unsubscribe) of the folder at current cursor point.  Against
2352 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2353 specified region.
2355 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2356 @code{wl-fldmgr-unsubscribe} toggles.  These two commands accept prefix
2357 argument and if the argument has positive number, the unsubscribe it.
2358 If the prefix argument has negative value, folder becomes visible and if
2359 zero, folder visibility is toggled.
2361 The other commands, @code{wl-fldmgr-subscribe} and
2362 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2363 key).
2365 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2366 executed in the access group, they have a same effect with
2367 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2368 The difference is that cut commands deletes folders from the current
2369 buffer.
2371 @subsubsection Operations in the Access Group
2373 You can insert and delete folders in the access group like usual folder
2374 group.  But insert and delete commands can be only available for the
2375 children folders of the access group and they only sets the subscribe
2376 status.  In other words, insertion of the folder means subscribing,
2377 deletion means unsubscribing.
2378 @footnote{In the current implementation,
2379 it is faster to delete region than to unsubscribe region.}
2381 To update the access group when children folders are inserted or deleted
2382 by other way (other than Wanderlust),
2383 open the access group by typing @kbd{C-u @key{RET}}.
2384 @xref{Selecting Folder}.
2386 The order of children folders of access group is saved after
2387 insertion/deletion/sorting.
2388 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2389 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2390 newly created folders are inserted on the top of the access group.
2392 @subsection Key bindings
2393 @cindex Keybind, Folder Mode
2394 @cindex Keybind, Folder Buffer
2396 Key bindings on the folder mode related to folder editing are shown below.
2397 All bindings starts with @kbd{m}, and primary commands are binded to
2398 one stroke key binding.
2400 @table @kbd
2401 @item m a
2402 @kindex m a (Folder)
2403 @findex wl-fldmgr-add
2404 Add specified folder to your folder list . If you enter non-existent
2405 folder, create it after confirmation.
2406 (@code{wl-fldmgr-add})
2408 @item +
2409 @itemx m g
2410 @kindex + (Folder)
2411 @kindex m g (Folder)
2412 @findex wl-fldmgr-make-group
2413 Create a folder group.
2414 (@code{wl-fldmgr-make-group})
2416 @itemx m A
2417 @kindex m A (Folder)
2418 @findex wl-fldmgr-make-access-group
2419 Create an access group.
2420 (@code{wl-fldmgr-make-access-group})
2422 @item m d
2423 @kindex m d (Folder)
2424 @findex wl-fldmgr-delete
2425 Delete folder itself and msgdb.
2426 If the folder itself cannot be deleted like NNTP folder,
2427 only msgdb is deleted.
2428 (@code{wl-fldmgr-delete})
2430 @item R
2431 @itemx m R
2432 @kindex R (Folder)
2433 @kindex m R (Folder)
2434 @findex wl-fldmgr-rename
2435 Change the name of folder or folder group.
2436 msgdb's path is also changed.
2437 (@code{wl-fldmgr-rename})
2439 @item *
2440 @itemx m m
2441 @kindex * (Folder)
2442 @kindex m m(Folder)
2443 @findex wl-fldmgr-make-multi
2444 Create a multi folders in the cutlist (cut, copied folders).
2445 (@code{wl-fldmgr-make-multi})
2447 @item |
2448 @itemx m f
2449 @kindex | (Folder)
2450 @kindex m f (Folder)
2451 @findex wl-fldmgr-make-filter
2452 Create a filter folder. (Put a filter on the folder).
2453 (@code{wl-fldmgr-make-filter})
2455 @item M-c
2456 @itemx m c
2457 @kindex M-c (Folder)
2458 @kindex m c (Folder)
2459 @findex wl-fldmgr-copy
2460 Copy folder (it is not available on folder group).
2461 (@code{wl-fldmgr-copy})
2463 @item M-w
2464 @itemx m W
2465 @kindex M-w (Folder)
2466 @kindex m W (Folder)
2467 @findex wl-fldmgr-copy-region
2468 Copy folders in the specified region.
2469 (@code{wl-fldmgr-copy-region})
2471 @item C-k
2472 @itemx m k
2473 @kindex C-k (Folder)
2474 @kindex m k (Folder)
2475 @findex wl-fldmgr-cut
2476 Cut folder. Folder itself is not deleted.
2477 (@code{wl-fldmgr-cut})
2479 @item C-w
2480 @itemx m C-w
2481 @kindex C-w (Folder)
2482 @kindex m C-w (Folder)
2483 @findex wl-fldmgr-cut-region
2484 Cut folders in the specified region.
2485 (@code{wl-fldmgr-cut-region})
2487 @item C-y
2488 @itemx m y
2489 @kindex C-y (Folder)
2490 @kindex m y (Folder)
2491 @findex wl-fldmgr-yank
2492 Paste folders that are copied or cut (folders in the cut-list).
2493 (@code{wl-fldmgr-yank})
2495 @item m p
2496 @kindex m p (Folder)
2497 @findex wl-fldmgr-set-petname
2498 Put nickname on the folder.
2499 (@code{wl-fldmgr-set-petname})
2501 @item m q
2502 @kindex m q (Folder)
2503 @findex wl-fldmgr-clear-cut-entity-list
2504 Clear the cut-list. (cut, copied folder information is cleared,
2505 you cannot paste after this)
2506 (@code{wl-fldmgr-clear-cut-entity-list})
2508 @item m s
2509 @kindex m s (Folder)
2510 @findex wl-fldmgr-sort
2511 Sort folders in the current folder group.
2512 (@code{wl-fldmgr-sort})
2514 @item m C-s
2515 @kindex m C-s (Folder)
2516 @findex wl-fldmgr-save
2517 Save current folder view to the @file{wl-folders-file}.
2518 (@code{wl-fldmgr-save})
2519 @end table
2521 [Following commands are only available on the access groups]
2523 @table @kbd
2524 @item u
2525 @itemx m u
2526 @kindex u (Folder)
2527 @kindex m u (Folder)
2528 @findex wl-fldmgr-unsubscribe
2529 Set the visibility of folder (subscribe/unsubscribe).
2530 (@code{wl-fldmgr-unsubscribe})
2532 @item U
2533 @itemx r u
2534 @kindex U (Folder)
2535 @kindex r u (Folder)
2536 @findex wl-fldmgr-unsubscribe-region
2537 Set the visibility of the folders (subscribe/unsubscribe) in the
2538 specified region.
2539 (@code{wl-fldmgr-unsubscribe-region})
2541 @item l
2542 @itemx m l
2543 @kindex l (Folder)
2544 @kindex m l (Folder)
2545 @findex wl-fldmgr-access-display-normal
2546 List folders that are currently available.
2547 (@code{wl-fldmgr-access-display-normal})
2549 @item L
2550 @itemx m L
2551 @kindex L (Folder)
2552 @kindex m L (Folder)
2553 @findex wl-fldmgr-access-display-all
2554 List all folders regardless of the subscription status.
2555 (@code{wl-fldmgr-access-display-all})
2556 @end table
2559 @subsection Customize variables
2561 @table @code
2562 @item  wl-interactive-save-folders
2563 @vindex wl-interactive-save-folders
2564 The initial setting is @code{t}.  If non-nil and folder view is
2565 modified, confirm saving it before Wanderlust or Emacs exits.  If
2566 @code{nil}, save without confirmation.
2568 @item wl-fldmgr-make-backup
2569 @vindex wl-fldmgr-make-backup
2570 The initial setting is @code{t}.  If non-nil, @file{~/.folders.bak} is
2571 created before saving the folder status.
2573 @item wl-fldmgr-sort-function
2574 @vindex wl-fldmgr-sort-function
2575 The initial setting is @code{wl-fldmgr-sort-standard}.  A function to
2576 sort folders.  By default function, folders are sorted alphabetically
2577 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2578 is non-nil).
2580 @item wl-fldmgr-sort-group-first
2581 @vindex wl-fldmgr-sort-group-first
2582 The initial setting is @code{t}.  If non-nil,
2583 @code{wl-fldmgr-sort-standard} precedes folder group.  If @code{nil}, it
2584 does not care whether it is folder group or not.
2586 @item wl-folder-check-async
2587 @vindex wl-folder-check-async
2588 The initial setting is @code{t}.  If non-nil, check folder's unread
2589 status asynchronously.  It boosts newsgroup checking.
2591 @item wl-folder-check-fast
2592 @vindex wl-folder-check-fast
2593 The initial setting is @code{nil}.
2594 If non-nil, it does not update folder status while checking.
2595 @c it is obsolete?
2596 @item wl-folder-notify-deleted
2597 @vindex wl-folder-notify-deleted
2598 The initial setting is @code{nil}.
2599 @c  nil means?
2600 If non-nil, negative value is displayed when the message is deleted.  If
2601 @code{sync}, folder is synchronized when the message is deleted.  If
2602 @code{nil}, message deletion is ignored.
2604 @item wl-fldmgr-add-complete-with-current-folder-list
2605 @vindex wl-fldmgr-add-complete-with-current-folder-list
2606 The initial setting is @code{nil}.
2607 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2608 candidate for @code{wl-fldmgr-add}.
2609 @end table
2611 @subsection Miscellanea
2613 Following is a note for folder editing.
2615 @enumerate
2616 @item
2617 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2618 paste(yank) command pastes the folders on one cut or copy command
2619 (If copy command is executed by region, folders in the region are pasted
2620 by one paste command)
2622 @item
2623 You cannot cut @samp{Desktop} group.
2624 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2626 @item
2627 You cannot copy folder group.
2629 @item
2630 Operations on the access group are only available for the folders
2631 in the same access group.
2633 @item
2634 You cannot create a folder which has same name with the folders already exist.
2636 @item
2637 You cannot insert folders which have same name in one group.
2638 You can insert them in the different groups.
2639 You cannot put same nickname to the different folders.
2640 @end enumerate
2643 @node Summary, Message, Folder, Top
2644 @chapter Summary Mode
2646 After you select the folder via folder mode, you enter to the summary
2647 mode.
2649 @menu
2650 * Usage of Summary Mode::       TIPS
2651 * Thread Operations::           Thread operations
2652 * Cache::                       File cache, Buffer cache, and Prefetch
2653 * Auto Refile::                 Auto refile settings
2654 * Sticky Summary::              Summary make sticky
2655 * Summary View::                Format of summary lines
2656 * Mark and Action::             Temporary marks and their effect
2657 * Key Bindings of Summary::     Key bindings
2658 * Variables of Summary::        Customize Summary Mode
2659 @end menu
2662 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2663 @section Usage (Tips)
2665 @subsection Summary Content
2667 In the summary mode, messages are displayed like following.
2669 @example
2670 @group
2671   377  09/16(Wed)11:57 [+1: Takuro Kitame  ] Bug?
2672   381  09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2673   384  09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2674   389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2675 @end group
2676 @end example
2678 Each line displays:
2680 @example
2681 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2682 @end example
2684 @noindent
2685 If you want to know how to change the format for this, please refer
2686 the section format of Summary lines.
2687 @xref{Summary View}.
2689 @var{Message number} is the message's unique number in the folder. In
2690 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2691 in the MH folder, it is the filename of the message.
2693 @var{Temporal mark} and @var{Persistent mark} are described later.
2695 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2696 Day})@var{Hour}:@var{Minute}}.  Default setting displays week day in
2697 Japanese, but if you want to display it in English, set the value of
2698 @code{wl-summary-weekday-name-lang} as @samp{en}.
2700 @var{Sender}'s indentation corresponds to the depth of the thread.
2701 Sender name is displayed as nickname if it is defined in the address
2702 book.  Set @code{wl-use-petname} as @code{nil}, if you want to quit
2703 displaying with nickname.
2705 If number is printed at the head of @var{Sender} part like @samp{+2},
2706 that means the message have 2 follow messages.
2708 @var{Subject} is the @samp{Subject:} header field of the message.  If
2709 the message have same @samp{Subject:} with the parent message, it is not
2710 displayed.  Some mailing list puts its sequence number in the
2711 @samp{Subject:} field, but it is
2712 ignored. @code{wl-summary-no-subject-message} is displayed when the
2713 message has empty subject field.
2715 @subsection Temporary Marks
2716 @cindex Mark, Temporary
2718 There are seven temporary marks,
2719 @samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}.
2720 Temporary marks indicates message operations.
2722 @table @samp
2723 @item *
2724 Target mark.
2725 You can execute a command on the all messages that have @samp{*} mark,
2726 with the key bindings which begins with @kbd{m}.
2728 @item d
2729 The mark to dispose. You can put @samp{d} by typing @kbd{d} key.
2731 @item D
2732 The mark to force delete. You can put @samp{D} by typing @kbd{D} key.
2734 @item o
2735 The mark to refile.
2736 After you type @kbd{o} key, prompt appears to input refile destination.
2737 Your answer is printed in the summary line.
2739 @item O
2740 The mark to refile.
2741 You can put this mark by typing @kbd{O} key.
2742 The difference between this mark and refile mark is,
2743 this mark does not delete the message while latter does.
2745 @item i
2746 The mark to prefetch reserved.
2747 You can put this mark by typing @kbd{i} key.
2749 @item ~
2750 The mark to resend reserved.
2751 After you type @kbd{~} key, prompt appears to input address to resend.
2752 Your answer is printed in the summary line.
2753 @end table
2755 @kbd{x} key executes action for temporary marks, respectively.
2757 @subsection Persistent Marks
2759 There are ten persistent marks, @samp{!}, @samp{N}, @samp{n}, @samp{U},
2760 @samp{u}, @samp{A}, @samp{a}, @samp{F}, @samp{f} and @samp{$}.
2762 The persistent mark indicates the message's status and it is saved.
2763 Each persistent mark indicates:
2765 @table @samp
2766 @item N
2767 It is new message.
2768 @item n
2769 It is new message. It differs from @samp{N} that message with @samp{n}
2770 is already cached.
2771 @item U
2772 It is unread message.
2773 @item u
2774 It is unread message. It differs from @samp{U} that message with @samp{u}
2775 is already cached.
2776 @item !
2777 It is message already read. It differs from message without mark that
2778 message with @samp{!} is not cached yet.
2779 @item A
2780 It is already replied message.
2781 @item a
2782 It is already replied message. It differs from @samp{A} that message
2783 with @samp{a} is already cached.
2784 @item F
2785 It is already forwarded message.
2786 @item f
2787 It is already forwarded message. It differs from @samp{F} that message
2788 with @samp{f} is already cached.
2789 @item $
2790 It is a message with some global flag.  It is convenient to put this
2791 mark on the messages to remember (If you want to remember to write a
2792 reply for the message, for example) because this mark remains after
2793 you exited Emacs.  Messages with the @samp{$} mark can be reviewed in
2794 the @samp{'flag} folder even the message itself is deleted in the actual
2795 folder. You can put global flag by typing @kbd{$} or @kbd{F} key.
2797 @item None
2798 If the message is read and cached (or local message),there are no
2799 persistent mark.
2800 @end table
2802 @samp{N}, @samp{U}, @samp{!}, @samp{A}, @samp{F} indicates that the
2803 message have no cache.  Messages with the marks other than these, you
2804 can read them in the offline status even they are in the IMAP folder or
2805 netnews folder.
2807 Among messages with persistent marks, ones with marks specified by 
2808 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2809 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2811 @subsection How To Read
2813 Basically, you can read messages only typing space key again and again.
2815 To update summary status to the newest status (synchronize),
2816 type @kbd{s} key.
2818 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2819 moves cursor to the next message.
2820 Enter message buffer by typing @kbd{j} key.
2821 To operate multipart, you have to enter to the message buffer.
2822 @xref{Message}.
2824 @subsection Pack the Message Numbers
2825 You can pack the message numbers in Summary by
2826 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2827 News Spool Folder and Maildir Folder are supported folder types.
2830 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2831 @section Thread Operations
2833 For example, the following line indicates one thread (a context of a topic).
2835 @example
2836   384  09/17(Thu)01:32 [+1: Teranishi       ] wl-0.6.2
2837 @end example
2839 @noindent
2840 If you type @kbd{/} on this line, the thread is opened and it changes
2841 the appearance like following.
2843 @example
2844 @group
2845   384  09/17(Thu)01:32 [ Teranishi          ] wl-0.6.2
2846   388  09/17(Thu)22:34 +-[ Murata san         ]
2847 @end group
2848 @end example
2850 (Message 388 is the replied message to the message 384.)
2851 If you type @kbd{/} key once again, the thread is closed.
2852 With prefix argument, @kbd{/} opens all children threads.
2854 If you type @kbd{[}, opens all threads in summary.  @kbd{]} closes all
2855 threads.
2857 Commands with the key binding that begins with @kbd{t} executes commands
2858 on the messages in the thread.
2859 @xref{Key Bindings of Summary}.
2861 @subsection reconstruct thread by hand
2863 You can reconstruct the thread manually.  In Summary, @kbd{M-w}
2864 (@code{wl-summary-save-current-message}) at the corresponding message,
2865 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2866 message then you have the reconstructed thread.
2869 @node Cache, Auto Refile, Thread Operations, Summary
2870 @section Cache
2872 @subsection Cache File
2874 The messages which have to access via network (e.x. IMAP, NNTP folder)
2875 are cached as a local file so as to save network traffic or to enable
2876 off-line operation.  The cache file is saved under the directory
2877 @file{~/.elmo/cache}.  To expire cache, type @kbd{M-x
2878 elmo-cache-expire-by-size}.  The command deletes cache files to the
2879 specified size by the order of last accessed time.
2881 @subsection Buffer Cache and Prefetching
2883 The messages that are read are kept in the cache buffer so as to make
2884 the behavior fast when you are to read the message again.  It is called
2885 `buffer cache'. The number of cache buffer is specified by
2886 @code{wl-message-buffer-cache-size}.
2888 There are message prefetching mechanism in the Wanderlust that
2889 prefetches next message while you are reading.
2891 You can control the message prefetching mechanism by these two
2892 variables.
2894 @table @code
2895 @item wl-message-buffer-prefetch-folder-type-list
2896 @vindex wl-message-buffer-prefetch-folder-type-list
2897 The initial setting is @code{'(imap4 nntp)}.  If it is a list of folder
2898 types, it specifies the folder types in which message prefetching is
2899 enabled. In initial setting, messages are prefetch only in the nntp and
2900 imap4 folders. In this case, multi folder that contains localdir and 
2901 imap4 prefetches only imap4 messages. This variable precedes the value of
2902 @code{wl-message-buffer-prefetch-folder-list}.
2903 To prefetch messages in all folder types, specify @code{t}.
2905 @item wl-message-buffer-prefetch-folder-list
2906 @vindex wl-message-buffer-prefetch-folder-list
2907 The initial setting is @code{nil}.
2908 A list of regexp of folders to enable message prefetching.
2910 @item wl-message-buffer-prefetch-depth
2911 @vindex wl-message-buffer-prefetch-depth
2912 The initial setting is 1. The number of messages for automatical prefetch.
2914 @item wl-message-buffer-prefetch-idle-time
2915 @vindex wl-message-buffer-prefetch-idle-time
2916 The initial setting is 1 (in seconds). The period of automatical prefetch.
2918 @item wl-message-buffer-prefetch-threshold
2919 @vindex wl-message-buffer-prefetch-threshold
2920 The initial setting is 30000 (bytes). If prefetching message has larger
2921 size than this value, Wanderlust does not prefetch automatically.
2922 If @code{wl-message-buffer-prefetch-threshold} is @code{nil}, 
2923 the message is not checked for the size.
2925 @item wl-auto-prefetch-first
2926 @vindex wl-auto-prefetch-first
2927 The initial setting is @code{nil}.
2928 If non-nil, first message is automatically prefetched to the buffer
2929 when you enter the folder.
2930 @end table
2933 @node Auto Refile, Sticky Summary, Cache, Summary
2934 @section Auto Refile
2935 @vindex elmo-msgdb-extra-fields
2936 @vindex wl-refile-rule-alist
2937 @findex wl-summary-auto-refile
2939 You can refile messages automatically, by typing @kbd{C-o}
2940 (@code{wl-summary-auto-refile}). It decides destination of refile by
2941 the content of the message header information (information in the msgdb).
2943 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2944 available.  If you want to decide destination by other header fields,
2945 set the variable @code{elmo-msgdb-extra-fields} like following.
2947 @lisp
2948 @group
2949 (setq elmo-msgdb-extra-fields
2950       '("x-ml-name"
2951         "reply-to"
2952         "sender"
2953         "mailing-list"
2954         "newsgroups"))
2955 @end group
2956 @end lisp
2958 @noindent
2959 By this setting, Wanderlust saves extra fields in the msgdb.  You have
2960 to type @kbd{s all} to get extra fields for the messages that are
2961 already exists in the summary.
2963 Then, specify the refile rule.  The refile target folder of auto
2964 refiling is decided by the value of @code{wl-refile-rule-alist}.
2965 @code{wl-refile-rule-alist} is a list of a rule:
2967 @example
2968 @group
2969 (@var{field} (@var{regexp} . @var{target})
2970        (@var{regexp} . @var{target})
2971        @dots{})
2972 @end group
2973 @end example
2975 Each rule means `if @var{field} value matches @var{regexp},
2976 then refile to @var{target} folder'.
2977 The rule matched first is applied.
2979 @var{field} is a string of field name.  You can specify a list of field name
2980 string, too. In this case, if one of these fields is matched, then the
2981 rule is fired (i.e. OR condition).
2983 @var{regexp} is a regular expression for field value.  @var{target} is a target
2984 folder string. You can specify a rule at @var{target} part, too.  In this
2985 case, If the field value of the rule and the current rule is matched,
2986 then the current rule is fired (i.e. AND condition).
2988 You can refer matched substring of @var{regexp} to specify @var{target} part.
2989 To refer substring, use following keys:
2991 @table @samp
2992 @item \&
2993 means substitute original matched text.
2995 @item \@var{N}
2996 means substitute what matched the @var{N}th `\(@dots{}\)'.
2997 (@var{N} is a number.)
2998 @end table
3000 Following is an example of @code{wl-refile-rule-alist}.
3002 @lisp
3003 @group
3004 (setq wl-refile-rule-alist
3005       '(("x-ml-name"
3006          ("^Wanderlust" . "+wl")
3007          ("^Elisp" . "+elisp"))
3008         (("To" "Cc")
3009          ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
3010         ("From"
3011          ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
3012                                     "+from-me-to-you"))))))
3013 @end group
3014 @end lisp
3016 After these settings, refile marks are automatically put on the condition
3017 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
3019 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
3020 auto refiling.
3021 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
3022 with these persistent marks are not automatically refiled.
3023 It means Wanderlust does not execute auto refile on unread messages by
3024 the default setting.
3025 To execute auto refile on all messages, set following.
3027 @lisp
3028 (setq wl-summary-auto-refile-skip-marks nil)
3029 @end lisp
3032 @node Sticky Summary, Summary View, Auto Refile, Summary
3033 @section Sticky Summary
3034 @cindex Summary, Sticky
3035 @cindex Sticky Summary
3037 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
3039 By entering the summary by typing @kbd{Shift RET} in Folder mode or
3040 @kbd{G} in some suummary sticky summary buffer is created.
3041 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
3042 makes current one sticky.
3044 The buffer name of the sticky summary becomes like
3045 @samp{Summary:@var{folder-name}}.
3046 You can visit the sticky summary at any time by @kbd{C-x b}
3047 (@code{switch-to-buffer}), or you can go round summary buffers by
3048 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
3049 (@code{wl-summary-next-buffer}) in summary mode.
3051 In sticky summary, the summary buffer is preserved after @kbd{g} or
3052 @kbd{q}.  To delete sticky summary, type @kbd{C-u q} to exit or move to
3053 another summary by @kbd{C-u g}. Other operations in the sticky summary
3054 are same as normal summary.
3056 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3057 are automatically stuck.
3060 @node Summary View, Mark and Action, Sticky Summary, Summary
3061 @section Format of summary lines
3062 @cindex Format of summary lines
3063 You can alter the format of lines in Summary mode.
3065 Summary line format is specified by @code{wl-summary-line-format}.
3066 You can use control strings defined by
3067 @code{wl-summary-line-format-spec-alist}.
3069 An example follows.
3071 @lisp
3072 @group
3073 ;; @r{number temporary-mark persistent-mark date branch}
3074 ;; @r{[ (number-of-children) sender ] subject}
3075 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
3076 @end group
3077 @end lisp
3079 Where the number set the column number of the field. If negative value,
3080 the column is filled from right. If the number begins with @samp{0},
3081 @samp{0} is used for filling columns instead of @samp{ }.
3083 Example:
3085 @example
3086 @group
3087 %5n   -> `1    '
3088 %-05n -> `00001'
3089 @end group
3090 @end example
3093 Major control strings defined by @code{wl-summary-line-format-spec-alist}
3094 are displayed in the following list.
3096 @example
3097 @group
3098 %n  message number
3099 %T  temporary mark
3100 %P  persistent mark
3101 %Y  year
3102 %M  month
3103 %D  day
3104 %W  day of week
3105 %h  hour
3106 %m  minute
3107 %t  branch of the thread
3108 %[  [ (< for re-connected child)
3109 %]  ] (> for re-connected child)
3110 %f  sender
3111 %s  subject
3112 %S  size
3113 %c  +number-of-children: (display only for opened thread)
3114 %C  [+number-of-children] (display only for opened thread)
3115 %#  mailing list information (`(' ML-name [ ` ' ML-number ] `)')
3116 %l  number in the mailing list
3117 %@@ `@@' only if the first MIME part is multipart/mixed
3118 %~  ` ' only if previous column is not empty
3119 @end group
3120 @end example
3122 The temporary mark (@samp{%T}) and persistent mark (@samp{%P}) must
3123 appear at the constant column. For example, if you specify @samp{%T} or
3124 @samp{%P} after the @samp{%t}, which changes its length by thread
3125 position, marks are not treated correctly.
3127 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
3128 column of the enclosed region is justified to the `number'. Multiple
3129 level @samp{%number(} parenthesis can be defined.  It is useful to
3130 justify the column of the multiple control strings.  For example, in the
3131 above @code{wl-summary-line-format},
3133 @example
3134 %17(%c %f%)
3135 @end example
3137 means ``Adjust number-of-children and sender string to the 17 column''.
3139 You can specify the format by each folders with
3140 @code{wl-folder-summary-line-format-alist}.  Please set regular
3141 expression for folder names and summary line format as the following
3142 example.
3144 @lisp
3145 @group
3146 (setq wl-folder-summary-line-format-alist
3147       '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
3148         ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
3149 @end group
3150 @end lisp
3152 @subsection on the format for sender name
3154 The format string @samp{%f} displays the return value of the function specified
3155 by @code{wl-summary-from-function}. If you use the function
3156 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
3157 while displays the recipient names if the folder name matches with
3158 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
3159 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
3161 For example, to display recipient names for the message in @samp{+backup} if
3162 its sender is yourself, set up as follows.
3164 @lisp
3165 (setq wl-summary-showto-folder-regexp "^\\+backup$")
3166 @end lisp
3169 @node Mark and Action, Key Bindings of Summary, Summary View, Summary
3170 @section Temporary marks and their effect
3171 @cindex Mark and Action
3173 You can define temporary marks and corresponding procedure by
3174 @code{wl-summary-mark-action-list}.  Initially, refile (@samp{o}), copy
3175 (@samp{O}), dispose (@samp{d}), delete (@samp{D}), prefetch (@samp{i})
3176 and resend (@samp{~}) are defined.
3178 Each element of @code{wl-summary-mark-action-list} consists of
3180 @example
3181 (@samp{MARK} @samp{SYMBOL}
3182  @samp{ARGUMENT-FUNCTION} @samp{SET-MARK-FUNCTION} @samp{EXEC-FUNCTION}
3183  @samp{FACE} @samp{DOC-STRING})
3184 @end example
3186 @samp{MARK} is a temporary mark string, and @samp{SYMBOL} is the name of
3187 the action to be defined.  @samp{ARGUMENT-FUNCTION} is a function to
3188 generate argument to be given to @samp{SET-MARK-FUNCTION}, which will be
3189 described next, and it takes arguments:
3191 @example
3192 (@samp{ACTION} @samp{NUMBER})
3193 @end example
3195 Where @samp{ACTION} equals to @samp{SYMBOL}, and @samp{NUMBER} is message
3196 number.  @samp{SET-MARK-FUNCTION} is a function to be called when the mark
3197 is put. It takes arguments:
3199 @example
3200 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3201 @end example
3203 Where @samp{NUMBER} is target message number, @samp{MARK} is a temporary
3204 mark string, and @samp{DATA} is given by @samp{ARGUMENT-FUNCTION}.
3206 @samp{EXEC-FUNCTION} is a function to be called when the action is
3207 executed. Its argument is a list of @samp{MARK-INFO}.  Here @samp{MARK-INFO}
3208 means a list consists of
3210 @example
3211 (@samp{NUMBER} @samp{MARK} @samp{DATA})
3212 @end example
3214 @samp{FACE} is a face to be used for highlighting.
3217 @node Key Bindings of Summary, Variables of Summary, Mark and Action, Summary
3218 @section Key bindings
3219 @cindex Keybind, Summary Mode
3220 @cindex Keybind, Summary Buffer
3222 Key bindings of the summary mode are shown below.
3224 @table @kbd
3225 @item @key{SPC}
3226 @kindex @key{SPC} (Summary)
3227 @findex wl-summary-read
3228 Proceed reading a message at the current cursor point.
3229 (@code{wl-summary-read})
3231 @item .
3232 @kindex . (Summary)
3233 @findex wl-summary-redisplay
3234 Redisplay a message at the current cursor point with default display
3235 type.  If this command is called with prefix argument, reload and redisplay
3236 message regardless of the message cache.
3237 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u .},
3238 reload and redisplay message with current display type regardless of the
3239 message cache.  (@code{wl-summary-redisplay})
3241 @item <
3242 @kindex < (Summary)
3243 @findex wl-summary-display-top
3244 Display the top message in the folder.
3245 (@code{wl-summary-display-top})
3247 @item >
3248 @kindex > (Summary)
3249 @findex wl-summary-display-bottom
3250 Display the bottom message in the folder.
3251 (@code{wl-summary-display-bottom})
3253 @item @key{BS}
3254 @itemx @key{DEL}
3255 @kindex @key{BS} (Summary)
3256 @kindex @key{DEL} (Summary)
3257 Display the previous page of the message at the current cursor point.
3258 @findex wl-summary-prev-page
3259 (@code{wl-summary-prev-page})
3261 @item @key{RET}
3262 @kindex @key{RET} (Summary)
3263 @findex wl-summary-enter-handler
3264 Display the next line of the message at the current cursor point.
3265 Display the message at the current cursor point if it is not displayed
3266 yet.  (@code{wl-summary-next-line-content}) If prefix argument is
3267 specified, message is scrolled up by one line.
3268 (@code{wl-summary-prev-line-content}) If prefix argument is numeric,
3269 cursor is jumped to the message with specified number.
3271 @item -
3272 @itemx M-@key{RET}
3273 @kindex - (Summary)
3274 @kindex M-@key{RET} (Summary)
3275 @findex wl-summary-prev-line-content
3276 Display the previous line of the message at the current cursor point.
3277 Display the message at the current cursor point if it is not displayed yet.
3278 (@code{wl-summary-prev-line-content})
3280 @item /
3281 @kindex / (Summary)
3282 @findex wl-thread-open-close
3283 Toggle open or close the thread at the current cursor point.
3284 With prefix argument, open all children threads.
3285 (@code{wl-thread-open-close})
3287 @item [
3288 @kindex [ (Summary)
3289 Open all threads.
3290 @findex wl-thread-open-all
3291 (@code{wl-thread-open-all})
3293 @item ]
3294 @kindex ] (Summary)
3295 Close all threads.
3296 @findex wl-thread-close-all
3297 (@code{wl-thread-close-all})
3299 @item g
3300 @kindex g (Summary)
3301 @findex wl-summary-goto-folder
3302 Go to other folder.
3303 (@code{wl-summary-goto-folder})
3305 @item c
3306 @kindex c (Summary)
3307 Mark all messages in the folder as read.
3308 @findex wl-summary-mark-as-read-all
3309 (@code{wl-summary-mark-as-read-all})
3311 @item a
3312 @kindex a (Summary)
3313 @findex wl-summary-reply
3314 Prepare a draft for reply the message at the current cursor point.
3315 (@code{wl-summary-reply})
3317 @item A
3318 @kindex A (Summary)
3319 @findex wl-summary-reply-with-citation
3320 Prepare a draft for reply the message at the current cursor point.
3321 (@code{wl-summary-reply-with-citation})
3323 @item C
3324 @kindex C (Summary)
3325 @findex wl-summary-cancel-message
3326 If the message at current cursor point is your own netnews article,
3327 cancel it.
3328 (@code{wl-summary-cancel-message})
3330 @item E
3331 @kindex E (Summary)
3332 @findex wl-summary-reedit
3333 Prepare a draft for re-editing the message at current cursor point.
3334 If the message at current cursor point is your own netnews article,
3335 a draft for `supersedes message' for the message is prepared.
3336 (@code{wl-summary-reedit})
3338 @item M-E
3339 @kindex M-E (Summary)
3340 @findex wl-summary-resend-bounced-mail
3341 If the message at current cursor point is a bounced message,
3342 a draft for re-sending original message is prepared.
3343 (@code{wl-summary-resend-bounced-mail})
3345 @item f
3346 @kindex f (Summary)
3347 @findex wl-summary-forward
3348 A draft for forwarding the message at current cursor point is prepared.
3349 (@code{wl-summary-forward})
3351 @item $
3352 @kindex $ (Summary)
3353 @findex wl-summary-mark-as-important
3354 Put @samp{important} flag on the message at current cursor point.
3355 If already flagged as @samp{important}, remove the flag.  If it is
3356 called with prefix argument, ask global flag to put similarly to @kbd{F}.
3357 (@code{wl-summary-mark-as-important})
3359 @item F
3360 @kindex F (Summary)
3361 @findex wl-summary-set-flags
3362 Put arbitrary global flag entered in the minibuffer.  If you use Emacs
3363 21 or later, you can specify multiple flags separated by @samp{,}
3364 simultaneously.  If it is called with prefix argument, remove existent
3365 global flags.
3366 (@code{wl-summary-set-flags})
3368 @item y
3369 @itemx e
3370 @kindex y (Summary)
3371 @kindex e (Summary)
3372 Save the message at current cursor point.
3373 @findex wl-summary-save
3374 (@code{wl-summary-save})
3376 @item n
3377 @kindex n (Summary)
3378 @findex wl-summary-next
3379 Move cursor to the next message.
3380 If message is marked with a temporal mark in
3381 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3382 In the offline mode, cursor is not moved to the messages which are not cached
3383 yet.
3384 (@code{wl-summary-next})
3386 @item p
3387 @kindex p (Summary)
3388 @findex wl-summary-prev
3389 Move cursor to the previous message.
3390 If message is marked with a temporal mark in
3391 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3392 In the offline mode, cursor is not moved to the messages which are not cached
3393 yet.
3394 (@code{wl-summary-prev})
3396 @item N
3397 @kindex N (Summary)
3398 @findex wl-summary-down
3399 Move cursor to the downward message which is unread or marked
3400 as @samp{$}.
3401 In the offline mode, cursor is not moved to the messages which are not cached
3402 yet.
3403 If there are messages which have target mark @samp{*} in the summary,
3404 cursor is moved to the downward message which have a target mark.
3405 This behavior is changed according to the value of @code{wl-summary-move-order}.
3406 (@code{wl-summary-down})
3408 @item P
3409 @kindex P (Summary)
3410 @findex wl-summary-up
3411 Move cursor to the upward message which is unread or marked
3412 as @samp{$}.
3413 In the offline mode, cursor is not moved to the messages which are not cached
3414 yet.
3415 If there are messages which have target mark @samp{*} in the summary,
3416 cursor is moved to the downward message which have a target mark.
3417 This behavior is changed according to the value of @code{wl-summary-move-order}.
3418 (@code{wl-summary-up})
3420 @item w
3421 @kindex w (Summary)
3422 @findex wl-summary-write
3423 Prepare a new draft.
3424 (@code{wl-summary-write})
3426 @item W
3427 @kindex W (Summary)
3428 @findex wl-summary-write-current-folder
3429 Prepare a new draft.  If the current folder is NNTP folder,
3430 @samp{Newsgroups:} field is completed.  If the current folder is mailing
3431 list folder (refile destination), guess @samp{To:} field and completed
3432 (If @code{wl-subscribed-mailing-list} is valid list)
3433 (@code{wl-summary-write-current-folder})
3435 @item H
3436 @kindex H (Summary)
3437 @findex wl-summary-toggle-all-header
3438 Toggle display type between all and partial header fields and redisplay
3439 the message at current cursor point.  If this command is called with
3440 prefix argument, reload and redisplay message regardless of the message cache.
3441 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u H},
3442 set default display type of summary by current display type of header fields.
3443 (@code{wl-summary-toggle-all-header})
3445 @item M
3446 @kindex M (Summary)
3447 @findex wl-summary-toggle-mime
3448 Toggle display type for MIME analysis and redisplay the message at
3449 current cursor point.  A change is performed in the order set as
3450 @code{wl-summary-display-mime-mode-list}.  If this command is called
3451 with numeric prefix argument, it switch directly as follows.
3453 @example
3454 @group
3455 1: Enable MIME analysis.
3456 2: Enable MIME analysis only for header fields.
3457 3: Disable MIME analysis.
3458 @end group
3459 @end example
3461 If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u
3462 M}, set default display type of summary by current display type of MIME
3463 analysis.  (@code{wl-summary-toggle-mime})
3465 @item C-c C-f
3466 @kindex C-c C-f (Summary)
3467 @findex wl-summary-toggle-header-narrowing
3468 Toggle header body narrowing of the message at current cursor point.
3469 (@code{wl-summary-toggle-header-narrowing})
3471 @item B
3472 @kindex B (Summary)
3473 @findex wl-summary-burst
3474 If the message at current cursor point has
3475 encapsulates multiple messages using MIME,
3476 de-capsulate and extract them on the current folder.
3477 If it is invoked in non-writable folder or it is called with prefix
3478 argument, it asks the destination folder.
3479 (@code{wl-summary-burst})
3481 @item @@
3482 @kindex @@ (Summary)
3483 @findex wl-summary-edit-addresses
3484 Append/change/delete the message's sender information to the address
3485 book @file{~/.addresses} interactively.  If this command is called with
3486 prefix argument, arbitrary address can be edited.
3487 (@code{wl-summary-edit-petname})
3489 @item Z
3490 @kindex Z (Summary)
3491 @findex wl-status-update
3492 Sync up address book status with @file{~/.addresses}'s content.
3493 (@code{wl-status-update})
3495 @item |
3496 @kindex | (Summary)
3497 @findex wl-summary-pipe-message
3498 Pipe current message's content to the external process.
3499 (@code{wl-summary-pipe-message})
3501 @item #
3502 @kindex # (Summary)
3503 @findex wl-summary-print-message
3504 Print out current message's content.
3505 It uses @code{ps-print} module in Emacs 20.x.
3506 If you don't use color printer, you might want to set
3507 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3509 @lisp
3510 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3511 @end lisp
3513 (@code{wl-summary-print-message})
3515 @item q
3516 @kindex q (Summary)
3517 @findex wl-summary-exit
3518 Exit current folder.
3519 (@code{wl-summary-exit})
3521 @item j
3522 @kindex j (Summary)
3523 @findex wl-summary-jump-to-current-message
3524 Jump cursor to the currently displayed message's window.
3525 (@code{wl-summary-jump-to-current-message})
3527 @item J
3528 @kindex J (Summary)
3529 Jump cursor to the other message.
3530 @findex wl-summary-jump-to-msg
3531 (@code{wl-summary-jump-to-msg})
3533 @item I
3534 @kindex I (Summary)
3535 Update summary status and
3536 prefetch all messages which have marks included in the
3537 @code{wl-summary-incorporate-marks}.
3538 @findex wl-summary-incorporate
3539 (@code{wl-summary-incorporate})
3541 @item M-j
3542 @kindex M-j (Summary)
3543 @findex wl-summary-jump-to-msg-by-message-id
3544 Jump cursor to the message which have specified @samp{Message-Id:}.  If
3545 @code{elmo-use-database} is non-nil, other folder is also searched.
3546 (@code{wl-summary-jump-to-msg-by-message-id})
3548 @item ^
3549 @kindex ^ (Summary)
3550 Jump to parent message.
3551 @findex wl-summary-jump-to-parent-message
3552 (@code{wl-summary-jump-to-parent-message})
3554 @item !
3555 @kindex ! (Summary)
3556 @findex wl-summary-mark-as-unread
3557 Mark as unread the message at current cursor point.
3558 (@code{wl-summary-mark-as-unread})
3560 @item s
3561 @kindex s (Summary)
3562 @findex wl-summary-sync
3563 Synchronize summary view after prompting the update range.
3564 You can specify one of the follows.
3566 @example
3567 @group
3568 all              Discard present msgdb and retrieve all informations.
3569                  Do not retrieve killed messages.
3570 all-entirely     Discard present msgdb and retrieve all informations.
3571                  Retrieve killed messages, too.
3572 update           Update the difference between informations in present
3573                  msgdb and in current folder instance.
3574                  Do not retrieve killed messages.
3575 update-entirely  Update the difference between informations in present
3576                  msgdb and in current folder instance.
3577                  Retrieve killed messages, too.
3578 rescan           Redisplay summary by rescanning present msgdb.
3579 rescan-noscore   Redisplay summary by rescanning present msgdb.
3580                  Display messages killed by score, too.
3581 rescan-thread    Redisplay summary by rescanning present msgdb.
3582                  Reconstruct thread, too.
3583 cache-status     Sync the all marks with the real status of cache.
3584 mark             Update marks.
3585 no-sync          Do nothing.
3586 first:NUM        Move to the filter folder(partial filter).
3587 last:NUM         Move to the filter folder(partial filter).
3588 @end group
3589 @end example
3591 @noindent
3592 (@code{wl-summary-sync})
3594 @item S
3595 @kindex S (Summary)
3596 @findex wl-summary-sort
3597 Sort summary order.
3598 You can sort by @samp{date}, @samp{from}, @samp{number}, @samp{subject},
3599 @samp{size} and @samp{list-info}.
3600 With prefix argument, sort summary lines into descending order.
3601 (@code{wl-summary-sort})
3603 @item T
3604 @kindex T (Summary)
3605 @findex wl-summary-toggle-thread
3606 Toggle the threading. The state will be preserved after exiting
3607 Wanderlust. You can alter default state for newly created summary
3608 by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
3609 Threading status is displayed on the modeline.
3610 @samp{@{S@}} means threading is off (Sequence) and
3611 @samp{@{T@}} means threading is on (Thread).
3612 (@code{wl-summary-toggle-thread})
3614 @item l
3615 @kindex l (Summary)
3616 @findex wl-summary-toggle-disp-folder
3617 Toggle displaying of folder window.
3618 (@code{wl-summary-toggle-disp-folder})
3620 @item v
3621 @kindex v (Summary)
3622 Toggle displaying of message window.
3623 @findex wl-summary-toggle-disp-msg
3624 (@code{wl-summary-toggle-disp-msg})
3626 @item V
3627 @kindex V (Summary)
3628 Move to the virtual folder (filter folder) with the condition specified.
3629 If called with prefix argument and current folder is virtual, exit it.
3630 @findex wl-summary-virtual
3631 (@code{wl-summary-virtual})
3633 @item @key{TAB}
3634 @kindex @key{TAB} (Summary)
3635 @findex wl-summary-goto-last-displayed-msg
3636 Jump to the message which is displayed last.
3637 (@code{wl-summary-goto-last-displayed-msg})
3639 @item ?
3640 @kindex ? (Summary)
3641 Put @samp{*} mark on the messages that satisfies the specified condition.
3642 If messages already have @samp{*} mark, new @samp{*} marks are overridden.
3643 If prefix argument is specified, current @samp{*} marks are removed and
3644 new @samp{*} marks are appended.
3646 @findex wl-summary-pick
3647 (@code{wl-summary-pick})
3649 @item R
3650 @kindex R (Summary)
3651 @findex wl-summary-mark-as-read
3652 Mark as read the message at the current cursor point.
3653 (@code{wl-summary-mark-as-read})
3655 @item x
3656 @kindex x (Summary)
3657 Execute action for all temporary marks in the summary buffer.
3658 @findex wl-summary-exec
3659 (@code{wl-summary-exec})
3661 @item *
3662 @kindex * (Summary)
3663 @findex wl-summary-target-mark-line
3664 Put target mark on the message at the current cursor point.
3665 (@code{wl-summary-target-mark-line}) @xref{Mark and Action}.
3667 @item o
3668 @kindex o (Summary)
3669 Put refile mark on the message at the current cursor point.
3670 @findex wl-summary-refile
3671 (@code{wl-summary-refile}) @xref{Mark and Action}.
3673 @item C-o
3674 @kindex C-o (Summary)
3675 Execute auto refile.
3676 @findex wl-summary-auto-refile
3677 (@code{wl-summary-auto-refile})
3679 @item O
3680 @kindex O (Summary)
3681 Put copy mark on the message at the current cursor point.
3682 @findex wl-summary-copy
3683 (@code{wl-summary-copy}) @xref{Mark and Action}.
3685 @item M-o
3686 @kindex M-o (Summary)
3687 Put refile mark on the message at the current cursor point with the destination
3688 previously specified.
3689 @findex wl-summary-refile-prev-destination
3690 (@code{wl-summary-refile-prev-destination})
3692 @item d
3693 @kindex d (Summary)
3694 @findex wl-summary-dispose
3695 Put disposal mark on the message at the current cursor point.
3696 The result of disposal is controlled by @code{wl-dispose-folder-alist},
3697 refiled to @code{wl-trash-folder} by default.
3698 (@code{wl-summary-dispose}) @xref{Mark and Action}.
3700 @item D
3701 @kindex D (Summary)
3702 @findex wl-summary-delete
3703 Put force deletion mark on the message at the current cursor point.
3704 (@code{wl-summary-delete}) @xref{Mark and Action}.
3706 @item i
3707 @kindex i (Summary)
3708 Put prefetch reservation mark on the message at the current cursor point.
3709 @findex wl-summary-prefetch
3710 (@code{wl-summary-prefetch}) @xref{Mark and Action}.
3712 @item ~
3713 @kindex ~ (Summary)
3714 @findex wl-summary-resend
3715 Put resend reservation mark on the message at the current cursor point.
3716 (@code{wl-summary-resend}) @xref{Mark and Action}.
3718 @item u
3719 @kindex u (Summary)
3720 @findex wl-summary-unmark
3721 Unmark the temporal mark on the message at the current cursor point.
3722 (@code{wl-summary-unmark})
3724 @item U
3725 @kindex U (Summary)
3726 Unmark all the temporal marks.
3727 @findex wl-summary-unmark-all
3728 (@code{wl-summary-unmark-all})
3730 @item r R
3731 @kindex r R (Summary)
3732 @findex wl-summary-mark-as-read-region
3733 Mark as read messages in the specified region.
3734 (@code{wl-summary-mark-as-read-region})
3736 @item r $
3737 @kindex r $ (Summary)
3738 @findex wl-summary-mark-as-important-region
3739 Put @samp{important} flag on messages in the specified region.
3740 If already flagged as @samp{important}, remove the flag.
3741 (@code{wl-summary-mark-as-important-region})
3743 @item r F
3744 @kindex r F (Summary)
3745 @findex wl-summary-set-flags-region
3746 Put arbitrary global flag entered in the minibuffer on messages in
3747 specified region.
3748 (@code{wl-summary-set-flags-region})
3750 @item r !
3751 @kindex r ! (Summary)
3752 @findex wl-summary-mark-as-unread-region
3753 Mark as unread messages in the specified region.
3754 (@code{wl-summary-mark-as-unread-region})
3756 @item r x
3757 @kindex r x (Summary)
3758 @findex wl-summary-exec-region
3759 Execute action for each temporary marks on the messages in the
3760 specified region.
3761 (@code{wl-summary-exec-region})
3763 @item r *
3764 @kindex r * (Summary)
3765 @findex wl-summary-target-mark-region
3766 Put target mark on the messages in the specified region.
3767 (@code{wl-summary-target-mark-region}) @xref{Mark and Action}.
3769 @item r o
3770 @kindex r o (Summary)
3771 @findex wl-summary-refile-region
3772 Put refile mark on the messages in the specified region.
3773 (@code{wl-summary-refile-region}) @xref{Mark and Action}.
3775 @item r O
3776 @kindex r O (Summary)
3777 @findex wl-summary-copy-region
3778 Put copy mark on the messages in the specified region.
3779 (@code{wl-summary-copy-region}) @xref{Mark and Action}.
3781 @item r d
3782 @kindex r d (Summary)
3783 @findex wl-summary-dispose-region
3784 Put disposal mark on the messages in the specified region.
3785 (@code{wl-summary-dispose-region}) @xref{Mark and Action}.
3787 @item r D
3788 @kindex r D (Summary)
3789 @findex wl-summary-delete-region
3790 Put force deletion mark on the messages in the specified region.
3791 (@code{wl-summary-delete-region}) @xref{Mark and Action}.
3793 @item r i
3794 @kindex r i (Summary)
3795 @findex wl-summary-prefetch-region
3796 Put prefetch reservation mark on messages in the specified region.
3797 (@code{wl-summary-prefetch-region}) @xref{Mark and Action}.
3799 @item r u
3800 @kindex r u (Summary)
3801 @findex wl-summary-unmark-region
3802 Delete temporal mark on the messages in the specified region.
3803 (@code{wl-summary-unmark-region})
3805 @item r y
3806 @kindex r y (Summary)
3807 Save messages in the specified region.
3808 @findex wl-summary-save-region
3809 (@code{wl-summary-save-region})
3811 @item t R
3812 @kindex t R (Summary)
3813 @findex wl-thread-mark-as-read
3814 Mark as read messages which are the descendant of the current thread.
3815 With prefix argument, it affects on the all messages in the thread tree.
3816 (@code{wl-thread-mark-as-read})
3818 @item t $
3819 @kindex t $ (Summary)
3820 @findex wl-thread-mark-as-important
3821 Put @samp{important} flag on the messages which are the descendant of
3822 the current thread.  If already flagged as @samp{important}, remove the
3823 flag.  With prefix argument, it affects on the all messages in the
3824 thread tree.
3825 (@code{wl-thread-mark-as-important})
3827 @item t F
3828 @kindex t F (Summary)
3829 @findex wl-thread-set-flags
3830 Put arbitrary global flag entered in the minibuffer on the messages
3831 which are the descendant of the current thread.  With prefix argument,
3832 it affects on the all messages in the thread tree.
3833 (@code{wl-thread-set-flags})
3835 @item t !
3836 @kindex t ! (Summary)
3837 @findex wl-thread-mark-as-unread
3838 Mark as unread messages which are the descendant of the current thread.
3839 With prefix argument, it affects on the all messages in the thread tree.
3840 (@code{wl-thread-mark-as-unread})
3842 @item t x
3843 @kindex t x (Summary)
3844 @findex wl-thread-exec
3845 Execute action for temporary marks on the messages which are
3846 the descendant of the current thread.  With prefix argument, it affects
3847 on the all messages in the thread tree.
3848 (@code{wl-thread-exec})
3850 @item t *
3851 @kindex t * (Summary)
3852 @findex wl-thread-target-mark
3853 Put target mark @samp{*} on the messages which are the descendant of the
3854 current thread.  With prefix argument, it affects on the all messages in
3855 the thread tree.
3856 (@code{wl-thread-target-mark}) @xref{Mark and Action}.
3858 @item t o
3859 @kindex t o (Summary)
3860 @findex wl-thread-refile
3861 Put refile mark on the messages which are the descendant of the current thread.
3862 With prefix argument, it affects on the all messages in the thread tree.
3863 (@code{wl-thread-refile}) @xref{Mark and Action}.
3865 @item t O
3866 @kindex t O (Summary)
3867 @findex wl-thread-copy
3868 Put copy mark on the messages which are the descendant of the current thread.
3869 With prefix argument, it affects on the all messages in the thread tree.
3870 (@code{wl-thread-copy}) @xref{Mark and Action}.
3872 @item t d
3873 @kindex t d (Summary)
3874 @findex wl-thread-dispose
3875 Put disposal mark on the messages which are the descendant of the current thread.
3876 With prefix argument, it affects on the all messages in the thread tree.
3877 (@code{wl-thread-dispose}) @xref{Mark and Action}.
3879 @item t D
3880 @kindex t D (Summary)
3881 @findex wl-thread-delete
3882 Put force deletion mark on the messages which are the descendant of the
3883 current thread.
3884 (@code{wl-thread-delete}) @xref{Mark and Action}.
3886 @item t i
3887 @kindex t i (Summary)
3888 @findex wl-thread-prefetch
3889 Put prefetch reservation mark on messages which are the descendant of
3890 the current thread.
3891 (@code{wl-thread-prefetch}) @xref{Mark and Action}.
3893 @item t u
3894 @kindex t u (Summary)
3895 @findex wl-thread-unmark
3896 Unmark temporal mark on the messages which are the descendant of the
3897 current thread. With prefix argument, it affects on the all messages in
3898 the thread tree.
3899 (@code{wl-thread-unmark})
3901 @item t y
3902 @kindex t y (Summary)
3903 @findex wl-thread-save
3904 Save messages which are the descendant of the current thread.
3905 With prefix argument, it affects on the all messages in the thread tree.
3906 (@code{wl-thread-save})
3908 @item m R
3909 @kindex m R (Summary)
3910 @findex wl-summary-target-mark-mark-as-read
3911 Mark as read all messages which have target mark @samp{*}.
3912 (@code{wl-summary-target-mark-mark-as-read})
3914 @item m $
3915 @kindex m $ (Summary)
3916 @findex wl-summary-target-mark-mark-as-important
3917 Put @samp{important} flag on all messages which have target mark @samp{*}.
3918 If already flagged as @samp{important}, remove the flag.
3919 (@code{wl-summary-target-mark-mark-as-important})
3921 @item m F
3922 @kindex m F (Summary)
3923 @findex wl-summary-target-mark-set-flags
3924 Put arbitrary global flag entered in the minibuffer on all messages
3925 which have target mark @samp{*}.
3926 (@code{wl-summary-target-mark-set-flags})
3928 @item m !
3929 @kindex m ! (Summary)
3930 @findex wl-summary-target-mark-mark-as-unread
3931 Mark as unread all messages which have target mark @samp{*}.
3932 (@code{wl-summary-target-mark-mark-as-unread})
3934 @item m o
3935 @kindex m o (Summary)
3936 @findex wl-summary-target-mark-refile
3937 Put refile mark on the messages which have target mark @samp{*}.
3938 (@code{wl-summary-target-mark-refile}) @xref{Mark and Action}.
3940 @item m O
3941 @kindex m O (Summary)
3942 @findex wl-summary-target-mark-copy
3943 Put copy mark on the messages which have target mark @samp{*}.
3944 (@code{wl-summary-target-mark-copy}) @xref{Mark and Action}.
3946 @item m d
3947 @kindex m d (Summary)
3948 @findex wl-summary-target-mark-dispose
3949 Put disposal mark on the messages which have target mark @samp{*}.
3950 (@code{wl-summary-target-mark-dispose}) @xref{Mark and Action}.
3952 @item m D
3953 @kindex m D (Summary)
3954 @findex wl-summary-target-mark-delete
3955 Put force deletion mark on the messages which have target mark @samp{*}.
3956 (@code{wl-summary-target-mark-delete}) @xref{Mark and Action}.
3958 @item m i
3959 @kindex m i (Summary)
3960 @findex wl-summary-target-mark-prefetch
3961 Put prefetch reservation mark on messages which have target mark @samp{*}.
3962 (@code{wl-summary-target-mark-prefetch}) @xref{Mark and Action}.
3964 @item m y
3965 @kindex m y (Summary)
3966 @findex wl-summary-target-mark-save
3967 Save messages which have target mark @samp{*}.
3968 (@code{wl-summary-target-mark-save})
3970 @item m u
3971 @kindex m u (Summary)
3972 Unmark all temporal marks.
3973 (@code{wl-summary-delete-all-temp-marks})
3974 @findex wl-summary-delete-all-temp-marks
3976 @item m a
3977 @kindex m a (Summary)
3978 Put target mark @samp{*} on the all messages.
3979 (@code{wl-summary-target-mark-all})
3980 @findex wl-summary-target-mark-all
3982 @item m t
3983 @kindex m t (Summary)
3984 Put target mark @samp{*} on the messages in the current thread.
3985 @findex wl-summary-target-mark-thread
3986 (@code{wl-summary-target-mark-thread})
3988 @item m r
3989 @kindex m r (Summary)
3990 @findex wl-summary-target-mark-region
3991 Put target mark @samp{*} on the messages in the specified region.
3992 (@code{wl-summary-target-mark-region})
3994 @item m A
3995 @kindex m A (Summary)
3996 @findex wl-summary-target-mark-reply-with-citation
3997 Prepare a draft which cites all messages which have target mark @samp{*}.
3998 (@code{wl-summary-target-mark-reply-with-citation})
4000 @item m f
4001 @kindex m f (Summary)
4002 @findex wl-summary-target-mark-forward
4003 Prepare a draft which forwards all messages which have target mark @samp{*}.
4004 (@code{wl-summary-target-mark-forward})
4006 @item m U
4007 @kindex m U (Summary)
4008 @findex wl-summary-target-mark-uudecode
4009 Uudecode the messages which have target mark @samp{*}.
4010 (@code{wl-summary-target-mark-uudecode})
4012 @item m ?
4013 @kindex m ? (Summary)
4014 @findex wl-summary-target-mark-pick
4015 Pick messages from the @samp{*} marked messages.
4016 That is, @samp{*} marks on the messages are remained
4017 if the specified condition is satisfied.
4018 (@code{wl-summary-target-mark-pick})
4020 @item m #
4021 @kindex m # (Summary)
4022 @findex wl-summary-target-mark-print
4023 Print out all messages which have target mark @samp{*}.
4024 (@code{wl-summary-target-mark-print})
4026 @item m |
4027 @kindex m | (Summary)
4028 @findex wl-summary-target-mark-pipe
4029 Pipe content of each message with target mark @samp{*} to some specified
4030 external process.
4031 (@code{wl-summary-target-mark-pipe})
4033 @item M-t
4034 @kindex M-t (Summary)
4035 @findex wl-toggle-plugged
4036 Toggle offline/online status of Wanderlust.
4037 (@code{wl-toggle-plugged})
4039 @item C-t
4040 @kindex C-t (Summary)
4041 Start Wanderlust's plug-status manager.
4042 (@code{wl-plugged-change})
4044 @item C-c C-o
4045 @kindex C-c C-o (Summary)
4046 @findex wl-jump-to-draft-buffer
4047 Move to the draft buffer if available.  If multiple draft buffer exists,
4048 moved to one after another.  If prefix argument is specified, load draft
4049 folder's message to the draft buffer and jump to it.
4050 (@code{wl-jump-to-draft-buffer})
4052 @item M-w
4053 @kindex M-w (Summary)
4054 @findex wl-summary-save-current-message
4055 Save the message at the current cursor point.
4056 (@code{wl-summary-save-current-message})
4058 @item C-y
4059 @kindex C-y (Summary)
4060 @findex wl-summary-yank-saved-message
4061 Regard the message at the current cursor point as
4062 parent, connect the message saved by
4063 @code{wl-summary-save-current-message}
4064 to the thread.
4065 (@code{wl-summary-yank-saved-message})
4067 @item C-x C-s
4068 @kindex C-x C-s (Summary)
4069 @findex wl-summary-save-status
4070 Save the current summary.
4071 (@code{wl-summary-save-status})
4072 @end table
4075 @node Variables of Summary,  , Key Bindings of Summary, Summary
4076 @section Customiziable variables
4078 @table @code
4079 @item wl-summary-move-order
4080 @vindex wl-summary-move-order
4081 The initial setting is @code{unread}.  Specify cursor moving policy.  If
4082 you want to precede new messages, set @code{new}.  If you want to
4083 precede unread messages, set @code{unread}.  If @code{nil}, proceed to
4084 next message.
4086 @item wl-auto-select-first
4087 @vindex wl-auto-select-first
4088 The initial setting is @code{nil}.
4089 If non-nil, first message is automatically displayed when you enter
4090 the folder.
4092 @item wl-auto-select-next
4093 @vindex wl-auto-select-next
4094 The initial setting is @code{nil}. This controls behavior when there is
4095 no unread message in current summary.
4097 @example
4098 nil: asks whether you want to go back to folder mode
4099 'unread: asks whether you want to go to next unread folder
4100   If the next one comes to be possessing no unread message
4101   by treatment of cross-posted messages or Scoring, then
4102   asks whether you want to go to next to next folder.
4103 'skip-no-unread: similar as unread
4104   But does not ask before going to next to next folder.
4105 otherwise: asks whether you want to go to next unread folder
4106 @end example
4108 It might be useful to set @code{'skip-no-unread} for people who
4109 want to continue reading by just pressing and pressing space key.
4111 @item wl-thread-insert-opened
4112 @vindex wl-thread-insert-opened
4113 The initial setting is @code{nil}.
4114 If non-nil, thread is inserted as opened.
4116 @item wl-thread-open-reading-thread
4117 @vindex wl-thread-open-reading-thread
4118 The initial setting is @code{t}.  If non-nil, reading thread is
4119 automatically opened though it is closed thread.
4121 @item wl-summary-exit-next-move
4122 @vindex wl-summary-exit-next-move
4123 The initial setting is @code{t}.  If non-nil, move to next folder at
4124 summary exit.
4126 @item wl-folder-move-cur-folder
4127 @vindex wl-folder-move-cur-folder
4128 The initial setting is @code{nil}.  If non-nil, cursor position on the
4129 folder is moved.
4131 @item wl-summary-weekday-name-lang
4132 @vindex  wl-summary-weekday-name-lang
4133 Specify language of the weekday.
4134 @samp{en} displays English, @samp{fr} displays French, @samp{de}
4135 displays Deutsch. You should rescan summary view after changing this value.
4137 @item wl-summary-fix-timezone
4138 @vindex wl-summary-fix-timezone
4139 The initial setting is @code{nil}.
4140 Time zone of the date string in summary mode is adjusted using this value.
4141 If @code{nil}, it is adjust to the default time zone information
4142 (system's default time zone or environment variable @samp{TZ}).
4144 @item wl-use-petname
4145 @vindex  wl-use-petname
4146 The initial setting is @code{t}.
4147 If non-nil, sender part displays nickname.
4149 @item wl-break-pages
4150 @vindex  wl-break-pages
4151 The initial setting is @code{t}.
4152 If non-nil, message is split as pages by @samp{^L}.
4154 @item wl-summary-from-function
4155 @vindex wl-summary-from-function
4156 Format function to display sender in summary.
4157 The initial setting is @code{wl-summary-default-from}.
4159 @item wl-summary-no-from-message
4160 @vindex  wl-summary-no-from-message
4161 The initial setting is @samp{nobody@@nowhere?}.  A string which is
4162 displayed when there's no @samp{From:} field in the message.
4164 @item wl-summary-subject-function
4165 @vindex wl-summary-subject-function
4166 Format function to display subject in summary.
4167 The initial setting is @code{wl-summary-default-subject} and
4168 it will cut the list name part etc. on the top of the subject.
4169 To display subject as it is, set as follows.
4171 @lisp
4172 (setq wl-summary-subject-function 'identity)
4173 @end lisp
4175 @item wl-summary-no-subject-message
4176 @vindex  wl-summary-no-subject-message
4177 The initial setting is @samp{(WL:No Subject in original.)}.  A string
4178 which is displayed when there's no @samp{Subject:} field in the message.
4180 @item wl-summary-default-view
4181 @vindex wl-summary-default-view
4182 The initial setting is @code{'thread}.
4183 The default state for newly created summary. You can set either
4184 @code{'thread} for thread view or @code{'sequence} for sequential view.
4186 @item wl-summary-use-frame
4187 @vindex wl-summary-use-frame
4188 The initial setting is @code{nil}.
4189 If non-nil, use new frame for the summary.
4191 @item wl-use-folder-petname
4192 @vindex  wl-use-folder-petname
4193 The initial setting is the list shown below:
4195 @lisp
4196 @group
4197 (modeline)
4198 @end group
4199 @end lisp
4201 @noindent
4202 A list of display policy (symbol) of folder nickname.  Available symbols
4203 are:
4205 @table @code
4206 @item modeline
4207 Display folder petname on modeline.
4208 @item ask-folder
4209 Destination folder is notified as nickname if
4210 @code{wl-auto-select-next} is non-nil.
4211 @item read-folder
4212 You can input folder name by nickname in the function
4213 @code{wl-summary-read-folder}.
4214 @end table
4216 @item wl-summary-move-direction-toggle
4217 @vindex  wl-summary-move-direction-toggle
4218 The initial setting is @code{t}.  If non-nil, last executed @kbd{p},
4219 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move.  If you
4220 want to aware of reading direction, set this to @code{t}.
4222 @item wl-summary-width
4223 @vindex  wl-summary-width
4224 The initial setting is 80.
4225 Width of summary line. If @code{nil}, summary line's width is as is.
4227 @item wl-summary-print-argument-within-window
4228 @vindex wl-summary-print-argument-within-window
4229 The initial setting is @code{nil}.
4230 If non-nil, the action argument is always printed on right side of
4231 window.
4233 @item wl-summary-indent-length-limit
4234 @vindex  wl-summary-indent-length-limit
4235 The initial setting is 46.
4236 Specify the limit of thread indent level. @code{nil} means unlimited
4237 indent level.
4238 If you set this to @code{nil} you should set @code{wl-summary-width}
4239 to @code{nil}, too.
4241 @item wl-summary-max-thread-depth
4242 @vindex wl-summary-max-thread-depth
4243 The initial setting is 15.
4244 If thread depth of the message is larger than this value,
4245 the thread is divided.
4247 @item wl-summary-recenter
4248 @vindex  wl-summary-recenter
4249 The initial setting is t.
4250 If non-nil, cursor point is moved to the center of the summary window.
4252 @item wl-summary-max-thread-depth
4253 @vindex wl-summary-max-thread-depth
4254 The initial setting is 30.
4255 If thread depth is larger than this value, divide it.
4257 @item wl-summary-divide-thread-when-subject-changed
4258 @vindex wl-summary-divide-thread-when-subject-changed
4259 The initial setting is @code{nil}.  If non-nil, thread is split if
4260 the subject is changed.
4262 @item wl-summary-search-via-nntp
4263 @vindex wl-summary-search-via-nntp
4264 The initial setting is @code{confirm}.
4266 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
4267 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
4268 from the NNTP server @code{elmo-nntp-default-server}.  The value of
4269 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
4270 @code{elmo-nntp-default-stream-type} are used.
4272 If @code{confirm}, server name can be specified. You can specify NNTP
4273 folder format like @samp{-:username@@servername:119!}.
4275 @item wl-summary-keep-cursor-command
4276 @vindex wl-summary-keep-cursor-command
4277 The initial setting is the list shown below:
4279 @lisp
4280 @group
4281 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
4282 @end group
4283 @end lisp
4285 @noindent
4286 When you entered to summary by these commands and the target summary
4287 buffer already exists, summary status is not automatically updated and
4288 cursor position is saved.
4290 @item elmo-folder-update-threshold
4291 @vindex elmo-folder-update-threshold
4292 The initial setting is 500.  If updated message number is larger than
4293 this value, confirm whether drop them or not (in the case where the value
4294 of @code{elmo-folder-update-confirm} is non-nil).
4296 @item elmo-folder-update-confirm
4297 @vindex elmo-folder-update-confirm
4298 The initial setting is @code{t}. If the value is non-nil, do check with
4299 @code{elmo-folder-update-threshold}.
4301 @item wl-summary-always-sticky-folder-list
4302 @vindex wl-summary-always-sticky-folder-list
4303 The initial setting is @code{nil}.
4304 @code{wl-summary-always-sticky-folder-list} specifies the folders that
4305 are automatically stuck. Each element is regexp of folder name.
4307 @item wl-summary-reserve-mark-list
4308 @vindex wl-summary-reserve-mark-list
4309 The initial setting is the list shown below:
4311 @lisp
4312 @group
4313 ("o" "O" "D" "d" "i")
4314 @end group
4315 @end lisp
4317 @noindent
4318 If a message is already marked as temporal marks in this list, the
4319 message is not marked by any mark command.
4321 @item wl-summary-skip-mark-list
4322 @vindex wl-summary-skip-mark-list
4323 The initial setting is the list shown below:
4325 @lisp
4326 @group
4327 ("D" "d")
4328 @end group
4329 @end lisp
4331 @noindent
4332 If a message is already marked as temporal marks in this list, the
4333 message is skipped at cursor move.
4335 @item elmo-message-fetch-threshold
4336 @vindex elmo-message-fetch-threshold
4337 The initial setting is 30000 (bytes).  If displaying message has larger
4338 size than this value, Wanderlust confirms whether fetch the message or
4339 not (in the case where the value of @code{elmo-message-fetch-confirm}
4340 is non-nil).
4342 @item elmo-message-fetch-confirm
4343 @vindex elmo-message-fetch-confirm
4344 The initial setting is @code{t}. If the value is non-nil, do check with
4345 @code{elmo-message-fetch-threshold}.
4347 @item wl-prefetch-threshold
4348 @vindex wl-prefetch-threshold
4349 The initial setting is 30000 (bytes). If prefetching message has larger
4350 size than this value and @code{wl-prefetch-confirm} is non-nil,
4351 Wanderlust confirms whether prefetch the message or not.  If
4352 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
4353 without confirmation.
4355 @item wl-prefetch-confirm
4356 @vindex wl-prefetch-confirm
4357 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
4358 prefetch the message or not if the message has larger size than
4359 @code{wl-prefetch-threshold}.
4361 @item elmo-imap4-use-cache
4362 @vindex elmo-imap4-use-cache
4363 The initial setting is @code{t}.  If non-nil, messages read via IMAP4
4364 are cached.
4366 @item elmo-nntp-use-cache
4367 @vindex elmo-nntp-use-cache
4368 The initial setting is @code{t}.  If non-nil, messages read via NNTP are
4369 cached.
4371 @item elmo-pop3-use-cache
4372 @vindex elmo-pop3-use-cache
4373 The initial setting is @code{t}.  If non-nil, messages read via POP3 are
4374 cached.
4376 @item elmo-shimbun-use-cache
4377 @vindex elmo-shimbun-use-cache
4378 The initial setting is @code{t}.  If non-nil, messages read in Shimbun
4379 folders are cached.
4381 @item wl-summary-resend-use-cache
4382 @vindex wl-summary-resend-use-cache
4383 The initial setting is @code{nil}¡£If non-nil, messages are resend
4384 using cache even in the offline status. Note that if you use cache,
4385 the message identity is not guaranteed.
4387 @item wl-folder-process-duplicates-alist
4388 @vindex wl-folder-process-duplicates-alist
4389 The initial setting is @code{nil}.
4390 This list determines how to deal with duplicated messages in the same folder.
4391 Each item in the list is regexp of folder name and action; you can specify any
4392 one of the following in the place of action:
4394 @example
4395 @code{nil} : do nothing for duplicated messages.
4396 @code{hide} : hide duplicated messages from the summary.
4397 @code{read} : set duplicated messages as read.
4398 @end example
4400 @noindent
4401 Following is an example (hide duplicated messages in multi folders)
4403 @lisp
4404 @group
4405 (setq wl-folder-process-duplicates-alist
4406                  '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4407                    ("^\\*.*" . hide) (".*" . read)))
4408 @end group
4409 @end lisp
4411 @item wl-summary-flag-alist
4412 @vindex wl-summary-flag-alist
4413 The initial setting is as follows:
4415 @lisp
4416 @group
4417 ((important "orange"))
4418 @end group
4419 @end lisp
4421 Specify the color and the mark of message in summary buffer with flag.
4422 If the mark are omitted, the mark specified in the variable
4423 @code{wl-summary-flag-mark} is assumed.  If multiple global flags are on
4424 one message, the former flag in this list is preferred.
4426 Example:
4428 @lisp
4429 @group
4430 (setq wl-summary-flag-alist
4431       '((important "purple")
4432         (todo "red")
4433         (business "green" "B")
4434         (private "blue" "X")))
4435 @end group
4436 @end lisp
4438 @item wl-summary-display-mime-mode-list
4439 @vindex wl-summary-display-mime-mode-list
4440 The initial setting is the list shown below:
4442 @lisp
4443 @group
4444 (mime as-is)
4445 @end group
4446 @end lisp
4448 @noindent
4449 The function @code{wl-summary-toggle-mime} switch specification of MIME
4450 analysis in the order of this list. You can specify one of the follows.
4452 @example
4453 @code{mime}        : Header and body are decoded.
4454 @code{header-only} : Only header is decoded.
4455 @code{as-is}       : Header and body are not decoded.
4456 @end example
4457 @end table
4460 @node Message, Draft, Summary, Top
4461 @chapter Message Buffer
4463 Message Buffers utilize MIME-View mode of SEMI.  For operational
4464 procedures and key bindings, refer to respective documents.
4465 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4466 You can also see help by @kbd{?} in message buffer.
4468 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4469 brings you back to Summary mode.  @kbd{l} toggles display of Summary
4470 mode buffer.
4472 @section Key Bindings
4474 @table @kbd
4476 @item l
4477 @kindex l (Message)
4478 @findex wl-message-toggle-disp-summary
4479 Toggles display of Summary buffer.
4480 (@code{wl-message-toggle-disp-summary})
4482 @item Button-2
4483 @findex wl-message-refer-article-or-url
4484 @kindex Button-2 (Message)
4485 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4486 corresponding message if found.
4487 (@code{wl-message-refer-article-or-url})
4489 @item Button-4 (upward movement of a wheel)
4490 @kindex Button-4 (Message)
4491 @findex wl-message-wheel-down
4492 Scrolls the message backwards.  When the top of the message is hit,
4493 moves to the previous message.
4494 (@code{wl-message-wheel-down})
4496 @item Button-5 (downward movement of a wheel)
4497 @kindex Button-5 (Message)
4498 @findex wl-message-wheel-up
4499 Scrolls the message forward.  When the bottom of the message is hit,
4500 moves to the next message.
4501 (@code{wl-message-wheel-up})
4503 @item D
4504 @kindex D (Message)
4505 @findex wl-message-delete-current-part
4506 Delete the part under cursor. In fact it appends modified message to
4507 the current folder then moves old one to trash folder. Therefore the
4508 message number will be changed.
4509 (@code{wl-message-delete-current-part})
4510 @end table
4512 @section Customizable Variables
4514 @table @code
4515 @item wl-message-window-size
4516 @vindex wl-message-window-size
4517 Initial setting is @code{(1 . 4)}.  It is a cons cell and the ratio of
4518 its car and cdr value corresponds to the ratio of Summary and Message
4519 windows.
4521 @item wl-message-ignored-field-list
4522 @vindex wl-message-ignored-field-list
4523 Initial setting is @code{nil}.
4524 All fields that match this list will be hidden in message buffer.
4525 Each elements are regexp of field-name.
4526 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4528 @item wl-message-visible-field-list
4529 @vindex wl-message-visible-field-list
4530 Initial setting is @code{nil}.
4531 All fields that match this list will be display in message buffer.
4532 Each elements are regexp of field-name. This value precedes
4533 @code{wl-message-ignored-field-list}.
4534 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4536 @item wl-message-sort-field-list
4537 @vindex wl-message-sort-field-list
4538 Initial setting is
4539 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4540 Header fields in message buffer are ordered by this value.
4541 Each elements are regexp of field-name.
4543 @item wl-message-truncate-lines
4544 @vindex wl-message-truncate-lines
4545 The initial value is the value of @code{default-truncate-lines}.
4546 If it is non-nil, truncate long lines in message buffer.
4548 @item wl-message-auto-reassemble-message/partial
4549 @vindex wl-message-auto-reassemble-message/partial
4550 The initial setting is @code{nil}.
4551 If non-nil, automatically reassemble fragments of the message on
4552 displaying when its MIME media type is message/partial.
4553 @end table
4555 @node Draft, Disconnected Operations, Message, Top
4556 @chapter Draft Buffer
4558 At Summary mode, pressing @kbd{w} and the like creates a new draft
4559 buffer.  You can edit and send mail and news articles in this buffer.
4561 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4562 with those if possible.
4564 @menu
4565 * Usage of Draft Mode::         TIPS
4566 * Key Bindings of Draft::       Key bindings
4567 * Variables of Draft Mode::     Customize Draft Mode
4568 @end menu
4570 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4571 @section Tips
4573 Basically it is Emacs-standard mail mode.
4575 @menu
4576 * Parameters for Sending::
4577 * Editing Header::
4578 * Editing Message Body and Sending::
4579 * Dynamical Message Re-arrangement::
4580 * Template::
4581 * POP-before-SMTP::
4582 @end menu
4584 @node Parameters for Sending, Editing Header, Usage of Draft Mode, Usage of Draft Mode
4585 @subsection Parameters for Sending
4587 According to the information of servers to send messages, configure
4588 following variables.
4590 @table @code
4591 @item wl-smtp-posting-server
4592 The name of the SMTP server used for mail transmission.
4594 @item wl-smtp-posting-port
4595 The SMTP port number for mail transmission.
4596 Without configuration, use default SMTP port number (25).
4598 @item wl-nntp-posting-server
4599 The name of NNTP server used for news submission.
4600 Without configuration, use @code{elmo-nntp-default-server}.
4602 @item wl-nntp-posting-port
4603 The NNTP port number for news submission.
4604 Without configuration, use @code{elmo-nntp-default-port}.
4605 @end table
4607 You may configure following variables on demand. See section
4608 Variables of Draft Mode for detail @xref{Variables of Draft Mode}.
4610 @table @code
4611 @item wl-smtp-posting-user
4612 User name for authentication by SMTP AUTH.
4614 @item wl-smtp-authenticate-type
4615 The authentication method for SMTP AUTH.
4616 Without configuration, authentication will not be carried out.
4618 @item wl-smtp-authenticate-realm
4619 The authentication realm for SMTP AUTH.
4620 Without configuration, authentication realm will not be specified.
4622 @item wl-smtp-connection-type
4623 Specify how to establish SMTP connections.
4625 @item wl-nntp-posting-user
4626 User name for AUTHINFO authentication on news submission.
4628 @item wl-nntp-posting-stream-type
4629 Specify how to establish NNTP connections.
4630 @end table
4632 @node Editing Header, Editing Message Body and Sending, Parameters for Sending, Usage of Draft Mode
4633 @subsection Editing Message Header
4635 You can freely edit header region above @samp{--text follows this line--},
4636 until you invoke the sending operation.
4638 Initially, the cursor is at the @samp{To:} field.  Fill in recipients
4639 addresses.  @kbd{@key{TAB}} completes them.
4641 You can use following headers to specify recipients. Add some of them
4642 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4644 @table @asis
4645 @item @samp{Newsgroups:}
4646 Specify newsgroups to which you post the news article.
4648 @item @samp{Cc:}
4649 Specify addresses to send a copy (Carbon Copy) of the message.
4650 @end table
4652 Following ones are removed from the header contents before sending.
4654 @table @asis
4655 @item @samp{Bcc:}
4656 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4658 @item @samp{Fcc:}
4659 Specify folders in which a copy of the message is saved.
4661 @item @samp{Ecc:}
4662 Specify recipients to send encapsulated copy of the message.
4663 @end table
4665 You can add initial headers by following variables.
4667 @table @code
4669 @item wl-fcc
4670 @vindex wl-fcc
4671 The initial setting is @code{nil}.
4672 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4673 the draft when it is prepared.  If function is specified, its return
4674 value is used.
4676 @item wl-bcc
4677 @vindex wl-bcc
4678 The initial setting is @code{nil}.
4679 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4680 the draft when it is prepared.
4681 @end table
4683 @node Editing Message Body and Sending, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4684 @subsection Editing Messages and Sending
4686 As a matter of course, editing message body can be performed in the same
4687 way as usual writing. You may write message body under
4688 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4689 @samp{--text follows this line--} intact.)
4691 Multi-part editing utilize MIME edit mode of SEMI.  For procedures of
4692 editing, refer to respective documents.  @xref{MIME-Edit, , ,mime-ui-en,
4693 a MIME user interface for GNU Emacs}.
4694 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4696 If you save the draft buffer you are editing, it is appended to the
4697 folder specified by @code{wl-draft-folder}.  You can leave draft buffer
4698 after storing it for future editing by @kbd{C-c C-z} (@code{wl-draft-save-and-exit}).
4700 If you have finished editing, you can send message by @kbd{C-c C-c}.
4703 @node Dynamical Message Re-arrangement, Template, Editing Message Body and Sending, Usage of Draft Mode
4704 @subsection Dynamic Modification of Messages
4705 @vindex wl-draft-config-alist
4706 @c @cindex Change Message
4707 @c @cindex Message, Change Dynamic
4709 You can set @code{wl-draft-config-alist} so that header and body of the
4710 message will automatically modified depending on information of header
4711 and others.
4713 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4715 In the example below, the header is modified when
4716 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.  You
4717 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4718 before sending the message.
4720 @lisp
4721 @group
4722 (setq wl-draft-config-alist
4723       '(((string-match "aaa\\.example\\.com$" (system-name))
4724          ;; @r{applied if the expression is non-nil}
4725          (wl-smtp-posting-server . "mailserver-B")
4726          (wl-nntp-posting-server . "newsserver-B")
4727          ;; @r{settings of temporary variables}
4728          )
4729         ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4730          ;; @r{applied if it matches the header of the draft buffer}
4731          ("Organization" . (format "Go %s" my-webpage)))
4732                        ;; @r{you can write elisp expressions here (eval only)}
4733          (top . "Hello.\n")    ;; @r{inserted at the top of the body}
4734          (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4735         ))
4736 @end group
4737 @end lisp
4739 The format of @code{wl-draft-config-alist} is:
4741 @example
4742 @group
4743 '(("@var{regexp of the header}" or @var{elisp expression}
4744   ("@var{Field}" . value(@var{elisp expression}))
4745    (@var{variable} . value(@var{elisp expression}))
4746    (@var{sub-function} . value(@var{elisp expression}))
4747    @var{function}
4748    @dots{})
4749   ("@var{regexp of the header}" or @var{elisp expression}
4750    ("@var{Field}" . value(@var{elisp expression}))
4751    @dots{}))
4752 @end group
4753 @end example
4755 Per default, there are 13 following sub-functions.
4757 @example
4758 'header:      Inserts the specified string at the bottom of the header.
4759 'header-top:  Inserts the specified string at the top of the header.
4760 'header-file: Inserts the specified file at the bottom of the header.
4761 'x-face:      Inserts @samp{X-Face:} field with the content of the specified file.
4762 'top:         Inserts the specified string at the top of the body.
4763 'top-file:    Inserts the specified file at the top of the body.
4764 'body:        Replaces the body with the specified string.
4765               Specifying @code{nil} deletes the entire body string.
4766 'body-file:   Replaces the body with the content of the specified file.
4767 'bottom:      Inserts the specified string at the bottom of the body.
4768 'bottom-file: Inserts the specified file at the top of the body.
4769 'part-top:  Inserts the specified string at the top of the current part.
4770 'part-bottom: Inserts the specified string at the bottom of the current part.
4771 'template:    Applies the specified template.
4772               (refer to the next subsection)
4773 @end example
4775 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4776 change them or add your own functions.  If you read the code, you can
4777 easily find how to write the functions.
4779 At the first of each item, @var{a regular expression of the header} or
4780 an @var{elisp expression} should be specified.  In the case of an elisp
4781 expression, the item is applied when the expression is evaluated
4782 non-nil.
4784 Per default, when multiple items match or are evaluated non-nil, all
4785 such items are applied, but if you set a variable
4786 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4787 is applied.
4789 At the second of the item, a cons or a list of functions should be
4790 specified.  The car part of the cons should be a header field, a
4791 variable, or a sub-function.  When a header field is specified, the
4792 field will be modified.  If a variable is specified, the value of the
4793 variable will be modified temporarily.
4795 In the cdr part of a cons, not only a variable but also an elisp
4796 expression can be specified as is.  If the car part is a header field
4797 and the cdr part is @code{nil}, the field will be deleted.
4799 See the next example as well:
4801 @lisp
4802 @group
4803 (setq wl-draft-config-alist
4804       '((reply                         ;; @r{(1)}
4805          "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4806          ;; @r{applied if it matches the header of the buffer being replied}
4807          (body . "  Hello.\n")
4808          (template . "default")
4809          )))
4810 @end group
4811 @end lisp
4813 As in the (1) above, if a header regexp is prepended with @code{reply},
4814 it is applied when the draft is prepared by @code{wl-summary-reply} for
4815 example, and when it matches the header being replied.  It is ignored
4816 when there is no buffer being replied, like after @code{wl-draft} was
4817 invoked.
4819 If you want to use name of parent folder, you can refer the buffer local
4820 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4821 changes From according to the folder name of the summary in which the draft
4822 was invoked.
4824 @lisp
4825 @group
4826 (setq wl-draft-config-alist
4827       '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4828          (\"From\" . \"user@@domain1\"))
4829         ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4830          (\"From\" . \"user@@domain2\"))))
4831 @end group
4832 @end lisp
4835 Note that @code{wl-draft-config-alist} is applied only once when
4836 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4837 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4838 aborting transmission, execute @kbd{C-c C-e}
4839 (@code{wl-draft-config-exec}) explicitly.
4841 If you don't want to apply @code{wl-draft-config-alist} when
4842 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4843 do the following:
4845 @lisp
4846 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4847 @end lisp
4849 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4850 prepared, do the following:
4852 @lisp
4853 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4854 @end lisp
4856 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4857 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4858 following:
4860 @lisp
4861 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4862 @end lisp
4864 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4865 @subsection Inserting Templates
4866 @cindex Template
4867 @cindex Apply Template
4869 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4870 @kbd{M-x wl-template-select} in the draft buffer.
4872 The format of @code{wl-template-alist} is almost the same as
4873 @code{wl-draft-config-alist}.
4874 @xref{Dynamical Message Re-arrangement}.
4876 @lisp
4877 @group
4878 (setq wl-template-alist
4879       '(("default"
4880          ("From" . wl-from)
4881          ("Organization" . "Example Co.Ltd.")
4882          (body . "Hello.\n"))
4883         ("report"
4884          (template . "default")                 ;; @r{(a)}
4885          ("To" . "boss@@example.com")
4886          ("Subject" . "Report")
4887          (body-file . "~/work/report.txt")
4888          )
4889         ))
4890 @end group
4891 @end lisp
4893 As you can see, the only difference is item (template) names such as
4894 @samp{default} and @samp{report}, instead of a regexp of header.
4895 Because definition of each item is the same as
4896 @code{wl-draft-config-alist}, you can call another template, like (a).
4898 Executing the command @code{wl-template-select} results in template
4899 selection, but the result differs depending on variable
4900 @code{wl-template-visible-select}.
4902 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4903 window is shown below the draft buffer.  You can select a template by
4904 @kbd{n} and @kbd{p} seeing the buffer window.
4906 Press the @key{RET} key and the template is actually applied to the draft
4907 buffer.  If you press @kbd{q}, nothing is applied.  In addition, you can
4908 adjust the window size by @code{wl-template-buffer-lines}.
4910 If @code{wl-template-visible-select} is @code{nil}, you should type the
4911 name of the template in the mini buffer.
4913 If @code{wl-template-select} is executed with prefix argument,
4914 inversed value of @code{wl-template-visible-select} is used.
4916 As shown in the example in @code{wl-draft-config-alist}, you can select
4917 @samp{default} template by writing:
4919 @lisp
4920 (template . "default")
4921 @end lisp
4923 @node POP-before-SMTP,  , Template, Usage of Draft Mode
4924 @subsection Sending mail by POP-before-SMTP
4925 @cindex POP-before-SMTP
4927 You can send mail by POP-before-SMTP. Necessary setting is
4929 @lisp
4930 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4931 @end lisp
4933 @noindent
4934 to change mail posting function from its default value @code{wl-draft-send-mail-with-smtp}.
4935 Also you would configure following variables on demand.
4937 @table @code
4938 @item wl-pop-before-smtp-user
4939 The POP user name for POP-before-SMTP authentication.
4940 If unset, @code{elmo-pop3-default-user} is used.
4942 @item wl-pop-before-smtp-server
4943 The POP server name for POP-before-SMTP authentication.
4944 If unset, @code{elmo-pop3-default-server} is used.
4946 @item wl-pop-before-smtp-authenticate-type
4947 The POP authentication method for POP-before-SMTP authentication.
4948 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4950 @item wl-pop-before-smtp-port
4951 The POP port number for POP-before-SMTP authentication.
4952 If unset, @code{elmo-pop3-default-port} is used.
4954 @item wl-pop-before-smtp-stream-type
4955 If @code{ssl}, POP connection is established using SSL.  If
4956 @code{starttls}, STARTTLS (RFC2595) connection will be established.  If
4957 unset, @code{elmo-pop3-default-stream-type} is used.
4958 @end table
4960 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4961 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4962 used.
4963 Therefore, if SMTP server and POP server are actually the same, and if
4964 POP folder per default (such as @samp{&}) is available, no settings are
4965 required.
4967 Refer to the following URL about POP-before-SMTP.
4969 @example
4970 @group
4971 http://www.iecc.com/pop-before-smtp.html
4972 @end group
4973 @end example
4976 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4977 @section Key Bindings
4978 @cindex Keybind, Draft Mode
4979 @cindex Keybind, Draft Buffer
4981 @table @kbd
4983 @item C-c C-y
4984 @kindex C-c C-y (Draft)
4985 @findex wl-draft-yank-original
4986 Cites the content of the current message buffer (the part under cursor).
4987 If the region is active, cites the region (it affects only if
4988 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4989 (on XEmacs) is Non-nil). If the command is called with prefix argument,
4990 the text inserted by yank command (the text content of clipboard) is cited.
4991 (@code{wl-draft-yank-original})
4993 @item C-c C-p
4994 @kindex C-c C-p (Draft)
4995 @findex wl-draft-preview-message
4996 Previews the content of the current draft.
4997 This is useful for previewing MIME multi-part messages.
4998 (@code{wl-draft-preview-message})
5000 @item C-c C-s
5001 @kindex C-c C-s (Draft)
5002 @findex wl-draft-send
5003 Sends the content of the current draft.  Does not erase the draft buffer.
5004 This is useful for sending multiple messages, which are a little different
5005 from each other.
5006 (@code{wl-draft-send})
5008 @item C-c C-c
5009 @kindex C-c C-c (Draft)
5010 @findex wl-draft-send-and-exit
5011 Sends the content of the current draft and erases the draft buffer.
5012 (@code{wl-draft-send-and-exit})
5014 @item C-x C-s
5015 @kindex C-x C-s (Draft)
5016 @findex wl-draft-save
5017 Save the current draft.
5018 (@code{wl-draft-save})
5020 @item C-c C-k
5021 @kindex C-c C-k (Draft)
5022 @findex wl-draft-kill
5023 Kills the current draft.
5024 (@code{wl-draft-kill})
5026 @item C-x k
5027 @kindex C-x k (Draft)
5028 @findex wl-draft-mimic-kill-buffer
5029 Kills the current draft.
5030 (@code{wl-draft-mimic-kill-buffer})
5032 @item C-c C-z
5033 @kindex C-c C-z (Draft)
5034 @findex wl-draft-save-and-exit
5035 Saves the current draft, and erases the draft buffer.
5036 This is useful if you want to suspend editing of the draft.
5037 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
5038 the @samp{+draft} folder.
5039 (@code{wl-draft-save-and-exit})
5041 @item C-c C-r
5042 @kindex C-c C-r (Draft)
5043 @findex wl-caesar-region
5044 Encodes or decodes the specified region in Caesar cipher.
5045 (@code{wl-caesar-region})
5047 @item C-l
5048 @kindex C-l (Draft)
5049 @findex wl-draft-highlight-and-recenter
5050 Recenter and rehighlight current draft.
5051 (@code{wl-draft-highlight-and-recenter})
5053 @item M-t
5054 @kindex M-t (Draft)
5055 @findex wl-toggle-plugged
5056 Toggles off-line/on-line states of Wanderlust.
5057 (@code{wl-toggle-plugged})
5059 @item C-c C-o
5060 @kindex C-c C-o (Draft)
5061 @findex wl-jump-to-draft-buffer
5062 Jumps to the other draft buffer, if exists.
5063 With prefix argument, reads a file (if any) from the draft folder when
5064 there is no such buffer.
5065 (@code{wl-jump-to-draft-buffer})
5067 @item C-c C-e
5068 @kindex C-c C-e (Draft)
5069 @findex wl-draft-config-exec
5070 Applies @code{wl-draft-config-alist}.
5071 (@code{wl-draft-config-exec})
5073 @item C-c C-j
5074 @kindex C-c C-j (Draft)
5075 @findex wl-template-select
5076 Selects a template.
5077 (@code{wl-template-select})
5079 @item C-c C-a
5080 @kindex C-c C-a (Draft)
5081 @findex wl-addrmgr
5082 Enter Address Manager.
5083 @xref{Address Manager}.
5084 (@code{wl-addrmgr})
5086 @item C-c C-d
5087 @kindex C-c C-d (Draft)
5088 @findex wl-draft-elide-region
5089 Elide the text between point and mark (@code{wl-draft-elide-region}).
5090 The text is killed and replaced with the contents of the variable
5091 @code{wl-draft-elide-ellipsis}.  The default value is to use an ellipsis
5092 (@samp{[...]}).
5093 @end table
5095 @node Variables of Draft Mode,  , Key Bindings of Draft, Draft
5096 @section Customizable Variables
5097 @cindex SMTP AUTH
5099 @table @code
5100 @item wl-subscribed-mailing-list
5101 @vindex wl-subscribed-mailing-list
5102 The initial setting is @code{nil}.  Mailing lists to which you
5103 subscribe.  If any of these are contained in @samp{To:} or @samp{Cc:}
5104 field of a reply draft, removes your own address from
5105 @samp{Mail-Followup-To:} and @samp{Cc:}.  And if any of these are
5106 contained in @samp{To:} or @samp{Cc:} field of a message to be
5107 automatically re-filed, the destination folder will be leaned in
5108 connection with the address.
5110 Example:
5112 @lisp
5113 @group
5114 (setq wl-subscribed-mailing-list
5115       '("wl@@lists.airs.net"
5116         "apel-ja@@m17n.org"
5117         "emacs-mime-ja@@m17n.org"))
5118 @end group
5119 @end lisp
5121 @item wl-insert-mail-followup-to
5122 @vindex wl-insert-mail-followup-to
5123 The initial setting is @code{nil}.  If non-nil, @samp{Mail-Followup-To:}
5124 field is automatically inserted in the draft buffer.
5126 @item wl-insert-mail-reply-to
5127 @vindex wl-insert-mail-reply-to
5128 The initial setting is @code{nil}.  If non-nil, @samp{Mail-Reply-To:}
5129 field is automatically inserted in the draft buffer.
5131 @item wl-auto-insert-x-face
5132 @vindex wl-auto-insert-x-face
5133 The initial setting is @code{t}.  If non-nil and there is an encoded
5134 X-Face string in a file @file{~/.xface} (the value of the variable
5135 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
5136 draft buffer.  If @code{nil}, it is not automatically inserted.
5138 @item wl-insert-message-id
5139 @vindex wl-insert-message-id
5140 The initial setting is @code{t}.  If non-nil, @samp{Message-ID:} field
5141 is automatically inserted on the transmission.
5143 @item wl-message-id-use-wl-from
5144 @vindex wl-message-id-use-wl-from
5145 The initial setting is @code{nil}.  If non-nil, the value of
5146 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
5148 @item wl-local-domain
5149 @vindex wl-local-domain
5150 The initial setting is @code{nil}.  If @code{nil}, the return value of
5151 the function @code{system-name} will be used as the domain part of
5152 @samp{Message-ID:}.
5154 If @code{system-name} does not return FQDN (i.e. the full name of the
5155 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
5156 to the string of the local domain name without hostname (like
5157 @samp{gohome.org}).  That is, a concatenation of @code{system-name}
5158 @samp{.} @code{wl-local-domain} is used as domain part of the
5159 @samp{Message-ID:}.
5161 If your terminal does not have global IP, set the value of
5162 @code{wl-message-id-domain}.  (You might be beaten up on the Net News if
5163 you use invalid @samp{Message-ID:}.)
5165 Moreover, concatenation of @code{system-name} @samp{.}
5166 @code{wl-local-domain} will be used as an argument to the HELO command
5167 in SMTP.
5169 @item wl-message-id-domain
5170 @vindex wl-message-id-domain
5171 The initial setting is @code{nil}.  If non-nil, this value is used as a
5172 domain part of the @samp{Message-ID:}.  If your terminal does not have
5173 global IP address, set unique string to this value (e.x. your e-mail
5174 address).
5176 @item wl-unique-id-suffix
5177 @vindex wl-unique-id-suffix
5178 The initial setting is @samp{.wl}. You can specify the string in generated
5179 Message-ID which appear just before @samp{@@}.
5181 @item wl-draft-config-alist
5182 @vindex wl-draft-config-alist
5183 The initial setting is @code{nil}.  Modifies the draft message just
5184 before the transmission.  The content of @code{wl-draft-config-alist}
5185 will be automatically applied only once on the transmission.  If you
5186 want to apply it manually, use @kbd{C-c C-e}.  This command can be used
5187 many times.
5189 @item wl-template-alist
5190 @vindex wl-template-alist
5191 The initial setting is @code{nil}.
5192 This variable specifies the template to be applied in the draft buffer.
5194 @item wl-draft-config-matchone
5195 @vindex wl-draft-config-matchone
5196 The initial setting is @code{nil}.  If non-nil, only the first matching
5197 item is used when @code{wl-draft-config-alist} is applied.  If
5198 @code{nil}, all matching items are used.
5200 @item wl-template-visible-select
5201 @vindex wl-template-visible-select
5202 The initial setting is @code{t}.
5203 If non-nil, you can preview the result of the template selection in
5204 another window.
5206 @item wl-template-confirm
5207 @vindex wl-template-confirm
5208 The initial setting is @code{nil}.
5209 If non-nil, asks for confirmation when you press the enter key to select
5210 template while previewing.
5212 @item wl-template-buffer-lines
5213 @vindex wl-template-buffer-lines
5214 The initial setting is 7.
5215 If @code{wl-template-visible-select} is non-nil, this variable specifies
5216 the size of the preview window.
5218 @item wl-draft-buffer-style
5219 @vindex wl-draft-buffer-style
5220 The initial setting is @code{full}.
5221 Style of draft buffer window (except for replying and forwarding).
5222 @code{keep} is to use current window,
5223 @code{full} is to use full frame window,
5224 @code{split} is to split current window and use it.
5225 If some function is specified, it is called with the draft buffer
5226 as an argument.
5228 @item wl-draft-reply-buffer-style
5229 @vindex wl-draft-reply-buffer-style
5230 The initial setting is @code{split}.
5231 Style of draft buffer for replying and forwarding.
5232 @code{keep} is to use message buffer window,
5233 @code{full} is to use full frame window,
5234 @code{split} is to split message buffer window and use it.
5235 If some function is specified, it is called with the draft buffer
5236 as an argument.
5238 @item wl-draft-use-frame
5239 @vindex wl-draft-use-frame
5240 The initial setting is @code{nil}.
5241 If non-nil, use new frame for the draft.
5243 @item wl-draft-reply-default-position
5244 @vindex wl-draft-reply-default-position
5245 The initial setting is @code{body}.
5246 Specify initial cursor position on draft buffer for reply.
5247 @code{body} is to move cursor to the top of the message body,
5248 @code{bottom} to the bottom of the message body, and @code{top} to the
5249 top of the header.
5251 @item wl-draft-truncate-lines
5252 @vindex wl-draft-truncate-lines
5253 The initial value is the value of @code{default-truncate-lines}.
5254 If it is non-nil, truncate long lines in draft buffer.
5256 @item wl-from
5257 @vindex wl-from
5258 The initial setting is the value of the variable
5259 @code{user-mail-address}.  The value of this variable is inserted as a
5260 @samp{From:} field of the draft when it is prepared.
5262 @item wl-envelope-from
5263 @vindex wl-envelope-from
5264 The initial setting is @code{nil}.
5265 The value of this variable is used for envelope from (MAIL FROM).
5266 If @code{nil}, the address part of @code{wl-from} is used.
5268 @item wl-user-mail-address-list
5269 @vindex wl-user-mail-address-list
5270 The initial setting is @code{nil}.
5271 This is the User's address list.  If you have multiple addresses,
5272 set this variable.
5274 @item wl-reply-subject-prefix
5275 @vindex wl-reply-subject-prefix
5276 The initial setting is @samp{Re: }.
5277 In the @samp{Subject:} of the reply draft, this string is prepended to
5278 the @samp{Subject:} of being replied.  You can specify a function to be
5279 message buffer of the reply target.
5281 @item wl-forward-subject-prefix
5282 @vindex wl-forward-subject-prefix
5283 The initial setting is @samp{Forward: }.
5284 In the @samp{Subject:} of the forwarding draft, this string is prepended
5285 to the @samp{Subject:} of being forwarded.  You can specify a function
5286 to be message buffer of the forward target.
5288 @item wl-draft-reply-use-address-with-full-name
5289 @vindex wl-draft-reply-use-address-with-full-name
5290 The initial setting is @code{t}.
5291 If non-nil, insert her full name with address when prepare a draft for
5292 reply a message.  If it is @code{nil}, insert her address only.
5294 @item wl-draft-enable-queuing
5295 @vindex wl-draft-enable-queuing
5296 The initial setting is @code{t}.
5297 This flag controls off-line transmission.  If non-nil, the draft is
5298 sent off-line.
5300 @item wl-draft-use-cache
5301 @vindex wl-draft-use-cache
5302 The initial setting is @code{nil}. If the value is non-nil and
5303 @code{wl-insert-message-id} is nil, cache the message which is sent.
5305 @item wl-fcc-force-as-read
5306 @vindex wl-fcc-force-as-read
5307 The initial setting is @code{nil}. If the value is non-nil,
5308 Mark as read the message saved by @samp{Fcc:}.
5310 @item wl-auto-flush-queue
5311 @vindex wl-auto-flush-queue
5312 The initial setting is t.
5313 This flag controls automatic transmission of the queue when Wanderlust
5314 becomes on-line.  If non-nil, the queue is automatically transmitted
5315 (with confirmation by @code{y-or-n-p}).  If you want to transmit it
5316 manually, press @kbd{F} in the folder mode.
5318 @item wl-ignored-forwarded-headers
5319 @vindex wl-ignored-forwarded-headers
5320 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
5321 All headers that match this regexp will be deleted when forwarding a message.
5323 @item wl-ignored-resent-headers
5324 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
5325 All headers that match this regexp will be deleted when resending a message.
5327 @item wl-draft-always-delete-myself
5328 @vindex wl-draft-always-delete-myself
5329 If non-nil, always removes your own address from @samp{To:} and
5330 @samp{Cc:} when you are replying to the mail addressed to you.
5332 @item wl-draft-delete-myself-from-bcc-fcc
5333 @vindex wl-draft-delete-myself-from-bcc-fcc
5334 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
5335 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
5337 @item wl-draft-send-mail-function
5338 @vindex wl-draft-send-mail-function
5339 The initial setting is @code{wl-draft-send-mail-with-smtp}.
5340 This is the function to post mails. To use POP-before-SMTP, set this to
5341 @code{wl-draft-send-mail-with-pop-before-smtp}.
5343 @item wl-smtp-posting-server
5344 @vindex wl-smtp-posting-server
5345 The initial setting is @code{nil}.
5346 This is the SMTP server name for mail transmission.
5348 @item wl-smtp-posting-port
5349 @vindex wl-smtp-posting-port
5350 The initial setting is @code{nil}.
5351 This is the SMTP port number for mail transmission.
5352 If @code{nil}, default SMTP port number (25) is used.
5354 @item wl-smtp-posting-user
5355 @vindex wl-smtp-posting-user
5356 The initial setting is @code{nil}.
5357 This is the user name for SMTP AUTH authentication.
5359 @item wl-smtp-authenticate-type
5360 @vindex wl-smtp-authenticate-type
5361 The initial setting is @code{nil}.
5362 This string-valued variable specifies the authentication method for SMTP
5363 AUTH authentication.  You may specify @code{plain}, @code{cram-md5},
5364 @code{digest-md5}, @code{login}, etc.  If @code{nil}, authentication
5365 will not be carried out.
5367 @item wl-smtp-authenticate-realm
5368 @vindex wl-smtp-authenticate-realm
5369 The initial setting is @code{nil}.
5370 This string-valued variable specifies the authentication realm for SMTP
5371 AUTH authentication. You have to set this variable for DIGEST-MD5
5372 authentication and so on.
5373 If @code{nil}, authentication realm is not specified in the authentication.
5375 @item wl-smtp-connection-type
5376 @vindex wl-smtp-connection-type
5377 The initial setting is @code{nil}.
5378 This symbol-valued variable specifies how to establish SMTP connections.
5379 If @code{nil}, use default connection type.
5380 If it is @code{starttls}, use STARTTLS (RFC3207).
5381 If it is @code{ssl}, use SSL.
5383 @item wl-nntp-posting-server
5384 @vindex wl-nntp-posting-server
5385 The initial setting is @code{nil}.
5386 This is the NNTP server name used for news submission.
5387 If @code{nil}, @code{elmo-nntp-default-server} is used.
5389 @item wl-nntp-posting-user
5390 @vindex wl-nntp-posting-user
5391 The initial setting is @code{nil}.
5392 This is the user name for AUTHINFO authentication on news submission.
5393 If @code{nil}, @code{elmo-nntp-default-user} is used.
5394 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
5396 @item wl-nntp-posting-port
5397 @vindex wl-nntp-posting-port
5398 The initial setting is @code{nil}.
5399 This is the port number of the NNTP server used for news submission.
5400 If @code{nil}, @code{elmo-nntp-default-port} is used.
5402 @item wl-nntp-posting-stream-type
5403 @vindex wl-nntp-posting-stream-type
5404 The initial setting is @code{nil}.
5405 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated.  If @code{ssl},
5406 SSL is used for news submission.  If @code{starttls}, STARTTLS (RFC2595)
5407 connection will be established.
5409 @item wl-nntp-posting-function
5410 @vindex wl-nntp-posting-function
5411 The initial setting is @code{elmo-nntp-post}.
5412 This is the function to post NNTP message.
5414 @item wl-nntp-posting-config-alist
5415 @vindex wl-nntp-posting-config-alist
5416 The initial setting is @code{nil}.
5417 The value takes an alist to define NNTP server like following example.
5418 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
5420 @lisp
5421 @group
5422 (setq wl-nntp-posting-config-alist
5423       '((",?gmane\\." . "news.gmane.org")
5424         (",?comp\\." .
5425          ((server . "news-server")
5426           (user . "newsmaster")
5427           (port . 119)
5428           (function . elmo-nntp-post)))
5429         (".*" . "default-news-server")))
5430 @end group
5431 @end lisp
5433 @item wl-pop-before-smtp-user
5434 @vindex wl-pop-before-smtp-user
5435 The initial setting is @code{nil}.
5436 This is the POP user name for POP-before-SMTP.
5437 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
5439 @item wl-pop-before-smtp-server
5440 @vindex wl-pop-before-smtp-server
5441 The initial setting is @code{nil}.
5442 This is the POP server name for POP-before-SMTP.
5443 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
5445 @item wl-pop-before-smtp-authenticate-type
5446 @vindex wl-pop-before-smtp-authenticate-type
5447 The initial setting is @code{nil}.
5448 This is the authentication method for POP-before-SMTP authentication.
5449 If it is @code{nil}, @code{elmo-pop3-default-authenticate-type} is used.
5451 @item wl-pop-before-smtp-port
5452 @vindex wl-pop-before-smtp-port
5453 The initial setting is @code{nil}.
5454 This is the POP port number for POP-before-SMTP.  If it is @code{nil},
5455 @code{elmo-pop3-default-port} is used.
5457 @item wl-pop-before-smtp-stream-type
5458 @vindex wl-pop-before-smtp-stream-type
5459 The initial setting is @code{nil}.
5460 This flag controls the use of SSL for POP-before-SMTP.  If it is
5461 @code{nil}, @code{elmo-pop3-default-stream-type} is used.  If @code{ssl},
5462 SSL is used.  If @code{starttls}, STARTTLS (RFC2595) connection will be
5463 established.
5465 @item wl-draft-queue-save-variables
5466 @vindex wl-draft-queue-save-variables
5467 Specifies a list of variable to which queued messages are saved on the
5468 off-line transmission.
5470 @item wl-draft-sendlog
5471 @vindex wl-draft-sendlog
5472 The initial setting is @code{t}.
5473 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}.  It
5474 is written when:
5476 @itemize @minus
5477 @item drafts are sent by smtp or qmail
5478 @item saved into folders by fcc
5479 @item saved into folders by queuing
5480 @end itemize
5482 (it is written even if the transmission fails).
5483 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
5484 and left to the logging function of @command{imput}.
5487 @item wl-draft-sendlog-max-size
5488 @vindex wl-draft-sendlog-max-size
5489 The initial setting is 20000 (in bytes).
5490 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
5491 beyond the size specified by this variable.
5493 @item wl-use-ldap
5494 @vindex wl-use-ldap
5495 The initial setting is @code{nil}.
5496 If non-nil, address completion uses LDAP.
5498 @item wl-ldap-server
5499 @vindex wl-ldap-server
5500 The initial setting is @samp{localhost}.
5501 LDAP server name for address completion.
5503 @item wl-ldap-port
5504 @vindex wl-ldap-port
5505 The initial setting is @code{nil}.
5506 If non-nil, the value is used as port number.
5508 @item wl-ldap-base
5509 @vindex wl-ldap-base
5510 The initial setting is @samp{c=US}.
5511 LDAP search starting point (base) for address completion.
5513 @item wl-draft-remove-group-list-contents
5514 @vindex wl-draft-remove-group-list-contents
5515 The initial setting is @code{t}.
5516 If non-nil, remove the group-lists' members in the recipients when
5517 sending the message (group-list means the description such as
5518 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
5519 @end table
5521 @node Disconnected Operations, Expire and Archive, Draft, Top
5522 @chapter Off-line Management
5523 @cindex Disconnected Operations
5525 Wanderlust has on-line and off-line states.
5527 @menu
5528 * Off-line State::              Wanderlust has on-line and off-line states
5529 * Enable Operations::           Enable Disconnected Operations
5530 * Plugged Mode::                Switching On-line/Off-line per Server/Port
5531 * Off-line State settings::     Invoking Wanderlust in the Off-line State
5532 * Variables of Plugged Mode::   Customize Plugged Mode
5533 @end menu
5536 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5537 @section Off-line State
5539 Wanderlust has on-line and off-line states.  In the off-line state, you
5540 cannot access messages via network, unless they are cached.
5542 @samp{[ON]} in the mode line indicates the on-line state.  @samp{[--]}
5543 in the mode line indicates the off-line state.  In folder or summary
5544 modes, press @kbd{M-t} to switch between off- and on-line.
5546 You can invoke Wanderlust in the off-line state by setting
5547 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5549 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5550 ignores uncached messages.
5553 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5554 @section Enable Disconeected Operations
5556 Even in the off-line state, provided that relevant messages are cached,
5557 and the variable @code{elmo-enable-disconnected-operation} (described
5558 later) is non-nil, you can following operations:
5559 @xref{Plugged Mode}, @xref{Off-line State settings}.
5561 @menu
5562 * Send Messages off-line::      Transmit Messages
5563 * Re-file and Copy queue::      Re-file and Copy (IMAP4)
5564 * Creation of Folders::         Create Folders off-line (IMAP4)
5565 * Marking::                     Mark (IMAP4)
5566 * Pre-fetching Reservations::   Pre-fetch
5567 @end menu
5569 As soon as Wanderlust becomes on-line, such operations invoked off-line
5570 are reflected in the servers via network.
5572 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5573 these off-line operations are not executed and causes an error on
5574 re-file or copy operations.
5576 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5577 @subsection Transmission of Messages
5579 You can proceed sending operation for  mail/news messages while you are
5580 off-line, then it will be reserved for sending (if you are using
5581 @file{im-wl.el}, it is irrelevant).
5582 Messages reserved for sending while off-line are accumulated in the
5583 queue folder, @samp{+queue}. These messages are transmitted at once when
5584 Wanderlust becomes on-line.
5586 You can visit @samp{+queue} in the off-line state and confirm content of
5587 messages in the queue.  You can also remove messages.  Removed messages
5588 are not transmitted even in the on-line state.
5591 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5592 @subsection Re-file and Copy (IMAP4)
5594 Re-file and copy operations to IMAP folders invoked during the off-line
5595 state are accumulated in the queue, and reflected in the server side
5596 when Wanderlust becomes on-line.  If you visit destination folders after
5597 off-line re-file or copy, it looks as if messages were appended even in
5598 off-line state.
5600 For the safety reasons, messages re-filed off-line are removed from
5601 source folders only if their @samp{Message-ID:} match messages on the
5602 servers.  While the queue is processed, messages that failed to be
5603 re-filed or copied to the specified folders are appended to the folder
5604 @samp{+lost+found}.
5607 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5608 @subsection Creation of Folders (IMAP4)
5610 You can create IMAP folders off-line.  The creation of folders are
5611 reflected in the servers when Wanderlust becomes on-line.  If the creation
5612 of those folders fails at that time for some reasons, messages
5613 to be re-filed into those are appended to the folder @samp{+lost+found}
5614 instead.
5617 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5618 @subsection Marking (IMAP4)
5620 Off-line changes in unread/read and importance mark @samp{$} information
5621 are also reflected in the servers when Wanderlust becomes on-line.
5624 @node Pre-fetching Reservations,  , Marking, Enable Operations
5625 @subsection Pre-fetching
5627 You can make reservations for pre-fetching messages in networking
5628 folders (IMAP, NNTP, POP3, shimbun).  Reserved messages are marked with
5629 @samp{u} but not cached yet.  When Wanderlust becomes on-line, they are
5630 pre-fetched from servers.
5633 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5634 @section Switching On-line/Off-line per Server/Port
5636 @kbd{M-t} described above switches networking states as a whole, but you
5637 can switch on-line/off-line per server/port.
5639 Pressing @kbd{C-t} in the folder or summary modes brings you in
5640 wl-plugged-mode shown below, in which you can change the plugged state
5641 for each port.
5643 @example
5644 @group
5645 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5646 [ON](wl-plugged)
5647   [--]hosta
5648     [--]smtp        +queue: 2 msgs (1,2)        @dots{}@r{sending queue}
5649     [--]nntp(119)   +queue: 1 msg (3)           @dots{}@r{sending queue}
5650   [ON]hostb
5651     [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5652                             %inbox(delete-msgids:1)    @dots{}@r{dop queue}
5653     [ON]nntp(119)
5654     [ON]smtp
5655 @end group
5656 @end example
5658 The first line indicates status of the following three variables, and
5659 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5660 column modifies the values of these variables.
5662 @example
5663 @group
5664 "Queuing"               @code{wl-draft-enable-queuing}
5665 "AutoFlushQueue"        @code{wl-auto-flush-queue}
5666 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5667 @end group
5668 @end example
5670 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5671 @code{nil}.
5673 The second and after lines indicate on-line/off-line states of servers
5674 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5675 off-line (in XEmacs or Emacs 21, they are shown with icons).  Pressing
5676 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5678 @dfn{sending queue} means messages accumulated in the folder
5679 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5680 off-line operations when @code{elmo-enable-disconnected-operation} is
5681 @code{t}.
5682 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5683 @c off-line operations are enabled.
5685 They are displayed if there are any of them.  In the example above, in
5686 the sending queue there are two messages (the first and the second in
5687 the queue folder) for smtp to hosta and one (the third) for nntp to
5688 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5689 @samp{%#mh/wl}.
5691 If you change @samp{(wl-plugged)} in the second line, the variable
5692 @code{wl-plugged} is changed, so that the mode line indicator and
5693 plugged states of all ports are affected.  If you change plugged states
5694 of any servers or ports, @samp{(wl-plugged)} in the second line is
5695 affected depending on @code{elmo-plugged-condition} settings and the
5696 plugged state of each port.
5699 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5700 @section Invoking Wanderlust in the Off-line State
5702 As described before, if you set @code{wl-plugged} to @code{nil} in
5703 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5704 off-line state.  You can specify off-line state on a per server or port
5705 basis.  Refer to @code{wl-reset-plugged-alist} also.
5707 Usually, when Wanderlust starts up, the plugged state of each port is
5708 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5709 @code{wl-nntp-posting-server} and so on.  If you want to change the
5710 plugged state of these ports or to add other ports, configure
5711 @code{wl-make-plugged-hook} with a function.
5713 @lisp
5714 @group
5715 (add-hook 'wl-make-plugged-hook
5716           '(lambda ()
5717              (elmo-set-plugged plugged-value(t/nil) server port)
5718                  ;; @r{add or change plugged states of the port of the server}
5719              (elmo-set-plugged plugged-value(t/nil) server)
5720                  ;; @r{if the port is omitted, all ports are affected}
5721                  ;; @r{(you cannot omit the port if you newly add the server)}
5722              ))
5723 @end group
5724 @end lisp
5727 @node Variables of Plugged Mode,  , Off-line State settings, Disconnected Operations
5728 @section Customizable Variables
5730 @table @code
5731 @item wl-plugged
5732 @vindex wl-plugged
5733 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5734 mode from the beginning.
5736 @item wl-queue-folder
5737 @vindex wl-queue-folder
5738 The initial setting is @samp{+queue}.
5739 This is the folder in which messages in the transmission queue are
5740 accumulated.
5742 @item wl-auto-flush-queue
5743 @vindex wl-auto-flush-queue
5744 The initial setting is @code{t}.
5745 This flag controls automatic transmission of the queue when Wanderlust
5746 becomes on-line.  If non-nil, the queue is automatically transmitted
5747 (with confirmation by @code{y-or-n-p}).  If you want to transmit it
5748 manually, press @kbd{F} in the folder mode.
5750 @item elmo-enable-disconnected-operation
5751 @vindex elmo-enable-disconnected-operation
5752 The initial setting is @code{t}.  Controls off-line operations regarding
5753 networking folders.  If non-nil, off-line operations are carried out.
5755 @item elmo-lost+found-folder
5756 @vindex elmo-lost+found-folder
5757 The initial setting is @samp{+lost+found}.
5758 This is the folder to which messages are saved when they fails to be
5759 appended while the off-line re-file/copy queue is processed.
5761 @item elmo-plugged-condition
5762 @vindex elmo-plugged-condition
5763 The initial setting is @code{one}.
5764 The value of @code{wl-plugged} reflects the return value of the function
5765 @code{elmo-plugged-p} (without arguments).
5766 This variable @code{elmo-plugged-condition} specifies the condition on
5767 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5768 plugged state of each port.
5770 @example
5771 'one         : plugged if one or more ports are plugged.
5772 'all         : plugged if all ports are plugged.
5773 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5774                states of the ports.
5775 @var{function}     : reflects the return value of the @var{function}
5776  functions available per default
5777  'elmo-plug-on-by-servers
5778              : reflects the plugged state of the servers specified by the
5779                variable elmo-plug-on-servers.
5780  'elmo-plug-on-by-exclude-servers
5781              : reflects the plugged state of the servers that are not
5782                in elmo-plug-on-exclude-servers.
5783                   elmo-plug-on-exclude-servers defaults to
5784                    '("localhost"
5785                      (system-name)
5786                      (system-name)without the domain part)
5787 @end example
5789 @example
5790 @group
5791 Example 1:
5792  (setq elmo-plugged-condition 'all)
5793 Example 2:
5794  (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5795  (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5796 Example 3:
5797  (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5798  (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5799 @end group
5800 @end example
5802 @item wl-reset-plugged-alist
5803 @vindex wl-reset-plugged-alist
5804 The initial setting is @code{t}.  If non-nil, plugged states are
5805 initialized on a per server or port basis when Wanderlust starts up.
5807 If @code{nil}, plugged states are retained while Emacs is running.  In
5808 other words, they are initialized when Emacs is restarted even if the
5809 value is @code{nil}.
5810 @end table
5813 @node Expire and Archive, Scoring, Disconnected Operations, Top
5814 @chapter Automatic Expiration and Archiving of Messages
5815 @cindex Expire and Archive
5817 @menu
5818 * Expire::      Expiration and Archiving
5819 * Archive::     Archiving All Messages
5820 @end menu
5823 @node Expire, Archive, Expire and Archive, Expire and Archive
5824 @section Expiration
5825 @cindex Expire Message
5827 Expiration means deletion of old messages which have outlasted a
5828 certain period of time.
5830 @code{wl-expire} supports not only simple deletion, but also moving to
5831 specified archiving folders.
5833 @section How to Use
5835 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5836 or @kbd{M-e} in the summary mode.
5838 @subsection Configuring @code{wl-expire-alist}
5840 An example configuration of @code{wl-expire-alist} is shown below.
5841 Everything in this @code{wl-expire-alist} makes a great difference in
5842 expiration, so be careful.  I advise you to set @code{wl-expire-use-log}
5843 to @code{t}, especially in the initial stage.
5845 @lisp
5846 @group
5847 (setq wl-expire-alist
5848       '(("^\\+trash$"   (date 14) remove)
5849                                   ;; @r{delete}
5850         ("^\\+tmp$"     (date 7) trash)
5851                                   ;; @r{re-file to @code{wl-trash-folder}}
5852         ("^\\+outbox$"  (number 300) "$outbox;lha")
5853                                   ;; @r{re-file to the specific folder}
5854         ("^\\+ml/tmp$"  nil)
5855                            ;; @r{do not expire}
5856         ("^\\+ml/wl$"   (number 500 510) wl-expire-archive-number1 t)
5857                            ;; @r{archive by message number (retaining numbers)}
5858         ("^\\+ml/.*"    (number 300 310) wl-expire-archive-number2 t)
5859                            ;; @r{archive by a fixed number (retaining numbers)}
5860         ("^\\+diary$"   (date 30) wl-expire-archive-date)
5861                            ;; @r{archive by year and month (numbers discarded)}
5862         ))
5863 @end group
5864 @end lisp
5866 Items in the list has the format of:
5868 @example
5869 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5870 @end example
5872 @noindent
5873 The folder is examined if it matches @var{regexp-for-folders} from the
5874 beginning of the list.  If you invoke expiration on the folder that does
5875 not match any of them, nothing will happen.  And if either the second or
5876 the third element of the item is @code{nil}, expiration will not take
5877 place.
5879 You can use any one of the following for
5880 @var{specification-of-message-to-be-deleted}:
5882 @table @code
5883 @item (number @var{n1} [@var{n2}])
5884 deletes messages depending on the number of messages in the folder.
5886 @var{n1} is the number of messages which should survive deletion, for example
5887 if its value is 500, the newest 500 messages survive and the rests are
5888 deleted.
5890 @var{n2} is the number of messages in the folder on which expiration should
5891 take place, which defaults to @var{n1} + 1.  For example if its value is 510,
5892 folders with 510 or more messages are expired.
5893 If you configured automatic expiration, frequently used folders may
5894 expire every time it receive messages, and you may be annoyed with the
5895 long delay in reading mail.
5896 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5897 expiration would not take place until a certain number of messages
5898 accumulate.
5900 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5901 with important/new/unread) are not deleted.
5902 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5903 will expire so as to have 500 messages including such ones.
5904 Otherwise, it will have 500 messages except such ones.
5906 @item (date @var{d1})
5907 deletes messages depending on the dates.
5909 Messages dated @var{d1} or more days ago are deleted, for example if its
5910 value is seven, messages seven days old or more are deleted.  Note that
5911 the date is the one in the @samp{Date:} field of the message, not when
5912 the message entered the folder.
5914 Messages with no or invalid @samp{Date:} field does not expire; you
5915 might have to delete them by hand.
5916 @end table
5918 You can use any one of the following in the place of @var{destination}:
5920 @table @asis
5921 @item @code{remove}
5922 deletes the messages instantly.
5924 @item @code{hide}
5925 hide the messages from summary (messages are not deleted).
5927 @item @code{trash}
5928 moves the messages to @code{wl-trash-folder}.
5930 @item @var{string}(folder)
5931 moves the messages to the folder specified with @var{string}.
5933 It would be useful for specifying an archiving folder, but because this
5934 does not move important messages, it might be better to use the
5935 standard functions described below.
5937 @item @var{function}
5938 invokes the specified @var{function}.
5940 To the @var{function}, three arguments are passed: a folder name, a list
5941 of messages to be deleted, and msgdb information of the summary.  You
5942 can specify function-specific arguments after the name of the
5943 @var{function}.  Note that the list contains messages with marks in
5944 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5945 function.
5947 These are four standard functions; three of them move messages to an archive
5948 folder in the specified way.  This means old messages can be compressed
5949 and saved in a file, being deleted from the original folder.
5950 The last one divides messages to some MH folders.
5952 @table @code
5953 @item wl-expire-archive-number1
5954 re-files to archiving folders corresponding to the message numbers of
5955 the messages being deleted.  For example, a message numbered 102 will be
5956 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5957 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5958 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5960 The archiving folders to which messages are re-filed are determined by
5961 the name of the folder as follows (in this case, archiving folders are
5962 handled as if @code{elmo-archive-treat-file} were non-nil).
5964 @table @asis
5965 @item If the folder type is localdir:
5966 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5968 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5969 (@file{~/Mail/ml/wl-00100.zip}).
5971 @item The folder type is other than localdir:
5972 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5974 For example, @samp{%#mh/ml/wl} corresponds to
5975 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5976 @end table
5978 As you can see, in the case of localdir, the folder type is not included
5979 in the path name, but otherwise it is included.
5980 And you can control the prefix to the archiving folder name by
5981 @code{wl-expire-archive-folder-prefix}.
5982 Refer to @code{wl-expire-archive-folder-prefix} for details.
5984 @item wl-expire-archive-number2
5985 re-files every certain number of messages to archiving folders.
5987 This differs from @samp{wl-expire-archive-number1} in that this re-files
5988 to the folder up to the specified number regardless of message numbers.
5989 The archiving folders to which messages are re-filed are determined in the
5990 same way as @code{wl-expire-archive-number1}.
5992 @item wl-expire-archive-date
5993 re-files messages depending on its date (year and month) to archive
5994 folders.
5996 For example, a message dated December 1998 is re-filed to
5997 @code{$folder-199812;zip}.  The name of the archiving folders except the
5998 date part are determined in the same way as
5999 @code{wl-expire-archive-number1}.
6002 You can set the first argument to these three standard functions to non-nil
6003 in @code{wl-expire-alist} so as to retain message numbers in the folder.
6004 For example, it can be specified just after the name of the function:
6006 @lisp
6007 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
6008 @end lisp
6010 If you omit the argument, consecutive numbers from 1 are assigned for
6011 each archiving folder.
6013 @item wl-expire-localdir-date
6014 divedes messages depending on its date (year and month) to MH folders
6015 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
6016 @end table
6017 @end table
6019 @subsection Treatment for Important or Unread Messages
6021 If you specify any of @code{remove}, @code{trash}, a folder name, or a
6022 standard function, messages with marks in
6023 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
6024 messages} thereafter) are retained.
6026 Per default, this variable include the important, new, and unread marks,
6027 so that messages with these marks are not removed.
6028 Note that you cannot include the temporary mark (i.e. temporary marks
6029 are removed anyway), and be sure to process temporary marks before you
6030 invoke expiration.
6032 @subsection Auto Expiration
6034 The following setup invokes expiration when you move into the summary
6035 mode.  There will be no confirmation, so make sure you made no mistake
6036 in regexp and other settings before you set up this.
6038 @lisp
6039 @group
6040 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
6041 @end group
6042 @end lisp
6044 In the folder mode, you can invoke expiration per group as well as per
6045 folder.  Therefore, if you specify @samp{Desktop} group, all folders
6046 matching @code{wl-expire-alist} expire.
6048 @section Tips
6050 @subsection Treating archive folders.
6051 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
6052 you must set non-nil value to @code{elmo-archive-treat-file}.
6054 @subsection Confirming
6056 If you are to use @code{remove}, try @code{trash} at first and see
6057 messages move to @code{wl-trash-folder} as expected, then replace it
6058 with @code{remove}.  It would be dangerous to use @code{remove} from the
6059 beginning.
6061 If you are to use @code{wl-expire-archive-number1} and the like, try to
6062 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
6063 you can append messages to it.  Even if settings in
6064 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
6065 would not be saved anywhere and disappeared in case the archiver program
6066 fails.
6068 After you make sure you can archive to the folder correctly, you can
6069 invoke expiration and utilize the log.
6071 If you set @code{wl-expire-use-log} to @code{t},
6072 @file{~/.elmo/expired-log} should contain the log, for example:
6074 @example
6075 @group
6076 delete  +ml/wl  (593 594 595 596 597 598 599)
6077 move    +ml/wl -> $ml/wl-00600;tgz;wl  (600 601 602)
6078 @end group
6079 @end example
6081 The first column indicates the operation, i.e. @samp{delete},
6082 @samp{copy}, or @samp{move}.  The next is the name of the folder that
6083 expired.  In the case of @samp{copy} and @samp{move}, the destination
6084 folder is recorded after @samp{->}.  The last is the list of message
6085 numbers that are actually deleted or moved (in the case of @samp{copy}
6086 and @samp{move}, the number is the one in the source folder, rather than
6087 the destination folder).
6089 @subsection Re-filing Reserved Messages
6091 The three standard functions copy reserved messages to the archive
6092 folder, but do not delete them from the source folder.  Because
6093 reserved messages and the like always remain, they are recorded in
6094 @file{~/.elmo/expired-alist} so that they are not copied over and over
6095 again.  They are not recorded if copied by @code{wl-summary-archive}.
6097 If you enabled logging, usually @samp{move} is recorded for re-filing,
6098 but instead @samp{copy} and @samp{delete} are recorded separately if
6099 reserved messages are involved.  This is because it actually copies
6100 messages including reserved, then deletes ones except reserved in that
6101 case.
6103 @section Customizable Variables
6105 @table @code
6106 @item wl-expire-alist
6107 @vindex wl-expire-alist
6108 The initial setting is @code{nil}.
6109 This variable specifies folders and methods to expire.  For details,
6110 refer to @code{wl-expire-alist} settings above.
6112 @item wl-summary-expire-reserve-marks
6113 @vindex wl-summary-expire-reserve-marks
6114 The initial setting is the list below.
6116 @lisp
6117 @group
6118 (list wl-summary-flag-mark
6119       wl-summary-new-uncached-mark
6120       wl-summary-new-cached-mark
6121       wl-summary-unread-uncached-mark
6122       wl-summary-unread-cached-mark)
6123 @end group
6124 @end lisp
6126 Messages with these marks are retained in the folder, even after
6127 expiration.
6128 Only permanent marks can be listed, not temporary marks.
6130 You can list marks one by one as in the default; you can use the
6131 following settings as well:
6133 @table @code
6134 @item all
6135 All messages with permanent marks are retained,
6136 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
6137 defaults.
6139 @item none
6140 All messages are handled as usual ones that are already read, no matter
6141 what marks they have; even important messages are deleted.
6142 @end table
6144 @item wl-expire-archive-files
6145 @vindex wl-expire-archive-files
6146 The initial setting is 100.
6147 This variable specifies the number of messages to be retained in one
6148 archiving folder.
6150 @item wl-expire-number-with-reserve-marks
6151 @vindex wl-expire-number-with-reserve-marks
6152 The initial setting is @code{nil}.
6153 If non-nil, if expiring messages are specified by @code{number},
6154 messages with @code{wl-summary-expire-reserve-marks} are also retained.
6156 @item wl-expire-archive-get-folder-function
6157 @vindex wl-expire-archive-get-folder-function
6158 The initial setting is @code{wl-expire-archive-get-folder}.
6160 This variable specifies a function that returns the name of an archiving
6161 folder for standard functions in the place of @var{destination}.
6162 You can use the following three variables for simple modification of
6163 folder names; if you want more complex settings, define your own
6164 function in this variable.
6166 @code{wl-expire-archive-get-folder} can be customized by these
6167 variables:
6168 @itemize @bullet
6169 @item @code{wl-expire-archive-folder-name-fmt}
6170 @item @code{wl-expire-archive-folder-type}
6171 @item @code{wl-expire-archive-folder-prefix}
6172 @end itemize
6174 @item wl-expire-archive-folder-name-fmt
6175 @vindex wl-expire-archive-folder-name-fmt
6176 The initial setting is @samp{%s-%%05d;%s}.
6177 This is a @code{format} string for archiving folders used in
6178 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
6179 Note that you must specify the message number by @samp{%%d}, because it
6180 is parsed twice by @code{format}.
6182 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
6183 well.
6185 @item wl-expire-archive-date-folder-name-fmt
6186 @vindex wl-expire-archive-date-folder-name-fmt
6187 The initial setting is @samp{%s-%%04d%%02d;%s}.
6188 This is a @code{format} string for archiving folders used in
6189 @code{wl-expire-archive-date}.  Note that you must specify the message
6190 number by @samp{%%d}, because it is parsed twice by @code{format}.
6191 There should be @samp{%%d} twice, one for the year and the other for the
6192 month.
6194 If you modify this, adjust
6195 @code{wl-expire-archive-date-folder-num-regexp} as well.
6197 @item wl-expire-archive-folder-type
6198 @vindex wl-expire-archive-folder-type
6199 The initial setting is @code{zip}.
6200 This variable specifies an archiver type of the archiving folders.
6202 @item wl-expire-archive-folder-prefix
6203 @vindex wl-expire-archive-folder-prefix
6204 The initial setting is @code{nil}.
6205 This variable specifies the prefix (directory structure) to archiving
6206 folders.
6207 Exercise extreme caution in using this feature, as it has not been
6208 seriously tested.
6209 In the worst case, there is a fear of destructing archiving folders.
6211 @table @code
6212 @item nil
6213 There will be no prefix.
6215 @item short
6216 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
6217 @samp{$ml/wl-00000;zip;wl}.
6219 @item t
6220 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
6221 resulting in
6223 @samp{$ml/wl-00000;zip;ml/wl}.
6224 @end table
6226 @item wl-expire-archive-folder-num-regexp
6227 @vindex wl-expire-archive-folder-num-regexp
6228 The initial setting is @samp{-\\([-0-9]+\\);}.
6229 This variable specifies the regular expression to be used for getting
6230 message numbers from multiple archiving folders specified by
6231 @code{elmo-list-folders}.
6232 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
6234 @item wl-expire-archive-date-folder-num-regexp
6235 @vindex wl-expire-archive-date-folder-num-regexp
6236 The initial setting is @samp{-\\([-0-9]+\\);}.
6237 This is the regular expression to be used for getting message numbers
6238 from multiple archiving folders specified by @code{elmo-list-folders}.
6239 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
6241 @item wl-expire-delete-oldmsg-confirm
6242 @vindex wl-expire-delete-oldmsg-confirm
6243 The initial setting is @code{t}.
6244 If non-nil, messages older than the one with the largest number will be
6245 deleted with confirmation.
6246 If @code{nil}, they are deleted without confirmation.
6248 This feature is valid only if non-nil is specified as a argument to the
6249 standard functions so as to retain numbers.
6251 @item wl-expire-use-log
6252 @vindex wl-expire-use-log
6253 The initial setting is @code{nil}.
6254 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
6255 They are appended but not truncated or rotated automatically; you might
6256 need to remove it manually.
6258 @item wl-expire-add-seen-list
6259 @vindex wl-expire-add-seen-list
6260 The initial setting is @code{t}.
6262 If non-nil, when messages are re-filed by expiration, read/unread
6263 information is passed to the destination folder.
6265 However if you do not read the destination folder from Wanderlust,
6266 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
6267 want to set this to @code{nil} if you are simply saving to some
6268 archiving folders.  Even if its value is @code{nil}, messages in the
6269 archiving folders are simply treated as unread; it does not affect
6270 expiration itself.
6272 @item wl-expire-folder-update-msgdb
6273 @vindex wl-expire-folder-update-msgdb
6274 The initial setting is @code{t}.
6275 If @code{t}, in the folder mode, expiration is carried out after
6276 updating summary information.  If you specified a list of regular
6277 expressions of folder names, summary information is updated for matching
6278 folders only.
6279 @end table
6282 @node Archive,  , Expire, Expire and Archive
6283 @section Archiving Messages
6285 @subsection Archiving Messages
6286 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
6287 folders.  If there are the archiving folders already, only new messages
6288 are appended.
6290 You can use @code{wl-archive-alist} in order to specify how messages are
6291 archived according to their folder names, as in @code{wl-expire-alist}.
6292 For example:
6294 @lisp
6295 @group
6296 (setq wl-archive-alist
6297       '(("^\\+tmp$"     wl-archive-date)
6298         ("^\\+outbox$"  wl-archive-number2)
6299         (".*"           wl-archive-number1)))
6300 @end group
6301 @end lisp
6303 Each item in the list has the following format:
6305 @example
6306 (@var{folders-regexp}  @var{deleting-function})
6307 @end example
6309 As you can see, you can only use a function after @var{folders-regexp}.
6310 Per default, there are three functions:
6312 @itemize @bullet
6313 @item @code{wl-archive-number1}
6314 @item @code{wl-archive-number2}
6315 @item @code{wl-archive-date}
6316 @end itemize
6318 As inferred from their names, they work similarly to "expire" versions,
6319 other than the following points:
6321 @itemize @minus
6322 @item No messages are deleted
6323 @item Message numbers are retained even if invoked without arguments
6324 @end itemize
6326 These functions are good to archive all messages in a folder by their
6327 numbers or by their dates.
6328 These are also useful for backup or confirmation purposes before
6329 expiration.
6330 If you try to re-file them after they are archived, they are deleted but
6331 not re-filed.
6333 Per default, the archiving folders to which messages are copied are
6334 determined automatically by @code{wl-expire-archive-get-folder-function}.
6335 You can copy to a specific folder by invoking with a prefix argument,
6336 i.e. @kbd{C-u M-x wl-summary-archive}.
6338 Note that this feature has not been seriously tested, because you can
6339 simply copy to an archiving folder, for example by
6340 @code{wl-summary-copy-region}.
6342 The archiving folders are determined by the same logic as in
6343 @code{wl-summary-expire}; the following customizable variables are
6344 relevant:
6346 @itemize @bullet
6347 @item @code{wl-expire-archive-files}
6348 @item @code{wl-expire-archive-get-folder-function}
6349 @item @code{wl-expire-archive-folder-name-fmt}
6350 @item @code{wl-expire-archive-folder-type}
6351 @item @code{wl-expire-archive-folder-prefix}
6352 @item @code{wl-expire-archive-folder-num-regexp}
6353 @end itemize
6355 @subsection Customizable Variables
6357 @table @code
6358 @item wl-archive-alist
6359 @vindex wl-archive-alist
6360 The initial setting is the list shown below:
6362 @lisp
6363 @group
6364 ((".*" wl-archive-number1))
6365 @end group
6366 @end lisp
6368 @noindent
6369 This variable specifies a function that copies to archiving folders.
6370 To the function, three arguments are passed: a folder name, a list of
6371 messages in the folder, and msgdb information of the summary.
6372 Needless to say, you can use your own function.
6373 @end table
6376 @node Scoring, Address Book, Expire and Archive, Top
6377 @chapter Score of the Messages
6378 @cindex Scoring
6379 @c @cindex Kill File
6381 Scoring is the function that associates a score (value) with each
6382 message, and marks as read or deletes from the summary according to it.
6384 You can put target or important marks on essential messages, or read marks
6385 on the ones you do not want to read, for example spam articles.
6387 This scoring function has a capability and a format similar to the one
6388 that Gnus has, although there are some unsupported features and
6389 Wanderlust specifics.
6390 @xref{Scoring, , ,gnus, The gnus Newsreader}.
6392 @menu
6393 * Score Commands::             Score Commands
6394 * Score File Format::          Score File Format
6395 @end menu
6398 @node Score Commands, Score File Format, Scoring, Scoring
6399 @section Score Commands
6400 @cindex Score Commands
6402 @subsection Score File Specification
6404 @code{wl-score-folder-alist} specifies score files or variables in which
6405 scores are defined, corresponding to folder names.
6407 @lisp
6408 @group
6409 (setq wl-score-folder-alist
6410       '(("^-.*"
6411          "news.SCORE"
6412          "my.SCORE")
6413         (".*"
6414          "all.SCORE")))
6415 @end group
6416 @end lisp
6418 If paths to the score files are omitted, the directory specified in the
6419 variable @code{wl-score-files-directory} is assumed.
6421 No matter what you write in @code{wl-score-folder-alist}, the default
6422 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
6423 read (it does not have to exist).
6424 Therefore, in the example above, the three score files,
6425 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
6426 the folders that matches @samp{^-.*}.
6428 @subsection Scored Messages
6430 Scores are attached to the messages that are specified by
6431 @code{wl-summary-score-marks} temporarily when the summary is updated;
6432 when you exit from the summary, the scores are removed and reverts to
6433 the defaults.
6435 @subsection Creation of Score Files
6437 In the summary buffer, move to an appropriate message and type @kbd{L}.
6438 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
6439 The string in Subject is presented.  Edit it and press @kbd{@key{RET}}.
6441 This makes @minus{}1000 are scored for messages with the same
6442 @samp{Subject:} as the string you entered.  That is, such a score file
6443 is created automatically.
6445 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
6446 The score file you just made appears.
6447 This buffer is called @dfn{score editing buffer} thereafter.
6448 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
6449 as you are previously; type @kbd{a}.  Then a score entry for "From"
6450 should be inserted.
6451 In this way, you can create a score file easily either in the summary
6452 buffer or in the score editing buffer.
6454 By the way, you might be aware the numbers of key strokes are different
6455 between @kbd{s s p} and @kbd{a}.
6456 This is determined by @code{wl-score-header-default-entry}.
6457 This variable specifies the default score entries corresponding to
6458 header fields.
6459 For example, for "subject" field, a type and a time limit are prompted,
6460 but for "from" field, they are fixed upon automatically as substring and
6461 permanent respectively.
6462 However, score values can be modified by the prefix argument.
6463 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
6464 headers and types.
6466 At last, type @kbd{C-c C-c} in the score editing buffer.  This saves the
6467 score file and terminates the edit mode.  Typing @kbd{C-c C-c} after
6468 erasing contents of the buffer deletes the score file being edited.
6470 @subsection Tips
6472 @subsubsection Selecting Score Files
6474 You can change score files to which scores are appended by
6475 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
6476 @code{wl-score-change-score-file}.
6478 @subsubsection Summing Up the Score
6480 If you add the same entries by @code{wl-summary-increase-score},
6481 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
6482 scores for the entry is summed up.
6484 For example, if you create @samp{from} entry with the score of @minus{}1000 by
6485 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
6486 @minus{}1200 will be created as a result.
6488 @subsubsection Creating Thread Key
6490 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
6491 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
6493 @subsubsection Creating Followup Key
6495 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
6496 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
6497 at the cursor to @samp{References} key.
6498 If @code{wl-score-auto-make-followup-entry} is non-nil,
6499 @samp{Message-ID} of all messages to be followed up within dates
6500 specified by @code{wl-score-expiry-days}.
6502 @subsection Key Bindings
6504 @table @kbd
6505 @item K
6506 @kindex K (Summary)
6507 @findex wl-summary-increase-score
6508 Increases the score for the current message.
6509 And the score entry is appended to the score file at the same moment.
6510 You can specify the score value by a prefix argument.
6512 @item L
6513 @kindex L (Summary)
6514 @findex wl-summary-lower-score
6515 Decreases the score for the current message.
6516 And the score entry is appended to the score file at the same moment.
6517 You can specify the score value by a prefix argument.
6519 @item h R
6520 @kindex h R (Summary)
6521 @findex wl-summary-rescore
6522 Re-applies the scoring.
6523 However, already scored messages are not scored anew.
6525 @item h c
6526 @kindex h c (Summary)
6527 @findex wl-score-change-score-file
6528 Changes the score file currently selected.
6530 @item h e
6531 @kindex h e (Summary)
6532 @findex wl-score-edit-current-scores
6533 Edits the score file currently selected.
6534 If there are multiple score files, the previously specified one is
6535 selected.
6537 @item h f
6538 @kindex h f (Summary)
6539 @findex wl-score-edit-file
6540 Edits an arbitrary score file and selects it.
6542 @item h F
6543 @kindex h F (Summary)
6544 @findex wl-score-flush-cache
6545 Erases caches associated to the score files that are read.
6546 If you modified score files directly (from other than Wanderlust), you
6547 need to re-read them after erasing the cache.
6549 @item h m
6550 @kindex h m (Summary)
6551 @findex wl-score-set-mark-below
6552 Specifies the criterion for scores to be marked as read.
6553 Messages with scores less than this value are marked as read.
6555 @item h x
6556 @kindex h x (Summary)
6557 @findex wl-score-set-expunge-below
6558 Specifies the criterion for scores to be deleted from the summary.
6559 Messages with scores less than this value are deleted.
6560 "Deleted" means it is not shown; they are not removed from the summary
6561 information or the folder.
6562 The deleted messages can be shown by rescan-noscore again.
6563 @end table
6565 @subsection Key Bindings in the Score Editing Buffer
6567 @table @kbd
6568 @item C-c C-k
6569 @kindex C-c C-k (Score Mode)
6570 @findex wl-score-edit-kill
6571 Abandons the file being edited.
6573 @item C-c C-c
6574 @kindex C-c C-c (Score Mode)
6575 @findex wl-score-edit-exit
6576 Saves the file being edited, and quits from the edit mode.
6578 @item C-c C-p
6579 @kindex C-c C-p (Score Mode)
6580 @findex wl-score-pretty-print
6581 Re-draws the score.
6583 @item C-c C-d
6584 @kindex C-c C-d (Score Mode)
6585 @findex wl-score-edit-insert-date
6586 Inserts the number of dates from Dec. 31, 1 B.C.
6587 It is used for creating the third factor of time-limited scores.
6589 @item C-c C-s
6590 @kindex C-c C-s (Score Mode)
6591 @findex wl-score-edit-insert-header
6592 Inserts the header of the message selected in the summary buffer.
6594 @item C-c C-e
6595 @kindex C-c C-e (Score Mode)
6596 @findex wl-score-edit-insert-entry
6597 Inserts the score entry of the message selected in the summary buffer.
6598 @end table
6600 @subsection Customizable Variables
6602 @table @code
6603 @item wl-summary-default-score
6604 @vindex wl-summary-default-score
6605 The initial setting is 0 (zero).
6606 This variable specifies the default value of the score.
6607 The score is increased or decreased based upon this value.
6609 @item wl-summary-important-above
6610 @vindex wl-summary-important-above
6611 The initial setting is @code{nil}.
6612 Messages with scores larger than this value are attached with the
6613 important mark (@samp{$}).
6614 If @code{nil}, no important marks are attached.
6616 @item wl-summary-target-above
6617 @vindex wl-summary-target-above
6618 The initial setting is @code{nil}.
6619 Messages with scores larger than this value are attached with the target
6620 mark (@samp{*}).
6621 If @code{nil}, no target marks are attached.
6623 @item wl-summary-mark-below
6624 @vindex wl-summary-mark-below
6625 The initial setting is 0 (zero).
6626 Messages with scores smaller than this value are marked as read.
6628 @item wl-summary-expunge-below
6629 @vindex wl-summary-expunge-below
6630 The initial setting is @code{nil}.
6631 Messages with scores smaller than this value are deleted from the
6632 summary.
6633 If @code{nil}, they are not deleted.
6635 @item wl-summary-score-marks
6636 @vindex wl-summary-score-marks
6637 The initial setting is the list shown below:
6639 @lisp
6640 @group
6641 (list wl-summary-new-uncached-mark
6642       wl-summary-new-cached-mark)
6643 @end group
6644 @end lisp
6646 @noindent
6647 Messages with these marks are scored.
6649 @item wl-use-scoring
6650 @vindex wl-use-scoring
6651 The initial setting is t.
6652 If non-nil, scoring is enabled.
6654 @item wl-score-files-directory
6655 @vindex wl-score-files-directory
6656 The initial setting is @file{~/.elmo/}.
6657 The default directory for score files.
6659 @item wl-score-interactive-default-score
6660 @vindex wl-score-interactive-default-score
6661 The initial setting is 1000.
6662 This value is used as a score when a score factor is @code{nil} in the
6663 score file.  It is also used in @code{wl-summary-increase-score} and
6664 @code{wl-summary-lower-score}, on condition that the value of
6665 @code{wl-score-header-default-entry} is @code{nil}.
6667 @item wl-score-expiry-days
6668 @vindex wl-score-expiry-days
6669 The initial setting is 7.
6670 This is the number of days before time-limited scores are deleted.
6672 @item wl-score-update-entry-dates
6673 @vindex wl-score-update-entry-dates
6674 The initial setting is @code{t}.
6675 If non-nil, it enables deletion of time-limited scores.
6677 @item wl-score-header-default-entry
6678 @vindex wl-score-header-default-entry
6679 Specifies the default value for each header field for score entries
6680 created by @code{wl-summary-increase-score},
6681 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6683 @item wl-score-simplify-fuzzy-regexp
6684 @vindex wl-score-simplify-fuzzy-regexp
6685 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6686 regular expression to be deleted from the string.
6687 Because this is usually used for Subject, the default is prefixes that
6688 are attached by mailing list programs.
6690 @item wl-summary-rescore-partial-threshold
6691 @vindex wl-summary-rescore-partial-threshold
6692 The initial setting is 200.
6693 When sync-all or rescan is executed, if there are messages more than
6694 this value, only the last same number of messages as this value are
6695 scored.
6697 @item wl-summary-auto-sync-marks
6698 @vindex wl-summary-auto-sync-marks
6699 If non-nil, unread/important marks are synchronized when the summary
6700 does.
6701 Unread marks reflect information on the IMAP4 server.
6702 Important marks reflect information on the IMAP4 server (flagged or
6703 not), and contents of @samp{'flag} folder.
6704 The initial setting is @code{t}.
6705 @end table
6708 @node Score File Format,  , Score Commands, Scoring
6709 @section Score File Format
6710 @cindex Score File Format
6712 The format of score files are the same as Gnus, and basically you can
6713 use Gnus score files as they are.  But they are not fully compatible
6714 because some keys are not supported and there are Wanderlust specifics.
6715 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6717 @lisp
6718 @group
6719 (("subject"
6720   ("for sale" -1000 nil s)
6721   ("profit" -1000 nil s))
6722  ("from"
6723   ("spam@@spamspamspam" -10000 nil s))
6724  ("followup"
6725   ("my@@address" 3001 nil s))
6726  ("chars"
6727   (1000000 -10 nil >))
6728  (important 5000)
6729  (target 3000)
6730  (mark 0)
6731  (expunge -3000))
6732 @end group
6733 @end lisp
6735 @table @code
6736 @item string
6737 If the key is a string, it is the name of the header to be matched.
6738 The following keys are available:
6739 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6740 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6741 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6742 @code{Chars} and @code{Lines} mean the size and the number of lines of
6743 the message, respectively.  @code{Extra}, @code{Followup}, @code{Thread}
6744 are described later.
6745 The rest corresponds the field of the same name.
6747 Arbitrary numbers of core entries are specified after the key.
6748 Each score entry consists of these five factors:
6750 @enumerate
6751 @item
6752 A factor that matches header.  This should be a number in the cases of
6753 @code{lines} and @code{chars}, otherwise a string.
6755 @item
6756 A score factor.  When the first item matches, the score of the message
6757 is increased or decreased by this value.
6759 @item
6760 A time limiting factor.  If @code{nil}, the score is permanent, and in the case
6761 of a number, the score is deleted if it does not match for days
6762 (@code{wl-score-expiry-days}) from the date specified by this.
6763 The date is since Dec. 31, 1 B.C.
6765 @item
6766 A type factor.  This specifies the way the first factor matches.
6767 Available types depend on keys.
6769 @table @dfn
6770 @item From, Subject, References, Message-ID
6771 For these keys in string, @code{r} and @code{R} (regexp),
6772 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6773 as well as @code{f} and @code{F} (fuzzy) can be used.
6774 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6776 @item Lines, Chars
6777 For these keys, the following five numerical relative operators can be
6778 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6780 @item Followup
6781 This key matches @code{From} header, and scores all follow-ups to the
6782 message.
6783 For example, it would be useful for increasing scores for follow-ups to
6784 you own article.
6786 You can use the same types as @code{From} except for @code{f}.
6787 And a @samp{Followup} entry is automatically appended to the score file.
6789 @item Thread
6790 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6791 A @samp{Thread} entry is automatically appended for each article that
6792 has @var{x} in the @code{References} header.
6793 You can make sure the whole thread including messages that does not have
6794 all ancestors @code{Message-ID} in @code{References} is scored.
6796 You can use the same types as @code{References} except for @code{f}.
6797 And a @samp{Thread} entry is automatically appended to the score file.
6798 @end table
6800 @item
6801 A factor for extension header.  This is meaningful only if the key is
6802 @code{Extra}.
6803 This specifies headers to be matched other than standard headers like
6804 @code{Subject} and @code{From}.
6805 Note that you should specify the header in
6806 @code{elmo-msgdb-extra-fields} also.
6807 Therefore it does not work in folders where extension headers cannot be
6808 retrieved.
6810 @end enumerate
6812 The sum of these scores @emph{after all factors are applied} becomes the
6813 score of the message.
6815 @cindex Score File Atoms
6816 @item mark
6817 Messages with a score less than this value is marked as read.
6818 The default is @code{wl-summary-mark-below}.
6820 @item expunge
6821 Messages with a score less than this value is deleted from the summary.
6822 The default is @code{wl-summary-expunge-below}.
6824 @item mark-and-expunge
6825 Both @code{mark} and @code{expunge} are applied,
6826 i.e. messages with a score less than this value is marked as read and
6827 deleted from the summary.
6829 @item target
6830 Messages with a score greater than this value is attached with temp
6831 marks.
6832 The default is @code{wl-summary-target-above}.
6834 @item important
6835 Messages with a score greater than this value is attached with important
6836 marks.
6837 The default is @code{wl-summary-important-above}.
6838 @end table
6840 @subsection Caveats
6842 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6843 are used, you need to set @code{elmo-msgdb-extra-fields}.
6845 @lisp
6846 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6847 @end lisp
6849 There are other restrictions as shown below:
6851 @itemize @bullet
6852 @item Because @samp{References} field in the summary information
6853 contains only the last @samp{Message-ID}, @code{references} key matches
6854 the last one only.
6855 @end itemize
6857 Keys that can be seen by folder of types:
6859 @example
6860 @group
6861                         chars lines xref  extra
6862 localdir,localnews        Y     E     E     E
6863 nntp (supporting xover)   Y     E     E     N
6864      (otherwise)          N     E     E     E
6865 imap4                     Y     E     E     E
6866 pop3                      N     E     E     E
6868                 Y: can be seen
6869                 N: cannot be seen (ignored)
6870                 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6871 @end group
6872 @end example
6875 @node Address Book, Spam Filter, Scoring, Top
6876 @chapter Address Book
6877 @cindex Address Book
6879 With address book, you can utilize address completion, and you have
6880 summary displayed with nicknames.
6882 @menu
6883 * Mail Addresses::   Definition of Address Book
6884 * Address Manager::  Address Manager
6885 @end menu
6888 @node Mail Addresses, Address Manager, Address Book, Address Book
6889 @section Address book
6890 @cindex Address book Definition
6891 @cindex .addresses
6892 @cindex Alias, Address
6894 The file @file{~/.addresses} is a simple address book for Wanderlust.
6895 Make address file @file{~/.addresses}, and edit to suit your requirement.
6897 The data written in @file{~/.addresses} are used for address completion
6898 under draft editing mode. Furthermore, they are used when showing names
6899 in summary display mode. You can safely skip this section, if you don't
6900 want to customize address completion and summary display.
6901 It is possible to add/change/remove addresses from @file{~/.addresses} in
6902 summary buffer after Wanderlust is invoked. @refill
6904 The format is very simple. Like this. @refill
6906 @example
6907 @group
6909 # @r{Lines begin with @samp{#} are comment.}
6910 # @r{Empty lines are ignored}
6912 # @r{Format of each line:}
6913 # @var{email-address}  "@var{nickname} "@var{realname}"
6915 teranisi@@gohome.org            "Yuuichi"      "Yuuichi Teranishi"
6916 foo@@bar.gohome.org             "Mr. Foo"    "John Foo"
6917 bar@@foo.gohome.org             "Mr. Bar"    "Michael Bar"
6918 @end group
6919 @end example
6921 @noindent
6922 One line defines one persons description.
6924 Actually, in default setup, @var{nickname} is used in summary-mode and
6925 @var{realname} is used in draft preparation mode. This behavior is
6926 better understood if you try it and confirmed the function first. You
6927 can write and try a small definition, so you will know the idea of the
6928 address book before writing a big one.
6930 And, if MH alias file is specified in variable @code{wl-alias-file},
6931 it is used as an address information in the draft preparation mode.
6933 If variable @code{wl-use-ldap} is non-nil (initial setting is
6934 @code{nil}), address completion in draft mode uses LDAP information.
6936 If you use LDAP, you have to set @code{wl-ldap-server},
6937 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6938 not have LDAP feature as built-in feature (Currently only XEmacs can
6939 have built-in LDAP feature), you have to set command exec @env{PATH} to
6940 the program @command{ldapsearch}.
6943 @node Address Manager,  , Mail Addresses, Address Book
6944 @section Address Manager
6945 @cindex Address Manager
6947 You can type @kbd{C-c C-a} to enter address manger mode.  you can edit
6948 the address book and insert address to draft buffer.
6950 @subsection Key Bindings
6952 @table @kbd
6953 @item t
6954 @kindex t (Address Manager)
6955 @findex wl-addrmgr-set-to
6956 Add @samp{To:} mark.
6958 @item c
6959 @kindex c (Address Manager)
6960 @findex wl-addrmgr-set-cc
6961 Add @samp{Cc:} mark.
6963 @item b
6964 @kindex b (Address Manager)
6965 @findex wl-addrmgr-set-bcc
6966 Add @samp{Bcc:} mark.
6968 @item u
6969 @kindex u (Address Manager)
6970 @findex wl-addrmgr-unmark
6971 Cancel the mark.
6973 @item x
6974 @kindex x (Address Manager)
6975 @findex wl-addrmgr-apply
6977 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6978 buffer and quit address manager.  When no draft buffer, make new draft
6979 with insert marked addresses.
6981 If no mark, quit address manager.
6984 @item q
6985 @kindex q (Address Manager)
6986 @findex wl-addrmgr-quit
6987 Quit address manager.
6989 @item a
6990 @kindex a (Address Manager)
6991 @findex wl-addrmgr-add
6992 Add new entry.
6994 @item d
6995 @kindex d (Address Manager)
6996 @findex wl-addrmgr-delete
6997 Delete entry.
6999 @item e
7000 @kindex e (Address Manager)
7001 @findex wl-addrmgr-edit
7002 Edit entry.
7003 @end table
7006 @node Spam Filter, Advanced Issues, Address Book, Top
7007 @chapter Spam Filter
7008 @cindex Spam Filter
7010 @code{wl-spam} provides an frontend to external spam filtering programs.
7011 You can register to or judge spam by the filtering program cooperateing
7012 with messages operations on Wanderlust.
7014 @menu
7015 * Usage of Spam Filter::        Usage of Spam Filter
7016 * Spam Filter Processors::      Supported spam filters
7017 @end menu
7019 @node Usage of Spam Filter, Spam Filter Processors, Spam Filter, Spam Filter
7020 @section Usage of Spam Filter
7022 @subsection Initial Setting
7024 To use @code{wl-spam}, write in @file{~/.wl} as follows:
7026 @lisp
7027 @group
7028 ;; @r{Use @samp{bogofilter} as spam back end}
7029 ;; @r{Set @samp{scheme} here as the spam filter you will use.}
7030 ;; @r{@xref{Spam Filter Processors}.}
7031 (setq elmo-spam-scheme 'bogofilter)
7032 (require 'wl-spam)
7033 @end group
7034 @end lisp
7036 @subsection spam mark
7038 The spam mark (@samp{s}) will be provided as new temporary mark.
7039 Messages marked by this will be refiled into @code{wl-spam-folder} when
7040 the action is called for execution. Marked messages will be skipped by
7041 summary walking in ordinary way.
7043 The spam mark is be put on by spam judgement described later, or by
7044 invoking @kbd{k m} at any time.
7046 @subsection spam judgment
7048 You can judge spam messages by following ways:
7050 @enumerate
7051 @item
7052 Make judgement on execution of auto-refile.
7054 Insert @code{wl-refile-guess-by-spam} to arbitrary position in
7055 @code{wl-auto-refile-guess-functions} as follows.
7057 @lisp
7058 @group
7059 (setq wl-auto-refile-guess-functions
7060       '(wl-refile-guess-by-rule
7061         wl-refile-guess-by-spam))
7062 @end group
7063 @end lisp
7065 In this example, judge spam if it could not decide refile destination by
7066 @code{wl-refile-rule-alist}.
7068 @item
7069 Make judgement on entering the summary of specified folder.
7071 Specify the value of @code{wl-spam-auto-check-folder-regexp-list}
7072 as the list of regular expressions for folder names to be
7073 automatically judged by spam filter.
7075 @lisp
7076 (setq wl-spam-auto-check-folder-regexp-list '("\\+inbox"))
7077 @end lisp
7079 In this example, judgement will be processed when you enter summary of
7080 the folder whose name contains @samp{+inbox}.
7082 @item
7083 Make judgement on splitting messages with @code{elmo-split}.
7085 It provides new function @code{spam-p} to be specified as @samp{CONDITION}
7086 in @code{elmo-split-rule}. This function returns true when the message
7087 is judged as spam.
7088 @xref{Split messages}.
7090 You can also process learning by the result of judgement. (You would
7091 better turn on this feature after learning to some extent)
7093 Example follows:
7095 @lisp
7096 @group
7097 (setq elmo-split-rule
7098       '(((spam-p) "+spam")
7099         ;; @r{to learn by the judgement, use following instead}
7100         ;((spam-p :register t) "+spam")
7101         (t "+inbox"))
7102 @end group
7103 @end lisp
7104 @end enumerate
7106 @subsection spam learning
7108 @code{wl-spam} automatically learn spam with refiling messages.
7110 At first, @code{wl-spam} classifies the folders controlled by Wanderlust
7111 into following 4 domains by the class of containig messages
7113 @table @samp
7114 @item spam
7115 Folders containing messages judged as spam.
7116 (The folder specified by @code{wl-spam-folder})
7117 @item good
7118 Folders containing messages judged as non-spam.
7119 @item undecide
7120 Folders containing messages not yet judged. Folders without
7121 pre-distribution may belong to this domain e.g. @samp{+inbox}.
7122 (specified by @code{wl-spam-undecided-folder-regexp-list})
7123 @item ignored
7124 Foldes have nothing to do with spam processing e.g.
7125 @code{wl-trash-folder} or @code{wl-draft-folder}. (specified by
7126 @code{wl-spam-ignored-folder-regexp-list})
7127 @end table
7129 When you refile messages across different domains, it automatically
7130 learn messages as @samp{spam} or @samp{non-spam} according to domains
7131 it belongs before and after.
7133 To put it concretely, it will learn by following rule:
7135 @table @samp
7136 @item undecide -> spam
7137 learn as spam.
7138 @item good -> spam
7139 learn as spam and cancel previous study as non-spam.
7140 @item undecide -> good
7141 learn as non-spam.
7142 @item spam -> good
7143 learn as non-spam and cancel previous study as spam.
7144 @end table
7146 It do not learn anything in other cases.
7148 @subsection Key Bindings
7149 @cindex Keybind, spam filter
7151 @table @kbd
7152 @item k m
7153 @kindex k m (Summary)
7154 @findex wl-summary-spam
7155 Put spam mark (@samp{s}) on current message.
7157 @item k c
7158 @kindex k c (Summary)
7159 @findex wl-summary-test-spam
7160 Test current message and put spam mark if judged as spam.
7162 @item k C
7163 @kindex k C (Summary)
7164 @findex wl-summary-mark-spam
7165 Test messages with the mark in @code{wl-spam-auto-check-marks},
7166 and put spam mark if judged as spam. If it is called with prefix
7167 argument, test all messages regardless of their marks.
7169 @item k s
7170 @kindex k s (Summary)
7171 @findex wl-summary-register-as-spam
7172 Register current message as spam.
7174 @item k S
7175 @kindex k S (Summary)
7176 @findex wl-summary-register-as-spam-all
7177 Register all messages in the folder as spam.
7179 @item k n
7180 @kindex k n (Summary)
7181 @findex wl-summary-register-as-good
7182 Register current message as non-spam.
7184 @item k N
7185 @kindex k N (Summary)
7186 @findex wl-summary-register-as-good-all
7187 Register all messages in the folder as non-spam.
7189 @item r k m
7190 @kindex r k m (Summary)
7191 @findex wl-summary-spam-region
7192 Put spam mark on messages in the specified region.
7194 @item r k c
7195 @kindex r k c (Summary)
7196 @findex wl-summary-test-spam-region
7197 Test messages in the specified region and put spam mark if judged as spam.
7199 @item t k m
7200 @kindex t k m (Summary)
7201 @findex wl-thread-spam
7202 Put spam mark on messages which are the descendant of the current thread.
7203 With prefix argument, it affects on the all messages in the thread tree.
7205 @item t k c
7206 @kindex t k c (Summary)
7207 @findex wl-thread-test-spam
7208 Test messages which are the descendant of the current thread and put spam mark
7209 if judged as spam.  With prefix argument, it affects on the all messages in
7210 the thread tree.
7212 @item m k
7213 @kindex m k (Summary)
7214 @findex wl-summary-target-mark-spam
7215 Put spam mark (@samp{s}) on messages with the target mark @samp{*}.
7217 @item m s
7218 @kindex m s (Summary)
7219 @findex wl-summary-target-mark-register-as-spam
7220 Register messages with the target mark @samp{*} as spam.
7222 @item m n
7223 @kindex m n (Summary)
7224 @findex wl-summary-target-mark-register-as-good
7225 Register messages with the target mark @samp{*} as non-spam.
7226 @end table
7228 @subsection Customizable Variables
7230 @table @code
7231 @item wl-spam-folder
7232 @vindex wl-spam-folder
7233 Specify the name of destination folder for the spam messages.
7234 The initial setting is @samp{+spam}.
7236 @item wl-spam-undecided-folder-regexp-list
7237 @vindex wl-spam-undecided-folder-regexp-list
7238 Specify the list of regexp of folder names which contain messages
7239 not yet decided as spam or non-spam.
7240 The initial setting is @code{'("inbox")}.
7242 @item wl-spam-ignored-folder-regexp-list
7243 @vindex wl-spam-ignored-folder-regexp-list
7244 The initial setting is as follows.
7246 @lisp
7247 @group
7248 (list (regexp-opt (list wl-draft-folder
7249                         wl-trash-folder
7250                         wl-queue-folder)))
7251 @end group
7252 @end lisp
7254 Folders of no effect against spam judgement, specified by the list of
7255 folder name regular expressions.
7257 @item wl-spam-auto-check-folder-regexp-list
7258 @vindex wl-spam-auto-check-folder-regexp-list
7259 Folders to make spam judgement on entering the summary of them,
7260 specified by the list of folder name regular expressions.
7261 The initial setting is @code{nil}.
7263 @item wl-spam-auto-check-marks
7264 @vindex wl-spam-auto-check-marks
7265 The initial setting is the following list:
7267 @lisp
7268 @group
7269 (list wl-summary-new-uncached-mark
7270       wl-summary-new-cached-mark)
7271 @end group
7272 @end lisp
7274 Messages with mark specified by this variable will be processed
7275 by whole-folder judgement including auto test by
7276 @code{wl-spam-auto-check-folder-regexp-list}.
7277 Persistent marks can be used in this method, but temporary marks cannot.
7279 You can specify the list of marks as the initial setting, or you can
7280 specify follwing symbol:
7282 @table @code
7283 @item all
7284 Process all messages regardless of persistent marks.
7285 @end table
7286 @end table
7289 @node Spam Filter Processors,  , Usage of Spam Filter, Spam Filter
7290 @section Supported Spam Filters
7291 @cindex Spam Filter, Bogofilter
7292 @cindex Spam Filter, Spamfilter
7294 Supported spam filtering libraries are following ones.
7296 @menu
7297 * bogofilter::                          bogofilter
7298 * spamfilter::                          spamfilter.el
7299 * bsfilter::                            bsfilter
7300 * SpamAssassin::                        SpamAssassin
7301 * SpamOracle::                          SpamOracle
7302 * Regular Expressions Header Matching:: Header regexp
7303 @end menu
7306 @node bogofilter, spamfilter, Spam Filter Processors, Spam Filter Processors
7307 @subsection bogofilter
7308 @cindex bogofilter
7310 bogofilter (@uref{http://bogofilter.sourceforge.net/}) is a spam filter
7311 implemented by C language.
7313 To use spam filter with bogofilter, write following setting in
7314 @file{~/.wl} or somewhere else.
7316 @lisp
7317 @group
7318 (setq elmo-spam-scheme 'bogofilter)
7319 @end group
7320 @end lisp
7322 @subsubsection Customizable Variables
7324 @table @code
7325 @item elmo-spam-bogofilter-program
7326 @vindex elmo-spam-bogofilter-program
7327 The initial setting is @file{bogofilter}.
7328 Specify the name of executable of bogofilter. If the executable
7329 is not in your environmental variable @env{PATH}, you should
7330 set this by full path.
7332 @item elmo-spam-bogofilter-args
7333 @vindex elmo-spam-bogofilter-args
7334 The initial setting is @code{nil}.
7335 Specify arguments to be supplied for bogofilter executable.
7337 @item elmo-spam-bogofilter-database-directory
7338 @vindex elmo-spam-bogofilter-database-directory
7339 Specify the directory for statistical database to be used.
7340 @code{nil} to use default directory (@file{~/.bogofilter}).
7341 The initial setting is @code{nil}.
7343 @item elmo-spam-bogofilter-max-messages-per-process
7344 @vindex elmo-spam-bogofilter-max-messages-per-process
7345 The initial setting is 30.  This variable specifies the number of
7346 messages to be learned by one process.
7348 @item elmo-spam-bogofilter-debug
7349 @vindex elmo-spam-bogofilter-debug
7350 The initial setting is @code{nil}.
7351 If you specify non-nil, the output from @command{bogofilter} is
7352 stored in the buffer named @code{"*Debug ELMO SPAM Bogofilter*"}.
7353 @end table
7356 @node spamfilter, bsfilter, bogofilter, Spam Filter Processors
7357 @subsection spamfilter.el
7358 @cindex spamfilter
7360 @file{spamfilter.el}
7361 (@uref{http://www.geocities.co.jp/SiliconValley-PaloAlto/7043/}) is a
7362 spam filtering library implemented by Emacs Lisp.
7364 Corresponding modules will be compiled/installed, if you have
7365 @file{spamfilter.el} within @code{load-path} when you are to install wl.
7366 @xref{Install}.
7368 To use @file{spamfilter.el}, write following setting in @file{~/.wl} or
7369 somewhere else.
7370 (Of cource, you have to have settings for @file{spamfilter.el} itself)
7372 @lisp
7373 @group
7374 (setq elmo-spam-scheme 'spamfilter)
7375 @end group
7376 @end lisp
7378 @subsubsection Customizable Variables
7380 @table @code
7381 @item elmo-spam-spamfilter-corpus-filename
7382 @vindex elmo-spam-spamfilter-corpus-filename
7383 The initial setting is @file{~/.elmo/.spamfilter}.
7384 It specifies the name of corpus file.
7385 @end table
7387 @node bsfilter, SpamAssassin, spamfilter, Spam Filter Processors
7388 @subsection bsfilter
7389 @cindex bsfilter
7391 bsfilter (@uref{http://bsfilter.org/index-e.html}) is a spam filter
7392 implemented by Ruby language.
7394 To use spam filter with bsfilter, write following setting in
7395 @file{~/.wl} or somewhere else.
7397 @lisp
7398 @group
7399 (setq elmo-spam-scheme 'bsfilter)
7400 @end group
7401 @end lisp
7403 @subsubsection Customizable Variables
7405 @table @code
7406 @item elmo-spam-bsfilter-program
7407 @vindex elmo-spam-bsfilter-program
7408 The initial setting is @file{bsfilter}.
7409 Specify the name of executable of @command{bsfilter}.  If the executable
7410 is not in your environmental variable @env{PATH}, you should
7411 set this by full path.
7413 @item elmo-spam-bsfilter-args
7414 @vindex elmo-spam-bsfilter-args
7415 The initial setting is @code{nil}.
7416 Specify arguments to be supplied for bsfilter executable.
7418 @item elmo-spam-bsfilter-database-directory
7419 @vindex elmo-spam-bsfilter-database-directory
7420 Specify the directory for statistical database to be used.
7421 @code{nil} to use default directory (@file{~/.bsfilter}).
7422 The initial setting is @code{nil}.
7424 @item elmo-spam-bsfilter-debug
7425 @vindex elmo-spam-bsfilter-debug
7426 The initial setting is @code{nil}.
7427 If you specify non-nil, the output from @command{bsfilter} is
7428 stored in the buffer named @code{"*Debug ELMO Bsfilter*"}.
7430 @item elmo-spam-bsfilter-shell-program
7431 @vindex elmo-spam-bsfilter-shell-program
7432 The initial setting is @file{ruby}.
7433 Specify the shell to execute @command{bsfilter}.  If the shell is not
7434 in your environmental variable @env{PATH}, you should set this by full path.
7436 @item elmo-spam-bsfilter-shell-switch
7437 @vindex elmo-spam-bsfilter-shell-switch
7438 The initial setting is @code{nil}.
7439 Specify options to give to the shell executing @command{bsfilter}.
7441 @item elmo-spam-bsfilter-update-switch
7442 @vindex elmo-spam-bsfilter-update-switch
7443 The initial setting is @code{"--auto-update"}.
7444 Specify options to give to @command{bsfilter} for learning messages.
7446 @end table
7448 @node SpamAssassin, SpamOracle, bsfilter, Spam Filter Processors
7449 @subsection SpamAssassin
7450 @cindex SpamAssassin
7452 SpamAssassin (@uref{http://spamassassin.org/}) is one of the most
7453 popular spam filtering program implemented on Perl. SpamAssassin
7454 attempts to identify spam using text analysis and several internet-based
7455 realtime blacklists.  SpamAssassin also uses a Bayesian learning filter
7456 which enables more accurate spam filtering.
7458 To use @file{SpamAssassin} on Wanderlust, write following setting
7459 in @file{~/.wl} or somewhere else.
7460 (Of course, you have to install SpamAssassin beforehand.)
7462 @lisp
7463 @group
7464 (setq elmo-spam-scheme 'sa)
7465 @end group
7466 @end lisp
7468 @subsubsection Customize Variables
7470 @table @code
7471 @item elmo-spam-spamassassin-program
7472 @vindex elmo-spam-spamassassin-program
7473 The initial setting is @file{spamassassin}.
7474 Specify the name of executable @command{spamassassin}. If the executable
7475 is not in your environmental variable @env{PATH}, you should
7476 set this by full path.
7478 @item elmo-spam-spamassassin-learn-program
7479 @vindex elmo-spam-spamassassin-learn-program
7480 The initial setting is @file{sa-learn}.  
7481 Specify the name of the SpamAssassin's Bayesian filtering learner
7482 program, @command{sa-learn}. If the executable is not in your
7483 environmental variable @env{PATH}, you should set this by full path.
7485 @item elmo-spam-spamassassin-program-arguments
7486 @vindex elmo-spam-spamassassin-program-arguments
7487 The initial setting is @code{'("-e")}.
7488 Specify the arguments to be supplied for @command{spamassassin} executable.
7489 You have to specify the argument to exit the program with an error exit code
7490 when the result is spam. For example, if you want to use @command{spamc}
7491  instead of @command{spamassassin}, you should specify @code{'("-c")}.
7493 @item elmo-spam-spamassassin-learn-program-arguments
7494 @vindex elmo-spam-spamassassin-lern-program-arguments
7495 The initial setting is @code{nil}.
7496 Specify the arguments to be supplied for @command{sa-learn}.
7498 @item elmo-spamassassin-debug
7499 @vindex elmo-spamassassin-debug
7500 The initial setting is @code{nil}.
7501 If you specify @code{t}, the output from @command{spamassassin} is
7502 stored in the buffer named @code{"*Debug ELMO SpamAssassin*"}.
7504 @end table
7506 @node SpamOracle, Regular Expressions Header Matching, SpamAssassin, Spam Filter Processors
7507 @subsection SpamOracle
7508 @cindex SpamOracle
7510 SpamOracle (`http://pauillac.inria.fr/~xleroy/software.html#spamoracle')
7511 is a spam filter implemented by Objective Caml language.
7513 To use spam filter with @file{spamoracle}, write following setting in
7514 @file{~/.wl} or somewhere else.
7515 (Of course, you have to install SpamOracle beforehand.)
7517 @lisp
7518 @group
7519 (setq elmo-spam-scheme 'spamoracle)
7520 @end group
7521 @end lisp
7523 @subsubsection Customizable Variables
7525 @table @code
7526 @item elmo-spam-spamoracle-program
7527 @vindex elmo-spam-spamoracle-program
7528 The initial setting is @file{spamoracle}.  Specify the name of
7529 executable of spamoracle. If the executable is not in your
7530 environmental variable @env{PATH}, you should set this by full path.
7532 @item elmo-spam-spamoracle-config-filename
7533 @vindex elmo-spam-spamoracle-config-filename
7534 Specify the name of config file.  @code{nil} to use default file
7535 (@file{~/.spamoracle.conf}).  The initial setting is @code{nil}.
7537 @item elmo-spam-spamoracle-database-filename
7538 @vindex elmo-spam-spamoracle-database-filename
7539 The initial setting is @file{~/.elmo/.spamoracle.db}.
7540 It specifies the name of database file.
7542 @item elmo-spam-spamoracle-spam-header-regexp
7543 @vindex elmo-spam-spamoracle-spam-header-regexp
7544 The initial setting is @code{"^X-Spam: yes;"}.  It specifies the regular
7545 expression of the header that indicates spam mail.  Use this setting
7546 when you change the @code{spam_header} parameter in the config file.
7548 @end table
7550 @node Regular Expressions Header Matching,  , SpamOracle, Spam Filter Processors
7551 @subsection Regular Expressions Header Matching
7552 @cindex Regular Expressions Header Matching
7554 Examine if regular expression matches corresponding field in message heaeder,
7555 and decide spam or not. To use this backend, add following setting to @file{~/.wl}.
7557 @lisp
7558 @group
7559 (setq elmo-spam-scheme 'header)
7560 @end group
7561 @end lisp
7563 If you want to check fields not included in the default overview
7564 information, add one into @code{elmo-msgdb-extra-fields}. Then it will
7565 do examination by the overview information and avoid loading whole
7566 message body as far as possible.
7568 @subsubsection Customize Variables
7570 @table @code
7571 @item elmo-spam-header-good-alist
7572 @vindex elmo-spam-header-good-alist
7573 The initial setting is the following list:
7575 @lisp
7576 '(("X-Spam-Flag" . "No"))
7577 @end lisp
7579 Specify a list of regular expressions to match with header field name
7580 for making non-spam decision. It takes precedence over
7581 @code{elmo-spam-header-spam-alist}.
7583 @item elmo-spam-header-spam-alist
7584 @vindex elmo-spam-header-spam-alist
7585 The initial setting is the following list:
7587 @lisp
7588 '(("X-Spam-Flag" . "Yes"))
7589 @end lisp
7591 Specify a list of regular expressions to match with header field name
7592 for making spam decision.
7593 @end table
7596 @node Advanced Issues, Migration, Spam Filter, Top
7597 @chapter Advanced Issues
7598 @cindex Advanced Issues
7600 @menu
7601 * Living with other packages:: Cooperating with other packages
7602 * Highlights::                 Highlights
7603 * Biff::                       Notify Mail arrival
7604 * Password Management::        Manage Passwords
7605 * Split messages::             Splitting messages
7606 * Batch Processing::           Invoke commands in batch mode
7607 * Advanced Settings::          Advanced Settings
7608 * Customizable Variables::     Customizable Variables
7609 * Hooks::                      Hooks
7610 @end menu
7613 @node Living with other packages, Highlights, Advanced Issues, Advanced Issues
7614 @section Living with other packages
7616 Examples with other packages.
7618 @menu
7619 * imput::                       imput (im-wl.el)
7620 * BBDB::                        The Insidious Big Brother Database
7621 * LSDB::                        The Lovely Sister Database
7622 * supercite::                   supercite.el
7623 * mu-cite::                     mu-cite.el
7624 * X-Face::                      x-face,bitmap-mule
7625 * dired-dd::                    dired-dd.el
7626 * MHC::                         MHC
7627 * Addrbook::                    Addrbook
7628 * mime-w3m::                    mime-w3m.el
7629 @end menu
7632 @node imput, BBDB, Living with other packages, Living with other packages
7633 @subsection imput
7634 @pindex imput
7635 @cindex im-wl
7637 Place @file{util/im-wl.el} on the @code{load-path} and do the following
7638 settings.
7640 @lisp
7641 @group
7642 (autoload 'wl-draft-send-with-imput-async "im-wl")
7643 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
7644 @end group
7645 @end lisp
7648 @node BBDB, LSDB, imput, Living with other packages
7649 @subsection bbdb.el
7650 @pindex BBDB
7652 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
7653 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
7654 and do the following settings.
7656 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
7657 byte-compiled and installed.
7658 @xref{Install}.
7660 @lisp
7661 @group
7662 (require 'bbdb-wl)
7664 (bbdb-wl-setup)
7665 ;; @r{enable pop-ups}
7666 (setq bbdb-use-pop-up t)
7667 ;; @r{auto collection}
7668 (setq bbdb/mail-auto-create-p t)
7669 ;; @r{exceptional folders against auto collection}
7670 (setq bbdb-wl-ignore-folder-regexp "^@@")
7671 (setq signature-use-bbdb t)
7672 (setq bbdb-north-american-phone-numbers-p nil)
7673 ;; @r{shows the name of bbdb in the summary} :-)
7674 (setq wl-summary-from-function 'bbdb-wl-from-func)
7675 ;; @r{automatically add mailing list fields}
7676 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
7677 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
7678 @end group
7679 @end lisp
7681 You can complete address with BBDB by @kbd{M-@key{TAB}}
7682 in draft buffer.
7685 @node LSDB, supercite, BBDB, Living with other packages
7686 @subsection lsdb.el
7687 @pindex LSDB
7689 The following is an example setting to use
7690 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
7691 with Wanderlust.
7693 @lisp
7694 @group
7695 (require 'lsdb)
7696 (lsdb-wl-insinuate)
7697 (add-hook 'wl-draft-mode-hook
7698           (lambda ()
7699              (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
7700 @end group
7701 @end lisp
7703 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
7704 (complete address with LSDB).
7707 @node supercite, mu-cite, LSDB, Living with other packages
7708 @subsection sc.el(supercite), sc-register.el
7709 @pindex sc
7710 @pindex supercite
7712 The same setting as usual mailers should be OK.  The following is an
7713 example of settings:
7715 @lisp
7716 @group
7717 (autoload 'sc-cite-original "supercite" nil t)
7718 (add-hook 'mail-citation-hook 'sc-cite-original)
7719 @end group
7720 @end lisp
7723 @node mu-cite, X-Face, supercite, Living with other packages
7724 @subsection mu-cite.el
7725 @pindex mu-cite
7727 The same setting as usual mailers should be OK.  The following is an
7728 example of settings.
7730 If you use mu-cite version 8.0 or earlier:
7732 @lisp
7733 @group
7734 (autoload 'mu-cite/cite-original "mu-cite" nil t)
7735 (setq mail-citation-hook 'mu-cite/cite-original)
7736 @end group
7737 @end lisp
7739 If you use mu-cite version 8.1 or later:
7741 @lisp
7742 @group
7743 (autoload 'mu-cite-original "mu-cite" nil t)
7744 (add-hook 'mail-citation-hook (function mu-cite-original))
7745 @end group
7746 @end lisp
7748 @node X-Face, dired-dd, mu-cite, Living with other packages
7749 @subsection x-face
7750 @pindex x-face
7752 If you have installed one of the following, you can decode
7753 @samp{X-Face:} field in message buffer and you will see face image.
7755 @menu
7756 * x-face-xmas::                       XEmacs case
7757 * x-face-mule::                       Emacs case
7758 @end menu
7760 If there is an encoded X-Face string in a file @file{~/.xface} (the
7761 value of the variable @code{wl-x-face-file}), it is inserted as a
7762 @samp{X-Face:} field in the draft buffer (if
7763 @code{wl-auto-insert-x-face} is non-nil).
7765 @node x-face-xmas, x-face-mule, X-Face, X-Face
7766 @subsubsection x-face-xmas (for XEmacs)
7767 @pindex x-face-xmas
7769 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
7770 1.3.6.13 or later, do the following:
7772 @lisp
7773 @group
7774 (autoload 'x-face-xmas-wl-display-x-face "x-face")
7775 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
7776 @end group
7777 @end lisp
7779 @node x-face-mule,  , x-face-xmas, X-Face
7780 @subsubsection x-face-mule (for Emacs)
7781 @pindex x-face-mule
7782 @pindex bitmap-mule
7784 If you use @file{x-face-mule.el} in bitmap-mule
7785 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
7787 @lisp
7788 @group
7789 (autoload 'x-face-decode-message-header "x-face-mule")
7790 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7791 @end group
7792 @end lisp
7794 @subsubsection x-face-e21 (for Emacs 21.x)
7795 @pindex x-face-e21
7797 With Emacs 21.x, you can use @file{x-face-e21.el}
7798 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
7799 to display X-Face. In this case, bitmap-mule is not required.
7800 Do as follows:
7802 @lisp
7803 @group
7804 (autoload 'x-face-decode-message-header "x-face-e21")
7805 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
7806 @end group
7807 @end lisp
7810 @node dired-dd, MHC, X-Face, Living with other packages
7811 @subsection dired-dd(Dired-DragDrop)
7812 @pindex Dired-DragDrop
7813 @pindex Dired-DD
7814 @cindex Drag and Drop
7816 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
7817 compose multi-part by simple Drag-and-Drop from dired to the draft
7818 buffer being edited in GNU Emacs (this feature is not Wanderlust
7819 specific, but general-purpose for SEMI).
7821 @lisp
7822 @group
7823 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
7824 (add-hook
7825  'dired-load-hook
7826  (function
7827   (lambda ()
7828     (load "dired-x")
7829     ;; @r{Set dired-x variables here.}
7830     ;; @r{To and flo@dots{}}
7831     (if window-system
7832         (progn (require 'dired-dd)
7833                (require 'dired-dd-mime))))))
7834 @end group
7835 @end lisp
7837 @node MHC, Addrbook, dired-dd, Living with other packages
7838 @subsection mhc.el
7839 @pindex MHC
7841 Message Harmonized Calendaring system
7842 (@uref{http://www.quickhack.net/mhc/})
7844 By using MHC, you can make a calendar from the messages.
7846 For mhc-0.25:
7848 @lisp
7849 @group
7850 (setq mhc-mailer-package 'wl)
7851 (autoload 'mhc-mode "mhc" nil t)
7852 (add-hook 'wl-summary-mode-hook 'mhc-mode)
7853 (add-hook 'wl-folder-mode-hook 'mhc-mode)
7854 @end group
7855 @end lisp
7857 For mhc-current:
7859 @lisp
7860 @group
7861 (autoload 'mhc-wl-setup "mhc-wl")
7862 (add-hook 'wl-init-hook 'mhc-wl-setup)
7863 @end group
7864 @end lisp
7866 @node Addrbook, mime-w3m, MHC, Living with other packages
7867 @subsection wl-addrbook.el
7868 @pindex Addrbook
7870 Addrbook of Mew
7871 (@uref{http://www.mew.org/})
7873 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
7874 @code{load-path} and do the following settings.
7876 @lisp
7877 @group
7878 (require 'wl-addrbook)
7879 (wl-addrbook-setup)
7880 @end group
7881 @end lisp
7883 @node mime-w3m,  , Addrbook, Living with other packages
7884 @subsection mime-w3m.el
7885 @pindex mime-w3m
7887 You can display html part by using @file{mime-w3m.el}
7888 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
7889 You can find the usage in comment region at the head of @file{mime-w3m.el}.
7892 @node Highlights, Biff, Living with other packages, Advanced Issues
7893 @section Highlights
7895 @subsection Customizable Variables
7897 @table @code
7898 @item  wl-summary-highlight
7899 @vindex wl-summary-highlight
7900 The initial setting is @code{t}.
7901 If non-nil, the summary is highlighted.
7903 @item  wl-highlight-max-summary-lines
7904 @vindex wl-highlight-max-summary-lines
7905 The initial setting is 10000.
7906 The summary is not highlighted if it has more lines than this value.
7908 @item  wl-summary-highlight-partial-threshold
7909 @vindex wl-summary-highlight-partial-threshold
7910 The initial setting is 1000.
7911 This is a threshold whether the whole summary is highlighted.
7912 If there are more lines of messages in the summary, it is partially
7913 highlighted.
7915 @item  wl-summary-partial-highlight-above-lines
7916 @vindex wl-summary-partial-highlight-above-lines
7917 The initial setting is 30.  If there are more lines of messages than
7918 @code{wl-summary-highlight-partial-threshold} in the summary, messages
7919 after the point that is the same number of lines as this value above the
7920 cursor line are highlighted partially.  (If this value is @code{nil},
7921 the last same number of lines as the value of
7922 @code{wl-summary-highlight-partial-threshold} are highlighted.)
7924 @item wl-highlight-body-too
7925 @vindex  wl-highlight-body-too
7926 The initial setting is @code{t}.
7927 If non-nil, bodies of drafts and messages are also highlighted.
7929 @item  wl-highlight-message-header-alist
7930 @vindex wl-highlight-message-header-alist
7931 When highlighting headers of drafts and messages, this variable
7932 specifies which faces are allocated to important
7933 (@code{wl-highlight-message-important-header-contents}), secondly
7934 important (@code{wl-highlight-message-important-header-contents2}), and
7935 unimportant (@code{wl-highlight-message-unimportant-header-contents})
7936 message headers.
7937 Similarly, it can be used for allocating arbitrary faces to arbitrary
7938 regular expressions.
7940 @item wl-highlight-citation-prefix-regexp
7941 @vindex  wl-highlight-citation-prefix-regexp
7942 Specifies a regular expression to which quoted lines in bodies of
7943 drafts and messages match.
7944 Bodies matching to this regular expression are highlighted by the faces
7945 specified by (@code{wl-highlight-message-cited-text-*}).
7947 @item  wl-highlight-highlight-citation-too
7948 @vindex wl-highlight-highlight-citation-too
7949 The initial setting is @code{nil}.
7950 If non-nil, the quoting regular expression itself given by
7951 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
7953 @item  wl-highlight-citation-header-regexp
7954 @vindex wl-highlight-citation-header-regexp
7955 Specifies a regular expression that denotes beginning of quotation.
7956 Bodies matching to this regular expression are highlighted by the face
7957 specified by @code{wl-highlight-message-headers}.
7959 @item wl-highlight-max-header-size
7960 @vindex wl-highlight-max-header-size
7961 The initial setting is @code{nil}.  If a header size is larger than this
7962 value, it will not be highlighted.  If @code{nil}, always highlighted
7963 (ignore header size).
7965 @item  wl-highlight-max-message-size
7966 @vindex wl-highlight-max-message-size
7967 The initial setting is 10000.
7968 If a message is larger than this value, it will not be highlighted.
7969 With this variable, highlight is suppressed for uuencode or huge digest
7970 messages.
7972 @item  wl-highlight-signature-separator
7973 @vindex wl-highlight-signature-separator
7974 Specifies regular expressions that denotes the boundary of a signature.
7975 It can be a regular expression, or a list of ones.
7976 Messages after the place that matches this regular expression are
7977 highlighted by the face specified by
7978 @code{wl-highlight-message-signature}.
7980 @item  wl-max-signature-size
7981 @vindex wl-max-signature-size
7982 The initial setting is 400.
7983 This is the largest size for a signature to be highlighted.
7985 @item wl-use-highlight-mouse-line
7986 @vindex  wl-use-highlight-mouse-line
7987 The initial setting is @code{t}.
7988 If non-nil, the line pointed by the mouse is highlighted in the folder
7989 mode, summary mode, and the like.
7990 @end table
7992 @subsection Setting Colors and Fonts of the Characters
7994 If you want to change colors or fonts of the characters, you need to
7995 modify faces defined in Wanderlust.  Use @code{set-face-font} if you
7996 want to change fonts, and @code{set-face-foreground} for colors, and so
7997 on.  You cannot write face settings in @file{.emacs}; write in
7998 @file{~/.wl}.
8000 For example, if you want to change the color for signatures to yellow,
8001 write
8003 @lisp
8004 (set-face-foreground 'wl-highlight-message-signature "yellow")
8005 @end lisp
8007 @noindent
8008 in @file{~/.wl}.
8010 Faces defined in Wanderlust:
8012 @table @code
8013 @item wl-highlight-message-headers
8014 The face for field names of message headers.
8016 @item wl-highlight-message-header-contents
8017 The face for field bodies of message headers.
8019 @item wl-highlight-message-important-header-contents
8020 The face for important parts of message headers.
8021 Per default, this face is used for a body of @samp{Subject:} field.
8022 You can change its value by editing
8023 @code{wl-highlight-message-header-alist}.
8025 @item wl-highlight-message-important-header-contents2
8026 The face for secondly important parts of message headers.
8027 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
8028 fields.  You can change its value by editing
8029 @code{wl-highlight-message-header-alist}.
8031 @item wl-highlight-message-unimportant-header-contents
8032 The face for unimportant parts of message headers.
8033 Per default, this face is used for bodies of @samp{X-} fields
8034 @samp{User-Agent:} fields.  You can change its value by editing
8035 @code{wl-highlight-message-header-alist}.
8037 @item wl-highlight-message-citation-header
8038 The face for headers of quoted messages.
8040 @item wl-highlight-message-cited-text-*
8041 The face for texts of quoted messages.  The last @samp{*} is a
8042 @var{single figure} so that 10 different colors can be used according to
8043 citation levels.
8045 @item wl-highlight-message-signature
8046 The face for signatures of messages.  The initial settings are
8047 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
8048 dark background colors.
8050 @item wl-highlight-header-separator-face
8051 The face for header separators of draft messages.
8053 @item wl-highlight-summary-important-face
8054 The face for message lines with important marks in the summary.
8056 @item wl-highlight-summary-new-face
8057 The face for message lines with new marks in the summary.
8059 @item wl-highlight-summary-displaying-face
8060 The face for the message line that is currently displayed.
8061 This face is overlaid.
8063 @item wl-highlight-thread-indent-face
8064 The face for the threads that is currently displayed.
8066 @item wl-highlight-summary-unread-face
8067 The face for message lines with unread marks in the summary.
8069 @item wl-highlight-summary-deleted-face
8070 The face for message lines with delete marks in the summary.
8072 @item wl-highlight-summary-refiled-face
8073 The face for message lines with re-file marks in the summary.
8075 @item wl-highlight-refile-destination-face
8076 The face for re-file information part of message lines with re-file
8077 marks in the summary.
8079 @item wl-highlight-summary-copied-face
8080 The face for message lines with copy marks in the summary.
8082 @item wl-highlight-summary-target-face
8083 The face for message lines with target marks @samp{*} in the summary.
8085 @item wl-highlight-summary-thread-top-face
8086 The face for message lines that are on the top of the thread in the
8087 summary.
8089 @item wl-highlight-summary-normal-face
8090 The face for message lines that are not on top of the thread in the
8091 summary.
8093 @item wl-highlight-folder-unknown-face
8094 The face for folders that are not known to have how many unsync messages
8095 in the folder mode.
8097 @item wl-highlight-folder-zero-face
8098 The face for folders that have no unsync messages in the folder mode.
8100 @item wl-highlight-folder-few-face
8101 The face for folders that have some unsync messages in the folder mode.
8103 @item wl-highlight-folder-many-face
8104 The face for folders that have many unsync messages in the folder mode.
8105 The boundary between `some' and `many' is specified by the variable
8106 @code{wl-folder-many-unsync-threshold}.
8108 @item wl-highlight-folder-unread-face
8109 The face for folders that have no unsync but unread messages in the
8110 folder mode.
8112 @item wl-highlight-folder-killed-face
8113 The face for folders that are deleted from the access group in the
8114 folder mode.
8116 @item wl-highlight-folder-opened-face
8117 The face for open groups in the folder mode.
8118 It is meaningful when @code{wl-highlight-folder-by-numbers} is
8119 @code{nil} or a @var{number}.
8121 @item wl-highlight-folder-closed-face
8122 The face for close groups in the folder mode.
8123 It is meaningful when @code{wl-highlight-folder-by-numbers} is
8124 @code{nil} or a @var{number}.
8126 @item wl-highlight-folder-path-face
8127 The face for the path to the currently selected folder in the folder
8128 mode.
8130 @item wl-highlight-logo-face
8131 The face for logo in the demo.
8133 @item wl-highlight-demo-face
8134 The face for strings (for example, a version number) in the demo.
8135 @end table
8138 @node Biff, Password Management, Highlights, Advanced Issues
8139 @section Notify Mail arrival
8140 @cindex Biff
8142 Following setting is to notify mail arrival of @samp{%inbox}
8143 by the indicator on the modeline
8145 @lisp
8146 (setq wl-biff-check-folder-list '("%inbox"))
8147 @end lisp
8149 @subsection Customizable Variables
8150 @table @code
8151 @item wl-biff-check-folder-list
8152 @vindex wl-biff-check-folder-list
8153 The initial setting is @code{nil}.
8154 This is the list of folders to check mail arrival.
8155 If @code{nil}, wl doesn't check mail arrival.
8157 @item wl-biff-check-interval
8158 @vindex wl-biff-check-interval
8159 The initial setting is 40 (in seconds).
8160 Check mail arrival in this period.
8162 @item wl-biff-use-idle-timer
8163 @vindex wl-biff-use-idle-timer
8164 The initial setting is @code{nil}.
8165 If it is @code{nil}, check mail arrival when the time specified by
8166 @code{wl-biff-check-interval} has passed.  If it is non-nil, check
8167 mail arrival when idling time exceeds @code{wl-biff-check-interval}.
8169 @item wl-biff-notify-hook
8170 @vindex wl-biff-notify-hook
8171 This hook is run at the arrival of new mail.
8172 To beep with mail arrival(initial setting), set as follows.
8173 @lisp
8174 (setq wl-biff-notify-hook '(ding))
8175 @end lisp
8176 For silence, set to @code{nil}.
8177 @end table
8180 @node Password Management, Split messages, Biff, Advanced Issues
8181 @section Manage Passwords
8183 If you input passwords to connect servers, they are stored in the
8184 variable @code{elmo-passwd-alist} per connection. You should be careful
8185 that others might read your passwords if they can touch your Emacs,
8186 since encoded plain passwords are there.
8188 If you invoke @kbd{M-x elmo-passwd-alist-save} while you have stored
8189 passwords, then they are saved on the file, and it will save you to
8190 input passwords. In this case, the risk that someone reads your
8191 keystroke might decrease, but please not that plain passwords are
8192 stored on a file. You should treat them very carefully.
8193 To remove saved passwords on file, invoke @kbd{M-x elmo-passwd-alist-clear}
8194 and then @kbd{M-x elmo-passwd-alist-save}.
8196 @table @code
8197 @item elmo-passwd-alist-file-name
8198 @vindex elmo-passwd-alist-file-name
8199 The initial setting is @file{passwd}.
8200 This is the name of the file in which passwords are saved.
8201 @code{elmo-passwd-alist-save} saves current passwords to the file.
8203 @item elmo-passwd-life-time
8204 @vindex  elmo-passwd-life-time
8205 The initial setting is @code{nil}.
8206 If the value is some number, timer is set to remove password entry after
8207 @code{elmo-passwd-life-time} seconds since you input the password.
8208 @code{nil} means never to remove passwords.
8209 @end table
8212 @node Split messages, Batch Processing, Password Management, Advanced Issues
8213 @section Message splitting
8214 @cindex Split messages
8216 You can use @code{elmo-split} to split message in folder specified by
8217 the variable @code{elmo-split-folder} a la @command{procmail} according
8218 to some specified rules. To use this feature, set as follows in your
8219 @file{~/.emacs} at first.
8221 @lisp
8222 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
8223 @end lisp
8225 Set source folder like following.
8227 @lisp
8228 (setq elmo-split-folder "%inbox")
8229 @end lisp
8231 And specify the rule in the variable @code{elmo-split-rule} (its format
8232 will be is described below).
8233 Then you can invoke @kbd{M-x elmo-split} to split messages according to
8234 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
8235 to do a rehearsal and show result (do not split actually).
8238 We will describe how to specify the rule. First of all, see following
8239 example, please.
8241 @lisp
8242 @group
8243 (setq elmo-split-rule
8244       ;; @r{Store messages from spammers into @samp{+junk}}
8245       '(((or (address-equal from "i.am@@spammer")
8246              (address-equal from "dull-work@@dull-boy")
8247              (address-equal from "death-march@@software")
8248              (address-equal from "ares@@aon.at")
8249              (address-equal from "get-money@@richman"))
8250          "+junk")
8251         ;; @r{Store messages from mule mailing list into @samp{%mule}}
8252         ((equal x-ml-name "mule") "%mule")
8253         ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
8254         ;; @r{and continue evaluating following rules}
8255         ((equal x-ml-name "wanderlust") "%wanderlust" continue)
8256         ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
8257         ((match from "\\(.*\\)@@yahoo\\.com")
8258          "+yahoo-\\1")
8259         ;; @r{Store unmatched mails into @samp{+inbox}}
8260         (t "+inbox")))
8261 @end group
8262 @end lisp
8264 The basic unit of the rule is a combination like
8266 @lisp
8267 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
8268 @end lisp
8270 If @samp{CONDITION} is true, @samp{ACTION} is performed.
8271 The 1st element @samp{CONDITION} is a condition represented by a
8272 balanced expression (sexp). Its grammar will be explained below.
8273 The 2nd element @samp{ACTION} is the name of the folder to split
8274 messages into, or a symbol. When the 3rd element @code{continue} is
8275 specified as symbol, evaluating rules is not stopped even when the
8276 condition is satisfied.
8278 The grammar for @samp{CONDITION} is as follows. See example above to
8279 learn how to write the condition practically.
8281 @enumerate
8282 @item
8283 Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
8284 (@samp{FIELD-NAME} is a symbol that describes the field name)
8286 @table @code
8287 @item @code{equal}
8288 True if the field value equals to @samp{VALUE}.
8289 Case of the letters are ignored.
8290 @item @code{match}
8291 True if the field value matches to VALUE.
8292 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
8293 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
8294 @item @code{address-equal}
8295 True if one of the addresses in the field equals to
8296 @samp{VALUE}. Case of the letters are ignored.
8297 @item @code{address-match}
8298 True if one of the addresses in the field matches to
8299 @samp{VALUE}.
8300 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
8301 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
8302 @end table
8304 @item
8305 Functions which accept an integer argument (@samp{SIZE}).
8307 @table @code
8308 @item @code{<}
8309 True if the size of the message is less than @samp{SIZE}.
8310 @item @code{>}
8311 True if the size of the message is greater than @samp{SIZE}.
8312 @end table
8314 @item
8315 Functions which accept any number of arguments.
8317 @table @code
8318 @item @code{or}
8319 True if one of the argument returns true.
8320 @item @code{and}
8321 True if all of the arguments return true.
8322 @end table
8324 @item
8325 A symbol.
8327 When a symbol is specified, it is evaluated.
8328 @end enumerate
8330 You can specify followings as 2nd @samp{ACTION}.
8332 @enumerate
8333 @item
8334 folder name
8336 If some string is specified, it will be regarded as the destination
8337 folder, and the message will be appended to it.
8339 @item
8340 @samp{delete}
8342 If the symbol  @samp{delete} is specified, delete the substance of the
8343 message in @code{elmo-split-folder}
8345 @item
8346 @samp{noop}
8348 If the symbol @samp{noop} is specified, do nothing on the message and
8349 keep it as it is.
8351 @item
8352 function
8354 If some function is specified, execute it.
8355 @end enumerate
8357 If the message passes all rules, it will be dealed along @samp{ACTION}
8358 specified by @code{elmo-split-default-action}.
8361 @node Batch Processing, Advanced Settings, Split messages, Advanced Issues
8362 @section Batch Processing
8363 @cindex Batch Processing
8365 You can request wanderlust to do some job on the command line.
8366 For now, you can invoke prefetching new messages in specified folders.
8368 Specify target folders in @code{wl-batch-prefetch-folder-list} then
8369 invoke as follows to execute prefetching:
8371 @example
8372 @group
8373 % emacs -batch -l wl-batch -f wl-batch-prefetch
8374 @end group
8375 @end example
8377 @subsection Customize Variables
8379 @table @code
8380 @item wl-batch-prefetch-folder-list
8381 @vindex wl-batch-prefetch-folder-list
8382 Target folders of prefetching by @code{wl-batch-prefetch}, specified as
8383 a list of folder names.
8384 @end table
8387 @node Advanced Settings, Customizable Variables, Batch Processing, Advanced Issues
8388 @section Advanced Settings
8390 @menu
8391 * Draft for Reply::             Draft for Reply
8392 * Thread Format::               Appearance of Thread
8393 * User-Agent Field::            @samp{User-Agent:} Header Field
8394 @end menu
8397 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
8398 @subsection Draft for Replay
8399 @vindex wl-draft-reply-with-argument-list
8400 @vindex wl-draft-reply-without-argument-list
8402 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
8403 The addressee for the draft is decided by following rules.
8405 For example, you can set as follows:
8407 @lisp
8408 @group
8409 (setq wl-draft-reply-without-argument-list
8410       '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8411         ("Followup-To" . (nil nil ("Followup-To")))
8412         (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8413         ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
8414 @end group
8415 @end lisp
8417 Where each element of the list  @code{wl-draft-reply-without-argument-list}
8418 is in the form
8420 @example
8421 (key . (to-list cc-list newsgroup-list))
8422 @end example
8424 and if the field designated by @samp{key} exist in the parent message,
8425 parent's field values designated by @samp{to-list} are copied to @samp{To:}
8426 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
8427 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
8428 the draft respectively.
8430 Examples:
8432 @lisp
8433 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
8434 @end lisp
8436 Match if the parent has @samp{Mail-Followup-To} field.
8437 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
8438 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
8439 respectively.
8441 @lisp
8442 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
8443 @end lisp
8445 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
8446 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
8448 @lisp
8449 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
8450 @end lisp
8452 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
8453 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
8454 respectively.
8456 These are evaluated in order and first matched one is used.
8458 Moreover, the behavior of @kbd{a} with prefix argument can
8459 be directed by @code{wl-draft-reply-with-argument-list} as well.
8462 By the way, you can use some function (will be evaluated in the parent
8463 message buffer) in the place of @samp{key} or @samp{to-list} etc.
8465 If you want to write a rule for replying to message written by yourself,
8466 specify function @code{wl-draft-self-reply-p} as @samp{key}.
8468 If you only want to reply to mailing lists in
8469 @code{wl-subscribed-mailing-list} if the parent has some of them,
8470 set as follows:
8472 @lisp
8473 @group
8474 (defun wl-mailing-list-addresses ()
8475   (let (list-addrs)
8476     (dolist (to (mapcar
8477                  (lambda (addr)
8478                    (nth 1 (std11-extract-address-components addr)))
8479                  (wl-parse-addresses
8480                   (wl-concat-list
8481                    (elmo-multiple-fields-body-list (list "To" "Cc"))
8482                    ","))))
8483       (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
8484         (setq list-addrs (cons to list-addrs))))
8485     (nreverse list-addrs)))
8487 (setq wl-draft-reply-with-argument-list
8488       '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
8489         ("Reply-To" . (("Reply-To") nil nil))
8490         ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
8491         ("From" . (("From") nil nil))))
8492 @end group
8493 @end lisp
8496 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
8497 @subsection Appearance of Threads
8499 @example
8500 @group
8501   389  09/18(Fri)01:07 [ Teranishi         ] wl-0.6.3
8502   390  09/18(Fri)07:25 +-[ Tsumura-san       ]
8503   391  09/18(Fri)19:24 +-[ Murata-san        ]
8504   392  09/20(Sun)21:49 +-[ Okunishi-san      ]
8505   396  09/20(Sun)22:11 | +-[ Tsumura-san       ]
8506   398  09/21(Mon)00:17 |   +-[ Tsumura-san       ]
8507   408  09/21(Mon)22:37 |     +-[ Okunishi-san      ]
8508   411  09/22(Tue)01:34 |       +-[ Tsumura-san       ]
8509   412  09/22(Tue)09:28 |       +-[ Teranishi         ]
8510   415  09/22(Tue)11:52 |         +-[ Tsumura-san       ]
8511   416  09/22(Tue)12:38 |           +-[ Teranishi         ]
8512   395  09/20(Sun)21:49 +-[ Okunishi-san      ]
8513   397  09/21(Mon)00:15 +-[ Okunishi-san      ]
8514 @end group
8515 @end example
8517 Settings to make appearance of threads like shown above:
8519 @lisp
8520 @group
8521 (setq wl-thread-indent-level 2)
8522 (setq wl-thread-have-younger-brother-str "+")
8523 (setq wl-thread-youngest-child-str       "+")
8524 (setq wl-thread-vertical-str             "|")
8525 (setq wl-thread-horizontal-str           "-")
8526 (setq wl-thread-space-str                " ")
8527 @end group
8528 @end lisp
8530 If you do not want to see branches, do the following:
8532 @lisp
8533 @group
8534 (setq wl-thread-indent-level 2)
8535 (setq wl-thread-have-younger-brother-str " ")
8536 (setq wl-thread-youngest-child-str       " ")
8537 (setq wl-thread-vertical-str             " ")
8538 (setq wl-thread-horizontal-str           " ")
8539 (setq wl-thread-space-str                " ")
8540 @end group
8541 @end lisp
8544 @node User-Agent Field,  , Thread Format, Advanced Settings
8545 @subsection User-Agent Field
8546 @cindex X-Mailer
8547 @cindex User-Agent
8549 If you are eccentric enough to elaborate @samp{X-Mailer:} or
8550 @samp{User-Agent:} fields, define a function that generate appropriate
8551 strings as you like, and set it to variable
8552 @code{wl-generate-mailer-string-function}.
8554 If you do not want verbose @samp{User-Agent:} field, do the following:
8556 @lisp
8557 @group
8558 (setq wl-generate-mailer-string-function
8559       'wl-generate-user-agent-string-1)
8560 @end group
8561 @end lisp
8563 The following is a example:
8565 @lisp
8566 @group
8567 (setq wl-generate-mailer-string-function nil)
8568 (setq wl-draft-additional-header-alist
8569       (list
8570        (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
8571 @end group
8572 @end lisp
8575 @node Customizable Variables, Hooks, Advanced Settings, Advanced Issues
8576 @section Customizable Variables
8578 Customizable variables that have not been described yet:
8580 @table @code
8581 @item wl-default-folder
8582 @vindex wl-default-folder
8583 The initial setting is @samp{%inbox}.  This is the default value for moving to
8584 a folder and the like.
8586 @item wl-draft-folder
8587 @vindex wl-draft-folder
8588 The initial setting is @samp{+draft}.  It is the folder to which drafts are
8589 saved.  It must be a writable folder.
8590 You can set IMAP remote folder, Maildir and so on.
8591 Note that variable settings applied by @code{wl-draft-config-exec} is saved
8592 under @code{elmo-msgdb-directory}.  That is to say, if you specified remote
8593 folder as @code{wl-draft-folder}, variable settings which are applied by
8594 @code{wl-draft-config-exec} before saving the draft will not affect on the
8595 draft buffer on another host by invoking @code{wl-summary-reedit}.
8597 @item wl-trash-folder
8598 @vindex wl-trash-folder
8599 The initial setting is @samp{+trash}.  It is the wastebasket folder.
8600 If you changed this variable, you had better restart Wanderlust.
8602 @item wl-interactive-exit
8603 @vindex wl-interactive-exit
8604 The initial setting is @code{t}.
8605 If non-nil, you are asked for confirmation when Wanderlust terminates.
8607 @item wl-interactive-send
8608 @vindex wl-interactive-send
8609 The initial setting is @code{t}.
8610 If non-nil, you are asked for confirmation when mail is sent.
8612 @item wl-default-sync-range
8613 @vindex wl-default-sync-range
8614 The initial setting is @samp{update}.
8615 Default update range of the summary. You can specify
8616 @samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
8617 See description of @code{wl-summary-sync} for the meaning of ranges.
8619 @item wl-folder-sync-range-alist
8620 @vindex wl-folder-sync-range-alist
8621 The initial setting is the alist shown below:
8623 @lisp
8624 @group
8625 (("^&.*$" . "all")
8626  ("^\\+draft$\\|^\\+queue$" . "all"))
8627 @end group
8628 @end lisp
8630 @noindent
8631 This is an associative list of regular expressions of folder names and
8632 update range of the summary.  Update range is one of the @samp{all},
8633 @samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
8634 match any of them, the value of @code{wl-default-sync-range} is used
8635 (@samp{update} by default).
8636 See description of @code{wl-summary-sync} for the meaning of ranges.
8638 @item wl-ask-range
8639 @vindex wl-ask-range
8640 The initial setting is @code{t}.
8641 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
8642 for updating the summary when you changed folders.
8644 @item wl-mime-charset
8645 @vindex wl-mime-charset
8646 The initial setting is @code{x-ctext}.
8647 This is the MIME charset for messages that are not MIME (e.g. without
8648 @samp{Content-Type:}). This value also used as default charset for
8649 summary.  (If you want to share Summary on Nemacs and other Emacsen, set
8650 this value as @code{iso-2022-jp}.)
8652 @item wl-highlight-folder-with-icon
8653 @vindex wl-highlight-folder-with-icon
8654 This is meaningful for XEmacs or Emacs 21..  The initial setting depends
8655 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
8657 @item wl-strict-diff-folders
8658 @vindex wl-strict-diff-folders
8659 This is a list of regular expressions of folders.
8660 Unread messages are checked, for example when you press @kbd{s} in
8661 the folder mode, usually in a brief way (rapidly processed but not
8662 accurate).
8663 The folders matching this variable are seriously checked.
8664 You may want to set this variable so as to match conditional filter
8665 folders for IMAP4 folders.
8666 The initial setting is @code{nil}.
8668 @item wl-folder-use-server-diff
8669 @vindex wl-folder-use-server-diff
8670 When unread messages are checked, for example when you press @kbd{s} in
8671 the folder mode, usually (the number of messages on the server) @minus{}
8672 (the number of local messages) will be the number of unread messages.
8673 However, if this variable is non-nil, the number of unread messages on
8674 the server is checked.  This affects IMAP4 folders only, but IMAP4
8675 folders in mail boxes matching
8676 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
8677 the number of unread messages on the server, even if they matches this
8678 variable.  The initial setting is @code{t}.
8680 @item wl-auto-check-folder-name
8681 @vindex wl-auto-check-folder-name
8682 The initial setting is @code{nil}.
8683 You can specify a folder or a group which is checked for unread message
8684 at the start. You can also specify a list of folders (groups) to be checked.
8685 If the value is @code{nil}, whole Desktop is checked at the start.
8686 If it is @code{none}, no folders are checked.
8688 @item wl-auto-uncheck-folder-list
8689 @vindex wl-auto-uncheck-folder-list
8690 The initial setting is the list shown below:
8692 @lisp
8693 @group
8694 ("\\$.*")
8695 @end group
8696 @end lisp
8698 @noindent
8699 You can set a list of regular expressions to specify folders
8700 which are not automatically checked even if they are included
8701 in some groups assigned by @code{wl-auto-check-folder-name}.
8703 @item wl-auto-check-folder-list
8704 @vindex wl-auto-check-folder-list
8705 The initial setting is @code{nil}.
8706 You can set a list of regular expressions to specify exceptions
8707 for @code{wl-auto-uncheck-folder-list}.
8709 @item wl-no-save-folder-list
8710 @vindex wl-no-save-folder-list
8711 The initial setting is the list shown below:
8713 @lisp
8714 @group
8715 ("^/.*$")
8716 @end group
8717 @end lisp
8719 @noindent
8720 This is a list of regular expressions of folders not to be saved.
8722 @item wl-save-folder-list
8723 @vindex wl-save-folder-list
8724 The initial setting is @code{nil}.
8725 This is a list of regular expressions of folders to be saved.
8726 This takes precedence over @code{wl-no-save-folder-list}.
8728 @item wl-folder-mime-charset-alist
8729 @vindex wl-folder-mime-charset-alist
8730 The initial setting is the alist shown below:
8732 @lisp
8733 @group
8734 (("^-alt\\.chinese" . big5)
8735  ("^-relcom\\." . koi8-r)
8736  ("^-tw\\." . big5)
8737  ("^-han\\." . euc-kr))
8738 @end group
8739 @end lisp
8741 @noindent
8742 This is an associative list of regular expressions of folder names and
8743 MIME charsets.
8744 If a folder do not match, @code{wl-mime-charset} is used.
8746 @item wl-folder-init-load-access-folders
8747 @vindex wl-folder-init-load-access-folders
8748 The initial setting is @code{nil}.
8749 This is a list of access groups to be loaded specifically at the start.
8750 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
8752 @item wl-folder-init-no-load-access-folders
8753 @vindex wl-folder-init-no-load-access-folders
8754 The initial setting is @code{nil}.
8755 This is a list of access groups not to be loaded specifically at the
8756 start.
8757 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
8759 @item wl-dispose-folder-alist
8760 @vindex wl-dispose-folder-alist
8761 The initial setting is the alist shown below:
8763 @lisp
8764 @group
8765 (("^-" . remove)
8766  ("^@@" . remove))
8767 @end group
8768 @end lisp
8770 @noindent
8771 This list determines disposition of messages with disposal marks.
8772 Each item in the list is a folder and destination; you can specify any
8773 one of the following in the place of destination:
8775 @example
8776 @code{remove} or @code{null} : deletes the messages instantly.
8777 string             : moves the messages to the specific folder.
8778 @code{trash} or others  : moves the messages to @code{wl-trash-folder}.
8779 @end example
8781 @item wl-x-face-file
8782 @vindex wl-x-face-file
8783 The initial setting is @file{~/.xface}.
8784 The name of the file that contains encoded X-Face strings.
8785 @xref{x-face-mule}.
8787 @item wl-demo-display-logo
8788 @vindex wl-demo-display-logo
8789 If non-nil, bitmap image is shown on the opening demo.  If you set
8790 @code{xpm} or @code{xbm}, (if possible) display selected image type
8791 logo.
8793 @item elmo-use-database
8794 @vindex  elmo-use-database
8795 This is meaningful for XEmacs only.  The initial setting depends on
8796 XEmacs (@code{t} for XEmacs with dbm).
8797 If non-nil, Message-ID is controlled by dbm.
8799 @item elmo-nntp-list-folders-use-cache
8800 @vindex elmo-nntp-list-folders-use-cache
8801 The initial setting is 600 (in seconds).
8802 This is period in seconds during which results of @samp{list} and
8803 @samp{list active} in NNTP are cached.  If it is @code{nil}, they are
8804 not cached.
8806 @item elmo-nntp-max-number-precedes-list-active
8807 @vindex elmo-nntp-max-number-precedes-list-active
8808 The initial setting is @code{nil}.
8809 If non-nil, the number of article obtained by @samp{list active} in NNTP
8810 are used as the maximum article number of the folder.
8811 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
8812 and if the number of read messages is not correct.
8814 @item elmo-nntp-default-use-listgroup
8815 @vindex elmo-nntp-default-use-listgroup
8816 The initial setting is @code{t}.
8817 If non-nil, @samp{listgroup} is used for checking the total number of
8818 articles.  If it is @code{nil}, @samp{group} is used.  In the latter
8819 case, the processing will be a little faster at the sacrifice of
8820 accuracy.
8822 @item elmo-pop3-send-command-synchronously
8823 @vindex elmo-pop3-send-command-synchronously
8824 The initial setting is @code{nil}.
8825 If non-nil, POP3 commands are issued synchronously.  Some implementation
8826 of POP3 server fails to get summary information without this setting.
8827 You may have to set this variable to @code{t}, if the process hangs
8828 while looking up POP3.
8830 @item elmo-dop-flush-confirm
8831 @vindex elmo-dop-flush-confirm
8832 The initial setting is @code{t}.
8833 If non-nil, you are asked for confirmation if accumulated off-line
8834 operations are executed.
8836 @item elmo-network-session-idle-timeout
8837 @vindex elmo-network-session-idle-timeout
8838 The initial setting is @code{nil}.
8839 Idle timeout of the network cache. Specified in seconds.
8840 If elapsed time since last access is larger than this value,
8841 cached session is not reused. If nil, network cache is reused.
8843 @end table
8846 @node Hooks,  , Customizable Variables, Advanced Issues
8847 @section Hooks
8849 (Not yet written)
8852 @node Migration, Terminology, Advanced Issues, Top
8853 @chapter Switch from older version of Wanderlust
8854 @cindex Migration
8856 This chapter explains the important thing for the upgrade,
8857 or migration from the previous version.
8858 It includes the changes of the setup, limitations etc.
8860 @menu
8861 * Before 2.12.0::       From prior to the version 2.12.0 
8862 @end menu
8864 @node Before 2.12.0,  , Migration, Migration
8865 @section Migration from prior to the version 2.12.0 
8867 @subsection The conversion of msgdb 
8869 From version 2.12.0 on, the structure of msgdb is changed.
8870 The msgdb for newly created folder will use this new format when created and saved.
8871 But by writing following line, you may use the old format of the msgdb as it was.
8873 @lisp
8874 @group
8875 (setq elmo-msgdb-default-type 'legacy)
8876 @end group
8877 @end lisp
8879 With the default setup, the old msgdb format is converted to the new
8880 format automatically.  You may change this behavior by writing following
8881 lines in @file{~/.wl}.
8883 @lisp
8884 @group
8885 ;; @r{If the format of msgdb is different from} @code{elmo-msgdb-default-type},
8886 ;; @r{the format will be converted automatically when}
8887 ;; @r{the msgdb is being loaded (default).}
8888 (setq elmo-msgdb-convert-type 'auto)
8890 ;; @r{Convert msgdb when hitting @kbd{s all} in Summary mode}
8891 (setq elmo-msgdb-convert-type 'sync)
8893 ;; @r{Inhibit conversion}
8894 (setq elmo-msgdb-convert-type nil)
8895 @end group
8896 @end lisp
8898 As is explained in above section, you may continue to use the old format.
8899 But you will have following limitations.
8901 @enumerate
8902 @item
8903 You cannot use forwarded mark (@samp{F}, @samp{f}).
8904 @item
8905 You may only use @samp{important} flag. The other global flags may not
8906 be available.
8907 @end enumerate
8909 @subsection Changes from @samp{'mark} folder to  @samp{'flag}.
8911 The folder @samp{'mark} will be automatically converted to @samp{'flag}
8912 folder when you first start the new version of Wanderlust.
8913 But there are some restrictions on this type of migrated folder.
8915 @enumerate
8916 @item
8917 @samp{important} flag attached will not be
8918 removed by deleting the associated message in @samp{'flag} folder.
8920 @item
8921 The message won't be deleted by removing
8922 @samp{important} flag in @samp{'flag} folder.
8924 @item
8925 help-echo will not show you the old message.
8927 @end enumerate
8929 If you have problem with migrating 
8930 from @samp{'mark} folder to the @samp{'flag} folder,
8931 invoking
8932 @kbd{M-x elmo-global-mark-upgrade} will transfer the message
8933 from @samp{'mark} folder to the @samp{'flag} folder.
8934 The duplicated message will not be processed, 
8935 you may issue that command repeatedly.
8938 @node Terminology, Mailing List, Migration, Top
8939 @chapter Terminology around Wanderlust
8940 @cindex Terminology
8942 Here we explain terminologies used in this manual.
8944 @table @samp
8945 @item folder
8946 A container in which messages are stored.
8948 @item group
8949 A set consists of some folders.
8951 @item access group
8952 A special group consists of automatically collected folders under
8953 some specified path.
8954 @xref{Folder Definition}.
8956 @item summary buffer
8957 A buffer for displaying list of messages in some folder.
8959 @item sticky summary
8960 Compared with ordinary summary buffer which will be destroyed after
8961 exiting from it, this type of summary will be remain even after exiting
8962 by @kbd{q} or @kbd{g}.
8963 @xref{Sticky Summary}.
8965 @item expire
8966 To delete or put into the archive expired messages.
8967 @xref{Expire}.
8969 @item score
8970 @xref{Scoring}.
8972 @item prefetch
8973 To cache messages beforehand in order to read messages after you will be
8974 disconnected from the server.
8975 @end table
8978 @node Mailing List, Addition, Terminology, Top
8979 @chapter Wanderlust Mailing List
8980 @cindex Bug report
8981 @cindex Backtrace
8983 Topics related to Wanderlust are discussed in following mailing lists.
8984 The latest version is also announced there.
8986 @display
8987 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
8988 @end display
8990 In this list Japanese is mainly used for discussion. We also have a list
8991 for discussion in English:
8993 @display
8994 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
8995 @end display
8996 (Messages posted to this list are also forwarded to the former one.)
8998 A guide can be obtained automatically by sending mail to
8999 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
9000 the English one) with the body
9002 @example
9003 # guide
9004 @end example
9006 Please send bug reports or patches to one of those lists.  You can post to
9007 the mailing list even though you are not a member of it.
9009 If you send a bug report, please attach Backtrace with it.
9010 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
9011 in Japanese.}
9013 I would like to express my thanks to the members of the mailing list for
9014 valuable advice and many pieces of code they contributed.
9016 @subsection Archive
9018 You can read messages posted to the mailing list on the web or in
9019 NetNews.
9021 Read messages posted to @t{<wl@@lists.airs.net>}
9023 @example
9024 @uref{http://lists.airs.net/wl/archive/}
9025 @uref{news://gmane.mail.wanderlust.general.japanese@@news.gmane.org}
9026 @end example
9028 Read messages posted to @t{<wl-en@@lists.airs.net>}
9030 @example
9031 @uref{http://lists.airs.net/wl-en/archive/}
9032 @uref{news://gmane.mail.wanderlust.general@@news.gmane.org}
9033 @end example
9036 @node Addition, Index, Mailing List, Top
9037 @chapter Additional Information
9039 @section Brief History
9041 @example
9042 1998  3/05    Tried to make a prototype that displays MH messages in threads.
9043       3/10    Made a msgdb mechanism by elisp.
9044       3/26    IMAP and NNTP can be displayed in threads.
9045       4/13    Began to assemble thread display modules as elmo.
9046       5/01    Finished 0.1.0, initial version with many defects.
9047       6/12    I made a slip of the tongue and said I was writing elisp
9048               mailer supporting IMAP
9049       6/16    0.1.3 was announced at tm-ja, elisp ML.
9050       6/22    Thanks to Kitame-san, the mailing list started at northeye.org.
9051       7/01    Support for mm-backend (0.3.0).
9052       8/25    multi folder added (0.5.0).
9053       8/28    filter folder added (0.5.1).
9054       9/10    You can open/close threads (0.6.0).
9055       9/11    fldmgr by Murata-san made editing folders easy.
9056       9/18    lha folders added by Okunishi-san (0.6.3).
9057       9/24    Display of branches of threads (0.6.5).
9058       9/28    Compression folder supporting multiple archivers by Okunishi-san.
9059      10/28    Off-line operations (0.7.4).
9060      12/09    Becomes beta version.
9061      12/21    wl-expire by Murata-san.
9062 1999  2/03    auto-refile by Tsumura-san.
9063       4/28    wl-template by Murata-san.
9064       5/18    Released 1.0.0 stable.
9065       7/05    Scoring by Murata-san (2.1.0).
9066       9/26    New plugged system by Murata-san (2.2.2).
9067      12/20    Support Modified UTF7.
9068 2000  3/24    Released 1.1.0 stable.
9069       4/03    CVS development started.
9070       5/07    Thread restoration & Its speed up with Murata-san.
9071       6/12    Address completion with LDAP with Chiba-san & Goto-san.
9072       7/11    killed message feature.
9073       7/18    Use UIDL in POP3.
9074       9/12    biff feature with Satata-san & Yamaoka-san.
9075      10/17    expire-hide by Okada-san.
9076      11/08    Released 2.4.0 stable.
9077 2001  7/04    Released 2.6.0 stable.
9078       8/21    wl-addrmgr by Kitamoto-san.
9079      12/27    Released 2.8.1 stable.
9080 2002 12/11    Released 2.10.0 stable.
9081 2003  7/05    Released 2.10.1 stable.
9082       9/18    flag folder is added.
9083       9/20    New msgdb format (modb-standard) by H.Murata-san.
9084      10/20    Spam filter by H.Murata-san.
9085 2004  1/06    Background color of the demo become configurable.
9086       2/09    'file' folder is added.
9087       9/12    forwarded mark.
9088               Default value of the mark strings are changed.
9089      12/24    Released 2.12.0 stable.
9090 @end example
9092 See @file{ChangeLog} for details.
9094 @section The Name
9096 According to a dictionary, Wanderlust has the meaning:
9098 @display
9099 wanderlust
9100   n eager longing for or impulse towards travelling in distant lands
9101   [Ger, fr wandern to wander + lust desire, pleasure]
9102 @end display
9104 @noindent
9105 but I had no profound intention.  (if farfetched, IMAP @result{} you can
9106 read mail anywhere @result{} desire to wander ?)
9108 Elmo is the abbreviation of @samp{Elisp Library for Message
9109 Orchestration}.  At first I meant the red puppet in the Sesame Street,
9110 but you may associate it with Wandering @result{} Drifting @result{}
9111 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
9113 @section Code Names
9115 Each versions has code names (they are almost jokes).
9116 Currently they are picked up alphabetically from the top 40 hits of
9117 U.S. Billboard magazines in 1980s.
9119 (@uref{http://ntl.matrix.com.br/pfilho/html/top40/})
9121 @node Index,  , Addition, Top
9122 @unnumbered Index
9124 @menu
9125 * Concept Index::               Concept Index
9126 * Key Index::                   Key Index
9127 * Variable Index::              Variable Index
9128 * Function Index::              Function Index
9129 @end menu
9131 @node Concept Index, Key Index, Index, Index
9132 @unnumberedsec Concept Index
9133 @printindex cp
9135 @node Key Index, Variable Index, Concept Index, Index
9136 @unnumberedsec Key Index
9137 @printindex ky
9139 @node Variable Index, Function Index, Key Index, Index
9140 @unnumberedsec Variable Index
9141 @printindex vr
9143 @node Function Index,  , Variable Index, Index
9144 @unnumberedsec Function Index
9145 @printindex fn
9147 @summarycontents
9148 @contents
9149 @bye
9151 @c Local Variables:
9152 @c fill-column: 72
9153 @c End: