1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
26 This edition is for Wanderlust version @value{VERSION}.
28 Permission is granted to make and distribute verbatim copies of this
29 manual provided the copyright notice and this permission notice are
30 preserved on all copies.
33 Permission is granted to process this file through TeX and print the
34 results, provided the printed document carries copying permission notice
35 identical to this one except for the removal of this paragraph (this
36 paragraph not being relevant to the printed manual).
39 Permission is granted to copy and distribute modified versions of this
40 manual under the conditions for verbatim copying, provided that the
41 entire resulting derived work is distributed under the terms of a
42 permission notice identical to this one.
44 Permission is granted to copy and distribute translations of this manual
45 into another language, under the above conditions for modified versions.
51 @title Wanderlust User's Manual
52 @subtitle Yet another message interface on Emacsen
53 @subtitle for Wanderlust version @value{VERSION}
54 @author Yuuichi Teranishi
55 @author Fujikazu Okunishi
56 @author Masahiro Murata
58 @author Kaoru Takahashi
60 @author Masayuki Osada
63 @vskip 0pt plus 1filll
64 Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi},
65 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
66 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
68 This manual is for Wanderlust version @value{VERSION}.
70 Permission is granted to make and distribute verbatim copies of this
71 manual provided the copyright notice and this permission notice are
72 preserved on all copies.
74 Permission is granted to copy and distribute modified versions of this
75 manual under the conditions for verbatim copying, provided that the
76 entire resulting derived work is distributed under the terms of a
77 permission notice identical to this one.
79 Permission is granted to copy and distribute translations of this manual
80 into another language, under the above conditions for modified versions.
86 @node Top, Introduction, (dir), (dir)
87 @top Wanderlust User's Manual
99 This manual is for Wanderlust @value{VERSION}.
104 * Introduction:: Read this first.
105 * Start Me Up:: Invoking Wanderlust.
106 * Folders:: How to specify folders.
107 * Folder:: Selecting and editing folders.
108 * Summary:: Reading and refiling messages.
109 * Message:: Saving and playing MIME multipart entities.
110 * Draft:: Draft buffer, sending mail and news.
111 * Disconnected Operations:: Off-Line management
112 * Expire and Archive:: Automatic expiration and archiving of messages.
113 * Scoring:: Score of the messages.
114 * Customization:: Customizing Wanderlust.
115 * Mailing List:: Wanderlust mailing list
116 * Addition:: Additional Information
121 @node Introduction, Start Me Up, Top, Top
122 @chapter Introduction of Wanderlust
125 Wanderlust is an mail/news management system on Emacsen.
126 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
128 The main features of Wanderlust:
131 @item Pure elisp implementation.
132 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
133 @item Unified access method to messages based on Mew-like Folder Specification.
134 @item Mew-like Key-bind and mark handling.
135 @item Manages unread messages.
136 @item Interactive thread display.
137 @item Folder Mode shows the list of subscribed folders.
138 @item Message Cache, Disconnected Operation (Read Only).
139 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
140 @item MIME compliant (by SEMI or tm).
141 @item Transmission of news and mail are unified by Message transmitting draft.
142 @item Graphical list of folders (XEmacs and Emacs 21).
143 @item View a part of message without retrieving the whole message (IMAP4).
144 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
145 @item Virtual Folders.
146 @item Supports compressed folder using common archiving utilities.
147 @item Old articles in folders are automatically removed/archived (Expiration).
148 @item Automatic re-file.
149 @item Template function makes it convenient to send fixed form messages.
155 Wanderlust is supposed to run on following Emacsen:
156 @c Wanderlust runs even on Nemacs 3.3.2 based on Emacs 18.55, 18.59 (with
157 @c limited functionality).
160 @item Nemacs 3.3.2 (Caution: limited functionality)
161 @item Mule 2.3 based on Emacs 19.28
162 @item Mule 2.3 based on Emacs 19.34
163 @item Emacs 20.2 or later
164 @item XEmacs 20.4 or later
165 @item Meadow 1.00 or later
166 @item Mule for Windows v1.22
167 @item NTEmacs 20.4 or later
171 IMAP4 connectivity with following imapd are confirmed to work with
175 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c
176 @item Cyrus imapd 1.4, 1.5.19, 1.6.22, 2.0.5
177 @item AIR MAIL (AIRC imapd release 2.00)
179 @item Microsoft Exchange Server 5.5
180 @item Sun Internet Mail Server 4.0
183 @c LDAP connectivity with following LDAPd are confirmed to work with
187 @node Start Me Up, Folders, Introduction, Top
188 @chapter Start up Wanderlust
191 The necessary procedure for starting Wanderlust is explained in steps
194 (Of course, you need a mail/news readable environment in advance)
197 * MIME Modules:: Installing the MIME modules.
198 * Download:: Download and extract the packages.
199 * Install:: Byte-compile and install.
200 * Minimal Settings:: @file{.emacs} setup.
201 * Mail Addresses:: Address book definition.
202 * Folder Definition:: Folder definition.
203 * Start Wanderlust:: Starting Wanderlust
207 @node MIME Modules, Download, Start Me Up, Start Me Up
208 @section Installing MIME modules
215 SEMI or tm must be installed to make Wanderlust work correctly.
217 SEMI does not run on Emacs 19.28 or earlier
218 @footnote{SEMI runs on Emacs 19.34. @*
219 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} describes how to.},
220 so you must install tm, the predecessor of SEMI. (tm version 8.7 or later
223 However, SEMI is recommended because of its wider functionality.
225 Refer to the documents of each package for detailed installation procedure.
227 SEMI and tm can be downloaded from these sites:
231 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
232 tm: http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
236 You need packages named APEL and FLIM to use SEMI.
237 You can download APEL and FLIM from following URLs:
241 APEL: ftp://ftp.m17n.org/pub/mule/apel/
242 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
246 You have to install APEL, FLIM and SEMI in this order. Generally
247 @samp{make install} will do the job. (In XEmacs 21, @samp{make
250 Recommended combination of APEL, FLIM and SEMI are following:
253 @item APEL 10.2, FLIM 1.13.2 and SEMI 1.13.7
256 You can also use many other FLIM/SEMI variants. Combination of the
257 latest versions should work. For example, following combination is
261 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
262 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
265 You have to re-install Wanderlust if you upgraded APEL, FLIM, SEMI or
269 @node Download, Install, MIME Modules, Start Me Up
270 @section Download and Extract the Package
273 You can download Wanderlust package from following sites:
277 ftp://ftp.gohome.org/wl/
280 Mirrored ftp/http sites:
284 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
285 http://www.jpl.org/elips/wl/
286 http://www.ring.gr.jp/archives/text/elisp/wl/
287 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
288 ftp://opaopa.org/pub/mirror/elisp/wl/
292 Extract the obtained package to your working directory:
297 % tar zxvf wl-@var{version}.tar.gz
298 % cd wl-@var{version}
302 @subsection To use SSL (Secure Socket Layer)
307 SSL (Secure Socket Layer) can be used for
308 SMTP, IMAP, NNTP and POP connections in Wanderlust.
310 There are two ways to use SSL. One is to start SSL negotiation just
311 after the connection establishment (generic way). The other one is to
312 start SSL negotiation by invoking STARTTLS command in the each session.
314 To use the formar SSL (generic SSL), you must install @file{ssl.el} in
315 the @file{utils} directory. OpenSSL command @command{openssl} is also
316 required to use @file{ssl.el}. You must set @env{PATH} to the directory
317 that OpenSSL commands are installed.
319 To use the latter SSL(STARTTLS), you must install starttls package in
321 You can download starttls package from the following site.
324 ftp://opaopa.org/pub/elisp/
327 @node Install, Minimal Settings, Download, Start Me Up
328 @section Byte-compile and install
335 @subsection Installation
337 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
338 Set the Emacs's command name to @code{EMACS}.
339 Set package installation directory to @code{LISPDIR}.
340 Then, please execute following commands.
349 Destination directory is auto-probed if you leave @code{LISPDIR}
350 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
352 If you are using an Emacs variant which does not merge specified directory
353 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
354 then you will see the error message:
357 Cannot open load file: mime-setup
361 In this case, either add destination directories of custom, APEL, FLIM
362 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
363 @code{load-path} in @file{WL-CFG} in extracted directory.
365 If you want to use BBDB, then the necessary modules are byte-compiled
366 and installed when BBDB directory is added to @code{load-path}.
369 @subsection @file{WL-CFG}
371 Contents of the file @file{WL-CFG} is loaded under installation if a file
372 with that name exists in extracted directory. You can use @file{WL-CFG} to
373 configure @code{load-path} to extra packages such as SEMI if needed.
375 If you want to specify the install directory of Wanderlust related
376 files, then set following variables in @file{WL-CFG}
380 A directory to install WL modules.
381 This directory is relative directory from @code{LISPDIR}.
382 WL modules include @file{wl*.el}, @file{wl*.elc} files.
383 @c Modules under the directory @file{util/} are also installed if
384 @c it detected as necessary.
387 A directory to install ELMO modules.
388 This directory is relative directory from @code{LISPDIR}.
389 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
390 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
394 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
396 If you want to install ELMO related files under a sub-directory
397 such as "elmo" then add following to @file{WL-CFG}:
400 (setq ELMO_PREFIX "elmo")
403 @subsection Install as a XEmacs package
404 @cindex XEmacs package
405 @cindex XEmacs package install
406 @cindex Package, XEmacs
407 @cindex Package install, XEmacs
408 @c @cindex install-package
410 It is possible to install Wanderlust as one of packages of XEmacs (21.0
411 or later). Configuration for autoload and icon-path in local
412 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
415 Follow the next example to install Wanderlust as an XEmacs package.
421 % make install-package
425 package directory is auto-probed, if SEMI is installed.
426 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
428 @subsection Run in place
430 If wl and elmo directories are defined in @code{load-path}, then
431 byte-compilation and installation are not necessary to start Wanderlust.
432 For example, if package is extracted in @file{~/work}, Wanderlust can be
433 invoked with following setting in @file{~/.emacs}.
437 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
438 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
444 Manual is described in Info format. Please do following.
453 If you install Wanderlust as a XEmacs package, Info file is already
454 installed too, so there are no need of these commands.
456 Manual directory is automatically detected. Of course, it can be
457 configured by @code{INFODIR} in @file{Makefile}.
459 You can read manual at the following URL:
462 http://www.gohome.org/wl/doc/wl-euc_toc.html
465 @node Minimal Settings, Mail Addresses, Install, Start Me Up
466 @section Set up .emacs
467 @cindex Minimal Settings
469 @cindex Configuration
473 The Wanderlust package contains two module groups.
476 @item ELMO (elmo-*.el)
477 These modules show everything as folders. This is the back-end for WL.
479 These modules controls the behavior of main body of Wanderlust.
480 They are also the front-end for ELMO.
483 You can customize the behavior of Wanderlust by changing the value
484 of environmental variables which begins with @code{elmo-} and @code{wl-}.
486 The minimal requirement for settings is as the following.
490 ;; @r{The setting to use SEMI/tm}
493 ;; @r{autoload configuration}
494 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
495 (autoload 'wl "wl" "Wanderlust" t)
496 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
498 ;; @r{Directory where icons are placed (XEmacs or Emacs 21).}
499 ;; @r{Default: @code{nil}.}
500 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
501 (setq wl-icon-dir "~/work/wl/etc")
503 ;; @r{SMTP server for mail posting. Default: @code{nil}}
504 (setq wl-smtp-posting-server "your.smtp.server.com")
505 ;; @r{NNTP server for news posting. Default: @code{nil}}
506 (setq wl-nntp-posting-server "your.nntp.server.com")
510 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
511 file exists). So it is convenient to gather Wanderlust specific settings
512 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
513 because you can't write them in @file{.emacs}
514 (if you write it to @file{.emacs}, you'll get an error).
517 All above described settings except (load "mime-setup") and autoload
518 configuration can be written in
521 @subsection @code{mail-user-agent}
522 @cindex Default Mailer
523 @cindex Mailer, Default
524 @vindex mail-user-agent
527 If you write following setting in you @file{.emacs}, you can
528 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
529 This means it enables you to run Wanderlust as a default mail composer
532 It is effective only when your Emacs can define @code{mail-user-agent}.
533 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
537 (autoload 'wl-user-agent-compose "wl-draft" nil t)
538 (if (boundp 'mail-user-agent)
539 (setq mail-user-agent 'wl-user-agent))
540 (if (fboundp 'define-mail-user-agent)
541 (define-mail-user-agent
543 'wl-user-agent-compose
551 @node Mail Addresses, Folder Definition, Minimal Settings, Start Me Up
552 @section Address book
553 @cindex Address book Definition
555 @cindex Alias, Address
557 The file @file{~/.addresses} is a simple address book for Wanderlust.
558 Make address file @file{~/.addresses}, and edit to suit your requirement.
560 The data written in @file{~/.addresses} are used for address completion
561 under draft editing mode. Furthermore, they are used when showing names
562 in summary display mode. You can safely skip this section, if you don't
563 want to customize address completion and summary display.
564 It is possible to add/change/remove addresses from @file{~/.addresses} in
565 summary buffer after Wanderlust is invoked. @refill
567 The format is very simple. Like this. @refill
572 # @r{Lines begin with @samp{#} are comment.}
573 # @r{Empty lines are ignored}
575 # @r{Format of each line:}
576 # @var{email-address} "@var{nickname} "@var{realname}"
578 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
579 foo@@bar.gohome.org "Mr. Foo" "John Foo"
580 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
585 One line defines one persons description.
587 Actually, in default setup, @var{nickname} is used in summary-mode and
588 @var{realname} is used in draft preparation mode. This behavior is
589 better understood if you try it and confirmed the function first. You
590 can write and try a small definition, so you will know the idea of the
591 address book before writing a big one.
593 And, if MH alias file is specified in variable @code{wl-alias-file},
594 it is used as an address information in the draft preparation mode.
596 If variable @code{wl-use-ldap} is non-nil (initial setting is
597 @code{nil}), address completion in draft mode uses LDAP information.
599 If you use LDAP, you have to set @code{wl-ldap-server},
600 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
601 not have LDAP feature as built-in feature (Currently only XEmacs can
602 have built-in LDAP feature), you have to set command exec @env{PATH} to
603 the program @command{ldapsearch}.
605 @node Folder Definition, Start Wanderlust, Mail Addresses, Start Me Up
606 @section Folder Definition
607 @cindex Folder Definition
610 You can skip this section because it is possible to add/edit the
611 subscribe folders from the buffer for list of folders.
613 Define the folders you want to subscribe in file @file{~/.folders}. The
614 contents written in @file{~/.folders} become the folders which you
615 subscribe to as it is.
617 Format for @file{~/.folders} is very simple. Here is an example:
622 # @r{Lines begin with @samp{#} are comment.}
623 # @r{Empty lines are ignored}
625 # @var{folder name} "@var{folder nickname}"
626 # @r{(nicknames are not necessary)}
631 %#mh/Backup@@my.imap.server.com "Sent"
634 %#mh/spool/wl "Wanderlust ML"
635 %#mh/spool/elips "ELIPS ML"
636 %#mh/spool/tm-ja "tm Japanese ML"
637 %#mh/spool/xemacs-beta "XEmacs beta"
638 -fj.news.reader.gnus@@other.nntp.server.com "Gnus Net news"
639 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
642 # @r{If folder name ends with @samp{/}, that means an `access group',}
643 # @r{all subfolders automatically included in one folder group.}
645 %#mh/expire@@localhost /
646 # @r{All MH folders are included in one folder group.}
651 Each line contains one folder you want to read. The definition of
652 folders will be explained in detail in the next section.
654 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
655 become one folder group. One folder group is treated as a directory
656 which can bed opened and closed in folder mode. It is convenient for
657 collecting some folders and putting them in order.
659 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
660 line and you have to write it that way (It is because the parser sucks).
662 There are two types of groups. One is like @samp{Emacsen} from above
663 example which the user chooses his favorite folders as a group.
665 The other one is @dfn{access group} like @samp{+} from above example.
666 It makes all the sub-folders in a folder to a group. (It differs from
667 the type of the folder. For example, @samp{+} makes entire MH
668 sub-directories to one group)
670 This behavior is better understood if you try it and confirmed the
671 function first. You can write and try a small folder definition, so you
672 will know the idea of the folder function before writing the real one.
674 @node Start Wanderlust, , Folder Definition, Start Me Up
675 @section Start Wanderlust
676 @cindex Start Wanderlust
678 If installation and configuration worked well, you can invoke Wanderlust by
679 typing following command in Emacs.
686 After initialization, Folder Mode which shows the list of folders will appear.
687 That means the folders you defined in the @file{~/.folders} are listed
688 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
689 can skip folder checking.
692 @node Folders, Folder, Start Me Up, Top
693 @chapter Wanderlust's folders
696 This chapter describes the folder types which Wanderlust is able to handle.
698 Wanderlust uses ELMO as it's interface, so every folder types supported
699 by ELMO is usable in Wanderlust.
701 As of version @value{VERSION}, 10 types of folders are predefined. These are
702 IMAP, NNTP, LocalDir(MH), News Spool, POP, Archive, Multi, Filter, Pipe
703 and Internal folder types.
706 * IMAP Folder:: @samp{%} -- IMAP folder
707 * NNTP Folder:: @samp{-} -- NNTP folder
708 * MH Folder:: @samp{+} -- MH folder
709 * Maildir Folder:: @samp{.} -- Maildir folder
710 * News Spool Folder:: @samp{=} -- News spool folder
711 * Archive Folder:: @samp{$} -- Archive folder
712 * POP Folder:: @samp{&} -- POP folder
713 * Multi Folder:: @samp{*} -- Multi folder
714 * Filter Folder:: @samp{/} -- Filter folder
715 * Pipe Folder:: @samp{|} -- Pipe folder
716 * Internal Folder:: @samp{'} -- Internal folder
720 @node IMAP Folder, NNTP Folder, Folders, Folders
727 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
733 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
737 You can specify @code{login} (encoded password transmission),
738 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
739 authentication) or @code{plain} (or @code{nil}, plain password
740 transmission) as @var{authenticate-type}. (To use CRAM-MD5 or
741 DIGEST-MD5 authentication, you must install @file{utils/sasl} package.)
746 @var{username} -> The value of @code{elmo-default-imap4-user}.
747 Initial setting is @env{USER} environment variable or
748 @env{LOGNAME} environment variable or return value of
749 @code{(user-login-name)}.
750 @var{authenticate-type} -> The value of @code{elmo-default-imap4-authenticate-type}.
751 Initial setting is "auth".
752 @var{hostname} -> The value of @code{elmo-default-imap4-server}.
753 Initial setting is "localhost".
754 @var{port} -> The value of @code{elmo-default-imap4-port}.
755 Initial setting is 143.
758 You can omit the @var{hostname} from folder names if you set
759 @code{elmo-default-imap4-server} as your main IMAP server.
760 For example, you can specify a folder as @samp{foo%imap@@gateway} even
761 if you have to go through a firewall.
763 SSL (Secure Socket Layer) connection will be used if a folder name
764 ends with @samp{!}. Or, if the value of @code{elmo-default-imap4-ssl} is non-nil,
765 SSL will be the default connection.
766 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
767 If the value of @code{elmo-default-imap4-ssl} is 'starttls,
768 STARTTLS will be the default connection.
770 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
771 authentication method, the password is sent in encoded form. But, if
772 your server is unable to receive an encoded password, authentication
773 will fall back to @code{plain} (that is, sending password in raw format)
774 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
775 authentication will fall back to @code{plain} without confirmation
776 (default value is @code{nil}).
782 %inbox -> IMAP mailbox "inbox"
783 %#mh/inbox -> IMAP mailbox "#mh/inbox"
785 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
786 %inbox:hoge/login@@server1
787 -> server1's IMAP mailbox "inbox"
788 of user "hoge", with plain password authentication
793 @subsection International mailbox names (Modified UTF7)
794 @cindex Modified UTF7
801 You can use international mailbox names in @var{mailbox} part, if you
802 are using Emacs which can treat unicode and
803 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
804 value is @code{nil}).
806 Currently, following Emacsen can treat unicode.
809 @item Emacs 20.3 or later + Mule-UCS
811 If you installed Mule-UCS package, Emacs can treat unicode.
812 You can obtain Mule-UCS package from following URL.
815 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
818 @item XEmacs 21.2.13 or later + ucs-conv package
820 By default, XEmacs 21 cannot treat unicodes, but if you installed
821 ucs-conv package, it can.
822 You can obtain ucs-conv package from following anonymous CVS.
826 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
827 Password: @var{NULL} (Just enter return key)
828 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
832 You also need utf7 conversion programs, @command{u7tou8} and
833 @command{u8tou7} to use international mailbox name in the current
834 XEmacs. These programs are included in the UTF7 package which can be
835 obtained from following URL.
838 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
842 @node NNTP Folder, MH Folder, IMAP Folder, Folders
847 A folder to access USENET news via NNTP protocol (RFC 977).
848 One newsgroup is treated as a folder.
854 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
860 @var{hostname} -> The value of @code{elmo-default-nntp-server}.
861 Initial setting is @samp{localhost}.
862 @var{username} -> The value of @code{elmo-default-nntp-user}.
863 Initial setting is @code{nil}.
864 @var{port} -> The value of @code{elmo-default-nntp-port}.
865 Initial setting is 119.
868 AUTHINFO is used as authentication method if the @var{username} is non-nil.
869 SSL will be default method if @code{elmo-default-nntp-ssl} is non-nil even
870 if the folder name doesn't end with @samp{!}.
871 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
872 if the value of @code{elmo-default-nntp-ssl} is @code{starttls},
873 STARTTLS will be the default connection.
879 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
880 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
884 @node MH Folder, Maildir Folder, NNTP Folder, Folders
890 A folder to access MH format mail (1 file is 1 mail).
895 @samp{+} @var{directory-name}
898 Normally, @var{directory-name} is an relative path to the variable
899 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
900 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
901 (this is also true for drive-letters).
903 Message number is used for the name of the message file.
909 +inbox -> @file{~/Mail/inbox}
910 +from/teranisi -> @file{~/Mail/from/teranisi}
911 +~/test -> @file{~/test}
915 @node Maildir Folder, News Spool Folder, MH Folder, Folders
916 @section Maildir Folder
917 @cindex Maildir Folder
921 A folder to access to Maildir format (1 file is 1 mail).
926 @samp{.} [@var{directory-name}]
929 Normally, @var{directory-name} is a relative path to the variable
930 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
931 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
932 (this is also true for drive-letters).
934 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
935 Messages are contained in the @file{cur} directory. All message files
936 in the @file{new} directory are moved to @file{cur} directory when you
937 access to the folder. All message files contained in the @file{tmp}
938 directory and not accessed for 36 hours are deleted.
940 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
946 . -> @file{~/Maildir}
947 .inbox -> @file{~/Maildir/inbox}
948 .from/teranisi -> @file{~/Maildir/from/teranisi}
949 .~/test -> @file{~/test}
954 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
955 @section News Spool Folder
956 @cindex News spool Folder
960 This folder handles locally saved news articles which are proposed by
961 Mew/IM. You can also read articles directly from a spool-file which is
962 retrieved by an utility like @command{gnspool}.
967 @samp{=} @var{directory-name}
970 @var{directory-name} is a sub-directory to the directory defined by
971 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
972 You can use @samp{.} as directory delimiter as well as @samp{/}.
978 =fj/os/os2 -> @file{~/News/fj/os/os2}
979 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
984 @node Archive Folder, POP Folder, News Spool Folder, Folders
985 @section Archive Folder
986 @cindex Archive Folder
990 This method can handle archive files, which are compressed by utilities
991 such as Info-ZIP or LHA, as one folder.
997 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1001 @var{path-name} is the relative path from
1002 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1003 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1004 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1005 also permitted under the environment of ange-ftp, efs.
1007 The actual file name of the archive folder is
1008 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1009 under the @var{path-name}. If a file named @var{path-name} exists, it is
1010 treated as folder. The suffix is automatically decided for
1011 @var{archiver-type}.
1013 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1014 (Initial setting is @code{zip}) is referred.
1016 @var{prefix} specifies the internal directory structure of the archive.
1017 For example, if the ML server is fml, @file{msend.tar.gz} has a
1018 structure like @file{spool/1}, so you have to specify @samp{spool} as
1025 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1026 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1027 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1028 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1033 * Archiver:: Archivers supported
1034 * Archive Tips:: TIPS
1035 * Archive Vars:: Customization
1039 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1040 @subsection Supported Archives
1050 By default, following archives are supported.
1054 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1055 GNU TAR('tgz, 'tar) ;; read-only
1059 If your archiver can include multiple files in one archive, you have a
1060 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1061 of the candidate. TAR is supported read-only because it cannot delete
1062 file in the archive (@code{mv})).
1064 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1065 archiver of Wanderlust because they cannot include multiple
1066 files. Archivers that cannot extract files to standard output are also
1069 @subsection OS specific information about archiver.
1071 Behaviors of the following archivers are confirmed by further experiences.
1072 (@samp{*} mark means recommended archiver).
1075 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1076 LHA OS/2 version Rel.2.06b Feb 18, 1998
1077 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1078 *Zip 2.2 (November 3rd 1997).
1079 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1080 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1081 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1083 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1084 LHa for UNIX V 1.14c
1085 UnZip 5.32 of 3 November 1997
1086 Zip 2.2 (November 3rd 1997)
1087 GNU tar 1.12 (1.11.x is no good)
1088 gzip 1.2.4 (18 Aug 93)
1090 [Win32] Win.98/Meadow
1094 GNU tar 1.11.8 + 1.5(WIN32)
1101 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1102 Hiramatsu version of LHA is only supported.
1103 In Win32, LHa32 is only supported (DOS version is no good).
1105 * Caution about GNU tar
1107 You have to take care about GNU tar's version because many version has
1108 problem on deleting file from archive.
1110 Please test @option{--delete} @option{-f} options work. Otherwise, your
1111 archive will be destroyed. No problem is reported on above versions of
1115 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1117 @cindex Archive Tips
1119 For comfortable migration, usage of @code{wl-summary-archive}
1120 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1121 archive folders created by expiration, you must set non-nil value to
1122 @code{elmo-archive-treat-file}.
1124 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1125 in processing speed. For comfortable use, Emacs20 is recommended.
1126 (If re-search's performance is the problem, 19.3x or later may be okay.)
1128 If many files are included in one archive,
1129 it takes long time to access to the archive folder because
1130 archiver starting overhead is increased (especially LHA).
1131 150-200 messages in one archive is recommended.
1133 Of course, following is possible @t{:-)}
1134 (meanings of these variables are described later.)
1138 (setq wl-fcc "$backup")
1139 (setq wl-trash-folder "$trash;lha")
1143 @node Archive Vars, , Archive Tips, Archive Folder
1144 @subsection Variables About Archive Folder
1145 @cindex Archive variables
1148 @item elmo-archive-default-type
1149 @vindex elmo-archive-default-type
1150 The initial setting is @code{zip}.
1151 Set archiver type by symbol.
1153 @item elmo-archive-@var{type}-method-alist
1154 @vindex elmo-archive-TYPE-method-alist
1155 Define archiver @var{type}'s methods.
1156 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1157 Each element of the alist is following.
1161 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1162 (@var{action} . @var{function}) ;; function
1166 Currently available actions are following.
1170 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1171 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1178 actions enclosed with braces are optional (They are used for better
1181 @item elmo-archive-suffix-alist
1182 @vindex elmo-archive-suffix-alist
1183 An alist of archiver-type (symbol) and suffix.
1185 @item elmo-archive-file-regexp-alist
1186 @vindex elmo-archive-file-regexp-alist
1187 An alist of a regexp to get file number from list output of archiver
1188 and archiver-type (symbol).
1190 @item elmo-archive-method-list
1191 @vindex elmo-archive-method-list
1192 A list of elmo-archive-@var{type}-method-alist
1193 (@var{type} is a symbol of archiver-type).
1195 @item elmo-archive-lha-dos-compatible
1196 @vindex elmo-archive-lha-dos-compatible
1197 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1198 DOS (Mr. Yoshizaki original) compatible.
1200 @item elmo-archive-cmdstr-max-length
1201 @vindex elmo-archive-cmdstr-max-length
1202 The initial setting is 8000.
1204 Max length of command line argument for external archiver program.
1205 Emacs does not have a limit of command line byte length, but some OS
1206 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1207 this limit because it calls external archiver program directly (not
1208 called via shell). For example, you cannot delete messages if archiver
1209 program must receive larger bytes of arguments to delete. OS/2 have a
1210 command line argument limit of 8190 bytes, so we defined default as 8000
1213 However, you don't have an influence of command line argument limit
1214 if the archiver has `actions' to receive target file information from
1215 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1218 @node POP Folder, Multi Folder, Archive Folder, Folders
1226 A folder to access e-mails via POP3 protocol (RFC 1939).
1232 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1237 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1238 as @var{authenticate-type}.
1242 @var{username} -> The value of @code{elmo-default-pop3-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-default-pop3-authenticate-type}.
1247 Initial setting is @samp{user}.
1248 @var{hostname} -> The value of @code{elmo-default-pop3-server}.
1249 Initial setting is @samp{localhost}.
1250 @var{port} -> The value of @code{elmo-default-pop3-port}.
1251 Initial setting is 110.
1258 &hoge@@localhost -> access to localhost as user @samp{hoge}.
1259 &hoge@@popserver:109 -> access to the server "popserver" on port 109
1260 as user @samp{hoge}.
1264 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1265 (XEmacs doesn't need @file{md5.el}).
1266 @file{md5.el} is included in @file{utils/sasl/lisp/} or Emacs/W3 package:
1269 http://www.cs.indiana.edu/elisp/w3/docs.html
1272 or LCD archive (GPL2).
1274 If the last character of the folder name is @samp{!}, Wanderlust connects to
1275 the POP server via SSL (Secure Socket Layer). If you set non-nil
1276 value to @code{elmo-default-pop-ssl}, you don't have to put @samp{!} in the
1277 end of the folder name to use SSL.
1278 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
1279 if the value of @code{elmo-default-pop-ssl} is @code{starttls},
1280 STARTTLS will be the default connection.
1282 @node Multi Folder, Filter Folder, POP Folder, Folders
1283 @section Multi Folder
1284 @cindex Multi Folder
1286 @cindex Folder, Multiple
1287 @cindex Folder, Marge
1289 A folder to access to a folder which collects messages from
1290 multiple folders virtually.
1296 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1300 After @samp{*} character, specify multiple folders you want to collect
1301 separated by ',' like
1302 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1308 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1309 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1310 treated as one folder.
1312 *+inbox,-fj.rec.tv,%inbox
1313 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1318 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1319 @section Filter Folder
1320 @cindex Filter Folder
1322 @cindex Folder, Filtering
1323 @cindex Folder, Virtual
1325 A folder to access to a folder which collects all messages that
1326 satisfy a condition virtually.
1331 @samp{/} @var{condition} @samp{/} @var{target-folder}
1334 In the @var{condition} part, you can specify following.
1338 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1340 first: @var{number} messages are picked from top of folder.
1341 last: @var{number} messages are picked from bottom of folder.
1347 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1348 /first:20/%inbox -> First 20 messages from %inbox are picked.
1353 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1355 since: only messages arrived since @var{date} are picked.
1356 before: only messages arrived before @var{date} are picked.
1358 You can specify following as @var{date}.
1362 yesterday -> a day before today.
1363 lastweek -> same day of last week.
1364 lastmonth -> same day of last month.
1365 lastyear -> same day of last year.
1366 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1367 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1375 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1377 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1383 Field filter: @samp{@var{field}:@var{value}}
1385 All messages that have @var{field} and its value is @var{value} are picked.
1386 @var{field} and @var{value} are case insensitive.
1392 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1393 and its value includes "teranisi" string are picked.
1394 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1402 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1403 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1405 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1406 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1412 /from:teranisi&!to:teranisi/+inbox
1413 -> In +inbox, messages are picked if the message's
1414 From: field includes "teranisi" and
1415 To: field doesn't include "teranisi".
1417 /tocc:"Yuuichi Teranishi"/+inbox
1418 -> In +inbox, messages are picked if the
1419 message's To: field or Cc: field includes
1420 "Yuuichi Teranishi".
1422 /(from:yt|from:teranisi)&subject:report/+inbox
1423 -> In +inbox, messages are picked if the message's
1424 From: field includes "yt" or "teranisi", and
1425 Subject includes "report".
1431 Tip for string description:
1433 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1434 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1435 should be escaped with @samp{\} in it). You can enclose the string with
1436 @samp{"} even it does not contain these characters.
1442 *%inbox,/from:teranisi/%inbox@@server
1443 -> Messages in %inbox or
1444 message is in the %inbox@@server folder and it's From field
1445 includes "teranisi" are collected.
1447 /last:100//to:teranisi/*+inbox,%inbox
1448 -> Latest 100 messages which is in the +inbox or %inbox folder
1449 and To: field matches "teranisi".
1451 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1452 -> Pick messages which have From: field and it includes "hogehoge"
1453 from latest 20 messages in the %#mh/inbox@@localhost
1454 and To: or Cc: field includes "teranisi".
1457 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1458 @section Pipe Folder
1462 @cindex Download Message
1463 @cindex Incorporate Message
1465 In the pipe folder, messages are automatically transferred from the source
1466 folder to destination folder.
1471 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1474 When you access to the pipe folder, messages are automatically transferred
1475 from @var{source-folder} to @var{destination-folder}.
1476 It is convenient if you want to download messages to local disk via POP.
1477 For example, if you specify following
1480 |&username@@popserver|+inbox
1483 and access to it, messages are downloaded automatically from
1484 &username@@popserver to @samp{+inbox}.
1490 %inbox|%myinbox -> Download %inbox to %myinbox.
1491 *&user@@popserver1,&user@@popserver2|+inbox
1492 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1496 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1498 @node Internal Folder, , Pipe Folder, Folders
1499 @section Internal folder
1500 @cindex Internal Folder
1502 @cindex Folder, @samp{$} mark
1504 A folder to access to internal messages of Wanderlust.
1516 A folder named @samp{'mark} is a special virtual folder which collects
1517 messages which have important mark @samp{$}.
1519 You can review important messages at once after you put important marks
1520 on the messages in the different folders.
1522 In this folder, if you delete message, important mark @samp{$} put on
1523 the message is removed. If you append messages to this folder, the
1524 message will have @samp{$} mark.
1526 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1527 folder. If you want IMAP folder's message remove from @samp{'mark}
1528 folder, remove important mark at IMAP Folder.)
1530 You can access to the cached messages fetched via network by accessing
1531 to the folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1532 the name of the subdirectories of the cache directory
1533 (@file{~/.elmo/cache}).
1536 @node Folder, Summary, Folders, Top
1537 @chapter Folder mode
1540 After you start Wanderlust, folder mode is appeared firstly.
1541 It contains folder list you subscribed.
1542 You can select and edit folders in this mode.
1545 * Selecting Folder:: Select folder you want to read.
1546 * Folder Manager:: Editing folders.
1550 @node Selecting Folder, Folder Manager, Folder, Folder
1551 @section Selecting Folder
1552 @cindex Selecting Folder
1554 @subsection Usage (TIPS)
1556 @subsubsection Check new, unread number
1558 Folder mode looks like this.
1559 (In XEmacs, it looks much nicer @t{;-)})
1563 [-]Desktop:14186/35580/67263
1568 [-]Emacsen:0/34/4837
1569 Wanderlust ML:0/0/558
1572 XEmacs Beta:0/29/255
1583 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1587 @kbd{s} key on the folder line updates these numbers.
1588 It changes its color if it has many new messages.
1590 The whole folder mode is a folder group named @samp{Desktop}.
1591 Folder group open/close by return key.
1592 A operation to a folder group is treated as operations on the
1594 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1595 six children folders update its unread number status.
1597 @subsubsection Select Folder
1599 To enter summary mode of the folder, type return (or space) key on
1601 If the variable @code{wl-stay-folder-window} has non-nil value,
1602 summary window appears on the right of the folder mode window.
1604 @subsection Key bindings
1606 Folder mode's key binding (related to selecting folders) is following.
1611 @kindex @key{SPC} (Folder)
1612 @kindex @key{RET} (Folder)
1613 @findex wl-folder-jump-to-current-entity
1614 Enter to the summary mode of the folder at the current cursor point.
1615 If the cursor is on the top of folder group line,
1616 the folder group is opened or closed.
1617 When the cursor is on the access group and this command is called
1618 with prefix argument, folder children list is updated to the newest one.
1619 (Children list is updated recursively if the access folder has hierarchical
1621 (@code{wl-folder-jump-to-current-entity})
1624 @kindex M-@key{RET} (Folder)
1625 @findex wl-folder-update-recursive-current-entity
1626 Folder children list of the access group at the current cursor point
1627 is updated to the newest one.
1628 (Children list is updated recursively if the access folder has hierarchical
1630 (@code{wl-folder-update-recursive-current-entity})
1635 Create a new draft message.
1640 @findex wl-folder-write-current-newsgroup
1641 If the current cursor point is on the NNTP folder,
1642 create a new draft message which already has newsgroups field.
1643 (@code{wl-folder-write-current-newsgroup})
1646 @kindex C-c C-o (Folder)
1647 @findex wl-jump-to-draft-buffer
1648 Move to the draft buffer if available. If multiple draft buffer exists,
1649 moved to one after another. If prefix argument is specified, load draft
1650 folder's message to the draft buffer and jump to it.
1651 (@code{wl-jump-to-draft-buffer})
1655 @findex wl-folder-check-current-entity
1656 Update new and unread number information of the folder at the current
1658 (@code{wl-folder-check-current-entity})
1662 @findex wl-folder-sync-current-entity
1663 Update summary information of the folder at the current cursor point.
1664 (@code{wl-folder-sync-current-entity})
1667 @kindex r s (Folder)
1668 @findex wl-folder-check-region
1669 Update new and unread number information of the folders in the currently
1671 (@code{wl-folder-check-region})
1674 @kindex r S (Folder)
1675 @findex wl-folder-sync-region
1676 Update summary information of the folders in the currently selected region.
1677 (@code{wl-folder-sync-region})
1681 @findex wl-status-update
1682 Sync up address book status with @file{~/.addresses}'s content.
1683 (@code{wl-status-update})
1687 @findex wl-folder-prev-unread
1688 Jump cursor to the folder which have unread messages on the upward from
1689 current cursor point.
1690 (@code{wl-folder-prev-unread})
1694 Jump cursor to the folder which have unread messages on the downward
1695 from current cursor point.
1696 (@code{wl-folder-next-unread})
1700 Move cursor to the folder on the previous line.
1701 (@code{wl-folder-prev-entity})
1705 Move cursor to the folder on the next line.
1706 (@code{wl-folder-next-entity})
1710 Jump to the folder specified by the user input.
1711 (@code{wl-folder-jump-folder})
1715 @findex wl-folder-prefetch-current-entity
1716 Prefetch new messages of the folder at the current cursor point by
1717 @code{wl-summary-incorporate}.
1718 If the cursor is on the folder group, it is executed recursively.
1719 (@code{wl-folder-prefetch-current-entity})
1723 @findex wl-folder-mark-as-read-all-current-entity
1724 Mark all unread messages of the folder at the current cursor point as read.
1725 If the cursor is on the folder group, it is executed recursively.
1726 (@code{wl-folder-mark-as-read-all-current-entity})
1730 @findex wl-folder-goto-first-unread-folder
1731 Enter summary mode of the first unread folder.
1732 (@code{wl-folder-goto-first-unread-folder})
1736 @findex wl-folder-empty-trash
1738 (@code{wl-folder-empty-trash})
1742 @findex wl-folder-open-all-unread-folder
1743 All unread folder is opened.
1744 (@code{wl-folder-open-all-unread-folder})
1748 @findex wl-folder-open-close
1749 Folder group is opened/closed.
1750 (@code{wl-thread-open-close})
1754 All folder group is opened.
1755 (@code{wl-folder-open-all})
1759 All folder group is closed.
1760 (@code{wl-folder-close-all})
1770 (@code{wl-folder-suspend})
1773 @kindex M-s (Folder)
1774 Save current folder status.
1778 @kindex M-t (Folder)
1779 Toggle Wanderlust's offline/online status.
1780 (@code{wl-toggle-plugged})
1783 @kindex C-t (Folder)
1784 Start Wanderlust's plug-status manager.
1785 (@code{wl-plugged-change})
1788 @subsection Customize variables
1791 @item wl-folders-file
1792 @vindex wl-folders-file
1793 The initial setting is @file{~/.folders}.
1794 Subscribed folders are described (saved) in this file.
1796 @item wl-folder-info-save
1797 @vindex wl-folder-info-save
1798 The initial setting is @code{t}. If non-nil, unread information is
1799 saved and used in the next Wanderlust session.
1801 @item wl-stay-folder-window
1802 @vindex wl-stay-folder-window
1803 The initial setting is @code{nil}.
1804 If non-nil, summary window is appeared on the right side of the folder buffer.
1806 @item wl-folder-window-width
1807 @vindex wl-folder-window-width
1808 The initial setting is 20.
1809 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1811 @item wl-folder-many-unsync-threshold
1812 @vindex wl-folder-many-unsync-threshold
1813 The initial setting is 70.
1814 If the number of unread messages is more than this value,
1815 folder color is changed.
1817 @item wl-highlight-folder-by-numbers
1818 @vindex wl-highlight-folder-by-numbers
1819 This option controls how to highlight each line in the folder buffer.
1820 The default value is @code{t}, highlighting with various colors based on
1821 the message numbers. If it is @code{nil}, highlighting with various
1822 colors based on the folder status. In addition, if it is a number
1823 (e.g. 1), highlighting will be done based on both the message numbers
1824 and the folder status.
1826 @item wl-folder-desktop-name
1827 @vindex wl-folder-desktop-name
1828 The initial setting is @samp{Desktop}.
1829 The name of top folder group.
1831 @item wl-folder-petname-alist
1832 @vindex wl-folder-petname-alist
1833 The initial setting is @code{nil}.
1834 An alist of folder's realname and its nickname.
1836 @item wl-folder-access-subscribe-alist
1837 @vindex wl-folder-access-subscribe-alist
1838 The initial setting is @code{nil}.
1840 Control automatic subscribing and unsubscribing of the children list
1846 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1850 If @var{subscribe-flag} is non-nil, folders which have name matched to
1851 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1852 already unsubscribed folder is not displayed even when the
1853 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1860 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1861 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1862 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1863 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1867 @item wl-folder-hierarchy-access-folders
1868 @vindex wl-folder-hierarchy-access-folders
1869 The initial setting is the list shown below:
1878 A list of access groups which creates children folder list hierarchically.
1880 For example, if you specify
1881 @code{wl-folder-hierarchy-access-folders} like following,
1885 (setq wl-folder-hierarchy-access-folders
1886 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1891 such access group hierarchy is obtained.
1897 -fj.comp.announce:0/0/2
1898 -fj.comp.dev.cdrom:0/0/0
1900 [+]-japan:238/238/1688
1903 -comp.unix.admin:0/0/0
1904 -comp.unix.dos-under-unix:0/0/0
1905 -comp.unix.programmer:0/0/0
1906 [-]-comp.unix.bsd:0/0/23
1907 -comp.unix.bsd.freebsd.announce:0/0/0
1912 If you opened @samp{-} in this example, only the direct children is created
1913 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1914 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1915 is not created until the children access group is opened.
1919 @node Folder Manager, , Selecting Folder, Folder
1920 @section Editing Folders
1921 @cindex Folder Manager
1922 @cindex Folder, Edit
1923 @cindex Folder, Subscribe
1924 @cindex Folder, Unsubscribe
1926 As described before, subscribed folder list is saved in @file{~/.folders} file.
1927 But you don't have to edit @file{~/.folders} directly.
1928 You can append, delete, edit folders from folder mode.
1930 @subsection Usage (Tips)
1932 @subsubsection Append Folder
1934 @kbd{m a} appends new folder to the folder mode.
1935 @kbd{m g} appends new folder group.
1936 To append new folder to this group, firstly open it,
1937 then execute append command in the next line.
1939 @subsubsection Edit Folder
1941 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1942 Thus, you can change folder position as if you were editing a normal file.
1944 @subsubsection Create Multi Folder.
1948 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
1950 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
1952 Type @kbd{m m}, then you can create multi folder.
1955 @subsubsection Delete Nickname, Filter
1957 You can delete nickname or filter by putting ``''(@var{NULL}) from the
1958 minibuffer while appending.
1960 @subsubsection Append Folder to Empty Group
1962 To append new folder to the empty folder group
1963 (after you create folder group by typing @kbd{m g}),
1964 firstly open it, then execute append command in the next line.
1965 If it is closed, folder is appended on the same level with
1966 the above folder group. It is difficult to explain by words so try it.
1967 In other words, appended position depends on the
1968 above folder group's open/close status.
1970 @subsubsection Charset of the Folders File.
1972 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
1974 @subsubsection Create Filter
1976 @kbd{m f} adds filter to the folder at the current cursor point. To
1977 create new filter folder and leave the current folder unchanged, copy it
1978 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
1979 filter can be specified while appending filter. If you put
1980 ``''(@var{NULL}), filter is deleted.
1982 @subsubsection Sort Folders
1984 Sorting of the folders is executed by the function specified by
1985 @code{wl-fldmgr-sort-func}.
1986 The initial setting is @code{wl-fldmgr-sort-standard},
1987 which sorts alphabetically.
1988 Sorting affects only on the current folder group. It does not
1989 affect on the child groups.
1991 @subsubsection Hiding Folders in the Access Group
1993 Usually, access group displays all children folders, but you can set
1994 some folders hidden. Following operations are only available on access
1997 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
1998 (subscribe/unsubscribe) of the folder at current cursor point. Against
1999 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2002 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2003 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2004 argument and if the argument has positive number, the unsubscribe it.
2005 If the prefix argument has negative value, folder becomes visible and if
2006 zero, folder visibility is toggled.
2008 The other commands, @code{wl-fldmgr-subscribe} and
2009 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2012 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2013 executed in the access group, they have a same effect with
2014 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2015 The difference is that cut(-region) commands deletes folders from the
2018 @subsubsection Operations in the Access Group
2020 You can insert and delete folders in the access group like usual folder
2021 group. But insert and delete commands can be only available for the
2022 children folders of the access group and they only sets the subscribe
2023 status. In other words, insertion of the folder means subscribing,
2024 deletion means unsubscribing.
2025 @footnote{In the current implementation,
2026 it is faster to delete region than to unsubscribe region.}
2028 To update the access group when children folders are inserted or deleted
2029 by other way (other than Wanderlust),
2030 open the access group by typing @kbd{C-u @key{RET}}.
2031 @xref{Selecting Folder}.
2033 The order of children folders of access group is saved after
2034 insertion/deletion/sorting.
2035 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2036 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2037 newly created folders are inserted on the top of the access group.
2039 @subsection Key bindings
2040 @cindex Keybind, Folder Mode
2041 @cindex Keybind, Folder Buffer
2043 Key bindings on the folder mode related to folder editing are shown below.
2044 All bindings starts with @kbd{m}, and primary commands are binded to
2045 one stroke key binding.
2049 @kindex m a (Folder)
2050 @findex wl-fldmgr-add
2052 (@code{wl-fldmgr-add})
2057 @kindex m g (Folder)
2058 @findex wl-fldmgr-make-group
2059 Create a folder group.
2060 (@code{wl-fldmgr-make-group})
2063 @kindex m A (Folder)
2064 @findex wl-fldmgr-make-access-group
2065 Create an access group.
2066 (@code{wl-fldmgr-make-access-group})
2069 @kindex m d (Folder)
2070 @findex wl-fldmgr-delete
2071 Delete folder itself and msgdb.
2072 If the folder itself cannot be deleted like NNTP folder,
2073 only msgdb is deleted.
2074 (@code{wl-fldmgr-delete})
2079 @kindex m R (Folder)
2080 @findex wl-fldmgr-rename
2081 Change the name of folder or folder group.
2082 msgdb's path is also changed.
2083 (@code{wl-fldmgr-rename})
2089 @findex wl-fldmgr-make-multi
2090 Create a multi folders in the cutlist (cut, copied folders).
2091 (@code{wl-fldmgr-make-multi})
2096 @kindex m f (Folder)
2097 @findex wl-fldmgr-make-filter
2098 Create a filter folder. (Put a filter on the folder).
2099 (@code{wl-fldmgr-make-filter})
2103 @kindex M-c (Folder)
2104 @kindex m c (Folder)
2105 @findex wl-fldmgr-copy
2106 Copy folder (it is not available on folder group).
2107 (@code{wl-fldmgr-copy})
2111 @kindex M-w (Folder)
2112 @kindex m W (Folder)
2113 @findex wl-fldmgr-copy-region
2114 Copy folders in the specified region.
2115 (@code{wl-fldmgr-copy-region})
2119 @kindex C-k (Folder)
2120 @kindex m k (Folder)
2121 @findex wl-fldmgr-cut
2122 Cut folder. Folder itself is not deleted.
2123 (@code{wl-fldmgr-cut})
2127 @kindex C-w (Folder)
2128 @kindex m C-w (Folder)
2129 @findex wl-fldmgr-cut-region
2130 Cut folders in the specified region.
2131 (@code{wl-fldmgr-cut-region})
2135 @kindex C-y (Folder)
2136 @kindex m y (Folder)
2137 @findex wl-fldmgr-yank
2138 Paste folders that are copied or cut (folders in the cut-list).
2139 (@code{wl-fldmgr-yank})
2142 @kindex m p (Folder)
2143 @findex wl-fldmgr-set-petname
2144 Put nickname on the folder.
2145 (@code{wl-fldmgr-set-petname})
2148 @kindex m q (Folder)
2149 @findex wl-fldmgr-clear-cut-entity-list
2150 Clear the cut-list. (cut, copied folder information is cleared,
2151 you cannot paste after this)
2152 (@code{wl-fldmgr-clear-cut-entity-list})
2155 @kindex m s (Folder)
2156 @findex wl-fldmgr-sort
2157 Sort folders in the current folder group.
2158 (@code{wl-fldmgr-sort})
2161 @kindex m C-s (Folder)
2162 @findex wl-fldmgr-save
2163 Save current folder view to the @file{wl-folders-file}.
2164 (@code{wl-fldmgr-save})
2167 [Following commands are only available on the access groups]
2173 @kindex m u (Folder)
2174 @findex wl-fldmgr-unsubscribe
2175 Set the visibility of folder (subscribe/unsubscribe).
2176 (@code{wl-fldmgr-unsubscribe})
2181 @kindex r u (Folder)
2182 @findex wl-fldmgr-unsubscribe-region
2183 Set the visibility of the folders (subscribe/unsubscribe) in the
2185 (@code{wl-fldmgr-unsubscribe-region})
2190 @kindex m l (Folder)
2191 @findex wl-fldmgr-access-display-normal
2192 List folders that are currently available.
2193 (@code{wl-fldmgr-access-display-normal})
2198 @kindex m L (Folder)
2199 @findex wl-fldmgr-access-display-all
2200 List all folders regardless of the subscription status.
2201 (@code{wl-fldmgr-access-display-all})
2205 @subsection Customize variables
2208 @item wl-interactive-save-folders
2209 @vindex wl-interactive-save-folders
2210 The initial setting is @code{t}. If non-nil and folder view is
2211 modified, confirm saving it before Wanderlust or Emacs exits. If
2212 @code{nil}, save without confirmation.
2214 @item wl-fldmgr-make-backup
2215 @vindex wl-fldmgr-make-backup
2216 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2217 created before saving the folder status.
2219 @item wl-fldmgr-sort-func
2220 @vindex wl-fldmgr-sort-func
2221 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2222 sort folders. By default function, folders are sorted alphabetically
2223 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2226 @item wl-fldmgr-sort-group-first
2227 @vindex wl-fldmgr-sort-group-first
2228 The initial setting is @code{t}. If non-nil,
2229 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2230 does not care whether it is folder group or not.
2232 @item wl-folder-check-async
2233 @vindex wl-folder-check-async
2234 The initial setting is @code{t}. If non-nil, check folder's unread
2235 status asynchronously. It boosts newsgroup checking.
2237 @item wl-folder-check-fast
2238 @vindex wl-folder-check-fast
2239 The initial setting is @code{nil}.
2240 If non-nil, it does not update folder status while checking.
2242 @item wl-folder-notify-deleted
2243 @vindex wl-folder-notify-deleted
2244 The initial setting is @code{nil}.
2246 If non-nil, negative value is displayed when the message is deleted. If
2247 @code{sync}, folder is synchronized when the message is deleted. If
2248 @code{nil}, message deletion is ignored.
2251 @subsection Miscellanea
2253 Following is a note for folder editing.
2257 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2258 paste(yank) command pastes the folders on one cut or copy command
2259 (If copy command is executed by region, folders in the region are pasted
2260 by one paste command)
2263 You cannot cut @samp{Desktop} group.
2264 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2267 You cannot copy folder group.
2270 Operations on the access group are only available for the folders
2271 in the same access group.
2274 You cannot create a folder which has same name with the folders already exist.
2277 You cannot insert folders which have same name in one group.
2278 You can insert them in the different groups.
2279 You cannot put same nickname to the different folders.
2283 @node Summary, Message, Folder, Top
2284 @chapter Summary Mode
2286 After you select the folder via folder mode, you enter to the summary
2290 * Usage of Summary Mode:: TIPS.
2291 * Thread Oparations:: Thread oparations.
2292 * Cache:: File cache, Buffer cache, and Prefetch.
2293 * Auto Refile:: Auto refile settings.
2294 * Sticky Summary:: Summary make sticky.
2295 * Key Bindings of Summary:: Key bindings.
2296 * Variables of Summary:: Customize Summary Mode.
2300 @node Usage of Summary Mode, Thread Oparations, Summary, Summary
2301 @section Usage (Tips)
2303 @subsection Summary Content
2305 In the summary mode, messages are displayed like following.
2309 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2310 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2311 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2312 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2319 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2323 You cannot change this in the current version.
2325 @var{Message number} is the message's unique number in the folder. In
2326 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2327 in the MH folder, it is the filename of the message.
2329 @var{Temporal mark} and @var{Persistent mark} are described later.
2331 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2332 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2333 Japanese, but if you want to display it in English, set the value of
2334 @code{wl-summary-weekday-name-lang} as @samp{en}.
2336 @var{Sender}'s indentation corresponds to the depth of the thread.
2337 Sender name is displayed as nickname if it is defined in the address
2338 book. Set @code{wl-use-petname} as @samp{nil}, if you want to quit
2339 displaying with nickname.
2341 If number is printed at the head of @var{Sender} part like @samp{+2},
2342 that means the message have 2 follow messages.
2344 @var{Subject} is the @samp{Subject:} header field of the message. If
2345 the message have same @samp{Subject:} with the parent message, it is not
2346 displayed. Some mailing list puts its sequence number in the
2347 @samp{Subject:} field, but it is
2348 ignored. @code{wl-summary-no-subject-message} is displayed when the
2349 message has empty subject field.
2351 @subsection Temporary Marks
2352 @cindex Mark, Temporary
2354 There are four temporary marks,
2355 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2356 Temporary marks indicates message operations.
2361 You can execute a command on the all messages that have @samp{*} mark,
2362 with the key bindings which begins with @kbd{m}.
2365 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2369 After you type @kbd{o} key, prompt appears to input refile destination.
2370 Your answer is printed in the summary line.
2374 You can put this mark by typing @kbd{O} key.
2375 The difference between this mark and refile mark is,
2376 this mark does not delete the message while latter does.
2379 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2381 @subsection Persistent Marks
2383 There are five persistent marks,
2384 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2386 The persistent mark indicates the message's status and it is saved.
2387 Each persistent mark indicates:
2393 It is unread message.
2395 It is unread but cached message.
2397 It is read but it is not cached.
2399 It is important message. You can put @samp{$} mark by typing @kbd{$}
2400 key (if already exists, the mark is deleted). It is convenient to put
2401 this mark on the messages to remember (If you want to remember to write
2402 a reply for the message, for example) because this mark remains after
2403 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2404 even the message itself is deleted in the actual folder.
2407 If the message is read and cached (or local message),there are no
2411 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2412 cache. Messages with the marks other than these, you can read them in
2413 the offline status even they are in the IMAP folder or netnews folder.
2415 @subsection How To Read
2417 Basically, you can read messages only typing space key again and again.
2419 To update summary status to the newest status (synchronize),
2422 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2423 moves cursor to the next message.
2424 Enter message buffer by typing @kbd{j} key.
2425 To operate multipart, you have to enter to the message buffer.
2429 @node Thread Oparations, Cache, Usage of Summary Mode, Summary
2430 @section Thread Operations
2432 For example, the following line indicates one thread (a context of a topic).
2435 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2439 If you type @kbd{/} on this line, the thread is opened and it changes
2440 the appearance like following.
2444 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2445 388 09/17(Thu)22:34 +-[ Murata san ]
2449 (Message 388 is the replied message to the message 384.)
2450 If you type @kbd{/} key once again, the thread is closed.
2451 With prefix argument, @kbd{/} opens all children threads.
2453 Commands with the key binding that begins with @kbd{t} executes commands
2454 on the messages in the thread.
2457 @node Cache, Auto Refile, Thread Oparations, Summary
2460 @subsection Cache File
2462 The messages which have to access via network (e.x. IMAP, NNTP folder)
2463 are cached as a local file. The cache file is saved under the directory
2464 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2465 elmo-cache-expire-by-size}. The command deletes cache files to the
2466 specified size by the order of last accessed time.
2468 @subsection Buffer Cache and Prefetching
2470 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2471 that are read are kept in the cache buffer. It is called `buffer
2472 cache'. The number of cache buffer is specified by
2473 @code{elmo-buffer-cache-size}.
2475 There are message prefetching mechanism in the Wanderlust that
2476 prefetches next message while you are reading. This function requires
2477 that the value of @code{elmo-use-buffer-cache} is non-nil.
2479 You can control the message prefetching mechanism by these two
2483 @item wl-cache-prefetch-folder-type-list
2484 @vindex wl-cache-prefetch-folder-type-list
2485 The initial setting is the list shown below:
2493 It specifies the folder types in which message prefetching is enabled.
2494 In the initial setting, multi folder that contains localdir and imap4
2495 prefetches only imap4 messages. This variable precedes the value of
2496 @code{wl-cache-prefetch-folder-list}.
2498 If you want to prefetch localdir and localnews also, following setting
2503 (setq wl-cache-prefetch-folder-type-list
2504 '(nntp imap4 localdir localnews))
2508 @item wl-cache-prefetch-folder-list
2509 @vindex wl-cache-prefetch-folder-list
2510 The initial setting is @code{nil}.
2511 A list of regexp of folders to enable message prefetching.
2515 @node Auto Refile, Sticky Summary, Cache, Summary
2516 @section Auto Refile
2517 @vindex elmo-msgdb-extra-fields
2518 @vindex wl-refile-rule-alist
2519 @findex wl-summary-auto-refile
2521 You can refile messages automatically, by typing @kbd{C-o}
2522 (@code{wl-summary-auto-refile}). It decides destination of refile by
2523 the content of the message header information (information in the msgdb).
2525 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2526 available. If you want to decide destination by other header fields,
2527 set the variable @code{elmo-msgdb-extra-fields} like following.
2531 (setq elmo-msgdb-extra-fields
2541 By this setting, Wanderlust saves extra fields in the msgdb. You have
2542 to type @kbd{s all} to get extra fields for the messages that are
2543 already exists in the summary.
2545 Then, specify the refile rule. The refile target folder of auto
2546 refiling is decided by the value of @code{wl-refile-rule-alist}.
2547 @code{wl-refile-rule-alist} is a list of a rule:
2551 (@var{field} (@var{regexp} . @var{target})
2552 (@var{regexp} . @var{target})
2557 Each rule means `if @var{field} value matches @var{regexp},
2558 then refile to @var{target} folder'.
2559 The rule matched first is applied.
2561 @var{field} is a string of field name. You can specify a list of field name
2562 string, too. In this case, if one of these fields is matched, then the
2563 rule is fired (i.e. OR condition).
2565 @var{regexp} is a regular expression for field value. @var{target} is a target
2566 folder string. You can specify a rule at @var{target} part, too. In this
2567 case, If the field value of the rule and the current rule is matched,
2568 then the current rule is fired (i.e. AND condition).
2570 In @var{target} part, you can refer matched substring of @var{regexp}.
2571 To refer substring, specify following in @var{target}:
2575 means substitute original matched text.
2578 means substitute what matched the @var{N}th `\(@dots{}\)'.
2579 (@var{N} is a number.)
2582 Following is an example of @code{wl-refile-rule-alist}.
2586 (setq wl-refile-rule-alist
2588 ("^Wanderlust" . "+wl")
2589 ("^Elisp" . "+elisp"))
2591 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2593 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2594 "+from-me-to-you"))))))
2598 After these settings, refile marks are automatically put on the condition
2599 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2601 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2603 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2604 with these persistent marks are not automatically refiled.
2605 It means Wanderlust does not execute auto refile on unread messages by
2606 the default setting.
2607 To execute auto refile on all messages, set following.
2610 (setq wl-summary-auto-refile-skip-marks nil)
2614 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2615 @section Sticky Summary
2616 @cindex Summary, Sticky
2617 @cindex Sticky Summary
2619 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2621 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2622 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2624 The buffer name of the sticky summary becomes like
2625 @samp{Summary:@var{folder-name}}.
2627 You can visit the sticky summary at any time by @kbd{C-x b}
2628 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2629 q}. Other operations in the sticky summary are same as normal summary.
2631 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2632 are automatically sticked.
2635 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2636 @section Key bindings
2637 @cindex Keybind, Summary Mode
2638 @cindex Keybind, Summary Buffer
2640 Key bindings of the summary mode are shown below.
2644 @kindex @key{SPC} (Summary)
2645 @findex wl-summary-read
2646 Proceed reading a message at the current cursor point.
2647 (@code{wl-summary-read})
2651 @findex wl-summary-redisplay
2652 Redisplay a message at the current cursor point.
2653 If this command is called with prefix argument,
2654 Redisplay message regardless of the message cache (message is re-loaded
2656 (@code{wl-summary-redisplay})
2660 @findex wl-summary-display-top
2661 Display the top message in the folder.
2662 (@code{wl-summary-display-top})
2666 @findex wl-summary-display-bottom
2667 Display the bottom message in the folder.
2668 (@code{wl-summary-display-bottom})
2672 @kindex @key{BS} (Summary)
2673 @kindex @key{DEL} (Summary)
2674 Display the previous page of the message at the current cursor point.
2675 @findex wl-summary-prev-page
2676 (@code{wl-summary-prev-page})
2679 @kindex @key{RET} (Summary)
2680 @findex wl-summary-next-line-content
2681 Display the next line of the message at the current cursor point.
2682 Display the message at the current cursor point if it is not displayed yet.
2683 (@code{wl-summary-next-line-content})
2688 @kindex M-@key{RET} (Summary)
2689 @findex wl-summary-prev-line-content
2690 Display the previous line of the message at the current cursor point.
2691 Display the message at the current cursor point if it is not displayed yet.
2692 (@code{wl-summary-prev-line-content})
2696 @findex wl-thread-open-close
2697 Toggle open or close the thread at the current cursor point.
2698 (@code{wl-thread-open-close})
2703 @findex wl-thread-open-all
2704 (@code{wl-thread-open-all})
2709 @findex wl-thread-close-all
2710 (@code{wl-thread-close-all})
2714 @findex wl-summary-goto-folder
2716 (@code{wl-summary-goto-folder})
2720 Mark all messages in the folder as read.
2721 @findex wl-summary-mark-as-read-all
2722 (@code{wl-summary-mark-as-read-all})
2726 @findex wl-summary-reply
2727 Prepare a draft for reply the message at the current cursor point.
2728 (@code{wl-summary-reply})
2732 @findex wl-summary-reply-with-citation
2733 Prepare a draft for reply the message at the current cursor point.
2734 (@code{wl-summary-reply-with-citation})
2738 @findex wl-summary-cancel-message
2739 If the message at current cursor point is your own netnews article,
2741 (@code{wl-summary-cancel-message})
2745 @findex wl-summary-reedit
2746 Prepare a draft for re-editing the message at current cursor point.
2747 If the message at current cursor point is your own netnews article,
2748 a draft for `supersedes message' for the message is prepared.
2749 (@code{wl-summary-reedit})
2752 @kindex M-e (Summary)
2753 @findex wl-summary-resend-bounced-mail
2754 If the message at current cursor point is a bounced message,
2755 a draft for re-sending original message is prepared.
2756 (@code{wl-summary-resend-bounced-mail})
2760 @findex wl-summary-forward
2761 A draft for forwarding the message at current cursor point is prepared.
2762 (@code{wl-summary-forward})
2766 @findex wl-summary-mark-as-important
2767 Put @samp{$} mark on the message at current cursor point.
2768 If already marked as @samp{$}, delete it.
2769 (@code{wl-summary-mark-as-important})
2775 Save the message at current cursor point.
2776 @findex wl-summary-save
2777 (@code{wl-summary-save})
2781 @findex wl-summary-next
2782 Move cursor to the next message.
2783 If message is marked with a temporal mark in
2784 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2785 In the offline mode, cursor is not moved to the messages which are not cached
2787 (@code{wl-summary-next})
2791 @findex wl-summary-prev
2792 Move cursor to the previous message.
2793 If message is marked with a temporal mark in
2794 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2795 In the offline mode, cursor is not moved to the messages which are not cached
2797 (@code{wl-summary-prev})
2801 @findex wl-summary-down
2802 Move cursor to the downward message which is unread or marked
2804 (@code{wl-summary-down})
2808 @findex wl-summary-up
2809 Move cursor to the upward message which is unread or marked
2811 (@code{wl-summary-up})
2815 @findex wl-summary-write
2816 Prepare a new draft.
2817 (@code{wl-summary-write})
2821 @findex wl-summary-write-current-newsgroup
2822 Prepare a new draft. If the current folder is netnews folder,
2823 @samp{Newsgroups:} field is completed.
2824 (@code{wl-summary-write-current-newsgroup})
2828 @findex wl-summary-redisplay-all-header
2829 Redisplay the message at current cursor point with all header fields.
2830 (@code{wl-summary-redisplay-all-header})
2834 @findex wl-summary-redisplay-no-mime
2835 Redisplay the message at current cursor point without MIME analysis.
2836 (@code{wl-summary-redisplay-no-mime})
2840 @findex wl-summary-burst
2841 If the message at current cursor point has
2842 encapsulates multiple messages using MIME,
2843 de-capsulate and extract them on the current folder.
2844 (@code{wl-summary-burst})
2847 @kindex @@ (Summary)
2848 @findex wl-summary-edit-addresses
2849 Append/change/delete the message's sender information to the address
2850 book @file{~/.addresses} interactively. If this command is called with
2851 prefix argument, arbitrary address can be edited.
2852 (@code{wl-summary-edit-petname})
2856 @findex wl-status-update
2857 Sync up address book status with @file{~/.addresses}'s content.
2858 (@code{wl-status-update})
2862 @findex wl-summary-pipe-message
2863 Pipe current message's content to the external process.
2864 (@code{wl-summary-pipe-message})
2868 @findex wl-summary-print-message
2869 Print out current message's content.
2870 It uses @code{ps-print} module in Emacs 20.x.
2871 If you don't use color printer, you might want to set
2872 @code{wl-ps-print-buffer-func} to @code{ps-print-buffer}.
2875 (setq wl-ps-print-buffer-func 'ps-print-buffer)
2878 (@code{wl-summary-print-message})
2882 @findex wl-summary-exit
2883 Exit current folder.
2884 (@code{wl-summary-exit})
2888 @findex wl-summary-jump-to-current-message
2889 Jump cursor to the currently displayed message's window.
2890 (@code{wl-summary-jump-to-current-message})
2894 Jump cursor to the other message.
2895 @findex wl-summary-jump-to-msg
2896 (@code{wl-summary-jump-to-msg})
2900 Update summary status and
2901 prefetch all messages which have marks included in the
2902 @code{wl-summary-incorporate-marks}.
2903 @findex wl-summary-incorporate
2904 (@code{wl-summary-incorporate})
2907 @kindex M-j (Summary)
2908 @findex wl-summary-jump-to-msg-by-message-id
2909 Jump cursor to the message which have specified @samp{Message-Id:}. If
2910 @code{elmo-use-database} is non-nil, other folder is also searched.
2911 (@code{wl-summary-jump-to-msg-by-message-id})
2915 Jump to parent message.
2916 @findex wl-summary-jump-to-parent-message
2917 (@code{wl-summary-jump-to-parent-message})
2921 @findex wl-summary-mark-as-unread
2922 Mark as unread the message at current cursor point.
2923 (@code{wl-summary-mark-as-unread})
2927 @findex wl-summary-sync
2928 Synchronize summary view after prompting the update range
2929 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
2933 all ...Discard current summary and update all message.
2934 update ...Update the difference between summary and the folder itself.
2935 rescan ...Rescan the msgdb and display again.
2936 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2937 first, last ...Move to the filter folder(partial filter).
2942 (@code{wl-summary-sync})
2946 @findex wl-summary-sort
2948 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
2949 (@code{wl-summary-sort})
2953 @findex wl-summary-toggle-thread
2954 Toggle the threading.
2955 Threading status is displayed on the modeline.
2956 @samp{@{S@}} means threading is off (Sequence) and
2957 @samp{@{T@}} means threading is on (Thread).
2958 (@code{wl-summary-toggle-thread})
2962 @findex wl-summary-toggle-disp-folder
2963 Toggle displaying of folder window.
2964 (@code{wl-summary-toggle-disp-folder})
2968 Toggle displaying of message window.
2969 @findex wl-summary-toggle-disp-msg
2970 (@code{wl-summary-toggle-disp-msg})
2974 Move to the virtual folder with the condition specified.
2975 If called with prefix argument and current folder is virtual, exit it.
2976 @findex wl-summary-virtual
2977 (@code{wl-summary-virtual})
2980 @kindex @key{TAB} (Summary)
2981 @findex wl-summary-goto-last-displayed-msg
2982 Jump to the message which is displayed last.
2983 (@code{wl-summary-goto-last-displayed-msg})
2987 Put @samp{*} mark on the messages that satisfies the specified condition.
2988 @findex wl-summary-pick
2989 (@code{wl-summary-pick})
2993 @findex wl-summary-mark-as-read
2994 Mark as read the message at the current cursor point.
2995 (@code{wl-summary-mark-as-read})
2999 Prefetch the message at the current cursor point.
3000 With prefix argument, prefetch the message even if it is cached.
3001 @findex wl-summary-prefetch
3002 (@code{wl-summary-prefetch})
3006 Execute @samp{D}, @samp{o} and @samp{O} marks.
3007 @findex wl-summary-exec
3008 (@code{wl-summary-exec})
3012 @findex wl-summary-target-mark-line
3013 Put target mark on the message at the current cursor point.
3014 (@code{wl-summary-target-mark-line})
3018 Put refile mark on the message at the current cursor point.
3019 @findex wl-summary-refile
3020 (@code{wl-summary-refile})
3023 @kindex C-o (Summary)
3024 Execute auto refile.
3025 @findex wl-summary-auto-refile
3026 (@code{wl-summary-auto-refile})
3030 Put copy mark on the message at the current cursor point.
3031 @findex wl-summary-copy
3032 (@code{wl-summary-copy})
3035 @kindex M-o (Summary)
3036 Put refile mark on the message at the current cursor point with the destination
3037 previously specified.
3038 @findex wl-summary-refile-prev-destination
3039 (@code{wl-summary-refile-prev-destination})
3043 @findex wl-summary-delete
3044 Put delete mark on the message at the current cursor point.
3045 (@code{wl-summary-delete})
3049 @findex wl-summary-unmark
3050 Unmark the temporal mark on the message at the current cursor point.
3051 (@code{wl-summary-unmark})
3055 Unmark all the temporal marks.
3056 @findex wl-summary-unmark-all
3057 (@code{wl-summary-unmark-all})
3060 @kindex r R (Summary)
3061 @findex wl-summary-mark-as-read-region
3062 Mark as read messages in the specified region.
3063 (@code{wl-summary-mark-as-read-region})
3066 @kindex r $ (Summary)
3067 @findex wl-summary-mark-as-important-region
3068 Mark as important @samp{$} messages in the specified region.
3069 If @samp{$} already exists, it is deleted.
3070 (@code{wl-summary-mark-as-important-region})
3073 @kindex r ! (Summary)
3074 @findex wl-summary-mark-as-unread-region
3075 Mark as unread messages in the specified region.
3076 (@code{wl-summary-mark-as-unread-region})
3079 @kindex r i (Summary)
3080 @findex wl-summary-prefetch-region
3081 Prefetch messages in the specified region.
3082 (@code{wl-summary-prefetch-region})
3085 @kindex r x (Summary)
3086 @findex wl-summary-exec-region
3087 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3089 (@code{wl-summary-exec-region})
3092 @kindex r * (Summary)
3093 @findex wl-summary-target-mark-region
3094 Put target mark on the messages in the specified region.
3095 (@code{wl-summary-target-mark-region})
3098 @kindex r o (Summary)
3099 @findex wl-summary-refile-region
3100 Put refile mark on the messages in the specified region.
3101 (@code{wl-summary-refile-region})
3104 @kindex r O (Summary)
3105 @findex wl-summary-copy-region
3106 Put copy mark on the messages in the specified region.
3107 (@code{wl-summary-copy-region})
3110 @kindex r d (Summary)
3111 @findex wl-summary-delete-region
3112 Put delete mark on the messages in the specified region.
3113 (@code{wl-summary-delete-region})
3116 @kindex r u (Summary)
3117 @findex wl-summary-unmark-region
3118 Delete temporal mark on the messages in the specified region.
3119 (@code{wl-summary-unmark-region})
3122 @kindex r y (Summary)
3123 Save messages in the specified region.
3124 @findex wl-summary-save-region
3125 (@code{wl-summary-save-region})
3128 @kindex t R (Summary)
3129 @findex wl-thread-mark-as-read
3130 Mark as read messages which are the descendant of the current thread.
3131 With prefix argument, it affects on the all messages in the thread tree.
3132 (@code{wl-thread-mark-as-read})
3135 @kindex t $ (Summary)
3136 @findex wl-thread-mark-as-important
3137 Put important mark @samp{$} on the messages which are the
3138 descendant of the current thread.
3139 If @samp{$} mark exists, it is deleted.
3140 With prefix argument, it affects on the all messages in the thread tree.
3141 (@code{wl-thread-mark-as-important})
3144 @kindex t ! (Summary)
3145 @findex wl-thread-mark-as-unread
3146 Mark as unread messages which are the descendant of the current thread.
3147 With prefix argument, it affects on the all messages in the thread tree.
3148 (@code{wl-thread-mark-as-unread})
3151 @kindex t i (Summary)
3152 @findex wl-thread-prefetch
3153 Prefetch messages which are the descendant of the current thread.
3154 With prefix argument, it affects on the all messages in the thread tree.
3155 (@code{wl-thread-prefetch})
3158 @kindex t x (Summary)
3159 @findex wl-thread-exec
3160 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3161 the descendant of the current thread. With prefix argument, it affects
3162 on the all messages in the thread tree.
3163 (@code{wl-thread-exec})
3166 @kindex t * (Summary)
3167 @findex wl-thread-target-mark
3168 Put target mark @samp{*} on the messages which are the descendant of the
3169 current thread. With prefix argument, it affects on the all messages in
3171 (@code{wl-thread-target-mark})
3174 @kindex t o (Summary)
3175 @findex wl-thread-refile
3176 Put refile mark on the messages which are the descendant of the current thread.
3177 With prefix argument, it affects on the all messages in the thread tree.
3178 (@code{wl-thread-refile})
3181 @kindex t O (Summary)
3182 @findex wl-thread-copy
3183 Put copy mark on the messages which are the descendant of the current thread.
3184 With prefix argument, it affects on the all messages in the thread tree.
3185 (@code{wl-thread-copy})
3188 @kindex t d (Summary)
3189 @findex wl-thread-delete
3190 Put delete mar on the messages which are the descendant of the current thread.
3191 With prefix argument, it affects on the all messages in the thread tree.
3192 (@code{wl-thread-delete})
3195 @kindex t u (Summary)
3196 @findex wl-thread-unmark
3197 Unmark temporal mark on the messages which are the descendant of the
3198 current thread. With prefix argument, it affects on the all messages in
3200 (@code{wl-thread-unmark})
3203 @kindex t y (Summary)
3204 @findex wl-thread-save
3205 Save messages which are the descendant of the current thread.
3206 With prefix argument, it affects on the all messages in the thread tree.
3207 (@code{wl-thread-save})
3210 @kindex m i (Summary)
3211 @findex wl-summary-target-mark-prefetch
3212 Prefetch all messages which have target mark @samp{*}.
3213 (@code{wl-summary-target-mark-prefetch})
3216 @kindex m R (Summary)
3217 @findex wl-summary-target-mark-mark-as-read
3218 Mark as read all messages which have target mark @samp{*}.
3219 (@code{wl-summary-target-mark-mark-as-read})
3222 @kindex m $ (Summary)
3223 @findex wl-summary-target-mark-mark-as-important
3224 Mark as important all messages which have target mark @samp{*}.
3225 If already marked as @samp{$}, it is deleted.
3226 (@code{wl-summary-target-mark-mark-as-important})
3229 @kindex m ! (Summary)
3230 @findex wl-summary-target-mark-mark-as-unread
3231 Mark as unread all messages which have target mark @samp{*}.
3232 (@code{wl-summary-target-mark-mark-as-unread})
3235 @kindex m o (Summary)
3236 @findex wl-summary-target-mark-refile
3237 Put refile mark on the messages which have target mark @samp{*}.
3238 (@code{wl-summary-target-mark-refile})
3241 @kindex m O (Summary)
3242 @findex wl-summary-target-mark-copy
3243 Put copy mark on the messages which have target mark @samp{*}.
3244 (@code{wl-summary-target-mark-copy})
3247 @kindex m d (Summary)
3248 @findex wl-summary-target-mark-delete
3249 Put delete mark on the messages which have target mark @samp{*}.
3250 (@code{wl-summary-target-mark-delete})
3253 @kindex m y (Summary)
3254 @findex wl-summary-target-mark-save
3255 Save messages which have target mark @samp{*}.
3256 (@code{wl-summary-target-mark-save})
3259 @kindex m u (Summary)
3260 Unmark all temporal marks.
3261 (@code{wl-summary-delete-all-temp-marks})
3262 @findex wl-summary-delete-all-temp-marks
3265 @kindex m a (Summary)
3266 Put target mark @samp{*} on the all messages.
3267 (@code{wl-summary-target-mark-all})
3268 @findex wl-summary-target-mark-all
3271 @kindex m t (Summary)
3272 Put target mark @samp{*} on the messages in the current thread.
3273 @findex wl-summary-target-mark-thread
3274 (@code{wl-summary-target-mark-thread})
3277 @kindex m r (Summary)
3278 @findex wl-summary-target-mark-region
3279 Put target mark @samp{*} on the messages in the specified region.
3280 (@code{wl-summary-target-mark-region})
3283 @kindex m A (Summary)
3284 @findex wl-summary-target-mark-reply-with-citation
3285 Prepare a draft which cites all messages which have target mark @samp{*}.
3286 (@code{wl-summary-target-mark-reply-with-citation})
3289 @kindex m f (Summary)
3290 @findex wl-summary-target-mark-forward
3291 Prepare a draft which forwards all messages which have target mark @samp{*}.
3292 (@code{wl-summary-target-mark-forward})
3295 @kindex m U (Summary)
3296 @findex wl-summary-target-mark-uudecode
3297 Uudecode the messages which have target mark @samp{*}.
3298 (@code{wl-summary-target-mark-uudecode})
3301 @kindex m ? (Summary)
3302 @findex wl-summary-target-mark-pick
3303 Pick messages from the @samp{*} marked messages.
3304 That is, @samp{*} marks on the messages are remained
3305 if the specified condition is satisfied.
3306 (@code{wl-summary-target-mark-pick})
3309 @kindex M-t (Summary)
3310 @findex wl-toggle-plugged
3311 Toggle offline/online status of Wanderlust.
3312 (@code{wl-toggle-plugged})
3315 @kindex C-t (Summary)
3316 Start Wanderlust's plug-status manager.
3317 (@code{wl-plugged-change})
3320 @kindex C-c C-o (Summary)
3321 @findex wl-jump-to-draft-buffer
3322 Move to the draft buffer if available. If multiple draft buffer exists,
3323 moved to one after another. If prefix argument is specified, load draft
3324 folder's message to the draft buffer and jump to it.
3325 (@code{wl-jump-to-draft-buffer})
3329 @node Variables of Summary, , Key Bindings of Summary, Summary
3330 @section Customiziable variables
3333 @item wl-summary-move-order
3334 @vindex wl-summary-move-order
3335 The initial setting is @code{unread}. Specify cursor moving policy. If
3336 you want to precede new messages, set @code{new}. If you want to
3337 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3340 @item wl-auto-select-first
3341 @vindex wl-auto-select-first
3342 The initial setting is @code{nil}.
3343 If non-nil, first message is automatically displayed.
3345 @item wl-auto-select-next
3346 @vindex wl-auto-select-next
3347 The initial setting is @code{nil}. If non-nil, jump to next summary
3348 automatically. If @code{unread}, jump to next unread folder's summary
3349 after confirmation. If @code{skip-no-unread}, unread folders are
3350 automatically skipped.
3352 @item wl-thread-insert-opened
3353 @vindex wl-thread-insert-opened
3354 The initial setting is @code{nil}.
3355 If non-nil, thread is inserted as opened.
3357 @item wl-thread-open-reading-thread
3358 @vindex wl-thread-open-reading-thread
3359 The initial setting is @code{t}. If non-nil, reading thread is
3360 automatically opened though it is closed thread.
3362 @item wl-summary-exit-next-move
3363 @vindex wl-summary-exit-next-move
3364 The initial setting is @code{t}. If non-nil, move to next folder at
3367 @item wl-folder-move-cur-folder
3368 @vindex wl-folder-move-cur-folder
3369 The initial setting is @code{nil}. If non-nil, cursor position on the
3372 @item wl-summary-weekday-name-lang
3373 @vindex wl-summary-weekday-name-lang
3374 The initial setting is @samp{ja}. Specify language of the weekday.
3375 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3378 @item wl-summary-fix-timezone
3379 @vindex wl-summary-fix-timezone
3380 The initial setting is @samp{JST}. Timezone to adjust summary's
3381 timezone. If @code{nil}, adjust to GMT.
3383 @item wl-use-petname
3384 @vindex wl-use-petname
3385 The initial setting is @code{t}.
3386 If non-nil, sender part displays nickname.
3388 @item wl-break-pages
3389 @vindex wl-break-pages
3390 The initial setting is @code{t}.
3391 If non-nil, message is splitted as pages by @samp{^L}.
3393 @item wl-message-window-size
3394 @vindex wl-message-window-size
3395 The initial setting is '(1 . 4).
3396 A cons cell to specify the rate of summary and message window.
3397 car:cdr corresponds summary:message.
3399 @item wl-summary-recenter
3400 @vindex wl-summary-recenter
3401 The initial setting is t.
3402 If non-nil, cursor point is moved to the center of the summary window.
3404 @item wl-summary-indent-length-limit
3405 @vindex wl-summary-indent-length-limit
3406 The initial setting is 46.
3407 Specify the limit of thread indent level.
3408 If nil, max indent level is unlimited.
3410 @item wl-summary-no-from-message
3411 @vindex wl-summary-no-from-message
3412 The initial setting is @samp{nobody@@nowhere?}. A string which is
3413 displayed when there's no @samp{From:} field in the message.
3415 @item wl-summary-no-subject-message
3416 @vindex wl-summary-no-subject-message
3417 The initial setting is @samp{(WL:No Subject in original.)}. A string
3418 which is displayed when there's no @samp{Subject:} field in the message.
3420 @item wl-summary-width
3421 @vindex wl-summary-width
3422 The initial setting is 80.
3423 Width of summary line. If @code{nil}, summary line's width is as is.
3425 @item wl-use-folder-petname
3426 @vindex wl-use-folder-petname
3427 The initial setting is the list shown below:
3436 A list of display policy (symbol) of folder nickname. Available symbols
3441 Display folder petname on modeline.
3443 Destination folder is notified as nickname if
3444 @code{wl-auto-select-next} is non-nil.
3446 You can input folder name by nickname in the function
3447 @code{wl-summary-read-folder}.
3450 @item wl-summary-move-direction-toggle
3451 @vindex wl-summary-move-direction-toggle
3452 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3453 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3454 want to aware of reading direction, set this to @code{t}.
3457 @vindex wl-from-width
3458 The initial setting is 17.
3459 Width of sender part of summary line.
3461 @item wl-summary-divide-thread-when-subject-changed
3462 @vindex wl-summary-divide-thread-when-subject-changed
3463 The initial setting is @code{nil}. If non-nil, thread is splitted if
3464 the subject is changed.
3466 @item wl-summary-search-via-nntp
3467 @vindex wl-summary-search-via-nntp
3468 The initial setting is @code{confirm}.
3470 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3471 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3472 from the NNTP server @code{elmo-default-nntp-server}. The value of
3473 @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
3474 @code{elmo-default-nntp-ssl} are used.
3476 If @code{confirm}, server name can be specified. You can specify NNTP
3477 folder format like @samp{-:username@@servername:119!}.
3479 @item wl-summary-keep-cursor-command
3480 @vindex wl-summary-keep-cursor-command
3481 The initial setting is the list shown below:
3485 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3490 When you entered to summary by these commands and the target summary
3491 buffer already exists, summary status is not automatically updated and
3492 cursor position is saved.
3494 @item wl-summary-update-confirm-threshold
3495 @vindex wl-summary-update-confirm-threshold
3496 The initial setting is 500. If updated message number is larger than
3497 this value, confirm whether drop them or not.
3499 @item wl-summary-always-sticky-folder-list
3500 @vindex wl-summary-always-sticky-folder-list
3501 The initial setting is @code{nil}.
3502 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3503 are automatically sticked. Each element is regexp of folder name.
3505 @item wl-summary-reserve-mark-list
3506 @vindex wl-summary-reserve-mark-list
3507 The initial setting is the list shown below:
3516 If a message is already marked as temporal marks in this list, the
3517 message is not marked by any mark command.
3519 @item wl-summary-skip-mark-list
3520 @vindex wl-summary-skip-mark-list
3521 The initial setting is the list shown below:
3530 If a message is already marked as temporal marks in this list, the
3531 message is skipped at cursor move.
3533 @item wl-fetch-confirm-threshold
3534 @vindex wl-fetch-confirm-threshold
3535 The initial setting is 30000 (bytes). If displaying message has larger
3536 size than this value, Wanderlust confirms whether fetch the message or
3537 not. If @code{nil}, the message is fetched without confirmation.
3539 @item wl-prefetch-threshold
3540 @vindex wl-prefetch-threshold
3541 The initial setting is 30000 (bytes). If prefetching message has larger
3542 size than this value and @code{wl-prefetch-confirm} is non-nil,
3543 Wanderlust confirms whether prefetch the message or not. If
3544 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3545 without confirmation.
3547 @item wl-prefetch-confirm
3548 @vindex wl-prefetch-confirm
3549 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3550 prefetch the message or not if the message has larger size than
3551 @code{wl-prefetch-threshold}.
3553 @item wl-cache-fetch-threshold
3554 @vindex wl-cache-fetch-threshold
3555 The initial setting is 30000 (bytes). The messages which have larger
3556 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3557 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3560 @item elmo-imap4-use-cache
3561 @vindex elmo-imap4-use-cache
3562 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3565 @item elmo-nntp-use-cache
3566 @vindex elmo-nntp-use-cache
3567 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3570 @item elmo-pop3-use-cache
3571 @vindex elmo-pop3-use-cache
3572 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3577 @node Message, Draft, Summary, Top
3578 @chapter Message Buffer
3580 Message Buffers utilize MIME-View mode of SEMI/tm. For operational
3581 procedures and key bindings, refer to respective documents.
3582 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3584 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3585 brings you back to Summary mode. @kbd{l} toggles display of Summary
3588 @section Key Bindings
3594 @findex wl-message-toggle-disp-summary
3595 Toggles display of Summary mode buffer.
3596 (@code{wl-message-toggle-disp-summary})
3599 @findex wl-message-refer-article-or-url
3600 @kindex Button-2 (Message)
3601 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3602 corresponding message if found.
3603 (@code{wl-message-refer-article-or-url})
3605 @item Button-4 (upward movement of a wheel)
3606 @kindex Button-4 (Message)
3607 @findex wl-message-wheel-down
3608 Scrolls the message backwards. When the top of the message is hit,
3609 moves to the previous message.
3610 (@code{wl-message-wheel-down})
3612 @item Button-5 (downward movement of a wheel)
3613 @kindex Button-5 (Message)
3614 @findex wl-message-wheel-up
3615 Scrolls the message forward. When the bottom of the message is hit,
3616 moves to the next message.
3617 (@code{wl-message-wheel-up})
3620 @section Customizable Variables
3623 @item wl-message-window-size
3624 @vindex wl-message-window-size
3625 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3626 its car and cdr value corresponds to the ratio of Summary and Message
3631 @node Draft, Disconnected Operations, Message, Top
3632 @chapter Draft Buffer
3634 At Summary mode, pressing @kbd{w} and the like creates a new draft
3635 buffer. You can edit and send mail and news articles in this buffer.
3639 Basically it is Emacs-standard mail mode.
3641 @subsection Address Completion
3643 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3644 addresses. @kbd{@key{TAB}} completes them.
3646 If you want to submit a news article, add @samp{Newsgroups:} field by
3647 yourself. Field names can be completed by @kbd{@key{TAB}}.
3649 If you save the draft buffer you are editing, it is appended to the
3650 folder specified by @code{wl-draft-folder}.
3652 Using @samp{FCC:} field, you can specify the folder to which a copy of
3653 the message is saved when it is sent.
3655 @subsection Editing Messages
3657 Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
3658 editing, refer to respective documents.
3659 @xref{MIME-Edit, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3661 @subsection Dynamic Modification of Messages
3662 @vindex wl-draft-config-alist
3663 @c @cindex Change Message
3664 @c @cindex Message, Change Dynamic
3666 You can set @code{wl-draft-config-alist} so that header and body of the
3667 message will automatically modified depending on information of header
3670 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3672 In the example below, the header is modified when
3673 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3674 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3675 before sending the message.
3679 (setq wl-draft-config-alist
3680 '(((string-match "aaa.ne.jp$" (system-name))
3681 ;; @r{applied if the expression is non-nil}
3682 (wl-smtp-posting-server . "mailserver-B")
3683 (wl-nntp-posting-server . "newsserver-B")
3684 ;; @r{settings of temporary variables}
3686 ("^To: .*user@@aaa.bbb.com"
3687 ;; @r{applied if it matches the header of the draft buffer}
3688 ("Organization" . (format "Go %s" my-webpage)))
3689 ;; @r{you can write elisp expressions here (eval only)}
3690 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3691 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3696 The format of @code{wl-draft-config-alist} is:
3700 '(("@var{regexp of the header}" or @var{elisp expression}
3701 ("@var{Field}" . value(@var{elisp expression}))
3702 (@var{variable} . value(@var{elisp expression}))
3703 (@var{sub-function} . value(@var{elisp expression}))
3706 ("@var{regexp of the header}" or @var{elisp expression}
3707 ("@var{Field}" . value(@var{elisp expression}))
3712 Per default, there are 10 following sub-functions.
3715 'header: Inserts the specified string at the bottom of the header.
3716 'header-file: Inserts the specified file at the bottom of the header.
3717 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3718 'top: Inserts the specified string at the top of the body.
3719 'top-file: Inserts the specified file at the top of the body.
3720 'body: Replaces the body with the specified string.
3721 Specifying @code{nil} deletes the entire body string.
3722 'body-file: Replaces the body with the content of the specified file.
3723 'bottom: Inserts the specified string at the bottom of the body.
3724 'bottom-file: Inserts the specified file at the top of the body.
3725 'template: Applies the specified template.
3726 (refer to the next subsection)
3729 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3730 change them or add your own functions. If you read the code, you can
3731 easily find how to write the functions.
3733 At the first of each item, @var{a regular expression of the header} or
3734 an @var{elisp expression} should be specified. In the case of an elisp
3735 expression, the item is applied when the expression is evaluated
3738 Per default, when multiple items match or are evaluated non-nil, all
3739 such items are applied, but if you set a variable
3740 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3743 At the second of the item, a cons or a list of functions should be
3744 specified. The car part of the cons should be a header field, a
3745 variable, or a sub-function. When a header field is specified, the
3746 field will be modified. If a variable is specified, the value of the
3747 variable will be modified temporarily.
3749 In the cdr part of a cons, not only a variable but also an elisp
3750 expression can be specified as is. If the car part is a header field
3751 and the cdr part is @code{nil}, the field will be deleted.
3753 See the next example as well:
3757 (setq wl-draft-config-alist
3759 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3760 ;; @r{applied if it matches the header of the buffer being replied}
3761 (body . " Hello.\n")
3762 (template . "default")
3767 As in the (1) above, if a header regexp is prepended with @code{reply},
3768 it is applied when the draft is prepared by @code{wl-summary-reply} for
3769 example, and when it matches the header being replied. It is ignored
3770 when there is no buffer being replied, like after @code{wl-draft} was
3773 Note that @code{wl-draft-config-alist} is applied only once when
3774 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3775 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3776 aborting transmission, execute @kbd{C-c C-e}
3777 (@code{wl-draft-config-exec}).
3779 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3780 prepared, do the following:
3783 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3786 @subsection Inserting Templates
3788 @cindex Apply Template
3790 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3791 @kbd{M-x wl-template-select} in the draft buffer.
3793 The format of @code{wl-template-alist} is almost the same as
3794 @code{wl-draft-config-alist}.
3798 (setq wl-template-alist
3801 ("Organization" . "~/.wl sample")
3802 (body . "Hello.\n"))
3804 (template . "default") ;; @r{(a)}
3805 ("To" . "jousi@@kaisha.jp")
3806 ("Subject" . "Report")
3807 (body-file . "~/work/report.txt")
3813 As you can see, the only difference is item (template) names such as
3814 @samp{default} and @samp{report}, instead of a regexp of header.
3815 Because definition of each item is the same as
3816 @code{wl-draft-config-alist}, you can call another template, like (a).
3818 Executing the command @code{wl-template-select} results in template
3819 selection, but the result differs depending on variable
3820 @code{wl-template-visible-select}.
3822 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3823 window is shown below the draft buffer. You can select a template by
3824 @kbd{n} and @kbd{p} seeing the buffer window.
3826 Press the @key{RET} key and the template is actually applied to the draft
3827 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3828 adjust the window size by @code{wl-template-buffer-lines}.
3830 If @code{wl-template-visible-select} is @code{nil}, you should type the
3831 name of the template in the mini buffer.
3833 As shown in the example in @code{wl-draft-config-alist}, you can select
3834 @samp{default} template by writing:
3837 (template . "default")
3840 @subsection Sending mail by POP-before-SMTP
3841 @cindex POP-before-SMTP
3843 You can send mail by POP-before-SMTP with this single line:
3846 (setq wl-draft-send-mail-func 'wl-draft-send-mail-with-pop-before-smtp)
3850 Configure the following variables if you need.
3853 @item wl-pop-before-smtp-user
3854 The POP user name for POP-before-SMTP authentication.
3855 If unset, @code{elmo-default-pop3-user} is used.
3857 @item wl-pop-before-smtp-server
3858 The POP server name for POP-before-SMTP authentication.
3859 If unset, @code{elmo-default-pop3-server} is used.
3861 @item wl-pop-before-smtp-authenticate-type
3862 The POP authentication method for POP-before-SMTP authentication.
3863 If unset, @code{elmo-default-pop3-authenticate-type} is used.
3865 @item wl-pop-before-smtp-port
3866 The POP port number for POP-before-SMTP authentication.
3867 If unset, @code{elmo-default-pop3-port} is used.
3869 @item wl-pop-before-smtp-ssl
3870 If non-nil, POP connection is established using SSL. If
3871 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
3872 unset, @code{elmo-default-pop3-ssl} is used.
3875 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
3876 unset, settings for POP folders (@code{elmo-default-pop3-*}) are
3878 Therefore, if SMTP server and POP server are actually the same, and if
3879 POP folder per default (such as @samp{&}) is available, no settings are
3882 Refer to the following URL about POP-before-SMTP.
3886 http://spam.ayamura.org/tools/smPbS.html
3887 http://www.iecc.com/pop-before-smtp.html
3891 @section Key Bindings
3892 @cindex Keybind, Draft Mode
3893 @cindex Keybind, Draft Buffer
3898 @kindex C-c C-y (Draft)
3899 @findex wl-draft-yank-original
3900 Cites the content of the current message buffer.
3901 (@code{wl-draft-yank-original})
3904 @kindex C-c C-p (Draft)
3905 @findex wl-draft-preview-message
3906 Previews the content of the current draft.
3907 This is useful for previewing MIME multi-part messages.
3908 (@code{wl-draft-preview-message})
3911 @kindex C-c C-s (Draft)
3912 @findex wl-draft-send
3913 Sends the content of the current draft. Does not erase the draft buffer.
3914 This is useful for sending multiple messages, which are a little different
3916 (@code{wl-draft-send})
3919 @kindex C-c C-c (Draft)
3920 @findex wl-draft-send-and-exit
3921 Sends the content of the current draft and erases the draft buffer.
3922 (@code{wl-draft-send-and-exit})
3925 @kindex C-x C-s (Draft)
3926 @findex wl-draft-save
3927 Save the current draft.
3928 (@code{wl-draft-save})
3931 @kindex C-c C-k (Draft)
3932 @findex wl-draft-kill
3933 Kills the current draft.
3934 (@code{wl-draft-kill})
3937 @kindex C-x k (Draft)
3938 @findex wl-draft-mimic-kill-buffer
3939 Kills the current draft.
3940 (@code{wl-draft-mimic-kill-buffer})
3943 @kindex C-c C-z (Draft)
3944 @findex wl-draft-save-and-exit
3945 Saves the current draft, and erases the draft buffer.
3946 This is useful if you want to suspend editing of the draft.
3947 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
3948 the @samp{+draft} folder.
3949 (@code{wl-draft-save-and-exit})
3952 @kindex C-c C-r (Draft)
3953 @findex wl-caesar-region
3954 Encodes or decodes the specified region in Caesar cipher.
3955 (@code{wl-caesar-region})
3959 @findex wl-toggle-plugged
3960 Toggles off-line/on-line states of Wanderlust.
3961 (@code{wl-toggle-plugged})
3964 @kindex C-c C-o (Draft)
3965 @findex wl-jump-to-draft-buffer
3966 Jumps to the other draft buffer, if exists.
3967 With prefix argument, reads a file (if any) from the draft folder when
3968 there is no such buffer.
3969 (@code{wl-jump-to-draft-buffer})
3972 @kindex C-c C-e (Draft)
3973 @findex wl-draft-config-exec
3974 Applies @code{wl-draft-config-alist}.
3975 (@code{wl-draft-config-exec})
3978 @kindex C-c C-j (Draft)
3979 @findex wl-template-select
3981 (@code{wl-template-select})
3984 @kindex C-c C-a (Draft)
3985 @findex wl-draft-insert-x-face-field
3986 Inserts the content of a file @file{~/.xface} (the value of the variable
3987 @code{wl-x-face-file}) as an @samp{X-Face:} field in the draft buffer.
3989 There should be encoded X-Face strings as a content of a file @file{~/.xface}.
3990 (@code{wl-draft-insert-x-face-field})
3993 @section Customizable Variables
3996 @item wl-subscribed-mailing-list
3997 @vindex wl-subscribed-mailing-list
3998 The initial setting is @code{nil}. Mailing lists to which you
3999 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4000 field of a reply draft, removes your own address from
4001 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4002 contained in @samp{To:} or @samp{Cc:} field of a message to be
4003 automatically re-filed, the destination folder will be leaned in
4004 connection with the address.
4006 @item wl-insert-mail-followup-to
4007 @vindex wl-insert-mail-followup-to
4008 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4009 field is automatically inserted in the draft buffer.
4011 @item wl-insert-mail-reply-to
4012 @vindex wl-insert-mail-reply-to
4013 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4014 field is automatically inserted in the draft buffer.
4016 @item wl-auto-insert-x-face
4017 @vindex wl-auto-insert-x-face
4018 The initial setting is @code{t}. If non-nil and there is an encoded
4019 X-Face string in a file @file{~/.xface} (the value of the variable
4020 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4021 draft buffer. If @code{nil}, it is not automatically inserted. Press
4022 @kbd{C-c C-a} to insert.
4024 @item wl-insert-message-id
4025 @vindex wl-insert-message-id
4026 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4027 is automatically inserted on the transmission.
4029 @item wl-local-domain
4030 @vindex wl-local-domain
4031 The initial setting is @code{nil}. If @code{nil}, the return value of
4032 the function @code{system-name} will be used as the domain part of
4035 If @code{system-name} does not return FQDN (i.e. the full name of the
4036 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4037 to the string of the local domain name without hostname (like
4038 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4039 @samp{.} @code{wl-local-domain} is used as domain part of the
4042 If your terminal does not have global IP, set the value of
4043 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4044 you use invalid @samp{Message-ID:}.)
4046 Moreover, concatenation of @code{system-name} @samp{.}
4047 @code{wl-local-domain} will be used as an argument to the HELO command
4050 @item wl-message-id-domain
4051 @vindex wl-message-id-domain
4052 The initial setting is @code{nil}. If non-nil, this value is used as a
4053 domain part of the @samp{Message-ID:}. If your terminal does not have
4054 global IP address, set unique string to this value (e.x. your e-mail
4057 @item wl-message-id-domain
4058 @vindex wl-message-id-domain
4059 The initial setting is @code{nil}. If @code{nil}, the return value of
4060 the function @code{system-name} will be used as the domain part of
4061 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4062 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4063 @strong{must} set this variable to the string of the full name of the
4064 host. Otherwise, you might be beaten up on the Net News.
4066 @item wl-draft-config-alist
4067 @vindex wl-draft-config-alist
4068 The initial setting is @code{nil}. Modifies the draft message just
4069 before the transmission. The content of @code{wl-draft-config-alist}
4070 will be automatically applied only once on the transmission. If you
4071 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4074 @item wl-template-alist
4075 @vindex wl-template-alist
4076 The initial setting is @code{nil}.
4077 This variable specifies the template to be applied in the draft buffer.
4079 @item wl-draft-config-matchone
4080 @vindex wl-draft-config-matchone
4081 The initial setting is @code{nil}. If non-nil, only the first matching
4082 item is used when @code{wl-draft-config-alist} is applied. If
4083 @code{nil}, all matching items are used.
4085 @item wl-template-visible-select
4086 @vindex wl-template-visible-select
4087 The initial setting is @code{t}.
4088 If non-nil, you can preview the result of the template selection in
4091 @item wl-template-confirm
4092 @vindex wl-template-confirm
4093 The initial setting is @code{nil}.
4094 If non-nil, asks for confirmation when you press the enter key to select
4095 template while previewing.
4097 @item wl-template-buffer-lines
4098 @vindex wl-template-buffer-lines
4099 The initial setting is 7.
4100 If @code{wl-template-visible-select} is non-nil, this variable specifies
4101 the size of the preview window.
4103 @item wl-draft-reply-buffer-style
4104 @vindex wl-draft-reply-buffer-style
4105 The initial setting is @code{split}. @code{split} or @code{full} can be
4106 specified. In the case of @code{full}, the whole frame will be used for
4107 a reply draft buffer when it is prepared.
4109 @item wl-draft-use-frame
4110 @vindex wl-draft-use-frame
4111 The initial setting is @code{nil}.
4112 If non-nil, use new frame for the draft.
4116 The initial setting is the value of the variable
4117 @code{user-mail-address}. The value of this variable is inserted as a
4118 @samp{From:} field of the draft when it is prepared.
4120 @item wl-envelope-from
4121 @vindex wl-envelope-from
4122 The initial setting is @code{nil}.
4123 The value of this variable is used for envelope from (MAIL FROM).
4124 If @code{nil}, the address part of @code{wl-from} is used.
4126 @item wl-user-mail-address-list
4127 @vindex wl-user-mail-address-list
4128 The initial setting is @code{nil}.
4129 This is the User's address list. If you have multiple addresses,
4134 The initial setting is @code{nil}.
4135 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4136 the draft when it is prepared. If function is specified, its return
4141 The initial setting is @code{nil}.
4142 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4143 the draft when it is prepared.
4145 @item wl-reply-subject-prefix
4146 @vindex wl-reply-subject-prefix
4147 The initial setting is @samp{Re: }.
4148 In the @samp{Subject:} of the reply draft, this string is prepended to
4149 the @samp{Subject:} of being replied.
4151 @item wl-draft-reply-use-address-with-full-name
4152 @vindex wl-draft-reply-use-address-with-full-name
4153 The initial setting is @code{t}.
4154 If non-nil, insert her full name with address when prepare a draft for
4155 reply a message. If it is @code{nil}, insert her address only.
4157 @item wl-draft-enable-queuing
4158 @vindex wl-draft-enable-queuing
4159 The initial setting is @code{t}.
4160 This flag controls off-line transmission. If non-nil, the draft is
4163 @item wl-draft-use-cache
4164 @vindex wl-draft-use-cache
4165 The initial setting is @code{t}.
4166 If non-nil, cache the message which is sent.
4168 @item wl-auto-flush-queue
4169 @vindex wl-auto-flush-queue
4170 The initial setting is t.
4171 This flag controls automatic transmission of the queue when Wanderlust
4172 becomes on-line. If non-nil, the queue is automatically transmitted
4173 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4174 manually, press @kbd{F} in the folder mode.
4176 @item wl-draft-always-delete-myself
4177 @vindex wl-draft-always-delete-myself
4178 If non-nil, always removes your own address from @samp{To:} and
4179 @samp{Cc:} when you are replying to the mail addressed to you.
4181 @item wl-smtp-posting-server
4182 @vindex wl-smtp-posting-server
4183 The initial setting is @code{nil}.
4184 This is the SMTP server name for mail transmission.
4186 @item wl-smtp-posting-user
4187 @vindex wl-smtp-posting-user
4188 The initial setting is @code{nil}.
4189 This is the user name for SMTP AUTH authentication. If @code{nil},
4190 @code{smtp-authenticate-user} is used.
4192 @item wl-smtp-authenticate-type
4193 @vindex wl-smtp-authenticate-type
4194 The initial setting is @code{nil}.
4195 This is the authentication method for SMTP AUTH authentication. If
4196 @code{nil}, @code{smtp-authenticate-type} is used. If
4197 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4200 @item wl-smtp-connection-type
4201 @vindex wl-smtp-connection-type
4202 The initial setting is @code{nil}.
4203 This variable specifies how to establish SMTP connections.
4204 If @code{nil}, @code{smtp-connection-type} is used.
4205 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4207 @item wl-nntp-posting-server
4208 @vindex wl-nntp-posting-server
4209 The initial setting is @code{nil}.
4210 This is the NNTP server name used for news submission.
4211 If @code{nil}, @code{elmo-default-nntp-server} is used.
4213 @item wl-nntp-posting-user
4214 @vindex wl-nntp-posting-user
4215 The initial setting is @code{nil}.
4216 This is the user name for AUTHINFO authentication on news submission.
4217 If @code{nil}, @code{elmo-default-nntp-user} is used.
4218 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4220 @item wl-nntp-posting-port
4221 @vindex wl-nntp-posting-port
4222 The initial setting is @code{nil}.
4223 This is the port number of the NNTP server used for news submission.
4224 If @code{nil}, @code{elmo-default-nntp-server} is used.
4226 @item wl-nntp-posting-ssl
4227 @vindex wl-nntp-posting-ssl
4228 The initial setting is @code{nil}.
4229 If @code{nil}, @code{elmo-default-nntp-ssl} is evaluated. If non-nil,
4230 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4231 connection will be established.
4233 @item wl-pop-before-smtp-user
4234 @vindex wl-pop-before-smtp-user
4235 The initial setting is @code{nil}.
4236 This is the POP user name for POP-before-SMTP.
4237 If it is @code{nil}, @code{elmo-default-pop3-user} is used.
4239 @item wl-pop-before-smtp-server
4240 @vindex wl-pop-before-smtp-server
4241 The initial setting is @code{nil}.
4242 This is the POP server name for POP-before-SMTP.
4243 If it is @code{nil}, @code{elmo-default-pop3-server} is used.
4245 @item wl-pop-before-smtp-authenticate-type
4246 @vindex wl-pop-before-smtp-authenticate-type
4247 The initial setting is @code{nil}.
4248 This is the authentication method for POP-before-SMTP authentication.
4249 If it is @code{nil}, @code{elmo-default-pop3-authenticate} is used.
4251 @item wl-pop-before-smtp-port
4252 @vindex wl-pop-before-smtp-port
4253 The initial setting is @code{nil}.
4254 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4255 @code{elmo-default-pop3-port} is used.
4257 @item wl-pop-before-smtp-ssl
4258 @vindex wl-pop-before-smtp-ssl
4259 The initial setting is @code{nil}.
4260 This flag controls the use of SSL for POP-before-SMTP. If it is
4261 @code{nil}, @code{elmo-default-pop3-ssl} is used. If @code{starttls},
4262 STARTTLS (RFC2595) connection will be established.
4264 @item wl-draft-queue-save-variables
4265 @vindex wl-draft-queue-save-variables
4266 Specifies a list of variable to which queued messages are saved on the
4267 off-line transmission.
4269 @item wl-draft-sendlog
4270 @vindex wl-draft-sendlog
4271 The initial setting is @code{t}.
4272 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4276 @item drafts are sent by smtp or qmail
4277 @item saved into folders by fcc
4278 @item saved into folders by queuing
4281 (it is written even if the transmission fails).
4282 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4283 and left to the logging function of @command{imput}.
4286 @item wl-draft-sendlog-max-size
4287 @vindex wl-draft-sendlog-max-size
4288 The initial setting is 20000 (in bytes).
4289 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4290 beyond the size specified by this variable.
4294 The initial setting is @code{nil}.
4295 If non-nil, address completion uses LDAP.
4297 @item wl-ldap-server
4298 @vindex wl-ldap-server
4299 The initial setting is @samp{localhost}.
4300 LDAP server name for address completion.
4303 @vindex wl-ldap-port
4304 The initial setting is @code{nil}.
4305 If non-nil, the value is used as port number.
4308 @vindex wl-ldap-base
4309 The initial setting is @samp{c=US}.
4310 LDAP search starting point (base) for address completion.
4313 @node Disconnected Operations, Expire and Archive, Draft, Top
4314 @chapter Off-line Management
4315 @cindex Disconnected Operations
4317 Wanderlust has on-line and off-line states.
4320 * Off-line State:: Wanderlust has on-line and off-line states.
4321 * Enable Operations:: Enable Disconeected Oparations.
4322 * Plugged Mode:: Switching On-line/Off-line per Server/Port.
4323 * Off-line State settings:: Invoking Wanderlust in the Off-line State.
4324 * Variables of Plugged Mode:: Customize Plugged Mode.
4328 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4329 @section Off-line State
4331 Wanderlust has on-line and off-line states. In the off-line state, you
4332 cannot access messages via network, unless they are cached.
4334 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4335 in the mode line indicates the off-line state. In folder or summary
4336 modes, press @kbd{M-t} to switch between off- and on-line.
4338 You can invoke Wanderlust in the off-line state by setting
4339 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4341 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4342 ignores uncached messages.
4345 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4346 @section Enable Disconeected Oparations
4348 Even in the off-line state, provided that relevant messages are cached,
4349 and the variable @code{elmo-enable-disconnected-operation} (described
4350 later) is non-nil, you can following oparations:
4351 @xref{Plugged Mode}, @xref{Off-line State settings}.
4354 * Send Messages off-line:: Transmit Messages.
4355 * Re-file and Copy queue:: Re-file and Copy (IMAP4).
4356 * Creation of Folders:: Create Folders off-line (IMAP4).
4357 * Marking:: Mark (IMAP4).
4358 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP).
4361 As soon as Wanderlust becomes on-line, such operations invoked off-line
4362 are reflected in the servers via network.
4365 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4366 @subsection Transmission of Messages
4368 You can send mail/news messages off-line (if you are using
4369 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4370 accumulated in the queue folder, @samp{+queue}. These messages are
4371 transmitted at once when Wanderlust becomes on-line.
4373 You can visit @samp{+queue} in the off-line state and confirm content of
4374 messages in the queue. You can also remove messages. Removed messages
4375 are not transmitted even in the on-line state.
4378 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4379 @subsection Re-file and Copy (IMAP4)
4381 Re-file and copy operations to IMAP folders invoked during the off-line
4382 state are accumulated in the queue, and reflected in the server side
4383 when Wanderlust becomes on-line. If you visit destination folders after
4384 off-line re-file or copy, it looks as if messages were appended even in
4387 For the safety reasons, messages re-filed off-line are removed from
4388 source folders only if their @samp{Message-ID:} match messages on the
4389 servers. While the queue is processed, messages that failed to be
4390 re-filed or copied to the specified folders are appended to the folder
4394 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4395 @subsection Creation of Folders (IMAP4)
4397 You can create IMAP folders off-line. The creation of folders are
4398 reflected in the servers when Wanderlust becomes on-line. At that time,
4399 if folders failed to be created on the servers for any reasons, messages
4400 re-filed to such folders are appended to the folder @samp{+lost+found}.
4403 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4404 @subsection Marking (IMAP4)
4406 Off-line changes in unread/read and importance mark @samp{$} information
4407 are also reflected in the servers when Wanderlust becomes on-line.
4410 @node Pre-fetching Reservations, , Marking, Enable Operations
4411 @subsection Pre-fetching (IMAP4, NNTP)
4413 You can make reservations for pre-fetching messages in IMAP or NNTP
4414 folders. Reserved messages are marked with @samp{!} but not cached
4415 yet. When Wanderlust becomes on-line, they are pre-fetched from
4418 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4419 these off-line operations for IMAP4 and NNTP do not take place, and
4420 off-line re-file, copy or suchlike simply results in error.
4422 Because off-line operations use cache files, it is a bad idea to erase
4423 them by hand; it may cause Wanderlust to malfunction.
4425 If you want to remove caches, be sure to execute @kbd{M-x
4426 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4427 remove caches for messages relevant to off-line operations.
4430 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4431 @section Switching On-line/Off-line per Server/Port
4433 @kbd{M-t} described above switches networking states as a whole, but you
4434 can switch on-line/off-line per server/port.
4436 Pressing @kbd{C-t} in the folder or summary modes brings you in
4437 wl-plugged-mode shown below, in which you can change the plugged state
4442 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4445 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4446 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4448 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4449 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4455 The first line indicates status of the following three variables, and
4456 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
4457 column modifies the values of these variables.
4461 "Queuing" @code{wl-draft-enable-queuing}
4462 "AutoFlushQueue" @code{wl-auto-flush-queue}
4463 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4467 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4470 The second and after lines indicate on-line/off-line states of servers
4471 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4472 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4473 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4475 @dfn{sending queue} means messages accumulated in the folder
4476 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4477 off-line operations when @code{elmo-enable-disconnected-operation} is
4479 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4480 @c off-line operations are enabled.
4482 They are displayed if there are any of them. In the example above, in
4483 the sending queue there are two messages (the first and the second in
4484 the queue folder) for smtp to hosta and one (the third) for nntp to
4485 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4488 If you change @samp{(wl-plugged)} in the second line, the variable
4489 @code{wl-plugged} is changed, so that the mode line indicator and
4490 plugged states of all ports are affected. If you change plugged states
4491 of any servers or ports, @samp{(wl-plugged)} in the second line is
4492 affected depending on @code{elmo-plugged-condition} settings and the
4493 plugged state of each port.
4496 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4497 @section Invoking Wanderlust in the Off-line State
4499 As described before, if you set @code{wl-plugged} to @code{nil} in
4500 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4501 off-line state. You can specify off-line state on a per server or port
4502 basis. Refer to @code{wl-reset-plugged-alist} also.
4504 Usually, when Wanderlust starts up, the plugged state of each port is
4505 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4506 @code{wl-nntp-posting-server} and so on. If you want to change the
4507 plugged state of these ports or to add other ports, configure
4508 @code{wl-make-plugged-hook} with a function.
4512 (add-hook 'wl-make-plugged-hook
4514 (elmo-set-plugged plugged-value(t/nil) server port)
4515 ;; @r{add or change plugged states of the port of the server}
4516 (elmo-set-plugged plugged-value(t/nil) server)
4517 ;; @r{if the port is omitted, all ports are affected}
4518 ;; @r{(you cannot omit the port if you newly add the server)}
4524 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4525 @section Customizable Variables
4530 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4531 mode from the beginning.
4533 @item wl-queue-folder
4534 @vindex wl-queue-folder
4535 The initial setting is @samp{+queue}.
4536 This is the folder in which messages in the transmission queue are
4539 @item wl-auto-flush-queue
4540 @vindex wl-auto-flush-queue
4541 The initial setting is @code{t}.
4542 This flag controls automatic transmission of the queue when Wanderlust
4543 becomes on-line. If non-nil, the queue is automatically transmitted
4544 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4545 manually, press @kbd{F} in the folder mode.
4547 @item elmo-enable-disconnected-operation
4548 @vindex elmo-enable-disconnected-operation
4549 The initial setting is @code{nil}. Controls off-line operations
4550 regarding IMAP4. If non-nil, off-line operations are carried out.
4552 @item elmo-lost+found-folder
4553 @vindex elmo-lost+found-folder
4554 The initial setting is @samp{+lost+found}.
4555 This is the folder to which messages are saved when they fails to be
4556 appended while the off-line re-file/copy queue is processed.
4558 @item elmo-plugged-condition
4559 @vindex elmo-plugged-condition
4560 The initial setting is @code{one}.
4561 The value of @code{wl-plugged} reflects the return value of the function
4562 @code{elmo-plugged-p} (without arguments).
4563 This variable @code{elmo-plugged-condition} specifies the condition on
4564 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4565 plugged state of each port.
4568 'one : plugged if one or more ports are plugged.
4569 'all : plugged if all ports are plugged.
4570 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4571 states of the ports.
4572 @var{function} : reflects the return value of the @var{function}
4573 functions available per default
4574 'elmo-plug-on-by-servers
4575 : reflects the plugged state of the servers specified by the
4576 variable elmo-plug-on-servers.
4577 'elmo-plug-on-by-exclude-servers
4578 : reflects the plugged state of the servers that are not
4579 in elmo-plug-on-exclude-servers.
4580 elmo-plug-on-exclude-servers defaults to
4583 (system-name)without the domain part)
4589 (setq elmo-plugged-condition 'all)
4591 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4592 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4594 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4595 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4599 @item wl-reset-plugged-alist
4600 @vindex wl-reset-plugged-alist
4601 The initial setting is @code{t}. If non-nil, plugged states are
4602 initialized on a per server or port basis when Wanderlust starts up.
4604 If @code{nil}, plugged states are retained while Emacs is running. In
4605 other words, they are initialized when Emacs is restarted even if the
4606 value is @code{nil}.
4610 @node Expire and Archive, Scoring, Disconnected Operations, Top
4611 @chapter Automatic Expiration and Archiving of Messages
4612 @cindex Expire and Archive
4615 * Expire:: Expiration and Archiving
4616 * Archive:: Archiving All Messages
4620 @node Expire, Archive, Expire and Archive, Expire and Archive
4622 @cindex Expire Message
4624 Expiration means deletion of old messages which have outlasted a
4625 certain period of time.
4627 @code{wl-expire} supports not only simple deletion, but also moving to
4628 specified archiving folders.
4632 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4633 or @kbd{M-e} in the summary mode.
4635 @subsection Configuring @code{wl-expire-alist}
4637 An example configuration of @code{wl-expire-alist} is shown below.
4638 Everything in this @code{wl-expire-alist} makes a great difference in
4639 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4640 to @code{t}, especially in the initial stage.
4644 (setq wl-expire-alist
4645 '(("^\\+trash$" (date 14) remove)
4647 ("^\\+tmp$" (date 7) trash)
4648 ;; @r{re-file to @code{wl-trash-folder}}
4649 ("^\\+outbox$" (number 300) "$outbox;lha")
4650 ;; @r{re-file to the specific folder}
4652 ;; @r{do not expire}
4653 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4654 ;; @r{archive by message number (retaining numbers)}
4655 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4656 ;; @r{archive by a fixed number (retaining numbers)}
4657 ("^\\+diary$" (date 30) wl-expire-archive-date)
4658 ;; @r{archive by year and month (numbers discarded)}
4663 Items in the list has the format of:
4666 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4670 The folder is examined if it matches @var{regexp-for-folders} from the
4671 beginning of the list. If you invoke expiration on the folder that does
4672 not match any of them, nothing will happen. And if either the second or
4673 the third element of the item is @code{nil}, expiration will not take
4676 You can use any one of the following for
4677 @var{specification-of-message-to-be-deleted}:
4680 @item (number @var{n1} [@var{n2}])
4681 deletes messages depending on the number of messages in the folder.
4683 @var{n1} is the number of messages which should survive deletion, for example
4684 if its value is 500, the newest 500 messages survive and the rests are
4687 @var{n2} is the number of messages in the folder on which expiration should
4688 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4689 folders with 510 or more messages are expired.
4690 If you configured automatic expiration, frequently used folders may
4691 expire every time it receive messages, and you may be annoyed with the
4692 long delay in reading mail.
4693 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4694 expiration would not take place until a certain number of messages
4697 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4698 with important/new/unread) are not deleted.
4699 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4700 will expire so as to have 500 messages including such ones.
4701 Otherwise, it will have 500 messages except such ones.
4703 @item (date @var{d1})
4704 deletes messages depending on the dates.
4706 Messages dated @var{d1} or more days ago are deleted, for example if its
4707 value is seven, messages seven days old or more are deleted. Note that
4708 the date is the one in the @samp{Date:} field of the message, not when
4709 the message entered the folder.
4711 Messages with no or invalid @samp{Date:} field does not expire; you
4712 might have to delete them by hand.
4715 You can use any one of the following in the place of @var{destination}:
4719 deletes the messages instantly.
4722 moves the messages to @code{wl-trash-folder}.
4724 @item @var{string}(folder)
4725 moves the messages to the folder specified with @var{string}.
4727 It would be useful for specifying an archiving folder, but because this
4728 does not move important messages, it might be better to use the
4729 standard functions described below.
4731 @item @var{function}
4732 invokes the specified @var{function}.
4734 To the @var{function}, three arguments are passed: a folder name, a list
4735 of messages to be deleted, and msgdb information of the summary. You
4736 can specify function-specific arguments after the name of the
4737 @var{function}. Note that the list contains messages with marks in
4738 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4741 These are three standard functions; they moves messages to an archive
4742 folder in the specified way. This means old messages can be compressed
4743 and saved in a file, being deleted from the original folder.
4746 @item wl-expire-archive-number1
4747 re-files to archiving folders corresponding to the message numbers of
4748 the messages being deleted. For example, a message numbered 102 will be
4749 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4750 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4751 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4753 The archiving folders to which messages are re-filed are determined by
4754 the name of the folder as follows (in this case, archiving folders are
4755 handled as if @code{elmo-archive-treat-file} were non-nil).
4758 @item If the folder type is localdir:
4759 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4761 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4762 (@file{~/Mail/ml/wl-00100.zip}).
4764 @item The folder type is other than localdir:
4765 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4767 For example, @samp{%#mh/ml/wl} corresponds to
4768 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4771 As you can see, in the case of localdir, the folder type is not included
4772 in the path name, but otherwise it is included.
4773 And you can control the prefix to the archiving folder name by
4774 @code{wl-expire-archive-folder-prefix}.
4775 Refer to @code{wl-expire-archive-folder-prefix} for details.
4777 @item wl-expire-archive-number2
4778 re-files every certain number of messages to archiving folders.
4780 This differs from @samp{wl-expire-archive-number1} in that this re-files
4781 to the folder up to the specified number regardless of message numbers.
4782 The archiving folders to which messages are re-filed are determined in the
4783 same way as @code{wl-expire-archive-number1}.
4785 @item wl-expire-archive-date
4786 re-files messages depending on its date (year and month) to archive
4789 For example, a message dated December 1998 is re-filed to
4790 @code{$folder-199812;zip}. The name of the archiving folders except the
4791 date part are determined in the same way as
4792 @code{wl-expire-archive-number1}.
4795 You can set the first argument to these three standard functions to non-nil
4796 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4797 For example, it can be specified just after the name of the function:
4800 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4803 If you omit the argument, consecutive numbers from 1 are assigned for
4804 each archiving folder.
4807 @subsection Treatment for Important or Unread Messages
4809 If you specify any of @code{remove}, @code{trash}, a folder name, or a
4810 standard function, messages with marks in
4811 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
4812 messages} thereafter) are retained.
4814 Per default, this variable include the important, new, and unread marks,
4815 so that messages with these marks are not removed.
4816 Note that you cannot include the temporary mark (i.e. temporary marks
4817 are removed anyway), and be sure to process temporary marks before you
4820 @subsection Auto Expiration
4822 The following setup invokes expiration when you move into the summary
4823 mode. There will be no confirmation, so make sure you made no mistake
4824 in regexp and other settings before you set up this.
4828 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4832 In the folder mode, you can invoke expiration per group as well as per
4833 folder. Therefore, if you specify @samp{Desktop} group, all folders
4834 matching @code{wl-expire-alist} expire.
4838 @subsection Treating archive folders.
4839 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
4840 you must set non-nil value to @code{elmo-archive-treat-file}.
4842 @subsection Confirming
4844 If you are to use @code{remove}, try @code{trash} at first and see
4845 messages move to @code{wl-trash-folder} as expected, then replace it
4846 with @code{remove}. It would be dangerous to use @code{remove} from the
4849 If you are to use @code{wl-expire-archive-number1} and the like, try to
4850 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
4851 you can append messages to it. Even if settings in
4852 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
4853 would not be saved anywhere and disappeared in case the archiver program
4856 After you make sure you can archive to the folder correctly, you can
4857 invoke expiration and utilize the log.
4859 If you set @code{wl-expire-use-log} to @code{t},
4860 @file{~/.elmo/expired-log} should contain the log, for example:
4864 delete +ml/wl (593 594 595 596 597 598 599)
4865 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
4869 The first column indicates the operation, i.e. @samp{delete},
4870 @samp{copy}, or @samp{move}. The next is the name of the folder that
4871 expired. In the case of @samp{copy} and @samp{move}, the destination
4872 folder is recorded after @samp{->}. The last is the list of message
4873 numbers that are actually deleted or moved (in the case of @samp{copy}
4874 and @samp{move}, the number is the one in the source folder, rather than
4875 the destination folder).
4877 @subsection Re-filing Reserved Messages
4879 The three standard functions copy reserved messages to the archive
4880 folder, but do not delete them from the source folder. Because
4881 reserved messages and the like always remain, they are recorded in
4882 @file{~/.elmo/expired-alist} so that they are not copied over and over
4883 again. They are not recorded if copied by @code{wl-summary-archive}.
4885 If you enabled logging, usually @samp{move} is recorded for re-filing,
4886 but instead @samp{copy} and @samp{delete} are recorded separately if
4887 reserved messages are involved. This is because it actually copies
4888 messages including reserved, then deletes ones except reserved in that
4891 @section Customizable Variables
4894 @item wl-expire-alist
4895 @vindex wl-expire-alist
4896 The initial setting is @code{nil}.
4897 This variable specifies folders and methods to expire. For details,
4898 refer to @code{wl-expire-alist} settings above.
4900 @item wl-summary-expire-reserve-marks
4901 @vindex wl-summary-expire-reserve-marks
4902 The initial setting is the list below.
4906 (list wl-summary-important-mark
4908 wl-summary-unread-mark
4909 wl-summary-unread-uncached-mark
4910 wl-summary-unread-cached-mark)
4914 Messages with these marks are retained in the folder, even after
4916 Only permanent marks can be listed, not temporary marks.
4918 You can list marks one by one as in the default; you can use the
4919 following settings as well:
4923 All messages with permanent marks are retained,
4924 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
4928 All messages are handled as usual ones that are already read, no matter
4929 what marks they have; even important messages are deleted.
4932 @item wl-expire-archive-files
4933 @vindex wl-expire-archive-files
4934 The initial setting is 100.
4935 This variable specifies the number of messages to be retained in one
4938 @item wl-expire-number-with-reserve-marks
4939 @vindex wl-expire-number-with-reserve-marks
4940 The initial setting is @code{nil}.
4941 If non-nil, if expiring messages are specified by @code{number},
4942 messages with @code{wl-summary-expire-reserve-marks} are also retained.
4944 @item wl-expire-archive-get-folder-func
4945 @vindex wl-expire-archive-get-folder-func
4946 The initial setting is @code{wl-expire-archive-get-folder}.
4948 This variable specifies a function that returns the name of an archiving
4949 folder for standard functions in the place of @var{destination}.
4950 You can use the following three variables for simple modification of
4951 folder names; if you want more complex settings, define your own
4952 function in this variable.
4954 @code{wl-expire-archive-get-folder} can be customized by these
4957 @item @code{wl-expire-archive-folder-name-fmt}
4958 @item @code{wl-expire-archive-folder-type}
4959 @item @code{wl-expire-archive-folder-prefix}
4962 @item wl-expire-archive-folder-name-fmt
4963 @vindex wl-expire-archive-folder-name-fmt
4964 The initial setting is @samp{%s-%%05d;%s}.
4965 This is a @code{format} string for archiving folders used in
4966 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
4967 Note that you must specify the message number by @samp{%%d}, because it
4968 is parsed twice by @code{format}.
4970 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
4973 @item wl-expire-archive-date-folder-name-fmt
4974 @vindex wl-expire-archive-date-folder-name-fmt
4975 The initial setting is @samp{%s-%%04d%%02d;%s}.
4976 This is a @code{format} string for archiving folders used in
4977 @code{wl-expire-archive-date}. Note that you must specify the message
4978 number by @samp{%%d}, because it is parsed twice by @code{format}.
4979 There should be @samp{%%d} twice, one for the year and the other for the
4982 If you modify this, adjust
4983 @code{wl-expire-archive-date-folder-num-regexp} as well.
4985 @item wl-expire-archive-folder-type
4986 @vindex wl-expire-archive-folder-type
4987 The initial setting is @code{zip}.
4988 This variable specifies an archiver type of the archiving folders.
4990 @item wl-expire-archive-folder-prefix
4991 @vindex wl-expire-archive-folder-prefix
4992 The initial setting is @code{nil}.
4993 This variable specifies the prefix (directory structure) to archiving
4995 Exercise extreme caution in using this feature, as it has not been
4997 In the worst case, there is a fear of destructing archiving folders.
5001 There will be no prefix.
5004 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5005 @samp{$ml/wl-00000;zip;wl}.
5008 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5011 @samp{$ml/wl-00000;zip;ml/wl}.
5014 @item wl-expire-archive-folder-num-regexp
5015 @vindex wl-expire-archive-folder-num-regexp
5016 The initial setting is @samp{-\\([-0-9]+\\);}.
5017 This variable specifies the regular expression to be used for getting
5018 message numbers from multiple archiving folders specified by
5019 @code{elmo-list-folders}.
5020 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5022 @item wl-expire-archive-date-folder-num-regexp
5023 @vindex wl-expire-archive-date-folder-num-regexp
5024 The initial setting is @samp{-\\([-0-9]+\\);}.
5025 This is the regular expression to be used for getting message numbers
5026 from multiple archiving folders specified by @code{elmo-list-folders}.
5027 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5029 @item wl-expire-delete-oldmsg-confirm
5030 @vindex wl-expire-delete-oldmsg-confirm
5031 The initial setting is @code{t}.
5032 If non-nil, messages older than the one with the largest number will be
5033 deleted with confirmation.
5034 If @code{nil}, they are deleted without confirmation.
5036 This feature is valid only if non-nil is specified as a argument to the
5037 standard functions so as to retain numbers.
5039 @item wl-expire-use-log
5040 @vindex wl-expire-use-log
5041 The initial setting is @code{nil}.
5042 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5043 They are appended but not truncated or rotated automatically; you might
5044 need to remove it manually.
5046 @item wl-expire-add-seen-list
5047 @vindex wl-expire-add-seen-list
5048 The initial setting is @code{t}.
5050 If non-nil, when messages are re-filed by expiration, read/unread
5051 information is passed to the destination folder.
5053 However if you do not read the destination folder from Wanderlust,
5054 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5055 want to set this to @code{nil} if you are simply saving to some
5056 archiving folders. Even if its value is @code{nil}, messages in the
5057 archiving folders are simply treated as unread; it does not affect
5060 @item wl-expire-folder-update-msgdb
5061 @vindex wl-expire-folder-update-msgdb
5062 The initial setting is @code{t}.
5063 If @code{t}, in the folder mode, expiration is carried out after
5064 updating summary information. If you specified a list of regular
5065 expressions of folder names, summary information is updated for matching
5070 @node Archive, , Expire, Expire and Archive
5071 @section Archiving Messages
5073 @subsection Archiving Messages
5074 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5075 folders. If there are the archiving folders already, only new messages
5078 You can use @code{wl-archive-alist} in order to specify how messages are
5079 archived according to their folder names, as in @code{wl-expire-alist}.
5084 (setq wl-archive-alist
5085 '(("^\\+tmp$" wl-archive-date)
5086 ("^\\+outbox$" wl-archive-number2)
5087 (".*" wl-archive-number1)))
5091 Each item in the list has the following format:
5094 (@var{folders-regexp} @var{deleting-function})
5097 As you can see, you can only use a function after @var{folders-regexp}.
5098 Per default, there are three functions:
5101 @item @code{wl-archive-number1}
5102 @item @code{wl-archive-number2}
5103 @item @code{wl-archive-date}
5106 As inferred from their names, they work similarly to "expire" versions,
5107 other than the following points:
5110 @item No messages are deleted
5111 @item Message numbers are retained even if invoked without arguments
5114 These functions are good to archive all messages in a folder by their
5115 numbers or by their dates.
5116 These are also useful for backup or confirmation purposes before
5118 If you try to re-file them after they are archived, they are deleted but
5121 Per default, the archiving folders to which messages are copied are
5122 determined automatically by @code{wl-expire-archive-get-folder-func}.
5123 You can copy to a specific folder by invoking with a prefix argument,
5124 i.e. @kbd{C-u M-x wl-summary-archive}.
5126 Note that this feature has not been seriously tested, because you can
5127 simply copy to an archiving folder, for example by
5128 @code{wl-summary-copy-region}.
5130 The archiving folders are determined by the same logic as in
5131 @code{wl-summary-expire}; the following customizable variables are
5135 @item @code{wl-expire-archive-files}
5136 @item @code{wl-expire-archive-get-folder-func}
5137 @item @code{wl-expire-archive-folder-name-fmt}
5138 @item @code{wl-expire-archive-folder-type}
5139 @item @code{wl-expire-archive-folder-prefix}
5140 @item @code{wl-expire-archive-folder-num-regexp}
5143 @subsection Customizable Variables
5146 @item wl-archive-alist
5147 @vindex wl-archive-alist
5148 The initial setting is the list shown below:
5152 ((".*" wl-archive-number1))
5157 This variable specifies a function that copies to archiving folders.
5158 To the function, three arguments are passed: a folder name, a list of
5159 messages in the folder, and msgdb information of the summary.
5160 Needless to say, you can use your own function.
5164 @node Scoring, Customization, Expire and Archive, Top
5165 @chapter Score of the Messages
5167 @c @cindex Kill File
5169 Scoring is the function that associates a score (value) with each
5170 message, and marks as read or deletes from the summary according to it.
5172 You can put target or important marks on essential messages, or read marks
5173 on the ones you do not want to read, for example spam articles.
5175 This scoring function has a capability and a format similar to the one
5176 that Gnus has, although there are some unsupported features and
5177 Wanderlust specifics.
5178 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5181 * Score Commands:: Score Commands
5182 * Score File Format:: Score File Format
5186 @node Score Commands, Score File Format, Scoring, Scoring
5187 @section Score Commands
5188 @cindex Score Commands
5190 @subsection Score File Specification
5192 @code{wl-score-folder-alist} specifies score files or variables in which
5193 scores are defined, corresponding to folder names.
5197 (setq wl-score-folder-alist
5206 If paths to the score files are omitted, the directory specified in the
5207 variable @code{wl-score-files-dir} is assumed.
5209 No matter what you write in @code{wl-score-folder-alist}, the default
5210 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5211 read (it does not have to exist).
5212 Therefore, in the example above, the three score files,
5213 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5214 the folders that matches @samp{^-.*}.
5216 @subsection Scored Messages
5218 Scores are attached to the messages that are specified by
5219 @code{wl-summary-score-marks} temporarily when the summary is updated;
5220 when you exit from the summary, the scores are removed and reverts to
5223 @subsection Creation of Score Files
5225 In the summary buffer, move to an appropriate message and type @kbd{L}.
5226 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5227 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5229 This makes @minus{}1000 are scored for messages with the same
5230 @samp{Subject:} as the string you entered. That is, such a score file
5231 is created automatically.
5233 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5234 The score file you just made appears.
5235 This buffer is called @dfn{score editing buffer} thereafter.
5236 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5237 as you are previously; type @kbd{a}. Then a score entry for "From"
5239 In this way, you can create a score file easily either in the summary
5240 buffer or in the score editing buffer.
5242 By the way, you might be aware the numbers of key strokes are different
5243 between @kbd{s s p} and @kbd{a}.
5244 This is determined by @code{wl-score-header-default-entry}.
5245 This variable specifies the default score entries corresponding to
5247 For example, for "subject" field, a type and a time limit are prompted,
5248 but for "from" field, they are fixed upon automatically as substring and
5249 permanent respectively.
5250 However, score values can be modified by the prefix argument.
5251 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5254 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5255 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5256 erasing contents of the buffer deletes the score file being edited.
5260 @subsubsection Selecting Score Files
5262 You can change score files to which scores are appended by
5263 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5264 @code{wl-score-change-score-file}.
5266 @subsubsection Summing Up the Score
5268 If you add the same entries by @code{wl-summary-increase-score},
5269 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5270 scores for the entry is summed up.
5272 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5273 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5274 @minus{}1200 will be created as a result.
5276 @subsubsection Creating Thread Key
5278 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5279 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5281 @subsubsection Creating Followup Key
5283 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5284 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5285 at the cursor to @samp{References} key.
5286 If @code{wl-score-auto-make-followup-entry} is non-nil,
5287 @samp{Message-ID} of all messages to be followed up within dates
5288 specified by @code{wl-score-expiry-days}.
5290 @subsection Key Bindings
5295 @findex wl-summary-increase-score
5296 Increases the score for the current message.
5297 And the score entry is appended to the score file at the same moment.
5298 You can specify the score value by a prefix argument.
5302 @findex wl-summary-lower-score
5303 Decreases the score for the current message.
5304 And the score entry is appended to the score file at the same moment.
5305 You can specify the score value by a prefix argument.
5308 @kindex h R (Summary)
5309 @findex wl-summary-rescore
5310 Re-applies the scoring.
5311 However, already scored messages are not scored anew.
5314 @kindex h c (Summary)
5315 @findex wl-score-change-score-file
5316 Changes the score file currently selected.
5319 @kindex h e (Summary)
5320 @findex wl-score-edit-current-scores
5321 Edits the score file currently selected.
5322 If there are multiple score files, the previously specified one is
5326 @kindex h f (Summary)
5327 @findex wl-score-edit-file
5328 Edits an arbitrary score file and selects it.
5331 @kindex h F (Summary)
5332 @findex wl-score-flush-cache
5333 Erases caches associated to the score files that are read.
5334 If you modified score files directly (from other than Wanderlust), you
5335 need to re-read them after erasing the cache.
5338 @kindex h m (Summary)
5339 @findex wl-score-set-mark-below
5340 Specifies the criterion for scores to be marked as read.
5341 Messages with scores less than this value are marked as read.
5344 @kindex h x (Summary)
5345 @findex wl-score-set-expunge-below
5346 Specifies the criterion for scores to be deleted from the summary.
5347 Messages with scores less than this value are deleted.
5348 "Deleted" means it is not shown; they are not removed from the summary
5349 information or the folder.
5350 The deleted messages can be shown by rescan-noscore again.
5353 @subsection Key Bindings in the Score Editing Buffer
5357 @kindex C-c C-k (Score Mode)
5358 @findex wl-score-edit-kill
5359 Abandons the file being edited.
5362 @kindex C-c C-c (Score Mode)
5363 @findex wl-score-edit-exit
5364 Saves the file being edited, and quits from the edit mode.
5367 @kindex C-c C-p (Score Mode)
5368 @findex wl-score-pretty-print
5372 @kindex C-c C-d (Score Mode)
5373 @findex wl-score-edit-insert-date
5374 Inserts the number of dates from Dec. 31, 1 B.C.
5375 It is used for creating the third factor of time-limited scores.
5378 @kindex C-c C-s (Score Mode)
5379 @findex wl-score-edit-insert-header
5380 Inserts the header of the message selected in the summary buffer.
5383 @kindex C-c C-e (Score Mode)
5384 @findex wl-score-edit-insert-entry
5385 Inserts the score entry of the message selected in the summary buffer.
5388 @subsection Customizable Variables
5391 @item wl-summary-default-score
5392 @vindex wl-summary-default-score
5393 The initial setting is 0 (zero).
5394 This variable specifies the default value of the score.
5395 The score is increased or decreased based upon this value.
5397 @item wl-summary-important-above
5398 @vindex wl-summary-important-above
5399 The initial setting is @code{nil}.
5400 Messages with scores larger than this value are attached with the
5401 important mark (@samp{$}).
5402 If @code{nil}, no important marks are attached.
5404 @item wl-summary-target-above
5405 @vindex wl-summary-target-above
5406 The initial setting is @code{nil}.
5407 Messages with scores larger than this value are attached with the target
5409 If @code{nil}, no target marks are attached.
5411 @item wl-summary-mark-below
5412 @vindex wl-summary-mark-below
5413 The initial setting is 0 (zero).
5414 Messages with scores smaller than this value are marked as read.
5416 @item wl-summary-expunge-below
5417 @vindex wl-summary-expunge-below
5418 The initial setting is @code{nil}.
5419 Messages with scores smaller than this value are deleted from the
5421 If @code{nil}, they are not deleted.
5423 @item wl-summary-score-marks
5424 @vindex wl-summary-score-marks
5425 The initial setting is the list shown below:
5429 (list wl-summary-new-mark)
5434 Messages with these marks are scored.
5436 @item wl-use-scoring
5437 @vindex wl-use-scoring
5438 The initial setting is t.
5439 If non-nil, scoring is enabled.
5441 @item wl-score-files-dir
5442 @vindex wl-score-files-dir
5443 The initial setting is @file{~/.elmo/}.
5444 The default directory for score files.
5446 @item wl-score-interactive-default-score
5447 @vindex wl-score-interactive-default-score
5448 The initial setting is 1000.
5449 This value is used as a score when a score factor is @code{nil} in the
5450 score file. It is also used in @code{wl-summary-increase-score} and
5451 @code{wl-summary-lower-score}, on condition that the value of
5452 @code{wl-score-header-default-entry} is @code{nil}.
5454 @item wl-score-expiry-days
5455 @vindex wl-score-expiry-days
5456 The initial setting is 7.
5457 This is the number of days before time-limited scores are deleted.
5459 @item wl-score-update-entry-dates
5460 @vindex wl-score-update-entry-dates
5461 The initial setting is @code{t}.
5462 If non-nil, it enables deletion of time-limited scores.
5464 @item wl-score-header-default-entry
5465 @vindex wl-score-header-default-entry
5466 Specifies the default value for each header field for score entries
5467 created by @code{wl-summary-increase-score},
5468 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5470 @item wl-score-simplify-fuzzy-regexp
5471 @vindex wl-score-simplify-fuzzy-regexp
5472 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5473 regular expression to be deleted from the string.
5474 Because this is usually used for Subject, the default is prefixes that
5475 are attached by mailing list programs.
5477 @item wl-summary-rescore-partial-threshold
5478 @vindex wl-summary-rescore-partial-threshold
5479 The initial setting is 200.
5480 When sync-all or rescan is executed, if there are messages more than
5481 this value, only the last same number of messages as this value are
5484 @item wl-summary-auto-sync-marks
5485 @vindex wl-summary-auto-sync-marks
5486 If non-nil, unread/important marks are synchronized when the summary
5488 Unread marks reflect information on the IMAP4 server.
5489 Important marks reflect information on the IMAP4 server (flagged or
5490 not), and contents of @samp{'mark} folder.
5491 The initial setting is @code{t}.
5495 @node Score File Format, , Score Commands, Scoring
5496 @section Score File Format
5497 @cindex Score File Format
5499 The format of score files are the same as Gnus, and basically you can
5500 use Gnus score files as they are. But they are not fully compatible
5501 because some keys are not supported and there are Wanderlust specifics.
5502 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5507 ("for sale" -1000 nil s)
5508 ("profit" -1000 nil s))
5510 ("spam@@spamspamspam" -10000 nil s))
5512 ("my@@address" 3001 nil s))
5514 (1000000 -10 nil >))
5524 If the key is a string, it is the name of the header to be matched.
5525 The following keys are available:
5526 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5527 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5528 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5529 @code{Chars} and @code{Lines} mean the size and the number of lines of
5530 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5531 are described later.
5532 The rest corresponds the field of the same name.
5534 Arbitrary numbers of core entries are specified after the key.
5535 Each score entry consists of these five factors:
5539 A factor that matches header. This should be a number in the cases of
5540 @code{lines} and @code{chars}, otherwise a string.
5543 A score factor. When the first item matches, the score of the message
5544 is increased or decreased by this value.
5547 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5548 of a number, the score is deleted if it does not match for days
5549 (@code{wl-score-expiry-days}) from the date specified by this.
5550 The date is since Dec. 31, 1 B.C.
5553 A type factor. This specifies the way the first factor matches.
5554 Available types depend on keys.
5557 @item From, Subject, References, Message-ID
5558 For these keys in string, @code{r} and @code{R} (regexp),
5559 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5560 as well as @code{f} and @code{F} (fuzzy) can be used.
5561 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5564 For these keys, the following five numerical relative operators can be
5565 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5568 This key matches @code{From} header, and scores all follow-ups to the
5570 For example, it would be useful for increasing scores for follow-ups to
5573 You can use the same types as @code{From} except for @code{f}.
5574 And a @samp{Followup} entry is automatically appended to the score file.
5577 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5578 A @samp{Thread} entry is automatically appended for each article that
5579 has @var{x} in the @code{References} header.
5580 You can make sure the whole thread including messages that does not have
5581 all ancestors @code{Message-ID} in @code{References} is scored.
5583 You can use the same types as @code{References} except for @code{f}.
5584 And a @samp{Thread} entry is automatically appended to the score file.
5588 A factor for extension header. This is meaningful only if the key is
5590 This specifies headers to be matched other than standard headers like
5591 @code{Subject} and @code{From}.
5592 Note that you should specify the header in
5593 @code{elmo-msgdb-extra-fields} also.
5594 Therefore it does not work in folders where extension headers cannot be
5599 The sum of these scores @emph{after all factors are applied} becomes the
5600 score of the message.
5602 @cindex Score File Atoms
5604 Messages with a score less than this value is marked as read.
5605 The default is @code{wl-summary-mark-below}.
5608 Messages with a score less than this value is deleted from the summary.
5609 The default is @code{wl-summary-expunge-below}.
5611 @item mark-and-expunge
5612 Both @code{mark} and @code{expunge} are applied,
5613 i.e. messages with a score less than this value is marked as read and
5614 deleted from the summary.
5617 Messages with a score greater than this value is attached with temp
5619 The default is @code{wl-summary-target-above}.
5622 Messages with a score greater than this value is attached with important
5624 The default is @code{wl-summary-important-above}.
5629 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5630 are used, you need to set @code{elmo-msgdb-extra-fields}.
5633 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5636 There are other restrictions as shown below:
5639 @item Because @samp{References} field in the summary information
5640 contains only the last @samp{Message-ID}, @code{references} key matches
5644 Keys that can be seen by folder of types:
5648 chars lines xref extra
5649 localdir,localnews Y E E E
5650 nntp (supporting xover) Y E E N
5656 N: cannot be seen (ignored)
5657 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5662 @node Customization, Mailing List, Scoring, Top
5663 @chapter Customizing Wanderlust
5664 @cindex Customization
5667 * Living with other packages:: Living with other packages
5668 * Highlights:: Highlights
5669 * Biff:: Notify Mail arrival
5670 * Advanced Settings:: Advanced Settings
5671 * Customizable Variables:: Customizable Variables
5676 @node Living with other packages, Highlights, Customization, Customization
5677 @section Living with other packages
5679 Examples with other packages.
5682 * imput:: imput (im-wl.el)
5684 * supercite:: supercite.el
5685 * mu-cite:: mu-cite.el
5686 * x-face-mule:: x-face-mule.el
5687 * dired-dd:: dired-dd.el
5691 @node imput, BBDB, Living with other packages, Living with other packages
5696 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5699 If @command{imput} is on the @code{exec-path} at the installation,
5700 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
5704 (autoload 'wl-draft-send-with-imput-async "im-wl")
5705 (setq wl-draft-send-func 'wl-draft-send-with-imput-async)
5710 @node BBDB, supercite, imput, Living with other packages
5714 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
5717 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
5718 byte-compiled and installed.
5726 ;; @r{enable pop-ups}
5727 (setq bbdb-use-pop-up t)
5728 ;; @r{auto collection}
5729 (setq bbdb/mail-auto-create-p t)
5730 (setq signature-use-bbdb t)
5731 (setq bbdb-north-american-phone-numbers-p nil)
5732 ;; @r{shows the name of bbdb in the summary} :-)
5733 (setq wl-summary-from-func 'bbdb-wl-from-func)
5734 ;; @r{automatically add mailing list fields}
5735 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
5736 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
5740 @node supercite, mu-cite, BBDB, Living with other packages
5741 @subsection sc.el(supercite), sc-register.el
5745 The same setting as usual mailers should be OK. The following is an
5746 example of settings:
5750 (autoload 'sc-cite-original "sc" nil t)
5751 (setq mail-yank-hooks 'sc-cite-original)
5752 (setq sc-preferred-header-style 1)
5753 (setq sc-electric-references-p nil)
5754 (setq sc-citation-leader "")
5755 (setq sc-load-hook '(lambda () (require 'sc-register)))
5756 (setq sc-preferred-attribution 'registeredname)
5761 @node mu-cite, x-face-mule, supercite, Living with other packages
5762 @subsection mu-cite.el
5765 The same setting as usual mailers should be OK. The following is an
5766 example of settings.
5768 If you use mu-cite version 8.0 or earlier:
5772 (autoload 'mu-cite/cite-original "mu-cite" nil t)
5773 (setq mail-citation-hook 'mu-cite/cite-original)
5777 If you use mu-cite version 8.1 or later:
5781 (autoload 'mu-cite-original "mu-cite" nil t)
5782 (add-hook 'mail-citation-hook (function mu-cite-original))
5786 @node x-face-mule, dired-dd, mu-cite, Living with other packages
5787 @subsection x-face-mule.el
5791 It depends on the version of x-face-mule.
5792 If you use x-face-mule 0.19 or older, do the following:
5796 (setq wl-highlight-x-face-func
5799 (x-face-mule:x-face-decode-message-header))))
5803 If you use x-face-mule 0.20 or later, try the following:
5807 (setq wl-highlight-x-face-func
5810 (x-face-mule-x-face-decode-message-header))))
5811 (require 'x-face-mule)
5815 Use these settings when you use @file{x-face-mule.el} attached to
5816 bitmap-mule 8.0 or later:
5820 (autoload 'x-face-decode-message-header "x-face-mule")
5821 (setq wl-highlight-x-face-func 'x-face-decode-message-header)
5825 If there is an encoded X-Face string in a file @file{~/.xface} (the
5826 value of the variable @code{wl-x-face-file}), it is inserted as a
5827 @samp{X-Face:} field in the draft buffer (if
5828 @code{wl-auto-insert-x-face} is non-nil).
5831 @node dired-dd, , x-face-mule, Living with other packages
5832 @subsection dired-dd(Dired-DragDrop)
5833 @pindex Dired-DragDrop
5835 @cindex Drag and Drop
5837 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
5838 compose multi-part by simple Drag-and-Drop from dired to the draft
5839 buffer being edited in GNU Emacs (this feature is not Wanderlust
5840 specific, but general-purpose for tm/SEMI).
5844 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
5850 ;; @r{Set dired-x variables here.}
5851 ;; @r{To and flo@dots{}}
5853 (progn (require 'dired-dd)
5854 (require 'dired-dd-mime))))))
5859 @node Highlights, Biff, Living with other packages, Customization
5862 @subsection Customizable Variables
5865 @item wl-summary-highlight
5866 @vindex wl-summary-highlight
5867 The initial setting is @code{t}.
5868 If non-nil, the summary is highlighted.
5870 @item wl-highlight-max-summary-lines
5871 @vindex wl-highlight-max-summary-lines
5872 The initial setting is 10000.
5873 The summary is not highlighted if it has more lines than this value.
5875 @item wl-summary-highlight-partial-threshold
5876 @vindex wl-summary-highlight-partial-threshold
5877 The initial setting is 1000.
5878 This is a threshold whether the whole summary is highlighted.
5879 If there are more lines of messages in the summary, it is partially
5882 @item wl-summary-partial-highlight-above-lines
5883 @vindex wl-summary-partial-highlight-above-lines
5884 The initial setting is 30. If there are more lines of messages than
5885 @code{wl-summary-highlight-partial-threshold} in the summary, messages
5886 after the point that is the same number of lines as this value above the
5887 cursor line are highlighted partially. (If this value is @code{nil},
5888 the last same number of lines as the value of
5889 @code{wl-summary-highlight-partial-threshold} are highlighted.)
5891 @item wl-highlight-body-too
5892 @vindex wl-highlight-body-too
5893 The initial setting is @code{t}.
5894 If non-nil, bodies of drafts and messages are also highlighted.
5896 @item wl-highlight-message-header-alist
5897 @vindex wl-highlight-message-header-alist
5898 When highlighting headers of drafts and messages, this variable
5899 specifies which faces are allocated to important
5900 (@code{wl-highlight-message-important-header-contents}), secondly
5901 important (@code{wl-highlight-message-important-header-contents2}), and
5902 unimportant (@code{wl-highlight-message-unimportant-header-contents})
5904 Similarly, it can be used for allocating arbitrary faces to arbitrary
5905 regular expressions.
5907 @item wl-highlight-citation-prefix-regexp
5908 @vindex wl-highlight-citation-prefix-regexp
5909 Specifies a regular expression to which quoted lines in bodies of
5910 drafts and messages match.
5911 Bodies matching to this regular expression are highlighted by the faces
5912 specified by (@code{wl-highlight-message-cited-text-*}).
5914 @item wl-highlight-highlight-citation-too
5915 @vindex wl-highlight-highlight-citation-too
5916 The initial setting is @code{nil}.
5917 If non-nil, the quoting regular expression itself given by
5918 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
5920 @item wl-highlight-citation-header-regexp
5921 @vindex wl-highlight-citation-header-regexp
5922 Specifies a regular expression that denotes beginning of quotation.
5923 Bodies matching to this regular expression are highlighted by the face
5924 specified by @code{wl-highlight-message-headers}.
5926 @item wl-highlight-max-message-size
5927 @vindex wl-highlight-max-message-size
5928 The initial setting is 10000.
5929 If a message is larger than this value, it will not be highlighted.
5930 With this variable, highlight is suppressed for uuencode or huge digest
5933 @item wl-highlight-signature-separator
5934 @vindex wl-highlight-signature-separator
5935 Specifies regular expressions that denotes the boundary of a signature.
5936 It can be a regular expression, or a list of ones.
5937 Messages after the place that matches this regular expression are
5938 highlighted by the face specified by
5939 @code{wl-highlight-message-signature}.
5941 @item wl-max-signature-size
5942 @vindex wl-max-signature-size
5943 The initial setting is 400.
5944 This is the largest size for a signature to be highlighted.
5946 @item wl-use-highlight-mouse-line
5947 @vindex wl-use-highlight-mouse-line
5948 The initial setting is @code{t}.
5949 If non-nil, the line pointed by the mouse is highlighted in the folder
5950 mode, summary mode, and the like.
5953 @subsection Setting Colors and Fonts of the Characters
5955 If you want to change colors or fonts of the characters, you need to
5956 modify faces defined in Wanderlust. Use @code{set-face-font} if you
5957 want to change fonts, and @code{set-face-foreground} for colors, and so
5958 on. You cannot write face settings in @file{.emacs}; write in
5961 For example, if you want to change the color for signatures to yellow,
5965 (set-face-foreground 'wl-highlight-message-signature "yellow")
5971 Faces defined in Wanderlust:
5974 @item wl-highlight-message-headers
5975 The face for field names of message headers.
5977 @item wl-highlight-message-header-contents
5978 The face for field bodies of message headers.
5980 @item wl-highlight-message-important-header-contents
5981 The face for important parts of message headers.
5982 Per default, this face is used for a body of @samp{Subject:} field.
5983 You can change its value by editing
5984 @code{wl-highlight-message-header-alist}.
5986 @item wl-highlight-message-important-header-contents2
5987 The face for secondly important parts of message headers.
5988 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
5989 fields. You can change its value by editing
5990 @code{wl-highlight-message-header-alist}.
5992 @item wl-highlight-message-unimportant-header-contents
5993 The face for unimportant parts of message headers.
5994 Per default, this face is used for bodies of @samp{X-} fields
5995 @samp{User-Agent:} fields. You can change its value by editing
5996 @code{wl-highlight-message-header-alist}.
5998 @item wl-highlight-message-citation-header
5999 The face for headers of quoted messages.
6001 @item wl-highlight-message-cited-text-*
6002 The face for texts of quoted messages. The last @samp{*} is a
6003 @var{single figure} so that 10 different colors can be used according to
6006 @item wl-highlight-message-signature
6007 The face for signatures of messages. The initial settings are
6008 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6009 dark background colors.
6011 @item wl-highlight-header-separator-face
6012 The face for header separators of draft messages.
6014 @item wl-highlight-summary-important-face
6015 The face for message lines with important marks in the summary.
6017 @item wl-highlight-summary-new-face
6018 The face for message lines with new marks in the summary.
6020 @item wl-highlight-summary-displaying-face
6021 The face for the message line that is currently displayed.
6022 This face is overlaid.
6024 @item wl-highlight-thread-indent-face
6025 The face for the threads that is currently displayed.
6027 @item wl-highlight-summary-unread-face
6028 The face for message lines with unread marks in the summary.
6030 @item wl-highlight-summary-deleted-face
6031 The face for message lines with delete marks in the summary.
6033 @item wl-highlight-summary-refiled-face
6034 The face for message lines with re-file marks in the summary.
6036 @item wl-highlight-refile-destination-face
6037 The face for re-file information part of message lines with re-file
6038 marks in the summary.
6040 @item wl-highlight-summary-copied-face
6041 The face for message lines with copy marks in the summary.
6043 @item wl-highlight-summary-target-face
6044 The face for message lines with target marks @samp{*} in the summary.
6046 @item wl-highlight-summary-thread-top-face
6047 The face for message lines that are on the top of the thread in the
6050 @item wl-highlight-summary-normal-face
6051 The face for message lines that are not on top of the thread in the
6054 @item wl-highlight-folder-unknown-face
6055 The face for folders that are not known to have how many unsync messages
6058 @item wl-highlight-folder-zero-face
6059 The face for folders that have no unsync messages in the folder mode.
6061 @item wl-highlight-folder-few-face
6062 The face for folders that have some unsync messages in the folder mode.
6064 @item wl-highlight-folder-many-face
6065 The face for folders that have many unsync messages in the folder mode.
6066 The boundary between `some' and `many' is specified by the variable
6067 @code{wl-folder-many-unsync-threshold}.
6069 @item wl-highlight-folder-unread-face
6070 The face for folders that have no unsync but unread messages in the
6073 @item wl-highlight-folder-killed-face
6074 The face for folders that are deleted from the access group in the
6077 @item wl-highlight-folder-opened-face
6078 The face for open groups in the folder mode.
6079 It is meaningful when @code{wl-highlight-group-folder-by-numbers} is
6080 @code{nil} or a @var{number}.
6082 @item wl-highlight-folder-closed-face
6083 The face for close groups in the folder mode.
6084 It is meaningful when @code{wl-highlight-group-folder-by-numbers} is
6085 @code{nil} or a @var{number}.
6087 @item wl-highlight-folder-path-face
6088 The face for the path to the currently selected folder in the folder
6091 @item wl-highlight-logo-face
6092 The face for logo in the demo.
6094 @item wl-highlight-demo-face
6095 The face for strings (for example, a version number) in the demo.
6099 @node Biff, Advanced Settings, Highlights, Customization
6100 @section Notify Mail arrival
6103 Following setting is to notify mail arrival of @samp{%inbox}
6104 by the indicator on the modeline
6107 (setq wl-biff-check-folder-list '("%inbox"))
6110 @subsection Customizable Variables
6112 @item wl-biff-check-folder-list
6113 @vindex wl-biff-check-folder-list
6114 The initial setting is @code{nil}.
6115 This is the list of folders to check mail arrival.
6116 If @code{nil}, wl doesn't check mail arrival.
6118 @item wl-biff-check-interval
6119 @vindex wl-biff-check-interval
6120 The initial setting is 40 (in seconds).
6121 Check mail arrival in this period.
6125 @node Advanced Settings, Customizable Variables, Biff, Customization
6126 @section Advanced Settings
6129 * Draft for Reply:: Draft for Reply
6130 * Thread Format:: Appearance of Thread
6131 * User-Agent Field:: @samp{User-Agent:} Header Field
6135 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6136 @subsection Draft for Replay
6138 If you want, when you replying to articles in mailing lists, the address
6139 in Reply-To field of the original message to be prepared to To field of
6140 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6145 (setq wl-draft-reply-without-argument-list
6146 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6147 ("Followup-To" . (nil nil ("Followup-To")))
6148 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6149 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6154 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6155 in the original message, @samp{Reply-To:} field in the original is
6156 copied to @samp{To:} field.)
6158 Moreover, the behavior of @kbd{a} with prefix argument can
6159 be directed by @code{wl-draft-reply-with-argument-list} as well.
6161 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6162 @subsection Appearance of Threads
6166 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6167 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6168 391 09/18(Fri)19:24 +-[ Murata-san ]
6169 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6170 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6171 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6172 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6173 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6174 412 09/22(Tue)09:28 | +-[ Teranishi ]
6175 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6176 416 09/22(Tue)12:38 | +-[ Teranishi ]
6177 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6178 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6182 Settings to make appearance of threads like shown above:
6186 (setq wl-thread-indent-level 2)
6187 (setq wl-thread-have-younger-brother-str "+")
6188 (setq wl-thread-youngest-child-str "+")
6189 (setq wl-thread-vertical-str "|")
6190 (setq wl-thread-horizontal-str "-")
6191 (setq wl-thread-space-str " ")
6195 If you do not want to see branches, do the following:
6199 (setq wl-thread-indent-level 2)
6200 (setq wl-thread-have-younger-brother-str " ")
6201 (setq wl-thread-youngest-child-str " ")
6202 (setq wl-thread-vertical-str " ")
6203 (setq wl-thread-horizontal-str " ")
6204 (setq wl-thread-space-str " ")
6209 @node User-Agent Field, , Thread Format, Advanced Settings
6210 @subsection User-Agent Field
6214 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6215 @samp{User-Agent:} fields, define a function that generate appropriate
6216 strings as you like, and set it to variable
6217 @code{wl-generate-mailer-string-func}.
6219 If you do not want verbose @samp{User-Agent:} field, do the following:
6223 (setq wl-generate-mailer-string-func
6226 (concat "User-Agent: "
6227 (wl-generate-user-agent-string-1 nil)))))
6231 The following is a example:
6235 (setq mime-edit-insert-user-agent-field nil)
6236 (setq wl-generate-mailer-string-func
6239 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6244 @node Customizable Variables, Hooks, Advanced Settings, Customization
6245 @section Customizable Variables
6247 Customizable variables that have not been described yet:
6250 @item wl-default-folder
6251 @vindex wl-default-folder
6252 The initial setting is @samp{%inbox}. This is the default value for moving to
6253 a folder and the like.
6255 @item wl-draft-folder
6256 @vindex wl-draft-folder
6257 The initial setting is @samp{+draft}. It is the folder to which drafts are
6258 saved. It must be a localdir folder.
6260 @item wl-trash-folder
6261 @vindex wl-trash-folder
6262 The initial setting is @samp{+trash}. It is the wastebasket folder.
6263 If you changed this variable, you had better restart Wanderlust.
6265 @item wl-interactive-exit
6266 @vindex wl-interactive-exit
6267 The initial setting is @code{t}.
6268 If non-nil, you are asked for confirmation when Wanderlust terminates.
6270 @item wl-interactive-send
6271 @vindex wl-interactive-send
6272 The initial setting is @code{nil}.
6273 If non-nil, you are asked for confirmation when mail is sent.
6275 @item wl-folder-sync-range-alist
6276 @vindex wl-folder-sync-range-alist
6277 The initial setting is the alist shown below:
6282 ("^\\+draft$\\|^\\+queue$" . "all"))
6287 This is an associative list of regular expressions of folder names and
6288 update range of the summary. Update range is one of the @samp{all},
6289 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6290 @samp{last}. If a folder do not match, @samp{update} is used.
6293 @vindex wl-ask-range
6294 The initial setting is @code{t}.
6295 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6296 for updating the summary when you changed folders.
6298 @item wl-mime-charset
6299 @vindex wl-mime-charset
6300 The initial setting is @code{x-ctext}.
6301 This is the MIME charset for messages that are not MIME (e.g. without
6302 @samp{Content-Type:}). This value also used as default charset for
6303 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6304 this value as @code{iso-2022-jp}.)
6306 @item wl-highlight-folder-with-icon
6307 @vindex wl-highlight-folder-with-icon
6308 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6309 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6311 @item wl-strict-diff-folders
6312 @vindex wl-strict-diff-folders
6313 This is a list of regular expressions of folders.
6314 Unread messages are checked, for example when you press @kbd{s} in
6315 the folder mode, usually in a brief way (rapidly processed but not
6317 The folders matching this variable are seriously checked.
6318 You may want to set this variable so as to match conditional filter
6319 folders for IMAP4 folders.
6320 The initial setting is @code{nil}.
6322 @item wl-folder-use-server-diff
6323 @vindex wl-folder-use-server-diff
6324 When unread messages are checked, for example when you press @kbd{s} in
6325 the folder mode, usually (the number of messages on the server) @minus{}
6326 (the number of local messages) will be the number of unread messages.
6327 However, if this variable is non-nil, the number of unread messages on
6328 the server is checked. This affects IMAP4 folders only, but IMAP4
6329 folders in mail boxes matching
6330 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6331 the number of unread messages on the server, even if they matches this
6332 variable. The initial setting is @code{t}.
6334 @item wl-auto-check-folder-name
6335 @vindex wl-auto-check-folder-name
6336 The initial setting is @code{nil}.
6337 If non-nil, the folder with the name of the value is checked for unread
6338 messages at the start.
6339 If it is @code{none}, no folders are checked.
6340 If it is a list, all folders in the list are checked at the start.
6342 @item wl-auto-uncheck-folder-list
6343 @vindex wl-auto-uncheck-folder-list
6344 The initial setting is the list shown below:
6353 Folders with the name matching this variable are not checked for unread
6354 messages at the start, even if they are included in the groups in
6355 @code{wl-auto-check-folder-name}.
6357 @item wl-auto-check-folder-list
6358 @vindex wl-auto-check-folder-list
6359 The initial setting is @code{nil}.
6360 Folders with the name matching this variable are always checked for
6361 unread messages at the start, if they are included in the groups in
6362 @code{wl-auto-check-folder-name}.
6363 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6365 @item wl-no-save-folder-list
6366 @vindex wl-no-save-folder-list
6367 The initial setting is the list shown below:
6376 This is a list of regular expressions of folders not to be saved.
6378 @item wl-save-folder-list
6379 @vindex wl-save-folder-list
6380 The initial setting is @code{nil}.
6381 This is a list of regular expressions of folders to be saved.
6382 This takes precedence over @code{wl-no-save-folder-list}.
6384 @item wl-folder-mime-charset-alist
6385 @vindex wl-folder-mime-charset-alist
6386 The initial setting is the alist shown below:
6390 (("^-alt\\.chinese" . big5)
6391 ("^-relcom\\." . koi8-r)
6393 ("^-han\\." . euc-kr))
6398 This is an associative list of regular expressions of folder names and
6400 If a folder do not match, @code{wl-mime-charset} is used.
6402 @item wl-folder-init-load-access-folders
6403 @vindex wl-folder-init-load-access-folders
6404 The initial setting is @code{nil}.
6405 This is a list of access groups to be loaded specifically at the start.
6406 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6408 @item wl-folder-init-no-load-access-folders
6409 @vindex wl-folder-init-no-load-access-folders
6410 The initial setting is @code{nil}.
6411 This is a list of access groups not to be loaded specifically at the
6413 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6415 @item wl-delete-folder-alist
6416 @vindex wl-delete-folder-alist
6417 The initial setting is the alist shown below:
6426 This list determines disposition of messages with delete marks.
6427 Each item in the list is a folder and destination; you can specify any
6428 one of the following in the place of destination:
6431 @code{remove} or @code{null} : deletes the messages instantly.
6432 string : moves the messages to the specific folder.
6433 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
6436 @item wl-refile-policy-alist
6437 @vindex wl-refile-policy-alist
6438 The initial setting is the list shown below:
6448 This list determines whether messages with re-file marks are moved or
6449 copied. Each item in the list is a cons cell of a folder and
6450 @code{copy} or @code{move}.
6452 @item wl-x-face-file
6453 @vindex wl-x-face-file
6454 The initial setting is @file{~/.xface}.
6455 The name of the file that contains encoded X-Face strings.
6458 @item wl-demo-display-logo
6459 @vindex wl-demo-display-logo
6460 If non-nil, bitmap image is shown on the opening demo. If you set
6461 @code{xpm} or @code{xbm}, (if possible) display selected image type
6464 @item elmo-use-database
6465 @vindex elmo-use-database
6466 This is meaningful for XEmacs only. The initial setting depends on
6467 XEmacs (@code{t} for XEmacs with dbm).
6468 If non-nil, Message-ID is controlled by dbm.
6470 @item elmo-passwd-alist-file-name
6471 @vindex elmo-passwd-alist-file-name
6472 The initial setting is @file{passwd}.
6473 This is the name of the file in which passwords are saved.
6474 @code{elmo-passwd-alist-save} saves current passwords to the file.
6476 @item elmo-nntp-list-folders-use-cache
6477 @vindex elmo-nntp-list-folders-use-cache
6478 The initial setting is 600 (in seconds).
6479 This is period in seconds during which results of @samp{list} and
6480 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6483 @item elmo-nntp-max-number-precedes-list-active
6484 @vindex elmo-nntp-max-number-precedes-list-active
6485 The initial setting is @code{nil}.
6486 If non-nil, the number of article obtained by @samp{list active} in NNTP
6487 are used as the maximum article number of the folder.
6488 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6489 and if the number of read messages is not correct.
6491 @item elmo-nntp-default-use-listgroup
6492 @vindex elmo-nntp-default-use-listgroup
6493 The initial setting is @code{t}.
6494 If non-nil, @samp{listgroup} is used for checking the total number of
6495 articles. If it is @code{nil}, @samp{group} is used. In the latter
6496 case, the processing will be a little faster at the sacrifice of
6499 @item elmo-pop3-send-command-synchronously
6500 @vindex elmo-pop3-send-command-synchronously
6501 The initial setting is @code{nil}.
6502 If non-nil, POP3 commands are issued synchronously. Some implementation
6503 of POP3 server fails to get summary information without this setting.
6504 You may have to set this variable to @code{t}, if the process hangs
6505 while looking up POP3.
6507 @item elmo-dop-flush-confirm
6508 @vindex elmo-dop-flush-confirm
6509 The initial setting is @code{t}.
6510 If non-nil, you are asked for confirmation if accumulated off-line
6511 operations are executed.
6513 @item elmo-display-progress-threshold
6514 @vindex elmo-display-progress-threshold
6515 The initial setting is 20.
6516 Threshold for display of progress gauge. If number of renewal is more than
6517 this value, display progress gauge.
6521 @node Hooks, , Customizable Variables, Customization
6527 @node Mailing List, Addition, Customization, Top
6528 @chapter Wanderlust Mailing List
6533 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6536 Topics related to Wanderlust are discussed in the mailing list.
6537 The latest version is also announced there (in Japanese, sorry).
6539 A guide can be obtained automatically by sending mail to
6540 @t{wl-ctl@@lists.airs.net} with the body
6545 Please send bug reports or patches to the mailing list. You can post to
6546 the mailing list even though you are not a member of it.
6548 If you send a bug report, please attach Backtrace with it.
6549 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
6552 I would like to express my thanks to the members of the mailing list for
6553 valuable advice and many pieces of code they contributed.
6556 @node Addition, Index, Mailing List, Top
6557 @chapter Additional Information
6559 @section Brief History
6562 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6563 3/10 Made a msgdb mechanism by elisp.
6564 3/26 IMAP and NNTP can be displayed in threads.
6565 4/13 Began to assemble thread display modules as elmo.
6566 5/01 Finished 0.1.0, initial version with many defects.
6567 6/12 I made a slip of the tongue and said I was writing elisp
6568 mailer supporting IMAP
6569 6/16 0.1.3 was announced at tm-ja, elisp ML.
6570 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6571 7/01 Support for mm-backend (0.3.0).
6572 8/25 multi folder added (0.5.0).
6573 8/28 filter folder added (0.5.1).
6574 9/10 You can open/close threads (0.6.0).
6575 9/11 fldmgr by Murata-san made editing folders easy.
6576 9/18 lha folders added by Okunishi-san (0.6.3).
6577 9/24 Display of branches of threads (0.6.5).
6578 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6579 10/28 Off-line operations (0.7.4).
6580 12/09 Becomes beta version.
6581 12/21 wl-expire by Murata-san.
6582 1999 2/03 auto-refile by Tsumura-san.
6583 4/28 wl-template by Murata-san.
6584 5/18 Released 1.0.0 stable.
6585 7/05 Scoring by Murata-san (2.1.0).
6586 9/26 New plugged system by Murata-san (2.2.2).
6587 12/20 Support Modified UTF7.
6588 2000 3/24 Released 1.1.0 stable.
6589 4/03 CVS development started.
6590 5/07 Thread restoration & Its speed up with Murata-san.
6591 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6592 7/11 killed message feature.
6593 7/18 Use UIDL in POP3.
6594 9/12 biff feature with Satata-san & Yamaoka-san.
6597 See @file{ChangeLog} for details.
6601 According to a dictionary, Wanderlust has the meaning:
6605 n eager longing for or impulse towards travelling in distant lands
6606 [Ger, fr wandern to wander + lust desire, pleasure]
6610 but I had no profound intention. (if farfetched, IMAP @result{} you can
6611 read mail anywhere @result{} desire to wander ?)
6613 Elmo is the abbreviation of @samp{Elisp Library for Message
6614 Orchestration}. At first I meant the red puppet in the Sesame Street,
6615 but you may associate it with Wandering @result{} Drifting @result{}
6616 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6620 Each versions has code names (they are almost jokes).
6621 Currently they are picked up alphabetically from the top 40 hits of
6622 U.S. Billboard magazines in 1980s.
6624 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
6627 @node Index, , Addition, Top
6631 * Concept Index:: Concept Index
6632 * Key Index:: Key Index
6633 * Variable Index:: Variable Index
6634 * Function Index:: Function Index
6637 @node Concept Index, Key Index, Index, Index
6638 @unnumberedsec Concept Index
6641 @node Key Index, Variable Index, Concept Index, Index
6642 @unnumberedsec Key Index
6645 @node Variable Index, Function Index, Key Index, Index
6646 @unnumberedsec Variable Index
6649 @node Function Index, , Variable Index, Index
6650 @unnumberedsec Function Index